diff --git a/third_party/googleapis/.bazeliskrc b/third_party/googleapis/.bazeliskrc
index 463b45379..04cd2fe7c 100644
--- a/third_party/googleapis/.bazeliskrc
+++ b/third_party/googleapis/.bazeliskrc
@@ -1,2 +1,2 @@
# See https://github.com/bazelbuild/bazelisk
-USE_BAZEL_VERSION=4.2.2
+USE_BAZEL_VERSION=6.0.0
diff --git a/third_party/googleapis/.github/workflows/diregapic.yaml b/third_party/googleapis/.github/workflows/diregapic.yaml
index 7e1d3db3e..fa7837f9d 100644
--- a/third_party/googleapis/.github/workflows/diregapic.yaml
+++ b/third_party/googleapis/.github/workflows/diregapic.yaml
@@ -8,7 +8,7 @@ on: # yamllint disable-line rule:truthy
jobs:
regenerate-compute:
runs-on: ubuntu-latest
- container: gcr.io/gapic-images/googleapis:20220711
+ container: gcr.io/gapic-images/googleapis:20230301
steps:
- name: Checkout master
uses: actions/checkout@v3
diff --git a/third_party/googleapis/.gitignore b/third_party/googleapis/.gitignore
index b2a32995a..c4e73d4c1 100644
--- a/third_party/googleapis/.gitignore
+++ b/third_party/googleapis/.gitignore
@@ -1,4 +1,5 @@
OWNERS
+README.google
google/internal
google/protobuf
.project
diff --git a/third_party/googleapis/.kokoro/Dockerfile b/third_party/googleapis/.kokoro/Dockerfile
index baa9776a0..0621d0e6c 100644
--- a/third_party/googleapis/.kokoro/Dockerfile
+++ b/third_party/googleapis/.kokoro/Dockerfile
@@ -13,7 +13,7 @@ RUN mkdir -p /tools
WORKDIR /tools
RUN curl -L https://github.com/bazelbuild/bazelisk/releases/download/v1.12.0/bazelisk-linux-amd64 -o bazelisk
RUN chmod +x bazelisk
-RUN curl -L https://github.com/bazelbuild/bazel/releases/download/5.2.0/bazel-5.2.0-linux-x86_64 -o bazel
+RUN curl -L https://github.com/bazelbuild/bazel/releases/download/6.0.0/bazel-6.0.0-linux-x86_64 -o bazel
RUN chmod +x bazel
WORKDIR /
diff --git a/third_party/googleapis/.kokoro/start.sh b/third_party/googleapis/.kokoro/start.sh
index 55ac24490..3a5bfb4fd 100755
--- a/third_party/googleapis/.kokoro/start.sh
+++ b/third_party/googleapis/.kokoro/start.sh
@@ -11,4 +11,4 @@ docker container run \
--workdir ${KOKORO_ROOT} \
--ipc=host \
--entrypoint ${KOKORO_ARTIFACTS_DIR}/github/googleapis/.kokoro/build.sh \
- gcr.io/gapic-images/googleapis:20220711
+ gcr.io/gapic-images/googleapis:20230301
diff --git a/third_party/googleapis/README.google b/third_party/googleapis/README.google
deleted file mode 100644
index 1e5856b8c..000000000
--- a/third_party/googleapis/README.google
+++ /dev/null
@@ -1,25 +0,0 @@
-URL: https://github.com/googleapis/googleapis/commit/475d72b7405c92f06d7f2d4aba866278eb5ad8e9
-Version: https://github.com/googleapis/googleapis/commit/475d72b7405c92f06d7f2d4aba866278eb5ad8e9
-License: Apache 2.0
-License File: # LICENSE
-Description:
- Public interface definitions of Google APIs.
-Local Modifications:
- README.google was removed from .gitignore.
- Remote submodules were not imported.
- Remove .gitmodules.
- Remove submodules from git index with 'git rm'.
-
- Imported as a git-subtree.
-
- $ git remote add googleapis https://github.com/googleapis/googleapis
- $ git subtree add --prefix third_party/googleapis googleapis master --squash
- $ rm third_party/googleapis/.gitmodules
- $ git rm third_party/googleapis/third_party/boringssl-with-bazel
- $ git rm third_party/googleapis/third_party/nanopb
- $ git rm third_party/googleapis/third_party/protobuf
- $ git rm third_party/googleapis/third_party/zlib
-
- To update from remote on an ongoing basis:
- $ git fetch googleapis
- $ git subtree pull --prefix third_party/googleapis googleapis master --squash
diff --git a/third_party/googleapis/WORKSPACE b/third_party/googleapis/WORKSPACE
index d3121d874..09c8c53d1 100644
--- a/third_party/googleapis/WORKSPACE
+++ b/third_party/googleapis/WORKSPACE
@@ -1,9 +1,5 @@
workspace(
name = "com_google_googleapis",
- # This tells Bazel that the node_modules directory is special and
- # is managed by the package manager.
- # https://bazelbuild.github.io/rules_nodejs/install.html
- managed_directories = {"@npm": ["@gapic_generator_typescript//:node_modules"]},
)
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
@@ -28,15 +24,38 @@ switched_rules_by_language(
ruby = True,
)
-# Protobuf depends on very old version of bazel_skylib (forward compatible with the new one).
-# Importing older version of bazel_skylib first (this is one of the things that protobuf_deps() call
-# below will do) breaks the grpc repositories, so importing the proper version explicitly before
-# everything else.
+_bazel_skylib_version = "1.4.0"
+
+_bazel_skylib_sha256 = "f24ab666394232f834f74d19e2ff142b0af17466ea0c69a3f4c276ee75f6efce"
+
http_archive(
name = "bazel_skylib",
- urls = ["https://github.com/bazelbuild/bazel-skylib/releases/download/0.9.0/bazel_skylib-0.9.0.tar.gz"],
+ sha256 = _bazel_skylib_sha256,
+ urls = ["https://github.com/bazelbuild/bazel-skylib/releases/download/{0}/bazel-skylib-{0}.tar.gz".format(_bazel_skylib_version)],
+)
+
+# Protobuf depends on very old version of rules_jvm_external.
+# Importing older version of rules_jvm_external first (this is one of the things that protobuf_deps() call
+# below will do) breaks the Java client library generation process, so importing the proper version explicitly before calling protobuf_deps().
+RULES_JVM_EXTERNAL_TAG = "4.5"
+
+RULES_JVM_EXTERNAL_SHA = "b17d7388feb9bfa7f2fa09031b32707df529f26c91ab9e5d909eb1676badd9a6"
+
+http_archive(
+ name = "rules_jvm_external",
+ sha256 = RULES_JVM_EXTERNAL_SHA,
+ strip_prefix = "rules_jvm_external-%s" % RULES_JVM_EXTERNAL_TAG,
+ url = "https://github.com/bazelbuild/rules_jvm_external/archive/%s.zip" % RULES_JVM_EXTERNAL_TAG,
)
+load("@rules_jvm_external//:repositories.bzl", "rules_jvm_external_deps")
+
+rules_jvm_external_deps()
+
+load("@rules_jvm_external//:setup.bzl", "rules_jvm_external_setup")
+
+rules_jvm_external_setup()
+
# Python rules should go early in the dependencies list, otherwise a wrong
# version of the library will be selected as a transitive dependency of gRPC.
http_archive(
@@ -60,9 +79,9 @@ rules_pkg_dependencies()
http_archive(
name = "com_google_protobuf",
- sha256 = "ce2fbea3c78147a41b2a922485d283137845303e5e1b6cbd7ece94b96ade7031",
- strip_prefix = "protobuf-3.21.7",
- urls = ["https://github.com/protocolbuffers/protobuf/archive/v3.21.7.tar.gz"],
+ sha256 = "930c2c3b5ecc6c9c12615cf5ad93f1cd6e12d0aba862b572e076259970ac3a53",
+ strip_prefix = "protobuf-3.21.12",
+ urls = ["https://github.com/protocolbuffers/protobuf/archive/v3.21.12.tar.gz"],
)
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
@@ -89,31 +108,12 @@ rules_proto_toolchains()
# Go
##############################################################################
-# This must be above the download of gRPC (in C++ section) and rules_gapic because both repositories depend on rules_go
-# and we would rather manage our version of rules_go explicitly rather than depend on the version those bring in transitively.
-_io_bazel_rules_go_version = "0.33.0"
-
-http_archive(
- name = "io_bazel_rules_go",
- sha256 = "685052b498b6ddfe562ca7a97736741d87916fe536623afb7da2824c0211c369",
- urls = [
- "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v{0}/rules_go-v{0}.zip".format(_io_bazel_rules_go_version),
- "https://github.com/bazelbuild/rules_go/releases/download/v{0}/rules_go-v{0}.zip".format(_io_bazel_rules_go_version),
- ],
-)
-
-load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
-
-go_rules_dependencies()
-
-go_register_toolchains(version = "1.16")
-
# rules_gapic also depends on rules_go, so it must come after our own dependency on rules_go.
# It must also come before gapic-generator-go so as to ensure that it does not bring in an old
# version of rules_gapic.
-_rules_gapic_version = "0.19.2"
+_rules_gapic_version = "0.22.1"
-_rules_gapic_sha256 = "8eff349ac8c3e306db603c8e00ac6d30c59138bb65cabf0f69bf79d23905eec4"
+_rules_gapic_sha256 = "865691b71a20a064106ce09c7f6b2087dc4eb1d7a3353f7a5f69a16ca8712f18"
http_archive(
name = "rules_gapic",
@@ -122,9 +122,20 @@ http_archive(
urls = ["https://github.com/googleapis/rules_gapic/archive/v%s.tar.gz" % _rules_gapic_version],
)
-load("@rules_gapic//:repositories.bzl", "rules_gapic_repositories")
+# This must be above the download of gRPC (in C++ section) and
+# rules_gapic_repositories because both depend on rules_go and we need to manage
+# our version of rules_go explicitly rather than depend on the version those
+# bring in transitively.
+_io_bazel_rules_go_version = "0.34.0"
-rules_gapic_repositories()
+http_archive(
+ name = "io_bazel_rules_go",
+ sha256 = "16e9fca53ed6bd4ff4ad76facc9b7b651a89db1689a2877d6fd7b82aa824e366",
+ urls = [
+ "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v{0}/rules_go-v{0}.zip".format(_io_bazel_rules_go_version),
+ "https://github.com/bazelbuild/rules_go/releases/download/v{0}/rules_go-v{0}.zip".format(_io_bazel_rules_go_version),
+ ],
+)
# Gazelle dependency version should match gazelle dependency expected by gRPC
_bazel_gazelle_version = "0.24.0"
@@ -138,6 +149,16 @@ http_archive(
],
)
+# This overrides the package name @go_googleapis to point at this package,
+# @com_google_googleapis, which has the latest versions of all protos and is the
+# source of truth for those protos. This prevents rules_go from loading its own,
+# conflicting copy of googleapis under this package name, which would create
+# package collisions during compilation.
+local_repository(
+ name = "go_googleapis",
+ path = ".",
+)
+
# Until this project is migrated to consume the new subdirectory of generated
# types e.g. longrunningpb, we must define our own version of longrunning here.
load("@bazel_gazelle//:deps.bzl", "go_repository")
@@ -149,13 +170,10 @@ go_repository(
version = "v0.1.1",
)
-_gapic_generator_go_version = "0.33.5"
+_gapic_generator_go_version = "0.34.0"
http_archive(
name = "com_googleapis_gapic_generator_go",
- repo_mapping = {
- "@go_googleapis": "@com_google_googleapis",
- },
strip_prefix = "gapic-generator-go-%s" % _gapic_generator_go_version,
urls = ["https://github.com/googleapis/gapic-generator-go/archive/v%s.tar.gz" % _gapic_generator_go_version],
)
@@ -164,14 +182,23 @@ load("@com_googleapis_gapic_generator_go//:repositories.bzl", "com_googleapis_ga
com_googleapis_gapic_generator_go_repositories()
-# Gazelle dependencies should go after gapic-generator-go dependencies to make sure that
-# gazelle does not override some of the critical dependencies of the gapic-generator-go.
-# At the same time gazelle repository itself must be imported before gapic-generator-go,
-# because gapic-generator-go depends on go_repository rule, which is defined in gazelle repo.
+# rules_go and gazelle dependencies are loaded after gapic-generator-go
+# dependencies to ensure that they do not override any of the go_repository
+# dependencies of gapic-generator-go.
+load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
+
+go_register_toolchains(version = "1.18.6")
+
+go_rules_dependencies()
+
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
gazelle_dependencies()
+load("@rules_gapic//:repositories.bzl", "rules_gapic_repositories")
+
+rules_gapic_repositories()
+
##############################################################################
# C++
##############################################################################
@@ -234,16 +261,6 @@ load("@com_google_protobuf//:protobuf_deps.bzl", "PROTOBUF_MAVEN_ARTIFACTS")
# PROTOBUF_MAVEN_ARTIFACTS variable so that Bazel users can resolve their
# dependencies through maven_install.
# https://github.com/protocolbuffers/protobuf/issues/9132
-RULES_JVM_EXTERNAL_TAG = "4.2"
-
-RULES_JVM_EXTERNAL_SHA = "cd1a77b7b02e8e008439ca76fd34f5b07aecb8c752961f9640dea15e9e5ba1ca"
-
-http_archive(
- name = "rules_jvm_external",
- sha256 = RULES_JVM_EXTERNAL_SHA,
- strip_prefix = "rules_jvm_external-%s" % RULES_JVM_EXTERNAL_TAG,
- url = "https://github.com/bazelbuild/rules_jvm_external/archive/%s.zip" % RULES_JVM_EXTERNAL_TAG,
-)
load("@rules_jvm_external//:defs.bzl", "maven_install")
@@ -255,12 +272,31 @@ maven_install(
],
)
-_gax_java_version = "2.19.4"
+_gapic_generator_java_version = "2.15.2"
+
+maven_install(
+ artifacts = [
+ "com.google.api:gapic-generator-java:" + _gapic_generator_java_version,
+ ],
+ #Update this False for local development
+ fail_on_missing_checksum = True,
+ repositories = [
+ "m2Local",
+ "https://repo.maven.apache.org/maven2/",
+ ]
+)
+http_archive(
+ name = "gapic_generator_java",
+ strip_prefix = "gapic-generator-java-%s" % _gapic_generator_java_version,
+ urls = ["https://github.com/googleapis/gapic-generator-java/archive/v%s.zip" % _gapic_generator_java_version],
+)
+
+# gax-java is part of gapic-generator-java repository
http_archive(
name = "com_google_api_gax_java",
- strip_prefix = "gax-java-%s" % _gax_java_version,
- urls = ["https://github.com/googleapis/gax-java/archive/v%s.zip" % _gax_java_version],
+ strip_prefix = "gapic-generator-java-%s/gax-java" % _gapic_generator_java_version,
+ urls = ["https://github.com/googleapis/gapic-generator-java/archive/v%s.zip" % _gapic_generator_java_version],
)
load("@com_google_api_gax_java//:repository_rules.bzl", "com_google_api_gax_java_properties")
@@ -278,20 +314,6 @@ load("@io_grpc_grpc_java//:repositories.bzl", "grpc_java_repositories")
grpc_java_repositories()
-# Java microgenerator.
-# Must go AFTER java-gax, since both java gax and gapic-generator are written in java and may conflict.
-_gapic_generator_java_version = "2.11.0"
-
-http_archive(
- name = "gapic_generator_java",
- strip_prefix = "gapic-generator-java-%s" % _gapic_generator_java_version,
- urls = ["https://github.com/googleapis/gapic-generator-java/archive/v%s.zip" % _gapic_generator_java_version],
-)
-
-load("@gapic_generator_java//:repositories.bzl", "gapic_generator_java_repositories")
-
-gapic_generator_java_repositories()
-
##############################################################################
# Python
##############################################################################
@@ -303,7 +325,7 @@ load("@rules_python//python:pip.bzl", "pip_install")
pip_install()
-_gapic_generator_python_version = "1.7.1"
+_gapic_generator_python_version = "1.8.5"
http_archive(
name = "gapic_generator_python",
@@ -325,9 +347,9 @@ gapic_generator_register_toolchains()
# TypeScript
##############################################################################
-_gapic_generator_typescript_version = "2.18.2"
+_gapic_generator_typescript_version = "3.0.3"
-_gapic_generator_typescript_sha256 = "45dfd7f059f45f83352a2d9438c1ed021817d9c894220cbd9578b1580194b937"
+_gapic_generator_typescript_sha256 = "f79b4517873f69ea09621b511aade2e039bcfc37f19342a135bf45eaa6f60595"
### TypeScript generator
http_archive(
@@ -337,28 +359,40 @@ http_archive(
urls = ["https://github.com/googleapis/gapic-generator-typescript/archive/v%s.tar.gz" % _gapic_generator_typescript_version],
)
-load("@gapic_generator_typescript//:repositories.bzl", "gapic_generator_typescript_repositories")
-
+load("@gapic_generator_typescript//:repositories.bzl", "gapic_generator_typescript_repositories", "NODE_VERSION")
gapic_generator_typescript_repositories()
-load("@build_bazel_rules_nodejs//:index.bzl", "node_repositories", "yarn_install")
+load("@aspect_rules_js//js:repositories.bzl", "rules_js_dependencies")
+rules_js_dependencies()
-node_repositories(
- package_json = ["@gapic_generator_typescript//:package.json"],
+load("@aspect_rules_ts//ts:repositories.bzl", "rules_ts_dependencies")
+rules_ts_dependencies(
+ ts_version_from = "@gapic_generator_typescript//:package.json",
)
-yarn_install(
- name = "npm",
- package_json = "@gapic_generator_typescript//:package.json",
- yarn_lock = "@gapic_generator_typescript//:yarn.lock",
+load("@rules_nodejs//nodejs:repositories.bzl", "nodejs_register_toolchains")
+nodejs_register_toolchains(
+ name = "nodejs",
+ node_version = NODE_VERSION,
)
+load("@aspect_rules_js//npm:npm_import.bzl", "npm_translate_lock", "pnpm_repository")
+npm_translate_lock(
+ name = "npm",
+ pnpm_lock = "@gapic_generator_typescript//:pnpm-lock.yaml",
+ data = ["@gapic_generator_typescript//:package.json"],
+)
+
+load("@npm//:repositories.bzl", "npm_repositories")
+npm_repositories()
+pnpm_repository(name = "pnpm")
+
##############################################################################
# PHP
##############################################################################
# PHP micro-generator
-_gapic_generator_php_version = "1.6.3"
+_gapic_generator_php_version = "1.6.6"
http_archive(
name = "gapic_generator_php",
@@ -399,9 +433,9 @@ http_archive(
urls = ["https://github.com/googleapis/gax-dotnet/archive/refs/tags/%s.tar.gz" % _gax_dotnet_version],
)
-_gapic_generator_csharp_version = "1.4.9"
+_gapic_generator_csharp_version = "1.4.11"
-_gapic_generator_csharp_sha256 = "b3641de24520ca9efa34146c447f89055fc4f803275501947d0fb7b1fa7aad49"
+_gapic_generator_csharp_sha256 = "40bb2ecf1e540df8f58bdca15c48e3da6fbdddc9c5786421b858222fb4e25202"
http_archive(
name = "gapic_generator_csharp",
@@ -418,9 +452,9 @@ gapic_generator_csharp_repositories()
# Ruby
##############################################################################
-_gapic_generator_ruby_version = "v0.18.1"
+_gapic_generator_ruby_version = "v0.23.1"
-_gapic_generator_ruby_sha256 = "510337661a2668583748cae9b55282ee0b359bed96858abdc3f4924f3dc1c3b3"
+_gapic_generator_ruby_sha256 = "44f9d4076386ddbd87a13c02e2be101a783817235806e32153325ee5fba7e663"
http_archive(
name = "gapic_generator_ruby",
diff --git a/third_party/googleapis/api-index-v1.json b/third_party/googleapis/api-index-v1.json
index 69cdbeaa0..8e92aab71 100644
--- a/third_party/googleapis/api-index-v1.json
+++ b/third_party/googleapis/api-index-v1.json
@@ -212,19 +212,19 @@
"nameInServiceConfig": "actions.googleapis.com"
},
{
- "id": "google.ads.googleads.v10",
- "directory": "google/ads/googleads/v10",
- "version": "v10",
- "majorVersion": "v10",
+ "id": "google.ads.googleads.v11",
+ "directory": "google/ads/googleads/v11",
+ "version": "v11",
+ "majorVersion": "v11",
"hostName": "googleads.googleapis.com",
"title": "Google Ads API",
"description": "Manage your Google Ads accounts, campaigns, and reports with this API.",
"importDirectories": [
- "google/ads/googleads/v10/common",
- "google/ads/googleads/v10/enums",
- "google/ads/googleads/v10/errors",
- "google/ads/googleads/v10/resources",
- "google/ads/googleads/v10/services",
+ "google/ads/googleads/v11/common",
+ "google/ads/googleads/v11/enums",
+ "google/ads/googleads/v11/errors",
+ "google/ads/googleads/v11/resources",
+ "google/ads/googleads/v11/services",
"google/api",
"google/longrunning",
"google/protobuf",
@@ -233,73 +233,73 @@
"options": {
"csharp_namespace": {
"valueCounts": {
- "Google.Ads.GoogleAds.V10.Common": 35,
- "Google.Ads.GoogleAds.V10.Enums": 294,
- "Google.Ads.GoogleAds.V10.Errors": 140,
- "Google.Ads.GoogleAds.V10.Resources": 156,
- "Google.Ads.GoogleAds.V10.Services": 102
+ "Google.Ads.GoogleAds.V11.Common": 35,
+ "Google.Ads.GoogleAds.V11.Enums": 299,
+ "Google.Ads.GoogleAds.V11.Errors": 141,
+ "Google.Ads.GoogleAds.V11.Resources": 156,
+ "Google.Ads.GoogleAds.V11.Services": 103
}
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common": 35,
- "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums": 294,
- "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors": 140,
- "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources": 156,
- "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services": 102
+ "google.golang.org/genproto/googleapis/ads/googleads/v11/common;common": 35,
+ "google.golang.org/genproto/googleapis/ads/googleads/v11/enums;enums": 299,
+ "google.golang.org/genproto/googleapis/ads/googleads/v11/errors;errors": 141,
+ "google.golang.org/genproto/googleapis/ads/googleads/v11/resources;resources": 156,
+ "google.golang.org/genproto/googleapis/ads/googleads/v11/services;services": 103
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 727
+ "true": 734
}
},
"java_package": {
"valueCounts": {
- "com.google.ads.googleads.v10.common": 35,
- "com.google.ads.googleads.v10.enums": 294,
- "com.google.ads.googleads.v10.errors": 140,
- "com.google.ads.googleads.v10.resources": 156,
- "com.google.ads.googleads.v10.services": 102
+ "com.google.ads.googleads.v11.common": 35,
+ "com.google.ads.googleads.v11.enums": 299,
+ "com.google.ads.googleads.v11.errors": 141,
+ "com.google.ads.googleads.v11.resources": 156,
+ "com.google.ads.googleads.v11.services": 103
}
},
"objc_class_prefix": {
"valueCounts": {
- "GAA": 727
+ "GAA": 734
}
},
"php_namespace": {
"valueCounts": {
- "Google\\Ads\\GoogleAds\\V10\\Common": 35,
- "Google\\Ads\\GoogleAds\\V10\\Enums": 294,
- "Google\\Ads\\GoogleAds\\V10\\Errors": 140,
- "Google\\Ads\\GoogleAds\\V10\\Resources": 156,
- "Google\\Ads\\GoogleAds\\V10\\Services": 102
+ "Google\\Ads\\GoogleAds\\V11\\Common": 35,
+ "Google\\Ads\\GoogleAds\\V11\\Enums": 299,
+ "Google\\Ads\\GoogleAds\\V11\\Errors": 141,
+ "Google\\Ads\\GoogleAds\\V11\\Resources": 156,
+ "Google\\Ads\\GoogleAds\\V11\\Services": 103
}
},
"ruby_package": {
"valueCounts": {
- "Google::Ads::GoogleAds::V10::Common": 35,
- "Google::Ads::GoogleAds::V10::Enums": 294,
- "Google::Ads::GoogleAds::V10::Errors": 140,
- "Google::Ads::GoogleAds::V10::Resources": 156,
- "Google::Ads::GoogleAds::V10::Services": 102
+ "Google::Ads::GoogleAds::V11::Common": 35,
+ "Google::Ads::GoogleAds::V11::Enums": 299,
+ "Google::Ads::GoogleAds::V11::Errors": 141,
+ "Google::Ads::GoogleAds::V11::Resources": 156,
+ "Google::Ads::GoogleAds::V11::Services": 103
}
}
},
"services": [
{
"shortName": "AccountBudgetProposalService",
- "fullName": "google.ads.googleads.v10.services.AccountBudgetProposalService",
+ "fullName": "google.ads.googleads.v11.services.AccountBudgetProposalService",
"methods": [
{
"shortName": "MutateAccountBudgetProposal",
- "fullName": "google.ads.googleads.v10.services.AccountBudgetProposalService.MutateAccountBudgetProposal",
+ "fullName": "google.ads.googleads.v11.services.AccountBudgetProposalService.MutateAccountBudgetProposal",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/accountBudgetProposals:mutate"
+ "path": "/v11/customers/{customer_id=*}/accountBudgetProposals:mutate"
}
]
}
@@ -307,27 +307,27 @@
},
{
"shortName": "AccountLinkService",
- "fullName": "google.ads.googleads.v10.services.AccountLinkService",
+ "fullName": "google.ads.googleads.v11.services.AccountLinkService",
"methods": [
{
"shortName": "CreateAccountLink",
- "fullName": "google.ads.googleads.v10.services.AccountLinkService.CreateAccountLink",
+ "fullName": "google.ads.googleads.v11.services.AccountLinkService.CreateAccountLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/accountLinks:create"
+ "path": "/v11/customers/{customer_id=*}/accountLinks:create"
}
]
},
{
"shortName": "MutateAccountLink",
- "fullName": "google.ads.googleads.v10.services.AccountLinkService.MutateAccountLink",
+ "fullName": "google.ads.googleads.v11.services.AccountLinkService.MutateAccountLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/accountLinks:mutate"
+ "path": "/v11/customers/{customer_id=*}/accountLinks:mutate"
}
]
}
@@ -335,16 +335,16 @@
},
{
"shortName": "AdGroupAdLabelService",
- "fullName": "google.ads.googleads.v10.services.AdGroupAdLabelService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupAdLabelService",
"methods": [
{
"shortName": "MutateAdGroupAdLabels",
- "fullName": "google.ads.googleads.v10.services.AdGroupAdLabelService.MutateAdGroupAdLabels",
+ "fullName": "google.ads.googleads.v11.services.AdGroupAdLabelService.MutateAdGroupAdLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adGroupAdLabels:mutate"
+ "path": "/v11/customers/{customer_id=*}/adGroupAdLabels:mutate"
}
]
}
@@ -352,16 +352,16 @@
},
{
"shortName": "AdGroupAdService",
- "fullName": "google.ads.googleads.v10.services.AdGroupAdService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupAdService",
"methods": [
{
"shortName": "MutateAdGroupAds",
- "fullName": "google.ads.googleads.v10.services.AdGroupAdService.MutateAdGroupAds",
+ "fullName": "google.ads.googleads.v11.services.AdGroupAdService.MutateAdGroupAds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adGroupAds:mutate"
+ "path": "/v11/customers/{customer_id=*}/adGroupAds:mutate"
}
]
}
@@ -369,16 +369,16 @@
},
{
"shortName": "AdGroupAssetService",
- "fullName": "google.ads.googleads.v10.services.AdGroupAssetService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupAssetService",
"methods": [
{
"shortName": "MutateAdGroupAssets",
- "fullName": "google.ads.googleads.v10.services.AdGroupAssetService.MutateAdGroupAssets",
+ "fullName": "google.ads.googleads.v11.services.AdGroupAssetService.MutateAdGroupAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adGroupAssets:mutate"
+ "path": "/v11/customers/{customer_id=*}/adGroupAssets:mutate"
}
]
}
@@ -386,16 +386,16 @@
},
{
"shortName": "AdGroupBidModifierService",
- "fullName": "google.ads.googleads.v10.services.AdGroupBidModifierService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupBidModifierService",
"methods": [
{
"shortName": "MutateAdGroupBidModifiers",
- "fullName": "google.ads.googleads.v10.services.AdGroupBidModifierService.MutateAdGroupBidModifiers",
+ "fullName": "google.ads.googleads.v11.services.AdGroupBidModifierService.MutateAdGroupBidModifiers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adGroupBidModifiers:mutate"
+ "path": "/v11/customers/{customer_id=*}/adGroupBidModifiers:mutate"
}
]
}
@@ -403,16 +403,16 @@
},
{
"shortName": "AdGroupCriterionCustomizerService",
- "fullName": "google.ads.googleads.v10.services.AdGroupCriterionCustomizerService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupCriterionCustomizerService",
"methods": [
{
"shortName": "MutateAdGroupCriterionCustomizers",
- "fullName": "google.ads.googleads.v10.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers",
+ "fullName": "google.ads.googleads.v11.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate"
+ "path": "/v11/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate"
}
]
}
@@ -420,16 +420,16 @@
},
{
"shortName": "AdGroupCriterionLabelService",
- "fullName": "google.ads.googleads.v10.services.AdGroupCriterionLabelService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupCriterionLabelService",
"methods": [
{
"shortName": "MutateAdGroupCriterionLabels",
- "fullName": "google.ads.googleads.v10.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels",
+ "fullName": "google.ads.googleads.v11.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adGroupCriterionLabels:mutate"
+ "path": "/v11/customers/{customer_id=*}/adGroupCriterionLabels:mutate"
}
]
}
@@ -437,16 +437,16 @@
},
{
"shortName": "AdGroupCriterionService",
- "fullName": "google.ads.googleads.v10.services.AdGroupCriterionService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupCriterionService",
"methods": [
{
"shortName": "MutateAdGroupCriteria",
- "fullName": "google.ads.googleads.v10.services.AdGroupCriterionService.MutateAdGroupCriteria",
+ "fullName": "google.ads.googleads.v11.services.AdGroupCriterionService.MutateAdGroupCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adGroupCriteria:mutate"
+ "path": "/v11/customers/{customer_id=*}/adGroupCriteria:mutate"
}
]
}
@@ -454,16 +454,16 @@
},
{
"shortName": "AdGroupCustomizerService",
- "fullName": "google.ads.googleads.v10.services.AdGroupCustomizerService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupCustomizerService",
"methods": [
{
"shortName": "MutateAdGroupCustomizers",
- "fullName": "google.ads.googleads.v10.services.AdGroupCustomizerService.MutateAdGroupCustomizers",
+ "fullName": "google.ads.googleads.v11.services.AdGroupCustomizerService.MutateAdGroupCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adGroupCustomizers:mutate"
+ "path": "/v11/customers/{customer_id=*}/adGroupCustomizers:mutate"
}
]
}
@@ -471,16 +471,16 @@
},
{
"shortName": "AdGroupExtensionSettingService",
- "fullName": "google.ads.googleads.v10.services.AdGroupExtensionSettingService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupExtensionSettingService",
"methods": [
{
"shortName": "MutateAdGroupExtensionSettings",
- "fullName": "google.ads.googleads.v10.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings",
+ "fullName": "google.ads.googleads.v11.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adGroupExtensionSettings:mutate"
+ "path": "/v11/customers/{customer_id=*}/adGroupExtensionSettings:mutate"
}
]
}
@@ -488,16 +488,16 @@
},
{
"shortName": "AdGroupFeedService",
- "fullName": "google.ads.googleads.v10.services.AdGroupFeedService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupFeedService",
"methods": [
{
"shortName": "MutateAdGroupFeeds",
- "fullName": "google.ads.googleads.v10.services.AdGroupFeedService.MutateAdGroupFeeds",
+ "fullName": "google.ads.googleads.v11.services.AdGroupFeedService.MutateAdGroupFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adGroupFeeds:mutate"
+ "path": "/v11/customers/{customer_id=*}/adGroupFeeds:mutate"
}
]
}
@@ -505,16 +505,16 @@
},
{
"shortName": "AdGroupLabelService",
- "fullName": "google.ads.googleads.v10.services.AdGroupLabelService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupLabelService",
"methods": [
{
"shortName": "MutateAdGroupLabels",
- "fullName": "google.ads.googleads.v10.services.AdGroupLabelService.MutateAdGroupLabels",
+ "fullName": "google.ads.googleads.v11.services.AdGroupLabelService.MutateAdGroupLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adGroupLabels:mutate"
+ "path": "/v11/customers/{customer_id=*}/adGroupLabels:mutate"
}
]
}
@@ -522,16 +522,16 @@
},
{
"shortName": "AdGroupService",
- "fullName": "google.ads.googleads.v10.services.AdGroupService",
+ "fullName": "google.ads.googleads.v11.services.AdGroupService",
"methods": [
{
"shortName": "MutateAdGroups",
- "fullName": "google.ads.googleads.v10.services.AdGroupService.MutateAdGroups",
+ "fullName": "google.ads.googleads.v11.services.AdGroupService.MutateAdGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adGroups:mutate"
+ "path": "/v11/customers/{customer_id=*}/adGroups:mutate"
}
]
}
@@ -539,16 +539,16 @@
},
{
"shortName": "AdParameterService",
- "fullName": "google.ads.googleads.v10.services.AdParameterService",
+ "fullName": "google.ads.googleads.v11.services.AdParameterService",
"methods": [
{
"shortName": "MutateAdParameters",
- "fullName": "google.ads.googleads.v10.services.AdParameterService.MutateAdParameters",
+ "fullName": "google.ads.googleads.v11.services.AdParameterService.MutateAdParameters",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/adParameters:mutate"
+ "path": "/v11/customers/{customer_id=*}/adParameters:mutate"
}
]
}
@@ -556,27 +556,27 @@
},
{
"shortName": "AdService",
- "fullName": "google.ads.googleads.v10.services.AdService",
+ "fullName": "google.ads.googleads.v11.services.AdService",
"methods": [
{
"shortName": "GetAd",
- "fullName": "google.ads.googleads.v10.services.AdService.GetAd",
+ "fullName": "google.ads.googleads.v11.services.AdService.GetAd",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v10/{resource_name=customers/*/ads/*}"
+ "path": "/v11/{resource_name=customers/*/ads/*}"
}
]
},
{
"shortName": "MutateAds",
- "fullName": "google.ads.googleads.v10.services.AdService.MutateAds",
+ "fullName": "google.ads.googleads.v11.services.AdService.MutateAds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/ads:mutate"
+ "path": "/v11/customers/{customer_id=*}/ads:mutate"
}
]
}
@@ -584,16 +584,16 @@
},
{
"shortName": "AssetGroupAssetService",
- "fullName": "google.ads.googleads.v10.services.AssetGroupAssetService",
+ "fullName": "google.ads.googleads.v11.services.AssetGroupAssetService",
"methods": [
{
"shortName": "MutateAssetGroupAssets",
- "fullName": "google.ads.googleads.v10.services.AssetGroupAssetService.MutateAssetGroupAssets",
+ "fullName": "google.ads.googleads.v11.services.AssetGroupAssetService.MutateAssetGroupAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/assetGroupAssets:mutate"
+ "path": "/v11/customers/{customer_id=*}/assetGroupAssets:mutate"
}
]
}
@@ -601,16 +601,16 @@
},
{
"shortName": "AssetGroupListingGroupFilterService",
- "fullName": "google.ads.googleads.v10.services.AssetGroupListingGroupFilterService",
+ "fullName": "google.ads.googleads.v11.services.AssetGroupListingGroupFilterService",
"methods": [
{
"shortName": "MutateAssetGroupListingGroupFilters",
- "fullName": "google.ads.googleads.v10.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters",
+ "fullName": "google.ads.googleads.v11.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate"
+ "path": "/v11/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate"
}
]
}
@@ -618,16 +618,16 @@
},
{
"shortName": "AssetGroupService",
- "fullName": "google.ads.googleads.v10.services.AssetGroupService",
+ "fullName": "google.ads.googleads.v11.services.AssetGroupService",
"methods": [
{
"shortName": "MutateAssetGroups",
- "fullName": "google.ads.googleads.v10.services.AssetGroupService.MutateAssetGroups",
+ "fullName": "google.ads.googleads.v11.services.AssetGroupService.MutateAssetGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/assetGroups:mutate"
+ "path": "/v11/customers/{customer_id=*}/assetGroups:mutate"
}
]
}
@@ -635,16 +635,16 @@
},
{
"shortName": "AssetGroupSignalService",
- "fullName": "google.ads.googleads.v10.services.AssetGroupSignalService",
+ "fullName": "google.ads.googleads.v11.services.AssetGroupSignalService",
"methods": [
{
"shortName": "MutateAssetGroupSignals",
- "fullName": "google.ads.googleads.v10.services.AssetGroupSignalService.MutateAssetGroupSignals",
+ "fullName": "google.ads.googleads.v11.services.AssetGroupSignalService.MutateAssetGroupSignals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/assetGroupSignals:mutate"
+ "path": "/v11/customers/{customer_id=*}/assetGroupSignals:mutate"
}
]
}
@@ -652,16 +652,16 @@
},
{
"shortName": "AssetService",
- "fullName": "google.ads.googleads.v10.services.AssetService",
+ "fullName": "google.ads.googleads.v11.services.AssetService",
"methods": [
{
"shortName": "MutateAssets",
- "fullName": "google.ads.googleads.v10.services.AssetService.MutateAssets",
+ "fullName": "google.ads.googleads.v11.services.AssetService.MutateAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/assets:mutate"
+ "path": "/v11/customers/{customer_id=*}/assets:mutate"
}
]
}
@@ -669,16 +669,16 @@
},
{
"shortName": "AssetSetAssetService",
- "fullName": "google.ads.googleads.v10.services.AssetSetAssetService",
+ "fullName": "google.ads.googleads.v11.services.AssetSetAssetService",
"methods": [
{
"shortName": "MutateAssetSetAssets",
- "fullName": "google.ads.googleads.v10.services.AssetSetAssetService.MutateAssetSetAssets",
+ "fullName": "google.ads.googleads.v11.services.AssetSetAssetService.MutateAssetSetAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/assetSetAssets:mutate"
+ "path": "/v11/customers/{customer_id=*}/assetSetAssets:mutate"
}
]
}
@@ -686,16 +686,55 @@
},
{
"shortName": "AssetSetService",
- "fullName": "google.ads.googleads.v10.services.AssetSetService",
+ "fullName": "google.ads.googleads.v11.services.AssetSetService",
"methods": [
{
"shortName": "MutateAssetSets",
- "fullName": "google.ads.googleads.v10.services.AssetSetService.MutateAssetSets",
+ "fullName": "google.ads.googleads.v11.services.AssetSetService.MutateAssetSets",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v11/customers/{customer_id=*}/assetSets:mutate"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "shortName": "AudienceInsightsService",
+ "fullName": "google.ads.googleads.v11.services.AudienceInsightsService",
+ "methods": [
+ {
+ "shortName": "GenerateAudienceCompositionInsights",
+ "fullName": "google.ads.googleads.v11.services.AudienceInsightsService.GenerateAudienceCompositionInsights",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v11/customers/{customer_id=*}:generateAudienceCompositionInsights"
+ }
+ ]
+ },
+ {
+ "shortName": "GenerateInsightsFinderReport",
+ "fullName": "google.ads.googleads.v11.services.AudienceInsightsService.GenerateInsightsFinderReport",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v11/customers/{customer_id=*}:generateInsightsFinderReport"
+ }
+ ]
+ },
+ {
+ "shortName": "ListAudienceInsightsAttributes",
+ "fullName": "google.ads.googleads.v11.services.AudienceInsightsService.ListAudienceInsightsAttributes",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/assetSets:mutate"
+ "path": "/v11/customers/{customer_id=*}:searchAudienceInsightsAttributes"
}
]
}
@@ -703,16 +742,16 @@
},
{
"shortName": "AudienceService",
- "fullName": "google.ads.googleads.v10.services.AudienceService",
+ "fullName": "google.ads.googleads.v11.services.AudienceService",
"methods": [
{
"shortName": "MutateAudiences",
- "fullName": "google.ads.googleads.v10.services.AudienceService.MutateAudiences",
+ "fullName": "google.ads.googleads.v11.services.AudienceService.MutateAudiences",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/audiences:mutate"
+ "path": "/v11/customers/{customer_id=*}/audiences:mutate"
}
]
}
@@ -720,49 +759,49 @@
},
{
"shortName": "BatchJobService",
- "fullName": "google.ads.googleads.v10.services.BatchJobService",
+ "fullName": "google.ads.googleads.v11.services.BatchJobService",
"methods": [
{
"shortName": "AddBatchJobOperations",
- "fullName": "google.ads.googleads.v10.services.BatchJobService.AddBatchJobOperations",
+ "fullName": "google.ads.googleads.v11.services.BatchJobService.AddBatchJobOperations",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{resource_name=customers/*/batchJobs/*}:addOperations"
+ "path": "/v11/{resource_name=customers/*/batchJobs/*}:addOperations"
}
]
},
{
"shortName": "ListBatchJobResults",
- "fullName": "google.ads.googleads.v10.services.BatchJobService.ListBatchJobResults",
+ "fullName": "google.ads.googleads.v11.services.BatchJobService.ListBatchJobResults",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v10/{resource_name=customers/*/batchJobs/*}:listResults"
+ "path": "/v11/{resource_name=customers/*/batchJobs/*}:listResults"
}
]
},
{
"shortName": "MutateBatchJob",
- "fullName": "google.ads.googleads.v10.services.BatchJobService.MutateBatchJob",
+ "fullName": "google.ads.googleads.v11.services.BatchJobService.MutateBatchJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/batchJobs:mutate"
+ "path": "/v11/customers/{customer_id=*}/batchJobs:mutate"
}
]
},
{
"shortName": "RunBatchJob",
- "fullName": "google.ads.googleads.v10.services.BatchJobService.RunBatchJob",
+ "fullName": "google.ads.googleads.v11.services.BatchJobService.RunBatchJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{resource_name=customers/*/batchJobs/*}:run"
+ "path": "/v11/{resource_name=customers/*/batchJobs/*}:run"
}
]
}
@@ -770,16 +809,16 @@
},
{
"shortName": "BiddingDataExclusionService",
- "fullName": "google.ads.googleads.v10.services.BiddingDataExclusionService",
+ "fullName": "google.ads.googleads.v11.services.BiddingDataExclusionService",
"methods": [
{
"shortName": "MutateBiddingDataExclusions",
- "fullName": "google.ads.googleads.v10.services.BiddingDataExclusionService.MutateBiddingDataExclusions",
+ "fullName": "google.ads.googleads.v11.services.BiddingDataExclusionService.MutateBiddingDataExclusions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/biddingDataExclusions:mutate"
+ "path": "/v11/customers/{customer_id=*}/biddingDataExclusions:mutate"
}
]
}
@@ -787,16 +826,16 @@
},
{
"shortName": "BiddingSeasonalityAdjustmentService",
- "fullName": "google.ads.googleads.v10.services.BiddingSeasonalityAdjustmentService",
+ "fullName": "google.ads.googleads.v11.services.BiddingSeasonalityAdjustmentService",
"methods": [
{
"shortName": "MutateBiddingSeasonalityAdjustments",
- "fullName": "google.ads.googleads.v10.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments",
+ "fullName": "google.ads.googleads.v11.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate"
+ "path": "/v11/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate"
}
]
}
@@ -804,16 +843,16 @@
},
{
"shortName": "BiddingStrategyService",
- "fullName": "google.ads.googleads.v10.services.BiddingStrategyService",
+ "fullName": "google.ads.googleads.v11.services.BiddingStrategyService",
"methods": [
{
"shortName": "MutateBiddingStrategies",
- "fullName": "google.ads.googleads.v10.services.BiddingStrategyService.MutateBiddingStrategies",
+ "fullName": "google.ads.googleads.v11.services.BiddingStrategyService.MutateBiddingStrategies",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/biddingStrategies:mutate"
+ "path": "/v11/customers/{customer_id=*}/biddingStrategies:mutate"
}
]
}
@@ -821,16 +860,16 @@
},
{
"shortName": "BillingSetupService",
- "fullName": "google.ads.googleads.v10.services.BillingSetupService",
+ "fullName": "google.ads.googleads.v11.services.BillingSetupService",
"methods": [
{
"shortName": "MutateBillingSetup",
- "fullName": "google.ads.googleads.v10.services.BillingSetupService.MutateBillingSetup",
+ "fullName": "google.ads.googleads.v11.services.BillingSetupService.MutateBillingSetup",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/billingSetups:mutate"
+ "path": "/v11/customers/{customer_id=*}/billingSetups:mutate"
}
]
}
@@ -838,16 +877,16 @@
},
{
"shortName": "CampaignAssetService",
- "fullName": "google.ads.googleads.v10.services.CampaignAssetService",
+ "fullName": "google.ads.googleads.v11.services.CampaignAssetService",
"methods": [
{
"shortName": "MutateCampaignAssets",
- "fullName": "google.ads.googleads.v10.services.CampaignAssetService.MutateCampaignAssets",
+ "fullName": "google.ads.googleads.v11.services.CampaignAssetService.MutateCampaignAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignAssets:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignAssets:mutate"
}
]
}
@@ -855,16 +894,16 @@
},
{
"shortName": "CampaignAssetSetService",
- "fullName": "google.ads.googleads.v10.services.CampaignAssetSetService",
+ "fullName": "google.ads.googleads.v11.services.CampaignAssetSetService",
"methods": [
{
"shortName": "MutateCampaignAssetSets",
- "fullName": "google.ads.googleads.v10.services.CampaignAssetSetService.MutateCampaignAssetSets",
+ "fullName": "google.ads.googleads.v11.services.CampaignAssetSetService.MutateCampaignAssetSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignAssetSets:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignAssetSets:mutate"
}
]
}
@@ -872,16 +911,16 @@
},
{
"shortName": "CampaignBidModifierService",
- "fullName": "google.ads.googleads.v10.services.CampaignBidModifierService",
+ "fullName": "google.ads.googleads.v11.services.CampaignBidModifierService",
"methods": [
{
"shortName": "MutateCampaignBidModifiers",
- "fullName": "google.ads.googleads.v10.services.CampaignBidModifierService.MutateCampaignBidModifiers",
+ "fullName": "google.ads.googleads.v11.services.CampaignBidModifierService.MutateCampaignBidModifiers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignBidModifiers:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignBidModifiers:mutate"
}
]
}
@@ -889,16 +928,16 @@
},
{
"shortName": "CampaignBudgetService",
- "fullName": "google.ads.googleads.v10.services.CampaignBudgetService",
+ "fullName": "google.ads.googleads.v11.services.CampaignBudgetService",
"methods": [
{
"shortName": "MutateCampaignBudgets",
- "fullName": "google.ads.googleads.v10.services.CampaignBudgetService.MutateCampaignBudgets",
+ "fullName": "google.ads.googleads.v11.services.CampaignBudgetService.MutateCampaignBudgets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignBudgets:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignBudgets:mutate"
}
]
}
@@ -906,16 +945,16 @@
},
{
"shortName": "CampaignConversionGoalService",
- "fullName": "google.ads.googleads.v10.services.CampaignConversionGoalService",
+ "fullName": "google.ads.googleads.v11.services.CampaignConversionGoalService",
"methods": [
{
"shortName": "MutateCampaignConversionGoals",
- "fullName": "google.ads.googleads.v10.services.CampaignConversionGoalService.MutateCampaignConversionGoals",
+ "fullName": "google.ads.googleads.v11.services.CampaignConversionGoalService.MutateCampaignConversionGoals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignConversionGoals:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignConversionGoals:mutate"
}
]
}
@@ -923,16 +962,16 @@
},
{
"shortName": "CampaignCriterionService",
- "fullName": "google.ads.googleads.v10.services.CampaignCriterionService",
+ "fullName": "google.ads.googleads.v11.services.CampaignCriterionService",
"methods": [
{
"shortName": "MutateCampaignCriteria",
- "fullName": "google.ads.googleads.v10.services.CampaignCriterionService.MutateCampaignCriteria",
+ "fullName": "google.ads.googleads.v11.services.CampaignCriterionService.MutateCampaignCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignCriteria:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignCriteria:mutate"
}
]
}
@@ -940,16 +979,16 @@
},
{
"shortName": "CampaignCustomizerService",
- "fullName": "google.ads.googleads.v10.services.CampaignCustomizerService",
+ "fullName": "google.ads.googleads.v11.services.CampaignCustomizerService",
"methods": [
{
"shortName": "MutateCampaignCustomizers",
- "fullName": "google.ads.googleads.v10.services.CampaignCustomizerService.MutateCampaignCustomizers",
+ "fullName": "google.ads.googleads.v11.services.CampaignCustomizerService.MutateCampaignCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignCustomizers:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignCustomizers:mutate"
}
]
}
@@ -957,38 +996,38 @@
},
{
"shortName": "CampaignDraftService",
- "fullName": "google.ads.googleads.v10.services.CampaignDraftService",
+ "fullName": "google.ads.googleads.v11.services.CampaignDraftService",
"methods": [
{
"shortName": "ListCampaignDraftAsyncErrors",
- "fullName": "google.ads.googleads.v10.services.CampaignDraftService.ListCampaignDraftAsyncErrors",
+ "fullName": "google.ads.googleads.v11.services.CampaignDraftService.ListCampaignDraftAsyncErrors",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v10/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors"
+ "path": "/v11/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors"
}
]
},
{
"shortName": "MutateCampaignDrafts",
- "fullName": "google.ads.googleads.v10.services.CampaignDraftService.MutateCampaignDrafts",
+ "fullName": "google.ads.googleads.v11.services.CampaignDraftService.MutateCampaignDrafts",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignDrafts:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignDrafts:mutate"
}
]
},
{
"shortName": "PromoteCampaignDraft",
- "fullName": "google.ads.googleads.v10.services.CampaignDraftService.PromoteCampaignDraft",
+ "fullName": "google.ads.googleads.v11.services.CampaignDraftService.PromoteCampaignDraft",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{campaign_draft=customers/*/campaignDrafts/*}:promote"
+ "path": "/v11/{campaign_draft=customers/*/campaignDrafts/*}:promote"
}
]
}
@@ -996,71 +1035,71 @@
},
{
"shortName": "CampaignExperimentService",
- "fullName": "google.ads.googleads.v10.services.CampaignExperimentService",
+ "fullName": "google.ads.googleads.v11.services.CampaignExperimentService",
"methods": [
{
"shortName": "CreateCampaignExperiment",
- "fullName": "google.ads.googleads.v10.services.CampaignExperimentService.CreateCampaignExperiment",
+ "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.CreateCampaignExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignExperiments:create"
+ "path": "/v11/customers/{customer_id=*}/campaignExperiments:create"
}
]
},
{
"shortName": "EndCampaignExperiment",
- "fullName": "google.ads.googleads.v10.services.CampaignExperimentService.EndCampaignExperiment",
+ "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.EndCampaignExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{campaign_experiment=customers/*/campaignExperiments/*}:end"
+ "path": "/v11/{campaign_experiment=customers/*/campaignExperiments/*}:end"
}
]
},
{
"shortName": "GraduateCampaignExperiment",
- "fullName": "google.ads.googleads.v10.services.CampaignExperimentService.GraduateCampaignExperiment",
+ "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.GraduateCampaignExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{campaign_experiment=customers/*/campaignExperiments/*}:graduate"
+ "path": "/v11/{campaign_experiment=customers/*/campaignExperiments/*}:graduate"
}
]
},
{
"shortName": "ListCampaignExperimentAsyncErrors",
- "fullName": "google.ads.googleads.v10.services.CampaignExperimentService.ListCampaignExperimentAsyncErrors",
+ "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.ListCampaignExperimentAsyncErrors",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v10/{resource_name=customers/*/campaignExperiments/*}:listAsyncErrors"
+ "path": "/v11/{resource_name=customers/*/campaignExperiments/*}:listAsyncErrors"
}
]
},
{
"shortName": "MutateCampaignExperiments",
- "fullName": "google.ads.googleads.v10.services.CampaignExperimentService.MutateCampaignExperiments",
+ "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.MutateCampaignExperiments",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignExperiments:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignExperiments:mutate"
}
]
},
{
"shortName": "PromoteCampaignExperiment",
- "fullName": "google.ads.googleads.v10.services.CampaignExperimentService.PromoteCampaignExperiment",
+ "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.PromoteCampaignExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{campaign_experiment=customers/*/campaignExperiments/*}:promote"
+ "path": "/v11/{campaign_experiment=customers/*/campaignExperiments/*}:promote"
}
]
}
@@ -1068,16 +1107,16 @@
},
{
"shortName": "CampaignExtensionSettingService",
- "fullName": "google.ads.googleads.v10.services.CampaignExtensionSettingService",
+ "fullName": "google.ads.googleads.v11.services.CampaignExtensionSettingService",
"methods": [
{
"shortName": "MutateCampaignExtensionSettings",
- "fullName": "google.ads.googleads.v10.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings",
+ "fullName": "google.ads.googleads.v11.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignExtensionSettings:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignExtensionSettings:mutate"
}
]
}
@@ -1085,16 +1124,16 @@
},
{
"shortName": "CampaignFeedService",
- "fullName": "google.ads.googleads.v10.services.CampaignFeedService",
+ "fullName": "google.ads.googleads.v11.services.CampaignFeedService",
"methods": [
{
"shortName": "MutateCampaignFeeds",
- "fullName": "google.ads.googleads.v10.services.CampaignFeedService.MutateCampaignFeeds",
+ "fullName": "google.ads.googleads.v11.services.CampaignFeedService.MutateCampaignFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignFeeds:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignFeeds:mutate"
}
]
}
@@ -1102,16 +1141,16 @@
},
{
"shortName": "CampaignGroupService",
- "fullName": "google.ads.googleads.v10.services.CampaignGroupService",
+ "fullName": "google.ads.googleads.v11.services.CampaignGroupService",
"methods": [
{
"shortName": "MutateCampaignGroups",
- "fullName": "google.ads.googleads.v10.services.CampaignGroupService.MutateCampaignGroups",
+ "fullName": "google.ads.googleads.v11.services.CampaignGroupService.MutateCampaignGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignGroups:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignGroups:mutate"
}
]
}
@@ -1119,16 +1158,16 @@
},
{
"shortName": "CampaignLabelService",
- "fullName": "google.ads.googleads.v10.services.CampaignLabelService",
+ "fullName": "google.ads.googleads.v11.services.CampaignLabelService",
"methods": [
{
"shortName": "MutateCampaignLabels",
- "fullName": "google.ads.googleads.v10.services.CampaignLabelService.MutateCampaignLabels",
+ "fullName": "google.ads.googleads.v11.services.CampaignLabelService.MutateCampaignLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignLabels:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignLabels:mutate"
}
]
}
@@ -1136,16 +1175,16 @@
},
{
"shortName": "CampaignService",
- "fullName": "google.ads.googleads.v10.services.CampaignService",
+ "fullName": "google.ads.googleads.v11.services.CampaignService",
"methods": [
{
"shortName": "MutateCampaigns",
- "fullName": "google.ads.googleads.v10.services.CampaignService.MutateCampaigns",
+ "fullName": "google.ads.googleads.v11.services.CampaignService.MutateCampaigns",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaigns:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaigns:mutate"
}
]
}
@@ -1153,16 +1192,16 @@
},
{
"shortName": "CampaignSharedSetService",
- "fullName": "google.ads.googleads.v10.services.CampaignSharedSetService",
+ "fullName": "google.ads.googleads.v11.services.CampaignSharedSetService",
"methods": [
{
"shortName": "MutateCampaignSharedSets",
- "fullName": "google.ads.googleads.v10.services.CampaignSharedSetService.MutateCampaignSharedSets",
+ "fullName": "google.ads.googleads.v11.services.CampaignSharedSetService.MutateCampaignSharedSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/campaignSharedSets:mutate"
+ "path": "/v11/customers/{customer_id=*}/campaignSharedSets:mutate"
}
]
}
@@ -1170,16 +1209,16 @@
},
{
"shortName": "ConversionActionService",
- "fullName": "google.ads.googleads.v10.services.ConversionActionService",
+ "fullName": "google.ads.googleads.v11.services.ConversionActionService",
"methods": [
{
"shortName": "MutateConversionActions",
- "fullName": "google.ads.googleads.v10.services.ConversionActionService.MutateConversionActions",
+ "fullName": "google.ads.googleads.v11.services.ConversionActionService.MutateConversionActions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/conversionActions:mutate"
+ "path": "/v11/customers/{customer_id=*}/conversionActions:mutate"
}
]
}
@@ -1187,16 +1226,16 @@
},
{
"shortName": "ConversionAdjustmentUploadService",
- "fullName": "google.ads.googleads.v10.services.ConversionAdjustmentUploadService",
+ "fullName": "google.ads.googleads.v11.services.ConversionAdjustmentUploadService",
"methods": [
{
"shortName": "UploadConversionAdjustments",
- "fullName": "google.ads.googleads.v10.services.ConversionAdjustmentUploadService.UploadConversionAdjustments",
+ "fullName": "google.ads.googleads.v11.services.ConversionAdjustmentUploadService.UploadConversionAdjustments",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:uploadConversionAdjustments"
+ "path": "/v11/customers/{customer_id=*}:uploadConversionAdjustments"
}
]
}
@@ -1204,16 +1243,16 @@
},
{
"shortName": "ConversionCustomVariableService",
- "fullName": "google.ads.googleads.v10.services.ConversionCustomVariableService",
+ "fullName": "google.ads.googleads.v11.services.ConversionCustomVariableService",
"methods": [
{
"shortName": "MutateConversionCustomVariables",
- "fullName": "google.ads.googleads.v10.services.ConversionCustomVariableService.MutateConversionCustomVariables",
+ "fullName": "google.ads.googleads.v11.services.ConversionCustomVariableService.MutateConversionCustomVariables",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/conversionCustomVariables:mutate"
+ "path": "/v11/customers/{customer_id=*}/conversionCustomVariables:mutate"
}
]
}
@@ -1221,16 +1260,16 @@
},
{
"shortName": "ConversionGoalCampaignConfigService",
- "fullName": "google.ads.googleads.v10.services.ConversionGoalCampaignConfigService",
+ "fullName": "google.ads.googleads.v11.services.ConversionGoalCampaignConfigService",
"methods": [
{
"shortName": "MutateConversionGoalCampaignConfigs",
- "fullName": "google.ads.googleads.v10.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs",
+ "fullName": "google.ads.googleads.v11.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate"
+ "path": "/v11/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate"
}
]
}
@@ -1238,27 +1277,27 @@
},
{
"shortName": "ConversionUploadService",
- "fullName": "google.ads.googleads.v10.services.ConversionUploadService",
+ "fullName": "google.ads.googleads.v11.services.ConversionUploadService",
"methods": [
{
"shortName": "UploadCallConversions",
- "fullName": "google.ads.googleads.v10.services.ConversionUploadService.UploadCallConversions",
+ "fullName": "google.ads.googleads.v11.services.ConversionUploadService.UploadCallConversions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:uploadCallConversions"
+ "path": "/v11/customers/{customer_id=*}:uploadCallConversions"
}
]
},
{
"shortName": "UploadClickConversions",
- "fullName": "google.ads.googleads.v10.services.ConversionUploadService.UploadClickConversions",
+ "fullName": "google.ads.googleads.v11.services.ConversionUploadService.UploadClickConversions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:uploadClickConversions"
+ "path": "/v11/customers/{customer_id=*}:uploadClickConversions"
}
]
}
@@ -1266,16 +1305,16 @@
},
{
"shortName": "ConversionValueRuleService",
- "fullName": "google.ads.googleads.v10.services.ConversionValueRuleService",
+ "fullName": "google.ads.googleads.v11.services.ConversionValueRuleService",
"methods": [
{
"shortName": "MutateConversionValueRules",
- "fullName": "google.ads.googleads.v10.services.ConversionValueRuleService.MutateConversionValueRules",
+ "fullName": "google.ads.googleads.v11.services.ConversionValueRuleService.MutateConversionValueRules",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/conversionValueRules:mutate"
+ "path": "/v11/customers/{customer_id=*}/conversionValueRules:mutate"
}
]
}
@@ -1283,16 +1322,16 @@
},
{
"shortName": "ConversionValueRuleSetService",
- "fullName": "google.ads.googleads.v10.services.ConversionValueRuleSetService",
+ "fullName": "google.ads.googleads.v11.services.ConversionValueRuleSetService",
"methods": [
{
"shortName": "MutateConversionValueRuleSets",
- "fullName": "google.ads.googleads.v10.services.ConversionValueRuleSetService.MutateConversionValueRuleSets",
+ "fullName": "google.ads.googleads.v11.services.ConversionValueRuleSetService.MutateConversionValueRuleSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/conversionValueRuleSets:mutate"
+ "path": "/v11/customers/{customer_id=*}/conversionValueRuleSets:mutate"
}
]
}
@@ -1300,16 +1339,16 @@
},
{
"shortName": "CustomAudienceService",
- "fullName": "google.ads.googleads.v10.services.CustomAudienceService",
+ "fullName": "google.ads.googleads.v11.services.CustomAudienceService",
"methods": [
{
"shortName": "MutateCustomAudiences",
- "fullName": "google.ads.googleads.v10.services.CustomAudienceService.MutateCustomAudiences",
+ "fullName": "google.ads.googleads.v11.services.CustomAudienceService.MutateCustomAudiences",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customAudiences:mutate"
+ "path": "/v11/customers/{customer_id=*}/customAudiences:mutate"
}
]
}
@@ -1317,16 +1356,16 @@
},
{
"shortName": "CustomConversionGoalService",
- "fullName": "google.ads.googleads.v10.services.CustomConversionGoalService",
+ "fullName": "google.ads.googleads.v11.services.CustomConversionGoalService",
"methods": [
{
"shortName": "MutateCustomConversionGoals",
- "fullName": "google.ads.googleads.v10.services.CustomConversionGoalService.MutateCustomConversionGoals",
+ "fullName": "google.ads.googleads.v11.services.CustomConversionGoalService.MutateCustomConversionGoals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customConversionGoals:mutate"
+ "path": "/v11/customers/{customer_id=*}/customConversionGoals:mutate"
}
]
}
@@ -1334,16 +1373,16 @@
},
{
"shortName": "CustomInterestService",
- "fullName": "google.ads.googleads.v10.services.CustomInterestService",
+ "fullName": "google.ads.googleads.v11.services.CustomInterestService",
"methods": [
{
"shortName": "MutateCustomInterests",
- "fullName": "google.ads.googleads.v10.services.CustomInterestService.MutateCustomInterests",
+ "fullName": "google.ads.googleads.v11.services.CustomInterestService.MutateCustomInterests",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customInterests:mutate"
+ "path": "/v11/customers/{customer_id=*}/customInterests:mutate"
}
]
}
@@ -1351,16 +1390,16 @@
},
{
"shortName": "CustomerAssetService",
- "fullName": "google.ads.googleads.v10.services.CustomerAssetService",
+ "fullName": "google.ads.googleads.v11.services.CustomerAssetService",
"methods": [
{
"shortName": "MutateCustomerAssets",
- "fullName": "google.ads.googleads.v10.services.CustomerAssetService.MutateCustomerAssets",
+ "fullName": "google.ads.googleads.v11.services.CustomerAssetService.MutateCustomerAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customerAssets:mutate"
+ "path": "/v11/customers/{customer_id=*}/customerAssets:mutate"
}
]
}
@@ -1368,16 +1407,16 @@
},
{
"shortName": "CustomerClientLinkService",
- "fullName": "google.ads.googleads.v10.services.CustomerClientLinkService",
+ "fullName": "google.ads.googleads.v11.services.CustomerClientLinkService",
"methods": [
{
"shortName": "MutateCustomerClientLink",
- "fullName": "google.ads.googleads.v10.services.CustomerClientLinkService.MutateCustomerClientLink",
+ "fullName": "google.ads.googleads.v11.services.CustomerClientLinkService.MutateCustomerClientLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customerClientLinks:mutate"
+ "path": "/v11/customers/{customer_id=*}/customerClientLinks:mutate"
}
]
}
@@ -1385,16 +1424,16 @@
},
{
"shortName": "CustomerConversionGoalService",
- "fullName": "google.ads.googleads.v10.services.CustomerConversionGoalService",
+ "fullName": "google.ads.googleads.v11.services.CustomerConversionGoalService",
"methods": [
{
"shortName": "MutateCustomerConversionGoals",
- "fullName": "google.ads.googleads.v10.services.CustomerConversionGoalService.MutateCustomerConversionGoals",
+ "fullName": "google.ads.googleads.v11.services.CustomerConversionGoalService.MutateCustomerConversionGoals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customerConversionGoals:mutate"
+ "path": "/v11/customers/{customer_id=*}/customerConversionGoals:mutate"
}
]
}
@@ -1402,16 +1441,16 @@
},
{
"shortName": "CustomerCustomizerService",
- "fullName": "google.ads.googleads.v10.services.CustomerCustomizerService",
+ "fullName": "google.ads.googleads.v11.services.CustomerCustomizerService",
"methods": [
{
"shortName": "MutateCustomerCustomizers",
- "fullName": "google.ads.googleads.v10.services.CustomerCustomizerService.MutateCustomerCustomizers",
+ "fullName": "google.ads.googleads.v11.services.CustomerCustomizerService.MutateCustomerCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/CustomerCustomizers:mutate"
+ "path": "/v11/customers/{customer_id=*}/CustomerCustomizers:mutate"
}
]
}
@@ -1419,16 +1458,16 @@
},
{
"shortName": "CustomerExtensionSettingService",
- "fullName": "google.ads.googleads.v10.services.CustomerExtensionSettingService",
+ "fullName": "google.ads.googleads.v11.services.CustomerExtensionSettingService",
"methods": [
{
"shortName": "MutateCustomerExtensionSettings",
- "fullName": "google.ads.googleads.v10.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings",
+ "fullName": "google.ads.googleads.v11.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customerExtensionSettings:mutate"
+ "path": "/v11/customers/{customer_id=*}/customerExtensionSettings:mutate"
}
]
}
@@ -1436,16 +1475,16 @@
},
{
"shortName": "CustomerFeedService",
- "fullName": "google.ads.googleads.v10.services.CustomerFeedService",
+ "fullName": "google.ads.googleads.v11.services.CustomerFeedService",
"methods": [
{
"shortName": "MutateCustomerFeeds",
- "fullName": "google.ads.googleads.v10.services.CustomerFeedService.MutateCustomerFeeds",
+ "fullName": "google.ads.googleads.v11.services.CustomerFeedService.MutateCustomerFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customerFeeds:mutate"
+ "path": "/v11/customers/{customer_id=*}/customerFeeds:mutate"
}
]
}
@@ -1453,16 +1492,16 @@
},
{
"shortName": "CustomerLabelService",
- "fullName": "google.ads.googleads.v10.services.CustomerLabelService",
+ "fullName": "google.ads.googleads.v11.services.CustomerLabelService",
"methods": [
{
"shortName": "MutateCustomerLabels",
- "fullName": "google.ads.googleads.v10.services.CustomerLabelService.MutateCustomerLabels",
+ "fullName": "google.ads.googleads.v11.services.CustomerLabelService.MutateCustomerLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customerLabels:mutate"
+ "path": "/v11/customers/{customer_id=*}/customerLabels:mutate"
}
]
}
@@ -1470,27 +1509,27 @@
},
{
"shortName": "CustomerManagerLinkService",
- "fullName": "google.ads.googleads.v10.services.CustomerManagerLinkService",
+ "fullName": "google.ads.googleads.v11.services.CustomerManagerLinkService",
"methods": [
{
"shortName": "MoveManagerLink",
- "fullName": "google.ads.googleads.v10.services.CustomerManagerLinkService.MoveManagerLink",
+ "fullName": "google.ads.googleads.v11.services.CustomerManagerLinkService.MoveManagerLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customerManagerLinks:moveManagerLink"
+ "path": "/v11/customers/{customer_id=*}/customerManagerLinks:moveManagerLink"
}
]
},
{
"shortName": "MutateCustomerManagerLink",
- "fullName": "google.ads.googleads.v10.services.CustomerManagerLinkService.MutateCustomerManagerLink",
+ "fullName": "google.ads.googleads.v11.services.CustomerManagerLinkService.MutateCustomerManagerLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customerManagerLinks:mutate"
+ "path": "/v11/customers/{customer_id=*}/customerManagerLinks:mutate"
}
]
}
@@ -1498,16 +1537,16 @@
},
{
"shortName": "CustomerNegativeCriterionService",
- "fullName": "google.ads.googleads.v10.services.CustomerNegativeCriterionService",
+ "fullName": "google.ads.googleads.v11.services.CustomerNegativeCriterionService",
"methods": [
{
"shortName": "MutateCustomerNegativeCriteria",
- "fullName": "google.ads.googleads.v10.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria",
+ "fullName": "google.ads.googleads.v11.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customerNegativeCriteria:mutate"
+ "path": "/v11/customers/{customer_id=*}/customerNegativeCriteria:mutate"
}
]
}
@@ -1515,38 +1554,38 @@
},
{
"shortName": "CustomerService",
- "fullName": "google.ads.googleads.v10.services.CustomerService",
+ "fullName": "google.ads.googleads.v11.services.CustomerService",
"methods": [
{
"shortName": "CreateCustomerClient",
- "fullName": "google.ads.googleads.v10.services.CustomerService.CreateCustomerClient",
+ "fullName": "google.ads.googleads.v11.services.CustomerService.CreateCustomerClient",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:createCustomerClient"
+ "path": "/v11/customers/{customer_id=*}:createCustomerClient"
}
]
},
{
"shortName": "ListAccessibleCustomers",
- "fullName": "google.ads.googleads.v10.services.CustomerService.ListAccessibleCustomers",
+ "fullName": "google.ads.googleads.v11.services.CustomerService.ListAccessibleCustomers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v10/customers:listAccessibleCustomers"
+ "path": "/v11/customers:listAccessibleCustomers"
}
]
},
{
"shortName": "MutateCustomer",
- "fullName": "google.ads.googleads.v10.services.CustomerService.MutateCustomer",
+ "fullName": "google.ads.googleads.v11.services.CustomerService.MutateCustomer",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:mutate"
+ "path": "/v11/customers/{customer_id=*}:mutate"
}
]
}
@@ -1554,16 +1593,16 @@
},
{
"shortName": "CustomerUserAccessInvitationService",
- "fullName": "google.ads.googleads.v10.services.CustomerUserAccessInvitationService",
+ "fullName": "google.ads.googleads.v11.services.CustomerUserAccessInvitationService",
"methods": [
{
"shortName": "MutateCustomerUserAccessInvitation",
- "fullName": "google.ads.googleads.v10.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation",
+ "fullName": "google.ads.googleads.v11.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customerUserAccessInvitations:mutate"
+ "path": "/v11/customers/{customer_id=*}/customerUserAccessInvitations:mutate"
}
]
}
@@ -1571,16 +1610,16 @@
},
{
"shortName": "CustomerUserAccessService",
- "fullName": "google.ads.googleads.v10.services.CustomerUserAccessService",
+ "fullName": "google.ads.googleads.v11.services.CustomerUserAccessService",
"methods": [
{
"shortName": "MutateCustomerUserAccess",
- "fullName": "google.ads.googleads.v10.services.CustomerUserAccessService.MutateCustomerUserAccess",
+ "fullName": "google.ads.googleads.v11.services.CustomerUserAccessService.MutateCustomerUserAccess",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customerUserAccesses:mutate"
+ "path": "/v11/customers/{customer_id=*}/customerUserAccesses:mutate"
}
]
}
@@ -1588,16 +1627,16 @@
},
{
"shortName": "CustomizerAttributeService",
- "fullName": "google.ads.googleads.v10.services.CustomizerAttributeService",
+ "fullName": "google.ads.googleads.v11.services.CustomizerAttributeService",
"methods": [
{
"shortName": "MutateCustomizerAttributes",
- "fullName": "google.ads.googleads.v10.services.CustomizerAttributeService.MutateCustomizerAttributes",
+ "fullName": "google.ads.googleads.v11.services.CustomizerAttributeService.MutateCustomizerAttributes",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/customizerAttributes:mutate"
+ "path": "/v11/customers/{customer_id=*}/customizerAttributes:mutate"
}
]
}
@@ -1605,16 +1644,16 @@
},
{
"shortName": "ExperimentArmService",
- "fullName": "google.ads.googleads.v10.services.ExperimentArmService",
+ "fullName": "google.ads.googleads.v11.services.ExperimentArmService",
"methods": [
{
"shortName": "MutateExperimentArms",
- "fullName": "google.ads.googleads.v10.services.ExperimentArmService.MutateExperimentArms",
+ "fullName": "google.ads.googleads.v11.services.ExperimentArmService.MutateExperimentArms",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/experimentArms:mutate"
+ "path": "/v11/customers/{customer_id=*}/experimentArms:mutate"
}
]
}
@@ -1622,71 +1661,71 @@
},
{
"shortName": "ExperimentService",
- "fullName": "google.ads.googleads.v10.services.ExperimentService",
+ "fullName": "google.ads.googleads.v11.services.ExperimentService",
"methods": [
{
"shortName": "EndExperiment",
- "fullName": "google.ads.googleads.v10.services.ExperimentService.EndExperiment",
+ "fullName": "google.ads.googleads.v11.services.ExperimentService.EndExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{experiment=customers/*/experiments/*}:endExperiment"
+ "path": "/v11/{experiment=customers/*/experiments/*}:endExperiment"
}
]
},
{
"shortName": "GraduateExperiment",
- "fullName": "google.ads.googleads.v10.services.ExperimentService.GraduateExperiment",
+ "fullName": "google.ads.googleads.v11.services.ExperimentService.GraduateExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{experiment=customers/*/experiments/*}:graduateExperiment"
+ "path": "/v11/{experiment=customers/*/experiments/*}:graduateExperiment"
}
]
},
{
"shortName": "ListExperimentAsyncErrors",
- "fullName": "google.ads.googleads.v10.services.ExperimentService.ListExperimentAsyncErrors",
+ "fullName": "google.ads.googleads.v11.services.ExperimentService.ListExperimentAsyncErrors",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v10/{resource_name=customers/*/experiments/*}:listExperimentAsyncErrors"
+ "path": "/v11/{resource_name=customers/*/experiments/*}:listExperimentAsyncErrors"
}
]
},
{
"shortName": "MutateExperiments",
- "fullName": "google.ads.googleads.v10.services.ExperimentService.MutateExperiments",
+ "fullName": "google.ads.googleads.v11.services.ExperimentService.MutateExperiments",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/experiments:mutate"
+ "path": "/v11/customers/{customer_id=*}/experiments:mutate"
}
]
},
{
"shortName": "PromoteExperiment",
- "fullName": "google.ads.googleads.v10.services.ExperimentService.PromoteExperiment",
+ "fullName": "google.ads.googleads.v11.services.ExperimentService.PromoteExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{resource_name=customers/*/experiments/*}:promoteExperiment"
+ "path": "/v11/{resource_name=customers/*/experiments/*}:promoteExperiment"
}
]
},
{
"shortName": "ScheduleExperiment",
- "fullName": "google.ads.googleads.v10.services.ExperimentService.ScheduleExperiment",
+ "fullName": "google.ads.googleads.v11.services.ExperimentService.ScheduleExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{resource_name=customers/*/experiments/*}:scheduleExperiment"
+ "path": "/v11/{resource_name=customers/*/experiments/*}:scheduleExperiment"
}
]
}
@@ -1694,16 +1733,16 @@
},
{
"shortName": "ExtensionFeedItemService",
- "fullName": "google.ads.googleads.v10.services.ExtensionFeedItemService",
+ "fullName": "google.ads.googleads.v11.services.ExtensionFeedItemService",
"methods": [
{
"shortName": "MutateExtensionFeedItems",
- "fullName": "google.ads.googleads.v10.services.ExtensionFeedItemService.MutateExtensionFeedItems",
+ "fullName": "google.ads.googleads.v11.services.ExtensionFeedItemService.MutateExtensionFeedItems",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/extensionFeedItems:mutate"
+ "path": "/v11/customers/{customer_id=*}/extensionFeedItems:mutate"
}
]
}
@@ -1711,16 +1750,16 @@
},
{
"shortName": "FeedItemService",
- "fullName": "google.ads.googleads.v10.services.FeedItemService",
+ "fullName": "google.ads.googleads.v11.services.FeedItemService",
"methods": [
{
"shortName": "MutateFeedItems",
- "fullName": "google.ads.googleads.v10.services.FeedItemService.MutateFeedItems",
+ "fullName": "google.ads.googleads.v11.services.FeedItemService.MutateFeedItems",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/feedItems:mutate"
+ "path": "/v11/customers/{customer_id=*}/feedItems:mutate"
}
]
}
@@ -1728,16 +1767,16 @@
},
{
"shortName": "FeedItemSetLinkService",
- "fullName": "google.ads.googleads.v10.services.FeedItemSetLinkService",
+ "fullName": "google.ads.googleads.v11.services.FeedItemSetLinkService",
"methods": [
{
"shortName": "MutateFeedItemSetLinks",
- "fullName": "google.ads.googleads.v10.services.FeedItemSetLinkService.MutateFeedItemSetLinks",
+ "fullName": "google.ads.googleads.v11.services.FeedItemSetLinkService.MutateFeedItemSetLinks",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/feedItemSetLinks:mutate"
+ "path": "/v11/customers/{customer_id=*}/feedItemSetLinks:mutate"
}
]
}
@@ -1745,16 +1784,16 @@
},
{
"shortName": "FeedItemSetService",
- "fullName": "google.ads.googleads.v10.services.FeedItemSetService",
+ "fullName": "google.ads.googleads.v11.services.FeedItemSetService",
"methods": [
{
"shortName": "MutateFeedItemSets",
- "fullName": "google.ads.googleads.v10.services.FeedItemSetService.MutateFeedItemSets",
+ "fullName": "google.ads.googleads.v11.services.FeedItemSetService.MutateFeedItemSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/feedItemSets:mutate"
+ "path": "/v11/customers/{customer_id=*}/feedItemSets:mutate"
}
]
}
@@ -1762,16 +1801,16 @@
},
{
"shortName": "FeedItemTargetService",
- "fullName": "google.ads.googleads.v10.services.FeedItemTargetService",
+ "fullName": "google.ads.googleads.v11.services.FeedItemTargetService",
"methods": [
{
"shortName": "MutateFeedItemTargets",
- "fullName": "google.ads.googleads.v10.services.FeedItemTargetService.MutateFeedItemTargets",
+ "fullName": "google.ads.googleads.v11.services.FeedItemTargetService.MutateFeedItemTargets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/feedItemTargets:mutate"
+ "path": "/v11/customers/{customer_id=*}/feedItemTargets:mutate"
}
]
}
@@ -1779,16 +1818,16 @@
},
{
"shortName": "FeedMappingService",
- "fullName": "google.ads.googleads.v10.services.FeedMappingService",
+ "fullName": "google.ads.googleads.v11.services.FeedMappingService",
"methods": [
{
"shortName": "MutateFeedMappings",
- "fullName": "google.ads.googleads.v10.services.FeedMappingService.MutateFeedMappings",
+ "fullName": "google.ads.googleads.v11.services.FeedMappingService.MutateFeedMappings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/feedMappings:mutate"
+ "path": "/v11/customers/{customer_id=*}/feedMappings:mutate"
}
]
}
@@ -1796,16 +1835,16 @@
},
{
"shortName": "FeedService",
- "fullName": "google.ads.googleads.v10.services.FeedService",
+ "fullName": "google.ads.googleads.v11.services.FeedService",
"methods": [
{
"shortName": "MutateFeeds",
- "fullName": "google.ads.googleads.v10.services.FeedService.MutateFeeds",
+ "fullName": "google.ads.googleads.v11.services.FeedService.MutateFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/feeds:mutate"
+ "path": "/v11/customers/{customer_id=*}/feeds:mutate"
}
]
}
@@ -1813,16 +1852,16 @@
},
{
"shortName": "GeoTargetConstantService",
- "fullName": "google.ads.googleads.v10.services.GeoTargetConstantService",
+ "fullName": "google.ads.googleads.v11.services.GeoTargetConstantService",
"methods": [
{
"shortName": "SuggestGeoTargetConstants",
- "fullName": "google.ads.googleads.v10.services.GeoTargetConstantService.SuggestGeoTargetConstants",
+ "fullName": "google.ads.googleads.v11.services.GeoTargetConstantService.SuggestGeoTargetConstants",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/geoTargetConstants:suggest"
+ "path": "/v11/geoTargetConstants:suggest"
}
]
}
@@ -1830,27 +1869,27 @@
},
{
"shortName": "GoogleAdsFieldService",
- "fullName": "google.ads.googleads.v10.services.GoogleAdsFieldService",
+ "fullName": "google.ads.googleads.v11.services.GoogleAdsFieldService",
"methods": [
{
"shortName": "GetGoogleAdsField",
- "fullName": "google.ads.googleads.v10.services.GoogleAdsFieldService.GetGoogleAdsField",
+ "fullName": "google.ads.googleads.v11.services.GoogleAdsFieldService.GetGoogleAdsField",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v10/{resource_name=googleAdsFields/*}"
+ "path": "/v11/{resource_name=googleAdsFields/*}"
}
]
},
{
"shortName": "SearchGoogleAdsFields",
- "fullName": "google.ads.googleads.v10.services.GoogleAdsFieldService.SearchGoogleAdsFields",
+ "fullName": "google.ads.googleads.v11.services.GoogleAdsFieldService.SearchGoogleAdsFields",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/googleAdsFields:search"
+ "path": "/v11/googleAdsFields:search"
}
]
}
@@ -1858,38 +1897,38 @@
},
{
"shortName": "GoogleAdsService",
- "fullName": "google.ads.googleads.v10.services.GoogleAdsService",
+ "fullName": "google.ads.googleads.v11.services.GoogleAdsService",
"methods": [
{
"shortName": "Mutate",
- "fullName": "google.ads.googleads.v10.services.GoogleAdsService.Mutate",
+ "fullName": "google.ads.googleads.v11.services.GoogleAdsService.Mutate",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/googleAds:mutate"
+ "path": "/v11/customers/{customer_id=*}/googleAds:mutate"
}
]
},
{
"shortName": "Search",
- "fullName": "google.ads.googleads.v10.services.GoogleAdsService.Search",
+ "fullName": "google.ads.googleads.v11.services.GoogleAdsService.Search",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/googleAds:search"
+ "path": "/v11/customers/{customer_id=*}/googleAds:search"
}
]
},
{
"shortName": "SearchStream",
- "fullName": "google.ads.googleads.v10.services.GoogleAdsService.SearchStream",
+ "fullName": "google.ads.googleads.v11.services.GoogleAdsService.SearchStream",
"mode": "SERVER_STREAMING",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/googleAds:searchStream"
+ "path": "/v11/customers/{customer_id=*}/googleAds:searchStream"
}
]
}
@@ -1897,16 +1936,16 @@
},
{
"shortName": "InvoiceService",
- "fullName": "google.ads.googleads.v10.services.InvoiceService",
+ "fullName": "google.ads.googleads.v11.services.InvoiceService",
"methods": [
{
"shortName": "ListInvoices",
- "fullName": "google.ads.googleads.v10.services.InvoiceService.ListInvoices",
+ "fullName": "google.ads.googleads.v11.services.InvoiceService.ListInvoices",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v10/customers/{customer_id=*}/invoices"
+ "path": "/v11/customers/{customer_id=*}/invoices"
}
]
}
@@ -1914,16 +1953,16 @@
},
{
"shortName": "KeywordPlanAdGroupKeywordService",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanAdGroupKeywordService",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanAdGroupKeywordService",
"methods": [
{
"shortName": "MutateKeywordPlanAdGroupKeywords",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate"
+ "path": "/v11/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate"
}
]
}
@@ -1931,16 +1970,16 @@
},
{
"shortName": "KeywordPlanAdGroupService",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanAdGroupService",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanAdGroupService",
"methods": [
{
"shortName": "MutateKeywordPlanAdGroups",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/keywordPlanAdGroups:mutate"
+ "path": "/v11/customers/{customer_id=*}/keywordPlanAdGroups:mutate"
}
]
}
@@ -1948,16 +1987,16 @@
},
{
"shortName": "KeywordPlanCampaignKeywordService",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanCampaignKeywordService",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanCampaignKeywordService",
"methods": [
{
"shortName": "MutateKeywordPlanCampaignKeywords",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate"
+ "path": "/v11/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate"
}
]
}
@@ -1965,16 +2004,16 @@
},
{
"shortName": "KeywordPlanCampaignService",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanCampaignService",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanCampaignService",
"methods": [
{
"shortName": "MutateKeywordPlanCampaigns",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/keywordPlanCampaigns:mutate"
+ "path": "/v11/customers/{customer_id=*}/keywordPlanCampaigns:mutate"
}
]
}
@@ -1982,27 +2021,38 @@
},
{
"shortName": "KeywordPlanIdeaService",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanIdeaService",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanIdeaService",
"methods": [
+ {
+ "shortName": "GenerateAdGroupThemes",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanIdeaService.GenerateAdGroupThemes",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v11/customers/{customer_id=*}:generateAdGroupThemes"
+ }
+ ]
+ },
{
"shortName": "GenerateKeywordHistoricalMetrics",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:generateKeywordHistoricalMetrics"
+ "path": "/v11/customers/{customer_id=*}:generateKeywordHistoricalMetrics"
}
]
},
{
"shortName": "GenerateKeywordIdeas",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanIdeaService.GenerateKeywordIdeas",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanIdeaService.GenerateKeywordIdeas",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:generateKeywordIdeas"
+ "path": "/v11/customers/{customer_id=*}:generateKeywordIdeas"
}
]
}
@@ -2010,60 +2060,60 @@
},
{
"shortName": "KeywordPlanService",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanService",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanService",
"methods": [
{
"shortName": "GenerateForecastCurve",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanService.GenerateForecastCurve",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanService.GenerateForecastCurve",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve"
+ "path": "/v11/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve"
}
]
},
{
"shortName": "GenerateForecastMetrics",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanService.GenerateForecastMetrics",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanService.GenerateForecastMetrics",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics"
+ "path": "/v11/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics"
}
]
},
{
"shortName": "GenerateForecastTimeSeries",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanService.GenerateForecastTimeSeries",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanService.GenerateForecastTimeSeries",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries"
+ "path": "/v11/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries"
}
]
},
{
"shortName": "GenerateHistoricalMetrics",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanService.GenerateHistoricalMetrics",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanService.GenerateHistoricalMetrics",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics"
+ "path": "/v11/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics"
}
]
},
{
"shortName": "MutateKeywordPlans",
- "fullName": "google.ads.googleads.v10.services.KeywordPlanService.MutateKeywordPlans",
+ "fullName": "google.ads.googleads.v11.services.KeywordPlanService.MutateKeywordPlans",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/keywordPlans:mutate"
+ "path": "/v11/customers/{customer_id=*}/keywordPlans:mutate"
}
]
}
@@ -2071,16 +2121,16 @@
},
{
"shortName": "KeywordThemeConstantService",
- "fullName": "google.ads.googleads.v10.services.KeywordThemeConstantService",
+ "fullName": "google.ads.googleads.v11.services.KeywordThemeConstantService",
"methods": [
{
"shortName": "SuggestKeywordThemeConstants",
- "fullName": "google.ads.googleads.v10.services.KeywordThemeConstantService.SuggestKeywordThemeConstants",
+ "fullName": "google.ads.googleads.v11.services.KeywordThemeConstantService.SuggestKeywordThemeConstants",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/keywordThemeConstants:suggest"
+ "path": "/v11/keywordThemeConstants:suggest"
}
]
}
@@ -2088,16 +2138,16 @@
},
{
"shortName": "LabelService",
- "fullName": "google.ads.googleads.v10.services.LabelService",
+ "fullName": "google.ads.googleads.v11.services.LabelService",
"methods": [
{
"shortName": "MutateLabels",
- "fullName": "google.ads.googleads.v10.services.LabelService.MutateLabels",
+ "fullName": "google.ads.googleads.v11.services.LabelService.MutateLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/labels:mutate"
+ "path": "/v11/customers/{customer_id=*}/labels:mutate"
}
]
}
@@ -2105,16 +2155,16 @@
},
{
"shortName": "MediaFileService",
- "fullName": "google.ads.googleads.v10.services.MediaFileService",
+ "fullName": "google.ads.googleads.v11.services.MediaFileService",
"methods": [
{
"shortName": "MutateMediaFiles",
- "fullName": "google.ads.googleads.v10.services.MediaFileService.MutateMediaFiles",
+ "fullName": "google.ads.googleads.v11.services.MediaFileService.MutateMediaFiles",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/mediaFiles:mutate"
+ "path": "/v11/customers/{customer_id=*}/mediaFiles:mutate"
}
]
}
@@ -2122,38 +2172,38 @@
},
{
"shortName": "MerchantCenterLinkService",
- "fullName": "google.ads.googleads.v10.services.MerchantCenterLinkService",
+ "fullName": "google.ads.googleads.v11.services.MerchantCenterLinkService",
"methods": [
{
"shortName": "GetMerchantCenterLink",
- "fullName": "google.ads.googleads.v10.services.MerchantCenterLinkService.GetMerchantCenterLink",
+ "fullName": "google.ads.googleads.v11.services.MerchantCenterLinkService.GetMerchantCenterLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v10/{resource_name=customers/*/merchantCenterLinks/*}"
+ "path": "/v11/{resource_name=customers/*/merchantCenterLinks/*}"
}
]
},
{
"shortName": "ListMerchantCenterLinks",
- "fullName": "google.ads.googleads.v10.services.MerchantCenterLinkService.ListMerchantCenterLinks",
+ "fullName": "google.ads.googleads.v11.services.MerchantCenterLinkService.ListMerchantCenterLinks",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v10/customers/{customer_id=*}/merchantCenterLinks"
+ "path": "/v11/customers/{customer_id=*}/merchantCenterLinks"
}
]
},
{
"shortName": "MutateMerchantCenterLink",
- "fullName": "google.ads.googleads.v10.services.MerchantCenterLinkService.MutateMerchantCenterLink",
+ "fullName": "google.ads.googleads.v11.services.MerchantCenterLinkService.MutateMerchantCenterLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/merchantCenterLinks:mutate"
+ "path": "/v11/customers/{customer_id=*}/merchantCenterLinks:mutate"
}
]
}
@@ -2161,38 +2211,38 @@
},
{
"shortName": "OfflineUserDataJobService",
- "fullName": "google.ads.googleads.v10.services.OfflineUserDataJobService",
+ "fullName": "google.ads.googleads.v11.services.OfflineUserDataJobService",
"methods": [
{
"shortName": "AddOfflineUserDataJobOperations",
- "fullName": "google.ads.googleads.v10.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations",
+ "fullName": "google.ads.googleads.v11.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations"
+ "path": "/v11/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations"
}
]
},
{
"shortName": "CreateOfflineUserDataJob",
- "fullName": "google.ads.googleads.v10.services.OfflineUserDataJobService.CreateOfflineUserDataJob",
+ "fullName": "google.ads.googleads.v11.services.OfflineUserDataJobService.CreateOfflineUserDataJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/offlineUserDataJobs:create"
+ "path": "/v11/customers/{customer_id=*}/offlineUserDataJobs:create"
}
]
},
{
"shortName": "RunOfflineUserDataJob",
- "fullName": "google.ads.googleads.v10.services.OfflineUserDataJobService.RunOfflineUserDataJob",
+ "fullName": "google.ads.googleads.v11.services.OfflineUserDataJobService.RunOfflineUserDataJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{resource_name=customers/*/offlineUserDataJobs/*}:run"
+ "path": "/v11/{resource_name=customers/*/offlineUserDataJobs/*}:run"
}
]
}
@@ -2200,16 +2250,16 @@
},
{
"shortName": "PaymentsAccountService",
- "fullName": "google.ads.googleads.v10.services.PaymentsAccountService",
+ "fullName": "google.ads.googleads.v11.services.PaymentsAccountService",
"methods": [
{
"shortName": "ListPaymentsAccounts",
- "fullName": "google.ads.googleads.v10.services.PaymentsAccountService.ListPaymentsAccounts",
+ "fullName": "google.ads.googleads.v11.services.PaymentsAccountService.ListPaymentsAccounts",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v10/customers/{customer_id=*}/paymentsAccounts"
+ "path": "/v11/customers/{customer_id=*}/paymentsAccounts"
}
]
}
@@ -2217,49 +2267,49 @@
},
{
"shortName": "ReachPlanService",
- "fullName": "google.ads.googleads.v10.services.ReachPlanService",
+ "fullName": "google.ads.googleads.v11.services.ReachPlanService",
"methods": [
{
"shortName": "GenerateProductMixIdeas",
- "fullName": "google.ads.googleads.v10.services.ReachPlanService.GenerateProductMixIdeas",
+ "fullName": "google.ads.googleads.v11.services.ReachPlanService.GenerateProductMixIdeas",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:generateProductMixIdeas"
+ "path": "/v11/customers/{customer_id=*}:generateProductMixIdeas"
}
]
},
{
"shortName": "GenerateReachForecast",
- "fullName": "google.ads.googleads.v10.services.ReachPlanService.GenerateReachForecast",
+ "fullName": "google.ads.googleads.v11.services.ReachPlanService.GenerateReachForecast",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:generateReachForecast"
+ "path": "/v11/customers/{customer_id=*}:generateReachForecast"
}
]
},
{
"shortName": "ListPlannableLocations",
- "fullName": "google.ads.googleads.v10.services.ReachPlanService.ListPlannableLocations",
+ "fullName": "google.ads.googleads.v11.services.ReachPlanService.ListPlannableLocations",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10:listPlannableLocations"
+ "path": "/v11:listPlannableLocations"
}
]
},
{
"shortName": "ListPlannableProducts",
- "fullName": "google.ads.googleads.v10.services.ReachPlanService.ListPlannableProducts",
+ "fullName": "google.ads.googleads.v11.services.ReachPlanService.ListPlannableProducts",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10:listPlannableProducts"
+ "path": "/v11:listPlannableProducts"
}
]
}
@@ -2267,27 +2317,27 @@
},
{
"shortName": "RecommendationService",
- "fullName": "google.ads.googleads.v10.services.RecommendationService",
+ "fullName": "google.ads.googleads.v11.services.RecommendationService",
"methods": [
{
"shortName": "ApplyRecommendation",
- "fullName": "google.ads.googleads.v10.services.RecommendationService.ApplyRecommendation",
+ "fullName": "google.ads.googleads.v11.services.RecommendationService.ApplyRecommendation",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/recommendations:apply"
+ "path": "/v11/customers/{customer_id=*}/recommendations:apply"
}
]
},
{
"shortName": "DismissRecommendation",
- "fullName": "google.ads.googleads.v10.services.RecommendationService.DismissRecommendation",
+ "fullName": "google.ads.googleads.v11.services.RecommendationService.DismissRecommendation",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/recommendations:dismiss"
+ "path": "/v11/customers/{customer_id=*}/recommendations:dismiss"
}
]
}
@@ -2295,16 +2345,16 @@
},
{
"shortName": "RemarketingActionService",
- "fullName": "google.ads.googleads.v10.services.RemarketingActionService",
+ "fullName": "google.ads.googleads.v11.services.RemarketingActionService",
"methods": [
{
"shortName": "MutateRemarketingActions",
- "fullName": "google.ads.googleads.v10.services.RemarketingActionService.MutateRemarketingActions",
+ "fullName": "google.ads.googleads.v11.services.RemarketingActionService.MutateRemarketingActions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/remarketingActions:mutate"
+ "path": "/v11/customers/{customer_id=*}/remarketingActions:mutate"
}
]
}
@@ -2312,16 +2362,16 @@
},
{
"shortName": "SharedCriterionService",
- "fullName": "google.ads.googleads.v10.services.SharedCriterionService",
+ "fullName": "google.ads.googleads.v11.services.SharedCriterionService",
"methods": [
{
"shortName": "MutateSharedCriteria",
- "fullName": "google.ads.googleads.v10.services.SharedCriterionService.MutateSharedCriteria",
+ "fullName": "google.ads.googleads.v11.services.SharedCriterionService.MutateSharedCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/sharedCriteria:mutate"
+ "path": "/v11/customers/{customer_id=*}/sharedCriteria:mutate"
}
]
}
@@ -2329,16 +2379,16 @@
},
{
"shortName": "SharedSetService",
- "fullName": "google.ads.googleads.v10.services.SharedSetService",
+ "fullName": "google.ads.googleads.v11.services.SharedSetService",
"methods": [
{
"shortName": "MutateSharedSets",
- "fullName": "google.ads.googleads.v10.services.SharedSetService.MutateSharedSets",
+ "fullName": "google.ads.googleads.v11.services.SharedSetService.MutateSharedSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/sharedSets:mutate"
+ "path": "/v11/customers/{customer_id=*}/sharedSets:mutate"
}
]
}
@@ -2346,16 +2396,16 @@
},
{
"shortName": "SmartCampaignSettingService",
- "fullName": "google.ads.googleads.v10.services.SmartCampaignSettingService",
+ "fullName": "google.ads.googleads.v11.services.SmartCampaignSettingService",
"methods": [
{
"shortName": "MutateSmartCampaignSettings",
- "fullName": "google.ads.googleads.v10.services.SmartCampaignSettingService.MutateSmartCampaignSettings",
+ "fullName": "google.ads.googleads.v11.services.SmartCampaignSettingService.MutateSmartCampaignSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/smartCampaignSettings:mutate"
+ "path": "/v11/customers/{customer_id=*}/smartCampaignSettings:mutate"
}
]
}
@@ -2363,38 +2413,38 @@
},
{
"shortName": "SmartCampaignSuggestService",
- "fullName": "google.ads.googleads.v10.services.SmartCampaignSuggestService",
+ "fullName": "google.ads.googleads.v11.services.SmartCampaignSuggestService",
"methods": [
{
"shortName": "SuggestKeywordThemes",
- "fullName": "google.ads.googleads.v10.services.SmartCampaignSuggestService.SuggestKeywordThemes",
+ "fullName": "google.ads.googleads.v11.services.SmartCampaignSuggestService.SuggestKeywordThemes",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:suggestKeywordThemes"
+ "path": "/v11/customers/{customer_id=*}:suggestKeywordThemes"
}
]
},
{
"shortName": "SuggestSmartCampaignAd",
- "fullName": "google.ads.googleads.v10.services.SmartCampaignSuggestService.SuggestSmartCampaignAd",
+ "fullName": "google.ads.googleads.v11.services.SmartCampaignSuggestService.SuggestSmartCampaignAd",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:suggestSmartCampaignAd"
+ "path": "/v11/customers/{customer_id=*}:suggestSmartCampaignAd"
}
]
},
{
"shortName": "SuggestSmartCampaignBudgetOptions",
- "fullName": "google.ads.googleads.v10.services.SmartCampaignSuggestService.SuggestSmartCampaignBudgetOptions",
+ "fullName": "google.ads.googleads.v11.services.SmartCampaignSuggestService.SuggestSmartCampaignBudgetOptions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions"
+ "path": "/v11/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions"
}
]
}
@@ -2402,16 +2452,16 @@
},
{
"shortName": "ThirdPartyAppAnalyticsLinkService",
- "fullName": "google.ads.googleads.v10.services.ThirdPartyAppAnalyticsLinkService",
+ "fullName": "google.ads.googleads.v11.services.ThirdPartyAppAnalyticsLinkService",
"methods": [
{
"shortName": "RegenerateShareableLinkId",
- "fullName": "google.ads.googleads.v10.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId",
+ "fullName": "google.ads.googleads.v11.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId"
+ "path": "/v11/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId"
}
]
}
@@ -2419,16 +2469,16 @@
},
{
"shortName": "UserDataService",
- "fullName": "google.ads.googleads.v10.services.UserDataService",
+ "fullName": "google.ads.googleads.v11.services.UserDataService",
"methods": [
{
"shortName": "UploadUserData",
- "fullName": "google.ads.googleads.v10.services.UserDataService.UploadUserData",
+ "fullName": "google.ads.googleads.v11.services.UserDataService.UploadUserData",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}:uploadUserData"
+ "path": "/v11/customers/{customer_id=*}:uploadUserData"
}
]
}
@@ -2436,218 +2486,219 @@
},
{
"shortName": "UserListService",
- "fullName": "google.ads.googleads.v10.services.UserListService",
+ "fullName": "google.ads.googleads.v11.services.UserListService",
"methods": [
{
"shortName": "MutateUserLists",
- "fullName": "google.ads.googleads.v10.services.UserListService.MutateUserLists",
+ "fullName": "google.ads.googleads.v11.services.UserListService.MutateUserLists",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v10/customers/{customer_id=*}/userLists:mutate"
+ "path": "/v11/customers/{customer_id=*}/userLists:mutate"
}
]
}
]
}
],
- "configFile": "googleads_v10.yaml",
+ "configFile": "googleads_v11.yaml",
"serviceConfigApiNames": [
- "google.ads.googleads.v10.services.AccountBudgetProposalService",
- "google.ads.googleads.v10.services.AccountLinkService",
- "google.ads.googleads.v10.services.AdGroupAdLabelService",
- "google.ads.googleads.v10.services.AdGroupAdService",
- "google.ads.googleads.v10.services.AdGroupAssetService",
- "google.ads.googleads.v10.services.AdGroupBidModifierService",
- "google.ads.googleads.v10.services.AdGroupCriterionCustomizerService",
- "google.ads.googleads.v10.services.AdGroupCriterionLabelService",
- "google.ads.googleads.v10.services.AdGroupCriterionService",
- "google.ads.googleads.v10.services.AdGroupCustomizerService",
- "google.ads.googleads.v10.services.AdGroupExtensionSettingService",
- "google.ads.googleads.v10.services.AdGroupFeedService",
- "google.ads.googleads.v10.services.AdGroupLabelService",
- "google.ads.googleads.v10.services.AdGroupService",
- "google.ads.googleads.v10.services.AdParameterService",
- "google.ads.googleads.v10.services.AdService",
- "google.ads.googleads.v10.services.AssetGroupAssetService",
- "google.ads.googleads.v10.services.AssetGroupListingGroupFilterService",
- "google.ads.googleads.v10.services.AssetGroupService",
- "google.ads.googleads.v10.services.AssetGroupSignalService",
- "google.ads.googleads.v10.services.AssetService",
- "google.ads.googleads.v10.services.AssetSetAssetService",
- "google.ads.googleads.v10.services.AssetSetService",
- "google.ads.googleads.v10.services.AudienceService",
- "google.ads.googleads.v10.services.BatchJobService",
- "google.ads.googleads.v10.services.BiddingDataExclusionService",
- "google.ads.googleads.v10.services.BiddingSeasonalityAdjustmentService",
- "google.ads.googleads.v10.services.BiddingStrategyService",
- "google.ads.googleads.v10.services.BillingSetupService",
- "google.ads.googleads.v10.services.CampaignAssetService",
- "google.ads.googleads.v10.services.CampaignAssetSetService",
- "google.ads.googleads.v10.services.CampaignBidModifierService",
- "google.ads.googleads.v10.services.CampaignBudgetService",
- "google.ads.googleads.v10.services.CampaignConversionGoalService",
- "google.ads.googleads.v10.services.CampaignCriterionService",
- "google.ads.googleads.v10.services.CampaignCustomizerService",
- "google.ads.googleads.v10.services.CampaignDraftService",
- "google.ads.googleads.v10.services.CampaignExperimentService",
- "google.ads.googleads.v10.services.CampaignExtensionSettingService",
- "google.ads.googleads.v10.services.CampaignFeedService",
- "google.ads.googleads.v10.services.CampaignGroupService",
- "google.ads.googleads.v10.services.CampaignLabelService",
- "google.ads.googleads.v10.services.CampaignService",
- "google.ads.googleads.v10.services.CampaignSharedSetService",
- "google.ads.googleads.v10.services.ConversionActionService",
- "google.ads.googleads.v10.services.ConversionAdjustmentUploadService",
- "google.ads.googleads.v10.services.ConversionCustomVariableService",
- "google.ads.googleads.v10.services.ConversionGoalCampaignConfigService",
- "google.ads.googleads.v10.services.ConversionUploadService",
- "google.ads.googleads.v10.services.ConversionValueRuleService",
- "google.ads.googleads.v10.services.ConversionValueRuleSetService",
- "google.ads.googleads.v10.services.CustomAudienceService",
- "google.ads.googleads.v10.services.CustomConversionGoalService",
- "google.ads.googleads.v10.services.CustomInterestService",
- "google.ads.googleads.v10.services.CustomerAssetService",
- "google.ads.googleads.v10.services.CustomerClientLinkService",
- "google.ads.googleads.v10.services.CustomerConversionGoalService",
- "google.ads.googleads.v10.services.CustomerCustomizerService",
- "google.ads.googleads.v10.services.CustomerExtensionSettingService",
- "google.ads.googleads.v10.services.CustomerFeedService",
- "google.ads.googleads.v10.services.CustomerLabelService",
- "google.ads.googleads.v10.services.CustomerManagerLinkService",
- "google.ads.googleads.v10.services.CustomerNegativeCriterionService",
- "google.ads.googleads.v10.services.CustomerService",
- "google.ads.googleads.v10.services.CustomerUserAccessInvitationService",
- "google.ads.googleads.v10.services.CustomerUserAccessService",
- "google.ads.googleads.v10.services.CustomizerAttributeService",
- "google.ads.googleads.v10.services.ExperimentArmService",
- "google.ads.googleads.v10.services.ExperimentService",
- "google.ads.googleads.v10.services.ExtensionFeedItemService",
- "google.ads.googleads.v10.services.FeedItemService",
- "google.ads.googleads.v10.services.FeedItemSetLinkService",
- "google.ads.googleads.v10.services.FeedItemSetService",
- "google.ads.googleads.v10.services.FeedItemTargetService",
- "google.ads.googleads.v10.services.FeedMappingService",
- "google.ads.googleads.v10.services.FeedService",
- "google.ads.googleads.v10.services.GeoTargetConstantService",
- "google.ads.googleads.v10.services.GoogleAdsFieldService",
- "google.ads.googleads.v10.services.GoogleAdsService",
- "google.ads.googleads.v10.services.InvoiceService",
- "google.ads.googleads.v10.services.KeywordPlanAdGroupKeywordService",
- "google.ads.googleads.v10.services.KeywordPlanAdGroupService",
- "google.ads.googleads.v10.services.KeywordPlanCampaignKeywordService",
- "google.ads.googleads.v10.services.KeywordPlanCampaignService",
- "google.ads.googleads.v10.services.KeywordPlanIdeaService",
- "google.ads.googleads.v10.services.KeywordPlanService",
- "google.ads.googleads.v10.services.KeywordThemeConstantService",
- "google.ads.googleads.v10.services.LabelService",
- "google.ads.googleads.v10.services.MediaFileService",
- "google.ads.googleads.v10.services.MerchantCenterLinkService",
- "google.ads.googleads.v10.services.OfflineUserDataJobService",
- "google.ads.googleads.v10.services.PaymentsAccountService",
- "google.ads.googleads.v10.services.ReachPlanService",
- "google.ads.googleads.v10.services.RecommendationService",
- "google.ads.googleads.v10.services.RemarketingActionService",
- "google.ads.googleads.v10.services.SharedCriterionService",
- "google.ads.googleads.v10.services.SharedSetService",
- "google.ads.googleads.v10.services.SmartCampaignSettingService",
- "google.ads.googleads.v10.services.SmartCampaignSuggestService",
- "google.ads.googleads.v10.services.ThirdPartyAppAnalyticsLinkService",
- "google.ads.googleads.v10.services.UserDataService",
- "google.ads.googleads.v10.services.UserListService"
- ],
- "nameInServiceConfig": "googleads.googleapis.com"
- },
- {
- "id": "google.ads.googleads.v11",
- "directory": "google/ads/googleads/v11",
- "version": "v11",
- "majorVersion": "v11",
- "hostName": "googleads.googleapis.com",
- "title": "Google Ads API",
- "description": "Manage your Google Ads accounts, campaigns, and reports with this API.",
- "importDirectories": [
- "google/ads/googleads/v11/common",
- "google/ads/googleads/v11/enums",
- "google/ads/googleads/v11/errors",
- "google/ads/googleads/v11/resources",
- "google/ads/googleads/v11/services",
- "google/api",
- "google/longrunning",
- "google/protobuf",
- "google/rpc"
- ],
- "options": {
- "csharp_namespace": {
- "valueCounts": {
- "Google.Ads.GoogleAds.V11.Common": 35,
- "Google.Ads.GoogleAds.V11.Enums": 299,
- "Google.Ads.GoogleAds.V11.Errors": 141,
- "Google.Ads.GoogleAds.V11.Resources": 156,
- "Google.Ads.GoogleAds.V11.Services": 103
- }
- },
- "go_package": {
- "valueCounts": {
- "google.golang.org/genproto/googleapis/ads/googleads/v11/common;common": 35,
- "google.golang.org/genproto/googleapis/ads/googleads/v11/enums;enums": 299,
- "google.golang.org/genproto/googleapis/ads/googleads/v11/errors;errors": 141,
- "google.golang.org/genproto/googleapis/ads/googleads/v11/resources;resources": 156,
- "google.golang.org/genproto/googleapis/ads/googleads/v11/services;services": 103
- }
- },
+ "google.ads.googleads.v11.services.AccountBudgetProposalService",
+ "google.ads.googleads.v11.services.AccountLinkService",
+ "google.ads.googleads.v11.services.AdGroupAdLabelService",
+ "google.ads.googleads.v11.services.AdGroupAdService",
+ "google.ads.googleads.v11.services.AdGroupAssetService",
+ "google.ads.googleads.v11.services.AdGroupBidModifierService",
+ "google.ads.googleads.v11.services.AdGroupCriterionCustomizerService",
+ "google.ads.googleads.v11.services.AdGroupCriterionLabelService",
+ "google.ads.googleads.v11.services.AdGroupCriterionService",
+ "google.ads.googleads.v11.services.AdGroupCustomizerService",
+ "google.ads.googleads.v11.services.AdGroupExtensionSettingService",
+ "google.ads.googleads.v11.services.AdGroupFeedService",
+ "google.ads.googleads.v11.services.AdGroupLabelService",
+ "google.ads.googleads.v11.services.AdGroupService",
+ "google.ads.googleads.v11.services.AdParameterService",
+ "google.ads.googleads.v11.services.AdService",
+ "google.ads.googleads.v11.services.AssetGroupAssetService",
+ "google.ads.googleads.v11.services.AssetGroupListingGroupFilterService",
+ "google.ads.googleads.v11.services.AssetGroupService",
+ "google.ads.googleads.v11.services.AssetGroupSignalService",
+ "google.ads.googleads.v11.services.AssetService",
+ "google.ads.googleads.v11.services.AssetSetAssetService",
+ "google.ads.googleads.v11.services.AssetSetService",
+ "google.ads.googleads.v11.services.AudienceInsightsService",
+ "google.ads.googleads.v11.services.AudienceService",
+ "google.ads.googleads.v11.services.BatchJobService",
+ "google.ads.googleads.v11.services.BiddingDataExclusionService",
+ "google.ads.googleads.v11.services.BiddingSeasonalityAdjustmentService",
+ "google.ads.googleads.v11.services.BiddingStrategyService",
+ "google.ads.googleads.v11.services.BillingSetupService",
+ "google.ads.googleads.v11.services.CampaignAssetService",
+ "google.ads.googleads.v11.services.CampaignAssetSetService",
+ "google.ads.googleads.v11.services.CampaignBidModifierService",
+ "google.ads.googleads.v11.services.CampaignBudgetService",
+ "google.ads.googleads.v11.services.CampaignConversionGoalService",
+ "google.ads.googleads.v11.services.CampaignCriterionService",
+ "google.ads.googleads.v11.services.CampaignCustomizerService",
+ "google.ads.googleads.v11.services.CampaignDraftService",
+ "google.ads.googleads.v11.services.CampaignExperimentService",
+ "google.ads.googleads.v11.services.CampaignExtensionSettingService",
+ "google.ads.googleads.v11.services.CampaignFeedService",
+ "google.ads.googleads.v11.services.CampaignGroupService",
+ "google.ads.googleads.v11.services.CampaignLabelService",
+ "google.ads.googleads.v11.services.CampaignService",
+ "google.ads.googleads.v11.services.CampaignSharedSetService",
+ "google.ads.googleads.v11.services.ConversionActionService",
+ "google.ads.googleads.v11.services.ConversionAdjustmentUploadService",
+ "google.ads.googleads.v11.services.ConversionCustomVariableService",
+ "google.ads.googleads.v11.services.ConversionGoalCampaignConfigService",
+ "google.ads.googleads.v11.services.ConversionUploadService",
+ "google.ads.googleads.v11.services.ConversionValueRuleService",
+ "google.ads.googleads.v11.services.ConversionValueRuleSetService",
+ "google.ads.googleads.v11.services.CustomAudienceService",
+ "google.ads.googleads.v11.services.CustomConversionGoalService",
+ "google.ads.googleads.v11.services.CustomInterestService",
+ "google.ads.googleads.v11.services.CustomerAssetService",
+ "google.ads.googleads.v11.services.CustomerClientLinkService",
+ "google.ads.googleads.v11.services.CustomerConversionGoalService",
+ "google.ads.googleads.v11.services.CustomerCustomizerService",
+ "google.ads.googleads.v11.services.CustomerExtensionSettingService",
+ "google.ads.googleads.v11.services.CustomerFeedService",
+ "google.ads.googleads.v11.services.CustomerLabelService",
+ "google.ads.googleads.v11.services.CustomerManagerLinkService",
+ "google.ads.googleads.v11.services.CustomerNegativeCriterionService",
+ "google.ads.googleads.v11.services.CustomerService",
+ "google.ads.googleads.v11.services.CustomerUserAccessInvitationService",
+ "google.ads.googleads.v11.services.CustomerUserAccessService",
+ "google.ads.googleads.v11.services.CustomizerAttributeService",
+ "google.ads.googleads.v11.services.ExperimentArmService",
+ "google.ads.googleads.v11.services.ExperimentService",
+ "google.ads.googleads.v11.services.ExtensionFeedItemService",
+ "google.ads.googleads.v11.services.FeedItemService",
+ "google.ads.googleads.v11.services.FeedItemSetLinkService",
+ "google.ads.googleads.v11.services.FeedItemSetService",
+ "google.ads.googleads.v11.services.FeedItemTargetService",
+ "google.ads.googleads.v11.services.FeedMappingService",
+ "google.ads.googleads.v11.services.FeedService",
+ "google.ads.googleads.v11.services.GeoTargetConstantService",
+ "google.ads.googleads.v11.services.GoogleAdsFieldService",
+ "google.ads.googleads.v11.services.GoogleAdsService",
+ "google.ads.googleads.v11.services.InvoiceService",
+ "google.ads.googleads.v11.services.KeywordPlanAdGroupKeywordService",
+ "google.ads.googleads.v11.services.KeywordPlanAdGroupService",
+ "google.ads.googleads.v11.services.KeywordPlanCampaignKeywordService",
+ "google.ads.googleads.v11.services.KeywordPlanCampaignService",
+ "google.ads.googleads.v11.services.KeywordPlanIdeaService",
+ "google.ads.googleads.v11.services.KeywordPlanService",
+ "google.ads.googleads.v11.services.KeywordThemeConstantService",
+ "google.ads.googleads.v11.services.LabelService",
+ "google.ads.googleads.v11.services.MediaFileService",
+ "google.ads.googleads.v11.services.MerchantCenterLinkService",
+ "google.ads.googleads.v11.services.OfflineUserDataJobService",
+ "google.ads.googleads.v11.services.PaymentsAccountService",
+ "google.ads.googleads.v11.services.ReachPlanService",
+ "google.ads.googleads.v11.services.RecommendationService",
+ "google.ads.googleads.v11.services.RemarketingActionService",
+ "google.ads.googleads.v11.services.SharedCriterionService",
+ "google.ads.googleads.v11.services.SharedSetService",
+ "google.ads.googleads.v11.services.SmartCampaignSettingService",
+ "google.ads.googleads.v11.services.SmartCampaignSuggestService",
+ "google.ads.googleads.v11.services.ThirdPartyAppAnalyticsLinkService",
+ "google.ads.googleads.v11.services.UserDataService",
+ "google.ads.googleads.v11.services.UserListService"
+ ],
+ "nameInServiceConfig": "googleads.googleapis.com"
+ },
+ {
+ "id": "google.ads.googleads.v12",
+ "directory": "google/ads/googleads/v12",
+ "version": "v12",
+ "majorVersion": "v12",
+ "hostName": "googleads.googleapis.com",
+ "title": "Google Ads API",
+ "description": "Manage your Google Ads accounts, campaigns, and reports with this API.",
+ "importDirectories": [
+ "google/ads/googleads/v12/common",
+ "google/ads/googleads/v12/enums",
+ "google/ads/googleads/v12/errors",
+ "google/ads/googleads/v12/resources",
+ "google/ads/googleads/v12/services",
+ "google/api",
+ "google/longrunning",
+ "google/protobuf",
+ "google/rpc"
+ ],
+ "options": {
+ "csharp_namespace": {
+ "valueCounts": {
+ "Google.Ads.GoogleAds.V12.Common": 36,
+ "Google.Ads.GoogleAds.V12.Enums": 301,
+ "Google.Ads.GoogleAds.V12.Errors": 142,
+ "Google.Ads.GoogleAds.V12.Resources": 159,
+ "Google.Ads.GoogleAds.V12.Services": 104
+ }
+ },
+ "go_package": {
+ "valueCounts": {
+ "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common": 36,
+ "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums": 301,
+ "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors": 142,
+ "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources": 159,
+ "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services": 104
+ }
+ },
"java_multiple_files": {
"valueCounts": {
- "true": 734
+ "true": 742
}
},
"java_package": {
"valueCounts": {
- "com.google.ads.googleads.v11.common": 35,
- "com.google.ads.googleads.v11.enums": 299,
- "com.google.ads.googleads.v11.errors": 141,
- "com.google.ads.googleads.v11.resources": 156,
- "com.google.ads.googleads.v11.services": 103
+ "com.google.ads.googleads.v12.common": 36,
+ "com.google.ads.googleads.v12.enums": 301,
+ "com.google.ads.googleads.v12.errors": 142,
+ "com.google.ads.googleads.v12.resources": 159,
+ "com.google.ads.googleads.v12.services": 104
}
},
"objc_class_prefix": {
"valueCounts": {
- "GAA": 734
+ "GAA": 742
}
},
"php_namespace": {
"valueCounts": {
- "Google\\Ads\\GoogleAds\\V11\\Common": 35,
- "Google\\Ads\\GoogleAds\\V11\\Enums": 299,
- "Google\\Ads\\GoogleAds\\V11\\Errors": 141,
- "Google\\Ads\\GoogleAds\\V11\\Resources": 156,
- "Google\\Ads\\GoogleAds\\V11\\Services": 103
+ "Google\\Ads\\GoogleAds\\V12\\Common": 36,
+ "Google\\Ads\\GoogleAds\\V12\\Enums": 301,
+ "Google\\Ads\\GoogleAds\\V12\\Errors": 142,
+ "Google\\Ads\\GoogleAds\\V12\\Resources": 159,
+ "Google\\Ads\\GoogleAds\\V12\\Services": 104
}
},
"ruby_package": {
"valueCounts": {
- "Google::Ads::GoogleAds::V11::Common": 35,
- "Google::Ads::GoogleAds::V11::Enums": 299,
- "Google::Ads::GoogleAds::V11::Errors": 141,
- "Google::Ads::GoogleAds::V11::Resources": 156,
- "Google::Ads::GoogleAds::V11::Services": 103
+ "Google::Ads::GoogleAds::V12::Common": 36,
+ "Google::Ads::GoogleAds::V12::Enums": 301,
+ "Google::Ads::GoogleAds::V12::Errors": 142,
+ "Google::Ads::GoogleAds::V12::Resources": 159,
+ "Google::Ads::GoogleAds::V12::Services": 104
}
}
},
"services": [
{
"shortName": "AccountBudgetProposalService",
- "fullName": "google.ads.googleads.v11.services.AccountBudgetProposalService",
+ "fullName": "google.ads.googleads.v12.services.AccountBudgetProposalService",
"methods": [
{
"shortName": "MutateAccountBudgetProposal",
- "fullName": "google.ads.googleads.v11.services.AccountBudgetProposalService.MutateAccountBudgetProposal",
+ "fullName": "google.ads.googleads.v12.services.AccountBudgetProposalService.MutateAccountBudgetProposal",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/accountBudgetProposals:mutate"
+ "path": "/v12/customers/{customer_id=*}/accountBudgetProposals:mutate"
}
]
}
@@ -2655,27 +2706,27 @@
},
{
"shortName": "AccountLinkService",
- "fullName": "google.ads.googleads.v11.services.AccountLinkService",
+ "fullName": "google.ads.googleads.v12.services.AccountLinkService",
"methods": [
{
"shortName": "CreateAccountLink",
- "fullName": "google.ads.googleads.v11.services.AccountLinkService.CreateAccountLink",
+ "fullName": "google.ads.googleads.v12.services.AccountLinkService.CreateAccountLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/accountLinks:create"
+ "path": "/v12/customers/{customer_id=*}/accountLinks:create"
}
]
},
{
"shortName": "MutateAccountLink",
- "fullName": "google.ads.googleads.v11.services.AccountLinkService.MutateAccountLink",
+ "fullName": "google.ads.googleads.v12.services.AccountLinkService.MutateAccountLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/accountLinks:mutate"
+ "path": "/v12/customers/{customer_id=*}/accountLinks:mutate"
}
]
}
@@ -2683,16 +2734,16 @@
},
{
"shortName": "AdGroupAdLabelService",
- "fullName": "google.ads.googleads.v11.services.AdGroupAdLabelService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupAdLabelService",
"methods": [
{
"shortName": "MutateAdGroupAdLabels",
- "fullName": "google.ads.googleads.v11.services.AdGroupAdLabelService.MutateAdGroupAdLabels",
+ "fullName": "google.ads.googleads.v12.services.AdGroupAdLabelService.MutateAdGroupAdLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adGroupAdLabels:mutate"
+ "path": "/v12/customers/{customer_id=*}/adGroupAdLabels:mutate"
}
]
}
@@ -2700,16 +2751,16 @@
},
{
"shortName": "AdGroupAdService",
- "fullName": "google.ads.googleads.v11.services.AdGroupAdService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupAdService",
"methods": [
{
"shortName": "MutateAdGroupAds",
- "fullName": "google.ads.googleads.v11.services.AdGroupAdService.MutateAdGroupAds",
+ "fullName": "google.ads.googleads.v12.services.AdGroupAdService.MutateAdGroupAds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adGroupAds:mutate"
+ "path": "/v12/customers/{customer_id=*}/adGroupAds:mutate"
}
]
}
@@ -2717,16 +2768,33 @@
},
{
"shortName": "AdGroupAssetService",
- "fullName": "google.ads.googleads.v11.services.AdGroupAssetService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupAssetService",
"methods": [
{
"shortName": "MutateAdGroupAssets",
- "fullName": "google.ads.googleads.v11.services.AdGroupAssetService.MutateAdGroupAssets",
+ "fullName": "google.ads.googleads.v12.services.AdGroupAssetService.MutateAdGroupAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adGroupAssets:mutate"
+ "path": "/v12/customers/{customer_id=*}/adGroupAssets:mutate"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "shortName": "AdGroupAssetSetService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupAssetSetService",
+ "methods": [
+ {
+ "shortName": "MutateAdGroupAssetSets",
+ "fullName": "google.ads.googleads.v12.services.AdGroupAssetSetService.MutateAdGroupAssetSets",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v12/customers/{customer_id=*}/adGroupAssetSets:mutate"
}
]
}
@@ -2734,16 +2802,16 @@
},
{
"shortName": "AdGroupBidModifierService",
- "fullName": "google.ads.googleads.v11.services.AdGroupBidModifierService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupBidModifierService",
"methods": [
{
"shortName": "MutateAdGroupBidModifiers",
- "fullName": "google.ads.googleads.v11.services.AdGroupBidModifierService.MutateAdGroupBidModifiers",
+ "fullName": "google.ads.googleads.v12.services.AdGroupBidModifierService.MutateAdGroupBidModifiers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adGroupBidModifiers:mutate"
+ "path": "/v12/customers/{customer_id=*}/adGroupBidModifiers:mutate"
}
]
}
@@ -2751,16 +2819,16 @@
},
{
"shortName": "AdGroupCriterionCustomizerService",
- "fullName": "google.ads.googleads.v11.services.AdGroupCriterionCustomizerService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupCriterionCustomizerService",
"methods": [
{
"shortName": "MutateAdGroupCriterionCustomizers",
- "fullName": "google.ads.googleads.v11.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers",
+ "fullName": "google.ads.googleads.v12.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate"
+ "path": "/v12/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate"
}
]
}
@@ -2768,16 +2836,16 @@
},
{
"shortName": "AdGroupCriterionLabelService",
- "fullName": "google.ads.googleads.v11.services.AdGroupCriterionLabelService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupCriterionLabelService",
"methods": [
{
"shortName": "MutateAdGroupCriterionLabels",
- "fullName": "google.ads.googleads.v11.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels",
+ "fullName": "google.ads.googleads.v12.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adGroupCriterionLabels:mutate"
+ "path": "/v12/customers/{customer_id=*}/adGroupCriterionLabels:mutate"
}
]
}
@@ -2785,16 +2853,16 @@
},
{
"shortName": "AdGroupCriterionService",
- "fullName": "google.ads.googleads.v11.services.AdGroupCriterionService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupCriterionService",
"methods": [
{
"shortName": "MutateAdGroupCriteria",
- "fullName": "google.ads.googleads.v11.services.AdGroupCriterionService.MutateAdGroupCriteria",
+ "fullName": "google.ads.googleads.v12.services.AdGroupCriterionService.MutateAdGroupCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adGroupCriteria:mutate"
+ "path": "/v12/customers/{customer_id=*}/adGroupCriteria:mutate"
}
]
}
@@ -2802,16 +2870,16 @@
},
{
"shortName": "AdGroupCustomizerService",
- "fullName": "google.ads.googleads.v11.services.AdGroupCustomizerService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupCustomizerService",
"methods": [
{
"shortName": "MutateAdGroupCustomizers",
- "fullName": "google.ads.googleads.v11.services.AdGroupCustomizerService.MutateAdGroupCustomizers",
+ "fullName": "google.ads.googleads.v12.services.AdGroupCustomizerService.MutateAdGroupCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adGroupCustomizers:mutate"
+ "path": "/v12/customers/{customer_id=*}/adGroupCustomizers:mutate"
}
]
}
@@ -2819,16 +2887,16 @@
},
{
"shortName": "AdGroupExtensionSettingService",
- "fullName": "google.ads.googleads.v11.services.AdGroupExtensionSettingService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupExtensionSettingService",
"methods": [
{
"shortName": "MutateAdGroupExtensionSettings",
- "fullName": "google.ads.googleads.v11.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings",
+ "fullName": "google.ads.googleads.v12.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adGroupExtensionSettings:mutate"
+ "path": "/v12/customers/{customer_id=*}/adGroupExtensionSettings:mutate"
}
]
}
@@ -2836,16 +2904,16 @@
},
{
"shortName": "AdGroupFeedService",
- "fullName": "google.ads.googleads.v11.services.AdGroupFeedService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupFeedService",
"methods": [
{
"shortName": "MutateAdGroupFeeds",
- "fullName": "google.ads.googleads.v11.services.AdGroupFeedService.MutateAdGroupFeeds",
+ "fullName": "google.ads.googleads.v12.services.AdGroupFeedService.MutateAdGroupFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adGroupFeeds:mutate"
+ "path": "/v12/customers/{customer_id=*}/adGroupFeeds:mutate"
}
]
}
@@ -2853,16 +2921,16 @@
},
{
"shortName": "AdGroupLabelService",
- "fullName": "google.ads.googleads.v11.services.AdGroupLabelService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupLabelService",
"methods": [
{
"shortName": "MutateAdGroupLabels",
- "fullName": "google.ads.googleads.v11.services.AdGroupLabelService.MutateAdGroupLabels",
+ "fullName": "google.ads.googleads.v12.services.AdGroupLabelService.MutateAdGroupLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adGroupLabels:mutate"
+ "path": "/v12/customers/{customer_id=*}/adGroupLabels:mutate"
}
]
}
@@ -2870,16 +2938,16 @@
},
{
"shortName": "AdGroupService",
- "fullName": "google.ads.googleads.v11.services.AdGroupService",
+ "fullName": "google.ads.googleads.v12.services.AdGroupService",
"methods": [
{
"shortName": "MutateAdGroups",
- "fullName": "google.ads.googleads.v11.services.AdGroupService.MutateAdGroups",
+ "fullName": "google.ads.googleads.v12.services.AdGroupService.MutateAdGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adGroups:mutate"
+ "path": "/v12/customers/{customer_id=*}/adGroups:mutate"
}
]
}
@@ -2887,16 +2955,16 @@
},
{
"shortName": "AdParameterService",
- "fullName": "google.ads.googleads.v11.services.AdParameterService",
+ "fullName": "google.ads.googleads.v12.services.AdParameterService",
"methods": [
{
"shortName": "MutateAdParameters",
- "fullName": "google.ads.googleads.v11.services.AdParameterService.MutateAdParameters",
+ "fullName": "google.ads.googleads.v12.services.AdParameterService.MutateAdParameters",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/adParameters:mutate"
+ "path": "/v12/customers/{customer_id=*}/adParameters:mutate"
}
]
}
@@ -2904,27 +2972,27 @@
},
{
"shortName": "AdService",
- "fullName": "google.ads.googleads.v11.services.AdService",
+ "fullName": "google.ads.googleads.v12.services.AdService",
"methods": [
{
"shortName": "GetAd",
- "fullName": "google.ads.googleads.v11.services.AdService.GetAd",
+ "fullName": "google.ads.googleads.v12.services.AdService.GetAd",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v11/{resource_name=customers/*/ads/*}"
+ "path": "/v12/{resource_name=customers/*/ads/*}"
}
]
},
{
"shortName": "MutateAds",
- "fullName": "google.ads.googleads.v11.services.AdService.MutateAds",
+ "fullName": "google.ads.googleads.v12.services.AdService.MutateAds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/ads:mutate"
+ "path": "/v12/customers/{customer_id=*}/ads:mutate"
}
]
}
@@ -2932,16 +3000,16 @@
},
{
"shortName": "AssetGroupAssetService",
- "fullName": "google.ads.googleads.v11.services.AssetGroupAssetService",
+ "fullName": "google.ads.googleads.v12.services.AssetGroupAssetService",
"methods": [
{
"shortName": "MutateAssetGroupAssets",
- "fullName": "google.ads.googleads.v11.services.AssetGroupAssetService.MutateAssetGroupAssets",
+ "fullName": "google.ads.googleads.v12.services.AssetGroupAssetService.MutateAssetGroupAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/assetGroupAssets:mutate"
+ "path": "/v12/customers/{customer_id=*}/assetGroupAssets:mutate"
}
]
}
@@ -2949,16 +3017,16 @@
},
{
"shortName": "AssetGroupListingGroupFilterService",
- "fullName": "google.ads.googleads.v11.services.AssetGroupListingGroupFilterService",
+ "fullName": "google.ads.googleads.v12.services.AssetGroupListingGroupFilterService",
"methods": [
{
"shortName": "MutateAssetGroupListingGroupFilters",
- "fullName": "google.ads.googleads.v11.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters",
+ "fullName": "google.ads.googleads.v12.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate"
+ "path": "/v12/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate"
}
]
}
@@ -2966,16 +3034,16 @@
},
{
"shortName": "AssetGroupService",
- "fullName": "google.ads.googleads.v11.services.AssetGroupService",
+ "fullName": "google.ads.googleads.v12.services.AssetGroupService",
"methods": [
{
"shortName": "MutateAssetGroups",
- "fullName": "google.ads.googleads.v11.services.AssetGroupService.MutateAssetGroups",
+ "fullName": "google.ads.googleads.v12.services.AssetGroupService.MutateAssetGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/assetGroups:mutate"
+ "path": "/v12/customers/{customer_id=*}/assetGroups:mutate"
}
]
}
@@ -2983,16 +3051,16 @@
},
{
"shortName": "AssetGroupSignalService",
- "fullName": "google.ads.googleads.v11.services.AssetGroupSignalService",
+ "fullName": "google.ads.googleads.v12.services.AssetGroupSignalService",
"methods": [
{
"shortName": "MutateAssetGroupSignals",
- "fullName": "google.ads.googleads.v11.services.AssetGroupSignalService.MutateAssetGroupSignals",
+ "fullName": "google.ads.googleads.v12.services.AssetGroupSignalService.MutateAssetGroupSignals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/assetGroupSignals:mutate"
+ "path": "/v12/customers/{customer_id=*}/assetGroupSignals:mutate"
}
]
}
@@ -3000,16 +3068,16 @@
},
{
"shortName": "AssetService",
- "fullName": "google.ads.googleads.v11.services.AssetService",
+ "fullName": "google.ads.googleads.v12.services.AssetService",
"methods": [
{
"shortName": "MutateAssets",
- "fullName": "google.ads.googleads.v11.services.AssetService.MutateAssets",
+ "fullName": "google.ads.googleads.v12.services.AssetService.MutateAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/assets:mutate"
+ "path": "/v12/customers/{customer_id=*}/assets:mutate"
}
]
}
@@ -3017,16 +3085,16 @@
},
{
"shortName": "AssetSetAssetService",
- "fullName": "google.ads.googleads.v11.services.AssetSetAssetService",
+ "fullName": "google.ads.googleads.v12.services.AssetSetAssetService",
"methods": [
{
"shortName": "MutateAssetSetAssets",
- "fullName": "google.ads.googleads.v11.services.AssetSetAssetService.MutateAssetSetAssets",
+ "fullName": "google.ads.googleads.v12.services.AssetSetAssetService.MutateAssetSetAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/assetSetAssets:mutate"
+ "path": "/v12/customers/{customer_id=*}/assetSetAssets:mutate"
}
]
}
@@ -3034,16 +3102,16 @@
},
{
"shortName": "AssetSetService",
- "fullName": "google.ads.googleads.v11.services.AssetSetService",
+ "fullName": "google.ads.googleads.v12.services.AssetSetService",
"methods": [
{
"shortName": "MutateAssetSets",
- "fullName": "google.ads.googleads.v11.services.AssetSetService.MutateAssetSets",
+ "fullName": "google.ads.googleads.v12.services.AssetSetService.MutateAssetSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/assetSets:mutate"
+ "path": "/v12/customers/{customer_id=*}/assetSets:mutate"
}
]
}
@@ -3051,38 +3119,49 @@
},
{
"shortName": "AudienceInsightsService",
- "fullName": "google.ads.googleads.v11.services.AudienceInsightsService",
+ "fullName": "google.ads.googleads.v12.services.AudienceInsightsService",
"methods": [
{
"shortName": "GenerateAudienceCompositionInsights",
- "fullName": "google.ads.googleads.v11.services.AudienceInsightsService.GenerateAudienceCompositionInsights",
+ "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.GenerateAudienceCompositionInsights",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:generateAudienceCompositionInsights"
+ "path": "/v12/customers/{customer_id=*}:generateAudienceCompositionInsights"
}
]
},
{
"shortName": "GenerateInsightsFinderReport",
- "fullName": "google.ads.googleads.v11.services.AudienceInsightsService.GenerateInsightsFinderReport",
+ "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.GenerateInsightsFinderReport",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:generateInsightsFinderReport"
+ "path": "/v12/customers/{customer_id=*}:generateInsightsFinderReport"
}
]
},
{
"shortName": "ListAudienceInsightsAttributes",
- "fullName": "google.ads.googleads.v11.services.AudienceInsightsService.ListAudienceInsightsAttributes",
+ "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.ListAudienceInsightsAttributes",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:searchAudienceInsightsAttributes"
+ "path": "/v12/customers/{customer_id=*}:searchAudienceInsightsAttributes"
+ }
+ ]
+ },
+ {
+ "shortName": "ListInsightsEligibleDates",
+ "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.ListInsightsEligibleDates",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v12/audienceInsights:listInsightsEligibleDates"
}
]
}
@@ -3090,16 +3169,16 @@
},
{
"shortName": "AudienceService",
- "fullName": "google.ads.googleads.v11.services.AudienceService",
+ "fullName": "google.ads.googleads.v12.services.AudienceService",
"methods": [
{
"shortName": "MutateAudiences",
- "fullName": "google.ads.googleads.v11.services.AudienceService.MutateAudiences",
+ "fullName": "google.ads.googleads.v12.services.AudienceService.MutateAudiences",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/audiences:mutate"
+ "path": "/v12/customers/{customer_id=*}/audiences:mutate"
}
]
}
@@ -3107,49 +3186,49 @@
},
{
"shortName": "BatchJobService",
- "fullName": "google.ads.googleads.v11.services.BatchJobService",
+ "fullName": "google.ads.googleads.v12.services.BatchJobService",
"methods": [
{
"shortName": "AddBatchJobOperations",
- "fullName": "google.ads.googleads.v11.services.BatchJobService.AddBatchJobOperations",
+ "fullName": "google.ads.googleads.v12.services.BatchJobService.AddBatchJobOperations",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{resource_name=customers/*/batchJobs/*}:addOperations"
+ "path": "/v12/{resource_name=customers/*/batchJobs/*}:addOperations"
}
]
},
{
"shortName": "ListBatchJobResults",
- "fullName": "google.ads.googleads.v11.services.BatchJobService.ListBatchJobResults",
+ "fullName": "google.ads.googleads.v12.services.BatchJobService.ListBatchJobResults",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v11/{resource_name=customers/*/batchJobs/*}:listResults"
+ "path": "/v12/{resource_name=customers/*/batchJobs/*}:listResults"
}
]
},
{
"shortName": "MutateBatchJob",
- "fullName": "google.ads.googleads.v11.services.BatchJobService.MutateBatchJob",
+ "fullName": "google.ads.googleads.v12.services.BatchJobService.MutateBatchJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/batchJobs:mutate"
+ "path": "/v12/customers/{customer_id=*}/batchJobs:mutate"
}
]
},
{
"shortName": "RunBatchJob",
- "fullName": "google.ads.googleads.v11.services.BatchJobService.RunBatchJob",
+ "fullName": "google.ads.googleads.v12.services.BatchJobService.RunBatchJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{resource_name=customers/*/batchJobs/*}:run"
+ "path": "/v12/{resource_name=customers/*/batchJobs/*}:run"
}
]
}
@@ -3157,16 +3236,16 @@
},
{
"shortName": "BiddingDataExclusionService",
- "fullName": "google.ads.googleads.v11.services.BiddingDataExclusionService",
+ "fullName": "google.ads.googleads.v12.services.BiddingDataExclusionService",
"methods": [
{
"shortName": "MutateBiddingDataExclusions",
- "fullName": "google.ads.googleads.v11.services.BiddingDataExclusionService.MutateBiddingDataExclusions",
+ "fullName": "google.ads.googleads.v12.services.BiddingDataExclusionService.MutateBiddingDataExclusions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/biddingDataExclusions:mutate"
+ "path": "/v12/customers/{customer_id=*}/biddingDataExclusions:mutate"
}
]
}
@@ -3174,16 +3253,16 @@
},
{
"shortName": "BiddingSeasonalityAdjustmentService",
- "fullName": "google.ads.googleads.v11.services.BiddingSeasonalityAdjustmentService",
+ "fullName": "google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService",
"methods": [
{
"shortName": "MutateBiddingSeasonalityAdjustments",
- "fullName": "google.ads.googleads.v11.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments",
+ "fullName": "google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate"
+ "path": "/v12/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate"
}
]
}
@@ -3191,16 +3270,16 @@
},
{
"shortName": "BiddingStrategyService",
- "fullName": "google.ads.googleads.v11.services.BiddingStrategyService",
+ "fullName": "google.ads.googleads.v12.services.BiddingStrategyService",
"methods": [
{
"shortName": "MutateBiddingStrategies",
- "fullName": "google.ads.googleads.v11.services.BiddingStrategyService.MutateBiddingStrategies",
+ "fullName": "google.ads.googleads.v12.services.BiddingStrategyService.MutateBiddingStrategies",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/biddingStrategies:mutate"
+ "path": "/v12/customers/{customer_id=*}/biddingStrategies:mutate"
}
]
}
@@ -3208,16 +3287,16 @@
},
{
"shortName": "BillingSetupService",
- "fullName": "google.ads.googleads.v11.services.BillingSetupService",
+ "fullName": "google.ads.googleads.v12.services.BillingSetupService",
"methods": [
{
"shortName": "MutateBillingSetup",
- "fullName": "google.ads.googleads.v11.services.BillingSetupService.MutateBillingSetup",
+ "fullName": "google.ads.googleads.v12.services.BillingSetupService.MutateBillingSetup",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/billingSetups:mutate"
+ "path": "/v12/customers/{customer_id=*}/billingSetups:mutate"
}
]
}
@@ -3225,16 +3304,16 @@
},
{
"shortName": "CampaignAssetService",
- "fullName": "google.ads.googleads.v11.services.CampaignAssetService",
+ "fullName": "google.ads.googleads.v12.services.CampaignAssetService",
"methods": [
{
"shortName": "MutateCampaignAssets",
- "fullName": "google.ads.googleads.v11.services.CampaignAssetService.MutateCampaignAssets",
+ "fullName": "google.ads.googleads.v12.services.CampaignAssetService.MutateCampaignAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignAssets:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaignAssets:mutate"
}
]
}
@@ -3242,16 +3321,16 @@
},
{
"shortName": "CampaignAssetSetService",
- "fullName": "google.ads.googleads.v11.services.CampaignAssetSetService",
+ "fullName": "google.ads.googleads.v12.services.CampaignAssetSetService",
"methods": [
{
"shortName": "MutateCampaignAssetSets",
- "fullName": "google.ads.googleads.v11.services.CampaignAssetSetService.MutateCampaignAssetSets",
+ "fullName": "google.ads.googleads.v12.services.CampaignAssetSetService.MutateCampaignAssetSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignAssetSets:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaignAssetSets:mutate"
}
]
}
@@ -3259,16 +3338,16 @@
},
{
"shortName": "CampaignBidModifierService",
- "fullName": "google.ads.googleads.v11.services.CampaignBidModifierService",
+ "fullName": "google.ads.googleads.v12.services.CampaignBidModifierService",
"methods": [
{
"shortName": "MutateCampaignBidModifiers",
- "fullName": "google.ads.googleads.v11.services.CampaignBidModifierService.MutateCampaignBidModifiers",
+ "fullName": "google.ads.googleads.v12.services.CampaignBidModifierService.MutateCampaignBidModifiers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignBidModifiers:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaignBidModifiers:mutate"
}
]
}
@@ -3276,16 +3355,16 @@
},
{
"shortName": "CampaignBudgetService",
- "fullName": "google.ads.googleads.v11.services.CampaignBudgetService",
+ "fullName": "google.ads.googleads.v12.services.CampaignBudgetService",
"methods": [
{
"shortName": "MutateCampaignBudgets",
- "fullName": "google.ads.googleads.v11.services.CampaignBudgetService.MutateCampaignBudgets",
+ "fullName": "google.ads.googleads.v12.services.CampaignBudgetService.MutateCampaignBudgets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignBudgets:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaignBudgets:mutate"
}
]
}
@@ -3293,16 +3372,16 @@
},
{
"shortName": "CampaignConversionGoalService",
- "fullName": "google.ads.googleads.v11.services.CampaignConversionGoalService",
+ "fullName": "google.ads.googleads.v12.services.CampaignConversionGoalService",
"methods": [
{
"shortName": "MutateCampaignConversionGoals",
- "fullName": "google.ads.googleads.v11.services.CampaignConversionGoalService.MutateCampaignConversionGoals",
+ "fullName": "google.ads.googleads.v12.services.CampaignConversionGoalService.MutateCampaignConversionGoals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignConversionGoals:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaignConversionGoals:mutate"
}
]
}
@@ -3310,16 +3389,16 @@
},
{
"shortName": "CampaignCriterionService",
- "fullName": "google.ads.googleads.v11.services.CampaignCriterionService",
+ "fullName": "google.ads.googleads.v12.services.CampaignCriterionService",
"methods": [
{
"shortName": "MutateCampaignCriteria",
- "fullName": "google.ads.googleads.v11.services.CampaignCriterionService.MutateCampaignCriteria",
+ "fullName": "google.ads.googleads.v12.services.CampaignCriterionService.MutateCampaignCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignCriteria:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaignCriteria:mutate"
}
]
}
@@ -3327,16 +3406,16 @@
},
{
"shortName": "CampaignCustomizerService",
- "fullName": "google.ads.googleads.v11.services.CampaignCustomizerService",
+ "fullName": "google.ads.googleads.v12.services.CampaignCustomizerService",
"methods": [
{
"shortName": "MutateCampaignCustomizers",
- "fullName": "google.ads.googleads.v11.services.CampaignCustomizerService.MutateCampaignCustomizers",
+ "fullName": "google.ads.googleads.v12.services.CampaignCustomizerService.MutateCampaignCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignCustomizers:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaignCustomizers:mutate"
}
]
}
@@ -3344,161 +3423,89 @@
},
{
"shortName": "CampaignDraftService",
- "fullName": "google.ads.googleads.v11.services.CampaignDraftService",
+ "fullName": "google.ads.googleads.v12.services.CampaignDraftService",
"methods": [
{
"shortName": "ListCampaignDraftAsyncErrors",
- "fullName": "google.ads.googleads.v11.services.CampaignDraftService.ListCampaignDraftAsyncErrors",
+ "fullName": "google.ads.googleads.v12.services.CampaignDraftService.ListCampaignDraftAsyncErrors",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v11/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors"
+ "path": "/v12/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors"
}
]
},
{
"shortName": "MutateCampaignDrafts",
- "fullName": "google.ads.googleads.v11.services.CampaignDraftService.MutateCampaignDrafts",
+ "fullName": "google.ads.googleads.v12.services.CampaignDraftService.MutateCampaignDrafts",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignDrafts:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaignDrafts:mutate"
}
]
},
{
"shortName": "PromoteCampaignDraft",
- "fullName": "google.ads.googleads.v11.services.CampaignDraftService.PromoteCampaignDraft",
+ "fullName": "google.ads.googleads.v12.services.CampaignDraftService.PromoteCampaignDraft",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{campaign_draft=customers/*/campaignDrafts/*}:promote"
+ "path": "/v12/{campaign_draft=customers/*/campaignDrafts/*}:promote"
}
]
}
]
},
{
- "shortName": "CampaignExperimentService",
- "fullName": "google.ads.googleads.v11.services.CampaignExperimentService",
+ "shortName": "CampaignExtensionSettingService",
+ "fullName": "google.ads.googleads.v12.services.CampaignExtensionSettingService",
"methods": [
{
- "shortName": "CreateCampaignExperiment",
- "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.CreateCampaignExperiment",
+ "shortName": "MutateCampaignExtensionSettings",
+ "fullName": "google.ads.googleads.v12.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignExperiments:create"
+ "path": "/v12/customers/{customer_id=*}/campaignExtensionSettings:mutate"
}
]
- },
+ }
+ ]
+ },
+ {
+ "shortName": "CampaignFeedService",
+ "fullName": "google.ads.googleads.v12.services.CampaignFeedService",
+ "methods": [
{
- "shortName": "EndCampaignExperiment",
- "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.EndCampaignExperiment",
+ "shortName": "MutateCampaignFeeds",
+ "fullName": "google.ads.googleads.v12.services.CampaignFeedService.MutateCampaignFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{campaign_experiment=customers/*/campaignExperiments/*}:end"
+ "path": "/v12/customers/{customer_id=*}/campaignFeeds:mutate"
}
]
- },
+ }
+ ]
+ },
+ {
+ "shortName": "CampaignGroupService",
+ "fullName": "google.ads.googleads.v12.services.CampaignGroupService",
+ "methods": [
{
- "shortName": "GraduateCampaignExperiment",
- "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.GraduateCampaignExperiment",
+ "shortName": "MutateCampaignGroups",
+ "fullName": "google.ads.googleads.v12.services.CampaignGroupService.MutateCampaignGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{campaign_experiment=customers/*/campaignExperiments/*}:graduate"
- }
- ]
- },
- {
- "shortName": "ListCampaignExperimentAsyncErrors",
- "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.ListCampaignExperimentAsyncErrors",
- "mode": "UNARY",
- "bindings": [
- {
- "httpMethod": "GET",
- "path": "/v11/{resource_name=customers/*/campaignExperiments/*}:listAsyncErrors"
- }
- ]
- },
- {
- "shortName": "MutateCampaignExperiments",
- "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.MutateCampaignExperiments",
- "mode": "UNARY",
- "bindings": [
- {
- "httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignExperiments:mutate"
- }
- ]
- },
- {
- "shortName": "PromoteCampaignExperiment",
- "fullName": "google.ads.googleads.v11.services.CampaignExperimentService.PromoteCampaignExperiment",
- "mode": "UNARY",
- "bindings": [
- {
- "httpMethod": "POST",
- "path": "/v11/{campaign_experiment=customers/*/campaignExperiments/*}:promote"
- }
- ]
- }
- ]
- },
- {
- "shortName": "CampaignExtensionSettingService",
- "fullName": "google.ads.googleads.v11.services.CampaignExtensionSettingService",
- "methods": [
- {
- "shortName": "MutateCampaignExtensionSettings",
- "fullName": "google.ads.googleads.v11.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings",
- "mode": "UNARY",
- "bindings": [
- {
- "httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignExtensionSettings:mutate"
- }
- ]
- }
- ]
- },
- {
- "shortName": "CampaignFeedService",
- "fullName": "google.ads.googleads.v11.services.CampaignFeedService",
- "methods": [
- {
- "shortName": "MutateCampaignFeeds",
- "fullName": "google.ads.googleads.v11.services.CampaignFeedService.MutateCampaignFeeds",
- "mode": "UNARY",
- "bindings": [
- {
- "httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignFeeds:mutate"
- }
- ]
- }
- ]
- },
- {
- "shortName": "CampaignGroupService",
- "fullName": "google.ads.googleads.v11.services.CampaignGroupService",
- "methods": [
- {
- "shortName": "MutateCampaignGroups",
- "fullName": "google.ads.googleads.v11.services.CampaignGroupService.MutateCampaignGroups",
- "mode": "UNARY",
- "bindings": [
- {
- "httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignGroups:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaignGroups:mutate"
}
]
}
@@ -3506,16 +3513,16 @@
},
{
"shortName": "CampaignLabelService",
- "fullName": "google.ads.googleads.v11.services.CampaignLabelService",
+ "fullName": "google.ads.googleads.v12.services.CampaignLabelService",
"methods": [
{
"shortName": "MutateCampaignLabels",
- "fullName": "google.ads.googleads.v11.services.CampaignLabelService.MutateCampaignLabels",
+ "fullName": "google.ads.googleads.v12.services.CampaignLabelService.MutateCampaignLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignLabels:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaignLabels:mutate"
}
]
}
@@ -3523,16 +3530,16 @@
},
{
"shortName": "CampaignService",
- "fullName": "google.ads.googleads.v11.services.CampaignService",
+ "fullName": "google.ads.googleads.v12.services.CampaignService",
"methods": [
{
"shortName": "MutateCampaigns",
- "fullName": "google.ads.googleads.v11.services.CampaignService.MutateCampaigns",
+ "fullName": "google.ads.googleads.v12.services.CampaignService.MutateCampaigns",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaigns:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaigns:mutate"
}
]
}
@@ -3540,16 +3547,16 @@
},
{
"shortName": "CampaignSharedSetService",
- "fullName": "google.ads.googleads.v11.services.CampaignSharedSetService",
+ "fullName": "google.ads.googleads.v12.services.CampaignSharedSetService",
"methods": [
{
"shortName": "MutateCampaignSharedSets",
- "fullName": "google.ads.googleads.v11.services.CampaignSharedSetService.MutateCampaignSharedSets",
+ "fullName": "google.ads.googleads.v12.services.CampaignSharedSetService.MutateCampaignSharedSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/campaignSharedSets:mutate"
+ "path": "/v12/customers/{customer_id=*}/campaignSharedSets:mutate"
}
]
}
@@ -3557,16 +3564,16 @@
},
{
"shortName": "ConversionActionService",
- "fullName": "google.ads.googleads.v11.services.ConversionActionService",
+ "fullName": "google.ads.googleads.v12.services.ConversionActionService",
"methods": [
{
"shortName": "MutateConversionActions",
- "fullName": "google.ads.googleads.v11.services.ConversionActionService.MutateConversionActions",
+ "fullName": "google.ads.googleads.v12.services.ConversionActionService.MutateConversionActions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/conversionActions:mutate"
+ "path": "/v12/customers/{customer_id=*}/conversionActions:mutate"
}
]
}
@@ -3574,16 +3581,16 @@
},
{
"shortName": "ConversionAdjustmentUploadService",
- "fullName": "google.ads.googleads.v11.services.ConversionAdjustmentUploadService",
+ "fullName": "google.ads.googleads.v12.services.ConversionAdjustmentUploadService",
"methods": [
{
"shortName": "UploadConversionAdjustments",
- "fullName": "google.ads.googleads.v11.services.ConversionAdjustmentUploadService.UploadConversionAdjustments",
+ "fullName": "google.ads.googleads.v12.services.ConversionAdjustmentUploadService.UploadConversionAdjustments",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:uploadConversionAdjustments"
+ "path": "/v12/customers/{customer_id=*}:uploadConversionAdjustments"
}
]
}
@@ -3591,16 +3598,16 @@
},
{
"shortName": "ConversionCustomVariableService",
- "fullName": "google.ads.googleads.v11.services.ConversionCustomVariableService",
+ "fullName": "google.ads.googleads.v12.services.ConversionCustomVariableService",
"methods": [
{
"shortName": "MutateConversionCustomVariables",
- "fullName": "google.ads.googleads.v11.services.ConversionCustomVariableService.MutateConversionCustomVariables",
+ "fullName": "google.ads.googleads.v12.services.ConversionCustomVariableService.MutateConversionCustomVariables",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/conversionCustomVariables:mutate"
+ "path": "/v12/customers/{customer_id=*}/conversionCustomVariables:mutate"
}
]
}
@@ -3608,16 +3615,16 @@
},
{
"shortName": "ConversionGoalCampaignConfigService",
- "fullName": "google.ads.googleads.v11.services.ConversionGoalCampaignConfigService",
+ "fullName": "google.ads.googleads.v12.services.ConversionGoalCampaignConfigService",
"methods": [
{
"shortName": "MutateConversionGoalCampaignConfigs",
- "fullName": "google.ads.googleads.v11.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs",
+ "fullName": "google.ads.googleads.v12.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate"
+ "path": "/v12/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate"
}
]
}
@@ -3625,27 +3632,27 @@
},
{
"shortName": "ConversionUploadService",
- "fullName": "google.ads.googleads.v11.services.ConversionUploadService",
+ "fullName": "google.ads.googleads.v12.services.ConversionUploadService",
"methods": [
{
"shortName": "UploadCallConversions",
- "fullName": "google.ads.googleads.v11.services.ConversionUploadService.UploadCallConversions",
+ "fullName": "google.ads.googleads.v12.services.ConversionUploadService.UploadCallConversions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:uploadCallConversions"
+ "path": "/v12/customers/{customer_id=*}:uploadCallConversions"
}
]
},
{
"shortName": "UploadClickConversions",
- "fullName": "google.ads.googleads.v11.services.ConversionUploadService.UploadClickConversions",
+ "fullName": "google.ads.googleads.v12.services.ConversionUploadService.UploadClickConversions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:uploadClickConversions"
+ "path": "/v12/customers/{customer_id=*}:uploadClickConversions"
}
]
}
@@ -3653,16 +3660,16 @@
},
{
"shortName": "ConversionValueRuleService",
- "fullName": "google.ads.googleads.v11.services.ConversionValueRuleService",
+ "fullName": "google.ads.googleads.v12.services.ConversionValueRuleService",
"methods": [
{
"shortName": "MutateConversionValueRules",
- "fullName": "google.ads.googleads.v11.services.ConversionValueRuleService.MutateConversionValueRules",
+ "fullName": "google.ads.googleads.v12.services.ConversionValueRuleService.MutateConversionValueRules",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/conversionValueRules:mutate"
+ "path": "/v12/customers/{customer_id=*}/conversionValueRules:mutate"
}
]
}
@@ -3670,16 +3677,16 @@
},
{
"shortName": "ConversionValueRuleSetService",
- "fullName": "google.ads.googleads.v11.services.ConversionValueRuleSetService",
+ "fullName": "google.ads.googleads.v12.services.ConversionValueRuleSetService",
"methods": [
{
"shortName": "MutateConversionValueRuleSets",
- "fullName": "google.ads.googleads.v11.services.ConversionValueRuleSetService.MutateConversionValueRuleSets",
+ "fullName": "google.ads.googleads.v12.services.ConversionValueRuleSetService.MutateConversionValueRuleSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/conversionValueRuleSets:mutate"
+ "path": "/v12/customers/{customer_id=*}/conversionValueRuleSets:mutate"
}
]
}
@@ -3687,16 +3694,16 @@
},
{
"shortName": "CustomAudienceService",
- "fullName": "google.ads.googleads.v11.services.CustomAudienceService",
+ "fullName": "google.ads.googleads.v12.services.CustomAudienceService",
"methods": [
{
"shortName": "MutateCustomAudiences",
- "fullName": "google.ads.googleads.v11.services.CustomAudienceService.MutateCustomAudiences",
+ "fullName": "google.ads.googleads.v12.services.CustomAudienceService.MutateCustomAudiences",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customAudiences:mutate"
+ "path": "/v12/customers/{customer_id=*}/customAudiences:mutate"
}
]
}
@@ -3704,16 +3711,16 @@
},
{
"shortName": "CustomConversionGoalService",
- "fullName": "google.ads.googleads.v11.services.CustomConversionGoalService",
+ "fullName": "google.ads.googleads.v12.services.CustomConversionGoalService",
"methods": [
{
"shortName": "MutateCustomConversionGoals",
- "fullName": "google.ads.googleads.v11.services.CustomConversionGoalService.MutateCustomConversionGoals",
+ "fullName": "google.ads.googleads.v12.services.CustomConversionGoalService.MutateCustomConversionGoals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customConversionGoals:mutate"
+ "path": "/v12/customers/{customer_id=*}/customConversionGoals:mutate"
}
]
}
@@ -3721,16 +3728,16 @@
},
{
"shortName": "CustomInterestService",
- "fullName": "google.ads.googleads.v11.services.CustomInterestService",
+ "fullName": "google.ads.googleads.v12.services.CustomInterestService",
"methods": [
{
"shortName": "MutateCustomInterests",
- "fullName": "google.ads.googleads.v11.services.CustomInterestService.MutateCustomInterests",
+ "fullName": "google.ads.googleads.v12.services.CustomInterestService.MutateCustomInterests",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customInterests:mutate"
+ "path": "/v12/customers/{customer_id=*}/customInterests:mutate"
}
]
}
@@ -3738,16 +3745,33 @@
},
{
"shortName": "CustomerAssetService",
- "fullName": "google.ads.googleads.v11.services.CustomerAssetService",
+ "fullName": "google.ads.googleads.v12.services.CustomerAssetService",
"methods": [
{
"shortName": "MutateCustomerAssets",
- "fullName": "google.ads.googleads.v11.services.CustomerAssetService.MutateCustomerAssets",
+ "fullName": "google.ads.googleads.v12.services.CustomerAssetService.MutateCustomerAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customerAssets:mutate"
+ "path": "/v12/customers/{customer_id=*}/customerAssets:mutate"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "shortName": "CustomerAssetSetService",
+ "fullName": "google.ads.googleads.v12.services.CustomerAssetSetService",
+ "methods": [
+ {
+ "shortName": "MutateCustomerAssetSets",
+ "fullName": "google.ads.googleads.v12.services.CustomerAssetSetService.MutateCustomerAssetSets",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v12/customers/{customer_id=*}/customerAssetSets:mutate"
}
]
}
@@ -3755,16 +3779,16 @@
},
{
"shortName": "CustomerClientLinkService",
- "fullName": "google.ads.googleads.v11.services.CustomerClientLinkService",
+ "fullName": "google.ads.googleads.v12.services.CustomerClientLinkService",
"methods": [
{
"shortName": "MutateCustomerClientLink",
- "fullName": "google.ads.googleads.v11.services.CustomerClientLinkService.MutateCustomerClientLink",
+ "fullName": "google.ads.googleads.v12.services.CustomerClientLinkService.MutateCustomerClientLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customerClientLinks:mutate"
+ "path": "/v12/customers/{customer_id=*}/customerClientLinks:mutate"
}
]
}
@@ -3772,16 +3796,16 @@
},
{
"shortName": "CustomerConversionGoalService",
- "fullName": "google.ads.googleads.v11.services.CustomerConversionGoalService",
+ "fullName": "google.ads.googleads.v12.services.CustomerConversionGoalService",
"methods": [
{
"shortName": "MutateCustomerConversionGoals",
- "fullName": "google.ads.googleads.v11.services.CustomerConversionGoalService.MutateCustomerConversionGoals",
+ "fullName": "google.ads.googleads.v12.services.CustomerConversionGoalService.MutateCustomerConversionGoals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customerConversionGoals:mutate"
+ "path": "/v12/customers/{customer_id=*}/customerConversionGoals:mutate"
}
]
}
@@ -3789,16 +3813,16 @@
},
{
"shortName": "CustomerCustomizerService",
- "fullName": "google.ads.googleads.v11.services.CustomerCustomizerService",
+ "fullName": "google.ads.googleads.v12.services.CustomerCustomizerService",
"methods": [
{
"shortName": "MutateCustomerCustomizers",
- "fullName": "google.ads.googleads.v11.services.CustomerCustomizerService.MutateCustomerCustomizers",
+ "fullName": "google.ads.googleads.v12.services.CustomerCustomizerService.MutateCustomerCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/CustomerCustomizers:mutate"
+ "path": "/v12/customers/{customer_id=*}/CustomerCustomizers:mutate"
}
]
}
@@ -3806,16 +3830,16 @@
},
{
"shortName": "CustomerExtensionSettingService",
- "fullName": "google.ads.googleads.v11.services.CustomerExtensionSettingService",
+ "fullName": "google.ads.googleads.v12.services.CustomerExtensionSettingService",
"methods": [
{
"shortName": "MutateCustomerExtensionSettings",
- "fullName": "google.ads.googleads.v11.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings",
+ "fullName": "google.ads.googleads.v12.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customerExtensionSettings:mutate"
+ "path": "/v12/customers/{customer_id=*}/customerExtensionSettings:mutate"
}
]
}
@@ -3823,16 +3847,16 @@
},
{
"shortName": "CustomerFeedService",
- "fullName": "google.ads.googleads.v11.services.CustomerFeedService",
+ "fullName": "google.ads.googleads.v12.services.CustomerFeedService",
"methods": [
{
"shortName": "MutateCustomerFeeds",
- "fullName": "google.ads.googleads.v11.services.CustomerFeedService.MutateCustomerFeeds",
+ "fullName": "google.ads.googleads.v12.services.CustomerFeedService.MutateCustomerFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customerFeeds:mutate"
+ "path": "/v12/customers/{customer_id=*}/customerFeeds:mutate"
}
]
}
@@ -3840,16 +3864,16 @@
},
{
"shortName": "CustomerLabelService",
- "fullName": "google.ads.googleads.v11.services.CustomerLabelService",
+ "fullName": "google.ads.googleads.v12.services.CustomerLabelService",
"methods": [
{
"shortName": "MutateCustomerLabels",
- "fullName": "google.ads.googleads.v11.services.CustomerLabelService.MutateCustomerLabels",
+ "fullName": "google.ads.googleads.v12.services.CustomerLabelService.MutateCustomerLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customerLabels:mutate"
+ "path": "/v12/customers/{customer_id=*}/customerLabels:mutate"
}
]
}
@@ -3857,27 +3881,27 @@
},
{
"shortName": "CustomerManagerLinkService",
- "fullName": "google.ads.googleads.v11.services.CustomerManagerLinkService",
+ "fullName": "google.ads.googleads.v12.services.CustomerManagerLinkService",
"methods": [
{
"shortName": "MoveManagerLink",
- "fullName": "google.ads.googleads.v11.services.CustomerManagerLinkService.MoveManagerLink",
+ "fullName": "google.ads.googleads.v12.services.CustomerManagerLinkService.MoveManagerLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customerManagerLinks:moveManagerLink"
+ "path": "/v12/customers/{customer_id=*}/customerManagerLinks:moveManagerLink"
}
]
},
{
"shortName": "MutateCustomerManagerLink",
- "fullName": "google.ads.googleads.v11.services.CustomerManagerLinkService.MutateCustomerManagerLink",
+ "fullName": "google.ads.googleads.v12.services.CustomerManagerLinkService.MutateCustomerManagerLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customerManagerLinks:mutate"
+ "path": "/v12/customers/{customer_id=*}/customerManagerLinks:mutate"
}
]
}
@@ -3885,16 +3909,16 @@
},
{
"shortName": "CustomerNegativeCriterionService",
- "fullName": "google.ads.googleads.v11.services.CustomerNegativeCriterionService",
+ "fullName": "google.ads.googleads.v12.services.CustomerNegativeCriterionService",
"methods": [
{
"shortName": "MutateCustomerNegativeCriteria",
- "fullName": "google.ads.googleads.v11.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria",
+ "fullName": "google.ads.googleads.v12.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customerNegativeCriteria:mutate"
+ "path": "/v12/customers/{customer_id=*}/customerNegativeCriteria:mutate"
}
]
}
@@ -3902,38 +3926,38 @@
},
{
"shortName": "CustomerService",
- "fullName": "google.ads.googleads.v11.services.CustomerService",
+ "fullName": "google.ads.googleads.v12.services.CustomerService",
"methods": [
{
"shortName": "CreateCustomerClient",
- "fullName": "google.ads.googleads.v11.services.CustomerService.CreateCustomerClient",
+ "fullName": "google.ads.googleads.v12.services.CustomerService.CreateCustomerClient",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:createCustomerClient"
+ "path": "/v12/customers/{customer_id=*}:createCustomerClient"
}
]
},
{
"shortName": "ListAccessibleCustomers",
- "fullName": "google.ads.googleads.v11.services.CustomerService.ListAccessibleCustomers",
+ "fullName": "google.ads.googleads.v12.services.CustomerService.ListAccessibleCustomers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v11/customers:listAccessibleCustomers"
+ "path": "/v12/customers:listAccessibleCustomers"
}
]
},
{
"shortName": "MutateCustomer",
- "fullName": "google.ads.googleads.v11.services.CustomerService.MutateCustomer",
+ "fullName": "google.ads.googleads.v12.services.CustomerService.MutateCustomer",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:mutate"
+ "path": "/v12/customers/{customer_id=*}:mutate"
}
]
}
@@ -3941,16 +3965,16 @@
},
{
"shortName": "CustomerUserAccessInvitationService",
- "fullName": "google.ads.googleads.v11.services.CustomerUserAccessInvitationService",
+ "fullName": "google.ads.googleads.v12.services.CustomerUserAccessInvitationService",
"methods": [
{
"shortName": "MutateCustomerUserAccessInvitation",
- "fullName": "google.ads.googleads.v11.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation",
+ "fullName": "google.ads.googleads.v12.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customerUserAccessInvitations:mutate"
+ "path": "/v12/customers/{customer_id=*}/customerUserAccessInvitations:mutate"
}
]
}
@@ -3958,16 +3982,16 @@
},
{
"shortName": "CustomerUserAccessService",
- "fullName": "google.ads.googleads.v11.services.CustomerUserAccessService",
+ "fullName": "google.ads.googleads.v12.services.CustomerUserAccessService",
"methods": [
{
"shortName": "MutateCustomerUserAccess",
- "fullName": "google.ads.googleads.v11.services.CustomerUserAccessService.MutateCustomerUserAccess",
+ "fullName": "google.ads.googleads.v12.services.CustomerUserAccessService.MutateCustomerUserAccess",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customerUserAccesses:mutate"
+ "path": "/v12/customers/{customer_id=*}/customerUserAccesses:mutate"
}
]
}
@@ -3975,16 +3999,16 @@
},
{
"shortName": "CustomizerAttributeService",
- "fullName": "google.ads.googleads.v11.services.CustomizerAttributeService",
+ "fullName": "google.ads.googleads.v12.services.CustomizerAttributeService",
"methods": [
{
"shortName": "MutateCustomizerAttributes",
- "fullName": "google.ads.googleads.v11.services.CustomizerAttributeService.MutateCustomizerAttributes",
+ "fullName": "google.ads.googleads.v12.services.CustomizerAttributeService.MutateCustomizerAttributes",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/customizerAttributes:mutate"
+ "path": "/v12/customers/{customer_id=*}/customizerAttributes:mutate"
}
]
}
@@ -3992,16 +4016,16 @@
},
{
"shortName": "ExperimentArmService",
- "fullName": "google.ads.googleads.v11.services.ExperimentArmService",
+ "fullName": "google.ads.googleads.v12.services.ExperimentArmService",
"methods": [
{
"shortName": "MutateExperimentArms",
- "fullName": "google.ads.googleads.v11.services.ExperimentArmService.MutateExperimentArms",
+ "fullName": "google.ads.googleads.v12.services.ExperimentArmService.MutateExperimentArms",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/experimentArms:mutate"
+ "path": "/v12/customers/{customer_id=*}/experimentArms:mutate"
}
]
}
@@ -4009,71 +4033,71 @@
},
{
"shortName": "ExperimentService",
- "fullName": "google.ads.googleads.v11.services.ExperimentService",
+ "fullName": "google.ads.googleads.v12.services.ExperimentService",
"methods": [
{
"shortName": "EndExperiment",
- "fullName": "google.ads.googleads.v11.services.ExperimentService.EndExperiment",
+ "fullName": "google.ads.googleads.v12.services.ExperimentService.EndExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{experiment=customers/*/experiments/*}:endExperiment"
+ "path": "/v12/{experiment=customers/*/experiments/*}:endExperiment"
}
]
},
{
"shortName": "GraduateExperiment",
- "fullName": "google.ads.googleads.v11.services.ExperimentService.GraduateExperiment",
+ "fullName": "google.ads.googleads.v12.services.ExperimentService.GraduateExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{experiment=customers/*/experiments/*}:graduateExperiment"
+ "path": "/v12/{experiment=customers/*/experiments/*}:graduateExperiment"
}
]
},
{
"shortName": "ListExperimentAsyncErrors",
- "fullName": "google.ads.googleads.v11.services.ExperimentService.ListExperimentAsyncErrors",
+ "fullName": "google.ads.googleads.v12.services.ExperimentService.ListExperimentAsyncErrors",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v11/{resource_name=customers/*/experiments/*}:listExperimentAsyncErrors"
+ "path": "/v12/{resource_name=customers/*/experiments/*}:listExperimentAsyncErrors"
}
]
},
{
"shortName": "MutateExperiments",
- "fullName": "google.ads.googleads.v11.services.ExperimentService.MutateExperiments",
+ "fullName": "google.ads.googleads.v12.services.ExperimentService.MutateExperiments",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/experiments:mutate"
+ "path": "/v12/customers/{customer_id=*}/experiments:mutate"
}
]
},
{
"shortName": "PromoteExperiment",
- "fullName": "google.ads.googleads.v11.services.ExperimentService.PromoteExperiment",
+ "fullName": "google.ads.googleads.v12.services.ExperimentService.PromoteExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{resource_name=customers/*/experiments/*}:promoteExperiment"
+ "path": "/v12/{resource_name=customers/*/experiments/*}:promoteExperiment"
}
]
},
{
"shortName": "ScheduleExperiment",
- "fullName": "google.ads.googleads.v11.services.ExperimentService.ScheduleExperiment",
+ "fullName": "google.ads.googleads.v12.services.ExperimentService.ScheduleExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{resource_name=customers/*/experiments/*}:scheduleExperiment"
+ "path": "/v12/{resource_name=customers/*/experiments/*}:scheduleExperiment"
}
]
}
@@ -4081,16 +4105,16 @@
},
{
"shortName": "ExtensionFeedItemService",
- "fullName": "google.ads.googleads.v11.services.ExtensionFeedItemService",
+ "fullName": "google.ads.googleads.v12.services.ExtensionFeedItemService",
"methods": [
{
"shortName": "MutateExtensionFeedItems",
- "fullName": "google.ads.googleads.v11.services.ExtensionFeedItemService.MutateExtensionFeedItems",
+ "fullName": "google.ads.googleads.v12.services.ExtensionFeedItemService.MutateExtensionFeedItems",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/extensionFeedItems:mutate"
+ "path": "/v12/customers/{customer_id=*}/extensionFeedItems:mutate"
}
]
}
@@ -4098,16 +4122,16 @@
},
{
"shortName": "FeedItemService",
- "fullName": "google.ads.googleads.v11.services.FeedItemService",
+ "fullName": "google.ads.googleads.v12.services.FeedItemService",
"methods": [
{
"shortName": "MutateFeedItems",
- "fullName": "google.ads.googleads.v11.services.FeedItemService.MutateFeedItems",
+ "fullName": "google.ads.googleads.v12.services.FeedItemService.MutateFeedItems",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/feedItems:mutate"
+ "path": "/v12/customers/{customer_id=*}/feedItems:mutate"
}
]
}
@@ -4115,16 +4139,16 @@
},
{
"shortName": "FeedItemSetLinkService",
- "fullName": "google.ads.googleads.v11.services.FeedItemSetLinkService",
+ "fullName": "google.ads.googleads.v12.services.FeedItemSetLinkService",
"methods": [
{
"shortName": "MutateFeedItemSetLinks",
- "fullName": "google.ads.googleads.v11.services.FeedItemSetLinkService.MutateFeedItemSetLinks",
+ "fullName": "google.ads.googleads.v12.services.FeedItemSetLinkService.MutateFeedItemSetLinks",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/feedItemSetLinks:mutate"
+ "path": "/v12/customers/{customer_id=*}/feedItemSetLinks:mutate"
}
]
}
@@ -4132,16 +4156,16 @@
},
{
"shortName": "FeedItemSetService",
- "fullName": "google.ads.googleads.v11.services.FeedItemSetService",
+ "fullName": "google.ads.googleads.v12.services.FeedItemSetService",
"methods": [
{
"shortName": "MutateFeedItemSets",
- "fullName": "google.ads.googleads.v11.services.FeedItemSetService.MutateFeedItemSets",
+ "fullName": "google.ads.googleads.v12.services.FeedItemSetService.MutateFeedItemSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/feedItemSets:mutate"
+ "path": "/v12/customers/{customer_id=*}/feedItemSets:mutate"
}
]
}
@@ -4149,16 +4173,16 @@
},
{
"shortName": "FeedItemTargetService",
- "fullName": "google.ads.googleads.v11.services.FeedItemTargetService",
+ "fullName": "google.ads.googleads.v12.services.FeedItemTargetService",
"methods": [
{
"shortName": "MutateFeedItemTargets",
- "fullName": "google.ads.googleads.v11.services.FeedItemTargetService.MutateFeedItemTargets",
+ "fullName": "google.ads.googleads.v12.services.FeedItemTargetService.MutateFeedItemTargets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/feedItemTargets:mutate"
+ "path": "/v12/customers/{customer_id=*}/feedItemTargets:mutate"
}
]
}
@@ -4166,16 +4190,16 @@
},
{
"shortName": "FeedMappingService",
- "fullName": "google.ads.googleads.v11.services.FeedMappingService",
+ "fullName": "google.ads.googleads.v12.services.FeedMappingService",
"methods": [
{
"shortName": "MutateFeedMappings",
- "fullName": "google.ads.googleads.v11.services.FeedMappingService.MutateFeedMappings",
+ "fullName": "google.ads.googleads.v12.services.FeedMappingService.MutateFeedMappings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/feedMappings:mutate"
+ "path": "/v12/customers/{customer_id=*}/feedMappings:mutate"
}
]
}
@@ -4183,16 +4207,16 @@
},
{
"shortName": "FeedService",
- "fullName": "google.ads.googleads.v11.services.FeedService",
+ "fullName": "google.ads.googleads.v12.services.FeedService",
"methods": [
{
"shortName": "MutateFeeds",
- "fullName": "google.ads.googleads.v11.services.FeedService.MutateFeeds",
+ "fullName": "google.ads.googleads.v12.services.FeedService.MutateFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/feeds:mutate"
+ "path": "/v12/customers/{customer_id=*}/feeds:mutate"
}
]
}
@@ -4200,16 +4224,16 @@
},
{
"shortName": "GeoTargetConstantService",
- "fullName": "google.ads.googleads.v11.services.GeoTargetConstantService",
+ "fullName": "google.ads.googleads.v12.services.GeoTargetConstantService",
"methods": [
{
"shortName": "SuggestGeoTargetConstants",
- "fullName": "google.ads.googleads.v11.services.GeoTargetConstantService.SuggestGeoTargetConstants",
+ "fullName": "google.ads.googleads.v12.services.GeoTargetConstantService.SuggestGeoTargetConstants",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/geoTargetConstants:suggest"
+ "path": "/v12/geoTargetConstants:suggest"
}
]
}
@@ -4217,27 +4241,27 @@
},
{
"shortName": "GoogleAdsFieldService",
- "fullName": "google.ads.googleads.v11.services.GoogleAdsFieldService",
+ "fullName": "google.ads.googleads.v12.services.GoogleAdsFieldService",
"methods": [
{
"shortName": "GetGoogleAdsField",
- "fullName": "google.ads.googleads.v11.services.GoogleAdsFieldService.GetGoogleAdsField",
+ "fullName": "google.ads.googleads.v12.services.GoogleAdsFieldService.GetGoogleAdsField",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v11/{resource_name=googleAdsFields/*}"
+ "path": "/v12/{resource_name=googleAdsFields/*}"
}
]
},
{
"shortName": "SearchGoogleAdsFields",
- "fullName": "google.ads.googleads.v11.services.GoogleAdsFieldService.SearchGoogleAdsFields",
+ "fullName": "google.ads.googleads.v12.services.GoogleAdsFieldService.SearchGoogleAdsFields",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/googleAdsFields:search"
+ "path": "/v12/googleAdsFields:search"
}
]
}
@@ -4245,38 +4269,38 @@
},
{
"shortName": "GoogleAdsService",
- "fullName": "google.ads.googleads.v11.services.GoogleAdsService",
+ "fullName": "google.ads.googleads.v12.services.GoogleAdsService",
"methods": [
{
"shortName": "Mutate",
- "fullName": "google.ads.googleads.v11.services.GoogleAdsService.Mutate",
+ "fullName": "google.ads.googleads.v12.services.GoogleAdsService.Mutate",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/googleAds:mutate"
+ "path": "/v12/customers/{customer_id=*}/googleAds:mutate"
}
]
},
{
"shortName": "Search",
- "fullName": "google.ads.googleads.v11.services.GoogleAdsService.Search",
+ "fullName": "google.ads.googleads.v12.services.GoogleAdsService.Search",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/googleAds:search"
+ "path": "/v12/customers/{customer_id=*}/googleAds:search"
}
]
},
{
"shortName": "SearchStream",
- "fullName": "google.ads.googleads.v11.services.GoogleAdsService.SearchStream",
+ "fullName": "google.ads.googleads.v12.services.GoogleAdsService.SearchStream",
"mode": "SERVER_STREAMING",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/googleAds:searchStream"
+ "path": "/v12/customers/{customer_id=*}/googleAds:searchStream"
}
]
}
@@ -4284,16 +4308,16 @@
},
{
"shortName": "InvoiceService",
- "fullName": "google.ads.googleads.v11.services.InvoiceService",
+ "fullName": "google.ads.googleads.v12.services.InvoiceService",
"methods": [
{
"shortName": "ListInvoices",
- "fullName": "google.ads.googleads.v11.services.InvoiceService.ListInvoices",
+ "fullName": "google.ads.googleads.v12.services.InvoiceService.ListInvoices",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v11/customers/{customer_id=*}/invoices"
+ "path": "/v12/customers/{customer_id=*}/invoices"
}
]
}
@@ -4301,16 +4325,16 @@
},
{
"shortName": "KeywordPlanAdGroupKeywordService",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanAdGroupKeywordService",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService",
"methods": [
{
"shortName": "MutateKeywordPlanAdGroupKeywords",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate"
+ "path": "/v12/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate"
}
]
}
@@ -4318,16 +4342,16 @@
},
{
"shortName": "KeywordPlanAdGroupService",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanAdGroupService",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupService",
"methods": [
{
"shortName": "MutateKeywordPlanAdGroups",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/keywordPlanAdGroups:mutate"
+ "path": "/v12/customers/{customer_id=*}/keywordPlanAdGroups:mutate"
}
]
}
@@ -4335,16 +4359,16 @@
},
{
"shortName": "KeywordPlanCampaignKeywordService",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanCampaignKeywordService",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService",
"methods": [
{
"shortName": "MutateKeywordPlanCampaignKeywords",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate"
+ "path": "/v12/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate"
}
]
}
@@ -4352,16 +4376,16 @@
},
{
"shortName": "KeywordPlanCampaignService",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanCampaignService",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignService",
"methods": [
{
"shortName": "MutateKeywordPlanCampaigns",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/keywordPlanCampaigns:mutate"
+ "path": "/v12/customers/{customer_id=*}/keywordPlanCampaigns:mutate"
}
]
}
@@ -4369,38 +4393,38 @@
},
{
"shortName": "KeywordPlanIdeaService",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanIdeaService",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService",
"methods": [
{
"shortName": "GenerateAdGroupThemes",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanIdeaService.GenerateAdGroupThemes",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService.GenerateAdGroupThemes",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:generateAdGroupThemes"
+ "path": "/v12/customers/{customer_id=*}:generateAdGroupThemes"
}
]
},
{
"shortName": "GenerateKeywordHistoricalMetrics",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:generateKeywordHistoricalMetrics"
+ "path": "/v12/customers/{customer_id=*}:generateKeywordHistoricalMetrics"
}
]
},
{
"shortName": "GenerateKeywordIdeas",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanIdeaService.GenerateKeywordIdeas",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService.GenerateKeywordIdeas",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:generateKeywordIdeas"
+ "path": "/v12/customers/{customer_id=*}:generateKeywordIdeas"
}
]
}
@@ -4408,60 +4432,60 @@
},
{
"shortName": "KeywordPlanService",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanService",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanService",
"methods": [
{
"shortName": "GenerateForecastCurve",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanService.GenerateForecastCurve",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastCurve",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve"
+ "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve"
}
]
},
{
"shortName": "GenerateForecastMetrics",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanService.GenerateForecastMetrics",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastMetrics",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics"
+ "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics"
}
]
},
{
"shortName": "GenerateForecastTimeSeries",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanService.GenerateForecastTimeSeries",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastTimeSeries",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries"
+ "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries"
}
]
},
{
"shortName": "GenerateHistoricalMetrics",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanService.GenerateHistoricalMetrics",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateHistoricalMetrics",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics"
+ "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics"
}
]
},
{
"shortName": "MutateKeywordPlans",
- "fullName": "google.ads.googleads.v11.services.KeywordPlanService.MutateKeywordPlans",
+ "fullName": "google.ads.googleads.v12.services.KeywordPlanService.MutateKeywordPlans",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/keywordPlans:mutate"
+ "path": "/v12/customers/{customer_id=*}/keywordPlans:mutate"
}
]
}
@@ -4469,16 +4493,16 @@
},
{
"shortName": "KeywordThemeConstantService",
- "fullName": "google.ads.googleads.v11.services.KeywordThemeConstantService",
+ "fullName": "google.ads.googleads.v12.services.KeywordThemeConstantService",
"methods": [
{
"shortName": "SuggestKeywordThemeConstants",
- "fullName": "google.ads.googleads.v11.services.KeywordThemeConstantService.SuggestKeywordThemeConstants",
+ "fullName": "google.ads.googleads.v12.services.KeywordThemeConstantService.SuggestKeywordThemeConstants",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/keywordThemeConstants:suggest"
+ "path": "/v12/keywordThemeConstants:suggest"
}
]
}
@@ -4486,16 +4510,16 @@
},
{
"shortName": "LabelService",
- "fullName": "google.ads.googleads.v11.services.LabelService",
+ "fullName": "google.ads.googleads.v12.services.LabelService",
"methods": [
{
"shortName": "MutateLabels",
- "fullName": "google.ads.googleads.v11.services.LabelService.MutateLabels",
+ "fullName": "google.ads.googleads.v12.services.LabelService.MutateLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/labels:mutate"
+ "path": "/v12/customers/{customer_id=*}/labels:mutate"
}
]
}
@@ -4503,16 +4527,16 @@
},
{
"shortName": "MediaFileService",
- "fullName": "google.ads.googleads.v11.services.MediaFileService",
+ "fullName": "google.ads.googleads.v12.services.MediaFileService",
"methods": [
{
"shortName": "MutateMediaFiles",
- "fullName": "google.ads.googleads.v11.services.MediaFileService.MutateMediaFiles",
+ "fullName": "google.ads.googleads.v12.services.MediaFileService.MutateMediaFiles",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/mediaFiles:mutate"
+ "path": "/v12/customers/{customer_id=*}/mediaFiles:mutate"
}
]
}
@@ -4520,38 +4544,38 @@
},
{
"shortName": "MerchantCenterLinkService",
- "fullName": "google.ads.googleads.v11.services.MerchantCenterLinkService",
+ "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService",
"methods": [
{
"shortName": "GetMerchantCenterLink",
- "fullName": "google.ads.googleads.v11.services.MerchantCenterLinkService.GetMerchantCenterLink",
+ "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService.GetMerchantCenterLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v11/{resource_name=customers/*/merchantCenterLinks/*}"
+ "path": "/v12/{resource_name=customers/*/merchantCenterLinks/*}"
}
]
},
{
"shortName": "ListMerchantCenterLinks",
- "fullName": "google.ads.googleads.v11.services.MerchantCenterLinkService.ListMerchantCenterLinks",
+ "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService.ListMerchantCenterLinks",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v11/customers/{customer_id=*}/merchantCenterLinks"
+ "path": "/v12/customers/{customer_id=*}/merchantCenterLinks"
}
]
},
{
"shortName": "MutateMerchantCenterLink",
- "fullName": "google.ads.googleads.v11.services.MerchantCenterLinkService.MutateMerchantCenterLink",
+ "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService.MutateMerchantCenterLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/merchantCenterLinks:mutate"
+ "path": "/v12/customers/{customer_id=*}/merchantCenterLinks:mutate"
}
]
}
@@ -4559,38 +4583,38 @@
},
{
"shortName": "OfflineUserDataJobService",
- "fullName": "google.ads.googleads.v11.services.OfflineUserDataJobService",
+ "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService",
"methods": [
{
"shortName": "AddOfflineUserDataJobOperations",
- "fullName": "google.ads.googleads.v11.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations",
+ "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations"
+ "path": "/v12/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations"
}
]
},
{
"shortName": "CreateOfflineUserDataJob",
- "fullName": "google.ads.googleads.v11.services.OfflineUserDataJobService.CreateOfflineUserDataJob",
+ "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService.CreateOfflineUserDataJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/offlineUserDataJobs:create"
+ "path": "/v12/customers/{customer_id=*}/offlineUserDataJobs:create"
}
]
},
{
"shortName": "RunOfflineUserDataJob",
- "fullName": "google.ads.googleads.v11.services.OfflineUserDataJobService.RunOfflineUserDataJob",
+ "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService.RunOfflineUserDataJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{resource_name=customers/*/offlineUserDataJobs/*}:run"
+ "path": "/v12/{resource_name=customers/*/offlineUserDataJobs/*}:run"
}
]
}
@@ -4598,16 +4622,16 @@
},
{
"shortName": "PaymentsAccountService",
- "fullName": "google.ads.googleads.v11.services.PaymentsAccountService",
+ "fullName": "google.ads.googleads.v12.services.PaymentsAccountService",
"methods": [
{
"shortName": "ListPaymentsAccounts",
- "fullName": "google.ads.googleads.v11.services.PaymentsAccountService.ListPaymentsAccounts",
+ "fullName": "google.ads.googleads.v12.services.PaymentsAccountService.ListPaymentsAccounts",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v11/customers/{customer_id=*}/paymentsAccounts"
+ "path": "/v12/customers/{customer_id=*}/paymentsAccounts"
}
]
}
@@ -4615,49 +4639,38 @@
},
{
"shortName": "ReachPlanService",
- "fullName": "google.ads.googleads.v11.services.ReachPlanService",
+ "fullName": "google.ads.googleads.v12.services.ReachPlanService",
"methods": [
{
- "shortName": "GenerateProductMixIdeas",
- "fullName": "google.ads.googleads.v11.services.ReachPlanService.GenerateProductMixIdeas",
+ "shortName": "GenerateReachForecast",
+ "fullName": "google.ads.googleads.v12.services.ReachPlanService.GenerateReachForecast",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:generateProductMixIdeas"
+ "path": "/v12/customers/{customer_id=*}:generateReachForecast"
}
]
},
{
- "shortName": "GenerateReachForecast",
- "fullName": "google.ads.googleads.v11.services.ReachPlanService.GenerateReachForecast",
+ "shortName": "ListPlannableLocations",
+ "fullName": "google.ads.googleads.v12.services.ReachPlanService.ListPlannableLocations",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:generateReachForecast"
+ "path": "/v12:listPlannableLocations"
}
]
},
{
- "shortName": "ListPlannableLocations",
- "fullName": "google.ads.googleads.v11.services.ReachPlanService.ListPlannableLocations",
+ "shortName": "ListPlannableProducts",
+ "fullName": "google.ads.googleads.v12.services.ReachPlanService.ListPlannableProducts",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11:listPlannableLocations"
- }
- ]
- },
- {
- "shortName": "ListPlannableProducts",
- "fullName": "google.ads.googleads.v11.services.ReachPlanService.ListPlannableProducts",
- "mode": "UNARY",
- "bindings": [
- {
- "httpMethod": "POST",
- "path": "/v11:listPlannableProducts"
+ "path": "/v12:listPlannableProducts"
}
]
}
@@ -4665,27 +4678,27 @@
},
{
"shortName": "RecommendationService",
- "fullName": "google.ads.googleads.v11.services.RecommendationService",
+ "fullName": "google.ads.googleads.v12.services.RecommendationService",
"methods": [
{
"shortName": "ApplyRecommendation",
- "fullName": "google.ads.googleads.v11.services.RecommendationService.ApplyRecommendation",
+ "fullName": "google.ads.googleads.v12.services.RecommendationService.ApplyRecommendation",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/recommendations:apply"
+ "path": "/v12/customers/{customer_id=*}/recommendations:apply"
}
]
},
{
"shortName": "DismissRecommendation",
- "fullName": "google.ads.googleads.v11.services.RecommendationService.DismissRecommendation",
+ "fullName": "google.ads.googleads.v12.services.RecommendationService.DismissRecommendation",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/recommendations:dismiss"
+ "path": "/v12/customers/{customer_id=*}/recommendations:dismiss"
}
]
}
@@ -4693,16 +4706,16 @@
},
{
"shortName": "RemarketingActionService",
- "fullName": "google.ads.googleads.v11.services.RemarketingActionService",
+ "fullName": "google.ads.googleads.v12.services.RemarketingActionService",
"methods": [
{
"shortName": "MutateRemarketingActions",
- "fullName": "google.ads.googleads.v11.services.RemarketingActionService.MutateRemarketingActions",
+ "fullName": "google.ads.googleads.v12.services.RemarketingActionService.MutateRemarketingActions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/remarketingActions:mutate"
+ "path": "/v12/customers/{customer_id=*}/remarketingActions:mutate"
}
]
}
@@ -4710,16 +4723,16 @@
},
{
"shortName": "SharedCriterionService",
- "fullName": "google.ads.googleads.v11.services.SharedCriterionService",
+ "fullName": "google.ads.googleads.v12.services.SharedCriterionService",
"methods": [
{
"shortName": "MutateSharedCriteria",
- "fullName": "google.ads.googleads.v11.services.SharedCriterionService.MutateSharedCriteria",
+ "fullName": "google.ads.googleads.v12.services.SharedCriterionService.MutateSharedCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/sharedCriteria:mutate"
+ "path": "/v12/customers/{customer_id=*}/sharedCriteria:mutate"
}
]
}
@@ -4727,16 +4740,16 @@
},
{
"shortName": "SharedSetService",
- "fullName": "google.ads.googleads.v11.services.SharedSetService",
+ "fullName": "google.ads.googleads.v12.services.SharedSetService",
"methods": [
{
"shortName": "MutateSharedSets",
- "fullName": "google.ads.googleads.v11.services.SharedSetService.MutateSharedSets",
+ "fullName": "google.ads.googleads.v12.services.SharedSetService.MutateSharedSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/sharedSets:mutate"
+ "path": "/v12/customers/{customer_id=*}/sharedSets:mutate"
}
]
}
@@ -4744,16 +4757,16 @@
},
{
"shortName": "SmartCampaignSettingService",
- "fullName": "google.ads.googleads.v11.services.SmartCampaignSettingService",
+ "fullName": "google.ads.googleads.v12.services.SmartCampaignSettingService",
"methods": [
{
"shortName": "MutateSmartCampaignSettings",
- "fullName": "google.ads.googleads.v11.services.SmartCampaignSettingService.MutateSmartCampaignSettings",
+ "fullName": "google.ads.googleads.v12.services.SmartCampaignSettingService.MutateSmartCampaignSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/smartCampaignSettings:mutate"
+ "path": "/v12/customers/{customer_id=*}/smartCampaignSettings:mutate"
}
]
}
@@ -4761,38 +4774,38 @@
},
{
"shortName": "SmartCampaignSuggestService",
- "fullName": "google.ads.googleads.v11.services.SmartCampaignSuggestService",
+ "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService",
"methods": [
{
"shortName": "SuggestKeywordThemes",
- "fullName": "google.ads.googleads.v11.services.SmartCampaignSuggestService.SuggestKeywordThemes",
+ "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService.SuggestKeywordThemes",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:suggestKeywordThemes"
+ "path": "/v12/customers/{customer_id=*}:suggestKeywordThemes"
}
]
},
{
"shortName": "SuggestSmartCampaignAd",
- "fullName": "google.ads.googleads.v11.services.SmartCampaignSuggestService.SuggestSmartCampaignAd",
+ "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService.SuggestSmartCampaignAd",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:suggestSmartCampaignAd"
+ "path": "/v12/customers/{customer_id=*}:suggestSmartCampaignAd"
}
]
},
{
"shortName": "SuggestSmartCampaignBudgetOptions",
- "fullName": "google.ads.googleads.v11.services.SmartCampaignSuggestService.SuggestSmartCampaignBudgetOptions",
+ "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService.SuggestSmartCampaignBudgetOptions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions"
+ "path": "/v12/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions"
}
]
}
@@ -4800,16 +4813,16 @@
},
{
"shortName": "ThirdPartyAppAnalyticsLinkService",
- "fullName": "google.ads.googleads.v11.services.ThirdPartyAppAnalyticsLinkService",
+ "fullName": "google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService",
"methods": [
{
"shortName": "RegenerateShareableLinkId",
- "fullName": "google.ads.googleads.v11.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId",
+ "fullName": "google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId"
+ "path": "/v12/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId"
}
]
}
@@ -4817,16 +4830,16 @@
},
{
"shortName": "UserDataService",
- "fullName": "google.ads.googleads.v11.services.UserDataService",
+ "fullName": "google.ads.googleads.v12.services.UserDataService",
"methods": [
{
"shortName": "UploadUserData",
- "fullName": "google.ads.googleads.v11.services.UserDataService.UploadUserData",
+ "fullName": "google.ads.googleads.v12.services.UserDataService.UploadUserData",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}:uploadUserData"
+ "path": "/v12/customers/{customer_id=*}:uploadUserData"
}
]
}
@@ -4834,144 +4847,145 @@
},
{
"shortName": "UserListService",
- "fullName": "google.ads.googleads.v11.services.UserListService",
+ "fullName": "google.ads.googleads.v12.services.UserListService",
"methods": [
{
"shortName": "MutateUserLists",
- "fullName": "google.ads.googleads.v11.services.UserListService.MutateUserLists",
+ "fullName": "google.ads.googleads.v12.services.UserListService.MutateUserLists",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v11/customers/{customer_id=*}/userLists:mutate"
+ "path": "/v12/customers/{customer_id=*}/userLists:mutate"
}
]
}
]
}
],
- "configFile": "googleads_v11.yaml",
+ "configFile": "googleads_v12.yaml",
"serviceConfigApiNames": [
- "google.ads.googleads.v11.services.AccountBudgetProposalService",
- "google.ads.googleads.v11.services.AccountLinkService",
- "google.ads.googleads.v11.services.AdGroupAdLabelService",
- "google.ads.googleads.v11.services.AdGroupAdService",
- "google.ads.googleads.v11.services.AdGroupAssetService",
- "google.ads.googleads.v11.services.AdGroupBidModifierService",
- "google.ads.googleads.v11.services.AdGroupCriterionCustomizerService",
- "google.ads.googleads.v11.services.AdGroupCriterionLabelService",
- "google.ads.googleads.v11.services.AdGroupCriterionService",
- "google.ads.googleads.v11.services.AdGroupCustomizerService",
- "google.ads.googleads.v11.services.AdGroupExtensionSettingService",
- "google.ads.googleads.v11.services.AdGroupFeedService",
- "google.ads.googleads.v11.services.AdGroupLabelService",
- "google.ads.googleads.v11.services.AdGroupService",
- "google.ads.googleads.v11.services.AdParameterService",
- "google.ads.googleads.v11.services.AdService",
- "google.ads.googleads.v11.services.AssetGroupAssetService",
- "google.ads.googleads.v11.services.AssetGroupListingGroupFilterService",
- "google.ads.googleads.v11.services.AssetGroupService",
- "google.ads.googleads.v11.services.AssetGroupSignalService",
- "google.ads.googleads.v11.services.AssetService",
- "google.ads.googleads.v11.services.AssetSetAssetService",
- "google.ads.googleads.v11.services.AssetSetService",
- "google.ads.googleads.v11.services.AudienceInsightsService",
- "google.ads.googleads.v11.services.AudienceService",
- "google.ads.googleads.v11.services.BatchJobService",
- "google.ads.googleads.v11.services.BiddingDataExclusionService",
- "google.ads.googleads.v11.services.BiddingSeasonalityAdjustmentService",
- "google.ads.googleads.v11.services.BiddingStrategyService",
- "google.ads.googleads.v11.services.BillingSetupService",
- "google.ads.googleads.v11.services.CampaignAssetService",
- "google.ads.googleads.v11.services.CampaignAssetSetService",
- "google.ads.googleads.v11.services.CampaignBidModifierService",
- "google.ads.googleads.v11.services.CampaignBudgetService",
- "google.ads.googleads.v11.services.CampaignConversionGoalService",
- "google.ads.googleads.v11.services.CampaignCriterionService",
- "google.ads.googleads.v11.services.CampaignCustomizerService",
- "google.ads.googleads.v11.services.CampaignDraftService",
- "google.ads.googleads.v11.services.CampaignExperimentService",
- "google.ads.googleads.v11.services.CampaignExtensionSettingService",
- "google.ads.googleads.v11.services.CampaignFeedService",
- "google.ads.googleads.v11.services.CampaignGroupService",
- "google.ads.googleads.v11.services.CampaignLabelService",
- "google.ads.googleads.v11.services.CampaignService",
- "google.ads.googleads.v11.services.CampaignSharedSetService",
- "google.ads.googleads.v11.services.ConversionActionService",
- "google.ads.googleads.v11.services.ConversionAdjustmentUploadService",
- "google.ads.googleads.v11.services.ConversionCustomVariableService",
- "google.ads.googleads.v11.services.ConversionGoalCampaignConfigService",
- "google.ads.googleads.v11.services.ConversionUploadService",
- "google.ads.googleads.v11.services.ConversionValueRuleService",
- "google.ads.googleads.v11.services.ConversionValueRuleSetService",
- "google.ads.googleads.v11.services.CustomAudienceService",
- "google.ads.googleads.v11.services.CustomConversionGoalService",
- "google.ads.googleads.v11.services.CustomInterestService",
- "google.ads.googleads.v11.services.CustomerAssetService",
- "google.ads.googleads.v11.services.CustomerClientLinkService",
- "google.ads.googleads.v11.services.CustomerConversionGoalService",
- "google.ads.googleads.v11.services.CustomerCustomizerService",
- "google.ads.googleads.v11.services.CustomerExtensionSettingService",
- "google.ads.googleads.v11.services.CustomerFeedService",
- "google.ads.googleads.v11.services.CustomerLabelService",
- "google.ads.googleads.v11.services.CustomerManagerLinkService",
- "google.ads.googleads.v11.services.CustomerNegativeCriterionService",
- "google.ads.googleads.v11.services.CustomerService",
- "google.ads.googleads.v11.services.CustomerUserAccessInvitationService",
- "google.ads.googleads.v11.services.CustomerUserAccessService",
- "google.ads.googleads.v11.services.CustomizerAttributeService",
- "google.ads.googleads.v11.services.ExperimentArmService",
- "google.ads.googleads.v11.services.ExperimentService",
- "google.ads.googleads.v11.services.ExtensionFeedItemService",
- "google.ads.googleads.v11.services.FeedItemService",
- "google.ads.googleads.v11.services.FeedItemSetLinkService",
- "google.ads.googleads.v11.services.FeedItemSetService",
- "google.ads.googleads.v11.services.FeedItemTargetService",
- "google.ads.googleads.v11.services.FeedMappingService",
- "google.ads.googleads.v11.services.FeedService",
- "google.ads.googleads.v11.services.GeoTargetConstantService",
- "google.ads.googleads.v11.services.GoogleAdsFieldService",
- "google.ads.googleads.v11.services.GoogleAdsService",
- "google.ads.googleads.v11.services.InvoiceService",
- "google.ads.googleads.v11.services.KeywordPlanAdGroupKeywordService",
- "google.ads.googleads.v11.services.KeywordPlanAdGroupService",
- "google.ads.googleads.v11.services.KeywordPlanCampaignKeywordService",
- "google.ads.googleads.v11.services.KeywordPlanCampaignService",
- "google.ads.googleads.v11.services.KeywordPlanIdeaService",
- "google.ads.googleads.v11.services.KeywordPlanService",
- "google.ads.googleads.v11.services.KeywordThemeConstantService",
- "google.ads.googleads.v11.services.LabelService",
- "google.ads.googleads.v11.services.MediaFileService",
- "google.ads.googleads.v11.services.MerchantCenterLinkService",
- "google.ads.googleads.v11.services.OfflineUserDataJobService",
- "google.ads.googleads.v11.services.PaymentsAccountService",
- "google.ads.googleads.v11.services.ReachPlanService",
- "google.ads.googleads.v11.services.RecommendationService",
- "google.ads.googleads.v11.services.RemarketingActionService",
- "google.ads.googleads.v11.services.SharedCriterionService",
- "google.ads.googleads.v11.services.SharedSetService",
- "google.ads.googleads.v11.services.SmartCampaignSettingService",
- "google.ads.googleads.v11.services.SmartCampaignSuggestService",
- "google.ads.googleads.v11.services.ThirdPartyAppAnalyticsLinkService",
- "google.ads.googleads.v11.services.UserDataService",
- "google.ads.googleads.v11.services.UserListService"
+ "google.ads.googleads.v12.services.AccountBudgetProposalService",
+ "google.ads.googleads.v12.services.AccountLinkService",
+ "google.ads.googleads.v12.services.AdGroupAdLabelService",
+ "google.ads.googleads.v12.services.AdGroupAdService",
+ "google.ads.googleads.v12.services.AdGroupAssetService",
+ "google.ads.googleads.v12.services.AdGroupAssetSetService",
+ "google.ads.googleads.v12.services.AdGroupBidModifierService",
+ "google.ads.googleads.v12.services.AdGroupCriterionCustomizerService",
+ "google.ads.googleads.v12.services.AdGroupCriterionLabelService",
+ "google.ads.googleads.v12.services.AdGroupCriterionService",
+ "google.ads.googleads.v12.services.AdGroupCustomizerService",
+ "google.ads.googleads.v12.services.AdGroupExtensionSettingService",
+ "google.ads.googleads.v12.services.AdGroupFeedService",
+ "google.ads.googleads.v12.services.AdGroupLabelService",
+ "google.ads.googleads.v12.services.AdGroupService",
+ "google.ads.googleads.v12.services.AdParameterService",
+ "google.ads.googleads.v12.services.AdService",
+ "google.ads.googleads.v12.services.AssetGroupAssetService",
+ "google.ads.googleads.v12.services.AssetGroupListingGroupFilterService",
+ "google.ads.googleads.v12.services.AssetGroupService",
+ "google.ads.googleads.v12.services.AssetGroupSignalService",
+ "google.ads.googleads.v12.services.AssetService",
+ "google.ads.googleads.v12.services.AssetSetAssetService",
+ "google.ads.googleads.v12.services.AssetSetService",
+ "google.ads.googleads.v12.services.AudienceInsightsService",
+ "google.ads.googleads.v12.services.AudienceService",
+ "google.ads.googleads.v12.services.BatchJobService",
+ "google.ads.googleads.v12.services.BiddingDataExclusionService",
+ "google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService",
+ "google.ads.googleads.v12.services.BiddingStrategyService",
+ "google.ads.googleads.v12.services.BillingSetupService",
+ "google.ads.googleads.v12.services.CampaignAssetService",
+ "google.ads.googleads.v12.services.CampaignAssetSetService",
+ "google.ads.googleads.v12.services.CampaignBidModifierService",
+ "google.ads.googleads.v12.services.CampaignBudgetService",
+ "google.ads.googleads.v12.services.CampaignConversionGoalService",
+ "google.ads.googleads.v12.services.CampaignCriterionService",
+ "google.ads.googleads.v12.services.CampaignCustomizerService",
+ "google.ads.googleads.v12.services.CampaignDraftService",
+ "google.ads.googleads.v12.services.CampaignExtensionSettingService",
+ "google.ads.googleads.v12.services.CampaignFeedService",
+ "google.ads.googleads.v12.services.CampaignGroupService",
+ "google.ads.googleads.v12.services.CampaignLabelService",
+ "google.ads.googleads.v12.services.CampaignService",
+ "google.ads.googleads.v12.services.CampaignSharedSetService",
+ "google.ads.googleads.v12.services.ConversionActionService",
+ "google.ads.googleads.v12.services.ConversionAdjustmentUploadService",
+ "google.ads.googleads.v12.services.ConversionCustomVariableService",
+ "google.ads.googleads.v12.services.ConversionGoalCampaignConfigService",
+ "google.ads.googleads.v12.services.ConversionUploadService",
+ "google.ads.googleads.v12.services.ConversionValueRuleService",
+ "google.ads.googleads.v12.services.ConversionValueRuleSetService",
+ "google.ads.googleads.v12.services.CustomAudienceService",
+ "google.ads.googleads.v12.services.CustomConversionGoalService",
+ "google.ads.googleads.v12.services.CustomInterestService",
+ "google.ads.googleads.v12.services.CustomerAssetService",
+ "google.ads.googleads.v12.services.CustomerAssetSetService",
+ "google.ads.googleads.v12.services.CustomerClientLinkService",
+ "google.ads.googleads.v12.services.CustomerConversionGoalService",
+ "google.ads.googleads.v12.services.CustomerCustomizerService",
+ "google.ads.googleads.v12.services.CustomerExtensionSettingService",
+ "google.ads.googleads.v12.services.CustomerFeedService",
+ "google.ads.googleads.v12.services.CustomerLabelService",
+ "google.ads.googleads.v12.services.CustomerManagerLinkService",
+ "google.ads.googleads.v12.services.CustomerNegativeCriterionService",
+ "google.ads.googleads.v12.services.CustomerService",
+ "google.ads.googleads.v12.services.CustomerUserAccessInvitationService",
+ "google.ads.googleads.v12.services.CustomerUserAccessService",
+ "google.ads.googleads.v12.services.CustomizerAttributeService",
+ "google.ads.googleads.v12.services.ExperimentArmService",
+ "google.ads.googleads.v12.services.ExperimentService",
+ "google.ads.googleads.v12.services.ExtensionFeedItemService",
+ "google.ads.googleads.v12.services.FeedItemService",
+ "google.ads.googleads.v12.services.FeedItemSetLinkService",
+ "google.ads.googleads.v12.services.FeedItemSetService",
+ "google.ads.googleads.v12.services.FeedItemTargetService",
+ "google.ads.googleads.v12.services.FeedMappingService",
+ "google.ads.googleads.v12.services.FeedService",
+ "google.ads.googleads.v12.services.GeoTargetConstantService",
+ "google.ads.googleads.v12.services.GoogleAdsFieldService",
+ "google.ads.googleads.v12.services.GoogleAdsService",
+ "google.ads.googleads.v12.services.InvoiceService",
+ "google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService",
+ "google.ads.googleads.v12.services.KeywordPlanAdGroupService",
+ "google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService",
+ "google.ads.googleads.v12.services.KeywordPlanCampaignService",
+ "google.ads.googleads.v12.services.KeywordPlanIdeaService",
+ "google.ads.googleads.v12.services.KeywordPlanService",
+ "google.ads.googleads.v12.services.KeywordThemeConstantService",
+ "google.ads.googleads.v12.services.LabelService",
+ "google.ads.googleads.v12.services.MediaFileService",
+ "google.ads.googleads.v12.services.MerchantCenterLinkService",
+ "google.ads.googleads.v12.services.OfflineUserDataJobService",
+ "google.ads.googleads.v12.services.PaymentsAccountService",
+ "google.ads.googleads.v12.services.ReachPlanService",
+ "google.ads.googleads.v12.services.RecommendationService",
+ "google.ads.googleads.v12.services.RemarketingActionService",
+ "google.ads.googleads.v12.services.SharedCriterionService",
+ "google.ads.googleads.v12.services.SharedSetService",
+ "google.ads.googleads.v12.services.SmartCampaignSettingService",
+ "google.ads.googleads.v12.services.SmartCampaignSuggestService",
+ "google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService",
+ "google.ads.googleads.v12.services.UserDataService",
+ "google.ads.googleads.v12.services.UserListService"
],
"nameInServiceConfig": "googleads.googleapis.com"
},
{
- "id": "google.ads.googleads.v12",
- "directory": "google/ads/googleads/v12",
- "version": "v12",
- "majorVersion": "v12",
+ "id": "google.ads.googleads.v13",
+ "directory": "google/ads/googleads/v13",
+ "version": "v13",
+ "majorVersion": "v13",
"hostName": "googleads.googleapis.com",
"title": "Google Ads API",
"description": "Manage your Google Ads accounts, campaigns, and reports with this API.",
"importDirectories": [
- "google/ads/googleads/v12/common",
- "google/ads/googleads/v12/enums",
- "google/ads/googleads/v12/errors",
- "google/ads/googleads/v12/resources",
- "google/ads/googleads/v12/services",
+ "google/ads/googleads/v13/common",
+ "google/ads/googleads/v13/enums",
+ "google/ads/googleads/v13/errors",
+ "google/ads/googleads/v13/resources",
+ "google/ads/googleads/v13/services",
"google/api",
"google/longrunning",
"google/protobuf",
@@ -4980,73 +4994,73 @@
"options": {
"csharp_namespace": {
"valueCounts": {
- "Google.Ads.GoogleAds.V12.Common": 36,
- "Google.Ads.GoogleAds.V12.Enums": 301,
- "Google.Ads.GoogleAds.V12.Errors": 142,
- "Google.Ads.GoogleAds.V12.Resources": 159,
- "Google.Ads.GoogleAds.V12.Services": 104
+ "Google.Ads.GoogleAds.V13.Common": 35,
+ "Google.Ads.GoogleAds.V13.Enums": 307,
+ "Google.Ads.GoogleAds.V13.Errors": 143,
+ "Google.Ads.GoogleAds.V13.Resources": 163,
+ "Google.Ads.GoogleAds.V13.Services": 106
}
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/ads/googleads/v12/common;common": 36,
- "google.golang.org/genproto/googleapis/ads/googleads/v12/enums;enums": 301,
- "google.golang.org/genproto/googleapis/ads/googleads/v12/errors;errors": 142,
- "google.golang.org/genproto/googleapis/ads/googleads/v12/resources;resources": 159,
- "google.golang.org/genproto/googleapis/ads/googleads/v12/services;services": 104
+ "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common": 35,
+ "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums": 307,
+ "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors": 143,
+ "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources": 163,
+ "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services": 106
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 742
+ "true": 754
}
},
"java_package": {
"valueCounts": {
- "com.google.ads.googleads.v12.common": 36,
- "com.google.ads.googleads.v12.enums": 301,
- "com.google.ads.googleads.v12.errors": 142,
- "com.google.ads.googleads.v12.resources": 159,
- "com.google.ads.googleads.v12.services": 104
+ "com.google.ads.googleads.v13.common": 35,
+ "com.google.ads.googleads.v13.enums": 307,
+ "com.google.ads.googleads.v13.errors": 143,
+ "com.google.ads.googleads.v13.resources": 163,
+ "com.google.ads.googleads.v13.services": 106
}
},
"objc_class_prefix": {
"valueCounts": {
- "GAA": 742
+ "GAA": 754
}
},
"php_namespace": {
"valueCounts": {
- "Google\\Ads\\GoogleAds\\V12\\Common": 36,
- "Google\\Ads\\GoogleAds\\V12\\Enums": 301,
- "Google\\Ads\\GoogleAds\\V12\\Errors": 142,
- "Google\\Ads\\GoogleAds\\V12\\Resources": 159,
- "Google\\Ads\\GoogleAds\\V12\\Services": 104
+ "Google\\Ads\\GoogleAds\\V13\\Common": 35,
+ "Google\\Ads\\GoogleAds\\V13\\Enums": 307,
+ "Google\\Ads\\GoogleAds\\V13\\Errors": 143,
+ "Google\\Ads\\GoogleAds\\V13\\Resources": 163,
+ "Google\\Ads\\GoogleAds\\V13\\Services": 106
}
},
"ruby_package": {
"valueCounts": {
- "Google::Ads::GoogleAds::V12::Common": 36,
- "Google::Ads::GoogleAds::V12::Enums": 301,
- "Google::Ads::GoogleAds::V12::Errors": 142,
- "Google::Ads::GoogleAds::V12::Resources": 159,
- "Google::Ads::GoogleAds::V12::Services": 104
+ "Google::Ads::GoogleAds::V13::Common": 35,
+ "Google::Ads::GoogleAds::V13::Enums": 307,
+ "Google::Ads::GoogleAds::V13::Errors": 143,
+ "Google::Ads::GoogleAds::V13::Resources": 163,
+ "Google::Ads::GoogleAds::V13::Services": 106
}
}
},
"services": [
{
"shortName": "AccountBudgetProposalService",
- "fullName": "google.ads.googleads.v12.services.AccountBudgetProposalService",
+ "fullName": "google.ads.googleads.v13.services.AccountBudgetProposalService",
"methods": [
{
"shortName": "MutateAccountBudgetProposal",
- "fullName": "google.ads.googleads.v12.services.AccountBudgetProposalService.MutateAccountBudgetProposal",
+ "fullName": "google.ads.googleads.v13.services.AccountBudgetProposalService.MutateAccountBudgetProposal",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/accountBudgetProposals:mutate"
+ "path": "/v13/customers/{customer_id=*}/accountBudgetProposals:mutate"
}
]
}
@@ -5054,27 +5068,27 @@
},
{
"shortName": "AccountLinkService",
- "fullName": "google.ads.googleads.v12.services.AccountLinkService",
+ "fullName": "google.ads.googleads.v13.services.AccountLinkService",
"methods": [
{
"shortName": "CreateAccountLink",
- "fullName": "google.ads.googleads.v12.services.AccountLinkService.CreateAccountLink",
+ "fullName": "google.ads.googleads.v13.services.AccountLinkService.CreateAccountLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/accountLinks:create"
+ "path": "/v13/customers/{customer_id=*}/accountLinks:create"
}
]
},
{
"shortName": "MutateAccountLink",
- "fullName": "google.ads.googleads.v12.services.AccountLinkService.MutateAccountLink",
+ "fullName": "google.ads.googleads.v13.services.AccountLinkService.MutateAccountLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/accountLinks:mutate"
+ "path": "/v13/customers/{customer_id=*}/accountLinks:mutate"
}
]
}
@@ -5082,16 +5096,16 @@
},
{
"shortName": "AdGroupAdLabelService",
- "fullName": "google.ads.googleads.v12.services.AdGroupAdLabelService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupAdLabelService",
"methods": [
{
"shortName": "MutateAdGroupAdLabels",
- "fullName": "google.ads.googleads.v12.services.AdGroupAdLabelService.MutateAdGroupAdLabels",
+ "fullName": "google.ads.googleads.v13.services.AdGroupAdLabelService.MutateAdGroupAdLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroupAdLabels:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroupAdLabels:mutate"
}
]
}
@@ -5099,16 +5113,16 @@
},
{
"shortName": "AdGroupAdService",
- "fullName": "google.ads.googleads.v12.services.AdGroupAdService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupAdService",
"methods": [
{
"shortName": "MutateAdGroupAds",
- "fullName": "google.ads.googleads.v12.services.AdGroupAdService.MutateAdGroupAds",
+ "fullName": "google.ads.googleads.v13.services.AdGroupAdService.MutateAdGroupAds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroupAds:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroupAds:mutate"
}
]
}
@@ -5116,16 +5130,16 @@
},
{
"shortName": "AdGroupAssetService",
- "fullName": "google.ads.googleads.v12.services.AdGroupAssetService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupAssetService",
"methods": [
{
"shortName": "MutateAdGroupAssets",
- "fullName": "google.ads.googleads.v12.services.AdGroupAssetService.MutateAdGroupAssets",
+ "fullName": "google.ads.googleads.v13.services.AdGroupAssetService.MutateAdGroupAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroupAssets:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroupAssets:mutate"
}
]
}
@@ -5133,16 +5147,16 @@
},
{
"shortName": "AdGroupAssetSetService",
- "fullName": "google.ads.googleads.v12.services.AdGroupAssetSetService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupAssetSetService",
"methods": [
{
"shortName": "MutateAdGroupAssetSets",
- "fullName": "google.ads.googleads.v12.services.AdGroupAssetSetService.MutateAdGroupAssetSets",
+ "fullName": "google.ads.googleads.v13.services.AdGroupAssetSetService.MutateAdGroupAssetSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroupAssetSets:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroupAssetSets:mutate"
}
]
}
@@ -5150,16 +5164,16 @@
},
{
"shortName": "AdGroupBidModifierService",
- "fullName": "google.ads.googleads.v12.services.AdGroupBidModifierService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupBidModifierService",
"methods": [
{
"shortName": "MutateAdGroupBidModifiers",
- "fullName": "google.ads.googleads.v12.services.AdGroupBidModifierService.MutateAdGroupBidModifiers",
+ "fullName": "google.ads.googleads.v13.services.AdGroupBidModifierService.MutateAdGroupBidModifiers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroupBidModifiers:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroupBidModifiers:mutate"
}
]
}
@@ -5167,16 +5181,16 @@
},
{
"shortName": "AdGroupCriterionCustomizerService",
- "fullName": "google.ads.googleads.v12.services.AdGroupCriterionCustomizerService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupCriterionCustomizerService",
"methods": [
{
"shortName": "MutateAdGroupCriterionCustomizers",
- "fullName": "google.ads.googleads.v12.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers",
+ "fullName": "google.ads.googleads.v13.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate"
+ "path": "/v13/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate"
}
]
}
@@ -5184,16 +5198,16 @@
},
{
"shortName": "AdGroupCriterionLabelService",
- "fullName": "google.ads.googleads.v12.services.AdGroupCriterionLabelService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupCriterionLabelService",
"methods": [
{
"shortName": "MutateAdGroupCriterionLabels",
- "fullName": "google.ads.googleads.v12.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels",
+ "fullName": "google.ads.googleads.v13.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroupCriterionLabels:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroupCriterionLabels:mutate"
}
]
}
@@ -5201,16 +5215,16 @@
},
{
"shortName": "AdGroupCriterionService",
- "fullName": "google.ads.googleads.v12.services.AdGroupCriterionService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupCriterionService",
"methods": [
{
"shortName": "MutateAdGroupCriteria",
- "fullName": "google.ads.googleads.v12.services.AdGroupCriterionService.MutateAdGroupCriteria",
+ "fullName": "google.ads.googleads.v13.services.AdGroupCriterionService.MutateAdGroupCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroupCriteria:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroupCriteria:mutate"
}
]
}
@@ -5218,16 +5232,16 @@
},
{
"shortName": "AdGroupCustomizerService",
- "fullName": "google.ads.googleads.v12.services.AdGroupCustomizerService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupCustomizerService",
"methods": [
{
"shortName": "MutateAdGroupCustomizers",
- "fullName": "google.ads.googleads.v12.services.AdGroupCustomizerService.MutateAdGroupCustomizers",
+ "fullName": "google.ads.googleads.v13.services.AdGroupCustomizerService.MutateAdGroupCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroupCustomizers:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroupCustomizers:mutate"
}
]
}
@@ -5235,16 +5249,16 @@
},
{
"shortName": "AdGroupExtensionSettingService",
- "fullName": "google.ads.googleads.v12.services.AdGroupExtensionSettingService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupExtensionSettingService",
"methods": [
{
"shortName": "MutateAdGroupExtensionSettings",
- "fullName": "google.ads.googleads.v12.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings",
+ "fullName": "google.ads.googleads.v13.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroupExtensionSettings:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroupExtensionSettings:mutate"
}
]
}
@@ -5252,16 +5266,16 @@
},
{
"shortName": "AdGroupFeedService",
- "fullName": "google.ads.googleads.v12.services.AdGroupFeedService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupFeedService",
"methods": [
{
"shortName": "MutateAdGroupFeeds",
- "fullName": "google.ads.googleads.v12.services.AdGroupFeedService.MutateAdGroupFeeds",
+ "fullName": "google.ads.googleads.v13.services.AdGroupFeedService.MutateAdGroupFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroupFeeds:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroupFeeds:mutate"
}
]
}
@@ -5269,16 +5283,16 @@
},
{
"shortName": "AdGroupLabelService",
- "fullName": "google.ads.googleads.v12.services.AdGroupLabelService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupLabelService",
"methods": [
{
"shortName": "MutateAdGroupLabels",
- "fullName": "google.ads.googleads.v12.services.AdGroupLabelService.MutateAdGroupLabels",
+ "fullName": "google.ads.googleads.v13.services.AdGroupLabelService.MutateAdGroupLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroupLabels:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroupLabels:mutate"
}
]
}
@@ -5286,16 +5300,16 @@
},
{
"shortName": "AdGroupService",
- "fullName": "google.ads.googleads.v12.services.AdGroupService",
+ "fullName": "google.ads.googleads.v13.services.AdGroupService",
"methods": [
{
"shortName": "MutateAdGroups",
- "fullName": "google.ads.googleads.v12.services.AdGroupService.MutateAdGroups",
+ "fullName": "google.ads.googleads.v13.services.AdGroupService.MutateAdGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adGroups:mutate"
+ "path": "/v13/customers/{customer_id=*}/adGroups:mutate"
}
]
}
@@ -5303,16 +5317,16 @@
},
{
"shortName": "AdParameterService",
- "fullName": "google.ads.googleads.v12.services.AdParameterService",
+ "fullName": "google.ads.googleads.v13.services.AdParameterService",
"methods": [
{
"shortName": "MutateAdParameters",
- "fullName": "google.ads.googleads.v12.services.AdParameterService.MutateAdParameters",
+ "fullName": "google.ads.googleads.v13.services.AdParameterService.MutateAdParameters",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/adParameters:mutate"
+ "path": "/v13/customers/{customer_id=*}/adParameters:mutate"
}
]
}
@@ -5320,27 +5334,27 @@
},
{
"shortName": "AdService",
- "fullName": "google.ads.googleads.v12.services.AdService",
+ "fullName": "google.ads.googleads.v13.services.AdService",
"methods": [
{
"shortName": "GetAd",
- "fullName": "google.ads.googleads.v12.services.AdService.GetAd",
+ "fullName": "google.ads.googleads.v13.services.AdService.GetAd",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v12/{resource_name=customers/*/ads/*}"
+ "path": "/v13/{resource_name=customers/*/ads/*}"
}
]
},
{
"shortName": "MutateAds",
- "fullName": "google.ads.googleads.v12.services.AdService.MutateAds",
+ "fullName": "google.ads.googleads.v13.services.AdService.MutateAds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/ads:mutate"
+ "path": "/v13/customers/{customer_id=*}/ads:mutate"
}
]
}
@@ -5348,16 +5362,16 @@
},
{
"shortName": "AssetGroupAssetService",
- "fullName": "google.ads.googleads.v12.services.AssetGroupAssetService",
+ "fullName": "google.ads.googleads.v13.services.AssetGroupAssetService",
"methods": [
{
"shortName": "MutateAssetGroupAssets",
- "fullName": "google.ads.googleads.v12.services.AssetGroupAssetService.MutateAssetGroupAssets",
+ "fullName": "google.ads.googleads.v13.services.AssetGroupAssetService.MutateAssetGroupAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/assetGroupAssets:mutate"
+ "path": "/v13/customers/{customer_id=*}/assetGroupAssets:mutate"
}
]
}
@@ -5365,16 +5379,16 @@
},
{
"shortName": "AssetGroupListingGroupFilterService",
- "fullName": "google.ads.googleads.v12.services.AssetGroupListingGroupFilterService",
+ "fullName": "google.ads.googleads.v13.services.AssetGroupListingGroupFilterService",
"methods": [
{
"shortName": "MutateAssetGroupListingGroupFilters",
- "fullName": "google.ads.googleads.v12.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters",
+ "fullName": "google.ads.googleads.v13.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate"
+ "path": "/v13/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate"
}
]
}
@@ -5382,16 +5396,16 @@
},
{
"shortName": "AssetGroupService",
- "fullName": "google.ads.googleads.v12.services.AssetGroupService",
+ "fullName": "google.ads.googleads.v13.services.AssetGroupService",
"methods": [
{
"shortName": "MutateAssetGroups",
- "fullName": "google.ads.googleads.v12.services.AssetGroupService.MutateAssetGroups",
+ "fullName": "google.ads.googleads.v13.services.AssetGroupService.MutateAssetGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/assetGroups:mutate"
+ "path": "/v13/customers/{customer_id=*}/assetGroups:mutate"
}
]
}
@@ -5399,16 +5413,16 @@
},
{
"shortName": "AssetGroupSignalService",
- "fullName": "google.ads.googleads.v12.services.AssetGroupSignalService",
+ "fullName": "google.ads.googleads.v13.services.AssetGroupSignalService",
"methods": [
{
"shortName": "MutateAssetGroupSignals",
- "fullName": "google.ads.googleads.v12.services.AssetGroupSignalService.MutateAssetGroupSignals",
+ "fullName": "google.ads.googleads.v13.services.AssetGroupSignalService.MutateAssetGroupSignals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/assetGroupSignals:mutate"
+ "path": "/v13/customers/{customer_id=*}/assetGroupSignals:mutate"
}
]
}
@@ -5416,16 +5430,16 @@
},
{
"shortName": "AssetService",
- "fullName": "google.ads.googleads.v12.services.AssetService",
+ "fullName": "google.ads.googleads.v13.services.AssetService",
"methods": [
{
"shortName": "MutateAssets",
- "fullName": "google.ads.googleads.v12.services.AssetService.MutateAssets",
+ "fullName": "google.ads.googleads.v13.services.AssetService.MutateAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/assets:mutate"
+ "path": "/v13/customers/{customer_id=*}/assets:mutate"
}
]
}
@@ -5433,16 +5447,16 @@
},
{
"shortName": "AssetSetAssetService",
- "fullName": "google.ads.googleads.v12.services.AssetSetAssetService",
+ "fullName": "google.ads.googleads.v13.services.AssetSetAssetService",
"methods": [
{
"shortName": "MutateAssetSetAssets",
- "fullName": "google.ads.googleads.v12.services.AssetSetAssetService.MutateAssetSetAssets",
+ "fullName": "google.ads.googleads.v13.services.AssetSetAssetService.MutateAssetSetAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/assetSetAssets:mutate"
+ "path": "/v13/customers/{customer_id=*}/assetSetAssets:mutate"
}
]
}
@@ -5450,16 +5464,16 @@
},
{
"shortName": "AssetSetService",
- "fullName": "google.ads.googleads.v12.services.AssetSetService",
+ "fullName": "google.ads.googleads.v13.services.AssetSetService",
"methods": [
{
"shortName": "MutateAssetSets",
- "fullName": "google.ads.googleads.v12.services.AssetSetService.MutateAssetSets",
+ "fullName": "google.ads.googleads.v13.services.AssetSetService.MutateAssetSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/assetSets:mutate"
+ "path": "/v13/customers/{customer_id=*}/assetSets:mutate"
}
]
}
@@ -5467,49 +5481,49 @@
},
{
"shortName": "AudienceInsightsService",
- "fullName": "google.ads.googleads.v12.services.AudienceInsightsService",
+ "fullName": "google.ads.googleads.v13.services.AudienceInsightsService",
"methods": [
{
"shortName": "GenerateAudienceCompositionInsights",
- "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.GenerateAudienceCompositionInsights",
+ "fullName": "google.ads.googleads.v13.services.AudienceInsightsService.GenerateAudienceCompositionInsights",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:generateAudienceCompositionInsights"
+ "path": "/v13/customers/{customer_id=*}:generateAudienceCompositionInsights"
}
]
},
{
"shortName": "GenerateInsightsFinderReport",
- "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.GenerateInsightsFinderReport",
+ "fullName": "google.ads.googleads.v13.services.AudienceInsightsService.GenerateInsightsFinderReport",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:generateInsightsFinderReport"
+ "path": "/v13/customers/{customer_id=*}:generateInsightsFinderReport"
}
]
},
{
"shortName": "ListAudienceInsightsAttributes",
- "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.ListAudienceInsightsAttributes",
+ "fullName": "google.ads.googleads.v13.services.AudienceInsightsService.ListAudienceInsightsAttributes",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:searchAudienceInsightsAttributes"
+ "path": "/v13/customers/{customer_id=*}:searchAudienceInsightsAttributes"
}
]
},
{
"shortName": "ListInsightsEligibleDates",
- "fullName": "google.ads.googleads.v12.services.AudienceInsightsService.ListInsightsEligibleDates",
+ "fullName": "google.ads.googleads.v13.services.AudienceInsightsService.ListInsightsEligibleDates",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/audienceInsights:listInsightsEligibleDates"
+ "path": "/v13/audienceInsights:listInsightsEligibleDates"
}
]
}
@@ -5517,16 +5531,16 @@
},
{
"shortName": "AudienceService",
- "fullName": "google.ads.googleads.v12.services.AudienceService",
+ "fullName": "google.ads.googleads.v13.services.AudienceService",
"methods": [
{
"shortName": "MutateAudiences",
- "fullName": "google.ads.googleads.v12.services.AudienceService.MutateAudiences",
+ "fullName": "google.ads.googleads.v13.services.AudienceService.MutateAudiences",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/audiences:mutate"
+ "path": "/v13/customers/{customer_id=*}/audiences:mutate"
}
]
}
@@ -5534,49 +5548,49 @@
},
{
"shortName": "BatchJobService",
- "fullName": "google.ads.googleads.v12.services.BatchJobService",
+ "fullName": "google.ads.googleads.v13.services.BatchJobService",
"methods": [
{
"shortName": "AddBatchJobOperations",
- "fullName": "google.ads.googleads.v12.services.BatchJobService.AddBatchJobOperations",
+ "fullName": "google.ads.googleads.v13.services.BatchJobService.AddBatchJobOperations",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{resource_name=customers/*/batchJobs/*}:addOperations"
+ "path": "/v13/{resource_name=customers/*/batchJobs/*}:addOperations"
}
]
},
{
"shortName": "ListBatchJobResults",
- "fullName": "google.ads.googleads.v12.services.BatchJobService.ListBatchJobResults",
+ "fullName": "google.ads.googleads.v13.services.BatchJobService.ListBatchJobResults",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v12/{resource_name=customers/*/batchJobs/*}:listResults"
+ "path": "/v13/{resource_name=customers/*/batchJobs/*}:listResults"
}
]
},
{
"shortName": "MutateBatchJob",
- "fullName": "google.ads.googleads.v12.services.BatchJobService.MutateBatchJob",
+ "fullName": "google.ads.googleads.v13.services.BatchJobService.MutateBatchJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/batchJobs:mutate"
+ "path": "/v13/customers/{customer_id=*}/batchJobs:mutate"
}
]
},
{
"shortName": "RunBatchJob",
- "fullName": "google.ads.googleads.v12.services.BatchJobService.RunBatchJob",
+ "fullName": "google.ads.googleads.v13.services.BatchJobService.RunBatchJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{resource_name=customers/*/batchJobs/*}:run"
+ "path": "/v13/{resource_name=customers/*/batchJobs/*}:run"
}
]
}
@@ -5584,16 +5598,16 @@
},
{
"shortName": "BiddingDataExclusionService",
- "fullName": "google.ads.googleads.v12.services.BiddingDataExclusionService",
+ "fullName": "google.ads.googleads.v13.services.BiddingDataExclusionService",
"methods": [
{
"shortName": "MutateBiddingDataExclusions",
- "fullName": "google.ads.googleads.v12.services.BiddingDataExclusionService.MutateBiddingDataExclusions",
+ "fullName": "google.ads.googleads.v13.services.BiddingDataExclusionService.MutateBiddingDataExclusions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/biddingDataExclusions:mutate"
+ "path": "/v13/customers/{customer_id=*}/biddingDataExclusions:mutate"
}
]
}
@@ -5601,16 +5615,16 @@
},
{
"shortName": "BiddingSeasonalityAdjustmentService",
- "fullName": "google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService",
+ "fullName": "google.ads.googleads.v13.services.BiddingSeasonalityAdjustmentService",
"methods": [
{
"shortName": "MutateBiddingSeasonalityAdjustments",
- "fullName": "google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments",
+ "fullName": "google.ads.googleads.v13.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate"
+ "path": "/v13/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate"
}
]
}
@@ -5618,16 +5632,16 @@
},
{
"shortName": "BiddingStrategyService",
- "fullName": "google.ads.googleads.v12.services.BiddingStrategyService",
+ "fullName": "google.ads.googleads.v13.services.BiddingStrategyService",
"methods": [
{
"shortName": "MutateBiddingStrategies",
- "fullName": "google.ads.googleads.v12.services.BiddingStrategyService.MutateBiddingStrategies",
+ "fullName": "google.ads.googleads.v13.services.BiddingStrategyService.MutateBiddingStrategies",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/biddingStrategies:mutate"
+ "path": "/v13/customers/{customer_id=*}/biddingStrategies:mutate"
}
]
}
@@ -5635,16 +5649,16 @@
},
{
"shortName": "BillingSetupService",
- "fullName": "google.ads.googleads.v12.services.BillingSetupService",
+ "fullName": "google.ads.googleads.v13.services.BillingSetupService",
"methods": [
{
"shortName": "MutateBillingSetup",
- "fullName": "google.ads.googleads.v12.services.BillingSetupService.MutateBillingSetup",
+ "fullName": "google.ads.googleads.v13.services.BillingSetupService.MutateBillingSetup",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/billingSetups:mutate"
+ "path": "/v13/customers/{customer_id=*}/billingSetups:mutate"
}
]
}
@@ -5652,16 +5666,16 @@
},
{
"shortName": "CampaignAssetService",
- "fullName": "google.ads.googleads.v12.services.CampaignAssetService",
+ "fullName": "google.ads.googleads.v13.services.CampaignAssetService",
"methods": [
{
"shortName": "MutateCampaignAssets",
- "fullName": "google.ads.googleads.v12.services.CampaignAssetService.MutateCampaignAssets",
+ "fullName": "google.ads.googleads.v13.services.CampaignAssetService.MutateCampaignAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignAssets:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignAssets:mutate"
}
]
}
@@ -5669,16 +5683,16 @@
},
{
"shortName": "CampaignAssetSetService",
- "fullName": "google.ads.googleads.v12.services.CampaignAssetSetService",
+ "fullName": "google.ads.googleads.v13.services.CampaignAssetSetService",
"methods": [
{
"shortName": "MutateCampaignAssetSets",
- "fullName": "google.ads.googleads.v12.services.CampaignAssetSetService.MutateCampaignAssetSets",
+ "fullName": "google.ads.googleads.v13.services.CampaignAssetSetService.MutateCampaignAssetSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignAssetSets:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignAssetSets:mutate"
}
]
}
@@ -5686,16 +5700,16 @@
},
{
"shortName": "CampaignBidModifierService",
- "fullName": "google.ads.googleads.v12.services.CampaignBidModifierService",
+ "fullName": "google.ads.googleads.v13.services.CampaignBidModifierService",
"methods": [
{
"shortName": "MutateCampaignBidModifiers",
- "fullName": "google.ads.googleads.v12.services.CampaignBidModifierService.MutateCampaignBidModifiers",
+ "fullName": "google.ads.googleads.v13.services.CampaignBidModifierService.MutateCampaignBidModifiers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignBidModifiers:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignBidModifiers:mutate"
}
]
}
@@ -5703,16 +5717,16 @@
},
{
"shortName": "CampaignBudgetService",
- "fullName": "google.ads.googleads.v12.services.CampaignBudgetService",
+ "fullName": "google.ads.googleads.v13.services.CampaignBudgetService",
"methods": [
{
"shortName": "MutateCampaignBudgets",
- "fullName": "google.ads.googleads.v12.services.CampaignBudgetService.MutateCampaignBudgets",
+ "fullName": "google.ads.googleads.v13.services.CampaignBudgetService.MutateCampaignBudgets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignBudgets:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignBudgets:mutate"
}
]
}
@@ -5720,16 +5734,16 @@
},
{
"shortName": "CampaignConversionGoalService",
- "fullName": "google.ads.googleads.v12.services.CampaignConversionGoalService",
+ "fullName": "google.ads.googleads.v13.services.CampaignConversionGoalService",
"methods": [
{
"shortName": "MutateCampaignConversionGoals",
- "fullName": "google.ads.googleads.v12.services.CampaignConversionGoalService.MutateCampaignConversionGoals",
+ "fullName": "google.ads.googleads.v13.services.CampaignConversionGoalService.MutateCampaignConversionGoals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignConversionGoals:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignConversionGoals:mutate"
}
]
}
@@ -5737,16 +5751,16 @@
},
{
"shortName": "CampaignCriterionService",
- "fullName": "google.ads.googleads.v12.services.CampaignCriterionService",
+ "fullName": "google.ads.googleads.v13.services.CampaignCriterionService",
"methods": [
{
"shortName": "MutateCampaignCriteria",
- "fullName": "google.ads.googleads.v12.services.CampaignCriterionService.MutateCampaignCriteria",
+ "fullName": "google.ads.googleads.v13.services.CampaignCriterionService.MutateCampaignCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignCriteria:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignCriteria:mutate"
}
]
}
@@ -5754,16 +5768,16 @@
},
{
"shortName": "CampaignCustomizerService",
- "fullName": "google.ads.googleads.v12.services.CampaignCustomizerService",
+ "fullName": "google.ads.googleads.v13.services.CampaignCustomizerService",
"methods": [
{
"shortName": "MutateCampaignCustomizers",
- "fullName": "google.ads.googleads.v12.services.CampaignCustomizerService.MutateCampaignCustomizers",
+ "fullName": "google.ads.googleads.v13.services.CampaignCustomizerService.MutateCampaignCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignCustomizers:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignCustomizers:mutate"
}
]
}
@@ -5771,38 +5785,38 @@
},
{
"shortName": "CampaignDraftService",
- "fullName": "google.ads.googleads.v12.services.CampaignDraftService",
+ "fullName": "google.ads.googleads.v13.services.CampaignDraftService",
"methods": [
{
"shortName": "ListCampaignDraftAsyncErrors",
- "fullName": "google.ads.googleads.v12.services.CampaignDraftService.ListCampaignDraftAsyncErrors",
+ "fullName": "google.ads.googleads.v13.services.CampaignDraftService.ListCampaignDraftAsyncErrors",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v12/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors"
+ "path": "/v13/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors"
}
]
},
{
"shortName": "MutateCampaignDrafts",
- "fullName": "google.ads.googleads.v12.services.CampaignDraftService.MutateCampaignDrafts",
+ "fullName": "google.ads.googleads.v13.services.CampaignDraftService.MutateCampaignDrafts",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignDrafts:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignDrafts:mutate"
}
]
},
{
"shortName": "PromoteCampaignDraft",
- "fullName": "google.ads.googleads.v12.services.CampaignDraftService.PromoteCampaignDraft",
+ "fullName": "google.ads.googleads.v13.services.CampaignDraftService.PromoteCampaignDraft",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{campaign_draft=customers/*/campaignDrafts/*}:promote"
+ "path": "/v13/{campaign_draft=customers/*/campaignDrafts/*}:promote"
}
]
}
@@ -5810,16 +5824,16 @@
},
{
"shortName": "CampaignExtensionSettingService",
- "fullName": "google.ads.googleads.v12.services.CampaignExtensionSettingService",
+ "fullName": "google.ads.googleads.v13.services.CampaignExtensionSettingService",
"methods": [
{
"shortName": "MutateCampaignExtensionSettings",
- "fullName": "google.ads.googleads.v12.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings",
+ "fullName": "google.ads.googleads.v13.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignExtensionSettings:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignExtensionSettings:mutate"
}
]
}
@@ -5827,16 +5841,16 @@
},
{
"shortName": "CampaignFeedService",
- "fullName": "google.ads.googleads.v12.services.CampaignFeedService",
+ "fullName": "google.ads.googleads.v13.services.CampaignFeedService",
"methods": [
{
"shortName": "MutateCampaignFeeds",
- "fullName": "google.ads.googleads.v12.services.CampaignFeedService.MutateCampaignFeeds",
+ "fullName": "google.ads.googleads.v13.services.CampaignFeedService.MutateCampaignFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignFeeds:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignFeeds:mutate"
}
]
}
@@ -5844,16 +5858,16 @@
},
{
"shortName": "CampaignGroupService",
- "fullName": "google.ads.googleads.v12.services.CampaignGroupService",
+ "fullName": "google.ads.googleads.v13.services.CampaignGroupService",
"methods": [
{
"shortName": "MutateCampaignGroups",
- "fullName": "google.ads.googleads.v12.services.CampaignGroupService.MutateCampaignGroups",
+ "fullName": "google.ads.googleads.v13.services.CampaignGroupService.MutateCampaignGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignGroups:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignGroups:mutate"
}
]
}
@@ -5861,16 +5875,16 @@
},
{
"shortName": "CampaignLabelService",
- "fullName": "google.ads.googleads.v12.services.CampaignLabelService",
+ "fullName": "google.ads.googleads.v13.services.CampaignLabelService",
"methods": [
{
"shortName": "MutateCampaignLabels",
- "fullName": "google.ads.googleads.v12.services.CampaignLabelService.MutateCampaignLabels",
+ "fullName": "google.ads.googleads.v13.services.CampaignLabelService.MutateCampaignLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignLabels:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignLabels:mutate"
}
]
}
@@ -5878,16 +5892,16 @@
},
{
"shortName": "CampaignService",
- "fullName": "google.ads.googleads.v12.services.CampaignService",
+ "fullName": "google.ads.googleads.v13.services.CampaignService",
"methods": [
{
"shortName": "MutateCampaigns",
- "fullName": "google.ads.googleads.v12.services.CampaignService.MutateCampaigns",
+ "fullName": "google.ads.googleads.v13.services.CampaignService.MutateCampaigns",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaigns:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaigns:mutate"
}
]
}
@@ -5895,16 +5909,16 @@
},
{
"shortName": "CampaignSharedSetService",
- "fullName": "google.ads.googleads.v12.services.CampaignSharedSetService",
+ "fullName": "google.ads.googleads.v13.services.CampaignSharedSetService",
"methods": [
{
"shortName": "MutateCampaignSharedSets",
- "fullName": "google.ads.googleads.v12.services.CampaignSharedSetService.MutateCampaignSharedSets",
+ "fullName": "google.ads.googleads.v13.services.CampaignSharedSetService.MutateCampaignSharedSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/campaignSharedSets:mutate"
+ "path": "/v13/customers/{customer_id=*}/campaignSharedSets:mutate"
}
]
}
@@ -5912,16 +5926,16 @@
},
{
"shortName": "ConversionActionService",
- "fullName": "google.ads.googleads.v12.services.ConversionActionService",
+ "fullName": "google.ads.googleads.v13.services.ConversionActionService",
"methods": [
{
"shortName": "MutateConversionActions",
- "fullName": "google.ads.googleads.v12.services.ConversionActionService.MutateConversionActions",
+ "fullName": "google.ads.googleads.v13.services.ConversionActionService.MutateConversionActions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/conversionActions:mutate"
+ "path": "/v13/customers/{customer_id=*}/conversionActions:mutate"
}
]
}
@@ -5929,16 +5943,16 @@
},
{
"shortName": "ConversionAdjustmentUploadService",
- "fullName": "google.ads.googleads.v12.services.ConversionAdjustmentUploadService",
+ "fullName": "google.ads.googleads.v13.services.ConversionAdjustmentUploadService",
"methods": [
{
"shortName": "UploadConversionAdjustments",
- "fullName": "google.ads.googleads.v12.services.ConversionAdjustmentUploadService.UploadConversionAdjustments",
+ "fullName": "google.ads.googleads.v13.services.ConversionAdjustmentUploadService.UploadConversionAdjustments",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:uploadConversionAdjustments"
+ "path": "/v13/customers/{customer_id=*}:uploadConversionAdjustments"
}
]
}
@@ -5946,16 +5960,16 @@
},
{
"shortName": "ConversionCustomVariableService",
- "fullName": "google.ads.googleads.v12.services.ConversionCustomVariableService",
+ "fullName": "google.ads.googleads.v13.services.ConversionCustomVariableService",
"methods": [
{
"shortName": "MutateConversionCustomVariables",
- "fullName": "google.ads.googleads.v12.services.ConversionCustomVariableService.MutateConversionCustomVariables",
+ "fullName": "google.ads.googleads.v13.services.ConversionCustomVariableService.MutateConversionCustomVariables",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/conversionCustomVariables:mutate"
+ "path": "/v13/customers/{customer_id=*}/conversionCustomVariables:mutate"
}
]
}
@@ -5963,16 +5977,16 @@
},
{
"shortName": "ConversionGoalCampaignConfigService",
- "fullName": "google.ads.googleads.v12.services.ConversionGoalCampaignConfigService",
+ "fullName": "google.ads.googleads.v13.services.ConversionGoalCampaignConfigService",
"methods": [
{
"shortName": "MutateConversionGoalCampaignConfigs",
- "fullName": "google.ads.googleads.v12.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs",
+ "fullName": "google.ads.googleads.v13.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate"
+ "path": "/v13/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate"
}
]
}
@@ -5980,27 +5994,27 @@
},
{
"shortName": "ConversionUploadService",
- "fullName": "google.ads.googleads.v12.services.ConversionUploadService",
+ "fullName": "google.ads.googleads.v13.services.ConversionUploadService",
"methods": [
{
"shortName": "UploadCallConversions",
- "fullName": "google.ads.googleads.v12.services.ConversionUploadService.UploadCallConversions",
+ "fullName": "google.ads.googleads.v13.services.ConversionUploadService.UploadCallConversions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:uploadCallConversions"
+ "path": "/v13/customers/{customer_id=*}:uploadCallConversions"
}
]
},
{
"shortName": "UploadClickConversions",
- "fullName": "google.ads.googleads.v12.services.ConversionUploadService.UploadClickConversions",
+ "fullName": "google.ads.googleads.v13.services.ConversionUploadService.UploadClickConversions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:uploadClickConversions"
+ "path": "/v13/customers/{customer_id=*}:uploadClickConversions"
}
]
}
@@ -6008,16 +6022,16 @@
},
{
"shortName": "ConversionValueRuleService",
- "fullName": "google.ads.googleads.v12.services.ConversionValueRuleService",
+ "fullName": "google.ads.googleads.v13.services.ConversionValueRuleService",
"methods": [
{
"shortName": "MutateConversionValueRules",
- "fullName": "google.ads.googleads.v12.services.ConversionValueRuleService.MutateConversionValueRules",
+ "fullName": "google.ads.googleads.v13.services.ConversionValueRuleService.MutateConversionValueRules",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/conversionValueRules:mutate"
+ "path": "/v13/customers/{customer_id=*}/conversionValueRules:mutate"
}
]
}
@@ -6025,16 +6039,16 @@
},
{
"shortName": "ConversionValueRuleSetService",
- "fullName": "google.ads.googleads.v12.services.ConversionValueRuleSetService",
+ "fullName": "google.ads.googleads.v13.services.ConversionValueRuleSetService",
"methods": [
{
"shortName": "MutateConversionValueRuleSets",
- "fullName": "google.ads.googleads.v12.services.ConversionValueRuleSetService.MutateConversionValueRuleSets",
+ "fullName": "google.ads.googleads.v13.services.ConversionValueRuleSetService.MutateConversionValueRuleSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/conversionValueRuleSets:mutate"
+ "path": "/v13/customers/{customer_id=*}/conversionValueRuleSets:mutate"
}
]
}
@@ -6042,16 +6056,16 @@
},
{
"shortName": "CustomAudienceService",
- "fullName": "google.ads.googleads.v12.services.CustomAudienceService",
+ "fullName": "google.ads.googleads.v13.services.CustomAudienceService",
"methods": [
{
"shortName": "MutateCustomAudiences",
- "fullName": "google.ads.googleads.v12.services.CustomAudienceService.MutateCustomAudiences",
+ "fullName": "google.ads.googleads.v13.services.CustomAudienceService.MutateCustomAudiences",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customAudiences:mutate"
+ "path": "/v13/customers/{customer_id=*}/customAudiences:mutate"
}
]
}
@@ -6059,16 +6073,16 @@
},
{
"shortName": "CustomConversionGoalService",
- "fullName": "google.ads.googleads.v12.services.CustomConversionGoalService",
+ "fullName": "google.ads.googleads.v13.services.CustomConversionGoalService",
"methods": [
{
"shortName": "MutateCustomConversionGoals",
- "fullName": "google.ads.googleads.v12.services.CustomConversionGoalService.MutateCustomConversionGoals",
+ "fullName": "google.ads.googleads.v13.services.CustomConversionGoalService.MutateCustomConversionGoals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customConversionGoals:mutate"
+ "path": "/v13/customers/{customer_id=*}/customConversionGoals:mutate"
}
]
}
@@ -6076,16 +6090,16 @@
},
{
"shortName": "CustomInterestService",
- "fullName": "google.ads.googleads.v12.services.CustomInterestService",
+ "fullName": "google.ads.googleads.v13.services.CustomInterestService",
"methods": [
{
"shortName": "MutateCustomInterests",
- "fullName": "google.ads.googleads.v12.services.CustomInterestService.MutateCustomInterests",
+ "fullName": "google.ads.googleads.v13.services.CustomInterestService.MutateCustomInterests",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customInterests:mutate"
+ "path": "/v13/customers/{customer_id=*}/customInterests:mutate"
}
]
}
@@ -6093,16 +6107,16 @@
},
{
"shortName": "CustomerAssetService",
- "fullName": "google.ads.googleads.v12.services.CustomerAssetService",
+ "fullName": "google.ads.googleads.v13.services.CustomerAssetService",
"methods": [
{
"shortName": "MutateCustomerAssets",
- "fullName": "google.ads.googleads.v12.services.CustomerAssetService.MutateCustomerAssets",
+ "fullName": "google.ads.googleads.v13.services.CustomerAssetService.MutateCustomerAssets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerAssets:mutate"
+ "path": "/v13/customers/{customer_id=*}/customerAssets:mutate"
}
]
}
@@ -6110,16 +6124,16 @@
},
{
"shortName": "CustomerAssetSetService",
- "fullName": "google.ads.googleads.v12.services.CustomerAssetSetService",
+ "fullName": "google.ads.googleads.v13.services.CustomerAssetSetService",
"methods": [
{
"shortName": "MutateCustomerAssetSets",
- "fullName": "google.ads.googleads.v12.services.CustomerAssetSetService.MutateCustomerAssetSets",
+ "fullName": "google.ads.googleads.v13.services.CustomerAssetSetService.MutateCustomerAssetSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerAssetSets:mutate"
+ "path": "/v13/customers/{customer_id=*}/customerAssetSets:mutate"
}
]
}
@@ -6127,16 +6141,16 @@
},
{
"shortName": "CustomerClientLinkService",
- "fullName": "google.ads.googleads.v12.services.CustomerClientLinkService",
+ "fullName": "google.ads.googleads.v13.services.CustomerClientLinkService",
"methods": [
{
"shortName": "MutateCustomerClientLink",
- "fullName": "google.ads.googleads.v12.services.CustomerClientLinkService.MutateCustomerClientLink",
+ "fullName": "google.ads.googleads.v13.services.CustomerClientLinkService.MutateCustomerClientLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerClientLinks:mutate"
+ "path": "/v13/customers/{customer_id=*}/customerClientLinks:mutate"
}
]
}
@@ -6144,16 +6158,16 @@
},
{
"shortName": "CustomerConversionGoalService",
- "fullName": "google.ads.googleads.v12.services.CustomerConversionGoalService",
+ "fullName": "google.ads.googleads.v13.services.CustomerConversionGoalService",
"methods": [
{
"shortName": "MutateCustomerConversionGoals",
- "fullName": "google.ads.googleads.v12.services.CustomerConversionGoalService.MutateCustomerConversionGoals",
+ "fullName": "google.ads.googleads.v13.services.CustomerConversionGoalService.MutateCustomerConversionGoals",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerConversionGoals:mutate"
+ "path": "/v13/customers/{customer_id=*}/customerConversionGoals:mutate"
}
]
}
@@ -6161,16 +6175,16 @@
},
{
"shortName": "CustomerCustomizerService",
- "fullName": "google.ads.googleads.v12.services.CustomerCustomizerService",
+ "fullName": "google.ads.googleads.v13.services.CustomerCustomizerService",
"methods": [
{
"shortName": "MutateCustomerCustomizers",
- "fullName": "google.ads.googleads.v12.services.CustomerCustomizerService.MutateCustomerCustomizers",
+ "fullName": "google.ads.googleads.v13.services.CustomerCustomizerService.MutateCustomerCustomizers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/CustomerCustomizers:mutate"
+ "path": "/v13/customers/{customer_id=*}/CustomerCustomizers:mutate"
}
]
}
@@ -6178,16 +6192,16 @@
},
{
"shortName": "CustomerExtensionSettingService",
- "fullName": "google.ads.googleads.v12.services.CustomerExtensionSettingService",
+ "fullName": "google.ads.googleads.v13.services.CustomerExtensionSettingService",
"methods": [
{
"shortName": "MutateCustomerExtensionSettings",
- "fullName": "google.ads.googleads.v12.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings",
+ "fullName": "google.ads.googleads.v13.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerExtensionSettings:mutate"
+ "path": "/v13/customers/{customer_id=*}/customerExtensionSettings:mutate"
}
]
}
@@ -6195,16 +6209,16 @@
},
{
"shortName": "CustomerFeedService",
- "fullName": "google.ads.googleads.v12.services.CustomerFeedService",
+ "fullName": "google.ads.googleads.v13.services.CustomerFeedService",
"methods": [
{
"shortName": "MutateCustomerFeeds",
- "fullName": "google.ads.googleads.v12.services.CustomerFeedService.MutateCustomerFeeds",
+ "fullName": "google.ads.googleads.v13.services.CustomerFeedService.MutateCustomerFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerFeeds:mutate"
+ "path": "/v13/customers/{customer_id=*}/customerFeeds:mutate"
}
]
}
@@ -6212,16 +6226,16 @@
},
{
"shortName": "CustomerLabelService",
- "fullName": "google.ads.googleads.v12.services.CustomerLabelService",
+ "fullName": "google.ads.googleads.v13.services.CustomerLabelService",
"methods": [
{
"shortName": "MutateCustomerLabels",
- "fullName": "google.ads.googleads.v12.services.CustomerLabelService.MutateCustomerLabels",
+ "fullName": "google.ads.googleads.v13.services.CustomerLabelService.MutateCustomerLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerLabels:mutate"
+ "path": "/v13/customers/{customer_id=*}/customerLabels:mutate"
}
]
}
@@ -6229,27 +6243,27 @@
},
{
"shortName": "CustomerManagerLinkService",
- "fullName": "google.ads.googleads.v12.services.CustomerManagerLinkService",
+ "fullName": "google.ads.googleads.v13.services.CustomerManagerLinkService",
"methods": [
{
"shortName": "MoveManagerLink",
- "fullName": "google.ads.googleads.v12.services.CustomerManagerLinkService.MoveManagerLink",
+ "fullName": "google.ads.googleads.v13.services.CustomerManagerLinkService.MoveManagerLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerManagerLinks:moveManagerLink"
+ "path": "/v13/customers/{customer_id=*}/customerManagerLinks:moveManagerLink"
}
]
},
{
"shortName": "MutateCustomerManagerLink",
- "fullName": "google.ads.googleads.v12.services.CustomerManagerLinkService.MutateCustomerManagerLink",
+ "fullName": "google.ads.googleads.v13.services.CustomerManagerLinkService.MutateCustomerManagerLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerManagerLinks:mutate"
+ "path": "/v13/customers/{customer_id=*}/customerManagerLinks:mutate"
}
]
}
@@ -6257,16 +6271,16 @@
},
{
"shortName": "CustomerNegativeCriterionService",
- "fullName": "google.ads.googleads.v12.services.CustomerNegativeCriterionService",
+ "fullName": "google.ads.googleads.v13.services.CustomerNegativeCriterionService",
"methods": [
{
"shortName": "MutateCustomerNegativeCriteria",
- "fullName": "google.ads.googleads.v12.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria",
+ "fullName": "google.ads.googleads.v13.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerNegativeCriteria:mutate"
+ "path": "/v13/customers/{customer_id=*}/customerNegativeCriteria:mutate"
}
]
}
@@ -6274,38 +6288,38 @@
},
{
"shortName": "CustomerService",
- "fullName": "google.ads.googleads.v12.services.CustomerService",
+ "fullName": "google.ads.googleads.v13.services.CustomerService",
"methods": [
{
"shortName": "CreateCustomerClient",
- "fullName": "google.ads.googleads.v12.services.CustomerService.CreateCustomerClient",
+ "fullName": "google.ads.googleads.v13.services.CustomerService.CreateCustomerClient",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:createCustomerClient"
+ "path": "/v13/customers/{customer_id=*}:createCustomerClient"
}
]
},
{
"shortName": "ListAccessibleCustomers",
- "fullName": "google.ads.googleads.v12.services.CustomerService.ListAccessibleCustomers",
+ "fullName": "google.ads.googleads.v13.services.CustomerService.ListAccessibleCustomers",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v12/customers:listAccessibleCustomers"
+ "path": "/v13/customers:listAccessibleCustomers"
}
]
},
{
"shortName": "MutateCustomer",
- "fullName": "google.ads.googleads.v12.services.CustomerService.MutateCustomer",
+ "fullName": "google.ads.googleads.v13.services.CustomerService.MutateCustomer",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:mutate"
+ "path": "/v13/customers/{customer_id=*}:mutate"
}
]
}
@@ -6313,16 +6327,16 @@
},
{
"shortName": "CustomerUserAccessInvitationService",
- "fullName": "google.ads.googleads.v12.services.CustomerUserAccessInvitationService",
+ "fullName": "google.ads.googleads.v13.services.CustomerUserAccessInvitationService",
"methods": [
{
"shortName": "MutateCustomerUserAccessInvitation",
- "fullName": "google.ads.googleads.v12.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation",
+ "fullName": "google.ads.googleads.v13.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerUserAccessInvitations:mutate"
+ "path": "/v13/customers/{customer_id=*}/customerUserAccessInvitations:mutate"
}
]
}
@@ -6330,16 +6344,16 @@
},
{
"shortName": "CustomerUserAccessService",
- "fullName": "google.ads.googleads.v12.services.CustomerUserAccessService",
+ "fullName": "google.ads.googleads.v13.services.CustomerUserAccessService",
"methods": [
{
"shortName": "MutateCustomerUserAccess",
- "fullName": "google.ads.googleads.v12.services.CustomerUserAccessService.MutateCustomerUserAccess",
+ "fullName": "google.ads.googleads.v13.services.CustomerUserAccessService.MutateCustomerUserAccess",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customerUserAccesses:mutate"
+ "path": "/v13/customers/{customer_id=*}/customerUserAccesses:mutate"
}
]
}
@@ -6347,16 +6361,16 @@
},
{
"shortName": "CustomizerAttributeService",
- "fullName": "google.ads.googleads.v12.services.CustomizerAttributeService",
+ "fullName": "google.ads.googleads.v13.services.CustomizerAttributeService",
"methods": [
{
"shortName": "MutateCustomizerAttributes",
- "fullName": "google.ads.googleads.v12.services.CustomizerAttributeService.MutateCustomizerAttributes",
+ "fullName": "google.ads.googleads.v13.services.CustomizerAttributeService.MutateCustomizerAttributes",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/customizerAttributes:mutate"
+ "path": "/v13/customers/{customer_id=*}/customizerAttributes:mutate"
}
]
}
@@ -6364,16 +6378,16 @@
},
{
"shortName": "ExperimentArmService",
- "fullName": "google.ads.googleads.v12.services.ExperimentArmService",
+ "fullName": "google.ads.googleads.v13.services.ExperimentArmService",
"methods": [
{
"shortName": "MutateExperimentArms",
- "fullName": "google.ads.googleads.v12.services.ExperimentArmService.MutateExperimentArms",
+ "fullName": "google.ads.googleads.v13.services.ExperimentArmService.MutateExperimentArms",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/experimentArms:mutate"
+ "path": "/v13/customers/{customer_id=*}/experimentArms:mutate"
}
]
}
@@ -6381,71 +6395,71 @@
},
{
"shortName": "ExperimentService",
- "fullName": "google.ads.googleads.v12.services.ExperimentService",
+ "fullName": "google.ads.googleads.v13.services.ExperimentService",
"methods": [
{
"shortName": "EndExperiment",
- "fullName": "google.ads.googleads.v12.services.ExperimentService.EndExperiment",
+ "fullName": "google.ads.googleads.v13.services.ExperimentService.EndExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{experiment=customers/*/experiments/*}:endExperiment"
+ "path": "/v13/{experiment=customers/*/experiments/*}:endExperiment"
}
]
},
{
"shortName": "GraduateExperiment",
- "fullName": "google.ads.googleads.v12.services.ExperimentService.GraduateExperiment",
+ "fullName": "google.ads.googleads.v13.services.ExperimentService.GraduateExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{experiment=customers/*/experiments/*}:graduateExperiment"
+ "path": "/v13/{experiment=customers/*/experiments/*}:graduateExperiment"
}
]
},
{
"shortName": "ListExperimentAsyncErrors",
- "fullName": "google.ads.googleads.v12.services.ExperimentService.ListExperimentAsyncErrors",
+ "fullName": "google.ads.googleads.v13.services.ExperimentService.ListExperimentAsyncErrors",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v12/{resource_name=customers/*/experiments/*}:listExperimentAsyncErrors"
+ "path": "/v13/{resource_name=customers/*/experiments/*}:listExperimentAsyncErrors"
}
]
},
{
"shortName": "MutateExperiments",
- "fullName": "google.ads.googleads.v12.services.ExperimentService.MutateExperiments",
+ "fullName": "google.ads.googleads.v13.services.ExperimentService.MutateExperiments",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/experiments:mutate"
+ "path": "/v13/customers/{customer_id=*}/experiments:mutate"
}
]
},
{
"shortName": "PromoteExperiment",
- "fullName": "google.ads.googleads.v12.services.ExperimentService.PromoteExperiment",
+ "fullName": "google.ads.googleads.v13.services.ExperimentService.PromoteExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{resource_name=customers/*/experiments/*}:promoteExperiment"
+ "path": "/v13/{resource_name=customers/*/experiments/*}:promoteExperiment"
}
]
},
{
"shortName": "ScheduleExperiment",
- "fullName": "google.ads.googleads.v12.services.ExperimentService.ScheduleExperiment",
+ "fullName": "google.ads.googleads.v13.services.ExperimentService.ScheduleExperiment",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{resource_name=customers/*/experiments/*}:scheduleExperiment"
+ "path": "/v13/{resource_name=customers/*/experiments/*}:scheduleExperiment"
}
]
}
@@ -6453,16 +6467,16 @@
},
{
"shortName": "ExtensionFeedItemService",
- "fullName": "google.ads.googleads.v12.services.ExtensionFeedItemService",
+ "fullName": "google.ads.googleads.v13.services.ExtensionFeedItemService",
"methods": [
{
"shortName": "MutateExtensionFeedItems",
- "fullName": "google.ads.googleads.v12.services.ExtensionFeedItemService.MutateExtensionFeedItems",
+ "fullName": "google.ads.googleads.v13.services.ExtensionFeedItemService.MutateExtensionFeedItems",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/extensionFeedItems:mutate"
+ "path": "/v13/customers/{customer_id=*}/extensionFeedItems:mutate"
}
]
}
@@ -6470,16 +6484,16 @@
},
{
"shortName": "FeedItemService",
- "fullName": "google.ads.googleads.v12.services.FeedItemService",
+ "fullName": "google.ads.googleads.v13.services.FeedItemService",
"methods": [
{
"shortName": "MutateFeedItems",
- "fullName": "google.ads.googleads.v12.services.FeedItemService.MutateFeedItems",
+ "fullName": "google.ads.googleads.v13.services.FeedItemService.MutateFeedItems",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/feedItems:mutate"
+ "path": "/v13/customers/{customer_id=*}/feedItems:mutate"
}
]
}
@@ -6487,16 +6501,16 @@
},
{
"shortName": "FeedItemSetLinkService",
- "fullName": "google.ads.googleads.v12.services.FeedItemSetLinkService",
+ "fullName": "google.ads.googleads.v13.services.FeedItemSetLinkService",
"methods": [
{
"shortName": "MutateFeedItemSetLinks",
- "fullName": "google.ads.googleads.v12.services.FeedItemSetLinkService.MutateFeedItemSetLinks",
+ "fullName": "google.ads.googleads.v13.services.FeedItemSetLinkService.MutateFeedItemSetLinks",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/feedItemSetLinks:mutate"
+ "path": "/v13/customers/{customer_id=*}/feedItemSetLinks:mutate"
}
]
}
@@ -6504,16 +6518,16 @@
},
{
"shortName": "FeedItemSetService",
- "fullName": "google.ads.googleads.v12.services.FeedItemSetService",
+ "fullName": "google.ads.googleads.v13.services.FeedItemSetService",
"methods": [
{
"shortName": "MutateFeedItemSets",
- "fullName": "google.ads.googleads.v12.services.FeedItemSetService.MutateFeedItemSets",
+ "fullName": "google.ads.googleads.v13.services.FeedItemSetService.MutateFeedItemSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/feedItemSets:mutate"
+ "path": "/v13/customers/{customer_id=*}/feedItemSets:mutate"
}
]
}
@@ -6521,16 +6535,16 @@
},
{
"shortName": "FeedItemTargetService",
- "fullName": "google.ads.googleads.v12.services.FeedItemTargetService",
+ "fullName": "google.ads.googleads.v13.services.FeedItemTargetService",
"methods": [
{
"shortName": "MutateFeedItemTargets",
- "fullName": "google.ads.googleads.v12.services.FeedItemTargetService.MutateFeedItemTargets",
+ "fullName": "google.ads.googleads.v13.services.FeedItemTargetService.MutateFeedItemTargets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/feedItemTargets:mutate"
+ "path": "/v13/customers/{customer_id=*}/feedItemTargets:mutate"
}
]
}
@@ -6538,16 +6552,16 @@
},
{
"shortName": "FeedMappingService",
- "fullName": "google.ads.googleads.v12.services.FeedMappingService",
+ "fullName": "google.ads.googleads.v13.services.FeedMappingService",
"methods": [
{
"shortName": "MutateFeedMappings",
- "fullName": "google.ads.googleads.v12.services.FeedMappingService.MutateFeedMappings",
+ "fullName": "google.ads.googleads.v13.services.FeedMappingService.MutateFeedMappings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/feedMappings:mutate"
+ "path": "/v13/customers/{customer_id=*}/feedMappings:mutate"
}
]
}
@@ -6555,16 +6569,16 @@
},
{
"shortName": "FeedService",
- "fullName": "google.ads.googleads.v12.services.FeedService",
+ "fullName": "google.ads.googleads.v13.services.FeedService",
"methods": [
{
"shortName": "MutateFeeds",
- "fullName": "google.ads.googleads.v12.services.FeedService.MutateFeeds",
+ "fullName": "google.ads.googleads.v13.services.FeedService.MutateFeeds",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/feeds:mutate"
+ "path": "/v13/customers/{customer_id=*}/feeds:mutate"
}
]
}
@@ -6572,16 +6586,16 @@
},
{
"shortName": "GeoTargetConstantService",
- "fullName": "google.ads.googleads.v12.services.GeoTargetConstantService",
+ "fullName": "google.ads.googleads.v13.services.GeoTargetConstantService",
"methods": [
{
"shortName": "SuggestGeoTargetConstants",
- "fullName": "google.ads.googleads.v12.services.GeoTargetConstantService.SuggestGeoTargetConstants",
+ "fullName": "google.ads.googleads.v13.services.GeoTargetConstantService.SuggestGeoTargetConstants",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/geoTargetConstants:suggest"
+ "path": "/v13/geoTargetConstants:suggest"
}
]
}
@@ -6589,27 +6603,27 @@
},
{
"shortName": "GoogleAdsFieldService",
- "fullName": "google.ads.googleads.v12.services.GoogleAdsFieldService",
+ "fullName": "google.ads.googleads.v13.services.GoogleAdsFieldService",
"methods": [
{
"shortName": "GetGoogleAdsField",
- "fullName": "google.ads.googleads.v12.services.GoogleAdsFieldService.GetGoogleAdsField",
+ "fullName": "google.ads.googleads.v13.services.GoogleAdsFieldService.GetGoogleAdsField",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v12/{resource_name=googleAdsFields/*}"
+ "path": "/v13/{resource_name=googleAdsFields/*}"
}
]
},
{
"shortName": "SearchGoogleAdsFields",
- "fullName": "google.ads.googleads.v12.services.GoogleAdsFieldService.SearchGoogleAdsFields",
+ "fullName": "google.ads.googleads.v13.services.GoogleAdsFieldService.SearchGoogleAdsFields",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/googleAdsFields:search"
+ "path": "/v13/googleAdsFields:search"
}
]
}
@@ -6617,38 +6631,38 @@
},
{
"shortName": "GoogleAdsService",
- "fullName": "google.ads.googleads.v12.services.GoogleAdsService",
+ "fullName": "google.ads.googleads.v13.services.GoogleAdsService",
"methods": [
{
"shortName": "Mutate",
- "fullName": "google.ads.googleads.v12.services.GoogleAdsService.Mutate",
+ "fullName": "google.ads.googleads.v13.services.GoogleAdsService.Mutate",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/googleAds:mutate"
+ "path": "/v13/customers/{customer_id=*}/googleAds:mutate"
}
]
},
{
"shortName": "Search",
- "fullName": "google.ads.googleads.v12.services.GoogleAdsService.Search",
+ "fullName": "google.ads.googleads.v13.services.GoogleAdsService.Search",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/googleAds:search"
+ "path": "/v13/customers/{customer_id=*}/googleAds:search"
}
]
},
{
"shortName": "SearchStream",
- "fullName": "google.ads.googleads.v12.services.GoogleAdsService.SearchStream",
+ "fullName": "google.ads.googleads.v13.services.GoogleAdsService.SearchStream",
"mode": "SERVER_STREAMING",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/googleAds:searchStream"
+ "path": "/v13/customers/{customer_id=*}/googleAds:searchStream"
}
]
}
@@ -6656,16 +6670,16 @@
},
{
"shortName": "InvoiceService",
- "fullName": "google.ads.googleads.v12.services.InvoiceService",
+ "fullName": "google.ads.googleads.v13.services.InvoiceService",
"methods": [
{
"shortName": "ListInvoices",
- "fullName": "google.ads.googleads.v12.services.InvoiceService.ListInvoices",
+ "fullName": "google.ads.googleads.v13.services.InvoiceService.ListInvoices",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v12/customers/{customer_id=*}/invoices"
+ "path": "/v13/customers/{customer_id=*}/invoices"
}
]
}
@@ -6673,16 +6687,16 @@
},
{
"shortName": "KeywordPlanAdGroupKeywordService",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanAdGroupKeywordService",
"methods": [
{
"shortName": "MutateKeywordPlanAdGroupKeywords",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate"
+ "path": "/v13/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate"
}
]
}
@@ -6690,16 +6704,16 @@
},
{
"shortName": "KeywordPlanAdGroupService",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupService",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanAdGroupService",
"methods": [
{
"shortName": "MutateKeywordPlanAdGroups",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/keywordPlanAdGroups:mutate"
+ "path": "/v13/customers/{customer_id=*}/keywordPlanAdGroups:mutate"
}
]
}
@@ -6707,16 +6721,16 @@
},
{
"shortName": "KeywordPlanCampaignKeywordService",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanCampaignKeywordService",
"methods": [
{
"shortName": "MutateKeywordPlanCampaignKeywords",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate"
+ "path": "/v13/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate"
}
]
}
@@ -6724,16 +6738,16 @@
},
{
"shortName": "KeywordPlanCampaignService",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignService",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanCampaignService",
"methods": [
{
"shortName": "MutateKeywordPlanCampaigns",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/keywordPlanCampaigns:mutate"
+ "path": "/v13/customers/{customer_id=*}/keywordPlanCampaigns:mutate"
}
]
}
@@ -6741,38 +6755,38 @@
},
{
"shortName": "KeywordPlanIdeaService",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanIdeaService",
"methods": [
{
"shortName": "GenerateAdGroupThemes",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService.GenerateAdGroupThemes",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanIdeaService.GenerateAdGroupThemes",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:generateAdGroupThemes"
+ "path": "/v13/customers/{customer_id=*}:generateAdGroupThemes"
}
]
},
{
"shortName": "GenerateKeywordHistoricalMetrics",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:generateKeywordHistoricalMetrics"
+ "path": "/v13/customers/{customer_id=*}:generateKeywordHistoricalMetrics"
}
]
},
{
"shortName": "GenerateKeywordIdeas",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanIdeaService.GenerateKeywordIdeas",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanIdeaService.GenerateKeywordIdeas",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:generateKeywordIdeas"
+ "path": "/v13/customers/{customer_id=*}:generateKeywordIdeas"
}
]
}
@@ -6780,60 +6794,60 @@
},
{
"shortName": "KeywordPlanService",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanService",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanService",
"methods": [
{
"shortName": "GenerateForecastCurve",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastCurve",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanService.GenerateForecastCurve",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve"
+ "path": "/v13/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve"
}
]
},
{
"shortName": "GenerateForecastMetrics",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastMetrics",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanService.GenerateForecastMetrics",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics"
+ "path": "/v13/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics"
}
]
},
{
"shortName": "GenerateForecastTimeSeries",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateForecastTimeSeries",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanService.GenerateForecastTimeSeries",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries"
+ "path": "/v13/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries"
}
]
},
{
"shortName": "GenerateHistoricalMetrics",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanService.GenerateHistoricalMetrics",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanService.GenerateHistoricalMetrics",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics"
+ "path": "/v13/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics"
}
]
},
{
"shortName": "MutateKeywordPlans",
- "fullName": "google.ads.googleads.v12.services.KeywordPlanService.MutateKeywordPlans",
+ "fullName": "google.ads.googleads.v13.services.KeywordPlanService.MutateKeywordPlans",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/keywordPlans:mutate"
+ "path": "/v13/customers/{customer_id=*}/keywordPlans:mutate"
}
]
}
@@ -6841,16 +6855,16 @@
},
{
"shortName": "KeywordThemeConstantService",
- "fullName": "google.ads.googleads.v12.services.KeywordThemeConstantService",
+ "fullName": "google.ads.googleads.v13.services.KeywordThemeConstantService",
"methods": [
{
"shortName": "SuggestKeywordThemeConstants",
- "fullName": "google.ads.googleads.v12.services.KeywordThemeConstantService.SuggestKeywordThemeConstants",
+ "fullName": "google.ads.googleads.v13.services.KeywordThemeConstantService.SuggestKeywordThemeConstants",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/keywordThemeConstants:suggest"
+ "path": "/v13/keywordThemeConstants:suggest"
}
]
}
@@ -6858,16 +6872,16 @@
},
{
"shortName": "LabelService",
- "fullName": "google.ads.googleads.v12.services.LabelService",
+ "fullName": "google.ads.googleads.v13.services.LabelService",
"methods": [
{
"shortName": "MutateLabels",
- "fullName": "google.ads.googleads.v12.services.LabelService.MutateLabels",
+ "fullName": "google.ads.googleads.v13.services.LabelService.MutateLabels",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/labels:mutate"
+ "path": "/v13/customers/{customer_id=*}/labels:mutate"
}
]
}
@@ -6875,16 +6889,16 @@
},
{
"shortName": "MediaFileService",
- "fullName": "google.ads.googleads.v12.services.MediaFileService",
+ "fullName": "google.ads.googleads.v13.services.MediaFileService",
"methods": [
{
"shortName": "MutateMediaFiles",
- "fullName": "google.ads.googleads.v12.services.MediaFileService.MutateMediaFiles",
+ "fullName": "google.ads.googleads.v13.services.MediaFileService.MutateMediaFiles",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/mediaFiles:mutate"
+ "path": "/v13/customers/{customer_id=*}/mediaFiles:mutate"
}
]
}
@@ -6892,38 +6906,38 @@
},
{
"shortName": "MerchantCenterLinkService",
- "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService",
+ "fullName": "google.ads.googleads.v13.services.MerchantCenterLinkService",
"methods": [
{
"shortName": "GetMerchantCenterLink",
- "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService.GetMerchantCenterLink",
+ "fullName": "google.ads.googleads.v13.services.MerchantCenterLinkService.GetMerchantCenterLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v12/{resource_name=customers/*/merchantCenterLinks/*}"
+ "path": "/v13/{resource_name=customers/*/merchantCenterLinks/*}"
}
]
},
{
"shortName": "ListMerchantCenterLinks",
- "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService.ListMerchantCenterLinks",
+ "fullName": "google.ads.googleads.v13.services.MerchantCenterLinkService.ListMerchantCenterLinks",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v12/customers/{customer_id=*}/merchantCenterLinks"
+ "path": "/v13/customers/{customer_id=*}/merchantCenterLinks"
}
]
},
{
"shortName": "MutateMerchantCenterLink",
- "fullName": "google.ads.googleads.v12.services.MerchantCenterLinkService.MutateMerchantCenterLink",
+ "fullName": "google.ads.googleads.v13.services.MerchantCenterLinkService.MutateMerchantCenterLink",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/merchantCenterLinks:mutate"
+ "path": "/v13/customers/{customer_id=*}/merchantCenterLinks:mutate"
}
]
}
@@ -6931,38 +6945,38 @@
},
{
"shortName": "OfflineUserDataJobService",
- "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService",
+ "fullName": "google.ads.googleads.v13.services.OfflineUserDataJobService",
"methods": [
{
"shortName": "AddOfflineUserDataJobOperations",
- "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations",
+ "fullName": "google.ads.googleads.v13.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations"
+ "path": "/v13/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations"
}
]
},
{
"shortName": "CreateOfflineUserDataJob",
- "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService.CreateOfflineUserDataJob",
+ "fullName": "google.ads.googleads.v13.services.OfflineUserDataJobService.CreateOfflineUserDataJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/offlineUserDataJobs:create"
+ "path": "/v13/customers/{customer_id=*}/offlineUserDataJobs:create"
}
]
},
{
"shortName": "RunOfflineUserDataJob",
- "fullName": "google.ads.googleads.v12.services.OfflineUserDataJobService.RunOfflineUserDataJob",
+ "fullName": "google.ads.googleads.v13.services.OfflineUserDataJobService.RunOfflineUserDataJob",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{resource_name=customers/*/offlineUserDataJobs/*}:run"
+ "path": "/v13/{resource_name=customers/*/offlineUserDataJobs/*}:run"
}
]
}
@@ -6970,16 +6984,44 @@
},
{
"shortName": "PaymentsAccountService",
- "fullName": "google.ads.googleads.v12.services.PaymentsAccountService",
+ "fullName": "google.ads.googleads.v13.services.PaymentsAccountService",
"methods": [
{
"shortName": "ListPaymentsAccounts",
- "fullName": "google.ads.googleads.v12.services.PaymentsAccountService.ListPaymentsAccounts",
+ "fullName": "google.ads.googleads.v13.services.PaymentsAccountService.ListPaymentsAccounts",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v12/customers/{customer_id=*}/paymentsAccounts"
+ "path": "/v13/customers/{customer_id=*}/paymentsAccounts"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "shortName": "ProductLinkService",
+ "fullName": "google.ads.googleads.v13.services.ProductLinkService",
+ "methods": [
+ {
+ "shortName": "CreateProductLink",
+ "fullName": "google.ads.googleads.v13.services.ProductLinkService.CreateProductLink",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v13/customers/{customer_id=*}/productLinks:create"
+ }
+ ]
+ },
+ {
+ "shortName": "RemoveProductLink",
+ "fullName": "google.ads.googleads.v13.services.ProductLinkService.RemoveProductLink",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v13/customers/{customer_id=*}/productLinks:remove"
}
]
}
@@ -6987,38 +7029,38 @@
},
{
"shortName": "ReachPlanService",
- "fullName": "google.ads.googleads.v12.services.ReachPlanService",
+ "fullName": "google.ads.googleads.v13.services.ReachPlanService",
"methods": [
{
"shortName": "GenerateReachForecast",
- "fullName": "google.ads.googleads.v12.services.ReachPlanService.GenerateReachForecast",
+ "fullName": "google.ads.googleads.v13.services.ReachPlanService.GenerateReachForecast",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:generateReachForecast"
+ "path": "/v13/customers/{customer_id=*}:generateReachForecast"
}
]
},
{
"shortName": "ListPlannableLocations",
- "fullName": "google.ads.googleads.v12.services.ReachPlanService.ListPlannableLocations",
+ "fullName": "google.ads.googleads.v13.services.ReachPlanService.ListPlannableLocations",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12:listPlannableLocations"
+ "path": "/v13:listPlannableLocations"
}
]
},
{
"shortName": "ListPlannableProducts",
- "fullName": "google.ads.googleads.v12.services.ReachPlanService.ListPlannableProducts",
+ "fullName": "google.ads.googleads.v13.services.ReachPlanService.ListPlannableProducts",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12:listPlannableProducts"
+ "path": "/v13:listPlannableProducts"
}
]
}
@@ -7026,27 +7068,27 @@
},
{
"shortName": "RecommendationService",
- "fullName": "google.ads.googleads.v12.services.RecommendationService",
+ "fullName": "google.ads.googleads.v13.services.RecommendationService",
"methods": [
{
"shortName": "ApplyRecommendation",
- "fullName": "google.ads.googleads.v12.services.RecommendationService.ApplyRecommendation",
+ "fullName": "google.ads.googleads.v13.services.RecommendationService.ApplyRecommendation",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/recommendations:apply"
+ "path": "/v13/customers/{customer_id=*}/recommendations:apply"
}
]
},
{
"shortName": "DismissRecommendation",
- "fullName": "google.ads.googleads.v12.services.RecommendationService.DismissRecommendation",
+ "fullName": "google.ads.googleads.v13.services.RecommendationService.DismissRecommendation",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/recommendations:dismiss"
+ "path": "/v13/customers/{customer_id=*}/recommendations:dismiss"
}
]
}
@@ -7054,16 +7096,16 @@
},
{
"shortName": "RemarketingActionService",
- "fullName": "google.ads.googleads.v12.services.RemarketingActionService",
+ "fullName": "google.ads.googleads.v13.services.RemarketingActionService",
"methods": [
{
"shortName": "MutateRemarketingActions",
- "fullName": "google.ads.googleads.v12.services.RemarketingActionService.MutateRemarketingActions",
+ "fullName": "google.ads.googleads.v13.services.RemarketingActionService.MutateRemarketingActions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/remarketingActions:mutate"
+ "path": "/v13/customers/{customer_id=*}/remarketingActions:mutate"
}
]
}
@@ -7071,16 +7113,16 @@
},
{
"shortName": "SharedCriterionService",
- "fullName": "google.ads.googleads.v12.services.SharedCriterionService",
+ "fullName": "google.ads.googleads.v13.services.SharedCriterionService",
"methods": [
{
"shortName": "MutateSharedCriteria",
- "fullName": "google.ads.googleads.v12.services.SharedCriterionService.MutateSharedCriteria",
+ "fullName": "google.ads.googleads.v13.services.SharedCriterionService.MutateSharedCriteria",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/sharedCriteria:mutate"
+ "path": "/v13/customers/{customer_id=*}/sharedCriteria:mutate"
}
]
}
@@ -7088,16 +7130,16 @@
},
{
"shortName": "SharedSetService",
- "fullName": "google.ads.googleads.v12.services.SharedSetService",
+ "fullName": "google.ads.googleads.v13.services.SharedSetService",
"methods": [
{
"shortName": "MutateSharedSets",
- "fullName": "google.ads.googleads.v12.services.SharedSetService.MutateSharedSets",
+ "fullName": "google.ads.googleads.v13.services.SharedSetService.MutateSharedSets",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/sharedSets:mutate"
+ "path": "/v13/customers/{customer_id=*}/sharedSets:mutate"
}
]
}
@@ -7105,16 +7147,27 @@
},
{
"shortName": "SmartCampaignSettingService",
- "fullName": "google.ads.googleads.v12.services.SmartCampaignSettingService",
+ "fullName": "google.ads.googleads.v13.services.SmartCampaignSettingService",
"methods": [
+ {
+ "shortName": "GetSmartCampaignStatus",
+ "fullName": "google.ads.googleads.v13.services.SmartCampaignSettingService.GetSmartCampaignStatus",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v13/{resource_name=customers/*/smartCampaignSettings/*}:getSmartCampaignStatus"
+ }
+ ]
+ },
{
"shortName": "MutateSmartCampaignSettings",
- "fullName": "google.ads.googleads.v12.services.SmartCampaignSettingService.MutateSmartCampaignSettings",
+ "fullName": "google.ads.googleads.v13.services.SmartCampaignSettingService.MutateSmartCampaignSettings",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/smartCampaignSettings:mutate"
+ "path": "/v13/customers/{customer_id=*}/smartCampaignSettings:mutate"
}
]
}
@@ -7122,38 +7175,38 @@
},
{
"shortName": "SmartCampaignSuggestService",
- "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService",
+ "fullName": "google.ads.googleads.v13.services.SmartCampaignSuggestService",
"methods": [
{
"shortName": "SuggestKeywordThemes",
- "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService.SuggestKeywordThemes",
+ "fullName": "google.ads.googleads.v13.services.SmartCampaignSuggestService.SuggestKeywordThemes",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:suggestKeywordThemes"
+ "path": "/v13/customers/{customer_id=*}:suggestKeywordThemes"
}
]
},
{
"shortName": "SuggestSmartCampaignAd",
- "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService.SuggestSmartCampaignAd",
+ "fullName": "google.ads.googleads.v13.services.SmartCampaignSuggestService.SuggestSmartCampaignAd",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:suggestSmartCampaignAd"
+ "path": "/v13/customers/{customer_id=*}:suggestSmartCampaignAd"
}
]
},
{
"shortName": "SuggestSmartCampaignBudgetOptions",
- "fullName": "google.ads.googleads.v12.services.SmartCampaignSuggestService.SuggestSmartCampaignBudgetOptions",
+ "fullName": "google.ads.googleads.v13.services.SmartCampaignSuggestService.SuggestSmartCampaignBudgetOptions",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions"
+ "path": "/v13/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions"
}
]
}
@@ -7161,16 +7214,33 @@
},
{
"shortName": "ThirdPartyAppAnalyticsLinkService",
- "fullName": "google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService",
+ "fullName": "google.ads.googleads.v13.services.ThirdPartyAppAnalyticsLinkService",
"methods": [
{
"shortName": "RegenerateShareableLinkId",
- "fullName": "google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId",
+ "fullName": "google.ads.googleads.v13.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId"
+ "path": "/v13/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "shortName": "TravelAssetSuggestionService",
+ "fullName": "google.ads.googleads.v13.services.TravelAssetSuggestionService",
+ "methods": [
+ {
+ "shortName": "SuggestTravelAssets",
+ "fullName": "google.ads.googleads.v13.services.TravelAssetSuggestionService.SuggestTravelAssets",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v13/customers/{customer_id=*}:suggestTravelAssets"
}
]
}
@@ -7178,16 +7248,16 @@
},
{
"shortName": "UserDataService",
- "fullName": "google.ads.googleads.v12.services.UserDataService",
+ "fullName": "google.ads.googleads.v13.services.UserDataService",
"methods": [
{
"shortName": "UploadUserData",
- "fullName": "google.ads.googleads.v12.services.UserDataService.UploadUserData",
+ "fullName": "google.ads.googleads.v13.services.UserDataService.UploadUserData",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}:uploadUserData"
+ "path": "/v13/customers/{customer_id=*}:uploadUserData"
}
]
}
@@ -7195,128 +7265,130 @@
},
{
"shortName": "UserListService",
- "fullName": "google.ads.googleads.v12.services.UserListService",
+ "fullName": "google.ads.googleads.v13.services.UserListService",
"methods": [
{
"shortName": "MutateUserLists",
- "fullName": "google.ads.googleads.v12.services.UserListService.MutateUserLists",
+ "fullName": "google.ads.googleads.v13.services.UserListService.MutateUserLists",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v12/customers/{customer_id=*}/userLists:mutate"
+ "path": "/v13/customers/{customer_id=*}/userLists:mutate"
}
]
}
]
}
],
- "configFile": "googleads_v12.yaml",
+ "configFile": "googleads_v13.yaml",
"serviceConfigApiNames": [
- "google.ads.googleads.v12.services.AccountBudgetProposalService",
- "google.ads.googleads.v12.services.AccountLinkService",
- "google.ads.googleads.v12.services.AdGroupAdLabelService",
- "google.ads.googleads.v12.services.AdGroupAdService",
- "google.ads.googleads.v12.services.AdGroupAssetService",
- "google.ads.googleads.v12.services.AdGroupAssetSetService",
- "google.ads.googleads.v12.services.AdGroupBidModifierService",
- "google.ads.googleads.v12.services.AdGroupCriterionCustomizerService",
- "google.ads.googleads.v12.services.AdGroupCriterionLabelService",
- "google.ads.googleads.v12.services.AdGroupCriterionService",
- "google.ads.googleads.v12.services.AdGroupCustomizerService",
- "google.ads.googleads.v12.services.AdGroupExtensionSettingService",
- "google.ads.googleads.v12.services.AdGroupFeedService",
- "google.ads.googleads.v12.services.AdGroupLabelService",
- "google.ads.googleads.v12.services.AdGroupService",
- "google.ads.googleads.v12.services.AdParameterService",
- "google.ads.googleads.v12.services.AdService",
- "google.ads.googleads.v12.services.AssetGroupAssetService",
- "google.ads.googleads.v12.services.AssetGroupListingGroupFilterService",
- "google.ads.googleads.v12.services.AssetGroupService",
- "google.ads.googleads.v12.services.AssetGroupSignalService",
- "google.ads.googleads.v12.services.AssetService",
- "google.ads.googleads.v12.services.AssetSetAssetService",
- "google.ads.googleads.v12.services.AssetSetService",
- "google.ads.googleads.v12.services.AudienceInsightsService",
- "google.ads.googleads.v12.services.AudienceService",
- "google.ads.googleads.v12.services.BatchJobService",
- "google.ads.googleads.v12.services.BiddingDataExclusionService",
- "google.ads.googleads.v12.services.BiddingSeasonalityAdjustmentService",
- "google.ads.googleads.v12.services.BiddingStrategyService",
- "google.ads.googleads.v12.services.BillingSetupService",
- "google.ads.googleads.v12.services.CampaignAssetService",
- "google.ads.googleads.v12.services.CampaignAssetSetService",
- "google.ads.googleads.v12.services.CampaignBidModifierService",
- "google.ads.googleads.v12.services.CampaignBudgetService",
- "google.ads.googleads.v12.services.CampaignConversionGoalService",
- "google.ads.googleads.v12.services.CampaignCriterionService",
- "google.ads.googleads.v12.services.CampaignCustomizerService",
- "google.ads.googleads.v12.services.CampaignDraftService",
- "google.ads.googleads.v12.services.CampaignExtensionSettingService",
- "google.ads.googleads.v12.services.CampaignFeedService",
- "google.ads.googleads.v12.services.CampaignGroupService",
- "google.ads.googleads.v12.services.CampaignLabelService",
- "google.ads.googleads.v12.services.CampaignService",
- "google.ads.googleads.v12.services.CampaignSharedSetService",
- "google.ads.googleads.v12.services.ConversionActionService",
- "google.ads.googleads.v12.services.ConversionAdjustmentUploadService",
- "google.ads.googleads.v12.services.ConversionCustomVariableService",
- "google.ads.googleads.v12.services.ConversionGoalCampaignConfigService",
- "google.ads.googleads.v12.services.ConversionUploadService",
- "google.ads.googleads.v12.services.ConversionValueRuleService",
- "google.ads.googleads.v12.services.ConversionValueRuleSetService",
- "google.ads.googleads.v12.services.CustomAudienceService",
- "google.ads.googleads.v12.services.CustomConversionGoalService",
- "google.ads.googleads.v12.services.CustomInterestService",
- "google.ads.googleads.v12.services.CustomerAssetService",
- "google.ads.googleads.v12.services.CustomerAssetSetService",
- "google.ads.googleads.v12.services.CustomerClientLinkService",
- "google.ads.googleads.v12.services.CustomerConversionGoalService",
- "google.ads.googleads.v12.services.CustomerCustomizerService",
- "google.ads.googleads.v12.services.CustomerExtensionSettingService",
- "google.ads.googleads.v12.services.CustomerFeedService",
- "google.ads.googleads.v12.services.CustomerLabelService",
- "google.ads.googleads.v12.services.CustomerManagerLinkService",
- "google.ads.googleads.v12.services.CustomerNegativeCriterionService",
- "google.ads.googleads.v12.services.CustomerService",
- "google.ads.googleads.v12.services.CustomerUserAccessInvitationService",
- "google.ads.googleads.v12.services.CustomerUserAccessService",
- "google.ads.googleads.v12.services.CustomizerAttributeService",
- "google.ads.googleads.v12.services.ExperimentArmService",
- "google.ads.googleads.v12.services.ExperimentService",
- "google.ads.googleads.v12.services.ExtensionFeedItemService",
- "google.ads.googleads.v12.services.FeedItemService",
- "google.ads.googleads.v12.services.FeedItemSetLinkService",
- "google.ads.googleads.v12.services.FeedItemSetService",
- "google.ads.googleads.v12.services.FeedItemTargetService",
- "google.ads.googleads.v12.services.FeedMappingService",
- "google.ads.googleads.v12.services.FeedService",
- "google.ads.googleads.v12.services.GeoTargetConstantService",
- "google.ads.googleads.v12.services.GoogleAdsFieldService",
- "google.ads.googleads.v12.services.GoogleAdsService",
- "google.ads.googleads.v12.services.InvoiceService",
- "google.ads.googleads.v12.services.KeywordPlanAdGroupKeywordService",
- "google.ads.googleads.v12.services.KeywordPlanAdGroupService",
- "google.ads.googleads.v12.services.KeywordPlanCampaignKeywordService",
- "google.ads.googleads.v12.services.KeywordPlanCampaignService",
- "google.ads.googleads.v12.services.KeywordPlanIdeaService",
- "google.ads.googleads.v12.services.KeywordPlanService",
- "google.ads.googleads.v12.services.KeywordThemeConstantService",
- "google.ads.googleads.v12.services.LabelService",
- "google.ads.googleads.v12.services.MediaFileService",
- "google.ads.googleads.v12.services.MerchantCenterLinkService",
- "google.ads.googleads.v12.services.OfflineUserDataJobService",
- "google.ads.googleads.v12.services.PaymentsAccountService",
- "google.ads.googleads.v12.services.ReachPlanService",
- "google.ads.googleads.v12.services.RecommendationService",
- "google.ads.googleads.v12.services.RemarketingActionService",
- "google.ads.googleads.v12.services.SharedCriterionService",
- "google.ads.googleads.v12.services.SharedSetService",
- "google.ads.googleads.v12.services.SmartCampaignSettingService",
- "google.ads.googleads.v12.services.SmartCampaignSuggestService",
- "google.ads.googleads.v12.services.ThirdPartyAppAnalyticsLinkService",
- "google.ads.googleads.v12.services.UserDataService",
- "google.ads.googleads.v12.services.UserListService"
+ "google.ads.googleads.v13.services.AccountBudgetProposalService",
+ "google.ads.googleads.v13.services.AccountLinkService",
+ "google.ads.googleads.v13.services.AdGroupAdLabelService",
+ "google.ads.googleads.v13.services.AdGroupAdService",
+ "google.ads.googleads.v13.services.AdGroupAssetService",
+ "google.ads.googleads.v13.services.AdGroupAssetSetService",
+ "google.ads.googleads.v13.services.AdGroupBidModifierService",
+ "google.ads.googleads.v13.services.AdGroupCriterionCustomizerService",
+ "google.ads.googleads.v13.services.AdGroupCriterionLabelService",
+ "google.ads.googleads.v13.services.AdGroupCriterionService",
+ "google.ads.googleads.v13.services.AdGroupCustomizerService",
+ "google.ads.googleads.v13.services.AdGroupExtensionSettingService",
+ "google.ads.googleads.v13.services.AdGroupFeedService",
+ "google.ads.googleads.v13.services.AdGroupLabelService",
+ "google.ads.googleads.v13.services.AdGroupService",
+ "google.ads.googleads.v13.services.AdParameterService",
+ "google.ads.googleads.v13.services.AdService",
+ "google.ads.googleads.v13.services.AssetGroupAssetService",
+ "google.ads.googleads.v13.services.AssetGroupListingGroupFilterService",
+ "google.ads.googleads.v13.services.AssetGroupService",
+ "google.ads.googleads.v13.services.AssetGroupSignalService",
+ "google.ads.googleads.v13.services.AssetService",
+ "google.ads.googleads.v13.services.AssetSetAssetService",
+ "google.ads.googleads.v13.services.AssetSetService",
+ "google.ads.googleads.v13.services.AudienceInsightsService",
+ "google.ads.googleads.v13.services.AudienceService",
+ "google.ads.googleads.v13.services.BatchJobService",
+ "google.ads.googleads.v13.services.BiddingDataExclusionService",
+ "google.ads.googleads.v13.services.BiddingSeasonalityAdjustmentService",
+ "google.ads.googleads.v13.services.BiddingStrategyService",
+ "google.ads.googleads.v13.services.BillingSetupService",
+ "google.ads.googleads.v13.services.CampaignAssetService",
+ "google.ads.googleads.v13.services.CampaignAssetSetService",
+ "google.ads.googleads.v13.services.CampaignBidModifierService",
+ "google.ads.googleads.v13.services.CampaignBudgetService",
+ "google.ads.googleads.v13.services.CampaignConversionGoalService",
+ "google.ads.googleads.v13.services.CampaignCriterionService",
+ "google.ads.googleads.v13.services.CampaignCustomizerService",
+ "google.ads.googleads.v13.services.CampaignDraftService",
+ "google.ads.googleads.v13.services.CampaignExtensionSettingService",
+ "google.ads.googleads.v13.services.CampaignFeedService",
+ "google.ads.googleads.v13.services.CampaignGroupService",
+ "google.ads.googleads.v13.services.CampaignLabelService",
+ "google.ads.googleads.v13.services.CampaignService",
+ "google.ads.googleads.v13.services.CampaignSharedSetService",
+ "google.ads.googleads.v13.services.ConversionActionService",
+ "google.ads.googleads.v13.services.ConversionAdjustmentUploadService",
+ "google.ads.googleads.v13.services.ConversionCustomVariableService",
+ "google.ads.googleads.v13.services.ConversionGoalCampaignConfigService",
+ "google.ads.googleads.v13.services.ConversionUploadService",
+ "google.ads.googleads.v13.services.ConversionValueRuleService",
+ "google.ads.googleads.v13.services.ConversionValueRuleSetService",
+ "google.ads.googleads.v13.services.CustomAudienceService",
+ "google.ads.googleads.v13.services.CustomConversionGoalService",
+ "google.ads.googleads.v13.services.CustomInterestService",
+ "google.ads.googleads.v13.services.CustomerAssetService",
+ "google.ads.googleads.v13.services.CustomerAssetSetService",
+ "google.ads.googleads.v13.services.CustomerClientLinkService",
+ "google.ads.googleads.v13.services.CustomerConversionGoalService",
+ "google.ads.googleads.v13.services.CustomerCustomizerService",
+ "google.ads.googleads.v13.services.CustomerExtensionSettingService",
+ "google.ads.googleads.v13.services.CustomerFeedService",
+ "google.ads.googleads.v13.services.CustomerLabelService",
+ "google.ads.googleads.v13.services.CustomerManagerLinkService",
+ "google.ads.googleads.v13.services.CustomerNegativeCriterionService",
+ "google.ads.googleads.v13.services.CustomerService",
+ "google.ads.googleads.v13.services.CustomerUserAccessInvitationService",
+ "google.ads.googleads.v13.services.CustomerUserAccessService",
+ "google.ads.googleads.v13.services.CustomizerAttributeService",
+ "google.ads.googleads.v13.services.ExperimentArmService",
+ "google.ads.googleads.v13.services.ExperimentService",
+ "google.ads.googleads.v13.services.ExtensionFeedItemService",
+ "google.ads.googleads.v13.services.FeedItemService",
+ "google.ads.googleads.v13.services.FeedItemSetLinkService",
+ "google.ads.googleads.v13.services.FeedItemSetService",
+ "google.ads.googleads.v13.services.FeedItemTargetService",
+ "google.ads.googleads.v13.services.FeedMappingService",
+ "google.ads.googleads.v13.services.FeedService",
+ "google.ads.googleads.v13.services.GeoTargetConstantService",
+ "google.ads.googleads.v13.services.GoogleAdsFieldService",
+ "google.ads.googleads.v13.services.GoogleAdsService",
+ "google.ads.googleads.v13.services.InvoiceService",
+ "google.ads.googleads.v13.services.KeywordPlanAdGroupKeywordService",
+ "google.ads.googleads.v13.services.KeywordPlanAdGroupService",
+ "google.ads.googleads.v13.services.KeywordPlanCampaignKeywordService",
+ "google.ads.googleads.v13.services.KeywordPlanCampaignService",
+ "google.ads.googleads.v13.services.KeywordPlanIdeaService",
+ "google.ads.googleads.v13.services.KeywordPlanService",
+ "google.ads.googleads.v13.services.KeywordThemeConstantService",
+ "google.ads.googleads.v13.services.LabelService",
+ "google.ads.googleads.v13.services.MediaFileService",
+ "google.ads.googleads.v13.services.MerchantCenterLinkService",
+ "google.ads.googleads.v13.services.OfflineUserDataJobService",
+ "google.ads.googleads.v13.services.PaymentsAccountService",
+ "google.ads.googleads.v13.services.ProductLinkService",
+ "google.ads.googleads.v13.services.ReachPlanService",
+ "google.ads.googleads.v13.services.RecommendationService",
+ "google.ads.googleads.v13.services.RemarketingActionService",
+ "google.ads.googleads.v13.services.SharedCriterionService",
+ "google.ads.googleads.v13.services.SharedSetService",
+ "google.ads.googleads.v13.services.SmartCampaignSettingService",
+ "google.ads.googleads.v13.services.SmartCampaignSuggestService",
+ "google.ads.googleads.v13.services.ThirdPartyAppAnalyticsLinkService",
+ "google.ads.googleads.v13.services.TravelAssetSuggestionService",
+ "google.ads.googleads.v13.services.UserDataService",
+ "google.ads.googleads.v13.services.UserListService"
],
"nameInServiceConfig": "googleads.googleapis.com"
},
@@ -7497,17 +7569,17 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin": 4
+ "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin": 5
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 4
+ "true": 5
}
},
"java_package": {
"valueCounts": {
- "com.google.analytics.admin.v1alpha": 4
+ "com.google.analytics.admin.v1alpha": 5
}
}
},
@@ -7586,6 +7658,21 @@
}
]
},
+ {
+ "shortName": "BatchCreateAccessBindings",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchCreateAccessBindings",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=accounts/*}/accessBindings:batchCreate"
+ },
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=properties/*}/accessBindings:batchCreate"
+ }
+ ]
+ },
{
"shortName": "BatchCreateUserLinks",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchCreateUserLinks",
@@ -7601,6 +7688,21 @@
}
]
},
+ {
+ "shortName": "BatchDeleteAccessBindings",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchDeleteAccessBindings",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=accounts/*}/accessBindings:batchDelete"
+ },
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=properties/*}/accessBindings:batchDelete"
+ }
+ ]
+ },
{
"shortName": "BatchDeleteUserLinks",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchDeleteUserLinks",
@@ -7616,6 +7718,21 @@
}
]
},
+ {
+ "shortName": "BatchGetAccessBindings",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchGetAccessBindings",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=accounts/*}/accessBindings:batchGet"
+ },
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=properties/*}/accessBindings:batchGet"
+ }
+ ]
+ },
{
"shortName": "BatchGetUserLinks",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchGetUserLinks",
@@ -7631,6 +7748,21 @@
}
]
},
+ {
+ "shortName": "BatchUpdateAccessBindings",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchUpdateAccessBindings",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=accounts/*}/accessBindings:batchUpdate"
+ },
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=properties/*}/accessBindings:batchUpdate"
+ }
+ ]
+ },
{
"shortName": "BatchUpdateUserLinks",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.BatchUpdateUserLinks",
@@ -7657,6 +7789,21 @@
}
]
},
+ {
+ "shortName": "CreateAccessBinding",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateAccessBinding",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=accounts/*}/accessBindings"
+ },
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=properties/*}/accessBindings"
+ }
+ ]
+ },
{
"shortName": "CreateAudience",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateAudience",
@@ -7734,6 +7881,17 @@
}
]
},
+ {
+ "shortName": "CreateExpandedDataSet",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateExpandedDataSet",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=properties/*}/expandedDataSets"
+ }
+ ]
+ },
{
"shortName": "CreateFirebaseLink",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateFirebaseLink",
@@ -7778,6 +7936,17 @@
}
]
},
+ {
+ "shortName": "CreateSearchAds360Link",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateSearchAds360Link",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=properties/*}/searchAds360Links"
+ }
+ ]
+ },
{
"shortName": "CreateUserLink",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.CreateUserLink",
@@ -7793,6 +7962,21 @@
}
]
},
+ {
+ "shortName": "DeleteAccessBinding",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteAccessBinding",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1alpha/{name=accounts/*/accessBindings/*}"
+ },
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1alpha/{name=properties/*/accessBindings/*}"
+ }
+ ]
+ },
{
"shortName": "DeleteAccount",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteAccount",
@@ -7848,6 +8032,17 @@
}
]
},
+ {
+ "shortName": "DeleteExpandedDataSet",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteExpandedDataSet",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1alpha/{name=properties/*/expandedDataSets/*}"
+ }
+ ]
+ },
{
"shortName": "DeleteFirebaseLink",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteFirebaseLink",
@@ -7892,6 +8087,17 @@
}
]
},
+ {
+ "shortName": "DeleteSearchAds360Link",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteSearchAds360Link",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1alpha/{name=properties/*/searchAds360Links/*}"
+ }
+ ]
+ },
{
"shortName": "DeleteUserLink",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteUserLink",
@@ -7907,6 +8113,32 @@
}
]
},
+ {
+ "shortName": "FetchAutomatedGa4ConfigurationOptOut",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.FetchAutomatedGa4ConfigurationOptOut",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut"
+ }
+ ]
+ },
+ {
+ "shortName": "GetAccessBinding",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetAccessBinding",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{name=accounts/*/accessBindings/*}"
+ },
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{name=properties/*/accessBindings/*}"
+ }
+ ]
+ },
{
"shortName": "GetAccount",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetAccount",
@@ -7940,6 +8172,17 @@
}
]
},
+ {
+ "shortName": "GetBigQueryLink",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetBigQueryLink",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{name=properties/*/bigQueryLinks/*}"
+ }
+ ]
+ },
{
"shortName": "GetConversionEvent",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetConversionEvent",
@@ -8028,6 +8271,17 @@
}
]
},
+ {
+ "shortName": "GetExpandedDataSet",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetExpandedDataSet",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{name=properties/*/expandedDataSets/*}"
+ }
+ ]
+ },
{
"shortName": "GetGlobalSiteTag",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetGlobalSiteTag",
@@ -8072,6 +8326,17 @@
}
]
},
+ {
+ "shortName": "GetSearchAds360Link",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetSearchAds360Link",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{name=properties/*/searchAds360Links/*}"
+ }
+ ]
+ },
{
"shortName": "GetUserLink",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.GetUserLink",
@@ -8087,6 +8352,21 @@
}
]
},
+ {
+ "shortName": "ListAccessBindings",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccessBindings",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=accounts/*}/accessBindings"
+ },
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=properties/*}/accessBindings"
+ }
+ ]
+ },
{
"shortName": "ListAccountSummaries",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccountSummaries",
@@ -8120,6 +8400,17 @@
}
]
},
+ {
+ "shortName": "ListBigQueryLinks",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListBigQueryLinks",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=properties/*}/bigQueryLinks"
+ }
+ ]
+ },
{
"shortName": "ListConversionEvents",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListConversionEvents",
@@ -8186,6 +8477,17 @@
}
]
},
+ {
+ "shortName": "ListExpandedDataSets",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListExpandedDataSets",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=properties/*}/expandedDataSets"
+ }
+ ]
+ },
{
"shortName": "ListFirebaseLinks",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListFirebaseLinks",
@@ -8230,6 +8532,17 @@
}
]
},
+ {
+ "shortName": "ListSearchAds360Links",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListSearchAds360Links",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=properties/*}/searchAds360Links"
+ }
+ ]
+ },
{
"shortName": "ListUserLinks",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.ListUserLinks",
@@ -8278,6 +8591,32 @@
}
]
},
+ {
+ "shortName": "SetAutomatedGa4ConfigurationOptOut",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.SetAutomatedGa4ConfigurationOptOut",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/properties:setAutomatedGa4ConfigurationOptOut"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateAccessBinding",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateAccessBinding",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1alpha/{access_binding.name=accounts/*/accessBindings/*}"
+ },
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1alpha/{access_binding.name=properties/*/accessBindings/*}"
+ }
+ ]
+ },
{
"shortName": "UpdateAccount",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateAccount",
@@ -8366,6 +8705,17 @@
}
]
},
+ {
+ "shortName": "UpdateExpandedDataSet",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateExpandedDataSet",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1alpha/{expanded_data_set.name=properties/*/expandedDataSets/*}"
+ }
+ ]
+ },
{
"shortName": "UpdateGoogleAdsLink",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateGoogleAdsLink",
@@ -8410,6 +8760,17 @@
}
]
},
+ {
+ "shortName": "UpdateSearchAds360Link",
+ "fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateSearchAds360Link",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1alpha/{search_ads_360_link.name=properties/*/searchAds360Links/*}"
+ }
+ ]
+ },
{
"shortName": "UpdateUserLink",
"fullName": "google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateUserLink",
@@ -12127,6 +12488,17 @@
}
]
},
+ {
+ "shortName": "GenerateInitialChangeStreamPartitions",
+ "fullName": "google.bigtable.v2.Bigtable.GenerateInitialChangeStreamPartitions",
+ "mode": "SERVER_STREAMING",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v2/{table_name=projects/*/instances/*/tables/*}:generateInitialChangeStreamPartitions"
+ }
+ ]
+ },
{
"shortName": "MutateRow",
"fullName": "google.bigtable.v2.Bigtable.MutateRow",
@@ -12160,6 +12532,17 @@
}
]
},
+ {
+ "shortName": "ReadChangeStream",
+ "fullName": "google.bigtable.v2.Bigtable.ReadChangeStream",
+ "mode": "SERVER_STREAMING",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v2/{table_name=projects/*/instances/*/tables/*}:readChangeStream"
+ }
+ ]
+ },
{
"shortName": "ReadModifyWriteRow",
"fullName": "google.bigtable.v2.Bigtable.ReadModifyWriteRow",
@@ -12386,7 +12769,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/accessapproval/v1;accessapproval": 1
+ "cloud.google.com/go/accessapproval/apiv1/accessapprovalpb;accessapprovalpb": 1
}
},
"java_multiple_files": {
@@ -12595,6 +12978,86 @@
],
"nameInServiceConfig": "accessapproval.googleapis.com"
},
+ {
+ "id": "google.cloud.advisorynotifications.v1",
+ "directory": "google/cloud/advisorynotifications/v1",
+ "version": "v1",
+ "majorVersion": "v1",
+ "hostName": "advisorynotifications.googleapis.com",
+ "title": "Advisory Notifications API",
+ "description": "An API for accessing Advisory Notifications in Google Cloud",
+ "importDirectories": [
+ "google/api",
+ "google/protobuf"
+ ],
+ "options": {
+ "csharp_namespace": {
+ "valueCounts": {
+ "Google.Cloud.AdvisoryNotifications.V1": 1
+ }
+ },
+ "go_package": {
+ "valueCounts": {
+ "cloud.google.com/go/advisorynotifications/apiv1/advisorynotificationspb;advisorynotificationspb": 1
+ }
+ },
+ "java_multiple_files": {
+ "valueCounts": {
+ "true": 1
+ }
+ },
+ "java_package": {
+ "valueCounts": {
+ "com.google.cloud.advisorynotifications.v1": 1
+ }
+ },
+ "php_namespace": {
+ "valueCounts": {
+ "Google\\Cloud\\AdvisoryNotifications\\V1": 1
+ }
+ },
+ "ruby_package": {
+ "valueCounts": {
+ "Google::Cloud::AdvisoryNotifications::V1": 1
+ }
+ }
+ },
+ "services": [
+ {
+ "shortName": "AdvisoryNotificationsService",
+ "fullName": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService",
+ "methods": [
+ {
+ "shortName": "GetNotification",
+ "fullName": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService.GetNotification",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=organizations/*/locations/*/notifications/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "ListNotifications",
+ "fullName": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService.ListNotifications",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=organizations/*/locations/*}/notifications"
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "configFile": "advisorynotifications_v1.yaml",
+ "serviceConfigApiNames": [
+ "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService"
+ ],
+ "nameInServiceConfig": "advisorynotifications.googleapis.com"
+ },
{
"id": "google.cloud.aiplatform.v1",
"directory": "google/cloud/aiplatform/v1",
@@ -12615,7 +13078,7 @@
"options": {
"csharp_namespace": {
"valueCounts": {
- "Google.Cloud.AIPlatform.V1": 74,
+ "Google.Cloud.AIPlatform.V1": 77,
"Google.Cloud.AIPlatform.V1.Schema.Predict.Instance": 9,
"Google.Cloud.AIPlatform.V1.Schema.Predict.Params": 6,
"Google.Cloud.AIPlatform.V1.Schema.Predict.Prediction": 10,
@@ -12624,21 +13087,21 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/instance;instance": 9,
- "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/params;params": 6,
- "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction;prediction": 10,
- "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition": 11,
- "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform": 74
+ "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb": 77,
+ "cloud.google.com/go/aiplatform/apiv1/schema/predict/instance/instancepb;instancepb": 9,
+ "cloud.google.com/go/aiplatform/apiv1/schema/predict/params/paramspb;paramspb": 6,
+ "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb;predictionpb": 10,
+ "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb": 11
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 110
+ "true": 113
}
},
"java_package": {
"valueCounts": {
- "com.google.cloud.aiplatform.v1": 74,
+ "com.google.cloud.aiplatform.v1": 77,
"com.google.cloud.aiplatform.v1.schema.predict.instance": 9,
"com.google.cloud.aiplatform.v1.schema.predict.params": 6,
"com.google.cloud.aiplatform.v1.schema.predict.prediction": 10,
@@ -12647,7 +13110,7 @@
},
"php_namespace": {
"valueCounts": {
- "Google\\Cloud\\AIPlatform\\V1": 74,
+ "Google\\Cloud\\AIPlatform\\V1": 77,
"Google\\Cloud\\AIPlatform\\V1\\Schema\\Predict\\Instance": 9,
"Google\\Cloud\\AIPlatform\\V1\\Schema\\Predict\\Params": 6,
"Google\\Cloud\\AIPlatform\\V1\\Schema\\Predict\\Prediction": 10,
@@ -12656,7 +13119,7 @@
},
"ruby_package": {
"valueCounts": {
- "Google::Cloud::AIPlatform::V1": 74,
+ "Google::Cloud::AIPlatform::V1": 77,
"Google::Cloud::AIPlatform::V1::Schema::Predict::Instance": 9,
"Google::Cloud::AIPlatform::V1::Schema::Predict::Params": 6,
"Google::Cloud::AIPlatform::V1::Schema::Predict::Prediction": 10,
@@ -13006,6 +13469,17 @@
}
]
},
+ {
+ "shortName": "DeleteFeatureValues",
+ "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeatureValues",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:deleteFeatureValues"
+ }
+ ]
+ },
{
"shortName": "DeleteFeaturestore",
"fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore",
@@ -13376,6 +13850,17 @@
}
]
},
+ {
+ "shortName": "CancelNasJob",
+ "fullName": "google.cloud.aiplatform.v1.JobService.CancelNasJob",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{name=projects/*/locations/*/nasJobs/*}:cancel"
+ }
+ ]
+ },
{
"shortName": "CreateBatchPredictionJob",
"fullName": "google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob",
@@ -13431,6 +13916,17 @@
}
]
},
+ {
+ "shortName": "CreateNasJob",
+ "fullName": "google.cloud.aiplatform.v1.JobService.CreateNasJob",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*}/nasJobs"
+ }
+ ]
+ },
{
"shortName": "DeleteBatchPredictionJob",
"fullName": "google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob",
@@ -13486,6 +13982,17 @@
}
]
},
+ {
+ "shortName": "DeleteNasJob",
+ "fullName": "google.cloud.aiplatform.v1.JobService.DeleteNasJob",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/locations/*/nasJobs/*}"
+ }
+ ]
+ },
{
"shortName": "GetBatchPredictionJob",
"fullName": "google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob",
@@ -13541,6 +14048,28 @@
}
]
},
+ {
+ "shortName": "GetNasJob",
+ "fullName": "google.cloud.aiplatform.v1.JobService.GetNasJob",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/nasJobs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetNasTrialDetail",
+ "fullName": "google.cloud.aiplatform.v1.JobService.GetNasTrialDetail",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/nasJobs/*/nasTrialDetails/*}"
+ }
+ ]
+ },
{
"shortName": "ListBatchPredictionJobs",
"fullName": "google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs",
@@ -13596,6 +14125,28 @@
}
]
},
+ {
+ "shortName": "ListNasJobs",
+ "fullName": "google.cloud.aiplatform.v1.JobService.ListNasJobs",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*}/nasJobs"
+ }
+ ]
+ },
+ {
+ "shortName": "ListNasTrialDetails",
+ "fullName": "google.cloud.aiplatform.v1.JobService.ListNasTrialDetails",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*/nasJobs/*}/nasTrialDetails"
+ }
+ ]
+ },
{
"shortName": "PauseModelDeploymentMonitoringJob",
"fullName": "google.cloud.aiplatform.v1.JobService.PauseModelDeploymentMonitoringJob",
@@ -14032,6 +14583,17 @@
"shortName": "ModelService",
"fullName": "google.cloud.aiplatform.v1.ModelService",
"methods": [
+ {
+ "shortName": "BatchImportEvaluatedAnnotations",
+ "fullName": "google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotations",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*/models/*/evaluations/*/slices/*}:batchImport"
+ }
+ ]
+ },
{
"shortName": "BatchImportModelEvaluationSlices",
"fullName": "google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices",
@@ -14043,6 +14605,17 @@
}
]
},
+ {
+ "shortName": "CopyModel",
+ "fullName": "google.cloud.aiplatform.v1.ModelService.CopyModel",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*}/models:copy"
+ }
+ ]
+ },
{
"shortName": "DeleteModel",
"fullName": "google.cloud.aiplatform.v1.ModelService.DeleteModel",
@@ -14661,6 +15234,17 @@
}
]
},
+ {
+ "shortName": "ReadTensorboardUsage",
+ "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage"
+ }
+ ]
+ },
{
"shortName": "UpdateTensorboard",
"fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboard",
@@ -14946,7 +15530,7 @@
"options": {
"csharp_namespace": {
"valueCounts": {
- "Google.Cloud.AIPlatform.V1Beta1": 76,
+ "Google.Cloud.AIPlatform.V1Beta1": 80,
"Google.Cloud.AIPlatform.V1Beta1.Schema": 6,
"Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance": 9,
"Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params": 6,
@@ -14956,22 +15540,22 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance": 9,
- "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params": 6,
- "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction": 11,
- "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition": 12,
- "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema": 6,
- "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform": 76
+ "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb": 80,
+ "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/instance/instancepb;instancepb": 9,
+ "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/params/paramspb;paramspb": 6,
+ "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb": 11,
+ "cloud.google.com/go/aiplatform/apiv1beta1/schema/schemapb;schemapb": 6,
+ "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb": 12
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 120
+ "true": 124
}
},
"java_package": {
"valueCounts": {
- "com.google.cloud.aiplatform.v1beta1": 76,
+ "com.google.cloud.aiplatform.v1beta1": 80,
"com.google.cloud.aiplatform.v1beta1.schema": 6,
"com.google.cloud.aiplatform.v1beta1.schema.predict.instance": 9,
"com.google.cloud.aiplatform.v1beta1.schema.predict.params": 6,
@@ -14981,7 +15565,7 @@
},
"php_namespace": {
"valueCounts": {
- "Google\\Cloud\\AIPlatform\\V1beta1": 76,
+ "Google\\Cloud\\AIPlatform\\V1beta1": 80,
"Google\\Cloud\\AIPlatform\\V1beta1\\Schema": 6,
"Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Instance": 9,
"Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Params": 6,
@@ -14991,7 +15575,7 @@
},
"ruby_package": {
"valueCounts": {
- "Google::Cloud::AIPlatform::V1beta1": 76,
+ "Google::Cloud::AIPlatform::V1beta1": 80,
"Google::Cloud::AIPlatform::V1beta1::Schema": 6,
"Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Instance": 9,
"Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Params": 6,
@@ -15784,6 +16368,17 @@
}
]
},
+ {
+ "shortName": "CancelNasJob",
+ "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelNasJob",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{name=projects/*/locations/*/nasJobs/*}:cancel"
+ }
+ ]
+ },
{
"shortName": "CreateBatchPredictionJob",
"fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateBatchPredictionJob",
@@ -15839,6 +16434,17 @@
}
]
},
+ {
+ "shortName": "CreateNasJob",
+ "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateNasJob",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{parent=projects/*/locations/*}/nasJobs"
+ }
+ ]
+ },
{
"shortName": "DeleteBatchPredictionJob",
"fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteBatchPredictionJob",
@@ -15894,6 +16500,17 @@
}
]
},
+ {
+ "shortName": "DeleteNasJob",
+ "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteNasJob",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1beta1/{name=projects/*/locations/*/nasJobs/*}"
+ }
+ ]
+ },
{
"shortName": "GetBatchPredictionJob",
"fullName": "google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob",
@@ -15949,6 +16566,28 @@
}
]
},
+ {
+ "shortName": "GetNasJob",
+ "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetNasJob",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{name=projects/*/locations/*/nasJobs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetNasTrialDetail",
+ "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetNasTrialDetail",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{name=projects/*/locations/*/nasJobs/*/nasTrialDetails/*}"
+ }
+ ]
+ },
{
"shortName": "ListBatchPredictionJobs",
"fullName": "google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs",
@@ -16004,6 +16643,28 @@
}
]
},
+ {
+ "shortName": "ListNasJobs",
+ "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListNasJobs",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{parent=projects/*/locations/*}/nasJobs"
+ }
+ ]
+ },
+ {
+ "shortName": "ListNasTrialDetails",
+ "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{parent=projects/*/locations/*/nasJobs/*}/nasTrialDetails"
+ }
+ ]
+ },
{
"shortName": "PauseModelDeploymentMonitoringJob",
"fullName": "google.cloud.aiplatform.v1beta1.JobService.PauseModelDeploymentMonitoringJob",
@@ -16050,6 +16711,34 @@
}
]
},
+ {
+ "shortName": "MatchService",
+ "fullName": "google.cloud.aiplatform.v1beta1.MatchService",
+ "methods": [
+ {
+ "shortName": "FindNeighbors",
+ "fullName": "google.cloud.aiplatform.v1beta1.MatchService.FindNeighbors",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:findNeighbors"
+ }
+ ]
+ },
+ {
+ "shortName": "ReadIndexDatapoints",
+ "fullName": "google.cloud.aiplatform.v1beta1.MatchService.ReadIndexDatapoints",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:readIndexDatapoints"
+ }
+ ]
+ }
+ ]
+ },
{
"shortName": "MetadataService",
"fullName": "google.cloud.aiplatform.v1beta1.MetadataService",
@@ -16440,6 +17129,17 @@
"shortName": "ModelService",
"fullName": "google.cloud.aiplatform.v1beta1.ModelService",
"methods": [
+ {
+ "shortName": "BatchImportEvaluatedAnnotations",
+ "fullName": "google.cloud.aiplatform.v1beta1.ModelService.BatchImportEvaluatedAnnotations",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{parent=projects/*/locations/*/models/*/evaluations/*/slices/*}:batchImport"
+ }
+ ]
+ },
{
"shortName": "BatchImportModelEvaluationSlices",
"fullName": "google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices",
@@ -16451,6 +17151,17 @@
}
]
},
+ {
+ "shortName": "CopyModel",
+ "fullName": "google.cloud.aiplatform.v1beta1.ModelService.CopyModel",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{parent=projects/*/locations/*}/models:copy"
+ }
+ ]
+ },
{
"shortName": "DeleteModel",
"fullName": "google.cloud.aiplatform.v1beta1.ModelService.DeleteModel",
@@ -16878,471 +17589,1448 @@
"bindings": [
{
"httpMethod": "POST",
- "path": "/v1beta1/{parent=projects/*/locations/*}/tensorboards"
+ "path": "/v1beta1/{parent=projects/*/locations/*}/tensorboards"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateTensorboardExperiment",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardExperiment",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*}/experiments"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateTensorboardRun",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardRun",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateTensorboardTimeSeries",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardTimeSeries",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteTensorboard",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboard",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteTensorboardExperiment",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardExperiment",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteTensorboardRun",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardRun",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteTensorboardTimeSeries",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardTimeSeries",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "ExportTensorboardTimeSeriesData",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:exportTensorboardTimeSeries"
+ }
+ ]
+ },
+ {
+ "shortName": "GetTensorboard",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboard",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetTensorboardExperiment",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardExperiment",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetTensorboardRun",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardRun",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetTensorboardTimeSeries",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardTimeSeries",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "ListTensorboardExperiments",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*}/experiments"
+ }
+ ]
+ },
+ {
+ "shortName": "ListTensorboardRuns",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs"
+ }
+ ]
+ },
+ {
+ "shortName": "ListTensorboardTimeSeries",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries"
+ }
+ ]
+ },
+ {
+ "shortName": "ListTensorboards",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{parent=projects/*/locations/*}/tensorboards"
+ }
+ ]
+ },
+ {
+ "shortName": "ReadTensorboardBlobData",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData",
+ "mode": "SERVER_STREAMING",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:readBlobData"
+ }
+ ]
+ },
+ {
+ "shortName": "ReadTensorboardTimeSeriesData",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:read"
+ }
+ ]
+ },
+ {
+ "shortName": "ReadTensorboardUsage",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardUsage",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateTensorboard",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboard",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1beta1/{tensorboard.name=projects/*/locations/*/tensorboards/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateTensorboardExperiment",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardExperiment",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1beta1/{tensorboard_experiment.name=projects/*/locations/*/tensorboards/*/experiments/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateTensorboardRun",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardRun",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1beta1/{tensorboard_run.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateTensorboardTimeSeries",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardTimeSeries",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1beta1/{tensorboard_time_series.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "WriteTensorboardExperimentData",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{tensorboard_experiment=projects/*/locations/*/tensorboards/*/experiments/*}:write"
+ }
+ ]
+ },
+ {
+ "shortName": "WriteTensorboardRunData",
+ "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{tensorboard_run=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}:write"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "shortName": "VizierService",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService",
+ "methods": [
+ {
+ "shortName": "AddTrialMeasurement",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.AddTrialMeasurement",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{trial_name=projects/*/locations/*/studies/*/trials/*}:addTrialMeasurement"
+ }
+ ]
+ },
+ {
+ "shortName": "CheckTrialEarlyStoppingState",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{trial_name=projects/*/locations/*/studies/*/trials/*}:checkTrialEarlyStoppingState"
+ }
+ ]
+ },
+ {
+ "shortName": "CompleteTrial",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CompleteTrial",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{name=projects/*/locations/*/studies/*/trials/*}:complete"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateStudy",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateStudy",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{parent=projects/*/locations/*}/studies"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateTrial",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateTrial",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteStudy",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteStudy",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1beta1/{name=projects/*/locations/*/studies/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteTrial",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteTrial",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1beta1/{name=projects/*/locations/*/studies/*/trials/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetStudy",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetStudy",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{name=projects/*/locations/*/studies/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetTrial",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetTrial",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{name=projects/*/locations/*/studies/*/trials/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "ListOptimalTrials",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials:listOptimalTrials"
+ }
+ ]
+ },
+ {
+ "shortName": "ListStudies",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListStudies",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{parent=projects/*/locations/*}/studies"
+ }
+ ]
+ },
+ {
+ "shortName": "ListTrials",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListTrials",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials"
+ }
+ ]
+ },
+ {
+ "shortName": "LookupStudy",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.LookupStudy",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{parent=projects/*/locations/*}/studies:lookup"
+ }
+ ]
+ },
+ {
+ "shortName": "StopTrial",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.StopTrial",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{name=projects/*/locations/*/studies/*/trials/*}:stop"
+ }
+ ]
+ },
+ {
+ "shortName": "SuggestTrials",
+ "fullName": "google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials:suggest"
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "configFile": "aiplatform_v1beta1.yaml",
+ "serviceConfigApiNames": [
+ "google.cloud.aiplatform.v1beta1.DatasetService",
+ "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService",
+ "google.cloud.aiplatform.v1beta1.EndpointService",
+ "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService",
+ "google.cloud.aiplatform.v1beta1.FeaturestoreService",
+ "google.cloud.aiplatform.v1beta1.IndexEndpointService",
+ "google.cloud.aiplatform.v1beta1.IndexService",
+ "google.cloud.aiplatform.v1beta1.JobService",
+ "google.cloud.aiplatform.v1beta1.MatchService",
+ "google.cloud.aiplatform.v1beta1.MetadataService",
+ "google.cloud.aiplatform.v1beta1.MigrationService",
+ "google.cloud.aiplatform.v1beta1.ModelService",
+ "google.cloud.aiplatform.v1beta1.PipelineService",
+ "google.cloud.aiplatform.v1beta1.PredictionService",
+ "google.cloud.aiplatform.v1beta1.SpecialistPoolService",
+ "google.cloud.aiplatform.v1beta1.TensorboardService",
+ "google.cloud.aiplatform.v1beta1.VizierService",
+ "google.cloud.location.Locations",
+ "google.iam.v1.IAMPolicy",
+ "google.longrunning.Operations"
+ ],
+ "nameInServiceConfig": "aiplatform.googleapis.com"
+ },
+ {
+ "id": "google.cloud.alloydb.v1",
+ "directory": "google/cloud/alloydb/v1",
+ "version": "v1",
+ "majorVersion": "v1",
+ "hostName": "alloydb.googleapis.com",
+ "title": "AlloyDB API",
+ "description": "AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance.
AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.",
+ "importDirectories": [
+ "google/api",
+ "google/cloud/alloydb/v1",
+ "google/longrunning",
+ "google/protobuf",
+ "google/rpc",
+ "google/type"
+ ],
+ "options": {
+ "csharp_namespace": {
+ "valueCounts": {
+ "Google.Cloud.AlloyDb.V1": 2
+ }
+ },
+ "go_package": {
+ "valueCounts": {
+ "cloud.google.com/go/alloydb/apiv1/alloydbpb;alloydbpb": 2
+ }
+ },
+ "java_multiple_files": {
+ "valueCounts": {
+ "true": 2
+ }
+ },
+ "java_package": {
+ "valueCounts": {
+ "com.google.cloud.alloydb.v1": 2
+ }
+ },
+ "php_namespace": {
+ "valueCounts": {
+ "Google\\Cloud\\AlloyDb\\V1": 2
+ }
+ },
+ "ruby_package": {
+ "valueCounts": {
+ "Google::Cloud::AlloyDb::V1": 2
+ }
+ }
+ },
+ "services": [
+ {
+ "shortName": "AlloyDBAdmin",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin",
+ "methods": [
+ {
+ "shortName": "BatchCreateInstances",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.BatchCreateInstances",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*/clusters/*}/instances:batchCreate"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateBackup",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateBackup",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*}/backups"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateCluster",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*}/clusters"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateInstance",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.CreateInstance",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*/clusters/*}/instances"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteBackup",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.DeleteBackup",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/locations/*/backups/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteCluster",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.DeleteCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/locations/*/clusters/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteInstance",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.DeleteInstance",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/locations/*/clusters/*/instances/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "FailoverInstance",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.FailoverInstance",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{name=projects/*/locations/*/clusters/*/instances/*}:failover"
+ }
+ ]
+ },
+ {
+ "shortName": "GetBackup",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.GetBackup",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/backups/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetCluster",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.GetCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/clusters/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetInstance",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.GetInstance",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/clusters/*/instances/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "ListBackups",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListBackups",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*}/backups"
+ }
+ ]
+ },
+ {
+ "shortName": "ListClusters",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListClusters",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*}/clusters"
+ }
+ ]
+ },
+ {
+ "shortName": "ListInstances",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListInstances",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*/clusters/*}/instances"
+ }
+ ]
+ },
+ {
+ "shortName": "ListSupportedDatabaseFlags",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.ListSupportedDatabaseFlags",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*}/supportedDatabaseFlags"
+ }
+ ]
+ },
+ {
+ "shortName": "RestartInstance",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.RestartInstance",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{name=projects/*/locations/*/clusters/*/instances/*}:restart"
+ }
+ ]
+ },
+ {
+ "shortName": "RestoreCluster",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.RestoreCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*}/clusters:restore"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateBackup",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.UpdateBackup",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1/{backup.name=projects/*/locations/*/backups/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateCluster",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.UpdateCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1/{cluster.name=projects/*/locations/*/clusters/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateInstance",
+ "fullName": "google.cloud.alloydb.v1.AlloyDBAdmin.UpdateInstance",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1/{instance.name=projects/*/locations/*/clusters/*/instances/*}"
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "configFile": "alloydb_v1.yaml",
+ "serviceConfigApiNames": [
+ "google.cloud.alloydb.v1.AlloyDBAdmin",
+ "google.cloud.location.Locations",
+ "google.iam.v1.IAMPolicy",
+ "google.longrunning.Operations"
+ ],
+ "nameInServiceConfig": "alloydb.googleapis.com"
+ },
+ {
+ "id": "google.cloud.alloydb.v1alpha",
+ "directory": "google/cloud/alloydb/v1alpha",
+ "version": "v1alpha",
+ "majorVersion": "v1",
+ "hostName": "alloydb.googleapis.com",
+ "title": "AlloyDB API",
+ "description": "AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance.
AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.",
+ "importDirectories": [
+ "google/api",
+ "google/cloud/alloydb/v1alpha",
+ "google/longrunning",
+ "google/protobuf",
+ "google/rpc",
+ "google/type"
+ ],
+ "options": {
+ "csharp_namespace": {
+ "valueCounts": {
+ "Google.Cloud.AlloyDb.V1Alpha": 2
+ }
+ },
+ "go_package": {
+ "valueCounts": {
+ "cloud.google.com/go/alloydb/apiv1alpha/alloydbpb;alloydbpb": 2
+ }
+ },
+ "java_multiple_files": {
+ "valueCounts": {
+ "true": 2
+ }
+ },
+ "java_package": {
+ "valueCounts": {
+ "com.google.cloud.alloydb.v1alpha": 2
+ }
+ },
+ "php_namespace": {
+ "valueCounts": {
+ "Google\\Cloud\\AlloyDb\\V1alpha": 2
+ }
+ },
+ "ruby_package": {
+ "valueCounts": {
+ "Google::Cloud::AlloyDb::V1alpha": 2
+ }
+ }
+ },
+ "services": [
+ {
+ "shortName": "AlloyDBAdmin",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin",
+ "methods": [
+ {
+ "shortName": "BatchCreateInstances",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.BatchCreateInstances",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=projects/*/locations/*/clusters/*}/instances:batchCreate"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateBackup",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateBackup",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=projects/*/locations/*}/backups"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateCluster",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=projects/*/locations/*}/clusters"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateInstance",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateInstance",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=projects/*/locations/*/clusters/*}/instances"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateSecondaryCluster",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateSecondaryCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=projects/*/locations/*}/clusters:createsecondary"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateSecondaryInstance",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.CreateSecondaryInstance",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=projects/*/locations/*/clusters/*}/instances:createsecondary"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteBackup",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.DeleteBackup",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1alpha/{name=projects/*/locations/*/backups/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteCluster",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.DeleteCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1alpha/{name=projects/*/locations/*/clusters/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteInstance",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.DeleteInstance",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1alpha/{name=projects/*/locations/*/clusters/*/instances/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "FailoverInstance",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.FailoverInstance",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{name=projects/*/locations/*/clusters/*/instances/*}:failover"
+ }
+ ]
+ },
+ {
+ "shortName": "GenerateClientCertificate",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GenerateClientCertificate",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=projects/*/locations/*/clusters/*}:generateClientCertificate"
}
]
},
{
- "shortName": "CreateTensorboardExperiment",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardExperiment",
+ "shortName": "GetBackup",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetBackup",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*}/experiments"
+ "httpMethod": "GET",
+ "path": "/v1alpha/{name=projects/*/locations/*/backups/*}"
}
]
},
{
- "shortName": "CreateTensorboardRun",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardRun",
+ "shortName": "GetCluster",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetCluster",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs"
+ "httpMethod": "GET",
+ "path": "/v1alpha/{name=projects/*/locations/*/clusters/*}"
}
]
},
{
- "shortName": "CreateTensorboardTimeSeries",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardTimeSeries",
+ "shortName": "GetConnectionInfo",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetConnectionInfo",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries"
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=projects/*/locations/*/clusters/*/instances/*}/connectionInfo"
}
]
},
{
- "shortName": "DeleteTensorboard",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboard",
+ "shortName": "GetInstance",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.GetInstance",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "DELETE",
- "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*}"
+ "httpMethod": "GET",
+ "path": "/v1alpha/{name=projects/*/locations/*/clusters/*/instances/*}"
}
]
},
{
- "shortName": "DeleteTensorboardExperiment",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardExperiment",
+ "shortName": "ListBackups",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListBackups",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "DELETE",
- "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*}"
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=projects/*/locations/*}/backups"
}
]
},
{
- "shortName": "DeleteTensorboardRun",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardRun",
+ "shortName": "ListClusters",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListClusters",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "DELETE",
- "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}"
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=projects/*/locations/*}/clusters"
}
]
},
{
- "shortName": "DeleteTensorboardTimeSeries",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardTimeSeries",
+ "shortName": "ListInstances",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListInstances",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "DELETE",
- "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=projects/*/locations/*/clusters/*}/instances"
}
]
},
{
- "shortName": "ExportTensorboardTimeSeriesData",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData",
+ "shortName": "ListSupportedDatabaseFlags",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.ListSupportedDatabaseFlags",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:exportTensorboardTimeSeries"
+ "httpMethod": "GET",
+ "path": "/v1alpha/{parent=projects/*/locations/*}/supportedDatabaseFlags"
}
]
},
{
- "shortName": "GetTensorboard",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboard",
+ "shortName": "PromoteCluster",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.PromoteCluster",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*}"
+ "httpMethod": "POST",
+ "path": "/v1alpha/{name=projects/*/locations/*/clusters/*}:promote"
}
]
},
{
- "shortName": "GetTensorboardExperiment",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardExperiment",
+ "shortName": "RestartInstance",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.RestartInstance",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*}"
+ "httpMethod": "POST",
+ "path": "/v1alpha/{name=projects/*/locations/*/clusters/*/instances/*}:restart"
}
]
},
{
- "shortName": "GetTensorboardRun",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardRun",
+ "shortName": "RestoreCluster",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.RestoreCluster",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}"
+ "httpMethod": "POST",
+ "path": "/v1alpha/{parent=projects/*/locations/*}/clusters:restore"
}
]
},
{
- "shortName": "GetTensorboardTimeSeries",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardTimeSeries",
+ "shortName": "UpdateBackup",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.UpdateBackup",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
+ "httpMethod": "PATCH",
+ "path": "/v1alpha/{backup.name=projects/*/locations/*/backups/*}"
}
]
},
{
- "shortName": "ListTensorboardExperiments",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments",
+ "shortName": "UpdateCluster",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.UpdateCluster",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*}/experiments"
+ "httpMethod": "PATCH",
+ "path": "/v1alpha/{cluster.name=projects/*/locations/*/clusters/*}"
}
]
},
{
- "shortName": "ListTensorboardRuns",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns",
+ "shortName": "UpdateInstance",
+ "fullName": "google.cloud.alloydb.v1alpha.AlloyDBAdmin.UpdateInstance",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs"
+ "httpMethod": "PATCH",
+ "path": "/v1alpha/{instance.name=projects/*/locations/*/clusters/*/instances/*}"
}
]
- },
+ }
+ ]
+ }
+ ],
+ "configFile": "alloydb_v1alpha.yaml",
+ "serviceConfigApiNames": [
+ "google.cloud.alloydb.v1alpha.AlloyDBAdmin",
+ "google.cloud.location.Locations",
+ "google.iam.v1.IAMPolicy",
+ "google.longrunning.Operations"
+ ],
+ "nameInServiceConfig": "alloydb.googleapis.com"
+ },
+ {
+ "id": "google.cloud.alloydb.v1beta",
+ "directory": "google/cloud/alloydb/v1beta",
+ "version": "v1beta",
+ "majorVersion": "v1",
+ "hostName": "alloydb.googleapis.com",
+ "title": "AlloyDB API",
+ "description": "AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance.
AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.",
+ "importDirectories": [
+ "google/api",
+ "google/cloud/alloydb/v1beta",
+ "google/longrunning",
+ "google/protobuf",
+ "google/rpc",
+ "google/type"
+ ],
+ "options": {
+ "csharp_namespace": {
+ "valueCounts": {
+ "Google.Cloud.AlloyDb.V1Beta": 2
+ }
+ },
+ "go_package": {
+ "valueCounts": {
+ "cloud.google.com/go/alloydb/apiv1beta/alloydbpb;alloydbpb": 2
+ }
+ },
+ "java_multiple_files": {
+ "valueCounts": {
+ "true": 2
+ }
+ },
+ "java_package": {
+ "valueCounts": {
+ "com.google.cloud.alloydb.v1beta": 2
+ }
+ },
+ "php_namespace": {
+ "valueCounts": {
+ "Google\\Cloud\\AlloyDb\\V1beta": 2
+ }
+ },
+ "ruby_package": {
+ "valueCounts": {
+ "Google::Cloud::AlloyDb::V1beta": 2
+ }
+ }
+ },
+ "services": [
+ {
+ "shortName": "AlloyDBAdmin",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin",
+ "methods": [
{
- "shortName": "ListTensorboardTimeSeries",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries",
+ "shortName": "BatchCreateInstances",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.BatchCreateInstances",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries"
+ "httpMethod": "POST",
+ "path": "/v1beta/{parent=projects/*/locations/*/clusters/*}/instances:batchCreate"
}
]
},
{
- "shortName": "ListTensorboards",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards",
+ "shortName": "CreateBackup",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateBackup",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{parent=projects/*/locations/*}/tensorboards"
+ "httpMethod": "POST",
+ "path": "/v1beta/{parent=projects/*/locations/*}/backups"
}
]
},
{
- "shortName": "ReadTensorboardBlobData",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData",
- "mode": "SERVER_STREAMING",
+ "shortName": "CreateCluster",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateCluster",
+ "mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:readBlobData"
+ "httpMethod": "POST",
+ "path": "/v1beta/{parent=projects/*/locations/*}/clusters"
}
]
},
{
- "shortName": "ReadTensorboardTimeSeriesData",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData",
+ "shortName": "CreateInstance",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateInstance",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:read"
+ "httpMethod": "POST",
+ "path": "/v1beta/{parent=projects/*/locations/*/clusters/*}/instances"
}
]
},
{
- "shortName": "UpdateTensorboard",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboard",
+ "shortName": "CreateSecondaryCluster",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateSecondaryCluster",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "PATCH",
- "path": "/v1beta1/{tensorboard.name=projects/*/locations/*/tensorboards/*}"
+ "httpMethod": "POST",
+ "path": "/v1beta/{parent=projects/*/locations/*}/clusters:createsecondary"
}
]
},
{
- "shortName": "UpdateTensorboardExperiment",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardExperiment",
+ "shortName": "CreateSecondaryInstance",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.CreateSecondaryInstance",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "PATCH",
- "path": "/v1beta1/{tensorboard_experiment.name=projects/*/locations/*/tensorboards/*/experiments/*}"
+ "httpMethod": "POST",
+ "path": "/v1beta/{parent=projects/*/locations/*/clusters/*}/instances:createsecondary"
}
]
},
{
- "shortName": "UpdateTensorboardRun",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardRun",
+ "shortName": "DeleteBackup",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.DeleteBackup",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "PATCH",
- "path": "/v1beta1/{tensorboard_run.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}"
+ "httpMethod": "DELETE",
+ "path": "/v1beta/{name=projects/*/locations/*/backups/*}"
}
]
},
{
- "shortName": "UpdateTensorboardTimeSeries",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardTimeSeries",
+ "shortName": "DeleteCluster",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.DeleteCluster",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "PATCH",
- "path": "/v1beta1/{tensorboard_time_series.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
+ "httpMethod": "DELETE",
+ "path": "/v1beta/{name=projects/*/locations/*/clusters/*}"
}
]
},
{
- "shortName": "WriteTensorboardExperimentData",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData",
+ "shortName": "DeleteInstance",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.DeleteInstance",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{tensorboard_experiment=projects/*/locations/*/tensorboards/*/experiments/*}:write"
+ "httpMethod": "DELETE",
+ "path": "/v1beta/{name=projects/*/locations/*/clusters/*/instances/*}"
}
]
},
{
- "shortName": "WriteTensorboardRunData",
- "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData",
+ "shortName": "FailoverInstance",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.FailoverInstance",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v1beta1/{tensorboard_run=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}:write"
+ "path": "/v1beta/{name=projects/*/locations/*/clusters/*/instances/*}:failover"
}
]
- }
- ]
- },
- {
- "shortName": "VizierService",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService",
- "methods": [
+ },
{
- "shortName": "AddTrialMeasurement",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.AddTrialMeasurement",
+ "shortName": "GenerateClientCertificate",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GenerateClientCertificate",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v1beta1/{trial_name=projects/*/locations/*/studies/*/trials/*}:addTrialMeasurement"
+ "path": "/v1beta/{parent=projects/*/locations/*/clusters/*}:generateClientCertificate"
}
]
},
{
- "shortName": "CheckTrialEarlyStoppingState",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState",
+ "shortName": "GetBackup",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetBackup",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{trial_name=projects/*/locations/*/studies/*/trials/*}:checkTrialEarlyStoppingState"
+ "httpMethod": "GET",
+ "path": "/v1beta/{name=projects/*/locations/*/backups/*}"
}
]
},
{
- "shortName": "CompleteTrial",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CompleteTrial",
+ "shortName": "GetCluster",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetCluster",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{name=projects/*/locations/*/studies/*/trials/*}:complete"
+ "httpMethod": "GET",
+ "path": "/v1beta/{name=projects/*/locations/*/clusters/*}"
}
]
},
{
- "shortName": "CreateStudy",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateStudy",
+ "shortName": "GetConnectionInfo",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetConnectionInfo",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{parent=projects/*/locations/*}/studies"
+ "httpMethod": "GET",
+ "path": "/v1beta/{parent=projects/*/locations/*/clusters/*/instances/*}/connectionInfo"
}
]
},
{
- "shortName": "CreateTrial",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateTrial",
+ "shortName": "GetInstance",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.GetInstance",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials"
+ "httpMethod": "GET",
+ "path": "/v1beta/{name=projects/*/locations/*/clusters/*/instances/*}"
}
]
},
{
- "shortName": "DeleteStudy",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteStudy",
+ "shortName": "ListBackups",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListBackups",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "DELETE",
- "path": "/v1beta1/{name=projects/*/locations/*/studies/*}"
+ "httpMethod": "GET",
+ "path": "/v1beta/{parent=projects/*/locations/*}/backups"
}
]
},
{
- "shortName": "DeleteTrial",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteTrial",
+ "shortName": "ListClusters",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListClusters",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "DELETE",
- "path": "/v1beta1/{name=projects/*/locations/*/studies/*/trials/*}"
+ "httpMethod": "GET",
+ "path": "/v1beta/{parent=projects/*/locations/*}/clusters"
}
]
},
{
- "shortName": "GetStudy",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetStudy",
+ "shortName": "ListInstances",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListInstances",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v1beta1/{name=projects/*/locations/*/studies/*}"
+ "path": "/v1beta/{parent=projects/*/locations/*/clusters/*}/instances"
}
]
},
{
- "shortName": "GetTrial",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetTrial",
+ "shortName": "ListSupportedDatabaseFlags",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.ListSupportedDatabaseFlags",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "GET",
- "path": "/v1beta1/{name=projects/*/locations/*/studies/*/trials/*}"
+ "path": "/v1beta/{parent=projects/*/locations/*}/supportedDatabaseFlags"
}
]
},
{
- "shortName": "ListOptimalTrials",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials",
+ "shortName": "PromoteCluster",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.PromoteCluster",
"mode": "UNARY",
"bindings": [
{
"httpMethod": "POST",
- "path": "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials:listOptimalTrials"
+ "path": "/v1beta/{name=projects/*/locations/*/clusters/*}:promote"
}
]
},
{
- "shortName": "ListStudies",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListStudies",
+ "shortName": "RestartInstance",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.RestartInstance",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{parent=projects/*/locations/*}/studies"
+ "httpMethod": "POST",
+ "path": "/v1beta/{name=projects/*/locations/*/clusters/*/instances/*}:restart"
}
]
},
{
- "shortName": "ListTrials",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListTrials",
+ "shortName": "RestoreCluster",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.RestoreCluster",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "GET",
- "path": "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials"
+ "httpMethod": "POST",
+ "path": "/v1beta/{parent=projects/*/locations/*}/clusters:restore"
}
]
},
{
- "shortName": "LookupStudy",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.LookupStudy",
+ "shortName": "UpdateBackup",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.UpdateBackup",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{parent=projects/*/locations/*}/studies:lookup"
+ "httpMethod": "PATCH",
+ "path": "/v1beta/{backup.name=projects/*/locations/*/backups/*}"
}
]
},
{
- "shortName": "StopTrial",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.StopTrial",
+ "shortName": "UpdateCluster",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.UpdateCluster",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{name=projects/*/locations/*/studies/*/trials/*}:stop"
+ "httpMethod": "PATCH",
+ "path": "/v1beta/{cluster.name=projects/*/locations/*/clusters/*}"
}
]
},
{
- "shortName": "SuggestTrials",
- "fullName": "google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials",
+ "shortName": "UpdateInstance",
+ "fullName": "google.cloud.alloydb.v1beta.AlloyDBAdmin.UpdateInstance",
"mode": "UNARY",
"bindings": [
{
- "httpMethod": "POST",
- "path": "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials:suggest"
+ "httpMethod": "PATCH",
+ "path": "/v1beta/{instance.name=projects/*/locations/*/clusters/*/instances/*}"
}
]
}
]
}
],
- "configFile": "aiplatform_v1beta1.yaml",
+ "configFile": "alloydb_v1beta.yaml",
"serviceConfigApiNames": [
- "google.cloud.aiplatform.v1beta1.DatasetService",
- "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService",
- "google.cloud.aiplatform.v1beta1.EndpointService",
- "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService",
- "google.cloud.aiplatform.v1beta1.FeaturestoreService",
- "google.cloud.aiplatform.v1beta1.IndexEndpointService",
- "google.cloud.aiplatform.v1beta1.IndexService",
- "google.cloud.aiplatform.v1beta1.JobService",
- "google.cloud.aiplatform.v1beta1.MetadataService",
- "google.cloud.aiplatform.v1beta1.MigrationService",
- "google.cloud.aiplatform.v1beta1.ModelService",
- "google.cloud.aiplatform.v1beta1.PipelineService",
- "google.cloud.aiplatform.v1beta1.PredictionService",
- "google.cloud.aiplatform.v1beta1.SpecialistPoolService",
- "google.cloud.aiplatform.v1beta1.TensorboardService",
- "google.cloud.aiplatform.v1beta1.VizierService",
+ "google.cloud.alloydb.v1beta.AlloyDBAdmin",
"google.cloud.location.Locations",
"google.iam.v1.IAMPolicy",
"google.longrunning.Operations"
],
- "nameInServiceConfig": "aiplatform.googleapis.com"
+ "nameInServiceConfig": "alloydb.googleapis.com"
},
{
"id": "google.cloud.apigateway.v1",
@@ -17366,7 +19054,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/apigateway/v1;apigateway": 2
+ "cloud.google.com/go/apigateway/apiv1/apigatewaypb;apigatewaypb": 2
}
},
"java_multiple_files": {
@@ -17590,7 +19278,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/apigeeconnect/v1;apigeeconnect": 2
+ "cloud.google.com/go/apigeeconnect/apiv1/apigeeconnectpb;apigeeconnectpb": 2
}
},
"java_multiple_files": {
@@ -17673,7 +19361,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/apigeeregistry/v1;apigeeregistry": 3
+ "cloud.google.com/go/apigeeregistry/apiv1/apigeeregistrypb;apigeeregistrypb": 3
}
},
"java_multiple_files": {
@@ -18242,7 +19930,7 @@
"majorVersion": "v1",
"hostName": "cloudasset.googleapis.com",
"title": "Cloud Asset API",
- "description": "The cloud asset API manages the history and inventory of cloud resources.",
+ "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.",
"importDirectories": [
"google/api",
"google/cloud/asset/v1",
@@ -18269,7 +19957,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/asset/v1;asset": 2
+ "cloud.google.com/go/asset/apiv1/assetpb;assetpb": 2
}
},
"java_multiple_files": {
@@ -18326,6 +20014,39 @@
}
]
},
+ {
+ "shortName": "AnalyzeOrgPolicies",
+ "fullName": "google.cloud.asset.v1.AssetService.AnalyzeOrgPolicies",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{scope=*/*}:analyzeOrgPolicies"
+ }
+ ]
+ },
+ {
+ "shortName": "AnalyzeOrgPolicyGovernedAssets",
+ "fullName": "google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedAssets",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{scope=*/*}:analyzeOrgPolicyGovernedAssets"
+ }
+ ]
+ },
+ {
+ "shortName": "AnalyzeOrgPolicyGovernedContainers",
+ "fullName": "google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedContainers",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{scope=*/*}:analyzeOrgPolicyGovernedContainers"
+ }
+ ]
+ },
{
"shortName": "BatchGetAssetsHistory",
"fullName": "google.cloud.asset.v1.AssetService.BatchGetAssetsHistory",
@@ -18530,7 +20251,7 @@
"majorVersion": "v1",
"hostName": "cloudasset.googleapis.com",
"title": "Cloud Asset API",
- "description": "The cloud asset API manages the history and inventory of cloud resources.",
+ "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.",
"importDirectories": [
"google/api",
"google/cloud/asset/v1p1beta1",
@@ -18550,7 +20271,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/asset/v1p1beta1;asset": 2
+ "cloud.google.com/go/asset/apiv1p1beta1/assetpb;assetpb": 2
}
},
"java_multiple_files": {
@@ -18601,7 +20322,8 @@
],
"configFile": "cloudasset_v1p1beta1.yaml",
"serviceConfigApiNames": [
- "google.cloud.asset.v1p1beta1.AssetService"
+ "google.cloud.asset.v1p1beta1.AssetService",
+ "google.longrunning.Operations"
],
"nameInServiceConfig": "cloudasset.googleapis.com"
},
@@ -18634,7 +20356,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1;asset": 2
+ "cloud.google.com/go/asset/apiv1p2beta1/assetpb;assetpb": 2
}
},
"java_multiple_files": {
@@ -18729,7 +20451,7 @@
"majorVersion": "v1",
"hostName": "cloudasset.googleapis.com",
"title": "Cloud Asset API",
- "description": "The cloud asset API manages the history and inventory of cloud resources.",
+ "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.",
"importDirectories": [
"google/api",
"google/cloud/asset/v1p5beta1",
@@ -18753,7 +20475,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/asset/v1p5beta1;asset": 2
+ "cloud.google.com/go/asset/apiv1p5beta1/assetpb;assetpb": 2
}
},
"java_multiple_files": {
@@ -18793,7 +20515,8 @@
],
"configFile": "cloudasset_v1p5beta1.yaml",
"serviceConfigApiNames": [
- "google.cloud.asset.v1p5beta1.AssetService"
+ "google.cloud.asset.v1p5beta1.AssetService",
+ "google.longrunning.Operations"
],
"nameInServiceConfig": "cloudasset.googleapis.com"
},
@@ -18804,12 +20527,10 @@
"majorVersion": "v1",
"hostName": "cloudasset.googleapis.com",
"title": "Cloud Asset API",
- "description": "The cloud asset API manages the history and inventory of cloud resources.",
+ "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.",
"importDirectories": [
"google/api",
- "google/cloud/asset/v1p7beta1",
"google/cloud/orgpolicy/v1",
- "google/cloud/osconfig/v1",
"google/iam/v1",
"google/identity/accesscontextmanager/v1",
"google/longrunning",
@@ -18829,7 +20550,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/asset/v1p7beta1;asset": 2
+ "cloud.google.com/go/asset/apiv1p7beta1/assetpb;assetpb": 2
}
},
"java_multiple_files": {
@@ -18869,7 +20590,8 @@
],
"configFile": "cloudasset_v1p7beta1.yaml",
"serviceConfigApiNames": [
- "google.cloud.asset.v1p7beta1.AssetService"
+ "google.cloud.asset.v1p7beta1.AssetService",
+ "google.longrunning.Operations"
],
"nameInServiceConfig": "cloudasset.googleapis.com"
},
@@ -18894,7 +20616,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/assuredworkloads/v1;assuredworkloads": 1
+ "cloud.google.com/go/assuredworkloads/apiv1/assuredworkloadspb;assuredworkloadspb": 1
}
},
"java_multiple_files": {
@@ -19036,7 +20758,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/assuredworkloads/v1beta1;assuredworkloads": 2
+ "cloud.google.com/go/assuredworkloads/apiv1beta1/assuredworkloadspb;assuredworkloadspb": 2
}
},
"java_multiple_files": {
@@ -19151,7 +20873,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/automl/v1;automl": 19
+ "cloud.google.com/go/automl/apiv1/automlpb;automlpb": 19
}
},
"java_multiple_files": {
@@ -19434,7 +21156,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl": 28
+ "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb": 28
}
},
"java_multiple_files": {
@@ -19788,7 +21510,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/baremetalsolution/v2;baremetalsolution": 6
+ "cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb;baremetalsolutionpb": 6
}
},
"java_multiple_files": {
@@ -20071,7 +21793,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/batch/v1;batch": 4
+ "cloud.google.com/go/batch/apiv1/batchpb;batchpb": 4
}
},
"java_multiple_files": {
@@ -20178,7 +21900,6 @@
"serviceConfigApiNames": [
"google.cloud.batch.v1.BatchService",
"google.cloud.location.Locations",
- "google.iam.v1.IAMPolicy",
"google.longrunning.Operations"
],
"nameInServiceConfig": "batch.googleapis.com"
@@ -20205,7 +21926,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/batch/v1alpha;batch": 4
+ "cloud.google.com/go/batch/apiv1alpha/batchpb;batchpb": 4
}
},
"java_multiple_files": {
@@ -20312,7 +22033,6 @@
"serviceConfigApiNames": [
"google.cloud.batch.v1alpha.BatchService",
"google.cloud.location.Locations",
- "google.iam.v1.IAMPolicy",
"google.longrunning.Operations"
],
"nameInServiceConfig": "batch.googleapis.com"
@@ -20338,7 +22058,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/beyondcorp/appconnections/v1;appconnections": 1
+ "cloud.google.com/go/beyondcorp/appconnections/apiv1/appconnectionspb;appconnectionspb": 1
}
},
"java_multiple_files": {
@@ -20467,7 +22187,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/beyondcorp/appconnectors/v1;appconnectors": 3
+ "cloud.google.com/go/beyondcorp/appconnectors/apiv1/appconnectorspb;appconnectorspb": 3
}
},
"java_multiple_files": {
@@ -20595,7 +22315,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/beyondcorp/appgateways/v1;appgateways": 1
+ "cloud.google.com/go/beyondcorp/appgateways/apiv1/appgatewayspb;appgatewayspb": 1
}
},
"java_multiple_files": {
@@ -20701,7 +22421,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/beyondcorp/clientconnectorservices/v1;clientconnectorservices": 1
+ "cloud.google.com/go/beyondcorp/clientconnectorservices/apiv1/clientconnectorservicespb;clientconnectorservicespb": 1
}
},
"java_multiple_files": {
@@ -20818,7 +22538,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/beyondcorp/clientgateways/v1;clientgateways": 1
+ "cloud.google.com/go/beyondcorp/clientgateways/apiv1/clientgatewayspb;clientgatewayspb": 1
}
},
"java_multiple_files": {
@@ -20924,7 +22644,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/analyticshub/v1;analyticshub": 1
+ "cloud.google.com/go/bigquery/analyticshub/apiv1/analyticshubpb;analyticshubpb": 1
}
},
"java_multiple_files": {
@@ -21139,6 +22859,247 @@
],
"nameInServiceConfig": "analyticshub.googleapis.com"
},
+ {
+ "id": "google.cloud.bigquery.biglake.v1alpha1",
+ "directory": "google/cloud/bigquery/biglake/v1alpha1",
+ "version": "v1alpha1",
+ "majorVersion": "v1",
+ "hostName": "biglake.googleapis.com",
+ "title": "BigLake API",
+ "description": "The BigLake API provides access to BigLake Metastore, a serverless, fully managed, and highly available metastore for open-source data that can be used for querying Apache Iceberg tables in BigQuery.",
+ "importDirectories": [
+ "google/api",
+ "google/protobuf"
+ ],
+ "options": {
+ "go_package": {
+ "valueCounts": {
+ "cloud.google.com/go/bigquery/biglake/apiv1alpha1/biglakepb;biglakepb": 1
+ }
+ },
+ "java_multiple_files": {
+ "valueCounts": {
+ "true": 1
+ }
+ },
+ "java_package": {
+ "valueCounts": {
+ "com.google.cloud.bigquery.biglake.v1alpha1": 1
+ }
+ }
+ },
+ "services": [
+ {
+ "shortName": "MetastoreService",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService",
+ "methods": [
+ {
+ "shortName": "CheckLock",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.CheckLock",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*/locks/*}:check"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateCatalog",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.CreateCatalog",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha1/{parent=projects/*/locations/*}/catalogs"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateDatabase",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.CreateDatabase",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha1/{parent=projects/*/locations/*/catalogs/*}/databases"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateLock",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.CreateLock",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha1/{parent=projects/*/locations/*/catalogs/*/databases/*}/locks"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateTable",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.CreateTable",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha1/{parent=projects/*/locations/*/catalogs/*/databases/*}/tables"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteCatalog",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.DeleteCatalog",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1alpha1/{name=projects/*/locations/*/catalogs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteDatabase",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.DeleteDatabase",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteLock",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.DeleteLock",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*/locks/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteTable",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.DeleteTable",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*/tables/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetCatalog",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.GetCatalog",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha1/{name=projects/*/locations/*/catalogs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetDatabase",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.GetDatabase",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetTable",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.GetTable",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*/tables/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "ListCatalogs",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.ListCatalogs",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha1/{parent=projects/*/locations/*}/catalogs"
+ }
+ ]
+ },
+ {
+ "shortName": "ListDatabases",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.ListDatabases",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha1/{parent=projects/*/locations/*/catalogs/*}/databases"
+ }
+ ]
+ },
+ {
+ "shortName": "ListLocks",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.ListLocks",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha1/{parent=projects/*/locations/*/catalogs/*/databases/*}/locks"
+ }
+ ]
+ },
+ {
+ "shortName": "ListTables",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.ListTables",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1alpha1/{parent=projects/*/locations/*/catalogs/*/databases/*}/tables"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateDatabase",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.UpdateDatabase",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1alpha1/{database.name=projects/*/locations/*/catalogs/*/databases/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateTable",
+ "fullName": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService.UpdateTable",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1alpha1/{table.name=projects/*/locations/*/catalogs/*/databases/*/tables/*}"
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "configFile": "biglake_v1alpha1.yaml",
+ "serviceConfigApiNames": [
+ "google.cloud.bigquery.biglake.v1alpha1.MetastoreService"
+ ],
+ "nameInServiceConfig": "biglake.googleapis.com"
+ },
{
"id": "google.cloud.bigquery.connection.v1",
"directory": "google/cloud/bigquery/connection/v1",
@@ -21160,7 +23121,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1;connection": 1
+ "cloud.google.com/go/bigquery/connection/apiv1/connectionpb;connectionpb": 1
}
},
"java_multiple_files": {
@@ -21302,7 +23263,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1;connection": 1
+ "cloud.google.com/go/bigquery/connection/apiv1beta1/connectionpb;connectionpb": 1
}
},
"java_package": {
@@ -21450,7 +23411,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/dataexchange/v1beta1;dataexchange": 1
+ "cloud.google.com/go/bigquery/dataexchange/apiv1beta1/dataexchangepb;dataexchangepb": 1
}
},
"java_multiple_files": {
@@ -21687,7 +23648,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/datapolicies/v1;datapolicies": 1
+ "cloud.google.com/go/bigquery/datapolicies/apiv1/datapoliciespb;datapoliciespb": 1
}
},
"java_multiple_files": {
@@ -21845,7 +23806,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/datapolicies/v1beta1;datapolicies": 1
+ "cloud.google.com/go/bigquery/datapolicies/apiv1beta1/datapoliciespb;datapoliciespb": 1
}
},
"java_multiple_files": {
@@ -21993,7 +23954,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1;datatransfer": 2
+ "cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb;datatransferpb": 2
}
},
"java_multiple_files": {
@@ -22285,7 +24246,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2;migration": 5
+ "cloud.google.com/go/bigquery/migration/apiv2/migrationpb;migrationpb": 5
}
},
"java_multiple_files": {
@@ -22417,7 +24378,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha;migration": 7
+ "cloud.google.com/go/bigquery/migration/apiv2alpha/migrationpb;migrationpb": 7
}
},
"java_multiple_files": {
@@ -22566,7 +24527,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/reservation/v1;reservation": 1
+ "cloud.google.com/go/bigquery/reservation/apiv1/reservationpb;reservationpb": 1
}
},
"java_multiple_files": {
@@ -22852,7 +24813,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1;storage": 7
+ "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb": 7
}
},
"java_multiple_files": {
@@ -23007,7 +24968,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta1;storage": 5
+ "cloud.google.com/go/bigquery/storage/apiv1beta1/storagepb;storagepb": 5
}
},
"java_package": {
@@ -23106,7 +25067,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta2;storage": 6
+ "cloud.google.com/go/bigquery/storage/apiv1beta2/storagepb;storagepb": 6
}
},
"java_multiple_files": {
@@ -23256,7 +25217,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/bigquery/v2;bigquery": 5
+ "cloud.google.com/go/bigquery/apiv2/bigquerypb;bigquerypb": 5
}
},
"java_package": {
@@ -23340,7 +25301,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/billing/budgets/v1;budgets": 2
+ "cloud.google.com/go/billing/budgets/apiv1/budgetspb;budgetspb": 2
}
},
"java_multiple_files": {
@@ -23440,7 +25401,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/billing/budgets/v1beta1;budgets": 2
+ "cloud.google.com/go/billing/budgets/apiv1beta1/budgetspb;budgetspb": 2
}
},
"java_multiple_files": {
@@ -23546,7 +25507,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/billing/v1;billing": 2
+ "cloud.google.com/go/billing/apiv1/billingpb;billingpb": 2
}
},
"java_multiple_files": {
@@ -23746,7 +25707,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/binaryauthorization/v1;binaryauthorization": 2
+ "cloud.google.com/go/binaryauthorization/apiv1/binaryauthorizationpb;binaryauthorizationpb": 2
}
},
"java_multiple_files": {
@@ -23923,7 +25884,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/binaryauthorization/v1beta1;binaryauthorization": 3
+ "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb;binaryauthorizationpb": 3
}
},
"java_multiple_files": {
@@ -24078,7 +26039,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/certificatemanager/v1;certificatemanager": 2
+ "cloud.google.com/go/certificatemanager/apiv1/certificatemanagerpb;certificatemanagerpb": 2
}
},
"java_multiple_files": {
@@ -24400,7 +26361,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/channel/v1;channel": 11
+ "cloud.google.com/go/channel/apiv1/channelpb;channelpb": 11
}
},
"java_multiple_files": {
@@ -25011,7 +26972,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/clouddms/v1;clouddms": 2
+ "cloud.google.com/go/clouddms/apiv1/clouddmspb;clouddmspb": 2
}
},
"java_multiple_files": {
@@ -25253,7 +27214,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/commerce/consumer/procurement/v1alpha1;procurement": 2
+ "cloud.google.com/go/commerce/consumer/procurement/apiv1alpha1/procurementpb;procurementpb": 2
}
},
"java_multiple_files": {
@@ -33569,7 +35530,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/connectors/v1;connectors": 9
+ "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb": 9
}
},
"java_multiple_files": {
@@ -33789,7 +35750,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/contactcenterinsights/v1;contactcenterinsights": 2
+ "cloud.google.com/go/contactcenterinsights/apiv1/contactcenterinsightspb;contactcenterinsightspb": 2
}
},
"java_multiple_files": {
@@ -34254,7 +36215,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse": 16
+ "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb": 16
}
},
"java_multiple_files": {
@@ -34617,6 +36578,242 @@
],
"nameInServiceConfig": "contentwarehouse.googleapis.com"
},
+ {
+ "id": "google.cloud.datacatalog.lineage.v1",
+ "directory": "google/cloud/datacatalog/lineage/v1",
+ "version": "v1",
+ "majorVersion": "v1",
+ "hostName": "datalineage.googleapis.com",
+ "title": "Data Lineage API",
+ "description": "",
+ "importDirectories": [
+ "google/api",
+ "google/longrunning",
+ "google/protobuf"
+ ],
+ "options": {
+ "csharp_namespace": {
+ "valueCounts": {
+ "Google.Cloud.DataCatalog.Lineage.V1": 1
+ }
+ },
+ "go_package": {
+ "valueCounts": {
+ "cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb;lineagepb": 1
+ }
+ },
+ "java_multiple_files": {
+ "valueCounts": {
+ "true": 1
+ }
+ },
+ "java_package": {
+ "valueCounts": {
+ "com.google.cloud.datacatalog.lineage.v1": 1
+ }
+ },
+ "php_namespace": {
+ "valueCounts": {
+ "Google\\Cloud\\DataCatalog\\Lineage\\V1": 1
+ }
+ },
+ "ruby_package": {
+ "valueCounts": {
+ "Google::Cloud::DataCatalog::Lineage::V1": 1
+ }
+ }
+ },
+ "services": [
+ {
+ "shortName": "Lineage",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage",
+ "methods": [
+ {
+ "shortName": "BatchSearchLinkProcesses",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*}:batchSearchLinkProcesses"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateLineageEvent",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.CreateLineageEvent",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*/processes/*/runs/*}/lineageEvents"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateProcess",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.CreateProcess",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*}/processes"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateRun",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.CreateRun",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*/processes/*}/runs"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteLineageEvent",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.DeleteLineageEvent",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/locations/*/processes/*/runs/*/lineageEvents/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteProcess",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.DeleteProcess",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/locations/*/processes/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteRun",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.DeleteRun",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/locations/*/processes/*/runs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetLineageEvent",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.GetLineageEvent",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/processes/*/runs/*/lineageEvents/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetProcess",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.GetProcess",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/processes/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetRun",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.GetRun",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/processes/*/runs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "ListLineageEvents",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.ListLineageEvents",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*/processes/*/runs/*}/lineageEvents"
+ }
+ ]
+ },
+ {
+ "shortName": "ListProcesses",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.ListProcesses",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*}/processes"
+ }
+ ]
+ },
+ {
+ "shortName": "ListRuns",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.ListRuns",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*/processes/*}/runs"
+ }
+ ]
+ },
+ {
+ "shortName": "SearchLinks",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*}:searchLinks"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateProcess",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.UpdateProcess",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1/{process.name=projects/*/locations/*/processes/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateRun",
+ "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.UpdateRun",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1/{run.name=projects/*/locations/*/processes/*/runs/*}"
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "configFile": "datalineage_v1.yaml",
+ "serviceConfigApiNames": [
+ "google.cloud.datacatalog.lineage.v1.Lineage",
+ "google.longrunning.Operations"
+ ],
+ "nameInServiceConfig": "datalineage.googleapis.com"
+ },
{
"id": "google.cloud.datacatalog.v1",
"directory": "google/cloud/datacatalog/v1",
@@ -34644,7 +36841,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog": 15
+ "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb": 15
}
},
"java_multiple_files": {
@@ -35301,7 +37498,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1;datacatalog": 10
+ "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb;datacatalogpb": 10
}
},
"java_multiple_files": {
@@ -35884,7 +38081,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/dataform/v1alpha2;dataform": 1
+ "cloud.google.com/go/dataform/apiv1alpha2/dataformpb;dataformpb": 1
}
},
"java_multiple_files": {
@@ -36341,7 +38538,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/dataform/v1beta1;dataform": 1
+ "cloud.google.com/go/dataform/apiv1beta1/dataformpb;dataformpb": 1
}
},
"java_multiple_files": {
@@ -36798,7 +38995,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/datafusion/v1;datafusion": 1
+ "cloud.google.com/go/datafusion/apiv1/datafusionpb;datafusionpb": 1
}
},
"java_multiple_files": {
@@ -36936,7 +39133,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/datafusion/v1beta1;datafusion": 1
+ "cloud.google.com/go/datafusion/apiv1beta1/datafusionpb;datafusionpb": 1
}
},
"java_multiple_files": {
@@ -37140,7 +39337,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1;datalabeling": 10
+ "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb;datalabelingpb": 10
}
},
"java_multiple_files": {
@@ -37570,17 +39767,17 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/dataplex/v1;dataplex": 7
+ "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb": 11
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 7
+ "true": 11
}
},
"java_package": {
"valueCounts": {
- "com.google.cloud.dataplex.v1": 7
+ "com.google.cloud.dataplex.v1": 11
}
}
},
@@ -37711,6 +39908,100 @@
}
]
},
+ {
+ "shortName": "DataScanService",
+ "fullName": "google.cloud.dataplex.v1.DataScanService",
+ "methods": [
+ {
+ "shortName": "CreateDataScan",
+ "fullName": "google.cloud.dataplex.v1.DataScanService.CreateDataScan",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*}/dataScans"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteDataScan",
+ "fullName": "google.cloud.dataplex.v1.DataScanService.DeleteDataScan",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/locations/*/dataScans/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetDataScan",
+ "fullName": "google.cloud.dataplex.v1.DataScanService.GetDataScan",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/dataScans/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetDataScanJob",
+ "fullName": "google.cloud.dataplex.v1.DataScanService.GetDataScanJob",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/dataScans/*/jobs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "ListDataScanJobs",
+ "fullName": "google.cloud.dataplex.v1.DataScanService.ListDataScanJobs",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*/dataScans/*}/jobs"
+ }
+ ]
+ },
+ {
+ "shortName": "ListDataScans",
+ "fullName": "google.cloud.dataplex.v1.DataScanService.ListDataScans",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*}/dataScans"
+ }
+ ]
+ },
+ {
+ "shortName": "RunDataScan",
+ "fullName": "google.cloud.dataplex.v1.DataScanService.RunDataScan",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{name=projects/*/locations/*/dataScans/*}:run"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateDataScan",
+ "fullName": "google.cloud.dataplex.v1.DataScanService.UpdateDataScan",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1/{data_scan.name=projects/*/locations/*/dataScans/*}"
+ }
+ ]
+ }
+ ]
+ },
{
"shortName": "DataplexService",
"fullName": "google.cloud.dataplex.v1.DataplexService",
@@ -38178,6 +40469,7 @@
"configFile": "dataplex_v1.yaml",
"serviceConfigApiNames": [
"google.cloud.dataplex.v1.ContentService",
+ "google.cloud.dataplex.v1.DataScanService",
"google.cloud.dataplex.v1.DataplexService",
"google.cloud.dataplex.v1.MetadataService",
"google.cloud.location.Locations",
@@ -38203,7 +40495,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/dataproc/v1;dataproc": 8
+ "cloud.google.com/go/dataproc/apiv1/dataprocpb;dataprocpb": 8
}
},
"java_multiple_files": {
@@ -38684,7 +40976,9 @@
"google.cloud.dataproc.v1.ClusterController",
"google.cloud.dataproc.v1.JobController",
"google.cloud.dataproc.v1.NodeGroupController",
- "google.cloud.dataproc.v1.WorkflowTemplateService"
+ "google.cloud.dataproc.v1.WorkflowTemplateService",
+ "google.iam.v1.IAMPolicy",
+ "google.longrunning.Operations"
],
"nameInServiceConfig": "dataproc.googleapis.com"
},
@@ -38710,7 +41004,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/dataqna/v1alpha;dataqna": 5
+ "cloud.google.com/go/dataqna/apiv1alpha/dataqnapb;dataqnapb": 5
}
},
"java_multiple_files": {
@@ -38843,7 +41137,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/datastream/v1;datastream": 2
+ "cloud.google.com/go/datastream/apiv1/datastreampb;datastreampb": 2
}
},
"java_multiple_files": {
@@ -39181,7 +41475,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1;datastream": 2
+ "cloud.google.com/go/datastream/apiv1alpha1/datastreampb;datastreampb": 2
}
},
"java_multiple_files": {
@@ -39468,7 +41762,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/deploy/v1;deploy": 8
+ "cloud.google.com/go/deploy/apiv1/deploypb;deploypb": 8
}
},
"java_multiple_files": {
@@ -39760,37 +42054,37 @@
"options": {
"cc_enable_arenas": {
"valueCounts": {
- "true": 21
+ "true": 22
}
},
"csharp_namespace": {
"valueCounts": {
- "Google.Cloud.Dialogflow.Cx.V3": 21
+ "Google.Cloud.Dialogflow.Cx.V3": 22
}
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3;cx": 21
+ "cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb": 22
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 21
+ "true": 22
}
},
"java_package": {
"valueCounts": {
- "com.google.cloud.dialogflow.cx.v3": 21
+ "com.google.cloud.dialogflow.cx.v3": 22
}
},
"objc_class_prefix": {
"valueCounts": {
- "DF": 21
+ "DF": 22
}
},
"ruby_package": {
"valueCounts": {
- "Google::Cloud::Dialogflow::CX::V3": 21
+ "Google::Cloud::Dialogflow::CX::V3": 22
}
}
},
@@ -41027,37 +43321,37 @@
"options": {
"cc_enable_arenas": {
"valueCounts": {
- "true": 21
+ "true": 22
}
},
"csharp_namespace": {
"valueCounts": {
- "Google.Cloud.Dialogflow.Cx.V3Beta1": 21
+ "Google.Cloud.Dialogflow.Cx.V3Beta1": 22
}
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3beta1;cx": 21
+ "cloud.google.com/go/dialogflow/cx/apiv3beta1/cxpb;cxpb": 22
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 21
+ "true": 22
}
},
"java_package": {
"valueCounts": {
- "com.google.cloud.dialogflow.cx.v3beta1": 21
+ "com.google.cloud.dialogflow.cx.v3beta1": 22
}
},
"objc_class_prefix": {
"valueCounts": {
- "DF": 21
+ "DF": 22
}
},
"ruby_package": {
"valueCounts": {
- "Google::Cloud::Dialogflow::CX::V3beta1": 21
+ "Google::Cloud::Dialogflow::CX::V3beta1": 22
}
}
},
@@ -42304,7 +44598,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/dialogflow/v2;dialogflow": 23
+ "cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb": 23
}
},
"java_multiple_files": {
@@ -43044,6 +45338,21 @@
"path": "/v2/{parent=projects/*/locations/*/conversations/*}/messages"
}
]
+ },
+ {
+ "shortName": "SuggestConversationSummary",
+ "fullName": "google.cloud.dialogflow.v2.Conversations.SuggestConversationSummary",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v2/{conversation=projects/*/conversations/*}/suggestions:suggestConversationSummary"
+ },
+ {
+ "httpMethod": "POST",
+ "path": "/v2/{conversation=projects/*/locations/*/conversations/*}/suggestions:suggestConversationSummary"
+ }
+ ]
}
]
},
@@ -44121,12 +46430,12 @@
},
"csharp_namespace": {
"valueCounts": {
- "Google.Cloud.Dialogflow.V2beta1": 21
+ "Google.Cloud.Dialogflow.V2Beta1": 21
}
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/dialogflow/v2beta1;dialogflow": 21
+ "cloud.google.com/go/dialogflow/apiv2beta1/dialogflowpb;dialogflowpb": 21
}
},
"java_multiple_files": {
@@ -45783,7 +48092,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/discoveryengine/v1beta;discoveryengine": 7
+ "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb": 7
}
},
"java_multiple_files": {
@@ -45970,32 +48279,32 @@
"options": {
"csharp_namespace": {
"valueCounts": {
- "Google.Cloud.DocumentAI.V1": 9
+ "Google.Cloud.DocumentAI.V1": 10
}
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/documentai/v1;documentai": 9
+ "cloud.google.com/go/documentai/apiv1/documentaipb;documentaipb": 10
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 9
+ "true": 10
}
},
"java_package": {
"valueCounts": {
- "com.google.cloud.documentai.v1": 9
+ "com.google.cloud.documentai.v1": 10
}
},
"php_namespace": {
"valueCounts": {
- "Google\\Cloud\\DocumentAI\\V1": 9
+ "Google\\Cloud\\DocumentAI\\V1": 10
}
},
"ruby_package": {
"valueCounts": {
- "Google::Cloud::DocumentAI::V1": 9
+ "Google::Cloud::DocumentAI::V1": 10
}
}
},
@@ -46085,6 +48394,17 @@
}
]
},
+ {
+ "shortName": "EvaluateProcessorVersion",
+ "fullName": "google.cloud.documentai.v1.DocumentProcessorService.EvaluateProcessorVersion",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{processor_version=projects/*/locations/*/processors/*/processorVersions/*}:evaluateProcessorVersion"
+ }
+ ]
+ },
{
"shortName": "FetchProcessorTypes",
"fullName": "google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes",
@@ -46096,6 +48416,17 @@
}
]
},
+ {
+ "shortName": "GetEvaluation",
+ "fullName": "google.cloud.documentai.v1.DocumentProcessorService.GetEvaluation",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/processors/*/processorVersions/*/evaluations/*}"
+ }
+ ]
+ },
{
"shortName": "GetProcessor",
"fullName": "google.cloud.documentai.v1.DocumentProcessorService.GetProcessor",
@@ -46107,6 +48438,17 @@
}
]
},
+ {
+ "shortName": "GetProcessorType",
+ "fullName": "google.cloud.documentai.v1.DocumentProcessorService.GetProcessorType",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/processorTypes/*}"
+ }
+ ]
+ },
{
"shortName": "GetProcessorVersion",
"fullName": "google.cloud.documentai.v1.DocumentProcessorService.GetProcessorVersion",
@@ -46118,6 +48460,17 @@
}
]
},
+ {
+ "shortName": "ListEvaluations",
+ "fullName": "google.cloud.documentai.v1.DocumentProcessorService.ListEvaluations",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*/processors/*/processorVersions/*}/evaluations"
+ }
+ ]
+ },
{
"shortName": "ListProcessorTypes",
"fullName": "google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes",
@@ -46188,6 +48541,17 @@
}
]
},
+ {
+ "shortName": "TrainProcessorVersion",
+ "fullName": "google.cloud.documentai.v1.DocumentProcessorService.TrainProcessorVersion",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*/processors/*}/processorVersions:train"
+ }
+ ]
+ },
{
"shortName": "UndeployProcessorVersion",
"fullName": "google.cloud.documentai.v1.DocumentProcessorService.UndeployProcessorVersion",
@@ -46234,7 +48598,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/documentai/v1beta2;documentai": 3
+ "cloud.google.com/go/documentai/apiv1beta2/documentaipb;documentaipb": 3
}
},
"java_multiple_files": {
@@ -46326,7 +48690,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/documentai/v1beta3;documentai": 10
+ "cloud.google.com/go/documentai/apiv1beta3/documentaipb;documentaipb": 10
}
},
"java_multiple_files": {
@@ -46480,6 +48844,17 @@
}
]
},
+ {
+ "shortName": "GetProcessorType",
+ "fullName": "google.cloud.documentai.v1beta3.DocumentProcessorService.GetProcessorType",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta3/{name=projects/*/locations/*/processorTypes/*}"
+ }
+ ]
+ },
{
"shortName": "GetProcessorVersion",
"fullName": "google.cloud.documentai.v1beta3.DocumentProcessorService.GetProcessorVersion",
@@ -46622,7 +48997,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/domains/v1;domains": 1
+ "cloud.google.com/go/domains/apiv1/domainspb;domainspb": 1
}
},
"java_multiple_files": {
@@ -46832,7 +49207,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/domains/v1alpha2;domains": 1
+ "cloud.google.com/go/domains/apiv1alpha2/domainspb;domainspb": 1
}
},
"java_multiple_files": {
@@ -47042,7 +49417,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/domains/v1beta1;domains": 1
+ "cloud.google.com/go/domains/apiv1beta1/domainspb;domainspb": 1
}
},
"java_multiple_files": {
@@ -47253,7 +49628,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/edgecontainer/v1;edgecontainer": 2
+ "cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb;edgecontainerpb": 2
}
},
"java_multiple_files": {
@@ -47492,7 +49867,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/enterpriseknowledgegraph/v1;enterpriseknowledgegraph": 3
+ "cloud.google.com/go/enterpriseknowledgegraph/apiv1/enterpriseknowledgegraphpb;enterpriseknowledgegraphpb": 3
}
},
"java_multiple_files": {
@@ -47651,7 +50026,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/essentialcontacts/v1;essentialcontacts": 2
+ "cloud.google.com/go/essentialcontacts/apiv1/essentialcontactspb;essentialcontactspb": 2
}
},
"java_multiple_files": {
@@ -47842,7 +50217,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/eventarc/publishing/v1;publisher": 1
+ "cloud.google.com/go/eventarc/publishing/apiv1/publishingpb;publishingpb": 1
}
},
"java_multiple_files": {
@@ -47926,7 +50301,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/eventarc/v1;eventarc": 6
+ "cloud.google.com/go/eventarc/apiv1/eventarcpb;eventarcpb": 6
}
},
"java_multiple_files": {
@@ -48189,7 +50564,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/filestore/v1;filestore": 1
+ "cloud.google.com/go/filestore/apiv1/filestorepb;filestorepb": 1
}
},
"java_multiple_files": {
@@ -48365,7 +50740,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/filestore/v1beta1;filestore": 1
+ "cloud.google.com/go/filestore/apiv1beta1/filestorepb;filestorepb": 1
}
},
"java_multiple_files": {
@@ -48659,7 +51034,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/functions/v1;functions": 2
+ "cloud.google.com/go/functions/apiv1/functionspb;functionspb": 2
}
},
"java_multiple_files": {
@@ -48830,7 +51205,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/functions/v2;functions": 1
+ "cloud.google.com/go/functions/apiv2/functionspb;functionspb": 1
}
},
"java_multiple_files": {
@@ -48970,7 +51345,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/functions/v2alpha;functions": 1
+ "cloud.google.com/go/functions/apiv2alpha/functionspb;functionspb": 1
}
},
"java_multiple_files": {
@@ -49110,7 +51485,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/functions/v2beta;functions": 1
+ "cloud.google.com/go/functions/apiv2beta/functionspb;functionspb": 1
}
},
"java_multiple_files": {
@@ -49251,7 +51626,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gaming/v1;gaming": 9
+ "cloud.google.com/go/gaming/apiv1/gamingpb;gamingpb": 9
}
},
"java_multiple_files": {
@@ -49614,7 +51989,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gaming/v1beta;gaming": 9
+ "cloud.google.com/go/gaming/apiv1beta/gamingpb;gamingpb": 9
}
},
"java_multiple_files": {
@@ -49988,7 +52363,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gkebackup/v1;gkebackup": 7
+ "cloud.google.com/go/gkebackup/apiv1/gkebackuppb;gkebackuppb": 7
}
},
"java_multiple_files": {
@@ -50309,7 +52684,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gkeconnect/gateway/v1;gateway": 1
+ "cloud.google.com/go/gkeconnect/gateway/apiv1/gatewaypb;gatewaypb": 1
}
},
"java_multiple_files": {
@@ -50364,7 +52739,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gkeconnect/gateway/v1alpha1;gateway": 1
+ "cloud.google.com/go/gkeconnect/gateway/apiv1alpha1/gatewaypb;gatewaypb": 1
}
},
"java_multiple_files": {
@@ -50419,7 +52794,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gkeconnect/gateway/v1beta1;gateway": 1
+ "cloud.google.com/go/gkeconnect/gateway/apiv1beta1/gatewaypb;gatewaypb": 1
}
},
"java_multiple_files": {
@@ -50538,9 +52913,9 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gkehub/configmanagement/v1;configmanagement": 1,
- "google.golang.org/genproto/googleapis/cloud/gkehub/multiclusteringress/v1;multiclusteringress": 1,
- "google.golang.org/genproto/googleapis/cloud/gkehub/v1;gkehub": 3
+ "cloud.google.com/go/gkehub/apiv1/gkehubpb;gkehubpb": 3,
+ "cloud.google.com/go/gkehub/configmanagement/apiv1/configmanagementpb;configmanagementpb": 1,
+ "cloud.google.com/go/gkehub/multiclusteringress/apiv1/multiclusteringresspb;multiclusteringresspb": 1
}
},
"java_multiple_files": {
@@ -50737,12 +53112,12 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gkehub/cloudauditlogging/v1alpha;cloudauditlogging": 1,
- "google.golang.org/genproto/googleapis/cloud/gkehub/configmanagement/v1alpha;configmanagement": 1,
- "google.golang.org/genproto/googleapis/cloud/gkehub/metering/v1alpha;metering": 1,
- "google.golang.org/genproto/googleapis/cloud/gkehub/multiclusteringress/v1alpha;multiclusteringress": 1,
- "google.golang.org/genproto/googleapis/cloud/gkehub/servicemesh/v1alpha;servicemesh": 1,
- "google.golang.org/genproto/googleapis/cloud/gkehub/v1alpha;gkehub": 2
+ "cloud.google.com/go/gkehub/apiv1alpha/gkehubpb;gkehubpb": 2,
+ "cloud.google.com/go/gkehub/cloudauditlogging/apiv1alpha/cloudauditloggingpb;cloudauditloggingpb": 1,
+ "cloud.google.com/go/gkehub/configmanagement/apiv1alpha/configmanagementpb;configmanagementpb": 1,
+ "cloud.google.com/go/gkehub/metering/apiv1alpha/meteringpb;meteringpb": 1,
+ "cloud.google.com/go/gkehub/multiclusteringress/apiv1alpha/multiclusteringresspb;multiclusteringresspb": 1,
+ "cloud.google.com/go/gkehub/servicemesh/apiv1alpha/servicemeshpb;servicemeshpb": 1
}
},
"java_multiple_files": {
@@ -50871,7 +53246,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gkehub/v1alpha2;gkehub": 1
+ "cloud.google.com/go/gkehub/apiv1alpha2/gkehubpb;gkehubpb": 1
}
},
"java_multiple_files": {
@@ -51014,10 +53389,10 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gkehub/configmanagement/v1beta;configmanagement": 1,
- "google.golang.org/genproto/googleapis/cloud/gkehub/metering/v1beta;metering": 1,
- "google.golang.org/genproto/googleapis/cloud/gkehub/multiclusteringress/v1beta;multiclusteringress": 1,
- "google.golang.org/genproto/googleapis/cloud/gkehub/v1beta;gkehub": 2
+ "cloud.google.com/go/gkehub/apiv1beta/gkehubpb;gkehubpb": 2,
+ "cloud.google.com/go/gkehub/configmanagement/apiv1beta/configmanagementpb;configmanagementpb": 1,
+ "cloud.google.com/go/gkehub/metering/apiv1beta/meteringpb;meteringpb": 1,
+ "cloud.google.com/go/gkehub/multiclusteringress/apiv1beta/multiclusteringresspb;multiclusteringresspb": 1
}
},
"java_multiple_files": {
@@ -51141,7 +53516,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gkehub/v1beta1;gkehub": 1
+ "cloud.google.com/go/gkehub/apiv1beta1/gkehubpb;gkehubpb": 1
}
},
"java_multiple_files": {
@@ -51287,36 +53662,130 @@
"options": {
"csharp_namespace": {
"valueCounts": {
- "Google.Cloud.GkeMultiCloud.V1": 5
+ "Google.Cloud.GkeMultiCloud.V1": 7
}
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1;gkemulticloud": 5
+ "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb;gkemulticloudpb": 7
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 5
+ "true": 7
}
},
"java_package": {
"valueCounts": {
- "com.google.cloud.gkemulticloud.v1": 5
+ "com.google.cloud.gkemulticloud.v1": 7
}
},
"php_namespace": {
"valueCounts": {
- "Google\\Cloud\\GkeMultiCloud\\V1": 5
+ "Google\\Cloud\\GkeMultiCloud\\V1": 7
}
},
"ruby_package": {
"valueCounts": {
- "Google::Cloud::GkeMultiCloud::V1": 5
+ "Google::Cloud::GkeMultiCloud::V1": 7
}
}
},
"services": [
+ {
+ "shortName": "AttachedClusters",
+ "fullName": "google.cloud.gkemulticloud.v1.AttachedClusters",
+ "methods": [
+ {
+ "shortName": "CreateAttachedCluster",
+ "fullName": "google.cloud.gkemulticloud.v1.AttachedClusters.CreateAttachedCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*}/attachedClusters"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteAttachedCluster",
+ "fullName": "google.cloud.gkemulticloud.v1.AttachedClusters.DeleteAttachedCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/locations/*/attachedClusters/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GenerateAttachedClusterInstallManifest",
+ "fullName": "google.cloud.gkemulticloud.v1.AttachedClusters.GenerateAttachedClusterInstallManifest",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*}:generateAttachedClusterInstallManifest"
+ }
+ ]
+ },
+ {
+ "shortName": "GetAttachedCluster",
+ "fullName": "google.cloud.gkemulticloud.v1.AttachedClusters.GetAttachedCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/attachedClusters/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetAttachedServerConfig",
+ "fullName": "google.cloud.gkemulticloud.v1.AttachedClusters.GetAttachedServerConfig",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/attachedServerConfig}"
+ }
+ ]
+ },
+ {
+ "shortName": "ImportAttachedCluster",
+ "fullName": "google.cloud.gkemulticloud.v1.AttachedClusters.ImportAttachedCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*/locations/*}/attachedClusters:import"
+ }
+ ]
+ },
+ {
+ "shortName": "ListAttachedClusters",
+ "fullName": "google.cloud.gkemulticloud.v1.AttachedClusters.ListAttachedClusters",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*}/attachedClusters"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateAttachedCluster",
+ "fullName": "google.cloud.gkemulticloud.v1.AttachedClusters.UpdateAttachedCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1/{attached_cluster.name=projects/*/locations/*/attachedClusters/*}"
+ }
+ ]
+ }
+ ]
+ },
{
"shortName": "AwsClusters",
"fullName": "google.cloud.gkemulticloud.v1.AwsClusters",
@@ -51640,8 +54109,10 @@
],
"configFile": "gkemulticloud_v1.yaml",
"serviceConfigApiNames": [
+ "google.cloud.gkemulticloud.v1.AttachedClusters",
"google.cloud.gkemulticloud.v1.AwsClusters",
- "google.cloud.gkemulticloud.v1.AzureClusters"
+ "google.cloud.gkemulticloud.v1.AzureClusters",
+ "google.longrunning.Operations"
],
"nameInServiceConfig": "gkemulticloud.googleapis.com"
},
@@ -51672,7 +54143,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/gsuiteaddons/v1;gsuiteaddons": 1
+ "cloud.google.com/go/gsuiteaddons/apiv1/gsuiteaddonspb;gsuiteaddonspb": 1
}
},
"java_multiple_files": {
@@ -51830,7 +54301,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/iap/v1;iap": 1
+ "cloud.google.com/go/iap/apiv1/iappb;iappb": 1
}
},
"java_multiple_files": {
@@ -52088,7 +54559,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/iap/v1beta1;iap": 1
+ "cloud.google.com/go/iap/apiv1beta1/iappb;iappb": 1
}
},
"java_multiple_files": {
@@ -52170,7 +54641,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/identitytoolkit/v2;identitytoolkit": 3
+ "cloud.google.com/go/identitytoolkit/apiv2/identitytoolkitpb;identitytoolkitpb": 3
}
},
"java_multiple_files": {
@@ -52286,7 +54757,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/ids/v1;ids": 1
+ "cloud.google.com/go/ids/apiv1/idspb;idspb": 1
}
},
"java_multiple_files": {
@@ -52386,7 +54857,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/iot/v1;iot": 2
+ "cloud.google.com/go/iot/apiv1/iotpb;iotpb": 2
}
},
"java_multiple_files": {
@@ -52671,6 +55142,105 @@
],
"nameInServiceConfig": "cloudiot.googleapis.com"
},
+ {
+ "id": "google.cloud.kms.inventory.v1",
+ "directory": "google/cloud/kms/inventory/v1",
+ "version": "v1",
+ "majorVersion": "v1",
+ "hostName": "kmsinventory.googleapis.com",
+ "title": "KMS Inventory API",
+ "description": "",
+ "importDirectories": [
+ "google/api",
+ "google/cloud/kms/v1",
+ "google/protobuf"
+ ],
+ "options": {
+ "cc_enable_arenas": {
+ "valueCounts": {
+ "true": 2
+ }
+ },
+ "csharp_namespace": {
+ "valueCounts": {
+ "Google.Cloud.Kms.Inventory.V1": 2
+ }
+ },
+ "go_package": {
+ "valueCounts": {
+ "cloud.google.com/go/kms/inventory/apiv1/inventorypb;inventorypb": 2
+ }
+ },
+ "java_multiple_files": {
+ "valueCounts": {
+ "true": 2
+ }
+ },
+ "java_package": {
+ "valueCounts": {
+ "com.google.cloud.kms.inventory.v1": 2
+ }
+ },
+ "php_namespace": {
+ "valueCounts": {
+ "Google\\Cloud\\Kms\\Inventory\\V1": 2
+ }
+ }
+ },
+ "services": [
+ {
+ "shortName": "KeyDashboardService",
+ "fullName": "google.cloud.kms.inventory.v1.KeyDashboardService",
+ "methods": [
+ {
+ "shortName": "ListCryptoKeys",
+ "fullName": "google.cloud.kms.inventory.v1.KeyDashboardService.ListCryptoKeys",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*}/cryptoKeys"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "shortName": "KeyTrackingService",
+ "fullName": "google.cloud.kms.inventory.v1.KeyTrackingService",
+ "methods": [
+ {
+ "shortName": "GetProtectedResourcesSummary",
+ "fullName": "google.cloud.kms.inventory.v1.KeyTrackingService.GetProtectedResourcesSummary",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/**}/protectedResourcesSummary"
+ }
+ ]
+ },
+ {
+ "shortName": "SearchProtectedResources",
+ "fullName": "google.cloud.kms.inventory.v1.KeyTrackingService.SearchProtectedResources",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{scope=organizations/*}/protectedResources:search"
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "configFile": "kmsinventory_v1.yaml",
+ "serviceConfigApiNames": [
+ "google.cloud.kms.inventory.v1.KeyDashboardService",
+ "google.cloud.kms.inventory.v1.KeyTrackingService"
+ ],
+ "nameInServiceConfig": "kmsinventory.googleapis.com"
+ },
{
"id": "google.cloud.kms.v1",
"directory": "google/cloud/kms/v1",
@@ -52697,7 +55267,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/kms/v1;kms": 3
+ "cloud.google.com/go/kms/apiv1/kmspb;kmspb": 3
}
},
"java_multiple_files": {
@@ -53083,7 +55653,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/language/v1;language": 1
+ "cloud.google.com/go/language/apiv1/languagepb;languagepb": 1
}
},
"java_multiple_files": {
@@ -53191,7 +55761,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/language/v1beta2;language": 1
+ "cloud.google.com/go/language/apiv1beta2/languagepb;languagepb": 1
}
},
"java_multiple_files": {
@@ -53307,7 +55877,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/lifesciences/v2beta;lifesciences": 1
+ "cloud.google.com/go/lifesciences/apiv2beta/lifesciencespb;lifesciencespb": 1
}
},
"java_multiple_files": {
@@ -53385,7 +55955,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/managedidentities/v1;managedidentities": 2
+ "cloud.google.com/go/managedidentities/apiv1/managedidentitiespb;managedidentitiespb": 2
}
},
"java_multiple_files": {
@@ -53561,7 +56131,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/managedidentities/v1beta1;managedidentities": 2
+ "cloud.google.com/go/managedidentities/apiv1beta1/managedidentitiespb;managedidentitiespb": 2
}
},
"java_multiple_files": {
@@ -53735,7 +56305,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/mediatranslation/v1alpha1;mediatranslation": 1
+ "cloud.google.com/go/mediatranslation/apiv1alpha1/mediatranslationpb;mediatranslationpb": 1
}
},
"java_package": {
@@ -53788,7 +56358,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/mediatranslation/v1beta1;mediatranslation": 1
+ "cloud.google.com/go/mediatranslation/apiv1beta1/mediatranslationpb;mediatranslationpb": 1
}
},
"java_multiple_files": {
@@ -53848,7 +56418,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/memcache/v1;memcache": 1
+ "cloud.google.com/go/memcache/apiv1/memcachepb;memcachepb": 1
}
},
"java_multiple_files": {
@@ -53983,7 +56553,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/memcache/v1beta2;memcache": 1
+ "cloud.google.com/go/memcache/apiv1beta2/memcachepb;memcachepb": 1
}
},
"java_multiple_files": {
@@ -54129,7 +56699,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/metastore/v1;metastore": 2
+ "cloud.google.com/go/metastore/apiv1/metastorepb;metastorepb": 2
}
},
"java_multiple_files": {
@@ -54410,7 +56980,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/metastore/v1alpha;metastore": 2
+ "cloud.google.com/go/metastore/apiv1alpha/metastorepb;metastorepb": 2
}
},
"java_multiple_files": {
@@ -54435,6 +57005,17 @@
"shortName": "DataprocMetastore",
"fullName": "google.cloud.metastore.v1alpha.DataprocMetastore",
"methods": [
+ {
+ "shortName": "AlterMetadataResourceLocation",
+ "fullName": "google.cloud.metastore.v1alpha.DataprocMetastore.AlterMetadataResourceLocation",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{service=projects/*/locations/*/services/*}:alterLocation"
+ }
+ ]
+ },
{
"shortName": "CreateBackup",
"fullName": "google.cloud.metastore.v1alpha.DataprocMetastore.CreateBackup",
@@ -54567,6 +57148,39 @@
}
]
},
+ {
+ "shortName": "MoveTableToDatabase",
+ "fullName": "google.cloud.metastore.v1alpha.DataprocMetastore.MoveTableToDatabase",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{service=projects/*/locations/*/services/*}:moveTableToDatabase"
+ }
+ ]
+ },
+ {
+ "shortName": "QueryMetadata",
+ "fullName": "google.cloud.metastore.v1alpha.DataprocMetastore.QueryMetadata",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{service=projects/*/locations/*/services/*}:queryMetadata"
+ }
+ ]
+ },
+ {
+ "shortName": "RemoveIamPolicy",
+ "fullName": "google.cloud.metastore.v1alpha.DataprocMetastore.RemoveIamPolicy",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1alpha/{resource=projects/*/locations/*/services/*/**}:removeIamPolicy"
+ }
+ ]
+ },
{
"shortName": "RestoreService",
"fullName": "google.cloud.metastore.v1alpha.DataprocMetastore.RestoreService",
@@ -54691,7 +57305,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/metastore/v1beta;metastore": 2
+ "cloud.google.com/go/metastore/apiv1beta/metastorepb;metastorepb": 2
}
},
"java_multiple_files": {
@@ -54716,6 +57330,17 @@
"shortName": "DataprocMetastore",
"fullName": "google.cloud.metastore.v1beta.DataprocMetastore",
"methods": [
+ {
+ "shortName": "AlterMetadataResourceLocation",
+ "fullName": "google.cloud.metastore.v1beta.DataprocMetastore.AlterMetadataResourceLocation",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta/{service=projects/*/locations/*/services/*}:alterLocation"
+ }
+ ]
+ },
{
"shortName": "CreateBackup",
"fullName": "google.cloud.metastore.v1beta.DataprocMetastore.CreateBackup",
@@ -54848,6 +57473,39 @@
}
]
},
+ {
+ "shortName": "MoveTableToDatabase",
+ "fullName": "google.cloud.metastore.v1beta.DataprocMetastore.MoveTableToDatabase",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta/{service=projects/*/locations/*/services/*}:moveTableToDatabase"
+ }
+ ]
+ },
+ {
+ "shortName": "QueryMetadata",
+ "fullName": "google.cloud.metastore.v1beta.DataprocMetastore.QueryMetadata",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta/{service=projects/*/locations/*/services/*}:queryMetadata"
+ }
+ ]
+ },
+ {
+ "shortName": "RemoveIamPolicy",
+ "fullName": "google.cloud.metastore.v1beta.DataprocMetastore.RemoveIamPolicy",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta/{resource=projects/*/locations/*/services/*/**}:removeIamPolicy"
+ }
+ ]
+ },
{
"shortName": "RestoreService",
"fullName": "google.cloud.metastore.v1beta.DataprocMetastore.RestoreService",
@@ -54971,32 +57629,32 @@
"options": {
"csharp_namespace": {
"valueCounts": {
- "Google.Cloud.NetworkConnectivity.V1": 3
+ "Google.Cloud.NetworkConnectivity.V1": 2
}
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/networkconnectivity/v1;networkconnectivity": 3
+ "cloud.google.com/go/networkconnectivity/apiv1/networkconnectivitypb;networkconnectivitypb": 2
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 3
+ "true": 2
}
},
"java_package": {
"valueCounts": {
- "com.google.cloud.networkconnectivity.v1": 3
+ "com.google.cloud.networkconnectivity.v1": 2
}
},
"php_namespace": {
"valueCounts": {
- "Google\\Cloud\\NetworkConnectivity\\V1": 3
+ "Google\\Cloud\\NetworkConnectivity\\V1": 2
}
},
"ruby_package": {
"valueCounts": {
- "Google::Cloud::NetworkConnectivity::V1": 3
+ "Google::Cloud::NetworkConnectivity::V1": 2
}
}
},
@@ -55116,63 +57774,12 @@
]
}
]
- },
- {
- "shortName": "PolicyBasedRoutingService",
- "fullName": "google.cloud.networkconnectivity.v1.PolicyBasedRoutingService",
- "methods": [
- {
- "shortName": "CreatePolicyBasedRoute",
- "fullName": "google.cloud.networkconnectivity.v1.PolicyBasedRoutingService.CreatePolicyBasedRoute",
- "mode": "UNARY",
- "bindings": [
- {
- "httpMethod": "POST",
- "path": "/v1/{parent=projects/*/locations/global}/policyBasedRoutes"
- }
- ]
- },
- {
- "shortName": "DeletePolicyBasedRoute",
- "fullName": "google.cloud.networkconnectivity.v1.PolicyBasedRoutingService.DeletePolicyBasedRoute",
- "mode": "UNARY",
- "bindings": [
- {
- "httpMethod": "DELETE",
- "path": "/v1/{name=projects/*/locations/global/policyBasedRoutes/*}"
- }
- ]
- },
- {
- "shortName": "GetPolicyBasedRoute",
- "fullName": "google.cloud.networkconnectivity.v1.PolicyBasedRoutingService.GetPolicyBasedRoute",
- "mode": "UNARY",
- "bindings": [
- {
- "httpMethod": "GET",
- "path": "/v1/{name=projects/*/locations/global/policyBasedRoutes/*}"
- }
- ]
- },
- {
- "shortName": "ListPolicyBasedRoutes",
- "fullName": "google.cloud.networkconnectivity.v1.PolicyBasedRoutingService.ListPolicyBasedRoutes",
- "mode": "UNARY",
- "bindings": [
- {
- "httpMethod": "GET",
- "path": "/v1/{parent=projects/*/locations/global}/policyBasedRoutes"
- }
- ]
- }
- ]
}
],
"configFile": "networkconnectivity_v1.yaml",
"serviceConfigApiNames": [
"google.cloud.location.Locations",
"google.cloud.networkconnectivity.v1.HubService",
- "google.cloud.networkconnectivity.v1.PolicyBasedRoutingService",
"google.iam.v1.IAMPolicy",
"google.longrunning.Operations"
],
@@ -55199,7 +57806,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/networkconnectivity/v1alpha1;networkconnectivity": 2
+ "cloud.google.com/go/networkconnectivity/apiv1alpha1/networkconnectivitypb;networkconnectivitypb": 2
}
},
"java_multiple_files": {
@@ -55370,7 +57977,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/networkmanagement/v1;networkmanagement": 3
+ "cloud.google.com/go/networkmanagement/apiv1/networkmanagementpb;networkmanagementpb": 3
}
},
"java_multiple_files": {
@@ -55497,7 +58104,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/networkmanagement/v1beta1;networkmanagement": 3
+ "cloud.google.com/go/networkmanagement/apiv1beta1/networkmanagementpb;networkmanagementpb": 3
}
},
"java_multiple_files": {
@@ -55623,7 +58230,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/networksecurity/v1;networksecurity": 6
+ "cloud.google.com/go/networksecurity/apiv1/networksecuritypb;networksecuritypb": 6
}
},
"java_multiple_files": {
@@ -55851,7 +58458,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/networksecurity/v1beta1;networksecurity": 6
+ "cloud.google.com/go/networksecurity/apiv1beta1/networksecuritypb;networksecuritypb": 6
}
},
"java_multiple_files": {
@@ -56079,7 +58686,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/networkservices/v1;networkservices": 10
+ "cloud.google.com/go/networkservices/apiv1/networkservicespb;networkservicespb": 10
}
},
"java_multiple_files": {
@@ -56571,7 +59178,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/networkservices/v1beta1;networkservices": 3
+ "cloud.google.com/go/networkservices/apiv1beta1/networkservicespb;networkservicespb": 3
}
},
"java_multiple_files": {
@@ -56687,7 +59294,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/notebooks/v1;notebooks": 10
+ "cloud.google.com/go/notebooks/apiv1/notebookspb;notebookspb": 10
}
},
"java_multiple_files": {
@@ -57276,7 +59883,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/notebooks/v1beta1;notebooks": 3
+ "cloud.google.com/go/notebooks/apiv1beta1/notebookspb;notebookspb": 3
}
},
"java_multiple_files": {
@@ -57544,7 +60151,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/optimization/v1;optimization": 2
+ "cloud.google.com/go/optimization/apiv1/optimizationpb;optimizationpb": 2
}
},
"java_multiple_files": {
@@ -57598,7 +60205,8 @@
],
"configFile": "cloudoptimization_v1.yaml",
"serviceConfigApiNames": [
- "google.cloud.optimization.v1.FleetRouting"
+ "google.cloud.optimization.v1.FleetRouting",
+ "google.longrunning.Operations"
],
"nameInServiceConfig": "cloudoptimization.googleapis.com"
},
@@ -57612,6 +60220,7 @@
"description": "Manages Apache Airflow environments on Google Cloud Platform.",
"importDirectories": [
"google/api",
+ "google/cloud/orchestration/airflow/service/v1",
"google/longrunning",
"google/protobuf",
"google/type"
@@ -57619,7 +60228,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/orchestration/airflow/service/v1;service": 3
+ "cloud.google.com/go/orchestration/airflow/service/apiv1/servicepb;servicepb": 3
}
},
"java_multiple_files": {
@@ -57753,6 +60362,7 @@
"description": "Manages Apache Airflow environments on Google Cloud Platform.",
"importDirectories": [
"google/api",
+ "google/cloud/orchestration/airflow/service/v1beta1",
"google/longrunning",
"google/protobuf",
"google/type"
@@ -57760,7 +60370,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/orchestration/airflow/service/v1beta1;service": 3
+ "cloud.google.com/go/orchestration/airflow/service/apiv1beta1/servicepb;servicepb": 3
}
},
"java_multiple_files": {
@@ -57913,7 +60523,7 @@
"majorVersion": "v2",
"hostName": "orgpolicy.googleapis.com",
"title": "Organization Policy API",
- "description": "The Org Policy API allows users to configure governance rules on their GCP resources across the Cloud Resource Hierarchy.",
+ "description": "The Organization Policy API allows users to configure governance rules on their Google Cloud resources across the resource hierarchy.",
"importDirectories": [
"google/api",
"google/cloud/orgpolicy/v2",
@@ -57928,7 +60538,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/orgpolicy/v2;orgpolicy": 2
+ "cloud.google.com/go/orgpolicy/apiv2/orgpolicypb;orgpolicypb": 2
}
},
"java_multiple_files": {
@@ -58116,7 +60726,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1;agentendpoint": 6
+ "cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb;agentendpointpb": 6
}
},
"java_multiple_files": {
@@ -58190,7 +60800,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/osconfig/agentendpoint/v1beta;agentendpoint": 4
+ "cloud.google.com/go/osconfig/agentendpoint/apiv1beta/agentendpointpb;agentendpointpb": 4
}
},
"java_multiple_files": {
@@ -58277,7 +60887,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/osconfig/v1;osconfig": 10
+ "cloud.google.com/go/osconfig/apiv1/osconfigpb;osconfigpb": 10
}
},
"java_multiple_files": {
@@ -58610,7 +61220,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/osconfig/v1alpha;osconfig": 9
+ "cloud.google.com/go/osconfig/apiv1alpha/osconfigpb;osconfigpb": 9
}
},
"java_multiple_files": {
@@ -58819,7 +61429,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta;osconfig": 5
+ "cloud.google.com/go/osconfig/apiv1beta/osconfigpb;osconfigpb": 5
}
},
"java_package": {
@@ -59061,7 +61671,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/oslogin/v1;oslogin": 1
+ "cloud.google.com/go/oslogin/apiv1/osloginpb;osloginpb": 1
}
},
"java_multiple_files": {
@@ -59197,7 +61807,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/oslogin/v1beta;oslogin": 1
+ "cloud.google.com/go/oslogin/apiv1beta/osloginpb;osloginpb": 1
}
},
"java_multiple_files": {
@@ -59336,7 +61946,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/paymentgateway/issuerswitch/v1;issuerswitch": 5
+ "cloud.google.com/go/paymentgateway/issuerswitch/apiv1/issuerswitchpb;issuerswitchpb": 5
}
},
"java_multiple_files": {
@@ -59595,7 +62205,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/phishingprotection/v1beta1;phishingprotection": 1
+ "cloud.google.com/go/phishingprotection/apiv1beta1/phishingprotectionpb;phishingprotectionpb": 1
}
},
"java_multiple_files": {
@@ -59677,7 +62287,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/policytroubleshooter/v1;policytroubleshooter": 2
+ "cloud.google.com/go/policytroubleshooter/apiv1/policytroubleshooterpb;policytroubleshooterpb": 2
}
},
"java_multiple_files": {
@@ -59749,7 +62359,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/privatecatalog/v1beta1;privatecatalog": 1
+ "cloud.google.com/go/privatecatalog/apiv1beta1/privatecatalogpb;privatecatalogpb": 1
}
},
"java_multiple_files": {
@@ -59872,7 +62482,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/pubsublite/v1;pubsublite": 6
+ "cloud.google.com/go/pubsublite/apiv1/pubsublitepb;pubsublitepb": 6
}
},
"java_multiple_files": {
@@ -60250,7 +62860,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1;recaptchaenterprise": 1
+ "cloud.google.com/go/recaptchaenterprise/apiv1/recaptchaenterprisepb;recaptchaenterprisepb": 1
}
},
"java_multiple_files": {
@@ -60456,7 +63066,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1;recaptchaenterprise": 1
+ "cloud.google.com/go/recaptchaenterprise/apiv1beta1/recaptchaenterprisepb;recaptchaenterprisepb": 1
}
},
"java_multiple_files": {
@@ -60544,7 +63154,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/recommendationengine/v1beta1;recommendationengine": 9
+ "cloud.google.com/go/recommendationengine/apiv1beta1/recommendationenginepb;recommendationenginepb": 9
}
},
"java_multiple_files": {
@@ -60788,7 +63398,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/recommender/logging/v1;logging": 1
+ "cloud.google.com/go/recommender/logging/apiv1/loggingpb;loggingpb": 1
}
},
"java_multiple_files": {
@@ -60820,7 +63430,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/recommender/logging/v1beta1;logging": 1
+ "cloud.google.com/go/recommender/logging/apiv1beta1/loggingpb;loggingpb": 1
}
},
"java_multiple_files": {
@@ -60859,7 +63469,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/recommender/v1;recommender": 5
+ "cloud.google.com/go/recommender/apiv1/recommenderpb;recommenderpb": 5
}
},
"java_multiple_files": {
@@ -61158,7 +63768,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/recommender/v1beta1;recommender": 5
+ "cloud.google.com/go/recommender/apiv1beta1/recommenderpb;recommenderpb": 5
}
},
"java_multiple_files": {
@@ -61452,7 +64062,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/redis/v1;redis": 1
+ "cloud.google.com/go/redis/apiv1/redispb;redispb": 1
}
},
"java_multiple_files": {
@@ -61618,7 +64228,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/redis/v1beta1;redis": 1
+ "cloud.google.com/go/redis/apiv1beta1/redispb;redispb": 1
}
},
"java_multiple_files": {
@@ -61789,7 +64399,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/resourcemanager/v2;resourcemanager": 1
+ "cloud.google.com/go/resourcemanager/apiv2/resourcemanagerpb;resourcemanagerpb": 1
}
},
"java_multiple_files": {
@@ -61965,7 +64575,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/resourcemanager/v3;resourcemanager": 6
+ "cloud.google.com/go/resourcemanager/apiv3/resourcemanagerpb;resourcemanagerpb": 6
}
},
"java_multiple_files": {
@@ -62568,7 +65178,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/resourcesettings/v1;resourcesettings": 1
+ "cloud.google.com/go/resourcesettings/apiv1/resourcesettingspb;resourcesettingspb": 1
}
},
"java_multiple_files": {
@@ -62687,7 +65297,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/retail/v2;retail": 17
+ "cloud.google.com/go/retail/apiv2/retailpb;retailpb": 17
}
},
"java_multiple_files": {
@@ -63286,7 +65896,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/retail/v2alpha;retail": 20
+ "cloud.google.com/go/retail/apiv2alpha/retailpb;retailpb": 20
}
},
"java_multiple_files": {
@@ -63991,7 +66601,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/retail/v2beta;retail": 20
+ "cloud.google.com/go/retail/apiv2beta/retailpb;retailpb": 20
}
},
"java_multiple_files": {
@@ -64680,7 +67290,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/run/v2;run": 12
+ "cloud.google.com/go/run/apiv2/runpb;runpb": 12
}
},
"java_multiple_files": {
@@ -65030,7 +67640,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/scheduler/v1;scheduler": 3
+ "cloud.google.com/go/scheduler/apiv1/schedulerpb;schedulerpb": 3
}
},
"java_multiple_files": {
@@ -65148,6 +67758,7 @@
],
"configFile": "cloudscheduler_v1.yaml",
"serviceConfigApiNames": [
+ "google.cloud.location.Locations",
"google.cloud.scheduler.v1.CloudScheduler"
],
"nameInServiceConfig": "cloudscheduler.googleapis.com"
@@ -65169,7 +67780,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/scheduler/v1beta1;scheduler": 3
+ "cloud.google.com/go/scheduler/apiv1beta1/schedulerpb;schedulerpb": 3
}
},
"java_multiple_files": {
@@ -65319,7 +67930,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/secretmanager/v1;secretmanager": 2
+ "cloud.google.com/go/secretmanager/apiv1/secretmanagerpb;secretmanagerpb": 2
}
},
"java_multiple_files": {
@@ -65554,7 +68165,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1;secretmanager": 2
+ "cloud.google.com/go/secrets/apiv1beta1/secretspb;secretspb": 2
}
},
"java_multiple_files": {
@@ -65790,7 +68401,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/security/privateca/v1;privateca": 2
+ "cloud.google.com/go/security/privateca/apiv1/privatecapb;privatecapb": 2
}
},
"java_multiple_files": {
@@ -66145,7 +68756,8 @@
"serviceConfigApiNames": [
"google.cloud.location.Locations",
"google.cloud.security.privateca.v1.CertificateAuthorityService",
- "google.iam.v1.IAMPolicy"
+ "google.iam.v1.IAMPolicy",
+ "google.longrunning.Operations"
],
"nameInServiceConfig": "privateca.googleapis.com"
},
@@ -66176,7 +68788,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1;privateca": 2
+ "cloud.google.com/go/security/privateca/apiv1beta1/privatecapb;privatecapb": 2
}
},
"java_multiple_files": {
@@ -66459,7 +69071,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/security/publicca/v1beta1;publicca": 2
+ "cloud.google.com/go/security/publicca/apiv1beta1/publiccapb;publiccapb": 2
}
},
"java_multiple_files": {
@@ -66534,7 +69146,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/securitycenter/settings/v1beta1;settings": 6
+ "cloud.google.com/go/securitycenter/settings/apiv1beta1/settingspb;settingspb": 6
}
},
"java_multiple_files": {
@@ -66898,7 +69510,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/securitycenter/v1;securitycenter": 30
+ "cloud.google.com/go/securitycenter/apiv1/securitycenterpb;securitycenterpb": 30
}
},
"java_multiple_files": {
@@ -67571,7 +70183,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/securitycenter/v1beta1;securitycenter": 7
+ "cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb;securitycenterpb": 7
}
},
"java_multiple_files": {
@@ -67824,7 +70436,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/securitycenter/v1p1beta1;securitycenter": 11
+ "cloud.google.com/go/securitycenter/apiv1p1beta1/securitycenterpb;securitycenterpb": 11
}
},
"java_multiple_files": {
@@ -68219,7 +70831,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/servicedirectory/v1;servicedirectory": 5
+ "cloud.google.com/go/servicedirectory/apiv1/servicedirectorypb;servicedirectorypb": 5
}
},
"java_multiple_files": {
@@ -68512,7 +71124,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/servicedirectory/v1beta1;servicedirectory": 5
+ "cloud.google.com/go/servicedirectory/apiv1beta1/servicedirectorypb;servicedirectorypb": 5
}
},
"java_multiple_files": {
@@ -68794,7 +71406,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/shell/v1;shell": 1
+ "cloud.google.com/go/shell/apiv1/shellpb;shellpb": 1
}
},
"java_multiple_files": {
@@ -68901,7 +71513,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/speech/v1;speech": 3
+ "cloud.google.com/go/speech/apiv1/speechpb;speechpb": 3
}
},
"java_multiple_files": {
@@ -69102,7 +71714,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1;speech": 3
+ "cloud.google.com/go/speech/apiv1p1beta1/speechpb;speechpb": 3
}
},
"java_multiple_files": {
@@ -69297,7 +71909,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/speech/v2;speech": 1
+ "cloud.google.com/go/speech/apiv2/speechpb;speechpb": 1
}
},
"java_multiple_files": {
@@ -69589,7 +72201,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/sql/v1;sql": 11
+ "cloud.google.com/go/sql/apiv1/sqlpb;sqlpb": 11
}
},
"java_multiple_files": {
@@ -70233,7 +72845,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/sql/v1beta4;sql": 5
+ "cloud.google.com/go/sql/apiv1beta4/sqlpb;sqlpb": 5
}
},
"java_multiple_files": {
@@ -70878,7 +73490,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/storageinsights/v1;storageinsights": 1
+ "cloud.google.com/go/storageinsights/apiv1/storageinsightspb;storageinsightspb": 1
}
},
"java_multiple_files": {
@@ -71014,7 +73626,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/talent/v4;talent": 12
+ "cloud.google.com/go/talent/apiv4/talentpb;talentpb": 12
}
},
"java_multiple_files": {
@@ -71337,7 +73949,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent": 13
+ "cloud.google.com/go/talent/apiv4beta1/talentpb;talentpb": 13
}
},
"java_multiple_files": {
@@ -71727,7 +74339,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/tasks/v2;tasks": 4
+ "cloud.google.com/go/tasks/apiv2/taskspb;taskspb": 4
}
},
"java_multiple_files": {
@@ -71955,7 +74567,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks": 5
+ "cloud.google.com/go/tasks/apiv2beta2/taskspb;taskspb": 5
}
},
"java_multiple_files": {
@@ -72227,7 +74839,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/tasks/v2beta3;tasks": 4
+ "cloud.google.com/go/tasks/apiv2beta3/taskspb;taskspb": 4
}
},
"java_multiple_files": {
@@ -72464,7 +75076,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/texttospeech/v1;texttospeech": 2
+ "cloud.google.com/go/texttospeech/apiv1/texttospeechpb;texttospeechpb": 2
}
},
"java_multiple_files": {
@@ -72570,7 +75182,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/texttospeech/v1beta1;texttospeech": 2
+ "cloud.google.com/go/texttospeech/apiv1beta1/texttospeechpb;texttospeechpb": 2
}
},
"java_multiple_files": {
@@ -72670,7 +75282,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/timeseriesinsights/v1;timeseriesinsights": 1
+ "cloud.google.com/go/timeseriesinsights/apiv1/timeseriesinsightspb;timeseriesinsightspb": 1
}
},
"java_multiple_files": {
@@ -72820,7 +75432,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/tpu/v1;tpu": 1
+ "cloud.google.com/go/tpu/apiv1/tpupb;tpupb": 1
}
},
"java_multiple_files": {
@@ -72987,7 +75599,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/tpu/v2;tpu": 1
+ "cloud.google.com/go/tpu/apiv2/tpupb;tpupb": 1
}
},
"java_multiple_files": {
@@ -73178,7 +75790,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/tpu/v2alpha1;tpu": 1
+ "cloud.google.com/go/tpu/apiv2alpha1/tpupb;tpupb": 1
}
},
"java_multiple_files": {
@@ -73432,7 +76044,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/translate/v3;translate": 1
+ "cloud.google.com/go/translation/apiv3/translationpb;translationpb": 1
}
},
"java_multiple_files": {
@@ -73618,7 +76230,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/translate/v3beta1;translate": 1
+ "cloud.google.com/go/translation/apiv3beta1/translationpb;translationpb": 1
}
},
"java_multiple_files": {
@@ -73801,7 +76413,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/video/livestream/v1;livestream": 3
+ "cloud.google.com/go/video/livestream/apiv1/livestreampb;livestreampb": 3
}
},
"java_multiple_files": {
@@ -74031,7 +76643,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/video/stitcher/v1;stitcher": 8
+ "cloud.google.com/go/video/stitcher/apiv1/stitcherpb;stitcherpb": 8
}
},
"java_multiple_files": {
@@ -74302,7 +76914,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/video/transcoder/v1;transcoder": 2
+ "cloud.google.com/go/video/transcoder/apiv1/transcoderpb;transcoderpb": 2
}
},
"java_multiple_files": {
@@ -74452,7 +77064,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/videointelligence/v1;videointelligence": 1
+ "cloud.google.com/go/videointelligence/apiv1/videointelligencepb;videointelligencepb": 1
}
},
"java_multiple_files": {
@@ -74523,7 +77135,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/videointelligence/v1p3beta1;videointelligence": 1
+ "cloud.google.com/go/videointelligence/apiv1p3beta1/videointelligencepb;videointelligencepb": 1
}
},
"java_multiple_files": {
@@ -74608,7 +77220,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/vision/v1;vision": 6
+ "cloud.google.com/go/vision/apiv1/visionpb;visionpb": 6
}
},
"java_multiple_files": {
@@ -74955,7 +77567,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/vision/v1p1beta1;vision": 4
+ "cloud.google.com/go/vision/apiv1p1beta1/visionpb;visionpb": 4
}
},
"java_multiple_files": {
@@ -75018,7 +77630,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/vision/v1p2beta1;vision": 4
+ "cloud.google.com/go/vision/apiv1p2beta1/visionpb;visionpb": 4
}
},
"java_multiple_files": {
@@ -75092,7 +77704,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/vision/v1p3beta1;vision": 6
+ "cloud.google.com/go/vision/apiv1p3beta1/visionpb;visionpb": 6
}
},
"java_multiple_files": {
@@ -75377,7 +77989,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/vision/v1p4beta1;vision": 7
+ "cloud.google.com/go/vision/apiv1p4beta1/visionpb;visionpb": 7
}
},
"java_multiple_files": {
@@ -75694,7 +78306,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/visionai/v1;visionai": 11
+ "cloud.google.com/go/visionai/apiv1/visionaipb;visionaipb": 11
}
},
"java_multiple_files": {
@@ -76742,7 +79354,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/visionai/v1alpha1;visionai": 11
+ "cloud.google.com/go/visionai/apiv1alpha1/visionaipb;visionaipb": 11
}
},
"java_multiple_files": {
@@ -77777,7 +80389,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/vmmigration/v1;vmmigration": 1
+ "cloud.google.com/go/vmmigration/apiv1/vmmigrationpb;vmmigrationpb": 1
}
},
"java_multiple_files": {
@@ -78070,6 +80682,17 @@
}
]
},
+ {
+ "shortName": "GetReplicationCycle",
+ "fullName": "google.cloud.vmmigration.v1.VmMigration.GetReplicationCycle",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/sources/*/migratingVms/*/replicationCycles/*}"
+ }
+ ]
+ },
{
"shortName": "GetSource",
"fullName": "google.cloud.vmmigration.v1.VmMigration.GetSource",
@@ -78158,6 +80781,17 @@
}
]
},
+ {
+ "shortName": "ListReplicationCycles",
+ "fullName": "google.cloud.vmmigration.v1.VmMigration.ListReplicationCycles",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*/sources/*/migratingVms/*}/replicationCycles"
+ }
+ ]
+ },
{
"shortName": "ListSources",
"fullName": "google.cloud.vmmigration.v1.VmMigration.ListSources",
@@ -78295,7 +80929,10 @@
],
"configFile": "vmmigration_v1.yaml",
"serviceConfigApiNames": [
- "google.cloud.vmmigration.v1.VmMigration"
+ "google.cloud.location.Locations",
+ "google.cloud.vmmigration.v1.VmMigration",
+ "google.iam.v1.IAMPolicy",
+ "google.longrunning.Operations"
],
"nameInServiceConfig": "vmmigration.googleapis.com"
},
@@ -78309,38 +80946,39 @@
"description": "The Google VMware Engine API lets you programmatically manage VMware environments.",
"importDirectories": [
"google/api",
+ "google/cloud/vmwareengine/v1",
"google/longrunning",
"google/protobuf"
],
"options": {
"csharp_namespace": {
"valueCounts": {
- "Google.Cloud.VmwareEngine.V1": 1
+ "Google.Cloud.VmwareEngine.V1": 2
}
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/vmwareengine/v1;vmwareengine": 1
+ "cloud.google.com/go/vmwareengine/apiv1/vmwareenginepb;vmwareenginepb": 2
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 1
+ "true": 2
}
},
"java_package": {
"valueCounts": {
- "com.google.cloud.vmwareengine.v1": 1
+ "com.google.cloud.vmwareengine.v1": 2
}
},
"php_namespace": {
"valueCounts": {
- "Google\\Cloud\\VmwareEngine\\V1": 1
+ "Google\\Cloud\\VmwareEngine\\V1": 2
}
},
"ruby_package": {
"valueCounts": {
- "Google::Cloud::VmwareEngine::V1": 1
+ "Google::Cloud::VmwareEngine::V1": 2
}
}
},
@@ -78723,7 +81361,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/vpcaccess/v1;vpcaccess": 1
+ "cloud.google.com/go/vpcaccess/apiv1/vpcaccesspb;vpcaccesspb": 1
}
},
"java_multiple_files": {
@@ -78827,7 +81465,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/webrisk/v1;webrisk": 1
+ "cloud.google.com/go/webrisk/apiv1/webriskpb;webriskpb": 1
}
},
"java_multiple_files": {
@@ -78934,7 +81572,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/webrisk/v1beta1;webrisk": 1
+ "cloud.google.com/go/webrisk/apiv1beta1/webriskpb;webriskpb": 1
}
},
"java_multiple_files": {
@@ -79031,7 +81669,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1;websecurityscanner": 11
+ "cloud.google.com/go/websecurityscanner/apiv1/websecurityscannerpb;websecurityscannerpb": 11
}
},
"java_multiple_files": {
@@ -79228,7 +81866,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1alpha;websecurityscanner": 7
+ "cloud.google.com/go/websecurityscanner/apiv1alpha/websecurityscannerpb;websecurityscannerpb": 7
}
},
"java_multiple_files": {
@@ -79420,7 +82058,7 @@
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1beta;websecurityscanner": 10
+ "cloud.google.com/go/websecurityscanner/apiv1beta/websecurityscannerpb;websecurityscannerpb": 10
}
},
"java_multiple_files": {
@@ -79616,7 +82254,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/workflows/executions/v1;executions": 1
+ "cloud.google.com/go/workflows/executions/apiv1/executionspb;executionspb": 1
}
},
"java_multiple_files": {
@@ -79703,7 +82341,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/workflows/executions/v1beta;executions": 1
+ "cloud.google.com/go/workflows/executions/apiv1beta/executionspb;executionspb": 1
}
},
"java_multiple_files": {
@@ -79791,7 +82429,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/workflows/v1;workflows": 1
+ "cloud.google.com/go/workflows/apiv1/workflowspb;workflowspb": 1
}
},
"java_multiple_files": {
@@ -79890,7 +82528,7 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/cloud/workflows/v1beta;workflows": 1
+ "cloud.google.com/go/workflows/apiv1beta/workflowspb;workflowspb": 1
}
},
"java_multiple_files": {
@@ -79973,6 +82611,274 @@
],
"nameInServiceConfig": "workflows.googleapis.com"
},
+ {
+ "id": "google.cloud.workstations.v1beta",
+ "directory": "google/cloud/workstations/v1beta",
+ "version": "v1beta",
+ "majorVersion": "v1",
+ "hostName": "workstations.googleapis.com",
+ "title": "Cloud Workstations API",
+ "description": "",
+ "importDirectories": [
+ "google/api",
+ "google/longrunning",
+ "google/protobuf",
+ "google/rpc"
+ ],
+ "options": {
+ "go_package": {
+ "valueCounts": {
+ "cloud.google.com/go/workstations/apiv1beta/workstationspb;workstationspb": 1
+ }
+ },
+ "java_multiple_files": {
+ "valueCounts": {
+ "true": 1
+ }
+ },
+ "java_package": {
+ "valueCounts": {
+ "com.google.cloud.workstations.v1beta": 1
+ }
+ }
+ },
+ "services": [
+ {
+ "shortName": "Workstations",
+ "fullName": "google.cloud.workstations.v1beta.Workstations",
+ "methods": [
+ {
+ "shortName": "CreateWorkstation",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.CreateWorkstation",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta/{parent=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}/workstations"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateWorkstationCluster",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.CreateWorkstationCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta/{parent=projects/*/locations/*}/workstationClusters"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateWorkstationConfig",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.CreateWorkstationConfig",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta/{parent=projects/*/locations/*/workstationClusters/*}/workstationConfigs"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteWorkstation",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.DeleteWorkstation",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1beta/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteWorkstationCluster",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.DeleteWorkstationCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1beta/{name=projects/*/locations/*/workstationClusters/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteWorkstationConfig",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.DeleteWorkstationConfig",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1beta/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GenerateAccessToken",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.GenerateAccessToken",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta/{workstation=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}:generateAccessToken"
+ }
+ ]
+ },
+ {
+ "shortName": "GetWorkstation",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.GetWorkstation",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetWorkstationCluster",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.GetWorkstationCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta/{name=projects/*/locations/*/workstationClusters/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetWorkstationConfig",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.GetWorkstationConfig",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "ListUsableWorkstationConfigs",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.ListUsableWorkstationConfigs",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta/{parent=projects/*/locations/*/workstationClusters/*}/workstationConfigs:listUsable"
+ }
+ ]
+ },
+ {
+ "shortName": "ListUsableWorkstations",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.ListUsableWorkstations",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta/{parent=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}/workstations:listUsable"
+ }
+ ]
+ },
+ {
+ "shortName": "ListWorkstationClusters",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.ListWorkstationClusters",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta/{parent=projects/*/locations/*}/workstationClusters"
+ }
+ ]
+ },
+ {
+ "shortName": "ListWorkstationConfigs",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.ListWorkstationConfigs",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta/{parent=projects/*/locations/*/workstationClusters/*}/workstationConfigs"
+ }
+ ]
+ },
+ {
+ "shortName": "ListWorkstations",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.ListWorkstations",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1beta/{parent=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}/workstations"
+ }
+ ]
+ },
+ {
+ "shortName": "StartWorkstation",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.StartWorkstation",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}:start"
+ }
+ ]
+ },
+ {
+ "shortName": "StopWorkstation",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.StopWorkstation",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1beta/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}:stop"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateWorkstation",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.UpdateWorkstation",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1beta/{workstation.name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateWorkstationCluster",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.UpdateWorkstationCluster",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1beta/{workstation_cluster.name=projects/*/locations/*/workstationClusters/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateWorkstationConfig",
+ "fullName": "google.cloud.workstations.v1beta.Workstations.UpdateWorkstationConfig",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1beta/{workstation_config.name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}"
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "configFile": "workstations_v1beta.yaml",
+ "serviceConfigApiNames": [
+ "google.cloud.location.Locations",
+ "google.cloud.workstations.v1beta.Workstations",
+ "google.iam.v1.IAMPolicy",
+ "google.longrunning.Operations"
+ ],
+ "nameInServiceConfig": "workstations.googleapis.com"
+ },
{
"id": "google.container.v1",
"directory": "google/container/v1",
@@ -81707,32 +84613,32 @@
"options": {
"csharp_namespace": {
"valueCounts": {
- "Google.Cloud.ArtifactRegistry.V1": 10
+ "Google.Cloud.ArtifactRegistry.V1": 11
}
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1;artifactregistry": 10
+ "google.golang.org/genproto/googleapis/devtools/artifactregistry/v1;artifactregistry": 11
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 10
+ "true": 11
}
},
"java_package": {
"valueCounts": {
- "com.google.devtools.artifactregistry.v1": 10
+ "com.google.devtools.artifactregistry.v1": 11
}
},
"php_namespace": {
"valueCounts": {
- "Google\\Cloud\\ArtifactRegistry\\V1": 10
+ "Google\\Cloud\\ArtifactRegistry\\V1": 11
}
},
"ruby_package": {
"valueCounts": {
- "Google::Cloud::ArtifactRegistry::V1": 10
+ "Google::Cloud::ArtifactRegistry::V1": 11
}
}
},
@@ -81840,6 +84746,28 @@
}
]
},
+ {
+ "shortName": "GetMavenArtifact",
+ "fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.GetMavenArtifact",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/repositories/*/mavenArtifacts/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetNpmPackage",
+ "fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.GetNpmPackage",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/repositories/*/npmPackages/*}"
+ }
+ ]
+ },
{
"shortName": "GetPackage",
"fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.GetPackage",
@@ -81862,6 +84790,17 @@
}
]
},
+ {
+ "shortName": "GetPythonPackage",
+ "fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.GetPythonPackage",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/repositories/*/pythonPackages/*}"
+ }
+ ]
+ },
{
"shortName": "GetRepository",
"fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.GetRepository",
@@ -81884,6 +84823,17 @@
}
]
},
+ {
+ "shortName": "GetVPCSCConfig",
+ "fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.GetVPCSCConfig",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/locations/*/vpcscConfig}"
+ }
+ ]
+ },
{
"shortName": "GetVersion",
"fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.GetVersion",
@@ -81939,6 +84889,28 @@
}
]
},
+ {
+ "shortName": "ListMavenArtifacts",
+ "fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.ListMavenArtifacts",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*/repositories/*}/mavenArtifacts"
+ }
+ ]
+ },
+ {
+ "shortName": "ListNpmPackages",
+ "fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.ListNpmPackages",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*/repositories/*}/npmPackages"
+ }
+ ]
+ },
{
"shortName": "ListPackages",
"fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.ListPackages",
@@ -81950,6 +84922,17 @@
}
]
},
+ {
+ "shortName": "ListPythonPackages",
+ "fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.ListPythonPackages",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*/locations/*/repositories/*}/pythonPackages"
+ }
+ ]
+ },
{
"shortName": "ListRepositories",
"fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.ListRepositories",
@@ -82037,13 +85020,26 @@
"path": "/v1/{tag.name=projects/*/locations/*/repositories/*/packages/*/tags/*}"
}
]
+ },
+ {
+ "shortName": "UpdateVPCSCConfig",
+ "fullName": "google.devtools.artifactregistry.v1.ArtifactRegistry.UpdateVPCSCConfig",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1/{vpcsc_config.name=projects/*/locations/*/vpcscConfig}"
+ }
+ ]
}
]
}
],
"configFile": "artifactregistry_v1.yaml",
"serviceConfigApiNames": [
- "google.devtools.artifactregistry.v1.ArtifactRegistry"
+ "google.cloud.location.Locations",
+ "google.devtools.artifactregistry.v1.ArtifactRegistry",
+ "google.longrunning.Operations"
],
"nameInServiceConfig": "artifactregistry.googleapis.com"
},
@@ -82380,6 +85376,7 @@
],
"configFile": "artifactregistry_v1beta2.yaml",
"serviceConfigApiNames": [
+ "google.cloud.location.Locations",
"google.devtools.artifactregistry.v1beta2.ArtifactRegistry"
],
"nameInServiceConfig": "artifactregistry.googleapis.com"
@@ -82507,6 +85504,11 @@
"GCB": 1
}
},
+ "php_namespace": {
+ "valueCounts": {
+ "Google\\Cloud\\Build\\V1": 1
+ }
+ },
"ruby_package": {
"valueCounts": {
"Google::Cloud::Build::V1": 1
@@ -82777,6 +85779,216 @@
],
"nameInServiceConfig": "cloudbuild.googleapis.com"
},
+ {
+ "id": "google.devtools.cloudbuild.v2",
+ "directory": "google/devtools/cloudbuild/v2",
+ "version": "v2",
+ "majorVersion": "v2",
+ "hostName": "cloudbuild.googleapis.com",
+ "title": "Cloud Build API",
+ "description": "Creates and manages builds on Google Cloud Platform.",
+ "importDirectories": [
+ "google/api",
+ "google/longrunning",
+ "google/protobuf"
+ ],
+ "options": {
+ "csharp_namespace": {
+ "valueCounts": {
+ "Google.Cloud.CloudBuild.V2": 2
+ }
+ },
+ "go_package": {
+ "valueCounts": {
+ "google.golang.org/genproto/googleapis/devtools/cloudbuild/v2;cloudbuild": 2
+ }
+ },
+ "java_multiple_files": {
+ "valueCounts": {
+ "true": 2
+ }
+ },
+ "java_package": {
+ "valueCounts": {
+ "google.devtools.cloudbuild.v2": 2
+ }
+ },
+ "objc_class_prefix": {
+ "valueCounts": {
+ "GCB": 2
+ }
+ },
+ "php_namespace": {
+ "valueCounts": {
+ "Google\\Cloud\\Build\\V2": 2
+ }
+ },
+ "ruby_package": {
+ "valueCounts": {
+ "Google::Cloud::Build::V2": 2
+ }
+ }
+ },
+ "services": [
+ {
+ "shortName": "RepositoryManager",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager",
+ "methods": [
+ {
+ "shortName": "BatchCreateRepositories",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.BatchCreateRepositories",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v2/{parent=projects/*/locations/*/connections/*}/repositories:batchCreate"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateConnection",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.CreateConnection",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v2/{parent=projects/*/locations/*}/connections"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateRepository",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.CreateRepository",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v2/{parent=projects/*/locations/*/connections/*}/repositories"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteConnection",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.DeleteConnection",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v2/{name=projects/*/locations/*/connections/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteRepository",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.DeleteRepository",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v2/{name=projects/*/locations/*/connections/*/repositories/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "FetchLinkableRepositories",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.FetchLinkableRepositories",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v2/{connection=projects/*/locations/*/connections/*}:fetchLinkableRepositories"
+ }
+ ]
+ },
+ {
+ "shortName": "FetchReadToken",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.FetchReadToken",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v2/{repository=projects/*/locations/*/connections/*/repositories/*}:accessReadToken"
+ }
+ ]
+ },
+ {
+ "shortName": "FetchReadWriteToken",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.FetchReadWriteToken",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v2/{repository=projects/*/locations/*/connections/*/repositories/*}:accessReadWriteToken"
+ }
+ ]
+ },
+ {
+ "shortName": "GetConnection",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.GetConnection",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v2/{name=projects/*/locations/*/connections/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetRepository",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.GetRepository",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v2/{name=projects/*/locations/*/connections/*/repositories/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "ListConnections",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.ListConnections",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v2/{parent=projects/*/locations/*}/connections"
+ }
+ ]
+ },
+ {
+ "shortName": "ListRepositories",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.ListRepositories",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v2/{parent=projects/*/locations/*/connections/*}/repositories"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateConnection",
+ "fullName": "google.devtools.cloudbuild.v2.RepositoryManager.UpdateConnection",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v2/{connection.name=projects/*/locations/*/connections/*}"
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "configFile": "cloudbuild_v2.yaml",
+ "serviceConfigApiNames": [
+ "google.cloud.location.Locations",
+ "google.devtools.cloudbuild.v2.RepositoryManager",
+ "google.iam.v1.IAMPolicy",
+ "google.longrunning.Operations"
+ ],
+ "nameInServiceConfig": "cloudbuild.googleapis.com"
+ },
{
"id": "google.devtools.clouddebugger.v2",
"directory": "google/devtools/clouddebugger/v2",
@@ -83180,7 +86392,7 @@
"majorVersion": "v1",
"hostName": "cloudtrace.googleapis.com",
"title": "Stackdriver Trace API",
- "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.",
+ "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenTelemetry.",
"importDirectories": [
"google/api",
"google/protobuf"
@@ -83271,7 +86483,7 @@
"majorVersion": "v2",
"hostName": "cloudtrace.googleapis.com",
"title": "Stackdriver Trace API",
- "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.",
+ "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenTelemetry.",
"importDirectories": [
"google/api",
"google/devtools/cloudtrace/v2",
@@ -87897,22 +91109,22 @@
"options": {
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/maps/fleetengine/delivery/v1;delivery": 5
+ "google.golang.org/genproto/googleapis/maps/fleetengine/delivery/v1;delivery": 6
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 5
+ "true": 6
}
},
"java_package": {
"valueCounts": {
- "google.maps.fleetengine.delivery.v1": 5
+ "google.maps.fleetengine.delivery.v1": 6
}
},
"objc_class_prefix": {
"valueCounts": {
- "CFED": 5
+ "CFED": 6
}
}
},
@@ -87976,6 +91188,17 @@
}
]
},
+ {
+ "shortName": "GetTaskTrackingInfo",
+ "fullName": "maps.fleetengine.delivery.v1.DeliveryService.GetTaskTrackingInfo",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=providers/*/taskTrackingInfo/*}"
+ }
+ ]
+ },
{
"shortName": "ListDeliveryVehicles",
"fullName": "maps.fleetengine.delivery.v1.DeliveryService.ListDeliveryVehicles",
@@ -88249,7 +91472,7 @@
"majorVersion": "v1",
"hostName": "mapsplatformdatasets.googleapis.com",
"title": "Maps Platform Datasets API",
- "description": "mapsplatformdatasets.googleapis.com API.",
+ "description": "The Maps Platform Datasets API enables developers to ingest geospatially-tied datasets that they can use to enrich their experience of Maps Platform solutions (e.g. styling, routing).",
"importDirectories": [
"google/api",
"google/maps/mapsplatformdatasets/v1alpha",
@@ -89165,32 +92388,32 @@
"options": {
"csharp_namespace": {
"valueCounts": {
- "Google.Cloud.Monitoring.V3": 17
+ "Google.Cloud.Monitoring.V3": 19
}
},
"go_package": {
"valueCounts": {
- "google.golang.org/genproto/googleapis/monitoring/v3;monitoring": 17
+ "google.golang.org/genproto/googleapis/monitoring/v3;monitoring": 19
}
},
"java_multiple_files": {
"valueCounts": {
- "true": 17
+ "true": 19
}
},
"java_package": {
"valueCounts": {
- "com.google.monitoring.v3": 17
+ "com.google.monitoring.v3": 19
}
},
"php_namespace": {
"valueCounts": {
- "Google\\Cloud\\Monitoring\\V3": 17
+ "Google\\Cloud\\Monitoring\\V3": 19
}
},
"ruby_package": {
"valueCounts": {
- "Google::Cloud::Monitoring::V3": 17
+ "Google::Cloud::Monitoring::V3": 19
}
}
},
@@ -89690,6 +92913,56 @@
}
]
},
+ {
+ "shortName": "SnoozeService",
+ "fullName": "google.monitoring.v3.SnoozeService",
+ "methods": [
+ {
+ "shortName": "CreateSnooze",
+ "fullName": "google.monitoring.v3.SnoozeService.CreateSnooze",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v3/{parent=projects/*}/snoozes"
+ }
+ ]
+ },
+ {
+ "shortName": "GetSnooze",
+ "fullName": "google.monitoring.v3.SnoozeService.GetSnooze",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v3/{name=projects/*/snoozes/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "ListSnoozes",
+ "fullName": "google.monitoring.v3.SnoozeService.ListSnoozes",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v3/{parent=projects/*}/snoozes"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateSnooze",
+ "fullName": "google.monitoring.v3.SnoozeService.UpdateSnooze",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v3/{snooze.name=projects/*/snoozes/*}"
+ }
+ ]
+ }
+ ]
+ },
{
"shortName": "UptimeCheckService",
"fullName": "google.monitoring.v3.UptimeCheckService",
@@ -89771,6 +93044,7 @@
"google.monitoring.v3.NotificationChannelService",
"google.monitoring.v3.QueryService",
"google.monitoring.v3.ServiceMonitoringService",
+ "google.monitoring.v3.SnoozeService",
"google.monitoring.v3.UptimeCheckService"
],
"nameInServiceConfig": "monitoring.googleapis.com"
@@ -90803,6 +94077,17 @@
"shortName": "SchemaService",
"fullName": "google.pubsub.v1.SchemaService",
"methods": [
+ {
+ "shortName": "CommitSchema",
+ "fullName": "google.pubsub.v1.SchemaService.CommitSchema",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{name=projects/*/schemas/*}:commit"
+ }
+ ]
+ },
{
"shortName": "CreateSchema",
"fullName": "google.pubsub.v1.SchemaService.CreateSchema",
@@ -90825,6 +94110,17 @@
}
]
},
+ {
+ "shortName": "DeleteSchemaRevision",
+ "fullName": "google.pubsub.v1.SchemaService.DeleteSchemaRevision",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/schemas/*}:deleteRevision"
+ }
+ ]
+ },
{
"shortName": "GetSchema",
"fullName": "google.pubsub.v1.SchemaService.GetSchema",
@@ -90836,6 +94132,17 @@
}
]
},
+ {
+ "shortName": "ListSchemaRevisions",
+ "fullName": "google.pubsub.v1.SchemaService.ListSchemaRevisions",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/schemas/*}:listRevisions"
+ }
+ ]
+ },
{
"shortName": "ListSchemas",
"fullName": "google.pubsub.v1.SchemaService.ListSchemas",
@@ -90847,6 +94154,17 @@
}
]
},
+ {
+ "shortName": "RollbackSchema",
+ "fullName": "google.pubsub.v1.SchemaService.RollbackSchema",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{name=projects/*/schemas/*}:rollback"
+ }
+ ]
+ },
{
"shortName": "ValidateMessage",
"fullName": "google.pubsub.v1.SchemaService.ValidateMessage",
@@ -91848,8 +95166,8 @@
"mode": "UNARY"
},
{
- "shortName": "CreateNotification",
- "fullName": "google.storage.v2.Storage.CreateNotification",
+ "shortName": "CreateNotificationConfig",
+ "fullName": "google.storage.v2.Storage.CreateNotificationConfig",
"mode": "UNARY"
},
{
@@ -91863,8 +95181,8 @@
"mode": "UNARY"
},
{
- "shortName": "DeleteNotification",
- "fullName": "google.storage.v2.Storage.DeleteNotification",
+ "shortName": "DeleteNotificationConfig",
+ "fullName": "google.storage.v2.Storage.DeleteNotificationConfig",
"mode": "UNARY"
},
{
@@ -91888,8 +95206,8 @@
"mode": "UNARY"
},
{
- "shortName": "GetNotification",
- "fullName": "google.storage.v2.Storage.GetNotification",
+ "shortName": "GetNotificationConfig",
+ "fullName": "google.storage.v2.Storage.GetNotificationConfig",
"mode": "UNARY"
},
{
@@ -91913,8 +95231,8 @@
"mode": "UNARY"
},
{
- "shortName": "ListNotifications",
- "fullName": "google.storage.v2.Storage.ListNotifications",
+ "shortName": "ListNotificationConfigs",
+ "fullName": "google.storage.v2.Storage.ListNotificationConfigs",
"mode": "UNARY"
},
{
@@ -92452,6 +95770,210 @@
"google.watcher.v1.Watcher"
],
"nameInServiceConfig": "watcher.googleapis.com"
+ },
+ {
+ "id": "grafeas.v1",
+ "directory": "grafeas/v1",
+ "version": "v1",
+ "majorVersion": "v1",
+ "hostName": "containeranalysis.googleapis.com",
+ "title": "Container Analysis API",
+ "description": "An implementation of the Grafeas API, which stores, and enables querying and retrieval of critical metadata about all of your software artifacts.",
+ "importDirectories": [
+ "google/api",
+ "google/protobuf",
+ "google/rpc",
+ "grafeas/v1"
+ ],
+ "options": {
+ "go_package": {
+ "valueCounts": {
+ "google.golang.org/genproto/googleapis/grafeas/v1;grafeas": 19
+ }
+ },
+ "java_multiple_files": {
+ "valueCounts": {
+ "true": 19
+ }
+ },
+ "java_package": {
+ "valueCounts": {
+ "io.grafeas.v1": 19
+ }
+ },
+ "objc_class_prefix": {
+ "valueCounts": {
+ "GRA": 19
+ }
+ }
+ },
+ "services": [
+ {
+ "shortName": "Grafeas",
+ "fullName": "grafeas.v1.Grafeas",
+ "methods": [
+ {
+ "shortName": "BatchCreateNotes",
+ "fullName": "grafeas.v1.Grafeas.BatchCreateNotes",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*}/notes:batchCreate"
+ }
+ ]
+ },
+ {
+ "shortName": "BatchCreateOccurrences",
+ "fullName": "grafeas.v1.Grafeas.BatchCreateOccurrences",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*}/occurrences:batchCreate"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateNote",
+ "fullName": "grafeas.v1.Grafeas.CreateNote",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*}/notes"
+ }
+ ]
+ },
+ {
+ "shortName": "CreateOccurrence",
+ "fullName": "grafeas.v1.Grafeas.CreateOccurrence",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "POST",
+ "path": "/v1/{parent=projects/*}/occurrences"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteNote",
+ "fullName": "grafeas.v1.Grafeas.DeleteNote",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/notes/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "DeleteOccurrence",
+ "fullName": "grafeas.v1.Grafeas.DeleteOccurrence",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "DELETE",
+ "path": "/v1/{name=projects/*/occurrences/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetNote",
+ "fullName": "grafeas.v1.Grafeas.GetNote",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/notes/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetOccurrence",
+ "fullName": "grafeas.v1.Grafeas.GetOccurrence",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/occurrences/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "GetOccurrenceNote",
+ "fullName": "grafeas.v1.Grafeas.GetOccurrenceNote",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/occurrences/*}/notes"
+ }
+ ]
+ },
+ {
+ "shortName": "ListNoteOccurrences",
+ "fullName": "grafeas.v1.Grafeas.ListNoteOccurrences",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{name=projects/*/notes/*}/occurrences"
+ }
+ ]
+ },
+ {
+ "shortName": "ListNotes",
+ "fullName": "grafeas.v1.Grafeas.ListNotes",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*}/notes"
+ }
+ ]
+ },
+ {
+ "shortName": "ListOccurrences",
+ "fullName": "grafeas.v1.Grafeas.ListOccurrences",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "GET",
+ "path": "/v1/{parent=projects/*}/occurrences"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateNote",
+ "fullName": "grafeas.v1.Grafeas.UpdateNote",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1/{name=projects/*/notes/*}"
+ }
+ ]
+ },
+ {
+ "shortName": "UpdateOccurrence",
+ "fullName": "grafeas.v1.Grafeas.UpdateOccurrence",
+ "mode": "UNARY",
+ "bindings": [
+ {
+ "httpMethod": "PATCH",
+ "path": "/v1/{name=projects/*/occurrences/*}"
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "configFile": "grafeas_v1.yaml",
+ "serviceConfigApiNames": [
+ "grafeas.v1.Grafeas"
+ ],
+ "nameInServiceConfig": "containeranalysis.googleapis.com"
}
],
"metadata": {
diff --git a/third_party/googleapis/google/ads/admob/v1/BUILD.bazel b/third_party/googleapis/google/ads/admob/v1/BUILD.bazel
index 7a91593e5..df6c85b8c 100644
--- a/third_party/googleapis/google/ads/admob/v1/BUILD.bazel
+++ b/third_party/googleapis/google/ads/admob/v1/BUILD.bazel
@@ -182,6 +182,7 @@ py_gapic_library(
":admob_proto_with_info",
],
rest_numeric_enums = True,
+ service_yaml = "//google/ads/admob:admob_v1.yaml",
transport = "rest",
)
@@ -308,6 +309,7 @@ ruby_cloud_gapic_library(
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-admob-v1"],
grpc_service_config = None,
rest_numeric_enums = True,
+ service_yaml = "//google/ads/admob:admob_v1.yaml",
deps = [
":admob_ruby_grpc",
":admob_ruby_proto",
@@ -351,6 +353,8 @@ csharp_gapic_library(
srcs = [":admob_proto_with_info"],
common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
rest_numeric_enums = True,
+ service_yaml = "//google/ads/admob:admob_v1.yaml",
+ transport = "rest",
deps = [
":admob_csharp_grpc",
":admob_csharp_proto",
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/asset_policy.proto b/third_party/googleapis/google/ads/googleads/v10/common/asset_policy.proto
deleted file mode 100644
index 554f6029b..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/common/asset_policy.proto
+++ /dev/null
@@ -1,45 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.common;
-
-import "google/ads/googleads/v10/common/policy.proto";
-import "google/ads/googleads/v10/enums/policy_approval_status.proto";
-import "google/ads/googleads/v10/enums/policy_review_status.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
-option java_multiple_files = true;
-option java_outer_classname = "AssetPolicyProto";
-option java_package = "com.google.ads.googleads.v10.common";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
-
-// Proto file describing asset policies.
-
-// Contains policy information for an asset inside an ad.
-message AdAssetPolicySummary {
- // The list of policy findings for this asset.
- repeated PolicyTopicEntry policy_topic_entries = 1;
-
- // Where in the review process this asset.
- google.ads.googleads.v10.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2;
-
- // The overall approval status of this asset, which is calculated based on
- // the status of its individual policy topic entries.
- google.ads.googleads.v10.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3;
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/explorer_auto_optimizer_setting.proto b/third_party/googleapis/google/ads/googleads/v10/common/explorer_auto_optimizer_setting.proto
deleted file mode 100644
index 670ca966d..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/common/explorer_auto_optimizer_setting.proto
+++ /dev/null
@@ -1,36 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.common;
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
-option java_multiple_files = true;
-option java_outer_classname = "ExplorerAutoOptimizerSettingProto";
-option java_package = "com.google.ads.googleads.v10.common";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
-
-// Proto file describing ExplorerAutoOptimizerSetting
-
-// Settings for the Display Campaign Optimizer, initially named "Explorer".
-// Learn more about
-// [automatic targeting](https://support.google.com/google-ads/answer/190596).
-message ExplorerAutoOptimizerSetting {
- // Indicates whether the optimizer is turned on.
- optional bool opt_in = 2;
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_experiment_status.proto b/third_party/googleapis/google/ads/googleads/v10/enums/campaign_experiment_status.proto
deleted file mode 100644
index ea8d0843f..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_experiment_status.proto
+++ /dev/null
@@ -1,75 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.enums;
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
-option java_multiple_files = true;
-option java_outer_classname = "CampaignExperimentStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
-
-// Proto file describing campaign experiment status.
-
-// Container for enum describing possible statuses of a campaign experiment.
-message CampaignExperimentStatusEnum {
- // Possible statuses of a campaign experiment.
- enum CampaignExperimentStatus {
- // The status has not been specified.
- UNSPECIFIED = 0;
-
- // Used for return value only. Represents value unknown in this version.
- UNKNOWN = 1;
-
- // The experiment campaign is being initialized.
- INITIALIZING = 2;
-
- // Initialization of the experiment campaign failed.
- INITIALIZATION_FAILED = 8;
-
- // The experiment campaign is fully initialized. The experiment is currently
- // running, scheduled to run in the future or has ended based on its
- // end date. An experiment with the status INITIALIZING will be updated to
- // ENABLED when it is fully created.
- ENABLED = 3;
-
- // The experiment campaign was graduated to a stand-alone
- // campaign, existing independently of the experiment.
- GRADUATED = 4;
-
- // The experiment is removed.
- REMOVED = 5;
-
- // The experiment's changes are being applied to the original campaign.
- // The long running operation returned by the promote method can be polled
- // to see the status of the promotion.
- PROMOTING = 6;
-
- // Promote of the experiment campaign failed.
- PROMOTION_FAILED = 9;
-
- // The changes of the experiment are promoted to their original campaign.
- PROMOTED = 7;
-
- // The experiment was ended manually. It did not end based on its end date.
- ENDED_MANUALLY = 10;
- }
-
-
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_experiment_traffic_split_type.proto b/third_party/googleapis/google/ads/googleads/v10/enums/campaign_experiment_traffic_split_type.proto
deleted file mode 100644
index 8533057f5..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_experiment_traffic_split_type.proto
+++ /dev/null
@@ -1,51 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.enums;
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
-option java_multiple_files = true;
-option java_outer_classname = "CampaignExperimentTrafficSplitTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
-
-// Proto file describing campaign experiment traffic split type.
-
-// Container for enum describing campaign experiment traffic split type.
-message CampaignExperimentTrafficSplitTypeEnum {
- // Enum of strategies for splitting traffic between base and experiment
- // campaigns in campaign experiment.
- enum CampaignExperimentTrafficSplitType {
- // Not specified.
- UNSPECIFIED = 0;
-
- // Used for return value only. Represents value unknown in this version.
- UNKNOWN = 1;
-
- // Traffic is randomly assigned to the base or experiment arm for each
- // query, independent of previous assignments for the same user.
- RANDOM_QUERY = 2;
-
- // Traffic is split using cookies to keep users in the same arm (base or
- // experiment) of the experiment.
- COOKIE = 3;
- }
-
-
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/lead_form_field_user_input_type.proto b/third_party/googleapis/google/ads/googleads/v10/enums/lead_form_field_user_input_type.proto
deleted file mode 100644
index 42e7d2f20..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/enums/lead_form_field_user_input_type.proto
+++ /dev/null
@@ -1,292 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.enums;
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
-option java_multiple_files = true;
-option java_outer_classname = "LeadFormFieldUserInputTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
-
-// Describes the input type of a lead form field.
-message LeadFormFieldUserInputTypeEnum {
- // Enum describing the input type of a lead form field.
- enum LeadFormFieldUserInputType {
- // Not specified.
- UNSPECIFIED = 0;
-
- // Used for return value only. Represents value unknown in this version.
- UNKNOWN = 1;
-
- // The user will be asked to fill in their given and family name. This field
- // cannot be set at the same time as GIVEN_NAME or FAMILY_NAME.
- FULL_NAME = 2;
-
- // The user will be asked to fill in their email address.
- EMAIL = 3;
-
- // The user will be asked to fill in their phone number.
- PHONE_NUMBER = 4;
-
- // The user will be asked to fill in their zip code.
- POSTAL_CODE = 5;
-
- // The user will be asked to fill in their city.
- CITY = 9;
-
- // The user will be asked to fill in their region part of the address (e.g.
- // state for US, province for Canada).
- REGION = 10;
-
- // The user will be asked to fill in their country.
- COUNTRY = 11;
-
- // The user will be asked to fill in their work email address.
- WORK_EMAIL = 12;
-
- // The user will be asked to fill in their company name.
- COMPANY_NAME = 13;
-
- // The user will be asked to fill in their work phone.
- WORK_PHONE = 14;
-
- // The user will be asked to fill in their job title.
- JOB_TITLE = 15;
-
- // The user will be asked to fill in their CPF for Brazil users.
- GOVERNMENT_ISSUED_ID_CPF_BR = 16;
-
- // The user will be asked to fill in their DNI for Argentina users.
- GOVERNMENT_ISSUED_ID_DNI_AR = 17;
-
- // The user will be asked to fill in their DNI for Peru users.
- GOVERNMENT_ISSUED_ID_DNI_PE = 18;
-
- // The user will be asked to fill in their RUT for Chile users.
- GOVERNMENT_ISSUED_ID_RUT_CL = 19;
-
- // The user will be asked to fill in their CC for Colombia users.
- GOVERNMENT_ISSUED_ID_CC_CO = 20;
-
- // The user will be asked to fill in their CI for Ecuador users.
- GOVERNMENT_ISSUED_ID_CI_EC = 21;
-
- // The user will be asked to fill in their RFC for Mexico users.
- GOVERNMENT_ISSUED_ID_RFC_MX = 22;
-
- // The user will be asked to fill in their first name. This
- // field can not be set at the same time as FULL_NAME.
- FIRST_NAME = 23;
-
- // The user will be asked to fill in their last name. This
- // field can not be set at the same time as FULL_NAME.
- LAST_NAME = 24;
-
- // Question: "Which model are you interested in?"
- // Category: "Auto"
- VEHICLE_MODEL = 1001;
-
- // Question: "Which type of vehicle are you interested in?"
- // Category: "Auto"
- VEHICLE_TYPE = 1002;
-
- // Question: "What is your preferred dealership?"
- // Category: "Auto"
- PREFERRED_DEALERSHIP = 1003;
-
- // Question: "When do you plan on purchasing a vehicle?"
- // Category: "Auto"
- VEHICLE_PURCHASE_TIMELINE = 1004;
-
- // Question: "Do you own a vehicle?"
- // Category: "Auto"
- VEHICLE_OWNERSHIP = 1005;
-
- // Question: "What vehicle ownership option are you interested in?"
- // Category: "Auto"
- VEHICLE_PAYMENT_TYPE = 1009;
-
- // Question: "What type of vehicle condition are you interested in?"
- // Category: "Auto"
- VEHICLE_CONDITION = 1010;
-
- // Question: "What size is your company?"
- // Category: "Business"
- COMPANY_SIZE = 1006;
-
- // Question: "What is your annual sales volume?"
- // Category: "Business"
- ANNUAL_SALES = 1007;
-
- // Question: "How many years have you been in business?"
- // Category: "Business"
- YEARS_IN_BUSINESS = 1008;
-
- // Question: "What is your job department?"
- // Category: "Business"
- JOB_DEPARTMENT = 1011;
-
- // Question: "What is your job role?"
- // Category: "Business"
- JOB_ROLE = 1012;
-
- // Question: "Which program are you interested in?"
- // Category: "Education"
- EDUCATION_PROGRAM = 1013;
-
- // Question: "Which course are you interested in?"
- // Category: "Education"
- EDUCATION_COURSE = 1014;
-
- // Question: "Which product are you interested in?"
- // Category: "General"
- PRODUCT = 1016;
-
- // Question: "Which service are you interested in?"
- // Category: "General"
- SERVICE = 1017;
-
- // Question: "Which offer are you interested in?"
- // Category: "General"
- OFFER = 1018;
-
- // Question: "Which category are you interested in?"
- // Category: "General"
- CATEGORY = 1019;
-
- // Question: "What is your preferred method of contact?"
- // Category: "General"
- PREFERRED_CONTACT_METHOD = 1020;
-
- // Question: "What is your preferred location?"
- // Category: "General"
- PREFERRED_LOCATION = 1021;
-
- // Question: "What is the best time to contact you?"
- // Category: "General"
- PREFERRED_CONTACT_TIME = 1022;
-
- // Question: "When are you looking to make a purchase?"
- // Category: "General"
- PURCHASE_TIMELINE = 1023;
-
- // Question: "How many years of work experience do you have?"
- // Category: "Jobs"
- YEARS_OF_EXPERIENCE = 1048;
-
- // Question: "What industry do you work in?"
- // Category: "Jobs"
- JOB_INDUSTRY = 1049;
-
- // Question: "What is your highest level of education?"
- // Category: "Jobs"
- LEVEL_OF_EDUCATION = 1050;
-
- // Question: "What type of property are you looking for?"
- // Category: "Real Estate"
- PROPERTY_TYPE = 1024;
-
- // Question: "What do you need a realtor's help with?"
- // Category: "Real Estate"
- REALTOR_HELP_GOAL = 1025;
-
- // Question: "What neighborhood are you interested in?"
- // Category: "Real Estate"
- PROPERTY_COMMUNITY = 1026;
-
- // Question: "What price range are you looking for?"
- // Category: "Real Estate"
- PRICE_RANGE = 1027;
-
- // Question: "How many bedrooms are you looking for?"
- // Category: "Real Estate"
- NUMBER_OF_BEDROOMS = 1028;
-
- // Question: "Are you looking for a fully furnished property?"
- // Category: "Real Estate"
- FURNISHED_PROPERTY = 1029;
-
- // Question: "Are you looking for properties that allow pets?"
- // Category: "Real Estate"
- PETS_ALLOWED_PROPERTY = 1030;
-
- // Question: "What is the next product you plan to purchase?"
- // Category: "Retail"
- NEXT_PLANNED_PURCHASE = 1031;
-
- // Question: "Would you like to sign up for an event?"
- // Category: "Retail"
- EVENT_SIGNUP_INTEREST = 1033;
-
- // Question: "Where are you interested in shopping?"
- // Category: "Retail"
- PREFERRED_SHOPPING_PLACES = 1034;
-
- // Question: "What is your favorite brand?"
- // Category: "Retail"
- FAVORITE_BRAND = 1035;
-
- // Question: "Which type of valid commercial license do you have?"
- // Category: "Transportation"
- TRANSPORTATION_COMMERCIAL_LICENSE_TYPE = 1036;
-
- // Question: "Interested in booking an event?"
- // Category: "Travel"
- EVENT_BOOKING_INTEREST = 1038;
-
- // Question: "What is your destination country?"
- // Category: "Travel"
- DESTINATION_COUNTRY = 1039;
-
- // Question: "What is your destination city?"
- // Category: "Travel"
- DESTINATION_CITY = 1040;
-
- // Question: "What is your departure country?"
- // Category: "Travel"
- DEPARTURE_COUNTRY = 1041;
-
- // Question: "What is your departure city?"
- // Category: "Travel"
- DEPARTURE_CITY = 1042;
-
- // Question: "What is your departure date?"
- // Category: "Travel"
- DEPARTURE_DATE = 1043;
-
- // Question: "What is your return date?"
- // Category: "Travel"
- RETURN_DATE = 1044;
-
- // Question: "How many people are you traveling with?"
- // Category: "Travel"
- NUMBER_OF_TRAVELERS = 1045;
-
- // Question: "What is your travel budget?"
- // Category: "Travel"
- TRAVEL_BUDGET = 1046;
-
- // Question: "Where do you want to stay during your travel?"
- // Category: "Travel"
- TRAVEL_ACCOMMODATION = 1047;
- }
-
-
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/reach_plan_ad_length.proto b/third_party/googleapis/google/ads/googleads/v10/enums/reach_plan_ad_length.proto
deleted file mode 100644
index 56c5da45c..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/enums/reach_plan_ad_length.proto
+++ /dev/null
@@ -1,51 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.enums;
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
-option java_multiple_files = true;
-option java_outer_classname = "ReachPlanAdLengthProto";
-option java_package = "com.google.ads.googleads.v10.enums";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
-
-// Proto file describing ad lengths of a plannable video ad.
-
-// Message describing length of a plannable video ad.
-message ReachPlanAdLengthEnum {
- // Possible ad length values.
- enum ReachPlanAdLength {
- // Not specified.
- UNSPECIFIED = 0;
-
- // The value is unknown in this version.
- UNKNOWN = 1;
-
- // 6 seconds long ad.
- SIX_SECONDS = 2;
-
- // 15 or 20 seconds long ad.
- FIFTEEN_OR_TWENTY_SECONDS = 3;
-
- // More than 20 seconds long ad.
- TWENTY_SECONDS_OR_MORE = 4;
- }
-
-
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/googleads_gapic.yaml b/third_party/googleapis/google/ads/googleads/v10/googleads_gapic.yaml
deleted file mode 100644
index 743a20731..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/googleads_gapic.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-type: com.google.api.codegen.ConfigProto
-config_schema_version: 2.0.0
-language_settings:
- csharp:
- package_name: Google.Ads.GoogleAds.V10.Services
- go:
- package_name: google.golang.org/google/ads/googleads/v10/services
- java:
- package_name: com.google.ads.googleads.v10.services
- nodejs:
- package_name: v10.services
- php:
- package_name: Google\Ads\GoogleAds\V10\Services
- python:
- package_name: google.ads.googleads_v10.gapic.services
- ruby:
- package_name: Google::Ads::Googleads::V10::Services
-interfaces:
-- name: google.ads.googleads.v10.services.OfflineUserDataJobService
- methods:
- - name: RunOfflineUserDataJob
- long_running:
- initial_poll_delay_millis: 300000
- max_poll_delay_millis: 3600000
- poll_delay_multiplier: 1.25
- total_poll_timeout_millis: 43200000
diff --git a/third_party/googleapis/google/ads/googleads/v10/googleads_grpc_service_config.json b/third_party/googleapis/google/ads/googleads/v10/googleads_grpc_service_config.json
deleted file mode 100755
index 499de42f2..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/googleads_grpc_service_config.json
+++ /dev/null
@@ -1,324 +0,0 @@
-{
- "methodConfig": [
- {
- "name": [
- {
- "service": "google.ads.googleads.v10.services.AccountBudgetProposalService"
- },
- {
- "service": "google.ads.googleads.v10.services.AccountLinkService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupAdLabelService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupAdService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupAssetService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupBidModifierService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupCriterionCustomizerService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupCriterionLabelService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupCriterionService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupCustomizerService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupExtensionSettingService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupFeedService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupLabelService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdGroupService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdParameterService"
- },
- {
- "service": "google.ads.googleads.v10.services.AdService"
- },
- {
- "service": "google.ads.googleads.v10.services.AssetGroupAssetService"
- },
- {
- "service": "google.ads.googleads.v10.services.AssetGroupListingGroupFilterService"
- },
- {
- "service": "google.ads.googleads.v10.services.AssetGroupService"
- },
- {
- "service": "google.ads.googleads.v10.services.AssetGroupSignalService"
- },
- {
- "service": "google.ads.googleads.v10.services.AssetService"
- },
- {
- "service": "google.ads.googleads.v10.services.AssetSetAssetService"
- },
- {
- "service": "google.ads.googleads.v10.services.AssetSetService"
- },
- {
- "service": "google.ads.googleads.v10.services.AudienceService"
- },
- {
- "service": "google.ads.googleads.v10.services.BatchJobService"
- },
- {
- "service": "google.ads.googleads.v10.services.BiddingDataExclusionService"
- },
- {
- "service": "google.ads.googleads.v10.services.BiddingSeasonalityAdjustmentService"
- },
- {
- "service": "google.ads.googleads.v10.services.BiddingStrategyService"
- },
- {
- "service": "google.ads.googleads.v10.services.BillingSetupService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignAssetService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignAssetSetService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignBidModifierService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignBudgetService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignConversionGoalService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignCriterionService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignCustomizerService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignDraftService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignExperimentService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignExtensionSettingService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignFeedService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignGroupService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignLabelService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignService"
- },
- {
- "service": "google.ads.googleads.v10.services.CampaignSharedSetService"
- },
- {
- "service": "google.ads.googleads.v10.services.ConversionActionService"
- },
- {
- "service": "google.ads.googleads.v10.services.ConversionAdjustmentUploadService"
- },
- {
- "service": "google.ads.googleads.v10.services.ConversionCustomVariableService"
- },
- {
- "service": "google.ads.googleads.v10.services.ConversionGoalCampaignConfigService"
- },
- {
- "service": "google.ads.googleads.v10.services.ConversionUploadService"
- },
- {
- "service": "google.ads.googleads.v10.services.ConversionValueRuleService"
- },
- {
- "service": "google.ads.googleads.v10.services.ConversionValueRuleSetService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomAudienceService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomConversionGoalService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomInterestService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerAssetService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerClientLinkService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerConversionGoalService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerCustomizerService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerExtensionSettingService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerFeedService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerLabelService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerManagerLinkService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerNegativeCriterionService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerUserAccessInvitationService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomerUserAccessService"
- },
- {
- "service": "google.ads.googleads.v10.services.CustomizerAttributeService"
- },
- {
- "service": "google.ads.googleads.v10.services.ExperimentArmService"
- },
- {
- "service": "google.ads.googleads.v10.services.ExperimentService"
- },
- {
- "service": "google.ads.googleads.v10.services.ExtensionFeedItemService"
- },
- {
- "service": "google.ads.googleads.v10.services.FeedItemService"
- },
- {
- "service": "google.ads.googleads.v10.services.FeedItemSetLinkService"
- },
- {
- "service": "google.ads.googleads.v10.services.FeedItemSetService"
- },
- {
- "service": "google.ads.googleads.v10.services.FeedItemTargetService"
- },
- {
- "service": "google.ads.googleads.v10.services.FeedMappingService"
- },
- {
- "service": "google.ads.googleads.v10.services.FeedService"
- },
- {
- "service": "google.ads.googleads.v10.services.GeoTargetConstantService"
- },
- {
- "service": "google.ads.googleads.v10.services.GoogleAdsFieldService"
- },
- {
- "service": "google.ads.googleads.v10.services.GoogleAdsService"
- },
- {
- "service": "google.ads.googleads.v10.services.InvoiceService"
- },
- {
- "service": "google.ads.googleads.v10.services.KeywordPlanAdGroupKeywordService"
- },
- {
- "service": "google.ads.googleads.v10.services.KeywordPlanAdGroupService"
- },
- {
- "service": "google.ads.googleads.v10.services.KeywordPlanCampaignKeywordService"
- },
- {
- "service": "google.ads.googleads.v10.services.KeywordPlanCampaignService"
- },
- {
- "service": "google.ads.googleads.v10.services.KeywordPlanIdeaService"
- },
- {
- "service": "google.ads.googleads.v10.services.KeywordPlanService"
- },
- {
- "service": "google.ads.googleads.v10.services.KeywordThemeConstantService"
- },
- {
- "service": "google.ads.googleads.v10.services.LabelService"
- },
- {
- "service": "google.ads.googleads.v10.services.MediaFileService"
- },
- {
- "service": "google.ads.googleads.v10.services.MerchantCenterLinkService"
- },
- {
- "service": "google.ads.googleads.v10.services.OfflineUserDataJobService"
- },
- {
- "service": "google.ads.googleads.v10.services.PaymentsAccountService"
- },
- {
- "service": "google.ads.googleads.v10.services.ReachPlanService"
- },
- {
- "service": "google.ads.googleads.v10.services.RecommendationService"
- },
- {
- "service": "google.ads.googleads.v10.services.RemarketingActionService"
- },
- {
- "service": "google.ads.googleads.v10.services.SharedCriterionService"
- },
- {
- "service": "google.ads.googleads.v10.services.SharedSetService"
- },
- {
- "service": "google.ads.googleads.v10.services.SmartCampaignSettingService"
- },
- {
- "service": "google.ads.googleads.v10.services.SmartCampaignSuggestService"
- },
- {
- "service": "google.ads.googleads.v10.services.ThirdPartyAppAnalyticsLinkService"
- },
- {
- "service": "google.ads.googleads.v10.services.UserDataService"
- },
- {
- "service": "google.ads.googleads.v10.services.UserListService"
- }
- ],
- "timeout": "14400s",
- "retryPolicy": {
- "initialBackoff": "5s",
- "maxBackoff": "60s",
- "backoffMultiplier": 1.3,
- "retryableStatusCodes": [
- "UNAVAILABLE",
- "DEADLINE_EXCEEDED"
- ]
- }
- }
- ]
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/googleads_v10.yaml b/third_party/googleapis/google/ads/googleads/v10/googleads_v10.yaml
deleted file mode 100644
index 40a6933df..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/googleads_v10.yaml
+++ /dev/null
@@ -1,810 +0,0 @@
-type: google.api.Service
-config_version: 3
-name: googleads.googleapis.com
-title: Google Ads API
-
-apis:
-- name: google.ads.googleads.v10.services.AccountBudgetProposalService
-- name: google.ads.googleads.v10.services.AccountLinkService
-- name: google.ads.googleads.v10.services.AdGroupAdLabelService
-- name: google.ads.googleads.v10.services.AdGroupAdService
-- name: google.ads.googleads.v10.services.AdGroupAssetService
-- name: google.ads.googleads.v10.services.AdGroupBidModifierService
-- name: google.ads.googleads.v10.services.AdGroupCriterionCustomizerService
-- name: google.ads.googleads.v10.services.AdGroupCriterionLabelService
-- name: google.ads.googleads.v10.services.AdGroupCriterionService
-- name: google.ads.googleads.v10.services.AdGroupCustomizerService
-- name: google.ads.googleads.v10.services.AdGroupExtensionSettingService
-- name: google.ads.googleads.v10.services.AdGroupFeedService
-- name: google.ads.googleads.v10.services.AdGroupLabelService
-- name: google.ads.googleads.v10.services.AdGroupService
-- name: google.ads.googleads.v10.services.AdParameterService
-- name: google.ads.googleads.v10.services.AdService
-- name: google.ads.googleads.v10.services.AssetGroupAssetService
-- name: google.ads.googleads.v10.services.AssetGroupListingGroupFilterService
-- name: google.ads.googleads.v10.services.AssetGroupService
-- name: google.ads.googleads.v10.services.AssetGroupSignalService
-- name: google.ads.googleads.v10.services.AssetService
-- name: google.ads.googleads.v10.services.AssetSetAssetService
-- name: google.ads.googleads.v10.services.AssetSetService
-- name: google.ads.googleads.v10.services.AudienceService
-- name: google.ads.googleads.v10.services.BatchJobService
-- name: google.ads.googleads.v10.services.BiddingDataExclusionService
-- name: google.ads.googleads.v10.services.BiddingSeasonalityAdjustmentService
-- name: google.ads.googleads.v10.services.BiddingStrategyService
-- name: google.ads.googleads.v10.services.BillingSetupService
-- name: google.ads.googleads.v10.services.CampaignAssetService
-- name: google.ads.googleads.v10.services.CampaignAssetSetService
-- name: google.ads.googleads.v10.services.CampaignBidModifierService
-- name: google.ads.googleads.v10.services.CampaignBudgetService
-- name: google.ads.googleads.v10.services.CampaignConversionGoalService
-- name: google.ads.googleads.v10.services.CampaignCriterionService
-- name: google.ads.googleads.v10.services.CampaignCustomizerService
-- name: google.ads.googleads.v10.services.CampaignDraftService
-- name: google.ads.googleads.v10.services.CampaignExperimentService
-- name: google.ads.googleads.v10.services.CampaignExtensionSettingService
-- name: google.ads.googleads.v10.services.CampaignFeedService
-- name: google.ads.googleads.v10.services.CampaignGroupService
-- name: google.ads.googleads.v10.services.CampaignLabelService
-- name: google.ads.googleads.v10.services.CampaignService
-- name: google.ads.googleads.v10.services.CampaignSharedSetService
-- name: google.ads.googleads.v10.services.ConversionActionService
-- name: google.ads.googleads.v10.services.ConversionAdjustmentUploadService
-- name: google.ads.googleads.v10.services.ConversionCustomVariableService
-- name: google.ads.googleads.v10.services.ConversionGoalCampaignConfigService
-- name: google.ads.googleads.v10.services.ConversionUploadService
-- name: google.ads.googleads.v10.services.ConversionValueRuleService
-- name: google.ads.googleads.v10.services.ConversionValueRuleSetService
-- name: google.ads.googleads.v10.services.CustomAudienceService
-- name: google.ads.googleads.v10.services.CustomConversionGoalService
-- name: google.ads.googleads.v10.services.CustomInterestService
-- name: google.ads.googleads.v10.services.CustomerAssetService
-- name: google.ads.googleads.v10.services.CustomerClientLinkService
-- name: google.ads.googleads.v10.services.CustomerConversionGoalService
-- name: google.ads.googleads.v10.services.CustomerCustomizerService
-- name: google.ads.googleads.v10.services.CustomerExtensionSettingService
-- name: google.ads.googleads.v10.services.CustomerFeedService
-- name: google.ads.googleads.v10.services.CustomerLabelService
-- name: google.ads.googleads.v10.services.CustomerManagerLinkService
-- name: google.ads.googleads.v10.services.CustomerNegativeCriterionService
-- name: google.ads.googleads.v10.services.CustomerService
-- name: google.ads.googleads.v10.services.CustomerUserAccessInvitationService
-- name: google.ads.googleads.v10.services.CustomerUserAccessService
-- name: google.ads.googleads.v10.services.CustomizerAttributeService
-- name: google.ads.googleads.v10.services.ExperimentArmService
-- name: google.ads.googleads.v10.services.ExperimentService
-- name: google.ads.googleads.v10.services.ExtensionFeedItemService
-- name: google.ads.googleads.v10.services.FeedItemService
-- name: google.ads.googleads.v10.services.FeedItemSetLinkService
-- name: google.ads.googleads.v10.services.FeedItemSetService
-- name: google.ads.googleads.v10.services.FeedItemTargetService
-- name: google.ads.googleads.v10.services.FeedMappingService
-- name: google.ads.googleads.v10.services.FeedService
-- name: google.ads.googleads.v10.services.GeoTargetConstantService
-- name: google.ads.googleads.v10.services.GoogleAdsFieldService
-- name: google.ads.googleads.v10.services.GoogleAdsService
-- name: google.ads.googleads.v10.services.InvoiceService
-- name: google.ads.googleads.v10.services.KeywordPlanAdGroupKeywordService
-- name: google.ads.googleads.v10.services.KeywordPlanAdGroupService
-- name: google.ads.googleads.v10.services.KeywordPlanCampaignKeywordService
-- name: google.ads.googleads.v10.services.KeywordPlanCampaignService
-- name: google.ads.googleads.v10.services.KeywordPlanIdeaService
-- name: google.ads.googleads.v10.services.KeywordPlanService
-- name: google.ads.googleads.v10.services.KeywordThemeConstantService
-- name: google.ads.googleads.v10.services.LabelService
-- name: google.ads.googleads.v10.services.MediaFileService
-- name: google.ads.googleads.v10.services.MerchantCenterLinkService
-- name: google.ads.googleads.v10.services.OfflineUserDataJobService
-- name: google.ads.googleads.v10.services.PaymentsAccountService
-- name: google.ads.googleads.v10.services.ReachPlanService
-- name: google.ads.googleads.v10.services.RecommendationService
-- name: google.ads.googleads.v10.services.RemarketingActionService
-- name: google.ads.googleads.v10.services.SharedCriterionService
-- name: google.ads.googleads.v10.services.SharedSetService
-- name: google.ads.googleads.v10.services.SmartCampaignSettingService
-- name: google.ads.googleads.v10.services.SmartCampaignSuggestService
-- name: google.ads.googleads.v10.services.ThirdPartyAppAnalyticsLinkService
-- name: google.ads.googleads.v10.services.UserDataService
-- name: google.ads.googleads.v10.services.UserListService
-
-types:
-- name: google.ads.googleads.v10.errors.GoogleAdsFailure
-- name: google.ads.googleads.v10.resources.BatchJob.BatchJobMetadata
-- name: google.ads.googleads.v10.services.CreateCampaignExperimentMetadata
-- name: google.ads.googleads.v10.services.PromoteExperimentMetadata
-- name: google.ads.googleads.v10.services.ScheduleExperimentMetadata
-
-documentation:
- summary: 'Manage your Google Ads accounts, campaigns, and reports with this API.'
- overview: |-
- The Google Ads API enables an app to integrate with the Google Ads
- platform. You can efficiently retrieve and change your Google Ads data
- using the API, making it ideal for managing large or complex accounts and
- campaigns.
-
-backend:
- rules:
- - selector: google.ads.googleads.v10.services.AccountBudgetProposalService.MutateAccountBudgetProposal
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AccountLinkService.CreateAccountLink
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.AccountLinkService.MutateAccountLink
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.AdGroupAdLabelService.MutateAdGroupAdLabels
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdGroupAdService.MutateAdGroupAds
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdGroupAssetService.MutateAdGroupAssets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdGroupBidModifierService.MutateAdGroupBidModifiers
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdGroupCriterionService.MutateAdGroupCriteria
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdGroupCustomizerService.MutateAdGroupCustomizers
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdGroupFeedService.MutateAdGroupFeeds
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdGroupLabelService.MutateAdGroupLabels
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdGroupService.MutateAdGroups
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdParameterService.MutateAdParameters
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdService.GetAd
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AdService.MutateAds
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AssetGroupAssetService.MutateAssetGroupAssets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AssetGroupService.MutateAssetGroups
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AssetGroupSignalService.MutateAssetGroupSignals
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AssetService.MutateAssets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AssetSetAssetService.MutateAssetSetAssets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AssetSetService.MutateAssetSets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.AudienceService.MutateAudiences
- deadline: 600.0
- - selector: 'google.ads.googleads.v10.services.BatchJobService.*'
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.BiddingDataExclusionService.MutateBiddingDataExclusions
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.BiddingStrategyService.MutateBiddingStrategies
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.BillingSetupService.MutateBillingSetup
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignAssetService.MutateCampaignAssets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignAssetSetService.MutateCampaignAssetSets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignBidModifierService.MutateCampaignBidModifiers
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignBudgetService.MutateCampaignBudgets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignConversionGoalService.MutateCampaignConversionGoals
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignCriterionService.MutateCampaignCriteria
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignCustomizerService.MutateCampaignCustomizers
- deadline: 60.0
- - selector: 'google.ads.googleads.v10.services.CampaignDraftService.*'
- deadline: 60.0
- - selector: 'google.ads.googleads.v10.services.CampaignExperimentService.*'
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignFeedService.MutateCampaignFeeds
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignGroupService.MutateCampaignGroups
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignLabelService.MutateCampaignLabels
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignService.MutateCampaigns
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CampaignSharedSetService.MutateCampaignSharedSets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.ConversionActionService.MutateConversionActions
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.ConversionAdjustmentUploadService.UploadConversionAdjustments
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.ConversionCustomVariableService.MutateConversionCustomVariables
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.ConversionUploadService.UploadCallConversions
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.ConversionUploadService.UploadClickConversions
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.ConversionValueRuleService.MutateConversionValueRules
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.ConversionValueRuleSetService.MutateConversionValueRuleSets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomAudienceService.MutateCustomAudiences
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.CustomConversionGoalService.MutateCustomConversionGoals
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomInterestService.MutateCustomInterests
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomerAssetService.MutateCustomerAssets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomerClientLinkService.MutateCustomerClientLink
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomerConversionGoalService.MutateCustomerConversionGoals
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomerCustomizerService.MutateCustomerCustomizers
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomerFeedService.MutateCustomerFeeds
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomerLabelService.MutateCustomerLabels
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomerManagerLinkService.MoveManagerLink
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomerManagerLinkService.MutateCustomerManagerLink
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria
- deadline: 60.0
- - selector: 'google.ads.googleads.v10.services.CustomerService.*'
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.CustomerUserAccessService.MutateCustomerUserAccess
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.CustomizerAttributeService.MutateCustomizerAttributes
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.ExperimentArmService.MutateExperimentArms
- deadline: 60.0
- - selector: 'google.ads.googleads.v10.services.ExperimentService.*'
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.ExtensionFeedItemService.MutateExtensionFeedItems
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.FeedItemService.MutateFeedItems
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.FeedItemSetLinkService.MutateFeedItemSetLinks
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.FeedItemSetService.MutateFeedItemSets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.FeedItemTargetService.MutateFeedItemTargets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.FeedMappingService.MutateFeedMappings
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.FeedService.MutateFeeds
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.GeoTargetConstantService.SuggestGeoTargetConstants
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.GoogleAdsFieldService.GetGoogleAdsField
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.GoogleAdsFieldService.SearchGoogleAdsFields
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.GoogleAdsService.Mutate
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.GoogleAdsService.Search
- deadline: 7200.0
- - selector: google.ads.googleads.v10.services.GoogleAdsService.SearchStream
- deadline: 7200.0
- - selector: google.ads.googleads.v10.services.InvoiceService.ListInvoices
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.KeywordPlanIdeaService.GenerateKeywordIdeas
- deadline: 600.0
- - selector: 'google.ads.googleads.v10.services.KeywordPlanService.*'
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.KeywordPlanService.MutateKeywordPlans
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.KeywordThemeConstantService.SuggestKeywordThemeConstants
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.LabelService.MutateLabels
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.MediaFileService.MutateMediaFiles
- deadline: 60.0
- - selector: 'google.ads.googleads.v10.services.MerchantCenterLinkService.*'
- deadline: 60.0
- - selector: 'google.ads.googleads.v10.services.OfflineUserDataJobService.*'
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.PaymentsAccountService.ListPaymentsAccounts
- deadline: 60.0
- - selector: 'google.ads.googleads.v10.services.ReachPlanService.*'
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.RecommendationService.ApplyRecommendation
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.RecommendationService.DismissRecommendation
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.RemarketingActionService.MutateRemarketingActions
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.SharedCriterionService.MutateSharedCriteria
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.SharedSetService.MutateSharedSets
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.SmartCampaignSettingService.MutateSmartCampaignSettings
- deadline: 60.0
- - selector: 'google.ads.googleads.v10.services.SmartCampaignSuggestService.*'
- deadline: 60.0
- - selector: google.ads.googleads.v10.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.UserDataService.UploadUserData
- deadline: 600.0
- - selector: google.ads.googleads.v10.services.UserListService.MutateUserLists
- deadline: 60.0
- - selector: 'google.longrunning.Operations.*'
- deadline: 60.0
-
-http:
- rules:
- - selector: google.longrunning.Operations.CancelOperation
- post: '/v10/{name=customers/*/operations/*}:cancel'
- body: '*'
- - selector: google.longrunning.Operations.DeleteOperation
- delete: '/v10/{name=customers/*/operations/*}'
- - selector: google.longrunning.Operations.GetOperation
- get: '/v10/{name=customers/*/operations/*}'
- - selector: google.longrunning.Operations.ListOperations
- get: '/v10/{name=customers/*/operations}'
- - selector: google.longrunning.Operations.WaitOperation
- post: '/v10/{name=customers/*/operations/*}:wait'
- body: '*'
-
-authentication:
- rules:
- - selector: google.ads.googleads.v10.services.AccountBudgetProposalService.MutateAccountBudgetProposal
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AccountLinkService.CreateAccountLink
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AccountLinkService.MutateAccountLink
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupAdLabelService.MutateAdGroupAdLabels
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupAdService.MutateAdGroupAds
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupAssetService.MutateAdGroupAssets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupBidModifierService.MutateAdGroupBidModifiers
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupCriterionService.MutateAdGroupCriteria
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupCustomizerService.MutateAdGroupCustomizers
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupFeedService.MutateAdGroupFeeds
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupLabelService.MutateAdGroupLabels
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdGroupService.MutateAdGroups
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdParameterService.MutateAdParameters
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdService.GetAd
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AdService.MutateAds
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AssetGroupAssetService.MutateAssetGroupAssets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AssetGroupService.MutateAssetGroups
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AssetGroupSignalService.MutateAssetGroupSignals
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AssetService.MutateAssets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AssetSetAssetService.MutateAssetSetAssets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AssetSetService.MutateAssetSets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.AudienceService.MutateAudiences
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.ads.googleads.v10.services.BatchJobService.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.BiddingDataExclusionService.MutateBiddingDataExclusions
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.BiddingStrategyService.MutateBiddingStrategies
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.BillingSetupService.MutateBillingSetup
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignAssetService.MutateCampaignAssets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignAssetSetService.MutateCampaignAssetSets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignBidModifierService.MutateCampaignBidModifiers
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignBudgetService.MutateCampaignBudgets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignConversionGoalService.MutateCampaignConversionGoals
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignCriterionService.MutateCampaignCriteria
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignCustomizerService.MutateCampaignCustomizers
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.ads.googleads.v10.services.CampaignDraftService.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.ads.googleads.v10.services.CampaignExperimentService.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignFeedService.MutateCampaignFeeds
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignGroupService.MutateCampaignGroups
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignLabelService.MutateCampaignLabels
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignService.MutateCampaigns
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CampaignSharedSetService.MutateCampaignSharedSets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.ConversionActionService.MutateConversionActions
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.ConversionAdjustmentUploadService.UploadConversionAdjustments
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.ConversionCustomVariableService.MutateConversionCustomVariables
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.ConversionUploadService.UploadCallConversions
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.ConversionUploadService.UploadClickConversions
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.ConversionValueRuleService.MutateConversionValueRules
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.ConversionValueRuleSetService.MutateConversionValueRuleSets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomAudienceService.MutateCustomAudiences
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomConversionGoalService.MutateCustomConversionGoals
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomInterestService.MutateCustomInterests
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerAssetService.MutateCustomerAssets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerClientLinkService.MutateCustomerClientLink
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerConversionGoalService.MutateCustomerConversionGoals
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerCustomizerService.MutateCustomerCustomizers
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerFeedService.MutateCustomerFeeds
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerLabelService.MutateCustomerLabels
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerManagerLinkService.MoveManagerLink
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerManagerLinkService.MutateCustomerManagerLink
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.ads.googleads.v10.services.CustomerService.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomerUserAccessService.MutateCustomerUserAccess
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.CustomizerAttributeService.MutateCustomizerAttributes
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.ExperimentArmService.MutateExperimentArms
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.ads.googleads.v10.services.ExperimentService.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.ExtensionFeedItemService.MutateExtensionFeedItems
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.FeedItemService.MutateFeedItems
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.FeedItemSetLinkService.MutateFeedItemSetLinks
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.FeedItemSetService.MutateFeedItemSets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.FeedItemTargetService.MutateFeedItemTargets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.FeedMappingService.MutateFeedMappings
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.FeedService.MutateFeeds
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.GeoTargetConstantService.SuggestGeoTargetConstants
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.GoogleAdsFieldService.GetGoogleAdsField
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.GoogleAdsFieldService.SearchGoogleAdsFields
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.ads.googleads.v10.services.GoogleAdsService.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.InvoiceService.ListInvoices
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.KeywordPlanIdeaService.GenerateKeywordIdeas
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.ads.googleads.v10.services.KeywordPlanService.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.KeywordThemeConstantService.SuggestKeywordThemeConstants
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.LabelService.MutateLabels
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.MediaFileService.MutateMediaFiles
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.ads.googleads.v10.services.MerchantCenterLinkService.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.ads.googleads.v10.services.OfflineUserDataJobService.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.PaymentsAccountService.ListPaymentsAccounts
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.ads.googleads.v10.services.ReachPlanService.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.RecommendationService.ApplyRecommendation
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.RecommendationService.DismissRecommendation
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.RemarketingActionService.MutateRemarketingActions
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.SharedCriterionService.MutateSharedCriteria
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.SharedSetService.MutateSharedSets
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.SmartCampaignSettingService.MutateSmartCampaignSettings
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.ads.googleads.v10.services.SmartCampaignSuggestService.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.UserDataService.UploadUserData
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: google.ads.googleads.v10.services.UserListService.MutateUserLists
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
- - selector: 'google.longrunning.Operations.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/adwords
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_asset.proto b/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_asset.proto
deleted file mode 100644
index a345353a9..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_asset.proto
+++ /dev/null
@@ -1,79 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/enums/asset_field_type.proto";
-import "google/ads/googleads/v10/enums/asset_link_status.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
-option java_multiple_files = true;
-option java_outer_classname = "AdGroupAssetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
-
-// Proto file describing the AdGroupAsset resource.
-
-// A link between an ad group and an asset.
-message AdGroupAsset {
- option (google.api.resource) = {
- type: "googleads.googleapis.com/AdGroupAsset"
- pattern: "customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}"
- };
-
- // Immutable. The resource name of the ad group asset.
- // AdGroupAsset resource names have the form:
- //
- // `customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}`
- string resource_name = 1 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupAsset"
- }
- ];
-
- // Required. Immutable. The ad group to which the asset is linked.
- string ad_group = 2 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroup"
- }
- ];
-
- // Required. Immutable. The asset which is linked to the ad group.
- string asset = 3 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }
- ];
-
- // Required. Immutable. Role that the asset takes under the linked ad group.
- google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.field_behavior) = IMMUTABLE
- ];
-
- // Status of the ad group asset.
- google.ads.googleads.v10.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/asset.proto b/third_party/googleapis/google/ads/googleads/v10/resources/asset.proto
deleted file mode 100644
index 3b6e5457b..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/resources/asset.proto
+++ /dev/null
@@ -1,179 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/asset_types.proto";
-import "google/ads/googleads/v10/common/custom_parameter.proto";
-import "google/ads/googleads/v10/common/policy.proto";
-import "google/ads/googleads/v10/enums/asset_type.proto";
-import "google/ads/googleads/v10/enums/policy_approval_status.proto";
-import "google/ads/googleads/v10/enums/policy_review_status.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
-option java_multiple_files = true;
-option java_outer_classname = "AssetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
-
-// Proto file describing the asset resource.
-
-// Asset is a part of an ad which can be shared across multiple ads.
-// It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc.
-// Assets are immutable and cannot be removed. To stop an asset from serving,
-// remove the asset from the entity that is using it.
-message Asset {
- option (google.api.resource) = {
- type: "googleads.googleapis.com/Asset"
- pattern: "customers/{customer_id}/assets/{asset_id}"
- };
-
- // Immutable. The resource name of the asset.
- // Asset resource names have the form:
- //
- // `customers/{customer_id}/assets/{asset_id}`
- string resource_name = 1 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }
- ];
-
- // Output only. The ID of the asset.
- optional int64 id = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Optional name of the asset.
- optional string name = 12;
-
- // Output only. Type of the asset.
- google.ads.googleads.v10.enums.AssetTypeEnum.AssetType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // A list of possible final URLs after all cross domain redirects.
- repeated string final_urls = 14;
-
- // A list of possible final mobile URLs after all cross domain redirects.
- repeated string final_mobile_urls = 16;
-
- // URL template for constructing a tracking URL.
- optional string tracking_url_template = 17;
-
- // A list of mappings to be used for substituting URL custom parameter tags in
- // the tracking_url_template, final_urls, and/or final_mobile_urls.
- repeated google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 18;
-
- // URL template for appending params to landing page URLs served with parallel
- // tracking.
- optional string final_url_suffix = 19;
-
- // Output only. Policy information for the asset.
- AssetPolicySummary policy_summary = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The specific type of the asset.
- oneof asset_data {
- // Immutable. A YouTube video asset.
- google.ads.googleads.v10.common.YoutubeVideoAsset youtube_video_asset = 5 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. A media bundle asset.
- google.ads.googleads.v10.common.MediaBundleAsset media_bundle_asset = 6 [(google.api.field_behavior) = IMMUTABLE];
-
- // Output only. An image asset.
- google.ads.googleads.v10.common.ImageAsset image_asset = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Immutable. A text asset.
- google.ads.googleads.v10.common.TextAsset text_asset = 8 [(google.api.field_behavior) = IMMUTABLE];
-
- // A lead form asset.
- google.ads.googleads.v10.common.LeadFormAsset lead_form_asset = 9;
-
- // A book on google asset.
- google.ads.googleads.v10.common.BookOnGoogleAsset book_on_google_asset = 10;
-
- // A promotion asset.
- google.ads.googleads.v10.common.PromotionAsset promotion_asset = 15;
-
- // A callout asset.
- google.ads.googleads.v10.common.CalloutAsset callout_asset = 20;
-
- // A structured snippet asset.
- google.ads.googleads.v10.common.StructuredSnippetAsset structured_snippet_asset = 21;
-
- // A sitelink asset.
- google.ads.googleads.v10.common.SitelinkAsset sitelink_asset = 22;
-
- // A page feed asset.
- google.ads.googleads.v10.common.PageFeedAsset page_feed_asset = 23;
-
- // A dynamic education asset.
- google.ads.googleads.v10.common.DynamicEducationAsset dynamic_education_asset = 24;
-
- // A mobile app asset.
- google.ads.googleads.v10.common.MobileAppAsset mobile_app_asset = 25;
-
- // A hotel callout asset.
- google.ads.googleads.v10.common.HotelCalloutAsset hotel_callout_asset = 26;
-
- // A call asset.
- google.ads.googleads.v10.common.CallAsset call_asset = 27;
-
- // A price asset.
- google.ads.googleads.v10.common.PriceAsset price_asset = 28;
-
- // Immutable. A call to action asset.
- google.ads.googleads.v10.common.CallToActionAsset call_to_action_asset = 29 [(google.api.field_behavior) = IMMUTABLE];
-
- // A dynamic real estate asset.
- google.ads.googleads.v10.common.DynamicRealEstateAsset dynamic_real_estate_asset = 30;
-
- // A dynamic custom asset.
- google.ads.googleads.v10.common.DynamicCustomAsset dynamic_custom_asset = 31;
-
- // A dynamic hotels and rentals asset.
- google.ads.googleads.v10.common.DynamicHotelsAndRentalsAsset dynamic_hotels_and_rentals_asset = 32;
-
- // A dynamic flights asset.
- google.ads.googleads.v10.common.DynamicFlightsAsset dynamic_flights_asset = 33;
-
- // Immutable. A discovery carousel card asset.
- google.ads.googleads.v10.common.DiscoveryCarouselCardAsset discovery_carousel_card_asset = 34 [(google.api.field_behavior) = IMMUTABLE];
-
- // A dynamic travel asset.
- google.ads.googleads.v10.common.DynamicTravelAsset dynamic_travel_asset = 35;
-
- // A dynamic local asset.
- google.ads.googleads.v10.common.DynamicLocalAsset dynamic_local_asset = 36;
-
- // A dynamic jobs asset.
- google.ads.googleads.v10.common.DynamicJobsAsset dynamic_jobs_asset = 37;
- }
-}
-
-// Contains policy information for an asset.
-message AssetPolicySummary {
- // Output only. The list of policy findings for this asset.
- repeated google.ads.googleads.v10.common.PolicyTopicEntry policy_topic_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Where in the review process this asset is.
- google.ads.googleads.v10.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The overall approval status of this asset, calculated based on the status
- // of its individual policy topic entries.
- google.ads.googleads.v10.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/asset_set.proto b/third_party/googleapis/google/ads/googleads/v10/resources/asset_set.proto
deleted file mode 100644
index 3dde31ad4..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/resources/asset_set.proto
+++ /dev/null
@@ -1,79 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/enums/asset_set_status.proto";
-import "google/ads/googleads/v10/enums/asset_set_type.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
-option java_multiple_files = true;
-option java_outer_classname = "AssetSetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
-
-// An asset set representing a collection of assets.
-// Use AssetSetAsset to link an asset to the asset set.
-message AssetSet {
- option (google.api.resource) = {
- type: "googleads.googleapis.com/AssetSet"
- pattern: "customers/{customer_id}/assetSets/{asset_set_id}"
- };
-
- // Merchant ID and Feed Label from Google Merchant Center.
- message MerchantCenterFeed {
- // Required. Merchant ID from Google Merchant Center
- int64 merchant_id = 1 [(google.api.field_behavior) = REQUIRED];
-
- // Optional. Feed Label from Google Merchant Center.
- optional string feed_label = 2 [(google.api.field_behavior) = OPTIONAL];
- }
-
- // Output only. The ID of the asset set.
- int64 id = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Immutable. The resource name of the asset set.
- // Asset set resource names have the form:
- //
- // `customers/{customer_id}/assetSets/{asset_set_id}`
- string resource_name = 1 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetSet"
- }
- ];
-
- // Required. Name of the asset set. Required. It must have a minimum length of 1 and
- // maximum length of 128.
- string name = 2 [(google.api.field_behavior) = REQUIRED];
-
- // Required. Immutable. The type of the asset set. Required.
- google.ads.googleads.v10.enums.AssetSetTypeEnum.AssetSetType type = 3 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.field_behavior) = IMMUTABLE
- ];
-
- // Output only. The status of the asset set. Read-only.
- google.ads.googleads.v10.enums.AssetSetStatusEnum.AssetSetStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Merchant ID and Feed Label from Google Merchant Center.
- MerchantCenterFeed merchant_center_feed = 5;
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_asset.proto b/third_party/googleapis/google/ads/googleads/v10/resources/campaign_asset.proto
deleted file mode 100644
index f68891d65..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_asset.proto
+++ /dev/null
@@ -1,75 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/enums/asset_field_type.proto";
-import "google/ads/googleads/v10/enums/asset_link_status.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
-option java_multiple_files = true;
-option java_outer_classname = "CampaignAssetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
-
-// Proto file describing the CampaignAsset resource.
-
-// A link between a Campaign and an Asset.
-message CampaignAsset {
- option (google.api.resource) = {
- type: "googleads.googleapis.com/CampaignAsset"
- pattern: "customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}"
- };
-
- // Immutable. The resource name of the campaign asset.
- // CampaignAsset resource names have the form:
- //
- // `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
- string resource_name = 1 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignAsset"
- }
- ];
-
- // Immutable. The campaign to which the asset is linked.
- optional string campaign = 6 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Campaign"
- }
- ];
-
- // Immutable. The asset which is linked to the campaign.
- optional string asset = 7 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }
- ];
-
- // Immutable. Role that the asset takes under the linked campaign.
- // Required.
- google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4 [(google.api.field_behavior) = IMMUTABLE];
-
- // Status of the campaign asset.
- google.ads.googleads.v10.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_criterion.proto b/third_party/googleapis/google/ads/googleads/v10/resources/campaign_criterion.proto
deleted file mode 100644
index 595e8643b..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_criterion.proto
+++ /dev/null
@@ -1,180 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/enums/campaign_criterion_status.proto";
-import "google/ads/googleads/v10/enums/criterion_type.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
-option java_multiple_files = true;
-option java_outer_classname = "CampaignCriterionProto";
-option java_package = "com.google.ads.googleads.v10.resources";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
-
-// Proto file describing the Campaign Criterion resource.
-
-// A campaign criterion.
-message CampaignCriterion {
- option (google.api.resource) = {
- type: "googleads.googleapis.com/CampaignCriterion"
- pattern: "customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}"
- };
-
- // Immutable. The resource name of the campaign criterion.
- // Campaign criterion resource names have the form:
- //
- // `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
- string resource_name = 1 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignCriterion"
- }
- ];
-
- // Immutable. The campaign to which the criterion belongs.
- optional string campaign = 37 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Campaign"
- }
- ];
-
- // Output only. The ID of the criterion.
- //
- // This field is ignored during mutate.
- optional int64 criterion_id = 38 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The display name of the criterion.
- //
- // This field is ignored for mutates.
- string display_name = 43 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The modifier for the bids when the criterion matches. The modifier must be
- // in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.
- // Use 0 to opt out of a Device type.
- optional float bid_modifier = 39;
-
- // Immutable. Whether to target (`false`) or exclude (`true`) the criterion.
- optional bool negative = 40 [(google.api.field_behavior) = IMMUTABLE];
-
- // Output only. The type of the criterion.
- google.ads.googleads.v10.enums.CriterionTypeEnum.CriterionType type = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The status of the criterion.
- google.ads.googleads.v10.enums.CampaignCriterionStatusEnum.CampaignCriterionStatus status = 35;
-
- // The campaign criterion.
- //
- // Exactly one must be set.
- oneof criterion {
- // Immutable. Keyword.
- google.ads.googleads.v10.common.KeywordInfo keyword = 8 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Placement.
- google.ads.googleads.v10.common.PlacementInfo placement = 9 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Mobile app category.
- google.ads.googleads.v10.common.MobileAppCategoryInfo mobile_app_category = 10 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Mobile application.
- google.ads.googleads.v10.common.MobileApplicationInfo mobile_application = 11 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Location.
- google.ads.googleads.v10.common.LocationInfo location = 12 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Device.
- google.ads.googleads.v10.common.DeviceInfo device = 13 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Ad Schedule.
- google.ads.googleads.v10.common.AdScheduleInfo ad_schedule = 15 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Age range.
- google.ads.googleads.v10.common.AgeRangeInfo age_range = 16 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Gender.
- google.ads.googleads.v10.common.GenderInfo gender = 17 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Income range.
- google.ads.googleads.v10.common.IncomeRangeInfo income_range = 18 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Parental status.
- google.ads.googleads.v10.common.ParentalStatusInfo parental_status = 19 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. User List.
- google.ads.googleads.v10.common.UserListInfo user_list = 22 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. YouTube Video.
- google.ads.googleads.v10.common.YouTubeVideoInfo youtube_video = 20 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. YouTube Channel.
- google.ads.googleads.v10.common.YouTubeChannelInfo youtube_channel = 21 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Proximity.
- google.ads.googleads.v10.common.ProximityInfo proximity = 23 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Topic.
- google.ads.googleads.v10.common.TopicInfo topic = 24 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Listing scope.
- google.ads.googleads.v10.common.ListingScopeInfo listing_scope = 25 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Language.
- google.ads.googleads.v10.common.LanguageInfo language = 26 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. IpBlock.
- google.ads.googleads.v10.common.IpBlockInfo ip_block = 27 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. ContentLabel.
- google.ads.googleads.v10.common.ContentLabelInfo content_label = 28 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Carrier.
- google.ads.googleads.v10.common.CarrierInfo carrier = 29 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. User Interest.
- google.ads.googleads.v10.common.UserInterestInfo user_interest = 30 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Webpage.
- google.ads.googleads.v10.common.WebpageInfo webpage = 31 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Operating system version.
- google.ads.googleads.v10.common.OperatingSystemVersionInfo operating_system_version = 32 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Mobile Device.
- google.ads.googleads.v10.common.MobileDeviceInfo mobile_device = 33 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Location Group
- google.ads.googleads.v10.common.LocationGroupInfo location_group = 34 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Custom Affinity.
- google.ads.googleads.v10.common.CustomAffinityInfo custom_affinity = 36 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Custom Audience
- google.ads.googleads.v10.common.CustomAudienceInfo custom_audience = 41 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Combined Audience.
- google.ads.googleads.v10.common.CombinedAudienceInfo combined_audience = 42 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Smart Campaign Keyword Theme.
- google.ads.googleads.v10.common.KeywordThemeInfo keyword_theme = 45 [(google.api.field_behavior) = IMMUTABLE];
- }
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_experiment.proto b/third_party/googleapis/google/ads/googleads/v10/resources/campaign_experiment.proto
deleted file mode 100644
index f2ca0b65c..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_experiment.proto
+++ /dev/null
@@ -1,120 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/enums/campaign_experiment_status.proto";
-import "google/ads/googleads/v10/enums/campaign_experiment_traffic_split_type.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
-option java_multiple_files = true;
-option java_outer_classname = "CampaignExperimentProto";
-option java_package = "com.google.ads.googleads.v10.resources";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
-
-// Proto file describing the Campaign Experiment resource.
-
-// An A/B experiment that compares the performance of the base campaign
-// (the control) and a variation of that campaign (the experiment).
-message CampaignExperiment {
- option (google.api.resource) = {
- type: "googleads.googleapis.com/CampaignExperiment"
- pattern: "customers/{customer_id}/campaignExperiments/{campaign_experiment_id}"
- };
-
- // Immutable. The resource name of the campaign experiment.
- // Campaign experiment resource names have the form:
- //
- // `customers/{customer_id}/campaignExperiments/{campaign_experiment_id}`
- string resource_name = 1 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignExperiment"
- }
- ];
-
- // Output only. The ID of the campaign experiment.
- //
- // This field is read-only.
- optional int64 id = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Immutable. The campaign draft with staged changes to the base campaign.
- optional string campaign_draft = 14 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignDraft"
- }
- ];
-
- // The name of the campaign experiment.
- //
- // This field is required when creating new campaign experiments
- // and must not conflict with the name of another non-removed
- // campaign experiment or campaign.
- //
- // It must not contain any null (code point 0x0), NL line feed
- // (code point 0xA) or carriage return (code point 0xD) characters.
- optional string name = 15;
-
- // The description of the experiment.
- optional string description = 16;
-
- // Immutable. Share of traffic directed to experiment as a percent (must be between 1 and
- // 99 inclusive. Base campaign receives the remainder of the traffic
- // (100 - traffic_split_percent). Required for create.
- optional int64 traffic_split_percent = 17 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Determines the behavior of the traffic split.
- google.ads.googleads.v10.enums.CampaignExperimentTrafficSplitTypeEnum.CampaignExperimentTrafficSplitType traffic_split_type = 7 [(google.api.field_behavior) = IMMUTABLE];
-
- // Output only. The experiment campaign, as opposed to the base campaign.
- optional string experiment_campaign = 18 [
- (google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Campaign"
- }
- ];
-
- // Output only. The status of the campaign experiment. This field is read-only.
- google.ads.googleads.v10.enums.CampaignExperimentStatusEnum.CampaignExperimentStatus status = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The resource name of the long-running operation that can be used to poll
- // for completion of experiment create or promote. The most recent long
- // running operation is returned.
- optional string long_running_operation = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Date when the campaign experiment starts. By default, the experiment starts
- // now or on the campaign's start date, whichever is later. If this field is
- // set, then the experiment starts at the beginning of the specified date in
- // the customer's time zone. Cannot be changed once the experiment starts.
- //
- // Format: YYYY-MM-DD
- // Example: 2019-03-14
- optional string start_date = 20;
-
- // The last day of the campaign experiment. By default, the experiment ends on
- // the campaign's end date. If this field is set, then the experiment ends at
- // the end of the specified date in the customer's time zone.
- //
- // Format: YYYY-MM-DD
- // Example: 2019-04-18
- optional string end_date = 21;
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_asset.proto b/third_party/googleapis/google/ads/googleads/v10/resources/customer_asset.proto
deleted file mode 100644
index 118b7cbdc..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_asset.proto
+++ /dev/null
@@ -1,70 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/enums/asset_field_type.proto";
-import "google/ads/googleads/v10/enums/asset_link_status.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
-option java_multiple_files = true;
-option java_outer_classname = "CustomerAssetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
-
-// Proto file describing the CustomerAsset resource.
-
-// A link between a customer and an asset.
-message CustomerAsset {
- option (google.api.resource) = {
- type: "googleads.googleapis.com/CustomerAsset"
- pattern: "customers/{customer_id}/customerAssets/{asset_id}~{field_type}"
- };
-
- // Immutable. The resource name of the customer asset.
- // CustomerAsset resource names have the form:
- //
- // `customers/{customer_id}/customerAssets/{asset_id}~{field_type}`
- string resource_name = 1 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerAsset"
- }
- ];
-
- // Required. Immutable. The asset which is linked to the customer.
- string asset = 2 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }
- ];
-
- // Required. Immutable. Role that the asset takes for the customer link.
- google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType field_type = 3 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.field_behavior) = IMMUTABLE
- ];
-
- // Status of the customer asset.
- google.ads.googleads.v10.enums.AssetLinkStatusEnum.AssetLinkStatus status = 4;
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/feed_mapping.proto b/third_party/googleapis/google/ads/googleads/v10/resources/feed_mapping.proto
deleted file mode 100644
index 37ee7cee4..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/resources/feed_mapping.proto
+++ /dev/null
@@ -1,188 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/enums/ad_customizer_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/affiliate_location_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/app_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/call_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/callout_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/custom_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/dsa_page_feed_criterion_field.proto";
-import "google/ads/googleads/v10/enums/education_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/feed_mapping_criterion_type.proto";
-import "google/ads/googleads/v10/enums/feed_mapping_status.proto";
-import "google/ads/googleads/v10/enums/flight_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/hotel_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/image_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/job_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/local_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/location_extension_targeting_criterion_field.proto";
-import "google/ads/googleads/v10/enums/location_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/message_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/placeholder_type.proto";
-import "google/ads/googleads/v10/enums/price_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/promotion_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/real_estate_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/sitelink_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/structured_snippet_placeholder_field.proto";
-import "google/ads/googleads/v10/enums/travel_placeholder_field.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
-option java_multiple_files = true;
-option java_outer_classname = "FeedMappingProto";
-option java_package = "com.google.ads.googleads.v10.resources";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
-
-// Proto file describing the FeedMapping resource.
-
-// A feed mapping.
-message FeedMapping {
- option (google.api.resource) = {
- type: "googleads.googleapis.com/FeedMapping"
- pattern: "customers/{customer_id}/feedMappings/{feed_id}~{feed_mapping_id}"
- };
-
- // Immutable. The resource name of the feed mapping.
- // Feed mapping resource names have the form:
- //
- // `customers/{customer_id}/feedMappings/{feed_id}~{feed_mapping_id}`
- string resource_name = 1 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/FeedMapping"
- }
- ];
-
- // Immutable. The feed of this feed mapping.
- optional string feed = 7 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }
- ];
-
- // Immutable. Feed attributes to field mappings. These mappings are a one-to-many
- // relationship meaning that 1 feed attribute can be used to populate
- // multiple placeholder fields, but 1 placeholder field can only draw
- // data from 1 feed attribute. Ad Customizer is an exception, 1 placeholder
- // field can be mapped to multiple feed attributes. Required.
- repeated AttributeFieldMapping attribute_field_mappings = 5 [(google.api.field_behavior) = IMMUTABLE];
-
- // Output only. Status of the feed mapping.
- // This field is read-only.
- google.ads.googleads.v10.enums.FeedMappingStatusEnum.FeedMappingStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Feed mapping target. Can be either a placeholder or a criterion. For a
- // given feed, the active FeedMappings must have unique targets. Required.
- oneof target {
- // Immutable. The placeholder type of this mapping (i.e., if the mapping maps feed
- // attributes to placeholder fields).
- google.ads.googleads.v10.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 3 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. The criterion type of this mapping (i.e., if the mapping maps feed
- // attributes to criterion fields).
- google.ads.googleads.v10.enums.FeedMappingCriterionTypeEnum.FeedMappingCriterionType criterion_type = 4 [(google.api.field_behavior) = IMMUTABLE];
- }
-}
-
-// Maps from feed attribute id to a placeholder or criterion field id.
-message AttributeFieldMapping {
- // Immutable. Feed attribute from which to map.
- optional int64 feed_attribute_id = 24 [(google.api.field_behavior) = IMMUTABLE];
-
- // Output only. The placeholder field ID. If a placeholder field enum is not published in
- // the current API version, then this field will be populated and the field
- // oneof will be empty.
- // This field is read-only.
- optional int64 field_id = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Placeholder or criterion field to be populated using data from
- // the above feed attribute. Required.
- oneof field {
- // Immutable. Sitelink Placeholder Fields.
- google.ads.googleads.v10.enums.SitelinkPlaceholderFieldEnum.SitelinkPlaceholderField sitelink_field = 3 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Call Placeholder Fields.
- google.ads.googleads.v10.enums.CallPlaceholderFieldEnum.CallPlaceholderField call_field = 4 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. App Placeholder Fields.
- google.ads.googleads.v10.enums.AppPlaceholderFieldEnum.AppPlaceholderField app_field = 5 [(google.api.field_behavior) = IMMUTABLE];
-
- // Output only. Location Placeholder Fields. This field is read-only.
- google.ads.googleads.v10.enums.LocationPlaceholderFieldEnum.LocationPlaceholderField location_field = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Affiliate Location Placeholder Fields. This field is read-only.
- google.ads.googleads.v10.enums.AffiliateLocationPlaceholderFieldEnum.AffiliateLocationPlaceholderField affiliate_location_field = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Immutable. Callout Placeholder Fields.
- google.ads.googleads.v10.enums.CalloutPlaceholderFieldEnum.CalloutPlaceholderField callout_field = 8 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Structured Snippet Placeholder Fields.
- google.ads.googleads.v10.enums.StructuredSnippetPlaceholderFieldEnum.StructuredSnippetPlaceholderField structured_snippet_field = 9 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Message Placeholder Fields.
- google.ads.googleads.v10.enums.MessagePlaceholderFieldEnum.MessagePlaceholderField message_field = 10 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Price Placeholder Fields.
- google.ads.googleads.v10.enums.PricePlaceholderFieldEnum.PricePlaceholderField price_field = 11 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Promotion Placeholder Fields.
- google.ads.googleads.v10.enums.PromotionPlaceholderFieldEnum.PromotionPlaceholderField promotion_field = 12 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Ad Customizer Placeholder Fields
- google.ads.googleads.v10.enums.AdCustomizerPlaceholderFieldEnum.AdCustomizerPlaceholderField ad_customizer_field = 13 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Dynamic Search Ad Page Feed Fields.
- google.ads.googleads.v10.enums.DsaPageFeedCriterionFieldEnum.DsaPageFeedCriterionField dsa_page_feed_field = 14 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Location Target Fields.
- google.ads.googleads.v10.enums.LocationExtensionTargetingCriterionFieldEnum.LocationExtensionTargetingCriterionField location_extension_targeting_field = 15 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Education Placeholder Fields
- google.ads.googleads.v10.enums.EducationPlaceholderFieldEnum.EducationPlaceholderField education_field = 16 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Flight Placeholder Fields
- google.ads.googleads.v10.enums.FlightPlaceholderFieldEnum.FlightPlaceholderField flight_field = 17 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Custom Placeholder Fields
- google.ads.googleads.v10.enums.CustomPlaceholderFieldEnum.CustomPlaceholderField custom_field = 18 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Hotel Placeholder Fields
- google.ads.googleads.v10.enums.HotelPlaceholderFieldEnum.HotelPlaceholderField hotel_field = 19 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Real Estate Placeholder Fields
- google.ads.googleads.v10.enums.RealEstatePlaceholderFieldEnum.RealEstatePlaceholderField real_estate_field = 20 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Travel Placeholder Fields
- google.ads.googleads.v10.enums.TravelPlaceholderFieldEnum.TravelPlaceholderField travel_field = 21 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Local Placeholder Fields
- google.ads.googleads.v10.enums.LocalPlaceholderFieldEnum.LocalPlaceholderField local_field = 22 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Job Placeholder Fields
- google.ads.googleads.v10.enums.JobPlaceholderFieldEnum.JobPlaceholderField job_field = 23 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Image Placeholder Fields
- google.ads.googleads.v10.enums.ImagePlaceholderFieldEnum.ImagePlaceholderField image_field = 26 [(google.api.field_behavior) = IMMUTABLE];
- }
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/invoice.proto b/third_party/googleapis/google/ads/googleads/v10/resources/invoice.proto
deleted file mode 100644
index c914f1c73..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/resources/invoice.proto
+++ /dev/null
@@ -1,202 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/dates.proto";
-import "google/ads/googleads/v10/enums/invoice_type.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
-option java_multiple_files = true;
-option java_outer_classname = "InvoiceProto";
-option java_package = "com.google.ads.googleads.v10.resources";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
-
-// Proto file describing the Invoice resource.
-
-// An invoice. All invoice information is snapshotted to match the PDF invoice.
-// For invoices older than the launch of InvoiceService, the snapshotted
-// information may not match the PDF invoice.
-message Invoice {
- option (google.api.resource) = {
- type: "googleads.googleapis.com/Invoice"
- pattern: "customers/{customer_id}/invoices/{invoice_id}"
- };
-
- // Represents a summarized account budget billable cost.
- message AccountBudgetSummary {
- // Output only. The resource name of the customer associated with this account budget.
- // This contains the customer ID, which appears on the invoice PDF as
- // "Account ID".
- // Customer resource names have the form:
- //
- // `customers/{customer_id}`
- optional string customer = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The descriptive name of the account budget's customer. It appears on the
- // invoice PDF as "Account".
- optional string customer_descriptive_name = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The resource name of the account budget associated with this summarized
- // billable cost.
- // AccountBudget resource names have the form:
- //
- // `customers/{customer_id}/accountBudgets/{account_budget_id}`
- optional string account_budget = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The name of the account budget. It appears on the invoice PDF as "Account
- // budget".
- optional string account_budget_name = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The purchase order number of the account budget. It appears on the
- // invoice PDF as "Purchase order".
- optional string purchase_order_number = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The pretax subtotal amount attributable to this budget during the service
- // period, in micros.
- optional int64 subtotal_amount_micros = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The tax amount attributable to this budget during the service period, in
- // micros.
- optional int64 tax_amount_micros = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The total amount attributable to this budget during the service period,
- // in micros. This equals the sum of the account budget subtotal amount and
- // the account budget tax amount.
- optional int64 total_amount_micros = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The billable activity date range of the account budget, within the
- // service date range of this invoice. The end date is inclusive. This can
- // be different from the account budget's start and end time.
- google.ads.googleads.v10.common.DateRange billable_activity_date_range = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // Output only. The resource name of the invoice. Multiple customers can share a given
- // invoice, so multiple resource names may point to the same invoice.
- // Invoice resource names have the form:
- //
- // `customers/{customer_id}/invoices/{invoice_id}`
- string resource_name = 1 [
- (google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Invoice"
- }
- ];
-
- // Output only. The ID of the invoice. It appears on the invoice PDF as "Invoice number".
- optional string id = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The type of invoice.
- google.ads.googleads.v10.enums.InvoiceTypeEnum.InvoiceType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The resource name of this invoice's billing setup.
- //
- // `customers/{customer_id}/billingSetups/{billing_setup_id}`
- optional string billing_setup = 26 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. A 16 digit ID used to identify the payments account associated with the
- // billing setup, e.g. "1234-5678-9012-3456". It appears on the invoice PDF as
- // "Billing Account Number".
- optional string payments_account_id = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. A 12 digit ID used to identify the payments profile associated with the
- // billing setup, e.g. "1234-5678-9012". It appears on the invoice PDF as
- // "Billing ID".
- optional string payments_profile_id = 28 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The issue date in yyyy-mm-dd format. It appears on the invoice PDF as
- // either "Issue date" or "Invoice date".
- optional string issue_date = 29 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The due date in yyyy-mm-dd format.
- optional string due_date = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The service period date range of this invoice. The end date is inclusive.
- google.ads.googleads.v10.common.DateRange service_date_range = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The currency code. All costs are returned in this currency. A subset of the
- // currency codes derived from the ISO 4217 standard is supported.
- optional string currency_code = 31 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The pretax subtotal amount of invoice level adjustments, in micros.
- int64 adjustments_subtotal_amount_micros = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The sum of taxes on the invoice level adjustments, in micros.
- int64 adjustments_tax_amount_micros = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The total amount of invoice level adjustments, in micros.
- int64 adjustments_total_amount_micros = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The pretax subtotal amount of invoice level regulatory costs, in micros.
- int64 regulatory_costs_subtotal_amount_micros = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The sum of taxes on the invoice level regulatory costs, in micros.
- int64 regulatory_costs_tax_amount_micros = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The total amount of invoice level regulatory costs, in micros.
- int64 regulatory_costs_total_amount_micros = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The pretax subtotal amount, in micros. This equals the
- // sum of the AccountBudgetSummary subtotal amounts,
- // Invoice.adjustments_subtotal_amount_micros, and
- // Invoice.regulatory_costs_subtotal_amount_micros.
- // Starting with v6, the Invoice.regulatory_costs_subtotal_amount_micros is no
- // longer included.
- optional int64 subtotal_amount_micros = 33 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The sum of all taxes on the invoice, in micros. This equals the sum of the
- // AccountBudgetSummary tax amounts, plus taxes not associated with a specific
- // account budget.
- optional int64 tax_amount_micros = 34 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The total amount, in micros. This equals the sum of
- // Invoice.subtotal_amount_micros and Invoice.tax_amount_micros.
- // Starting with v6, Invoice.regulatory_costs_subtotal_amount_micros is
- // also added as it is no longer already included in
- // Invoice.tax_amount_micros.
- optional int64 total_amount_micros = 35 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The resource name of the original invoice corrected, wrote off, or canceled
- // by this invoice, if applicable. If `corrected_invoice` is set,
- // `replaced_invoices` will not be set.
- // Invoice resource names have the form:
- //
- // `customers/{customer_id}/invoices/{invoice_id}`
- optional string corrected_invoice = 36 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The resource name of the original invoice(s) being rebilled or replaced by
- // this invoice, if applicable. There might be multiple replaced invoices due
- // to invoice consolidation. The replaced invoices may not belong to the same
- // payments account. If `replaced_invoices` is set, `corrected_invoice` will
- // not be set.
- // Invoice resource names have the form:
- //
- // `customers/{customer_id}/invoices/{invoice_id}`
- repeated string replaced_invoices = 37 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The URL to a PDF copy of the invoice. Users need to pass in their OAuth
- // token to request the PDF with this URL.
- optional string pdf_url = 38 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The list of summarized account budget information associated with this
- // invoice.
- repeated AccountBudgetSummary account_budget_summaries = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/recommendation.proto b/third_party/googleapis/google/ads/googleads/v10/resources/recommendation.proto
deleted file mode 100644
index 076ce11b9..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/resources/recommendation.proto
+++ /dev/null
@@ -1,386 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/common/extensions.proto";
-import "google/ads/googleads/v10/enums/keyword_match_type.proto";
-import "google/ads/googleads/v10/enums/recommendation_type.proto";
-import "google/ads/googleads/v10/enums/target_cpa_opt_in_recommendation_goal.proto";
-import "google/ads/googleads/v10/resources/ad.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
-option java_multiple_files = true;
-option java_outer_classname = "RecommendationProto";
-option java_package = "com.google.ads.googleads.v10.resources";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
-
-// Proto file describing the Recommendation resource.
-
-// A recommendation.
-message Recommendation {
- option (google.api.resource) = {
- type: "googleads.googleapis.com/Recommendation"
- pattern: "customers/{customer_id}/recommendations/{recommendation_id}"
- };
-
- // The impact of making the change as described in the recommendation.
- // Some types of recommendations may not have impact information.
- message RecommendationImpact {
- // Output only. Base metrics at the time the recommendation was generated.
- RecommendationMetrics base_metrics = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Estimated metrics if the recommendation is applied.
- RecommendationMetrics potential_metrics = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // Weekly account performance metrics. For some recommendation types, these
- // are averaged over the past 90-day period and hence can be fractional.
- message RecommendationMetrics {
- // Output only. Number of ad impressions.
- optional double impressions = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Number of ad clicks.
- optional double clicks = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Cost (in micros) for advertising, in the local currency for the account.
- optional int64 cost_micros = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Number of conversions.
- optional double conversions = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Number of video views for a video ad campaign.
- optional double video_views = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The budget recommendation for budget constrained campaigns.
- message CampaignBudgetRecommendation {
- // The impact estimates for a given budget amount.
- message CampaignBudgetRecommendationOption {
- // Output only. The budget amount for this option.
- optional int64 budget_amount_micros = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The impact estimate if budget is changed to amount specified in this
- // option.
- RecommendationImpact impact = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // Output only. The current budget amount in micros.
- optional int64 current_budget_amount_micros = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The recommended budget amount in micros.
- optional int64 recommended_budget_amount_micros = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The budget amounts and associated impact estimates for some values of
- // possible budget amounts.
- repeated CampaignBudgetRecommendationOption budget_options = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The keyword recommendation.
- message KeywordRecommendation {
- // Output only. The recommended keyword.
- google.ads.googleads.v10.common.KeywordInfo keyword = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The recommended CPC (cost-per-click) bid.
- optional int64 recommended_cpc_bid_micros = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The text ad recommendation.
- message TextAdRecommendation {
- // Output only. Recommended ad.
- Ad ad = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Creation date of the recommended ad.
- // YYYY-MM-DD format, e.g., 2018-04-17.
- optional string creation_date = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Date, if present, is the earliest when the recommendation will be auto
- // applied.
- // YYYY-MM-DD format, e.g., 2018-04-17.
- optional string auto_apply_date = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The Target CPA opt-in recommendation.
- message TargetCpaOptInRecommendation {
- // The Target CPA opt-in option with impact estimate.
- message TargetCpaOptInRecommendationOption {
- // Output only. The goal achieved by this option.
- google.ads.googleads.v10.enums.TargetCpaOptInRecommendationGoalEnum.TargetCpaOptInRecommendationGoal goal = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Average CPA target.
- optional int64 target_cpa_micros = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The minimum campaign budget, in local currency for the account,
- // required to achieve the target CPA.
- // Amount is specified in micros, where one million is equivalent to one
- // currency unit.
- optional int64 required_campaign_budget_amount_micros = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The impact estimate if this option is selected.
- RecommendationImpact impact = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // Output only. The available goals and corresponding options for Target CPA strategy.
- repeated TargetCpaOptInRecommendationOption options = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The recommended average CPA target. See required budget amount and impact
- // of using this recommendation in options list.
- optional int64 recommended_target_cpa_micros = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The Maximize Conversions Opt-In recommendation.
- message MaximizeConversionsOptInRecommendation {
- // Output only. The recommended new budget amount.
- optional int64 recommended_budget_amount_micros = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The Enhanced Cost-Per-Click Opt-In recommendation.
- message EnhancedCpcOptInRecommendation {
-
- }
-
- // The Search Partners Opt-In recommendation.
- message SearchPartnersOptInRecommendation {
-
- }
-
- // The Maximize Clicks opt-in recommendation.
- message MaximizeClicksOptInRecommendation {
- // Output only. The recommended new budget amount.
- // Only set if the current budget is too high.
- optional int64 recommended_budget_amount_micros = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The Optimize Ad Rotation recommendation.
- message OptimizeAdRotationRecommendation {
-
- }
-
- // The Callout extension recommendation.
- message CalloutExtensionRecommendation {
- // Output only. Callout extensions recommended to be added.
- repeated google.ads.googleads.v10.common.CalloutFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The Sitelink extension recommendation.
- message SitelinkExtensionRecommendation {
- // Output only. Sitelink extensions recommended to be added.
- repeated google.ads.googleads.v10.common.SitelinkFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The Call extension recommendation.
- message CallExtensionRecommendation {
- // Output only. Call extensions recommended to be added.
- repeated google.ads.googleads.v10.common.CallFeedItem recommended_extensions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The keyword match type recommendation.
- message KeywordMatchTypeRecommendation {
- // Output only. The existing keyword where the match type should be more broad.
- google.ads.googleads.v10.common.KeywordInfo keyword = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The recommended new match type.
- google.ads.googleads.v10.enums.KeywordMatchTypeEnum.KeywordMatchType recommended_match_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The move unused budget recommendation.
- message MoveUnusedBudgetRecommendation {
- // Output only. The excess budget's resource_name.
- optional string excess_campaign_budget = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The recommendation for the constrained budget to increase.
- CampaignBudgetRecommendation budget_recommendation = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The Target ROAS opt-in recommendation.
- message TargetRoasOptInRecommendation {
- // Output only. The recommended target ROAS (revenue per unit of spend).
- // The value is between 0.01 and 1000.0, inclusive.
- optional double recommended_target_roas = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The minimum campaign budget, in local currency for the account,
- // required to achieve the target ROAS.
- // Amount is specified in micros, where one million is equivalent to one
- // currency unit.
- optional int64 required_campaign_budget_amount_micros = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The add responsive search ad asset recommendation.
- message ResponsiveSearchAdAssetRecommendation {
- // Output only. The current ad to be updated.
- Ad current_ad = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The recommended assets. This is populated only with the new headlines
- // and/or descriptions, and is otherwise empty.
- Ad recommended_assets = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The add responsive search ad recommendation.
- message ResponsiveSearchAdRecommendation {
- // Output only. Recommended ad.
- Ad ad = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // The use broad match keyword recommendation.
- message UseBroadMatchKeywordRecommendation {
- // Output only. Sample of keywords to be expanded to Broad Match.
- repeated google.ads.googleads.v10.common.KeywordInfo keyword = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Total number of keywords to be expanded to Broad Match in the campaign.
- int64 suggested_keywords_count = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Total number of keywords in the campaign.
- int64 campaign_keywords_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Whether the associated campaign uses a shared budget.
- bool campaign_uses_shared_budget = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The budget recommended to avoid becoming budget constrained after
- // applying the recommendation.
- int64 required_campaign_budget_amount_micros = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
- // Immutable. The resource name of the recommendation.
- //
- // `customers/{customer_id}/recommendations/{recommendation_id}`
- string resource_name = 1 [
- (google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Recommendation"
- }
- ];
-
- // Output only. The type of recommendation.
- google.ads.googleads.v10.enums.RecommendationTypeEnum.RecommendationType type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The impact on account performance as a result of applying the
- // recommendation.
- RecommendationImpact impact = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The budget targeted by this recommendation. This will be set only when
- // the recommendation affects a single campaign budget.
- //
- // This field will be set for the following recommendation types:
- // CAMPAIGN_BUDGET, FORECASTING_CAMPAIGN_BUDGET, MARGINAL_ROI_CAMPAIGN_BUDGET,
- // MOVE_UNUSED_BUDGET
- optional string campaign_budget = 24 [
- (google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignBudget"
- }
- ];
-
- // Output only. The campaign targeted by this recommendation. This will be set only when
- // the recommendation affects a single campaign.
- //
- // This field will be set for the following recommendation types:
- // CALL_EXTENSION, CALLOUT_EXTENSION, ENHANCED_CPC_OPT_IN,
- // USE_BROAD_MATCH_KEYWORD, KEYWORD, KEYWORD_MATCH_TYPE,
- // MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, OPTIMIZE_AD_ROTATION,
- // RESPONSIVE_SEARCH_AD, RESPONSIVE_SEARCH_AD_ASSET, SEARCH_PARTNERS_OPT_IN,
- // SITELINK_EXTENSION, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN, TEXT_AD
- optional string campaign = 25 [
- (google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Campaign"
- }
- ];
-
- // Output only. The ad group targeted by this recommendation. This will be set only when
- // the recommendation affects a single ad group.
- //
- // This field will be set for the following recommendation types:
- // KEYWORD, OPTIMIZE_AD_ROTATION, RESPONSIVE_SEARCH_AD,
- // RESPONSIVE_SEARCH_AD_ASSET, TEXT_AD
- optional string ad_group = 26 [
- (google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroup"
- }
- ];
-
- // Output only. Whether the recommendation is dismissed or not.
- optional bool dismissed = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The details of recommendation.
- oneof recommendation {
- // Output only. The campaign budget recommendation.
- CampaignBudgetRecommendation campaign_budget_recommendation = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The forecasting campaign budget recommendation.
- CampaignBudgetRecommendation forecasting_campaign_budget_recommendation = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The keyword recommendation.
- KeywordRecommendation keyword_recommendation = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Add expanded text ad recommendation.
- TextAdRecommendation text_ad_recommendation = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The TargetCPA opt-in recommendation.
- TargetCpaOptInRecommendation target_cpa_opt_in_recommendation = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The MaximizeConversions Opt-In recommendation.
- MaximizeConversionsOptInRecommendation maximize_conversions_opt_in_recommendation = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The Enhanced Cost-Per-Click Opt-In recommendation.
- EnhancedCpcOptInRecommendation enhanced_cpc_opt_in_recommendation = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The Search Partners Opt-In recommendation.
- SearchPartnersOptInRecommendation search_partners_opt_in_recommendation = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The MaximizeClicks Opt-In recommendation.
- MaximizeClicksOptInRecommendation maximize_clicks_opt_in_recommendation = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The Optimize Ad Rotation recommendation.
- OptimizeAdRotationRecommendation optimize_ad_rotation_recommendation = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The Callout extension recommendation.
- CalloutExtensionRecommendation callout_extension_recommendation = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The Sitelink extension recommendation.
- SitelinkExtensionRecommendation sitelink_extension_recommendation = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The Call extension recommendation.
- CallExtensionRecommendation call_extension_recommendation = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The keyword match type recommendation.
- KeywordMatchTypeRecommendation keyword_match_type_recommendation = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The move unused budget recommendation.
- MoveUnusedBudgetRecommendation move_unused_budget_recommendation = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The Target ROAS opt-in recommendation.
- TargetRoasOptInRecommendation target_roas_opt_in_recommendation = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The add responsive search ad recommendation.
- ResponsiveSearchAdRecommendation responsive_search_ad_recommendation = 28 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The marginal ROI campaign budget recommendation.
- CampaignBudgetRecommendation marginal_roi_campaign_budget_recommendation = 29 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The use broad match keyword recommendation.
- UseBroadMatchKeywordRecommendation use_broad_match_keyword_recommendation = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The add responsive search ad asset recommendation.
- ResponsiveSearchAdAssetRecommendation responsive_search_ad_asset_recommendation = 31 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_experiment_service.proto b/third_party/googleapis/google/ads/googleads/v10/services/campaign_experiment_service.proto
deleted file mode 100644
index b3908bddd..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_experiment_service.proto
+++ /dev/null
@@ -1,374 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.services;
-
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_experiment.proto";
-import "google/api/annotations.proto";
-import "google/api/client.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-import "google/longrunning/operations.proto";
-import "google/protobuf/empty.proto";
-import "google/protobuf/field_mask.proto";
-import "google/rpc/status.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
-option java_multiple_files = true;
-option java_outer_classname = "CampaignExperimentServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
-
-// Proto file describing the Campaign Experiment service.
-
-// CampaignExperimentService manages the life cycle of campaign experiments.
-// It is used to create new experiments from drafts, modify experiment
-// properties, promote changes in an experiment back to its base campaign,
-// graduate experiments into new stand-alone campaigns, and to remove an
-// experiment.
-//
-// An experiment consists of two variants or arms - the base campaign and the
-// experiment campaign, directing a fixed share of traffic to each arm.
-// A campaign experiment is created from a draft of changes to the base campaign
-// and will be a snapshot of changes in the draft at the time of creation.
-service CampaignExperimentService {
- option (google.api.default_host) = "googleads.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";
-
- // Creates a campaign experiment based on a campaign draft. The draft campaign
- // will be forked into a real campaign (called the experiment campaign) that
- // will begin serving ads if successfully created.
- //
- // The campaign experiment is created immediately with status INITIALIZING.
- // This method return a long running operation that tracks the forking of the
- // draft campaign. If the forking fails, a list of errors can be retrieved
- // using the ListCampaignExperimentAsyncErrors method. The operation's
- // metadata will be a StringValue containing the resource name of the created
- // campaign experiment.
- //
- // List of thrown errors:
- // [AuthenticationError]()
- // [AuthorizationError]()
- // [CampaignExperimentError]()
- // [DatabaseError]()
- // [DateError]()
- // [DateRangeError]()
- // [FieldError]()
- // [HeaderError]()
- // [InternalError]()
- // [QuotaError]()
- // [RangeError]()
- // [RequestError]()
- rpc CreateCampaignExperiment(CreateCampaignExperimentRequest) returns (google.longrunning.Operation) {
- option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignExperiments:create"
- body: "*"
- };
- option (google.api.method_signature) = "customer_id,campaign_experiment";
- option (google.longrunning.operation_info) = {
- response_type: "google.protobuf.Empty"
- metadata_type: "google.ads.googleads.v10.services.CreateCampaignExperimentMetadata"
- };
- }
-
- // Updates campaign experiments. Operation statuses are returned.
- //
- // List of thrown errors:
- // [AuthenticationError]()
- // [AuthorizationError]()
- // [CampaignExperimentError]()
- // [HeaderError]()
- // [InternalError]()
- // [QuotaError]()
- // [RequestError]()
- rpc MutateCampaignExperiments(MutateCampaignExperimentsRequest) returns (MutateCampaignExperimentsResponse) {
- option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignExperiments:mutate"
- body: "*"
- };
- option (google.api.method_signature) = "customer_id,operations";
- }
-
- // Graduates a campaign experiment to a full campaign. The base and experiment
- // campaigns will start running independently with their own budgets.
- //
- // List of thrown errors:
- // [AuthenticationError]()
- // [AuthorizationError]()
- // [CampaignExperimentError]()
- // [HeaderError]()
- // [InternalError]()
- // [MutateError]()
- // [QuotaError]()
- // [RequestError]()
- rpc GraduateCampaignExperiment(GraduateCampaignExperimentRequest) returns (GraduateCampaignExperimentResponse) {
- option (google.api.http) = {
- post: "/v10/{campaign_experiment=customers/*/campaignExperiments/*}:graduate"
- body: "*"
- };
- option (google.api.method_signature) = "campaign_experiment,campaign_budget";
- }
-
- // Promotes the changes in a experiment campaign back to the base campaign.
- //
- // The campaign experiment is updated immediately with status PROMOTING.
- // This method return a long running operation that tracks the promoting of
- // the experiment campaign. If the promoting fails, a list of errors can be
- // retrieved using the ListCampaignExperimentAsyncErrors method.
- //
- // List of thrown errors:
- // [AuthenticationError]()
- // [AuthorizationError]()
- // [HeaderError]()
- // [InternalError]()
- // [QuotaError]()
- // [RequestError]()
- rpc PromoteCampaignExperiment(PromoteCampaignExperimentRequest) returns (google.longrunning.Operation) {
- option (google.api.http) = {
- post: "/v10/{campaign_experiment=customers/*/campaignExperiments/*}:promote"
- body: "*"
- };
- option (google.api.method_signature) = "campaign_experiment";
- option (google.longrunning.operation_info) = {
- response_type: "google.protobuf.Empty"
- metadata_type: "google.protobuf.Empty"
- };
- }
-
- // Immediately ends a campaign experiment, changing the experiment's scheduled
- // end date and without waiting for end of day. End date is updated to be the
- // time of the request.
- //
- // List of thrown errors:
- // [AuthenticationError]()
- // [AuthorizationError]()
- // [CampaignExperimentError]()
- // [HeaderError]()
- // [InternalError]()
- // [QuotaError]()
- // [RequestError]()
- rpc EndCampaignExperiment(EndCampaignExperimentRequest) returns (google.protobuf.Empty) {
- option (google.api.http) = {
- post: "/v10/{campaign_experiment=customers/*/campaignExperiments/*}:end"
- body: "*"
- };
- option (google.api.method_signature) = "campaign_experiment";
- }
-
- // Returns all errors that occurred during CampaignExperiment create or
- // promote (whichever occurred last).
- // Supports standard list paging.
- //
- // List of thrown errors:
- // [AuthenticationError]()
- // [AuthorizationError]()
- // [HeaderError]()
- // [InternalError]()
- // [QuotaError]()
- // [RequestError]()
- rpc ListCampaignExperimentAsyncErrors(ListCampaignExperimentAsyncErrorsRequest) returns (ListCampaignExperimentAsyncErrorsResponse) {
- option (google.api.http) = {
- get: "/v10/{resource_name=customers/*/campaignExperiments/*}:listAsyncErrors"
- };
- option (google.api.method_signature) = "resource_name";
- }
-}
-
-// Request message for [CampaignExperimentService.MutateCampaignExperiments][google.ads.googleads.v10.services.CampaignExperimentService.MutateCampaignExperiments].
-message MutateCampaignExperimentsRequest {
- // Required. The ID of the customer whose campaign experiments are being modified.
- string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
-
- // Required. The list of operations to perform on individual campaign experiments.
- repeated CampaignExperimentOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
-
- // If true, successful operations will be carried out and invalid
- // operations will return errors. If false, all operations will be carried
- // out in one transaction if and only if they are all valid.
- // Default is false.
- bool partial_failure = 3;
-
- // If true, the request is validated but not executed. Only errors are
- // returned, not results.
- bool validate_only = 4;
-
- // The response content type setting. Determines whether the mutable resource
- // or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
-}
-
-// A single update operation on a campaign experiment.
-message CampaignExperimentOperation {
- // FieldMask that determines which resource fields are modified in an update.
- google.protobuf.FieldMask update_mask = 3;
-
- // The mutate operation.
- oneof operation {
- // Update operation: The campaign experiment is expected to have a valid
- // resource name.
- google.ads.googleads.v10.resources.CampaignExperiment update = 1;
-
- // Remove operation: The campaign experiment is expected to have a valid
- // resource name, in this format:
- //
- // `customers/{customer_id}/campaignExperiments/{campaign_experiment_id}`
- string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignExperiment"
- }];
- }
-}
-
-// Response message for campaign experiment mutate.
-message MutateCampaignExperimentsResponse {
- // Errors that pertain to operation failures in the partial failure mode.
- // Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
- google.rpc.Status partial_failure_error = 3;
-
- // All results for the mutate.
- repeated MutateCampaignExperimentResult results = 2;
-}
-
-// The result for the campaign experiment mutate.
-message MutateCampaignExperimentResult {
- // Returned for successful operations.
- string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignExperiment"
- }];
-
- // The mutated campaign experiment with only mutable fields after mutate. The
- // field will only be returned when response_content_type is set to
- // "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignExperiment campaign_experiment = 2;
-}
-
-// Request message for [CampaignExperimentService.CreateCampaignExperiment][google.ads.googleads.v10.services.CampaignExperimentService.CreateCampaignExperiment].
-message CreateCampaignExperimentRequest {
- // Required. The ID of the customer whose campaign experiment is being created.
- string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
-
- // Required. The campaign experiment to be created.
- google.ads.googleads.v10.resources.CampaignExperiment campaign_experiment = 2 [(google.api.field_behavior) = REQUIRED];
-
- // If true, the request is validated but not executed. Only errors are
- // returned, not results.
- bool validate_only = 3;
-}
-
-// Message used as metadata returned in Long Running Operations for
-// CreateCampaignExperimentRequest
-message CreateCampaignExperimentMetadata {
- // Resource name of campaign experiment created.
- string campaign_experiment = 1;
-}
-
-// Request message for [CampaignExperimentService.GraduateCampaignExperiment][google.ads.googleads.v10.services.CampaignExperimentService.GraduateCampaignExperiment].
-message GraduateCampaignExperimentRequest {
- // Required. The resource name of the campaign experiment to graduate.
- string campaign_experiment = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignExperiment"
- }
- ];
-
- // Required. Resource name of the budget to attach to the campaign graduated from the
- // experiment.
- string campaign_budget = 2 [(google.api.field_behavior) = REQUIRED];
-
- // If true, the request is validated but not executed. Only errors are
- // returned, not results.
- bool validate_only = 3;
-}
-
-// Response message for campaign experiment graduate.
-message GraduateCampaignExperimentResponse {
- // The resource name of the campaign from the graduated experiment.
- // This campaign is the same one as CampaignExperiment.experiment_campaign.
- string graduated_campaign = 1;
-}
-
-// Request message for [CampaignExperimentService.PromoteCampaignExperiment][google.ads.googleads.v10.services.CampaignExperimentService.PromoteCampaignExperiment].
-message PromoteCampaignExperimentRequest {
- // Required. The resource name of the campaign experiment to promote.
- string campaign_experiment = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignExperiment"
- }
- ];
-
- // If true, the request is validated but no Long Running Operation is created.
- // Only errors are returned.
- bool validate_only = 2;
-}
-
-// Request message for [CampaignExperimentService.EndCampaignExperiment][google.ads.googleads.v10.services.CampaignExperimentService.EndCampaignExperiment].
-message EndCampaignExperimentRequest {
- // Required. The resource name of the campaign experiment to end.
- string campaign_experiment = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignExperiment"
- }
- ];
-
- // If true, the request is validated but not executed. Only errors are
- // returned, not results.
- bool validate_only = 2;
-}
-
-// Request message for
-// [CampaignExperimentService.ListCampaignExperimentAsyncErrors][google.ads.googleads.v10.services.CampaignExperimentService.ListCampaignExperimentAsyncErrors].
-message ListCampaignExperimentAsyncErrorsRequest {
- // Required. The name of the campaign experiment from which to retrieve the async
- // errors.
- string resource_name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignExperiment"
- }
- ];
-
- // Token of the page to retrieve. If not specified, the first
- // page of results will be returned. Use the value obtained from
- // `next_page_token` in the previous response in order to request
- // the next page of results.
- string page_token = 2;
-
- // Number of elements to retrieve in a single page.
- // When a page request is too large, the server may decide to
- // further limit the number of returned resources.
- int32 page_size = 3;
-}
-
-// Response message for
-// [CampaignExperimentService.ListCampaignExperimentAsyncErrors][google.ads.googleads.v10.services.CampaignExperimentService.ListCampaignExperimentAsyncErrors].
-message ListCampaignExperimentAsyncErrorsResponse {
- // Details of the errors when performing the asynchronous operation.
- repeated google.rpc.Status errors = 1;
-
- // Pagination token used to retrieve the next page of results.
- // Pass the content of this string as the `page_token` attribute of
- // the next request. `next_page_token` is not returned for the last
- // page.
- string next_page_token = 2;
-}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/smart_campaign_setting_service.proto b/third_party/googleapis/google/ads/googleads/v10/services/smart_campaign_setting_service.proto
deleted file mode 100644
index 4d0a95195..000000000
--- a/third_party/googleapis/google/ads/googleads/v10/services/smart_campaign_setting_service.proto
+++ /dev/null
@@ -1,111 +0,0 @@
-// Copyright 2022 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.
-
-syntax = "proto3";
-
-package google.ads.googleads.v10.services;
-
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/smart_campaign_setting.proto";
-import "google/api/annotations.proto";
-import "google/api/client.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-import "google/protobuf/field_mask.proto";
-import "google/rpc/status.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
-option java_multiple_files = true;
-option java_outer_classname = "SmartCampaignSettingServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
-
-// Proto file describing the Smart campaign setting service.
-
-// Service to manage Smart campaign settings.
-service SmartCampaignSettingService {
- option (google.api.default_host) = "googleads.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";
-
- // Updates Smart campaign settings for campaigns.
- rpc MutateSmartCampaignSettings(MutateSmartCampaignSettingsRequest) returns (MutateSmartCampaignSettingsResponse) {
- option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/smartCampaignSettings:mutate"
- body: "*"
- };
- option (google.api.method_signature) = "customer_id,operations";
- }
-}
-
-// Request message for
-// [SmartCampaignSettingService.MutateSmartCampaignSetting][].
-message MutateSmartCampaignSettingsRequest {
- // Required. The ID of the customer whose Smart campaign settings are being modified.
- string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
-
- // Required. The list of operations to perform on individual Smart campaign settings.
- repeated SmartCampaignSettingOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
-
- // If true, successful operations will be carried out and invalid
- // operations will return errors. If false, all operations will be carried
- // out in one transaction if and only if they are all valid.
- // Default is false.
- bool partial_failure = 3;
-
- // If true, the request is validated but not executed. Only errors are
- // returned, not results.
- bool validate_only = 4;
-
- // The response content type setting. Determines whether the mutable resource
- // or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
-}
-
-// A single operation to update Smart campaign settings for a campaign.
-message SmartCampaignSettingOperation {
- // Update operation: The Smart campaign setting must specify a valid
- // resource name.
- google.ads.googleads.v10.resources.SmartCampaignSetting update = 1;
-
- // FieldMask that determines which resource fields are modified in an update.
- google.protobuf.FieldMask update_mask = 2;
-}
-
-// Response message for campaign mutate.
-message MutateSmartCampaignSettingsResponse {
- // Errors that pertain to operation failures in the partial failure mode.
- // Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
- google.rpc.Status partial_failure_error = 1;
-
- // All results for the mutate.
- repeated MutateSmartCampaignSettingResult results = 2;
-}
-
-// The result for the Smart campaign setting mutate.
-message MutateSmartCampaignSettingResult {
- // Returned for successful operations.
- string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/SmartCampaignSetting"
- }];
-
- // The mutated Smart campaign setting with only mutable fields after mutate.
- // The field will only be returned when response_content_type is set to
- // "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.SmartCampaignSetting smart_campaign_setting = 2;
-}
diff --git a/third_party/googleapis/google/ads/googleads/v11/BUILD.bazel b/third_party/googleapis/google/ads/googleads/v11/BUILD.bazel
index 15de6b62f..7ae6c756a 100644
--- a/third_party/googleapis/google/ads/googleads/v11/BUILD.bazel
+++ b/third_party/googleapis/google/ads/googleads/v11/BUILD.bazel
@@ -150,6 +150,7 @@ csharp_gapic_library(
":googleads_proto_with_info",
],
grpc_service_config = "googleads_grpc_service_config.json",
+ service_yaml = "googleads_v11.yaml",
deps = [
"//google/ads/googleads/v11/services:services_csharp_grpc",
],
@@ -186,6 +187,7 @@ ruby_ads_gapic_library(
":overrides.:namespace.Googleads=GoogleAds",
],
grpc_service_config = "googleads_grpc_service_config.json",
+ service_yaml = "googleads_v11.yaml",
)
ruby_gapic_assembly_pkg(
@@ -221,6 +223,7 @@ py_gapic_library(
"python-gapic-templates=ads-templates",
"warehouse-package-name=google-ads",
],
+ service_yaml = "googleads_v11.yaml",
)
py_gapic_assembly_pkg(
diff --git a/third_party/googleapis/google/ads/googleads/v12/BUILD.bazel b/third_party/googleapis/google/ads/googleads/v12/BUILD.bazel
index ca955e444..740bed089 100644
--- a/third_party/googleapis/google/ads/googleads/v12/BUILD.bazel
+++ b/third_party/googleapis/google/ads/googleads/v12/BUILD.bazel
@@ -150,6 +150,7 @@ csharp_gapic_library(
":googleads_proto_with_info",
],
grpc_service_config = "googleads_grpc_service_config.json",
+ service_yaml = "googleads_v12.yaml",
deps = [
"//google/ads/googleads/v12/services:services_csharp_grpc",
],
@@ -186,6 +187,7 @@ ruby_ads_gapic_library(
":overrides.:namespace.Googleads=GoogleAds",
],
grpc_service_config = "googleads_grpc_service_config.json",
+ service_yaml = "googleads_v12.yaml",
)
ruby_gapic_assembly_pkg(
@@ -221,6 +223,7 @@ py_gapic_library(
"python-gapic-templates=ads-templates",
"warehouse-package-name=google-ads",
],
+ service_yaml = "googleads_v12.yaml",
)
py_gapic_assembly_pkg(
diff --git a/third_party/googleapis/google/ads/googleads/v10/BUILD.bazel b/third_party/googleapis/google/ads/googleads/v13/BUILD.bazel
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/BUILD.bazel
rename to third_party/googleapis/google/ads/googleads/v13/BUILD.bazel
index df7dd527b..a1292ea55 100644
--- a/third_party/googleapis/google/ads/googleads/v10/BUILD.bazel
+++ b/third_party/googleapis/google/ads/googleads/v13/BUILD.bazel
@@ -26,11 +26,11 @@ proto_library(
name = "googleads_proto",
srcs = [],
deps = [
- "//google/ads/googleads/v10/common:common_proto",
- "//google/ads/googleads/v10/enums:enums_proto",
- "//google/ads/googleads/v10/errors:errors_proto",
- "//google/ads/googleads/v10/resources:resources_proto",
- "//google/ads/googleads/v10/services:services_proto",
+ "//google/ads/googleads/v13/common:common_proto",
+ "//google/ads/googleads/v13/enums:enums_proto",
+ "//google/ads/googleads/v13/errors:errors_proto",
+ "//google/ads/googleads/v13/resources:resources_proto",
+ "//google/ads/googleads/v13/services:services_proto",
],
)
@@ -59,11 +59,11 @@ java_gapic_library(
gapic_yaml = "googleads_gapic.yaml",
grpc_service_config = ":googleads_grpc_service_config.json",
deps = [
- "//google/ads/googleads/v10/common:common_java_proto",
- "//google/ads/googleads/v10/enums:enums_java_proto",
- "//google/ads/googleads/v10/resources:resources_java_proto",
- "//google/ads/googleads/v10/services:services_java_grpc",
- "//google/ads/googleads/v10/services:services_java_proto",
+ "//google/ads/googleads/v13/common:common_java_proto",
+ "//google/ads/googleads/v13/enums:enums_java_proto",
+ "//google/ads/googleads/v13/resources:resources_java_proto",
+ "//google/ads/googleads/v13/services:services_java_grpc",
+ "//google/ads/googleads/v13/services:services_java_proto",
],
)
@@ -72,7 +72,7 @@ java_gapic_library(
java_gapic_test(
name = "googleads_java_gapic_suite",
test_classes = [
- "com.google.ads.googleads.v10.services.CampaignServiceClientTest",
+ "com.google.ads.googleads.v13.services.CampaignServiceClientTest",
],
runtime_deps = [":googleads_java_gapic_test"],
)
@@ -81,13 +81,13 @@ java_gapic_assembly_gradle_pkg(
name = "googleads-java",
deps = [
":googleads_java_gapic",
- "//google/ads/googleads/v10:googleads_proto",
- "//google/ads/googleads/v10/common:common_java_proto",
- "//google/ads/googleads/v10/enums:enums_java_proto",
- "//google/ads/googleads/v10/errors:errors_java_proto",
- "//google/ads/googleads/v10/resources:resources_java_proto",
- "//google/ads/googleads/v10/services:services_java_grpc",
- "//google/ads/googleads/v10/services:services_java_proto",
+ "//google/ads/googleads/v13:googleads_proto",
+ "//google/ads/googleads/v13/common:common_java_proto",
+ "//google/ads/googleads/v13/enums:enums_java_proto",
+ "//google/ads/googleads/v13/errors:errors_java_proto",
+ "//google/ads/googleads/v13/resources:resources_java_proto",
+ "//google/ads/googleads/v13/services:services_java_grpc",
+ "//google/ads/googleads/v13/services:services_java_proto",
],
)
@@ -119,7 +119,8 @@ php_gapic_library(
srcs = [":googleads_proto"],
gapic_yaml = "googleads_gapic.yaml",
grpc_service_config = "googleads_grpc_service_config.json",
- service_yaml = "googleads_v10.yaml",
+ service_yaml = "googleads_v13.yaml",
+ generate_snippets = False,
deps = [
":googleads_php_grpc",
":googleads_php_proto",
@@ -150,8 +151,9 @@ csharp_gapic_library(
":googleads_proto_with_info",
],
grpc_service_config = "googleads_grpc_service_config.json",
+ service_yaml = "googleads_v13.yaml",
deps = [
- "//google/ads/googleads/v10/services:services_csharp_grpc",
+ "//google/ads/googleads/v13/services:services_csharp_grpc",
],
)
@@ -159,12 +161,12 @@ csharp_gapic_assembly_pkg(
name = "googleads-csharp",
deps = [
":googleads_csharp_gapic",
- "//google/ads/googleads/v10/common:common_csharp_proto",
- "//google/ads/googleads/v10/enums:enums_csharp_proto",
- "//google/ads/googleads/v10/errors:errors_csharp_proto",
- "//google/ads/googleads/v10/resources:resources_csharp_proto",
- "//google/ads/googleads/v10/services:services_csharp_grpc",
- "//google/ads/googleads/v10/services:services_csharp_proto",
+ "//google/ads/googleads/v13/common:common_csharp_proto",
+ "//google/ads/googleads/v13/enums:enums_csharp_proto",
+ "//google/ads/googleads/v13/errors:errors_csharp_proto",
+ "//google/ads/googleads/v13/resources:resources_csharp_proto",
+ "//google/ads/googleads/v13/services:services_csharp_grpc",
+ "//google/ads/googleads/v13/services:services_csharp_proto",
],
)
@@ -186,18 +188,19 @@ ruby_ads_gapic_library(
":overrides.:namespace.Googleads=GoogleAds",
],
grpc_service_config = "googleads_grpc_service_config.json",
+ service_yaml = "googleads_v13.yaml",
)
ruby_gapic_assembly_pkg(
name = "googleads-ruby",
deps = [
":googleads_ruby_gapic",
- "//google/ads/googleads/v10/common:common_ruby_proto",
- "//google/ads/googleads/v10/enums:enums_ruby_proto",
- "//google/ads/googleads/v10/errors:errors_ruby_proto",
- "//google/ads/googleads/v10/resources:resources_ruby_proto",
- "//google/ads/googleads/v10/services:services_ruby_grpc",
- "//google/ads/googleads/v10/services:services_ruby_proto",
+ "//google/ads/googleads/v13/common:common_ruby_proto",
+ "//google/ads/googleads/v13/enums:enums_ruby_proto",
+ "//google/ads/googleads/v13/errors:errors_ruby_proto",
+ "//google/ads/googleads/v13/resources:resources_ruby_proto",
+ "//google/ads/googleads/v13/services:services_ruby_grpc",
+ "//google/ads/googleads/v13/services:services_ruby_proto",
],
)
@@ -221,18 +224,19 @@ py_gapic_library(
"python-gapic-templates=ads-templates",
"warehouse-package-name=google-ads",
],
+ service_yaml = "googleads_v13.yaml",
)
py_gapic_assembly_pkg(
name = "googleads-py",
deps = [
":googleads_py_gapic",
- "//google/ads/googleads/v10/common:common_py_proto",
- "//google/ads/googleads/v10/enums:enums_py_proto",
- "//google/ads/googleads/v10/errors:errors_py_proto",
- "//google/ads/googleads/v10/resources:resources_py_proto",
- "//google/ads/googleads/v10/services:services_py_grpc",
- "//google/ads/googleads/v10/services:services_py_proto",
+ "//google/ads/googleads/v13/common:common_py_proto",
+ "//google/ads/googleads/v13/enums:enums_py_proto",
+ "//google/ads/googleads/v13/errors:errors_py_proto",
+ "//google/ads/googleads/v13/resources:resources_py_proto",
+ "//google/ads/googleads/v13/services:services_py_grpc",
+ "//google/ads/googleads/v13/services:services_py_proto",
],
)
@@ -252,8 +256,8 @@ nodejs_gapic_library(
extra_protoc_parameters = ["metadata"],
grpc_service_config = "googleads_grpc_service_config.json",
main_service = "GoogleAdsService",
- package = "google.ads.googleads.v10",
- service_yaml = "googleads_v10.yaml",
+ package = "google.ads.googleads.v13",
+ service_yaml = "googleads_v13.yaml",
deps = [],
)
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/BUILD.bazel b/third_party/googleapis/google/ads/googleads/v13/common/BUILD.bazel
similarity index 98%
rename from third_party/googleapis/google/ads/googleads/v10/common/BUILD.bazel
rename to third_party/googleapis/google/ads/googleads/v13/common/BUILD.bazel
index 226401bf6..780d303b9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/BUILD.bazel
+++ b/third_party/googleapis/google/ads/googleads/v13/common/BUILD.bazel
@@ -26,7 +26,7 @@ proto_library(
name = "common_proto",
srcs = glob(["*.proto"]),
deps = [
- "//google/ads/googleads/v10/enums:enums_proto",
+ "//google/ads/googleads/v13/enums:enums_proto",
"//google/api:annotations_proto",
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/ad_asset.proto b/third_party/googleapis/google/ads/googleads/v13/common/ad_asset.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/common/ad_asset.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/ad_asset.proto
index 5324d7862..e1819bd5a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/ad_asset.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/ad_asset.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/common/asset_policy.proto";
-import "google/ads/googleads/v10/enums/asset_performance_label.proto";
-import "google/ads/googleads/v10/enums/served_asset_field_type.proto";
+import "google/ads/googleads/v13/common/asset_policy.proto";
+import "google/ads/googleads/v13/enums/asset_performance_label.proto";
+import "google/ads/googleads/v13/enums/served_asset_field_type.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "AdAssetProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing assets used inside an ad.
@@ -40,10 +40,12 @@ message AdTextAsset {
// within this field. Multiple assets can be pinned to the same field. An
// asset that is unpinned or pinned to a different field will not serve in a
// field where some other asset has been pinned.
- google.ads.googleads.v10.enums.ServedAssetFieldTypeEnum.ServedAssetFieldType pinned_field = 2;
+ google.ads.googleads.v13.enums.ServedAssetFieldTypeEnum.ServedAssetFieldType
+ pinned_field = 2;
// The performance label of this text asset.
- google.ads.googleads.v10.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel asset_performance_label = 5;
+ google.ads.googleads.v13.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel
+ asset_performance_label = 5;
// The policy summary of this text asset.
AdAssetPolicySummary policy_summary_info = 6;
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/ad_type_infos.proto b/third_party/googleapis/google/ads/googleads/v13/common/ad_type_infos.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/common/ad_type_infos.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/ad_type_infos.proto
index 160c43c17..6b6f989ff 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/ad_type_infos.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/ad_type_infos.proto
@@ -14,25 +14,25 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
-
-import "google/ads/googleads/v10/common/ad_asset.proto";
-import "google/ads/googleads/v10/enums/call_conversion_reporting_state.proto";
-import "google/ads/googleads/v10/enums/display_ad_format_setting.proto";
-import "google/ads/googleads/v10/enums/display_upload_product_type.proto";
-import "google/ads/googleads/v10/enums/legacy_app_install_ad_app_store.proto";
-import "google/ads/googleads/v10/enums/mime_type.proto";
-import "google/ads/googleads/v10/enums/video_thumbnail.proto";
+package google.ads.googleads.v13.common;
+
+import "google/ads/googleads/v13/common/ad_asset.proto";
+import "google/ads/googleads/v13/enums/call_conversion_reporting_state.proto";
+import "google/ads/googleads/v13/enums/display_ad_format_setting.proto";
+import "google/ads/googleads/v13/enums/display_upload_product_type.proto";
+import "google/ads/googleads/v13/enums/legacy_app_install_ad_app_store.proto";
+import "google/ads/googleads/v13/enums/mime_type.proto";
+import "google/ads/googleads/v13/enums/video_thumbnail.proto";
import "google/api/field_behavior.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "AdTypeInfosProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file containing info messages for specific ad types.
@@ -82,19 +82,16 @@ message ExpandedDynamicSearchAdInfo {
}
// A hotel ad.
-message HotelAdInfo {
+message HotelAdInfo {}
-}
+// A travel ad.
+message TravelAdInfo {}
// A Smart Shopping ad.
-message ShoppingSmartAdInfo {
-
-}
+message ShoppingSmartAdInfo {}
// A standard Shopping ad.
-message ShoppingProductAdInfo {
-
-}
+message ShoppingProductAdInfo {}
// A Shopping Comparison Listing ad.
message ShoppingComparisonListingAdInfo {
@@ -103,93 +100,6 @@ message ShoppingComparisonListingAdInfo {
optional string headline = 2;
}
-// A Gmail ad.
-message GmailAdInfo {
- // The Gmail teaser.
- GmailTeaser teaser = 1;
-
- // The MediaFile resource name of the header image. Valid image types are GIF,
- // JPEG and PNG. The minimum size is 300x100 pixels and the aspect ratio must
- // be between 3:1 and 5:1 (+-1%).
- optional string header_image = 10;
-
- // The MediaFile resource name of the marketing image. Valid image types are
- // GIF, JPEG and PNG. The image must either be landscape with a minimum size
- // of 600x314 pixels and aspect ratio of 600:314 (+-1%) or square with a
- // minimum size of 300x300 pixels and aspect ratio of 1:1 (+-1%)
- optional string marketing_image = 11;
-
- // Headline of the marketing image.
- optional string marketing_image_headline = 12;
-
- // Description of the marketing image.
- optional string marketing_image_description = 13;
-
- // Display-call-to-action of the marketing image.
- DisplayCallToAction marketing_image_display_call_to_action = 6;
-
- // Product images. Up to 15 images are supported.
- repeated ProductImage product_images = 7;
-
- // Product videos. Up to 7 videos are supported. At least one product video
- // or a marketing image must be specified.
- repeated ProductVideo product_videos = 8;
-}
-
-// Gmail teaser data. The teaser is a small header that acts as an invitation
-// to view the rest of the ad (the body).
-message GmailTeaser {
- // Headline of the teaser.
- optional string headline = 5;
-
- // Description of the teaser.
- optional string description = 6;
-
- // Business name of the advertiser.
- optional string business_name = 7;
-
- // The MediaFile resource name of the logo image. Valid image types are GIF,
- // JPEG and PNG. The minimum size is 144x144 pixels and the aspect ratio must
- // be 1:1 (+-1%).
- optional string logo_image = 8;
-}
-
-// Data for display call to action. The call to action is a piece of the ad
-// that prompts the user to do something. Like clicking a link or making a phone
-// call.
-message DisplayCallToAction {
- // Text for the display-call-to-action.
- optional string text = 5;
-
- // Text color for the display-call-to-action in hexadecimal, e.g. #ffffff for
- // white.
- optional string text_color = 6;
-
- // Identifies the URL collection in the `ad.url_collections` field. If not
- // set, the URL defaults to `final_url`.
- optional string url_collection_id = 7;
-}
-
-// Product image specific data.
-message ProductImage {
- // The MediaFile resource name of the product image. Valid image types are
- // GIF, JPEG and PNG. The minimum size is 300x300 pixels and the aspect ratio
- // must be 1:1 (+-1%).
- optional string product_image = 4;
-
- // Description of the product.
- optional string description = 5;
-
- // Display-call-to-action of the product image.
- DisplayCallToAction display_call_to_action = 3;
-}
-
-// Product video specific data.
-message ProductVideo {
- // The MediaFile resource name of a video which must be hosted on YouTube.
- optional string product_video = 2;
-}
-
// An image ad.
message ImageAdInfo {
// Width in pixels of the full size image.
@@ -211,7 +121,7 @@ message ImageAdInfo {
optional string preview_image_url = 20;
// The mime type of the image.
- google.ads.googleads.v10.enums.MimeTypeEnum.MimeType mime_type = 10;
+ google.ads.googleads.v13.enums.MimeTypeEnum.MimeType mime_type = 10;
// The name of the image. If the image was created from a MediaFile, this is
// the MediaFile's name. If the image was created from bytes, this is empty.
@@ -238,6 +148,14 @@ message ImageAdInfo {
message VideoBumperInStreamAdInfo {
// The image assets of the companion banner used with the ad.
AdImageAsset companion_banner = 3;
+
+ // Label on the "Call To Action" button taking the user to the video ad's
+ // final URL.
+ string action_button_label = 4;
+
+ // Additional text displayed with the CTA (call-to-action) button to give
+ // context and encourage clicking on the button.
+ string action_headline = 5;
}
// Representation of video non-skippable in-stream ad format (15 second
@@ -294,7 +212,8 @@ message InFeedVideoAdInfo {
string description2 = 3;
// Video thumbnail image to use.
- google.ads.googleads.v10.enums.VideoThumbnailEnum.VideoThumbnail thumbnail = 4;
+ google.ads.googleads.v13.enums.VideoThumbnailEnum.VideoThumbnail thumbnail =
+ 4;
}
// A video ad.
@@ -323,8 +242,9 @@ message VideoAdInfo {
// A video responsive ad.
message VideoResponsiveAdInfo {
- // List of text assets used for the short headline, e.g. the "Call To Action"
- // banner. Currently, only a single value for the short headline is supported.
+ // List of text assets used for the short headline, for example, the "Call To
+ // Action" banner. Currently, only a single value for the short headline is
+ // supported.
repeated AdTextAsset headlines = 1;
// List of text assets used for the long headline.
@@ -335,8 +255,8 @@ message VideoResponsiveAdInfo {
// Currently, only a single value for the description is supported.
repeated AdTextAsset descriptions = 3;
- // List of text assets used for the button, e.g. the "Call To Action" button.
- // Currently, only a single value for the button is supported.
+ // List of text assets used for the button, for example, the "Call To Action"
+ // button. Currently, only a single value for the button is supported.
repeated AdTextAsset call_to_actions = 4;
// List of YouTube video assets used for the ad.
@@ -404,12 +324,12 @@ message LegacyResponsiveDisplayAdInfo {
// Must be true if `main_color` and `accent_color` are not set.
optional bool allow_flexible_color = 20;
- // The accent color of the ad in hexadecimal, e.g. #ffffff for white.
+ // The accent color of the ad in hexadecimal, for example, #ffffff for white.
// If one of `main_color` and `accent_color` is set, the other is required as
// well.
optional string accent_color = 21;
- // The main color of the ad in hexadecimal, e.g. #ffffff for white.
+ // The main color of the ad in hexadecimal, for example, #ffffff for white.
// If one of `main_color` and `accent_color` is set, the other is required as
// well.
optional string main_color = 22;
@@ -430,9 +350,10 @@ message LegacyResponsiveDisplayAdInfo {
optional string square_marketing_image = 27;
// Specifies which format the ad will be served in. Default is ALL_FORMATS.
- google.ads.googleads.v10.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting format_setting = 13;
+ google.ads.googleads.v13.enums.DisplayAdFormatSettingEnum
+ .DisplayAdFormatSetting format_setting = 13;
- // Prefix before price. E.g. 'as low as'.
+ // Prefix before price. For example, 'as low as'.
optional string price_prefix = 28;
// Promotion text used for dynamic formats of responsive ads. For example
@@ -510,7 +431,8 @@ message LegacyAppInstallAdInfo {
optional string app_id = 6;
// The app store the mobile app is available in.
- google.ads.googleads.v10.enums.LegacyAppInstallAdAppStoreEnum.LegacyAppInstallAdAppStore app_store = 2;
+ google.ads.googleads.v13.enums.LegacyAppInstallAdAppStoreEnum
+ .LegacyAppInstallAdAppStore app_store = 2;
// The headline of the ad.
optional string headline = 7;
@@ -563,12 +485,12 @@ message ResponsiveDisplayAdInfo {
// The advertiser/brand name. Maximum display width is 25.
optional string business_name = 17;
- // The main color of the ad in hexadecimal, e.g. #ffffff for white.
+ // The main color of the ad in hexadecimal, for example, #ffffff for white.
// If one of `main_color` and `accent_color` is set, the other is required as
// well.
optional string main_color = 18;
- // The accent color of the ad in hexadecimal, e.g. #ffffff for white.
+ // The accent color of the ad in hexadecimal, for example, #ffffff for white.
// If one of `main_color` and `accent_color` is set, the other is required as
// well.
optional string accent_color = 19;
@@ -583,7 +505,7 @@ message ResponsiveDisplayAdInfo {
// The call-to-action text for the ad. Maximum display width is 30.
optional string call_to_action_text = 21;
- // Prefix before price. E.g. 'as low as'.
+ // Prefix before price. For example, 'as low as'.
optional string price_prefix = 22;
// Promotion text used for dynamic formats of responsive ads. For example
@@ -591,7 +513,8 @@ message ResponsiveDisplayAdInfo {
optional string promo_text = 23;
// Specifies which format the ad will be served in. Default is ALL_FORMATS.
- google.ads.googleads.v10.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting format_setting = 16;
+ google.ads.googleads.v13.enums.DisplayAdFormatSettingEnum
+ .DisplayAdFormatSetting format_setting = 16;
// Specification for various creative controls.
ResponsiveDisplayAdControlSpec control_spec = 24;
@@ -610,8 +533,8 @@ message LocalAdInfo {
repeated AdTextAsset descriptions = 2;
// List of text assets for call-to-actions. When the ad serves the
- // call-to-actions will be selected from this list. Call-to-actions are
- // optional and at most 5 can be specified.
+ // call-to-actions will be selected from this list. At least 1 and at most
+ // 5 call-to-actions must be specified.
repeated AdTextAsset call_to_actions = 3;
// List of marketing image assets that may be displayed with the ad. The
@@ -624,8 +547,8 @@ message LocalAdInfo {
// image assets must be specified.
repeated AdImageAsset logo_images = 5;
- // List of YouTube video assets that may be displayed with the ad. Videos
- // are optional and at most 20 can be specified.
+ // List of YouTube video assets that may be displayed with the ad. At least 1
+ // and at most 20 video assets must be specified.
repeated AdVideoAsset videos = 6;
// First part of optional text that can be appended to the URL in the ad.
@@ -641,7 +564,8 @@ message LocalAdInfo {
// need to be included with the ad.
message DisplayUploadAdInfo {
// The product type of this ad. See comments on the enum for details.
- google.ads.googleads.v10.enums.DisplayUploadProductTypeEnum.DisplayUploadProductType display_upload_product_type = 1;
+ google.ads.googleads.v13.enums.DisplayUploadProductTypeEnum
+ .DisplayUploadProductType display_upload_product_type = 1;
// The asset data that makes up the ad.
oneof media_asset {
@@ -667,12 +591,12 @@ message ResponsiveDisplayAdControlSpec {
// A Smart campaign ad.
message SmartCampaignAdInfo {
- // List of text assets for headlines. When the ad serves the headlines will
- // be selected from this list. 3 headlines must be specified.
+ // List of text assets, each of which corresponds to a headline when the ad
+ // serves. This list consists of a minimum of 3 and up to 15 text assets.
repeated AdTextAsset headlines = 1;
- // List of text assets for descriptions. When the ad serves the descriptions
- // will be selected from this list. 2 descriptions must be specified.
+ // List of text assets, each of which corresponds to a description when the ad
+ // serves. This list consists of a minimum of 2 and up to 4 text assets.
repeated AdTextAsset descriptions = 2;
}
@@ -719,7 +643,8 @@ message CallAdInfo {
// The call conversion behavior of this call ad. It can use its own call
// conversion setting, inherit the account level setting, or be disabled.
- google.ads.googleads.v10.enums.CallConversionReportingStateEnum.CallConversionReportingState conversion_reporting_state = 10;
+ google.ads.googleads.v13.enums.CallConversionReportingStateEnum
+ .CallConversionReportingState conversion_reporting_state = 10;
// First part of text that can be appended to the URL in the ad. Optional.
string path1 = 13;
@@ -769,7 +694,7 @@ message DiscoveryMultiAssetAdInfo {
// Call to action text.
optional string call_to_action_text = 8;
- // Boolean flag that indicates if this ad must be served with lead form.
+ // Boolean option that indicates if this ad must be served with lead form.
optional bool lead_form_only = 9;
}
@@ -778,8 +703,8 @@ message DiscoveryCarouselAdInfo {
// Required. The Advertiser/brand name.
string business_name = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. Logo image to be used in the ad. The minimum size is 128x128 and the
- // aspect ratio must be 1:1(+-1%).
+ // Required. Logo image to be used in the ad. The minimum size is 128x128 and
+ // the aspect ratio must be 1:1(+-1%).
AdImageAsset logo_image = 2 [(google.api.field_behavior) = REQUIRED];
// Required. Headline of the ad.
@@ -792,5 +717,6 @@ message DiscoveryCarouselAdInfo {
string call_to_action_text = 5;
// Required. Carousel cards that will display with the ad. Min 2 max 10.
- repeated AdDiscoveryCarouselCardAsset carousel_cards = 6 [(google.api.field_behavior) = REQUIRED];
+ repeated AdDiscoveryCarouselCardAsset carousel_cards = 6
+ [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/common/asset_policy.proto b/third_party/googleapis/google/ads/googleads/v13/common/asset_policy.proto
new file mode 100644
index 000000000..8fc1980ff
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/common/asset_policy.proto
@@ -0,0 +1,82 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.common;
+
+import "google/ads/googleads/v13/common/policy.proto";
+import "google/ads/googleads/v13/enums/asset_link_primary_status.proto";
+import "google/ads/googleads/v13/enums/asset_link_primary_status_reason.proto";
+import "google/ads/googleads/v13/enums/asset_offline_evaluation_error_reasons.proto";
+import "google/ads/googleads/v13/enums/policy_approval_status.proto";
+import "google/ads/googleads/v13/enums/policy_review_status.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
+option java_multiple_files = true;
+option java_outer_classname = "AssetPolicyProto";
+option java_package = "com.google.ads.googleads.v13.common";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
+
+// Proto file describing asset policies.
+
+// Contains policy information for an asset inside an ad.
+message AdAssetPolicySummary {
+ // The list of policy findings for this asset.
+ repeated PolicyTopicEntry policy_topic_entries = 1;
+
+ // Where in the review process this asset.
+ google.ads.googleads.v13.enums.PolicyReviewStatusEnum.PolicyReviewStatus
+ review_status = 2;
+
+ // The overall approval status of this asset, which is calculated based on
+ // the status of its individual policy topic entries.
+ google.ads.googleads.v13.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus
+ approval_status = 3;
+}
+
+// Provides the detail of a PrimaryStatus.
+// Each asset link has a PrimaryStatus value (e.g. NOT_ELIGIBLE, meaning not
+// serving), and list of corroborating PrimaryStatusReasons (e.g.
+// [ASSET_DISAPPROVED]). Each reason may have some additional details
+// annotated with it. For instance, when the reason is ASSET_DISAPPROVED, the
+// details field will contain additional information about the offline
+// evaluation errors which led to the asset being disapproved.
+// Next Id: 4
+message AssetLinkPrimaryStatusDetails {
+ // Provides the reason of this PrimaryStatus.
+ optional google.ads.googleads.v13.enums.AssetLinkPrimaryStatusReasonEnum
+ .AssetLinkPrimaryStatusReason reason = 1;
+
+ // Provides the PrimaryStatus of this status detail.
+ optional google.ads.googleads.v13.enums.AssetLinkPrimaryStatusEnum
+ .AssetLinkPrimaryStatus status = 2;
+
+ // Provides the details associated with the asset link primary status.
+ oneof details {
+ // Provides the details for AssetLinkPrimaryStatusReason.ASSET_DISAPPROVED
+ AssetDisapproved asset_disapproved = 3;
+ }
+}
+
+// Details related to AssetLinkPrimaryStatusReasonPB.ASSET_DISAPPROVED
+// Next Id: 2
+message AssetDisapproved {
+ // Provides the quality evaluation disapproval reason of an asset.
+ repeated google.ads.googleads.v13.enums.AssetOfflineEvaluationErrorReasonsEnum
+ .AssetOfflineEvaluationErrorReasons offline_evaluation_error_reasons = 1;
+}
diff --git a/third_party/googleapis/google/ads/googleads/v13/common/asset_set_types.proto b/third_party/googleapis/google/ads/googleads/v13/common/asset_set_types.proto
new file mode 100644
index 000000000..2814a351f
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/common/asset_set_types.proto
@@ -0,0 +1,188 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.common;
+
+import "google/ads/googleads/v13/enums/chain_relationship_type.proto";
+import "google/ads/googleads/v13/enums/location_ownership_type.proto";
+import "google/ads/googleads/v13/enums/location_string_filter_type.proto";
+import "google/api/field_behavior.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
+option java_multiple_files = true;
+option java_outer_classname = "AssetSetTypesProto";
+option java_package = "com.google.ads.googleads.v13.common";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
+
+// Proto file containing info messages for specific asset set types.
+
+// Data related to location set. One of the Google Business Profile (previously
+// known as Google My Business) data, Chain data, and map location data need to
+// be specified.
+message LocationSet {
+ // Required. Immutable. Location Ownership Type (owned location or affiliate
+ // location).
+ google.ads.googleads.v13.enums.LocationOwnershipTypeEnum.LocationOwnershipType
+ location_ownership_type = 3 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.field_behavior) = IMMUTABLE
+ ];
+
+ // Location data specific to each sync source.
+ oneof source {
+ // Data used to configure a location set populated from Google Business
+ // Profile locations.
+ BusinessProfileLocationSet business_profile_location_set = 1;
+
+ // Data used to configure a location on chain set populated with the
+ // specified chains.
+ ChainSet chain_location_set = 2;
+
+ // Only set if locations are synced based on selected maps locations
+ MapsLocationSet maps_location_set = 5;
+ }
+}
+
+// Data used to configure a location set populated from Google Business Profile
+// locations.
+// Different types of filters are AND'ed together, if they are specified.
+message BusinessProfileLocationSet {
+ // Required. Immutable. The HTTP authorization token used to obtain
+ // authorization.
+ string http_authorization_token = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.field_behavior) = REQUIRED
+ ];
+
+ // Required. Immutable. Email address of a Google Business Profile account or
+ // email address of a manager of the Google Business Profile account.
+ string email_address = 2 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.field_behavior) = IMMUTABLE
+ ];
+
+ // Used to filter Google Business Profile listings by business name. If
+ // businessNameFilter is set, only listings with a matching business name are
+ // candidates to be sync'd into Assets.
+ string business_name_filter = 3;
+
+ // Used to filter Google Business Profile listings by labels. If entries exist
+ // in labelFilters, only listings that have any of the labels set are
+ // candidates to be synchronized into Assets. If no entries exist in
+ // labelFilters, then all listings are candidates for syncing.
+ // Label filters are OR'ed together.
+ repeated string label_filters = 4;
+
+ // Used to filter Google Business Profile listings by listing id. If entries
+ // exist in listingIdFilters, only listings specified by the filters are
+ // candidates to be synchronized into Assets. If no entries exist in
+ // listingIdFilters, then all listings are candidates for syncing.
+ // Listing ID filters are OR'ed together.
+ repeated int64 listing_id_filters = 5;
+
+ // Immutable. The account ID of the managed business whose locations are to be
+ // used. If this field is not set, then all businesses accessible by the user
+ // (specified by the emailAddress) are used.
+ string business_account_id = 6 [(google.api.field_behavior) = IMMUTABLE];
+}
+
+// Data used to configure a location set populated with the specified chains.
+message ChainSet {
+ // Required. Immutable. Relationship type the specified chains have with this
+ // advertiser.
+ google.ads.googleads.v13.enums.ChainRelationshipTypeEnum.ChainRelationshipType
+ relationship_type = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.field_behavior) = IMMUTABLE
+ ];
+
+ // Required. A list of chain level filters, all filters are OR'ed together.
+ repeated ChainFilter chains = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// One chain level filter on location in a feed item set.
+// The filtering logic among all the fields is AND.
+message ChainFilter {
+ // Required. Used to filter chain locations by chain id. Only chain locations
+ // that belong to the specified chain will be in the asset set.
+ int64 chain_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Used to filter chain locations by location attributes.
+ // Only chain locations that belong to all of the specified attribute(s) will
+ // be in the asset set. If this field is empty, it means no filtering on this
+ // field.
+ repeated string location_attributes = 2;
+}
+
+// Wrapper for multiple maps location sync data
+message MapsLocationSet {
+ // Required. A list of maps location info that user manually synced in.
+ repeated MapsLocationInfo maps_locations = 1
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Wrapper for place ids
+message MapsLocationInfo {
+ // Place ID of the Maps location.
+ string place_id = 1;
+}
+
+// Information about a Business Profile dynamic location group.
+// Only applicable if the sync level AssetSet's type is LOCATION_SYNC and
+// sync source is Business Profile.
+message BusinessProfileLocationGroup {
+ // Filter for dynamic Business Profile location sets.
+ DynamicBusinessProfileLocationGroupFilter
+ dynamic_business_profile_location_group_filter = 1;
+}
+
+// Represents a filter on Business Profile locations in an asset set. If
+// multiple filters are provided, they are AND'ed together.
+message DynamicBusinessProfileLocationGroupFilter {
+ // Used to filter Business Profile locations by label. Only locations that
+ // have any of the listed labels will be in the asset set.
+ // Label filters are OR'ed together.
+ repeated string label_filters = 1;
+
+ // Used to filter Business Profile locations by business name.
+ optional BusinessProfileBusinessNameFilter business_name_filter = 2;
+
+ // Used to filter Business Profile locations by listing ids.
+ repeated int64 listing_id_filters = 3;
+}
+
+// Business Profile location group business name filter.
+message BusinessProfileBusinessNameFilter {
+ // Business name string to use for filtering.
+ string business_name = 1;
+
+ // The type of string matching to use when filtering with business_name.
+ google.ads.googleads.v13.enums.LocationStringFilterTypeEnum
+ .LocationStringFilterType filter_type = 2;
+}
+
+// Represents information about a Chain dynamic location group.
+// Only applicable if the sync level AssetSet's type is LOCATION_SYNC and
+// sync source is chain.
+message ChainLocationGroup {
+ // Used to filter chain locations by chain ids.
+ // Only Locations that belong to the specified chain(s) will be in the asset
+ // set.
+ repeated ChainFilter dynamic_chain_location_group_filters = 1;
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/asset_types.proto b/third_party/googleapis/google/ads/googleads/v13/common/asset_types.proto
similarity index 64%
rename from third_party/googleapis/google/ads/googleads/v10/common/asset_types.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/asset_types.proto
index 4c29c35e1..a2ffc1251 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/asset_types.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/asset_types.proto
@@ -14,34 +14,35 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
-
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/common/feed_common.proto";
-import "google/ads/googleads/v10/enums/call_conversion_reporting_state.proto";
-import "google/ads/googleads/v10/enums/call_to_action_type.proto";
-import "google/ads/googleads/v10/enums/lead_form_call_to_action_type.proto";
-import "google/ads/googleads/v10/enums/lead_form_desired_intent.proto";
-import "google/ads/googleads/v10/enums/lead_form_field_user_input_type.proto";
-import "google/ads/googleads/v10/enums/lead_form_post_submit_call_to_action_type.proto";
-import "google/ads/googleads/v10/enums/mime_type.proto";
-import "google/ads/googleads/v10/enums/mobile_app_vendor.proto";
-import "google/ads/googleads/v10/enums/price_extension_price_qualifier.proto";
-import "google/ads/googleads/v10/enums/price_extension_price_unit.proto";
-import "google/ads/googleads/v10/enums/price_extension_type.proto";
-import "google/ads/googleads/v10/enums/promotion_extension_discount_modifier.proto";
-import "google/ads/googleads/v10/enums/promotion_extension_occasion.proto";
+package google.ads.googleads.v13.common;
+
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/common/feed_common.proto";
+import "google/ads/googleads/v13/enums/call_conversion_reporting_state.proto";
+import "google/ads/googleads/v13/enums/call_to_action_type.proto";
+import "google/ads/googleads/v13/enums/lead_form_call_to_action_type.proto";
+import "google/ads/googleads/v13/enums/lead_form_desired_intent.proto";
+import "google/ads/googleads/v13/enums/lead_form_field_user_input_type.proto";
+import "google/ads/googleads/v13/enums/lead_form_post_submit_call_to_action_type.proto";
+import "google/ads/googleads/v13/enums/location_ownership_type.proto";
+import "google/ads/googleads/v13/enums/mime_type.proto";
+import "google/ads/googleads/v13/enums/mobile_app_vendor.proto";
+import "google/ads/googleads/v13/enums/price_extension_price_qualifier.proto";
+import "google/ads/googleads/v13/enums/price_extension_price_unit.proto";
+import "google/ads/googleads/v13/enums/price_extension_type.proto";
+import "google/ads/googleads/v13/enums/promotion_extension_discount_modifier.proto";
+import "google/ads/googleads/v13/enums/promotion_extension_occasion.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "AssetTypesProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file containing info messages for specific asset types.
@@ -73,7 +74,7 @@ message ImageAsset {
optional int64 file_size = 6;
// MIME type of the image asset.
- google.ads.googleads.v10.enums.MimeTypeEnum.MimeType mime_type = 3;
+ google.ads.googleads.v13.enums.MimeTypeEnum.MimeType mime_type = 3;
// Metadata for this image at its original size.
ImageDimension full_size = 4;
@@ -103,22 +104,25 @@ message LeadFormAsset {
string business_name = 10 [(google.api.field_behavior) = REQUIRED];
// Required. Pre-defined display text that encourages user to expand the form.
- google.ads.googleads.v10.enums.LeadFormCallToActionTypeEnum.LeadFormCallToActionType call_to_action_type = 17 [(google.api.field_behavior) = REQUIRED];
+ google.ads.googleads.v13.enums.LeadFormCallToActionTypeEnum
+ .LeadFormCallToActionType call_to_action_type = 17
+ [(google.api.field_behavior) = REQUIRED];
- // Required. Text giving a clear value proposition of what users expect once they expand
- // the form.
- string call_to_action_description = 18 [(google.api.field_behavior) = REQUIRED];
+ // Required. Text giving a clear value proposition of what users expect once
+ // they expand the form.
+ string call_to_action_description = 18
+ [(google.api.field_behavior) = REQUIRED];
- // Required. Headline of the expanded form to describe what the form is asking for or
- // facilitating.
+ // Required. Headline of the expanded form to describe what the form is asking
+ // for or facilitating.
string headline = 12 [(google.api.field_behavior) = REQUIRED];
- // Required. Detailed description of the expanded form to describe what the form is
- // asking for or facilitating.
+ // Required. Detailed description of the expanded form to describe what the
+ // form is asking for or facilitating.
string description = 13 [(google.api.field_behavior) = REQUIRED];
- // Required. Link to a page describing the policy on how the collected data is handled
- // by the advertiser/business.
+ // Required. Link to a page describing the policy on how the collected data is
+ // handled by the advertiser/business.
string privacy_policy_url = 14 [(google.api.field_behavior) = REQUIRED];
// Headline of text shown after form submission that describes how the
@@ -129,10 +133,12 @@ message LeadFormAsset {
// advertiser will follow up with the user.
optional string post_submit_description = 16;
- // Ordered list of input fields.
+ // Ordered list of input fields. This field can be updated by reordering
+ // questions, but not by adding or removing questions.
repeated LeadFormField fields = 8;
- // Ordered list of custom question fields.
+ // Ordered list of custom question fields. This field is subject to a limit of
+ // 5 qualifying questions per form.
repeated LeadFormCustomQuestionField custom_question_fields = 23;
// Configured methods for collected lead data to be delivered to advertiser.
@@ -141,14 +147,17 @@ message LeadFormAsset {
// Pre-defined display text that encourages user action after the form is
// submitted.
- google.ads.googleads.v10.enums.LeadFormPostSubmitCallToActionTypeEnum.LeadFormPostSubmitCallToActionType post_submit_call_to_action_type = 19;
+ google.ads.googleads.v13.enums.LeadFormPostSubmitCallToActionTypeEnum
+ .LeadFormPostSubmitCallToActionType post_submit_call_to_action_type = 19;
// Asset resource name of the background image. The minimum size is 600x314
// and the aspect ratio must be 1.91:1 (+-1%).
optional string background_image_asset = 20;
- // Desired intent for the lead form, e.g. more volume or more qualified.
- google.ads.googleads.v10.enums.LeadFormDesiredIntentEnum.LeadFormDesiredIntent desired_intent = 21;
+ // Chosen intent for the lead form, for example, more volume or more
+ // qualified.
+ google.ads.googleads.v13.enums.LeadFormDesiredIntentEnum.LeadFormDesiredIntent
+ desired_intent = 21;
// Custom disclosure shown along with Google disclaimer on the lead form.
// Accessible to allowed customers only.
@@ -157,9 +166,10 @@ message LeadFormAsset {
// One input field instance within a form.
message LeadFormField {
- // Describes the input type, which may be a predefined type such as
- // "full name" or a pre-vetted question like "Do you own a car?".
- google.ads.googleads.v10.enums.LeadFormFieldUserInputTypeEnum.LeadFormFieldUserInputType input_type = 1;
+ // Describes the input type, which may be a predefined type such as "full
+ // name" or a pre-vetted question like "What kind of vehicle do you have?".
+ google.ads.googleads.v13.enums.LeadFormFieldUserInputTypeEnum
+ .LeadFormFieldUserInputType input_type = 1;
// Defines answer configuration that this form field accepts. If oneof is not
// set, this is a free-text answer.
@@ -173,7 +183,8 @@ message LeadFormField {
// One custom question input field instance within a form.
message LeadFormCustomQuestionField {
- // The exact custom question field text (e.g. "Do you own a car?").
+ // The exact custom question field text (for example, "What kind of vehicle
+ // do you have?").
string custom_question_text = 1;
// Defines answer configuration that this form field accepts. If
@@ -219,9 +230,7 @@ message WebhookDelivery {
// A Book on Google asset. Used to redirect user to book through Google.
// Book on Google will change the redirect url to book directly through
// Google.
-message BookOnGoogleAsset {
-
-}
+message BookOnGoogleAsset {}
// A Promotion asset.
message PromotionAsset {
@@ -229,7 +238,8 @@ message PromotionAsset {
string promotion_target = 1 [(google.api.field_behavior) = REQUIRED];
// A modifier for qualification of the discount.
- google.ads.googleads.v10.enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier discount_modifier = 2;
+ google.ads.googleads.v13.enums.PromotionExtensionDiscountModifierEnum
+ .PromotionExtensionDiscountModifier discount_modifier = 2;
// Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd
// format.
@@ -242,7 +252,8 @@ message PromotionAsset {
// The occasion the promotion was intended for.
// If an occasion is set, the redemption window will need to fall within the
// date range associated with the occasion.
- google.ads.googleads.v10.enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion occasion = 9;
+ google.ads.googleads.v13.enums.PromotionExtensionOccasionEnum
+ .PromotionExtensionOccasion occasion = 9;
// The language of the promotion.
// Represented as BCP 47 language tag.
@@ -358,43 +369,44 @@ message PageFeedAsset {
// A Dynamic Education asset.
message DynamicEducationAsset {
- // Required. Program ID which can be any sequence of letters and digits, and must be
- // unique and match the values of remarketing tag. Required.
+ // Required. Program ID which can be any sequence of letters and digits, and
+ // must be unique and match the values of remarketing tag. Required.
string program_id = 1 [(google.api.field_behavior) = REQUIRED];
// Location ID which can be any sequence of letters and digits and must be
// unique.
string location_id = 2;
- // Required. Program name, e.g. Nursing. Required.
+ // Required. Program name, for example, Nursing. Required.
string program_name = 3 [(google.api.field_behavior) = REQUIRED];
- // Subject of study, e.g. Health.
+ // Subject of study, for example, Health.
string subject = 4;
- // Program description, e.g. Nursing Certification.
+ // Program description, for example, Nursing Certification.
string program_description = 5;
- // School name, e.g. Mountain View School of Nursing.
+ // School name, for example, Mountain View School of Nursing.
string school_name = 6;
// School address which can be specified in one of the following formats.
- // (1) City, state, code, country, e.g. Mountain View, CA, USA.
- // (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043.
- // (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403
+ // (1) City, state, code, country, for example, Mountain View, CA, USA.
+ // (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043.
+ // (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
string address = 7;
- // Contextual keywords, e.g. Nursing certification, Health, Mountain View.
+ // Contextual keywords, for example, Nursing certification, Health, Mountain
+ // View.
repeated string contextual_keywords = 8;
- // Android deep link, e.g.
+ // Android deep link, for example,
// android-app://com.example.android/http/example.com/gizmos?1234.
string android_app_link = 9;
// Similar program IDs.
repeated string similar_program_ids = 10;
- // iOS deep link, e.g. exampleApp://content/page.
+ // iOS deep link, for example, exampleApp://content/page.
string ios_app_link = 11;
// iOS app store ID. This is used to check if the user has the app installed
@@ -402,24 +414,25 @@ message DynamicEducationAsset {
// ios_app_link field must also be present.
int64 ios_app_store_id = 12;
- // Thumbnail image url, e.g. http://www.example.com/thumbnail.png. The
+ // Thumbnail image url, for example, http://www.example.com/thumbnail.png. The
// thumbnail image will not be uploaded as image asset.
string thumbnail_image_url = 13;
- // Image url, e.g. http://www.example.com/image.png. The image will not be
- // uploaded as image asset.
+ // Image url, for example, http://www.example.com/image.png. The image will
+ // not be uploaded as image asset.
string image_url = 14;
}
// An asset representing a mobile app.
message MobileAppAsset {
- // Required. A string that uniquely identifies a mobile application. It should just
- // contain the platform native id, like "com.android.ebay" for Android or
+ // Required. A string that uniquely identifies a mobile application. It should
+ // just contain the platform native id, like "com.android.ebay" for Android or
// "12345689" for iOS.
string app_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The application store that distributes this specific app.
- google.ads.googleads.v10.enums.MobileAppVendorEnum.MobileAppVendor app_store = 2 [(google.api.field_behavior) = REQUIRED];
+ google.ads.googleads.v13.enums.MobileAppVendorEnum.MobileAppVendor app_store =
+ 2 [(google.api.field_behavior) = REQUIRED];
// Required. The visible text displayed when the link is rendered in an ad.
// The length of this string should be between 1 and 25, inclusive.
@@ -447,23 +460,26 @@ message HotelCalloutAsset {
// A Call asset.
message CallAsset {
- // Required. Two-letter country code of the phone number. Examples: 'US', 'us'.
+ // Required. Two-letter country code of the phone number. Examples: 'US',
+ // 'us'.
string country_code = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890'
+ // Required. The advertiser's raw phone number. Examples: '1234567890',
+ // '(123)456-7890'
string phone_number = 2 [(google.api.field_behavior) = REQUIRED];
// Indicates whether this CallAsset should use its own call conversion
// setting, follow the account level setting, or disable call conversion.
- google.ads.googleads.v10.enums.CallConversionReportingStateEnum.CallConversionReportingState call_conversion_reporting_state = 3;
+ google.ads.googleads.v13.enums.CallConversionReportingStateEnum
+ .CallConversionReportingState call_conversion_reporting_state = 3;
// The conversion action to attribute a call conversion to. If not set, the
// default conversion action is used. This field only has effect if
// call_conversion_reporting_state is set to
// USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
string call_conversion_action = 4 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionAction"
- }];
+ type: "googleads.googleapis.com/ConversionAction"
+ }];
// List of non-overlapping schedules specifying all time intervals for which
// the asset may serve. There can be a maximum of 6 schedules per day, 42 in
@@ -474,10 +490,12 @@ message CallAsset {
// An asset representing a list of price offers.
message PriceAsset {
// Required. The type of the price asset.
- google.ads.googleads.v10.enums.PriceExtensionTypeEnum.PriceExtensionType type = 1 [(google.api.field_behavior) = REQUIRED];
+ google.ads.googleads.v13.enums.PriceExtensionTypeEnum.PriceExtensionType
+ type = 1 [(google.api.field_behavior) = REQUIRED];
// The price qualifier of the price asset.
- google.ads.googleads.v10.enums.PriceExtensionPriceQualifierEnum.PriceExtensionPriceQualifier price_qualifier = 2;
+ google.ads.googleads.v13.enums.PriceExtensionPriceQualifierEnum
+ .PriceExtensionPriceQualifier price_qualifier = 2;
// Required. The language of the price asset.
// Represented as BCP 47 language tag.
@@ -502,7 +520,8 @@ message PriceOffering {
Money price = 3 [(google.api.field_behavior) = REQUIRED];
// The price unit of the price offering.
- google.ads.googleads.v10.enums.PriceExtensionPriceUnitEnum.PriceExtensionPriceUnit unit = 4;
+ google.ads.googleads.v13.enums.PriceExtensionPriceUnitEnum
+ .PriceExtensionPriceUnit unit = 4;
// Required. The final URL after all cross domain redirects.
string final_url = 5 [(google.api.field_behavior) = REQUIRED];
@@ -514,56 +533,58 @@ message PriceOffering {
// A call to action asset.
message CallToActionAsset {
// Call to action.
- google.ads.googleads.v10.enums.CallToActionTypeEnum.CallToActionType call_to_action = 1;
+ google.ads.googleads.v13.enums.CallToActionTypeEnum.CallToActionType
+ call_to_action = 1;
}
// A dynamic real estate asset.
message DynamicRealEstateAsset {
- // Required. Listing ID which can be any sequence of letters and digits, and must be
- // unique and match the values of remarketing tag. Required.
+ // Required. Listing ID which can be any sequence of letters and digits, and
+ // must be unique and match the values of remarketing tag. Required.
string listing_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. Listing name, e.g. Boulevard Bungalow. Required.
+ // Required. Listing name, for example, Boulevard Bungalow. Required.
string listing_name = 2 [(google.api.field_behavior) = REQUIRED];
- // City name, e.g. Mountain View, California.
+ // City name, for example, Mountain View, California.
string city_name = 3;
- // Description, e.g. 3 beds, 2 baths, 1568 sq. ft.
+ // Description, for example, 3 beds, 2 baths, 1568 sq. ft.
string description = 4;
// Address which can be specified in one of the following formats.
- // (1) City, state, code, country, e.g. Mountain View, CA, USA.
- // (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043.
- // (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403
+ // (1) City, state, code, country, for example, Mountain View, CA, USA.
+ // (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043.
+ // (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
string address = 5;
// Price which can be number followed by the alphabetic currency code,
- // ISO 4217 standard. Use '.' as the decimal mark. e.g. 200,000.00 USD.
+ // ISO 4217 standard. Use '.' as the decimal mark, for example, 200,000.00
+ // USD.
string price = 6;
- // Image URL, e.g. http://www.example.com/image.png. The image will not be
- // uploaded as image asset.
+ // Image URL, for example, http://www.example.com/image.png. The image will
+ // not be uploaded as image asset.
string image_url = 7;
- // Property type, e.g. House.
+ // Property type, for example, House.
string property_type = 8;
- // Listing type, e.g. For sale.
+ // Listing type, for example, For sale.
string listing_type = 9;
- // Contextual keywords, e.g. For sale; Houses for sale.
+ // Contextual keywords, for example, For sale; Houses for sale.
repeated string contextual_keywords = 10;
// Formatted price which can be any characters. If set, this attribute will be
- // used instead of 'price', e.g. Starting at $200,000.00.
+ // used instead of 'price', for example, Starting at $200,000.00.
string formatted_price = 11;
- // Android deep link, e.g.
+ // Android deep link, for example,
// android-app://com.example.android/http/example.com/gizmos?1234.
string android_app_link = 12;
- // iOS deep link, e.g. exampleApp://content/page.
+ // iOS deep link, for example, exampleApp://content/page.
string ios_app_link = 13;
// iOS app store ID. This is used to check if the user has the app installed
@@ -578,60 +599,61 @@ message DynamicRealEstateAsset {
// A dynamic custom asset.
message DynamicCustomAsset {
// Required. ID which can be any sequence of letters and digits, and must be
- // unique and match the values of remarketing tag, e.g. sedan. Required.
+ // unique and match the values of remarketing tag, for example, sedan.
+ // Required.
string id = 1 [(google.api.field_behavior) = REQUIRED];
- // ID2 which can be any sequence of letters and digits, e.g. red. ID sequence
- // (ID + ID2) must be unique.
+ // ID2 which can be any sequence of letters and digits, for example, red. ID
+ // sequence (ID + ID2) must be unique.
string id2 = 2;
- // Required. Item title, e.g. Mid-size sedan. Required.
+ // Required. Item title, for example, Mid-size sedan. Required.
string item_title = 3 [(google.api.field_behavior) = REQUIRED];
- // Item subtitle, e.g. At your Mountain View dealership.
+ // Item subtitle, for example, At your Mountain View dealership.
string item_subtitle = 4;
- // Item description, e.g. Best selling mid-size car.
+ // Item description, for example, Best selling mid-size car.
string item_description = 5;
// Item address which can be specified in one of the following formats.
- // (1) City, state, code, country, e.g. Mountain View, CA, USA.
- // (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043.
- // (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403
+ // (1) City, state, code, country, for example, Mountain View, CA, USA.
+ // (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043.
+ // (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
string item_address = 6;
- // Item category, e.g. Sedans.
+ // Item category, for example, Sedans.
string item_category = 7;
// Price which can be number followed by the alphabetic currency code,
- // ISO 4217 standard. Use '.' as the decimal mark, e.g. 20,000.00 USD.
+ // ISO 4217 standard. Use '.' as the decimal mark, for example, 20,000.00 USD.
string price = 8;
// Sale price which can be number followed by the alphabetic currency code,
- // ISO 4217 standard. Use '.' as the decimal mark, e.g. 15,000.00 USD.
+ // ISO 4217 standard. Use '.' as the decimal mark, for example, 15,000.00 USD.
// Must be less than the 'price' field.
string sale_price = 9;
// Formatted price which can be any characters. If set, this attribute will be
- // used instead of 'price', e.g. Starting at $20,000.00.
+ // used instead of 'price', for example, Starting at $20,000.00.
string formatted_price = 10;
// Formatted sale price which can be any characters. If set, this attribute
- // will be used instead of 'sale price', e.g. On sale for $15,000.00.
+ // will be used instead of 'sale price', for example, On sale for $15,000.00.
string formatted_sale_price = 11;
- // Image URL, e.g. http://www.example.com/image.png. The image will not be
- // uploaded as image asset.
+ // Image URL, for example, http://www.example.com/image.png. The image will
+ // not be uploaded as image asset.
string image_url = 12;
- // Contextual keywords, e.g. Sedans, 4 door sedans.
+ // Contextual keywords, for example, Sedans, 4 door sedans.
repeated string contextual_keywords = 13;
- // Android deep link, e.g.
+ // Android deep link, for example,
// android-app://com.example.android/http/example.com/gizmos?1234.
string android_app_link = 14;
- // iOS deep link, e.g. exampleApp://content/page.
+ // iOS deep link, for example, exampleApp://content/page.
string ios_app_link = 16;
// iOS app store ID. This is used to check if the user has the app installed
@@ -645,51 +667,51 @@ message DynamicCustomAsset {
// A dynamic hotels and rentals asset.
message DynamicHotelsAndRentalsAsset {
- // Required. Property ID which can be any sequence of letters and digits, and must be
- // unique and match the values of remarketing tag. Required.
+ // Required. Property ID which can be any sequence of letters and digits, and
+ // must be unique and match the values of remarketing tag. Required.
string property_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. Property name, e.g. Mountain View Hotel. Required.
+ // Required. Property name, for example, Mountain View Hotel. Required.
string property_name = 2 [(google.api.field_behavior) = REQUIRED];
- // Image URL, e.g. http://www.example.com/image.png. The image will not be
- // uploaded as image asset.
+ // Image URL, for example, http://www.example.com/image.png. The image will
+ // not be uploaded as image asset.
string image_url = 3;
- // Destination name, e.g. Downtown Mountain View.
+ // Destination name, for example, Downtown Mountain View.
string destination_name = 4;
- // Description, e.g. Close to SJC Airport.
+ // Description, for example, Close to SJC Airport.
string description = 5;
// Price which can be number followed by the alphabetic currency code,
- // ISO 4217 standard. Use '.' as the decimal mark, e.g. 100.00 USD.
+ // ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
string price = 6;
- // ISO 4217 standard. Use '.' as the decimal mark, e.g. 80.00 USD.
+ // ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD.
// Must be less than the 'price' field.
string sale_price = 7;
- // Star rating. Must be a number between 1–5, inclusive.
+ // Star rating. Must be a number between 1 to 5, inclusive.
int64 star_rating = 8;
- // Category, e.g. Hotel suite.
+ // Category, for example, Hotel suite.
string category = 9;
- // Contextual keywords, e.g. Mountain View "Hotels", South Bay hotels.
+ // Contextual keywords, for example, Mountain View "Hotels", South Bay hotels.
repeated string contextual_keywords = 10;
// Address which can be specified in one of the following formats.
- // (1) City, state, code, country, e.g. Mountain View, CA, USA.
- // (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043.
- // (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403
+ // (1) City, state, code, country, for example, Mountain View, CA, USA.
+ // (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043.
+ // (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403
string address = 11;
- // Android deep link, e.g.
+ // Android deep link, for example,
// android-app://com.example.android/http/example.com/gizmos?1234.
string android_app_link = 12;
- // iOS deep link, e.g. exampleApp://content/page.
+ // iOS deep link, for example, exampleApp://content/page.
string ios_app_link = 13;
// iOS app store ID. This is used to check if the user has the app installed
@@ -698,11 +720,11 @@ message DynamicHotelsAndRentalsAsset {
int64 ios_app_store_id = 14;
// Formatted price which can be any characters. If set, this attribute will be
- // used instead of 'price', e.g. Starting at $100.00.
+ // used instead of 'price', for example, Starting at $100.00.
string formatted_price = 15;
// Formatted sale price which can be any characters. If set, this attribute
- // will be used instead of 'sale price', e.g. On sale for $80.00.
+ // will be used instead of 'sale price', for example, On sale for $80.00.
string formatted_sale_price = 16;
// Similar property IDs.
@@ -711,49 +733,49 @@ message DynamicHotelsAndRentalsAsset {
// A dynamic flights asset.
message DynamicFlightsAsset {
- // Required. Destination ID which can be any sequence of letters and digits, and must be
- // unique and match the values of remarketing tag. Required.
+ // Required. Destination ID which can be any sequence of letters and digits,
+ // and must be unique and match the values of remarketing tag. Required.
string destination_id = 1 [(google.api.field_behavior) = REQUIRED];
// Origin ID which can be any sequence of letters and digits. The ID sequence
// (destination ID + origin ID) must be unique.
string origin_id = 2;
- // Required. Flight description, e.g. Book your ticket. Required.
+ // Required. Flight description, for example, Book your ticket. Required.
string flight_description = 3 [(google.api.field_behavior) = REQUIRED];
- // Image URL, e.g. http://www.example.com/image.png. The image will not be
- // uploaded as image asset.
+ // Image URL, for example, http://www.example.com/image.png. The image will
+ // not be uploaded as image asset.
string image_url = 4;
- // Destination name, e.g. Paris.
+ // Destination name, for example, Paris.
string destination_name = 5;
- // Origin name, e.g. London.
+ // Origin name, for example, London.
string origin_name = 6;
// Flight price which can be number followed by the alphabetic currency code,
- // ISO 4217 standard. Use '.' as the decimal mark. e.g. 100.00 USD.
+ // ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
string flight_price = 7;
// Flight sale price which can be number followed by the alphabetic currency
- // code, ISO 4217 standard. Use '.' as the decimal mark, e.g. 80.00 USD.
- // Must be less than the 'flight_price' field.
+ // code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00
+ // USD. Must be less than the 'flight_price' field.
string flight_sale_price = 8;
// Formatted price which can be any characters. If set, this attribute will be
- // used instead of 'price', e.g. Starting at $100.00.
+ // used instead of 'price', for example, Starting at $100.00.
string formatted_price = 9;
// Formatted sale price which can be any characters. If set, this attribute
- // will be used instead of 'sale price', e.g. On sale for $80.00.
+ // will be used instead of 'sale price', for example, On sale for $80.00.
string formatted_sale_price = 10;
- // Android deep link, e.g.
+ // Android deep link, for example,
// android-app://com.example.android/http/example.com/gizmos?1234.
string android_app_link = 11;
- // iOS deep link, e.g. exampleApp://content/page.
+ // iOS deep link, for example, exampleApp://content/page.
string ios_app_link = 12;
// iOS app store ID. This is used to check if the user has the app installed
@@ -761,14 +783,14 @@ message DynamicFlightsAsset {
// ios_app_link field must also be present.
int64 ios_app_store_id = 13;
- // Similar destination IDs, e.g. PAR,LON.
+ // Similar destination IDs, for example, PAR,LON.
repeated string similar_destination_ids = 14;
// A custom field which can be multiple key to values mapping separated by
// delimiters (",", "|" and ":"), in the forms of
// ": , , ... , | : , ...
- // , | ... | : , ... ," e.g. wifi: most |
- // aircraft: 320, 77W | flights: 42 | legroom: 32".
+ // , | ... | : , ... ," for example, wifi:
+ // most | aircraft: 320, 77W | flights: 42 | legroom: 32".
string custom_mapping = 15;
}
@@ -794,64 +816,64 @@ message DiscoveryCarouselCardAsset {
// A dynamic travel asset.
message DynamicTravelAsset {
- // Required. Destination ID which can be any sequence of letters and digits, and must be
- // unique and match the values of remarketing tag. Required.
+ // Required. Destination ID which can be any sequence of letters and digits,
+ // and must be unique and match the values of remarketing tag. Required.
string destination_id = 1 [(google.api.field_behavior) = REQUIRED];
// Origin ID which can be any sequence of letters and digits. The ID sequence
// (destination ID + origin ID) must be unique.
string origin_id = 2;
- // Required. Title, e.g. Book your train ticket. Required.
+ // Required. Title, for example, Book your train ticket. Required.
string title = 3 [(google.api.field_behavior) = REQUIRED];
- // Destination name, e.g. Paris.
+ // Destination name, for example, Paris.
string destination_name = 4;
// Destination address which can be specified in one of the following formats.
- // (1) City, state, code, country, e.g. Mountain View, CA, USA.
- // (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043.
- // (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403.
+ // (1) City, state, code, country, for example, Mountain View, CA, USA.
+ // (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043.
+ // (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
string destination_address = 5;
- // Origin name, e.g. London.
+ // Origin name, for example, London.
string origin_name = 6;
// Price which can be a number followed by the alphabetic currency code,
- // ISO 4217 standard. Use '.' as the decimal mark. e.g. 100.00 USD.
+ // ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
string price = 7;
// Sale price which can be a number followed by the alphabetic currency
- // code, ISO 4217 standard. Use '.' as the decimal mark, e.g. 80.00 USD.
- // Must be less than the 'price' field.
+ // code, ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00
+ // USD. Must be less than the 'price' field.
string sale_price = 8;
// Formatted price which can be any characters. If set, this attribute will be
- // used instead of 'price', e.g. Starting at $100.00.
+ // used instead of 'price', for example, Starting at $100.00.
string formatted_price = 9;
// Formatted sale price which can be any characters. If set, this attribute
- // will be used instead of 'sale price', e.g. On sale for $80.00.
+ // will be used instead of 'sale price', for example, On sale for $80.00.
string formatted_sale_price = 10;
- // Category, e.g. Express.
+ // Category, for example, Express.
string category = 11;
- // Contextual keywords, e.g. Paris trains.
+ // Contextual keywords, for example, Paris trains.
repeated string contextual_keywords = 12;
- // Similar destination IDs, e.g. NYC.
+ // Similar destination IDs, for example, NYC.
repeated string similar_destination_ids = 13;
- // Image URL, e.g. http://www.example.com/image.png. The image will not be
- // uploaded as image asset.
+ // Image URL, for example, http://www.example.com/image.png. The image will
+ // not be uploaded as image asset.
string image_url = 14;
- // Android deep link, e.g.
+ // Android deep link, for example,
// android-app://com.example.android/http/example.com/gizmos?1234.
string android_app_link = 15;
- // iOS deep link, e.g. exampleApp://content/page.
+ // iOS deep link, for example, exampleApp://content/page.
string ios_app_link = 16;
// iOS app store ID. This is used to check if the user has the app installed
@@ -862,60 +884,61 @@ message DynamicTravelAsset {
// A dynamic local asset.
message DynamicLocalAsset {
- // Required. Deal ID which can be any sequence of letters and digits, and must be
- // unique and match the values of remarketing tag. Required.
+ // Required. Deal ID which can be any sequence of letters and digits, and must
+ // be unique and match the values of remarketing tag. Required.
string deal_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. Deal name, e.g. 50% off at Mountain View Grocers. Required.
+ // Required. Deal name, for example, 50% off at Mountain View Grocers.
+ // Required.
string deal_name = 2 [(google.api.field_behavior) = REQUIRED];
- // Subtitle, e.g. Groceries.
+ // Subtitle, for example, Groceries.
string subtitle = 3;
- // Description, e.g. Save on your weekly bill.
+ // Description, for example, Save on your weekly bill.
string description = 4;
// Price which can be a number followed by the alphabetic currency code,
- // ISO 4217 standard. Use '.' as the decimal mark, e.g. 100.00 USD.
+ // ISO 4217 standard. Use '.' as the decimal mark, for example, 100.00 USD.
string price = 5;
// Sale price which can be number followed by the alphabetic currency code,
- // ISO 4217 standard. Use '.' as the decimal mark, e.g. 80.00 USD.
+ // ISO 4217 standard. Use '.' as the decimal mark, for example, 80.00 USD.
// Must be less than the 'price' field.
string sale_price = 6;
- // Image URL, e.g. http://www.example.com/image.png. The image will not be
- // uploaded as image asset.
+ // Image URL, for example, http://www.example.com/image.png. The image will
+ // not be uploaded as image asset.
string image_url = 7;
// Address which can be specified in one of the following formats.
- // (1) City, state, code, country, e.g. Mountain View, CA, USA.
- // (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043.
- // (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403.
+ // (1) City, state, code, country, for example, Mountain View, CA, USA.
+ // (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043.
+ // (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
string address = 8;
- // Category, e.g. Food.
+ // Category, for example, Food.
string category = 9;
- // Contextual keywords, e.g. Save groceries coupons.
+ // Contextual keywords, for example, Save groceries coupons.
repeated string contextual_keywords = 10;
// Formatted price which can be any characters. If set, this attribute will be
- // used instead of 'price', e.g. Starting at $100.00.
+ // used instead of 'price', for example, Starting at $100.00.
string formatted_price = 11;
// Formatted sale price which can be any characters. If set, this attribute
- // will be used instead of 'sale price', e.g. On sale for $80.00.
+ // will be used instead of 'sale price', for example, On sale for $80.00.
string formatted_sale_price = 12;
- // Android deep link, e.g.
+ // Android deep link, for example,
// android-app://com.example.android/http/example.com/gizmos?1234.
string android_app_link = 13;
- // Similar deal IDs, e.g. 1275.
+ // Similar deal IDs, for example, 1275.
repeated string similar_deal_ids = 14;
- // iOS deep link, e.g. exampleApp://content/page.
+ // iOS deep link, for example, exampleApp://content/page.
string ios_app_link = 15;
// iOS app store ID. This is used to check if the user has the app installed
@@ -926,50 +949,50 @@ message DynamicLocalAsset {
// A dynamic jobs asset.
message DynamicJobsAsset {
- // Required. Job ID which can be any sequence of letters and digits, and must be
- // unique and match the values of remarketing tag. Required.
+ // Required. Job ID which can be any sequence of letters and digits, and must
+ // be unique and match the values of remarketing tag. Required.
string job_id = 1 [(google.api.field_behavior) = REQUIRED];
// Location ID which can be any sequence of letters and digits. The ID
// sequence (job ID + location ID) must be unique.
string location_id = 2;
- // Required. Job title, e.g. Software engineer. Required.
+ // Required. Job title, for example, Software engineer. Required.
string job_title = 3 [(google.api.field_behavior) = REQUIRED];
- // Job subtitle, e.g. Level II.
+ // Job subtitle, for example, Level II.
string job_subtitle = 4;
- // Description, e.g. Apply your technical skills.
+ // Description, for example, Apply your technical skills.
string description = 5;
- // Image URL, e.g. http://www.example.com/image.png. The image will not be
- // uploaded as image asset.
+ // Image URL, for example, http://www.example.com/image.png. The image will
+ // not be uploaded as image asset.
string image_url = 6;
- // Job category, e.g. Technical.
+ // Job category, for example, Technical.
string job_category = 7;
- // Contextual keywords, e.g. Software engineering job.
+ // Contextual keywords, for example, Software engineering job.
repeated string contextual_keywords = 8;
// Address which can be specified in one of the following formats.
- // (1) City, state, code, country, e.g. Mountain View, CA, USA.
- // (2) Full address, e.g. 123 Boulevard St, Mountain View, CA 94043.
- // (3) Latitude-longitude in the DDD format, e.g. 41.40338, 2.17403.
+ // (1) City, state, code, country, for example, Mountain View, CA, USA.
+ // (2) Full address, for example, 123 Boulevard St, Mountain View, CA 94043.
+ // (3) Latitude-longitude in the DDD format, for example, 41.40338, 2.17403.
string address = 9;
- // Salary, e.g. $100,000.
+ // Salary, for example, $100,000.
string salary = 10;
- // Android deep link, e.g.
+ // Android deep link, for example,
// android-app://com.example.android/http/example.com/gizmos?1234.
string android_app_link = 11;
- // Similar job IDs, e.g. 1275.
+ // Similar job IDs, for example, 1275.
repeated string similar_job_ids = 12;
- // iOS deep link, e.g. exampleApp://content/page.
+ // iOS deep link, for example, exampleApp://content/page.
string ios_app_link = 13;
// iOS app store ID. This is used to check if the user has the app installed
@@ -977,3 +1000,55 @@ message DynamicJobsAsset {
// ios_app_link field must also be present.
int64 ios_app_store_id = 14;
}
+
+// A location asset.
+message LocationAsset {
+ // Place IDs uniquely identify a place in the Google Places database and on
+ // Google Maps.
+ // This field is unique for a given customer ID and asset type. See
+ // https://developers.google.com/places/web-service/place-id to learn more
+ // about Place ID.
+ string place_id = 1;
+
+ // The list of business locations for the customer.
+ // This will only be returned if the Location Asset is syncing from the
+ // Business Profile account. It is possible to have multiple Business Profile
+ // listings under the same account that point to the same Place ID.
+ repeated BusinessProfileLocation business_profile_locations = 2;
+
+ // The type of location ownership.
+ // If the type is BUSINESS_OWNER, it will be served as a location extension.
+ // If the type is AFFILIATE, it will be served as an affiliate location.
+ google.ads.googleads.v13.enums.LocationOwnershipTypeEnum.LocationOwnershipType
+ location_ownership_type = 3;
+}
+
+// Business Profile location data synced from the linked Business Profile
+// account.
+message BusinessProfileLocation {
+ // Advertiser specified label for the location on the Business Profile
+ // account. This is synced from the Business Profile account.
+ repeated string labels = 1;
+
+ // Business Profile store code of this location. This is synced from the
+ // Business Profile account.
+ string store_code = 2;
+
+ // Listing ID of this Business Profile location. This is synced from the
+ // linked Business Profile account.
+ int64 listing_id = 3;
+}
+
+// A hotel property asset.
+message HotelPropertyAsset {
+ // Place IDs uniquely identify a place in the Google Places database and on
+ // Google Maps. See https://developers.google.com/places/web-service/place-id
+ // to learn more.
+ string place_id = 1;
+
+ // Address of the hotel. Read-only.
+ string hotel_address = 2;
+
+ // Name of the hotel. Read-only.
+ string hotel_name = 3;
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/asset_usage.proto b/third_party/googleapis/google/ads/googleads/v13/common/asset_usage.proto
similarity index 67%
rename from third_party/googleapis/google/ads/googleads/v10/common/asset_usage.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/asset_usage.proto
index fed3ed5f0..2e58adabc 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/asset_usage.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/asset_usage.proto
@@ -14,18 +14,18 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/served_asset_field_type.proto";
+import "google/ads/googleads/v13/enums/served_asset_field_type.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "AssetUsageProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing asset usage.
@@ -35,5 +35,6 @@ message AssetUsage {
string asset = 1;
// The served field type of the asset.
- google.ads.googleads.v10.enums.ServedAssetFieldTypeEnum.ServedAssetFieldType served_asset_field_type = 2;
+ google.ads.googleads.v13.enums.ServedAssetFieldTypeEnum.ServedAssetFieldType
+ served_asset_field_type = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/audiences.proto b/third_party/googleapis/google/ads/googleads/v13/common/audiences.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/common/audiences.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/audiences.proto
index 126955c00..c343d204e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/audiences.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/audiences.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/gender_type.proto";
-import "google/ads/googleads/v10/enums/income_range_type.proto";
-import "google/ads/googleads/v10/enums/parental_status_type.proto";
+import "google/ads/googleads/v13/enums/gender_type.proto";
+import "google/ads/googleads/v13/enums/income_range_type.proto";
+import "google/ads/googleads/v13/enums/parental_status_type.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "AudiencesProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Positive dimension specifying user's audience.
message AudienceDimension {
@@ -90,7 +90,7 @@ message AgeSegment {
// Dimension specifying users by their gender.
message GenderDimension {
// Included gender demographic segments.
- repeated google.ads.googleads.v10.enums.GenderTypeEnum.GenderType genders = 1;
+ repeated google.ads.googleads.v13.enums.GenderTypeEnum.GenderType genders = 1;
// Include users whose gender is not determined.
optional bool include_undetermined = 2;
@@ -99,7 +99,8 @@ message GenderDimension {
// Dimension specifying users by their household income.
message HouseholdIncomeDimension {
// Included household income demographic segments.
- repeated google.ads.googleads.v10.enums.IncomeRangeTypeEnum.IncomeRangeType income_ranges = 1;
+ repeated google.ads.googleads.v13.enums.IncomeRangeTypeEnum.IncomeRangeType
+ income_ranges = 1;
// Include users whose household income is not determined.
optional bool include_undetermined = 2;
@@ -108,7 +109,9 @@ message HouseholdIncomeDimension {
// Dimension specifying users by their parental status.
message ParentalStatusDimension {
// Included parental status demographic segments.
- repeated google.ads.googleads.v10.enums.ParentalStatusTypeEnum.ParentalStatusType parental_statuses = 1;
+ repeated
+ google.ads.googleads.v13.enums.ParentalStatusTypeEnum.ParentalStatusType
+ parental_statuses = 1;
// Include users whose parental status is undetermined.
optional bool include_undetermined = 2;
@@ -143,6 +146,9 @@ message AudienceSegment {
}
// User list segment.
+// The Similar Audiences sunset starts May 2023. Refer to
+// https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html
+// for other options.
message UserListSegment {
// The user list resource.
optional string user_list = 1;
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/bidding.proto b/third_party/googleapis/google/ads/googleads/v13/common/bidding.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/common/bidding.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/bidding.proto
index 66c84ea04..b2c42f60a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/bidding.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/bidding.proto
@@ -14,18 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/target_impression_share_location.proto";
+import "google/ads/googleads/v13/enums/target_frequency_time_unit.proto";
+import "google/ads/googleads/v13/enums/target_impression_share_location.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "BiddingProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing bidding schemes.
@@ -42,9 +43,14 @@ message Commission {
// An automated bidding strategy that raises bids for clicks
// that seem more likely to lead to a conversion and lowers
// them for clicks where they seem less likely.
-message EnhancedCpc {
+//
+// This bidding strategy is deprecated and cannot be created anymore. Use
+// ManualCpc with enhanced_cpc_enabled set to true for equivalent functionality.
+message EnhancedCpc {}
-}
+// Manual bidding strategy that allows advertiser to set the bid per
+// advertiser-specified action.
+message ManualCpa {}
// Manual click-based bidding where user pays per click.
message ManualCpc {
@@ -53,26 +59,14 @@ message ManualCpc {
}
// Manual impression-based bidding where user pays per thousand impressions.
-message ManualCpm {
-
-}
+message ManualCpm {}
// View based bidding where user pays per video view.
-message ManualCpv {
-
-}
+message ManualCpv {}
// An automated bidding strategy to help get the most conversions for your
// campaigns while spending your budget.
message MaximizeConversions {
- // The target cost-per-action (CPA) option. This is the average amount that
- // you would like to spend per conversion action specified in micro units of
- // the bidding strategy's currency. If set, the bid strategy will get as many
- // conversions as possible at or below the target cost-per-action. If the
- // target CPA is not set, the bid strategy will aim to achieve the lowest
- // possible CPA given the budget.
- int64 target_cpa = 1;
-
// Maximum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
// Mutable for portfolio bidding strategies only.
@@ -82,6 +76,14 @@ message MaximizeConversions {
// The limit applies to all keywords managed by the strategy.
// Mutable for portfolio bidding strategies only.
int64 cpc_bid_floor_micros = 3;
+
+ // The target cost-per-action (CPA) option. This is the average amount that
+ // you would like to spend per conversion action specified in micro units of
+ // the bidding strategy's currency. If set, the bid strategy will get as many
+ // conversions as possible at or below the target cost-per-action. If the
+ // target CPA is not set, the bid strategy will aim to achieve the lowest
+ // possible CPA given the budget.
+ int64 target_cpa_micros = 4;
}
// An automated bidding strategy to help get the most conversion value for your
@@ -127,7 +129,23 @@ message TargetCpa {
// Target CPM (cost per thousand impressions) is an automated bidding strategy
// that sets bids to optimize performance given the target CPM you set.
message TargetCpm {
+ // Additional information related to bidding goal.
+ oneof goal {
+ // Target Frequency bidding goal details.
+ TargetCpmTargetFrequencyGoal target_frequency_goal = 1;
+ }
+}
+
+// Target Frequency bidding goal details.
+message TargetCpmTargetFrequencyGoal {
+ // Target Frequency count representing how many times you want to reach
+ // a single user.
+ int64 target_count = 1;
+ // Time window expressing the period over which you want to reach
+ // the specified target_count.
+ google.ads.googleads.v13.enums.TargetFrequencyTimeUnitEnum
+ .TargetFrequencyTimeUnit time_unit = 2;
}
// An automated bidding strategy that sets bids so that a certain percentage of
@@ -135,10 +153,11 @@ message TargetCpm {
// location).
message TargetImpressionShare {
// The targeted location on the search results page.
- google.ads.googleads.v10.enums.TargetImpressionShareLocationEnum.TargetImpressionShareLocation location = 1;
+ google.ads.googleads.v13.enums.TargetImpressionShareLocationEnum
+ .TargetImpressionShareLocation location = 1;
- // The desired fraction of ads to be shown in the targeted location in micros.
- // E.g. 1% equals 10,000.
+ // The chosen fraction of ads to be shown in the targeted location in micros.
+ // For example, 1% equals 10,000.
optional int64 location_fraction_micros = 4;
// The highest CPC bid the automated bidding system is permitted to specify.
@@ -150,7 +169,7 @@ message TargetImpressionShare {
// An automated bidding strategy that helps you maximize revenue while
// averaging a specific target return on ad spend (ROAS).
message TargetRoas {
- // Required. The desired revenue (based on conversion data) per unit of spend.
+ // Required. The chosen revenue (based on conversion data) per unit of spend.
// Value must be between 0.01 and 1000.0, inclusive.
optional double target_roas = 4;
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/click_location.proto b/third_party/googleapis/google/ads/googleads/v13/common/click_location.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/common/click_location.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/click_location.proto
index 8fe94caf2..51c6be39a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/click_location.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/click_location.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "ClickLocationProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing a ClickLocation.
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/criteria.proto b/third_party/googleapis/google/ads/googleads/v13/common/criteria.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/common/criteria.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/criteria.proto
index abdfa9310..68d5bb571 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/criteria.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/criteria.proto
@@ -14,41 +14,40 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
-
-import "google/ads/googleads/v10/enums/age_range_type.proto";
-import "google/ads/googleads/v10/enums/app_payment_model_type.proto";
-import "google/ads/googleads/v10/enums/content_label_type.proto";
-import "google/ads/googleads/v10/enums/day_of_week.proto";
-import "google/ads/googleads/v10/enums/device.proto";
-import "google/ads/googleads/v10/enums/gender_type.proto";
-import "google/ads/googleads/v10/enums/hotel_date_selection_type.proto";
-import "google/ads/googleads/v10/enums/income_range_type.proto";
-import "google/ads/googleads/v10/enums/interaction_type.proto";
-import "google/ads/googleads/v10/enums/keyword_match_type.proto";
-import "google/ads/googleads/v10/enums/listing_group_type.proto";
-import "google/ads/googleads/v10/enums/location_group_radius_units.proto";
-import "google/ads/googleads/v10/enums/minute_of_hour.proto";
-import "google/ads/googleads/v10/enums/parental_status_type.proto";
-import "google/ads/googleads/v10/enums/preferred_content_type.proto";
-import "google/ads/googleads/v10/enums/product_bidding_category_level.proto";
-import "google/ads/googleads/v10/enums/product_channel.proto";
-import "google/ads/googleads/v10/enums/product_channel_exclusivity.proto";
-import "google/ads/googleads/v10/enums/product_condition.proto";
-import "google/ads/googleads/v10/enums/product_custom_attribute_index.proto";
-import "google/ads/googleads/v10/enums/product_type_level.proto";
-import "google/ads/googleads/v10/enums/proximity_radius_units.proto";
-import "google/ads/googleads/v10/enums/webpage_condition_operand.proto";
-import "google/ads/googleads/v10/enums/webpage_condition_operator.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+package google.ads.googleads.v13.common;
+
+import "google/ads/googleads/v13/enums/age_range_type.proto";
+import "google/ads/googleads/v13/enums/app_payment_model_type.proto";
+import "google/ads/googleads/v13/enums/content_label_type.proto";
+import "google/ads/googleads/v13/enums/day_of_week.proto";
+import "google/ads/googleads/v13/enums/device.proto";
+import "google/ads/googleads/v13/enums/gender_type.proto";
+import "google/ads/googleads/v13/enums/hotel_date_selection_type.proto";
+import "google/ads/googleads/v13/enums/income_range_type.proto";
+import "google/ads/googleads/v13/enums/interaction_type.proto";
+import "google/ads/googleads/v13/enums/keyword_match_type.proto";
+import "google/ads/googleads/v13/enums/listing_group_type.proto";
+import "google/ads/googleads/v13/enums/location_group_radius_units.proto";
+import "google/ads/googleads/v13/enums/minute_of_hour.proto";
+import "google/ads/googleads/v13/enums/parental_status_type.proto";
+import "google/ads/googleads/v13/enums/product_bidding_category_level.proto";
+import "google/ads/googleads/v13/enums/product_channel.proto";
+import "google/ads/googleads/v13/enums/product_channel_exclusivity.proto";
+import "google/ads/googleads/v13/enums/product_condition.proto";
+import "google/ads/googleads/v13/enums/product_custom_attribute_index.proto";
+import "google/ads/googleads/v13/enums/product_type_level.proto";
+import "google/ads/googleads/v13/enums/proximity_radius_units.proto";
+import "google/ads/googleads/v13/enums/webpage_condition_operand.proto";
+import "google/ads/googleads/v13/enums/webpage_condition_operator.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "CriteriaProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing criteria types.
@@ -58,7 +57,8 @@ message KeywordInfo {
optional string text = 3;
// The match type of the keyword.
- google.ads.googleads.v10.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 2;
+ google.ads.googleads.v13.enums.KeywordMatchTypeEnum.KeywordMatchType
+ match_type = 2;
}
// A placement criterion. This can be used to modify bids for sites when
@@ -84,10 +84,11 @@ message MobileApplicationInfo {
// platform_native_id is the mobile application identifier native to the
// corresponding platform.
// For iOS, this native identifier is the 9 digit string that appears at the
- // end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App
- // Store link is "http://itunes.apple.com/us/app/flood-it!-2/id476943146").
- // For Android, this native identifier is the application's package name
- // (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link
+ // end of an App Store URL (for example, "476943146" for "Flood-It! 2" whose
+ // App Store link is
+ // "http://itunes.apple.com/us/app/flood-it!-2/id476943146"). For Android,
+ // this native identifier is the application's package name (for example,
+ // "com.labpixies.colordrips" for "Color Drips" given Google Play link
// "https://play.google.com/store/apps/details?id=com.labpixies.colordrips").
// A well formed app id for Google Ads API would thus be "1-476943146" for iOS
// and "2-com.labpixies.colordrips" for Android.
@@ -107,19 +108,13 @@ message LocationInfo {
// A device criterion.
message DeviceInfo {
// Type of the device.
- google.ads.googleads.v10.enums.DeviceEnum.Device type = 1;
-}
-
-// A preferred content criterion.
-message PreferredContentInfo {
- // Type of the preferred content.
- google.ads.googleads.v10.enums.PreferredContentTypeEnum.PreferredContentType type = 2;
+ google.ads.googleads.v13.enums.DeviceEnum.Device type = 1;
}
// A listing group criterion.
message ListingGroupInfo {
// Type of the listing group.
- google.ads.googleads.v10.enums.ListingGroupTypeEnum.ListingGroupType type = 1;
+ google.ads.googleads.v13.enums.ListingGroupTypeEnum.ListingGroupType type = 1;
// Dimension value with which this listing group is refining its parent.
// Undefined for the root group.
@@ -179,18 +174,31 @@ message ListingDimensionInfo {
// Type of a product offer.
ProductTypeInfo product_type = 12;
- // Grouping of a product offer.
+ // Grouping of a product offer. This listing dimension is deprecated and it
+ // is supported only in Display campaigns.
ProductGroupingInfo product_grouping = 17;
- // Labels of a product offer.
+ // Labels of a product offer. This listing dimension is deprecated and it is
+ // supported only in Display campaigns.
ProductLabelsInfo product_labels = 18;
- // Legacy condition of a product offer.
+ // Legacy condition of a product offer. This listing dimension is deprecated
+ // and it is supported only in Display campaigns.
ProductLegacyConditionInfo product_legacy_condition = 19;
- // Full type of a product offer.
+ // Full type of a product offer. This listing dimension is deprecated and it
+ // is supported only in Display campaigns.
ProductTypeFullInfo product_type_full = 20;
+ // Advertiser-specific activity ID.
+ ActivityIdInfo activity_id = 21;
+
+ // Rating of the activity as a number 1 to 5, where 5 is the best.
+ ActivityRatingInfo activity_rating = 22;
+
+ // Country the activity is in.
+ ActivityCountryInfo activity_country = 23;
+
// Unknown dimension. Set when no other listing dimension is set.
UnknownListingDimensionInfo unknown_listing_dimension = 14;
}
@@ -234,12 +242,9 @@ message ProductBiddingCategoryInfo {
// this article: https://support.google.com/merchants/answer/6324436
optional int64 id = 4;
- // Two-letter upper-case country code of the product bidding category. It must
- // match the campaign.shopping_setting.sales_country field.
- optional string country_code = 5;
-
// Level of the product bidding category.
- google.ads.googleads.v10.enums.ProductBiddingCategoryLevelEnum.ProductBiddingCategoryLevel level = 3;
+ google.ads.googleads.v13.enums.ProductBiddingCategoryLevelEnum
+ .ProductBiddingCategoryLevel level = 3;
}
// Brand of the product.
@@ -251,19 +256,21 @@ message ProductBrandInfo {
// Locality of a product offer.
message ProductChannelInfo {
// Value of the locality.
- google.ads.googleads.v10.enums.ProductChannelEnum.ProductChannel channel = 1;
+ google.ads.googleads.v13.enums.ProductChannelEnum.ProductChannel channel = 1;
}
// Availability of a product offer.
message ProductChannelExclusivityInfo {
// Value of the availability.
- google.ads.googleads.v10.enums.ProductChannelExclusivityEnum.ProductChannelExclusivity channel_exclusivity = 1;
+ google.ads.googleads.v13.enums.ProductChannelExclusivityEnum
+ .ProductChannelExclusivity channel_exclusivity = 1;
}
// Condition of a product offer.
message ProductConditionInfo {
// Value of the condition.
- google.ads.googleads.v10.enums.ProductConditionEnum.ProductCondition condition = 1;
+ google.ads.googleads.v13.enums.ProductConditionEnum.ProductCondition
+ condition = 1;
}
// Custom attribute of a product offer.
@@ -272,7 +279,8 @@ message ProductCustomAttributeInfo {
optional string value = 3;
// Indicates the index of the custom attribute.
- google.ads.googleads.v10.enums.ProductCustomAttributeIndexEnum.ProductCustomAttributeIndex index = 2;
+ google.ads.googleads.v13.enums.ProductCustomAttributeIndexEnum
+ .ProductCustomAttributeIndex index = 2;
}
// Item id of a product offer.
@@ -287,7 +295,8 @@ message ProductTypeInfo {
optional string value = 3;
// Level of the type.
- google.ads.googleads.v10.enums.ProductTypeLevelEnum.ProductTypeLevel level = 2;
+ google.ads.googleads.v13.enums.ProductTypeLevelEnum.ProductTypeLevel level =
+ 2;
}
// Grouping of a product offer. This listing dimension is deprecated and it is
@@ -319,14 +328,13 @@ message ProductTypeFullInfo {
}
// Unknown listing dimension.
-message UnknownListingDimensionInfo {
+message UnknownListingDimensionInfo {}
-}
-
-// Criterion for hotel date selection (default dates vs. user selected).
+// Criterion for hotel date selection (default dates versus user selected).
message HotelDateSelectionTypeInfo {
// Type of the hotel date selection
- google.ads.googleads.v10.enums.HotelDateSelectionTypeEnum.HotelDateSelectionType type = 1;
+ google.ads.googleads.v13.enums.HotelDateSelectionTypeEnum
+ .HotelDateSelectionType type = 1;
}
// Criterion for number of days prior to the stay the booking is being made.
@@ -359,13 +367,32 @@ message HotelCheckInDateRangeInfo {
// Criterion for day of the week the booking is for.
message HotelCheckInDayInfo {
// The day of the week.
- google.ads.googleads.v10.enums.DayOfWeekEnum.DayOfWeek day_of_week = 1;
+ google.ads.googleads.v13.enums.DayOfWeekEnum.DayOfWeek day_of_week = 1;
+}
+
+// Advertiser-specific activity ID.
+message ActivityIdInfo {
+ // String value of the activity ID.
+ optional string value = 1;
+}
+
+// Rating of the activity as a number 1 to 5, where 5 is the best.
+message ActivityRatingInfo {
+ // Long value of the activity rating.
+ optional int64 value = 1;
+}
+
+// Country the activity is in.
+message ActivityCountryInfo {
+ // String value of the activity country. The Geo Target Constant resource
+ // name.
+ optional string value = 1;
}
// Criterion for Interaction Type.
message InteractionTypeInfo {
// The interaction type.
- google.ads.googleads.v10.enums.InteractionTypeEnum.InteractionType type = 1;
+ google.ads.googleads.v13.enums.InteractionTypeEnum.InteractionType type = 1;
}
// Represents an AdSchedule criterion.
@@ -379,14 +406,14 @@ message AdScheduleInfo {
//
// This field is required for CREATE operations and is prohibited on UPDATE
// operations.
- google.ads.googleads.v10.enums.MinuteOfHourEnum.MinuteOfHour start_minute = 1;
+ google.ads.googleads.v13.enums.MinuteOfHourEnum.MinuteOfHour start_minute = 1;
// Minutes after the end hour at which this schedule ends. The schedule is
// exclusive of the end minute.
//
// This field is required for CREATE operations and is prohibited on UPDATE
// operations.
- google.ads.googleads.v10.enums.MinuteOfHourEnum.MinuteOfHour end_minute = 2;
+ google.ads.googleads.v13.enums.MinuteOfHourEnum.MinuteOfHour end_minute = 2;
// Starting hour in 24 hour time.
// This field must be between 0 and 23, inclusive.
@@ -406,31 +433,32 @@ message AdScheduleInfo {
//
// This field is required for CREATE operations and is prohibited on UPDATE
// operations.
- google.ads.googleads.v10.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5;
+ google.ads.googleads.v13.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5;
}
// An age range criterion.
message AgeRangeInfo {
// Type of the age range.
- google.ads.googleads.v10.enums.AgeRangeTypeEnum.AgeRangeType type = 1;
+ google.ads.googleads.v13.enums.AgeRangeTypeEnum.AgeRangeType type = 1;
}
// A gender criterion.
message GenderInfo {
// Type of the gender.
- google.ads.googleads.v10.enums.GenderTypeEnum.GenderType type = 1;
+ google.ads.googleads.v13.enums.GenderTypeEnum.GenderType type = 1;
}
// An income range criterion.
message IncomeRangeInfo {
// Type of the income range.
- google.ads.googleads.v10.enums.IncomeRangeTypeEnum.IncomeRangeType type = 1;
+ google.ads.googleads.v13.enums.IncomeRangeTypeEnum.IncomeRangeType type = 1;
}
// A parental status criterion.
message ParentalStatusInfo {
// Type of the parental status.
- google.ads.googleads.v10.enums.ParentalStatusTypeEnum.ParentalStatusType type = 1;
+ google.ads.googleads.v13.enums.ParentalStatusTypeEnum.ParentalStatusType
+ type = 1;
}
// A YouTube Video criterion.
@@ -468,7 +496,8 @@ message ProximityInfo {
optional double radius = 5;
// The unit of measurement of the radius. Default is KILOMETERS.
- google.ads.googleads.v10.enums.ProximityRadiusUnitsEnum.ProximityRadiusUnits radius_units = 3;
+ google.ads.googleads.v13.enums.ProximityRadiusUnitsEnum.ProximityRadiusUnits
+ radius_units = 3;
// Full address.
AddressInfo address = 4;
@@ -542,7 +571,7 @@ message IpBlockInfo {
// Content Label for category exclusion.
message ContentLabelInfo {
// Content label type, required for CREATE operations.
- google.ads.googleads.v10.enums.ContentLabelTypeEnum.ContentLabelType type = 1;
+ google.ads.googleads.v13.enums.ContentLabelTypeEnum.ContentLabelType type = 1;
}
// Represents a Carrier Criterion.
@@ -569,7 +598,8 @@ message WebpageInfo {
// Conditions, or logical expressions, for webpage targeting. The list of
// webpage targeting conditions are and-ed together when evaluated
- // for targeting.
+ // for targeting. An empty list of conditions indicates all pages of the
+ // campaign's website are targeted.
//
// This field is required for CREATE operations and is prohibited on UPDATE
// operations.
@@ -589,10 +619,13 @@ message WebpageInfo {
// Logical expression for targeting webpages of an advertiser's website.
message WebpageConditionInfo {
// Operand of webpage targeting condition.
- google.ads.googleads.v10.enums.WebpageConditionOperandEnum.WebpageConditionOperand operand = 1;
+ google.ads.googleads.v13.enums.WebpageConditionOperandEnum
+ .WebpageConditionOperand operand = 1;
// Operator of webpage targeting condition.
- google.ads.googleads.v10.enums.WebpageConditionOperatorEnum.WebpageConditionOperator operator = 2;
+ google.ads.googleads.v13.enums.WebpageConditionOperatorEnum
+ .WebpageConditionOperator
+ operator = 2;
// Argument of webpage targeting condition.
optional string argument = 4;
@@ -613,7 +646,8 @@ message OperatingSystemVersionInfo {
// An app payment model criterion.
message AppPaymentModelInfo {
// Type of the app payment model.
- google.ads.googleads.v10.enums.AppPaymentModelTypeEnum.AppPaymentModelType type = 1;
+ google.ads.googleads.v13.enums.AppPaymentModelTypeEnum.AppPaymentModelType
+ type = 1;
}
// A mobile device criterion.
@@ -636,14 +670,15 @@ message CustomIntentInfo {
optional string custom_intent = 2;
}
-// A radius around a list of locations specified via a feed.
+// A radius around a list of locations specified through a feed or assetSet.
message LocationGroupInfo {
- // Feed specifying locations for targeting.
- // This is required and must be set in CREATE operations.
+ // Feed specifying locations for targeting. Cannot be set with AssetSet
+ // fields. This is required and must be set in CREATE operations.
optional string feed = 5;
// Geo target constant(s) restricting the scope of the geographic area within
- // the feed. Currently only one geo target constant is allowed.
+ // the feed. Currently only one geo target constant is allowed. Cannot be set
+ // with AssetSet fields.
repeated string geo_target_constants = 6;
// Distance in units specifying the radius around targeted locations.
@@ -651,15 +686,31 @@ message LocationGroupInfo {
optional int64 radius = 7;
// Unit of the radius. Miles and meters are supported for geo target
- // constants. Milli miles and meters are supported for feed item sets.
- // This is required and must be set in CREATE operations.
- google.ads.googleads.v10.enums.LocationGroupRadiusUnitsEnum.LocationGroupRadiusUnits radius_units = 4;
+ // constants. Milli miles and meters are supported for feed item sets and
+ // asset sets. This is required and must be set in CREATE operations.
+ google.ads.googleads.v13.enums.LocationGroupRadiusUnitsEnum
+ .LocationGroupRadiusUnits radius_units = 4;
// FeedItemSets whose FeedItems are targeted. If multiple IDs are specified,
// then all items that appear in at least one set are targeted. This field
// cannot be used with geo_target_constants. This is optional and can only be
- // set in CREATE operations.
+ // set in CREATE operations. Cannot be set with AssetSet fields.
repeated string feed_item_sets = 8;
+
+ // Denotes that the latest customer level asset set is used for targeting.
+ // Used with radius and radius_units. Cannot be used with
+ // feed, geo target constants or feed item sets. When using asset sets, either
+ // this field or location_group_asset_sets should be specified. Both cannot be
+ // used at the same time. This can only be set in CREATE operations.
+ optional bool enable_customer_level_location_asset_set = 9;
+
+ // AssetSets whose Assets are targeted. If multiple IDs are specified, then
+ // all items that appear in at least one set are targeted. This field cannot
+ // be used with feed, geo target constants or feed item sets. When using asset
+ // sets, either this field or enable_customer_level_location_asset_set should
+ // be specified. Both cannot be used at the same time. This can only be set
+ // in CREATE operations.
+ repeated string location_group_asset_sets = 10;
}
// A custom audience criterion.
@@ -694,3 +745,10 @@ message KeywordThemeInfo {
string free_form_keyword_theme = 2;
}
}
+
+// A Local Services Ads service ID. Represents a service type
+// (such as install_faucet) that a Local Services Campaign can target.
+message LocalServiceIdInfo {
+ // The criterion resource name.
+ string service_id = 1;
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/criterion_category_availability.proto b/third_party/googleapis/google/ads/googleads/v13/common/criterion_category_availability.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/common/criterion_category_availability.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/criterion_category_availability.proto
index dd6f5165f..e7da44621 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/criterion_category_availability.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/criterion_category_availability.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/advertising_channel_sub_type.proto";
-import "google/ads/googleads/v10/enums/advertising_channel_type.proto";
-import "google/ads/googleads/v10/enums/criterion_category_channel_availability_mode.proto";
-import "google/ads/googleads/v10/enums/criterion_category_locale_availability_mode.proto";
+import "google/ads/googleads/v13/enums/advertising_channel_sub_type.proto";
+import "google/ads/googleads/v13/enums/advertising_channel_type.proto";
+import "google/ads/googleads/v13/enums/criterion_category_channel_availability_mode.proto";
+import "google/ads/googleads/v13/enums/criterion_category_locale_availability_mode.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "CriterionCategoryAvailabilityProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing criterion category availability information.
@@ -50,13 +50,16 @@ message CriterionCategoryChannelAvailability {
// CHANNEL_TYPE_AND_SUBTYPES (advertising_channel_type,
// advertising_channel_sub_type, and include_default_channel_sub_type will all
// be set).
- google.ads.googleads.v10.enums.CriterionCategoryChannelAvailabilityModeEnum.CriterionCategoryChannelAvailabilityMode availability_mode = 1;
+ google.ads.googleads.v13.enums.CriterionCategoryChannelAvailabilityModeEnum
+ .CriterionCategoryChannelAvailabilityMode availability_mode = 1;
// Channel type the category is available to.
- google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 2;
+ google.ads.googleads.v13.enums.AdvertisingChannelTypeEnum
+ .AdvertisingChannelType advertising_channel_type = 2;
// Channel subtypes under the channel type the category is available to.
- repeated google.ads.googleads.v10.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 3;
+ repeated google.ads.googleads.v13.enums.AdvertisingChannelSubTypeEnum
+ .AdvertisingChannelSubType advertising_channel_sub_type = 3;
// Whether default channel sub type is included. For example,
// advertising_channel_type being DISPLAY and include_default_channel_sub_type
@@ -71,7 +74,8 @@ message CriterionCategoryLocaleAvailability {
// language will be empty), COUNTRY (only country will be set), LANGUAGE (only
// language wil be set), COUNTRY_AND_LANGUAGE (both country and language will
// be set).
- google.ads.googleads.v10.enums.CriterionCategoryLocaleAvailabilityModeEnum.CriterionCategoryLocaleAvailabilityMode availability_mode = 1;
+ google.ads.googleads.v13.enums.CriterionCategoryLocaleAvailabilityModeEnum
+ .CriterionCategoryLocaleAvailabilityMode availability_mode = 1;
// Code of the country.
optional string country_code = 4;
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/custom_parameter.proto b/third_party/googleapis/google/ads/googleads/v13/common/custom_parameter.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/common/custom_parameter.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/custom_parameter.proto
index b7ee8e673..dc595a159 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/custom_parameter.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/custom_parameter.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "CustomParameterProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing CustomParameter and operation
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/customizer_value.proto b/third_party/googleapis/google/ads/googleads/v13/common/customizer_value.proto
similarity index 63%
rename from third_party/googleapis/google/ads/googleads/v10/common/customizer_value.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/customizer_value.proto
index cce674262..753715f16 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/customizer_value.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/customizer_value.proto
@@ -14,31 +14,33 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/customizer_attribute_type.proto";
+import "google/ads/googleads/v13/enums/customizer_attribute_type.proto";
import "google/api/field_behavior.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "CustomizerValueProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing common customizer value proto messages.
// A customizer value that is referenced in customizer linkage entities
// like CustomerCustomizer, CampaignCustomizer, etc.
message CustomizerValue {
- // Required. The data type for the customizer value. It must match the attribute type.
- // The string_value content must match the constraints associated with the
- // type.
- google.ads.googleads.v10.enums.CustomizerAttributeTypeEnum.CustomizerAttributeType type = 1 [(google.api.field_behavior) = REQUIRED];
+ // Required. The data type for the customizer value. It must match the
+ // attribute type. The string_value content must match the constraints
+ // associated with the type.
+ google.ads.googleads.v13.enums.CustomizerAttributeTypeEnum
+ .CustomizerAttributeType type = 1
+ [(google.api.field_behavior) = REQUIRED];
- // Required. Value to insert in creative text. Customizer values of all types are stored
- // as string to make formatting unambiguous.
+ // Required. Value to insert in creative text. Customizer values of all types
+ // are stored as string to make formatting unambiguous.
string string_value = 2 [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/dates.proto b/third_party/googleapis/google/ads/googleads/v13/common/dates.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/common/dates.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/dates.proto
index 2796d68c0..10c2e6687 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/dates.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/dates.proto
@@ -14,18 +14,18 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/month_of_year.proto";
+import "google/ads/googleads/v13/enums/month_of_year.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "DatesProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing date range message.
@@ -50,9 +50,9 @@ message YearMonthRange {
// Year month.
message YearMonth {
- // The year (e.g. 2020).
+ // The year (for example, 2020).
int64 year = 1;
- // The month of the year. (e.g. FEBRUARY).
- google.ads.googleads.v10.enums.MonthOfYearEnum.MonthOfYear month = 2;
+ // The month of the year. (for example, FEBRUARY).
+ google.ads.googleads.v13.enums.MonthOfYearEnum.MonthOfYear month = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/extensions.proto b/third_party/googleapis/google/ads/googleads/v13/common/extensions.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/common/extensions.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/extensions.proto
index ea8563206..8964ee08b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/extensions.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/extensions.proto
@@ -14,28 +14,28 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
-
-import "google/ads/googleads/v10/common/custom_parameter.proto";
-import "google/ads/googleads/v10/common/feed_common.proto";
-import "google/ads/googleads/v10/enums/app_store.proto";
-import "google/ads/googleads/v10/enums/call_conversion_reporting_state.proto";
-import "google/ads/googleads/v10/enums/price_extension_price_qualifier.proto";
-import "google/ads/googleads/v10/enums/price_extension_price_unit.proto";
-import "google/ads/googleads/v10/enums/price_extension_type.proto";
-import "google/ads/googleads/v10/enums/promotion_extension_discount_modifier.proto";
-import "google/ads/googleads/v10/enums/promotion_extension_occasion.proto";
+package google.ads.googleads.v13.common;
+
+import "google/ads/googleads/v13/common/custom_parameter.proto";
+import "google/ads/googleads/v13/common/feed_common.proto";
+import "google/ads/googleads/v13/enums/app_store.proto";
+import "google/ads/googleads/v13/enums/call_conversion_reporting_state.proto";
+import "google/ads/googleads/v13/enums/price_extension_price_qualifier.proto";
+import "google/ads/googleads/v13/enums/price_extension_price_unit.proto";
+import "google/ads/googleads/v13/enums/price_extension_type.proto";
+import "google/ads/googleads/v13/enums/promotion_extension_discount_modifier.proto";
+import "google/ads/googleads/v13/enums/promotion_extension_occasion.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "ExtensionsProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing extension types.
@@ -52,7 +52,7 @@ message AppFeedItem {
// The application store that the target application belongs to.
// This field is required.
- google.ads.googleads.v10.enums.AppStoreEnum.AppStore app_store = 3;
+ google.ads.googleads.v13.enums.AppStoreEnum.AppStore app_store = 3;
// A list of possible final URLs after all cross domain redirects.
// This list must not be empty.
@@ -99,7 +99,8 @@ message CallFeedItem {
// Enum value that indicates whether this call extension uses its own call
// conversion setting (or just have call conversion disabled), or following
// the account level setting.
- google.ads.googleads.v10.enums.CallConversionReportingStateEnum.CallConversionReportingState call_conversion_reporting_state = 6;
+ google.ads.googleads.v13.enums.CallConversionReportingStateEnum
+ .CallConversionReportingState call_conversion_reporting_state = 6;
}
// Represents a callout extension.
@@ -194,10 +195,12 @@ message TextMessageFeedItem {
// Represents a Price extension.
message PriceFeedItem {
// Price extension type of this extension.
- google.ads.googleads.v10.enums.PriceExtensionTypeEnum.PriceExtensionType type = 1;
+ google.ads.googleads.v13.enums.PriceExtensionTypeEnum.PriceExtensionType
+ type = 1;
// Price qualifier for all offers of this price extension.
- google.ads.googleads.v10.enums.PriceExtensionPriceQualifierEnum.PriceExtensionPriceQualifier price_qualifier = 2;
+ google.ads.googleads.v13.enums.PriceExtensionPriceQualifierEnum
+ .PriceExtensionPriceQualifier price_qualifier = 2;
// Tracking URL template for all offers of this price extension.
optional string tracking_url_template = 7;
@@ -224,7 +227,8 @@ message PriceOffer {
Money price = 3;
// Price unit for this offer.
- google.ads.googleads.v10.enums.PriceExtensionPriceUnitEnum.PriceExtensionPriceUnit unit = 4;
+ google.ads.googleads.v13.enums.PriceExtensionPriceUnitEnum
+ .PriceExtensionPriceUnit unit = 4;
// A list of possible final URLs after all cross domain redirects.
repeated string final_urls = 9;
@@ -240,7 +244,8 @@ message PromotionFeedItem {
optional string promotion_target = 16;
// Enum that modifies the qualification of the discount.
- google.ads.googleads.v10.enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier discount_modifier = 2;
+ google.ads.googleads.v13.enums.PromotionExtensionDiscountModifierEnum
+ .PromotionExtensionDiscountModifier discount_modifier = 2;
// Start date of when the promotion is eligible to be redeemed.
optional string promotion_start_date = 19;
@@ -251,7 +256,8 @@ message PromotionFeedItem {
// The occasion the promotion was intended for.
// If an occasion is set, the redemption window will need to fall within
// the date range associated with the occasion.
- google.ads.googleads.v10.enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion occasion = 9;
+ google.ads.googleads.v13.enums.PromotionExtensionOccasionEnum
+ .PromotionExtensionOccasion occasion = 9;
// A list of possible final URLs after all cross domain redirects.
// This field is required.
@@ -360,8 +366,6 @@ message ImageFeedItem {
// Required. Resource name of the image asset.
string image_asset = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/feed_common.proto b/third_party/googleapis/google/ads/googleads/v13/common/feed_common.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/common/feed_common.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/feed_common.proto
index 207364ded..361dad842 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/feed_common.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/feed_common.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "FeedCommonProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing common feed proto messages.
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/feed_item_set_filter_type_infos.proto b/third_party/googleapis/google/ads/googleads/v13/common/feed_item_set_filter_type_infos.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/common/feed_item_set_filter_type_infos.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/feed_item_set_filter_type_infos.proto
index 920694555..fc2cc8bd7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/feed_item_set_filter_type_infos.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/feed_item_set_filter_type_infos.proto
@@ -14,18 +14,18 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/feed_item_set_string_filter_type.proto";
+import "google/ads/googleads/v13/enums/feed_item_set_string_filter_type.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "FeedItemSetFilterTypeInfosProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Represents a filter on locations in a feed item set.
// Only applicable if the parent Feed of the FeedItemSet is a LOCATION feed.
@@ -44,7 +44,8 @@ message BusinessNameFilter {
string business_name = 1;
// The type of string matching to use when filtering with business_name.
- google.ads.googleads.v10.enums.FeedItemSetStringFilterTypeEnum.FeedItemSetStringFilterType filter_type = 2;
+ google.ads.googleads.v13.enums.FeedItemSetStringFilterTypeEnum
+ .FeedItemSetStringFilterType filter_type = 2;
}
// Represents a filter on affiliate locations in a FeedItemSet.
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/final_app_url.proto b/third_party/googleapis/google/ads/googleads/v13/common/final_app_url.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/common/final_app_url.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/final_app_url.proto
index e72d47684..0c78caa33 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/final_app_url.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/final_app_url.proto
@@ -14,25 +14,26 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/app_url_operating_system_type.proto";
+import "google/ads/googleads/v13/enums/app_url_operating_system_type.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "FinalAppUrlProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file FinalAppUrl type.
// A URL for deep linking into an app for the given operating system.
message FinalAppUrl {
// The operating system targeted by this URL. Required.
- google.ads.googleads.v10.enums.AppUrlOperatingSystemTypeEnum.AppUrlOperatingSystemType os_type = 1;
+ google.ads.googleads.v13.enums.AppUrlOperatingSystemTypeEnum
+ .AppUrlOperatingSystemType os_type = 1;
// The app deep link URL. Deep links specify a location in an app that
// corresponds to the content you'd like to show, and should be of the form
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/frequency_cap.proto b/third_party/googleapis/google/ads/googleads/v13/common/frequency_cap.proto
similarity index 57%
rename from third_party/googleapis/google/ads/googleads/v10/common/frequency_cap.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/frequency_cap.proto
index 7f75aadb5..7ad339eaf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/frequency_cap.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/frequency_cap.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/frequency_cap_event_type.proto";
-import "google/ads/googleads/v10/enums/frequency_cap_level.proto";
-import "google/ads/googleads/v10/enums/frequency_cap_time_unit.proto";
+import "google/ads/googleads/v13/enums/frequency_cap_event_type.proto";
+import "google/ads/googleads/v13/enums/frequency_cap_level.proto";
+import "google/ads/googleads/v13/enums/frequency_cap_time_unit.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "FrequencyCapProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing frequency caps.
@@ -45,15 +45,18 @@ message FrequencyCapEntry {
// A group of fields used as keys for a frequency cap.
// There can be no more than one frequency cap with the same key.
message FrequencyCapKey {
- // The level on which the cap is to be applied (e.g. ad group ad, ad group).
- // The cap is applied to all the entities of this level.
- google.ads.googleads.v10.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
-
- // The type of event that the cap applies to (e.g. impression).
- google.ads.googleads.v10.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
-
- // Unit of time the cap is defined at (e.g. day, week).
- google.ads.googleads.v10.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
+ // The level on which the cap is to be applied (for example, ad group ad, ad
+ // group). The cap is applied to all the entities of this level.
+ google.ads.googleads.v13.enums.FrequencyCapLevelEnum.FrequencyCapLevel level =
+ 1;
+
+ // The type of event that the cap applies to (for example, impression).
+ google.ads.googleads.v13.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType
+ event_type = 3;
+
+ // Unit of time the cap is defined at (for example, day, week).
+ google.ads.googleads.v13.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit
+ time_unit = 2;
// Number of time units the cap lasts.
optional int32 time_length = 5;
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/keyword_plan_common.proto b/third_party/googleapis/google/ads/googleads/v13/common/keyword_plan_common.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/common/keyword_plan_common.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/keyword_plan_common.proto
index 0f4fd175e..eb85a499d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/keyword_plan_common.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/keyword_plan_common.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/common/dates.proto";
-import "google/ads/googleads/v10/enums/device.proto";
-import "google/ads/googleads/v10/enums/keyword_plan_aggregate_metric_type.proto";
-import "google/ads/googleads/v10/enums/keyword_plan_competition_level.proto";
-import "google/ads/googleads/v10/enums/keyword_plan_concept_group_type.proto";
-import "google/ads/googleads/v10/enums/month_of_year.proto";
+import "google/ads/googleads/v13/common/dates.proto";
+import "google/ads/googleads/v13/enums/device.proto";
+import "google/ads/googleads/v13/enums/keyword_plan_aggregate_metric_type.proto";
+import "google/ads/googleads/v13/enums/keyword_plan_competition_level.proto";
+import "google/ads/googleads/v13/enums/keyword_plan_concept_group_type.proto";
+import "google/ads/googleads/v13/enums/month_of_year.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanCommonProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing Keyword Planner messages.
@@ -47,7 +47,8 @@ message KeywordPlanHistoricalMetrics {
repeated MonthlySearchVolume monthly_search_volumes = 6;
// The competition level for the query.
- google.ads.googleads.v10.enums.KeywordPlanCompetitionLevelEnum.KeywordPlanCompetitionLevel competition = 2;
+ google.ads.googleads.v13.enums.KeywordPlanCompetitionLevelEnum
+ .KeywordPlanCompetitionLevel competition = 2;
// The competition index for the query in the range [0, 100].
// Shows how competitive ad placement is for a keyword.
@@ -85,11 +86,11 @@ message HistoricalMetricsOptions {
// Monthly search volume.
message MonthlySearchVolume {
- // The year of the search volume (e.g. 2020).
+ // The year of the search volume (for example, 2020).
optional int64 year = 4;
// The month of the search volume.
- google.ads.googleads.v10.enums.MonthOfYearEnum.MonthOfYear month = 2;
+ google.ads.googleads.v13.enums.MonthOfYearEnum.MonthOfYear month = 2;
// Approximate number of searches for the month.
// A null value indicates the search volume is unavailable for
@@ -100,7 +101,8 @@ message MonthlySearchVolume {
// The aggregate metrics specification of the request.
message KeywordPlanAggregateMetrics {
// The list of aggregate metrics to fetch data.
- repeated google.ads.googleads.v10.enums.KeywordPlanAggregateMetricTypeEnum.KeywordPlanAggregateMetricType aggregate_metric_types = 1;
+ repeated google.ads.googleads.v13.enums.KeywordPlanAggregateMetricTypeEnum
+ .KeywordPlanAggregateMetricType aggregate_metric_types = 1;
}
// The aggregated historical metrics for keyword plan keywords.
@@ -117,7 +119,7 @@ message KeywordPlanAggregateMetricResults {
// The total searches for the device type during the specified time period.
message KeywordPlanDeviceSearches {
// The device type.
- google.ads.googleads.v10.enums.DeviceEnum.Device device = 1;
+ google.ads.googleads.v13.enums.DeviceEnum.Device device = 1;
// The total searches for the device.
optional int64 search_count = 2;
@@ -144,5 +146,6 @@ message ConceptGroup {
string name = 1;
// The concept group type.
- google.ads.googleads.v10.enums.KeywordPlanConceptGroupTypeEnum.KeywordPlanConceptGroupType type = 2;
+ google.ads.googleads.v13.enums.KeywordPlanConceptGroupTypeEnum
+ .KeywordPlanConceptGroupType type = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/matching_function.proto b/third_party/googleapis/google/ads/googleads/v13/common/matching_function.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/common/matching_function.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/matching_function.proto
index 92c296e54..481b37096 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/matching_function.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/matching_function.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/matching_function_context_type.proto";
-import "google/ads/googleads/v10/enums/matching_function_operator.proto";
+import "google/ads/googleads/v13/enums/matching_function_context_type.proto";
+import "google/ads/googleads/v13/enums/matching_function_operator.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "MatchingFunctionProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing a matching function.
@@ -45,7 +45,7 @@ message MatchingFunction {
// 5. AND(IN(FEED_ITEM_ID,{10001,10002}),EQUALS(CONTEXT.DEVICE,"Mobile"))
//
// For more details, visit
- // https://developers.google.com/adwords/api/docs/guides/feed-matching-functions
+ // https://developers.google.com/google-ads/api/docs/extensions/feeds/matching-functions
//
// Note that because multiple strings may represent the same underlying
// function (whitespace and single versus double quotation marks, for
@@ -54,7 +54,9 @@ message MatchingFunction {
optional string function_string = 5;
// Operator for a function.
- google.ads.googleads.v10.enums.MatchingFunctionOperatorEnum.MatchingFunctionOperator operator = 4;
+ google.ads.googleads.v13.enums.MatchingFunctionOperatorEnum
+ .MatchingFunctionOperator
+ operator = 4;
// The operands on the left hand side of the equation. This is also the
// operand to be used for single operand expressions such as NOT.
@@ -104,7 +106,8 @@ message Operand {
// An operand in a function referring to a value in the request context.
message RequestContextOperand {
// Type of value to be referred in the request context.
- google.ads.googleads.v10.enums.MatchingFunctionContextTypeEnum.MatchingFunctionContextType context_type = 1;
+ google.ads.googleads.v13.enums.MatchingFunctionContextTypeEnum
+ .MatchingFunctionContextType context_type = 1;
}
// Different operands that can be used in a matching function. Required.
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/metric_goal.proto b/third_party/googleapis/google/ads/googleads/v13/common/metric_goal.proto
similarity index 63%
rename from third_party/googleapis/google/ads/googleads/v10/common/metric_goal.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/metric_goal.proto
index cb63aa634..20aecc783 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/metric_goal.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/metric_goal.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/experiment_metric.proto";
-import "google/ads/googleads/v10/enums/experiment_metric_direction.proto";
+import "google/ads/googleads/v13/enums/experiment_metric.proto";
+import "google/ads/googleads/v13/enums/experiment_metric_direction.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "MetricGoalProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing experiment metric goal.
@@ -34,9 +34,11 @@ option ruby_package = "Google::Ads::GoogleAds::V10::Common";
message MetricGoal {
// The metric of the goal. For example, clicks, impressions, cost,
// conversions, etc.
- google.ads.googleads.v10.enums.ExperimentMetricEnum.ExperimentMetric metric = 1;
+ google.ads.googleads.v13.enums.ExperimentMetricEnum.ExperimentMetric metric =
+ 1;
// The metric direction of the goal. For example, increase, decrease, no
// change.
- google.ads.googleads.v10.enums.ExperimentMetricDirectionEnum.ExperimentMetricDirection direction = 2;
+ google.ads.googleads.v13.enums.ExperimentMetricDirectionEnum
+ .ExperimentMetricDirection direction = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/metrics.proto b/third_party/googleapis/google/ads/googleads/v13/common/metrics.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/common/metrics.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/metrics.proto
index 2a4f6b08f..fe1906cb3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/metrics.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/metrics.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/interaction_event_type.proto";
-import "google/ads/googleads/v10/enums/quality_score_bucket.proto";
+import "google/ads/googleads/v13/enums/interaction_event_type.proto";
+import "google/ads/googleads/v13/enums/quality_score_bucket.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "MetricsProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing metrics.
@@ -40,7 +40,8 @@ message Metrics {
optional double active_view_cpm = 184;
// Active view measurable clicks divided by active view viewable impressions.
- // This metric is reported only for display network.
+ //
+ // This metric is reported only for the Display Network.
optional double active_view_ctr = 185;
// A measurement of how often your ad has become viewable on a Display
@@ -94,11 +95,13 @@ message Metrics {
// The number of times people clicked the "Call" button to call a store during
// or after clicking an ad. This number doesn't include whether or not calls
// were connected, or the duration of any calls.
+ //
// This metric applies to feed items only.
optional double all_conversions_from_click_to_call = 195;
// The number of times people clicked a "Get directions" button to navigate to
// a store after clicking an ad.
+ //
// This metric applies to feed items only.
optional double all_conversions_from_directions = 196;
@@ -108,27 +111,81 @@ message Metrics {
// The number of times people clicked a link to view a store's menu after
// clicking an ad.
+ //
// This metric applies to feed items only.
optional double all_conversions_from_menu = 198;
// The number of times people placed an order at a store after clicking an ad.
+ //
// This metric applies to feed items only.
optional double all_conversions_from_order = 199;
// The number of other conversions (for example, posting a review or saving a
// location for a store) that occurred after people clicked an ad.
+ //
// This metric applies to feed items only.
optional double all_conversions_from_other_engagement = 200;
// Estimated number of times people visited a store after clicking an ad.
+ //
// This metric applies to feed items only.
optional double all_conversions_from_store_visit = 201;
// The number of times that people were taken to a store's URL after clicking
// an ad.
+ //
// This metric applies to feed items only.
optional double all_conversions_from_store_website = 202;
+ // This metric is part of the Auction Insights report, and tells how often
+ // the ads of another participant showed as the very first ad above the
+ // organic search results.
+ // This percentage is computed only over the auctions that you appeared in
+ // the page.
+ //
+ // This metric is not publicly available.
+ optional double auction_insight_search_absolute_top_impression_percentage =
+ 258;
+
+ // This metric is part of the Auction Insights report, and tells the
+ // percentage of impressions that another participant obtained, over the total
+ // number of impressions that your ads were eligible for.
+ // Any value below 0.1 is reported as 0.0999.
+ //
+ // This metric is not publicly available.
+ optional double auction_insight_search_impression_share = 259;
+
+ // This metric is part of the Auction Insights report, and tells the
+ // percentage of impressions that your ads outranked (showed above)
+ // another participant in the auction, compared to the total number of
+ // impressions that your ads were eligible for.
+ // Any value below 0.1 is reported as 0.0999.
+ //
+ // This metric is not publicly available.
+ optional double auction_insight_search_outranking_share = 260;
+
+ // This metric is part of the Auction Insights report, and tells how often
+ // another participant's ad received an impression when your ad also received
+ // an impression.
+ //
+ // This metric is not publicly available.
+ optional double auction_insight_search_overlap_rate = 261;
+
+ // This metric is part of the Auction Insights report, and tells how often
+ // another participant's ad was shown in a higher position than yours, when
+ // both of your ads were shown at the same page.
+ //
+ // This metric is not publicly available.
+ optional double auction_insight_search_position_above_rate = 262;
+
+ // This metric is part of the Auction Insights report, and tells how often
+ // the ads of another participant showed above the organic search results.
+ // This percentage is computed only over the auctions that you appeared in
+ // the page.
+ //
+ // This metric is not publicly available.
+ optional double auction_insight_search_top_impression_percentage = 263;
+
// The average amount you pay per interaction. This amount is the total cost
// of your ads divided by the total number of interactions.
optional double average_cost = 203;
@@ -207,9 +264,9 @@ message Metrics {
// The last date/time a conversion tag for this conversion action successfully
// fired and was seen by Google Ads. This firing event may not have been the
- // result of an attributable conversion (e.g. because the tag was fired from a
- // browser that did not previously click an ad from an appropriate
- // advertiser). The date/time is in the customer's time zone.
+ // result of an attributable conversion (for example, because the tag was
+ // fired from a browser that did not previously click an ad from an
+ // appropriate advertiser). The date/time is in the customer's time zone.
optional string conversion_last_received_request_date_time = 161;
// The date of the most recent conversion for this conversion action. The date
@@ -314,14 +371,17 @@ message Metrics {
// include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions.
- optional double current_model_attributed_conversions_from_interactions_rate = 176;
+ optional double current_model_attributed_conversions_from_interactions_rate =
+ 176;
// The value of current model attributed conversions from interactions divided
// by the number of ad interactions. This only includes conversion actions
// which include_in_conversions_metric attribute is set to true. If you use
// conversion-based bidding, your bid strategies will optimize for these
// conversions.
- optional double current_model_attributed_conversions_from_interactions_value_per_interaction = 177;
+ optional double
+ current_model_attributed_conversions_from_interactions_value_per_interaction =
+ 177;
// The value of current model attributed conversions. This only includes
// conversion actions which include_in_conversions_metric attribute is set to
@@ -365,16 +425,19 @@ message Metrics {
optional int64 hotel_eligible_impressions = 215;
// The creative historical quality score.
- google.ads.googleads.v10.enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80;
+ google.ads.googleads.v13.enums.QualityScoreBucketEnum.QualityScoreBucket
+ historical_creative_quality_score = 80;
// The quality of historical landing page experience.
- google.ads.googleads.v10.enums.QualityScoreBucketEnum.QualityScoreBucket historical_landing_page_quality_score = 81;
+ google.ads.googleads.v13.enums.QualityScoreBucketEnum.QualityScoreBucket
+ historical_landing_page_quality_score = 81;
// The historical quality score.
optional int64 historical_quality_score = 216;
// The historical search predicted click through rate (CTR).
- google.ads.googleads.v10.enums.QualityScoreBucketEnum.QualityScoreBucket historical_search_predicted_ctr = 83;
+ google.ads.googleads.v13.enums.QualityScoreBucketEnum.QualityScoreBucket
+ historical_search_predicted_ctr = 83;
// The number of times the ad was forwarded to someone else as a message.
optional int64 gmail_forwards = 217;
@@ -388,6 +451,7 @@ message Metrics {
optional int64 gmail_secondary_clicks = 219;
// The number of times a store's location-based ad was shown.
+ //
// This metric applies to feed items only.
optional int64 impressions_from_store_reach = 220;
@@ -406,7 +470,8 @@ message Metrics {
optional int64 interactions = 223;
// The types of payable and free interactions.
- repeated google.ads.googleads.v10.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100;
+ repeated google.ads.googleads.v13.enums.InteractionEventTypeEnum
+ .InteractionEventType interaction_event_types = 100;
// The percentage of clicks filtered out of your total number of clicks
// (filtered + non-filtered clicks) during the reporting period.
@@ -623,10 +688,93 @@ message Metrics {
// The total number of view-through conversions.
// These happen when a customer sees an image or rich media ad, then later
- // completes a conversion on your site without interacting with (e.g.,
+ // completes a conversion on your site without interacting with (for example,
// clicking on) another ad.
optional int64 view_through_conversions = 155;
// The number of iOS Store Kit Ad Network conversions.
int64 sk_ad_network_conversions = 246;
+
+ // Clicks from properties not owned by the publisher for which the traffic
+ // the publisher has paid for or acquired through incentivized activity
+ int64 publisher_purchased_clicks = 264;
+
+ // Clicks from properties for which the traffic the publisher has not paid
+ // for or acquired through incentivized activity
+ int64 publisher_organic_clicks = 265;
+
+ // Clicks from traffic which is not identified as "Publisher Purchased" or
+ // "Publisher Organic"
+ int64 publisher_unknown_clicks = 266;
+
+ // Number of call button clicks on any location surface after a chargeable ad
+ // event (click or impression). This measure is coming from Asset based
+ // location.
+ optional double all_conversions_from_location_asset_click_to_call = 267;
+
+ // Number of driving directions clicks on any location surface after a
+ // chargeable ad event (click or impression). This measure is coming
+ // from Asset based location.
+ optional double all_conversions_from_location_asset_directions = 268;
+
+ // Number of menu link clicks on any location surface after a chargeable ad
+ // event (click or impression). This measure is coming from Asset based
+ // location.
+ optional double all_conversions_from_location_asset_menu = 269;
+
+ // Number of order clicks on any location surface after a chargeable ad event
+ // (click or impression). This measure is coming from Asset based
+ // location.
+ optional double all_conversions_from_location_asset_order = 270;
+
+ // Number of other types of local action clicks on any location surface after
+ // a chargeable ad event (click or impression). This measure is coming
+ // from Asset based location.
+ optional double all_conversions_from_location_asset_other_engagement = 271;
+
+ // Estimated number of visits to the store after a chargeable
+ // ad event (click or impression). This measure is coming from Asset
+ // based location.
+ optional double all_conversions_from_location_asset_store_visits = 272;
+
+ // Number of website URL clicks on any location surface after a chargeable ad
+ // event (click or impression). This measure is coming from Asset based
+ // location.
+ optional double all_conversions_from_location_asset_website = 273;
+
+ // Number of impressions in which the store location was shown or the location
+ // was used for targeting. This measure is coming from Asset based
+ // location.
+ optional int64 eligible_impressions_from_location_asset_store_reach = 274;
+
+ // Number of call button clicks on any location surface after an impression.
+ // This measure is coming from Asset based location.
+ optional double view_through_conversions_from_location_asset_click_to_call =
+ 275;
+
+ // Number of driving directions clicks on any location surface after an
+ // impression. This measure is coming from Asset based location.
+ optional double view_through_conversions_from_location_asset_directions = 276;
+
+ // Number of menu link clicks on any location surface after an impression.
+ // This measure is coming from Asset based location.
+ optional double view_through_conversions_from_location_asset_menu = 277;
+
+ // Number of order clicks on any location surface after an impression. This
+ // measure is coming from Asset based location.
+ optional double view_through_conversions_from_location_asset_order = 278;
+
+ // Number of other types of local action clicks on any location surface after
+ // an impression. This measure is coming from Asset based location.
+ optional double
+ view_through_conversions_from_location_asset_other_engagement = 279;
+
+ // Estimated number of visits to the store after an impression.
+ // This measure is coming from Asset based location.
+ optional double view_through_conversions_from_location_asset_store_visits =
+ 280;
+
+ // Number of website URL clicks on any location surface after an impression.
+ // This measure is coming from Asset based location.
+ optional double view_through_conversions_from_location_asset_website = 281;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/offline_user_data.proto b/third_party/googleapis/google/ads/googleads/v13/common/offline_user_data.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/common/offline_user_data.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/offline_user_data.proto
index 6d5fe9c4b..153e14901 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/offline_user_data.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/offline_user_data.proto
@@ -14,18 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/user_identifier_source.proto";
+import "google/ads/googleads/v13/enums/user_identifier_source.proto";
+import "google/api/field_behavior.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "OfflineUserDataProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing offline user data.
@@ -64,7 +65,8 @@ message OfflineUserAddressInfo {
message UserIdentifier {
// Source of the user identifier when the upload is from Store Sales,
// ConversionUploadService, or ConversionAdjustmentUploadService.
- google.ads.googleads.v10.enums.UserIdentifierSourceEnum.UserIdentifierSource user_identifier_source = 6;
+ google.ads.googleads.v13.enums.UserIdentifierSourceEnum.UserIdentifierSource
+ user_identifier_source = 6;
// Exactly one must be specified. For OfflineUserDataJobService, Customer
// Match accepts hashed_email, hashed_phone_number, mobile_id,
@@ -215,6 +217,46 @@ message UserAttribute {
// users with a better experience. Accessible only to merchants on the
// allow-list with the user's consent.
optional ShoppingLoyalty shopping_loyalty = 7;
+
+ // Optional. Advertiser defined lifecycle stage for the user. The accepted
+ // values are "Lead", "Active" and "Churned".
+ string lifecycle_stage = 8 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Timestamp of the first purchase made by the user.
+ // The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
+ // optional timezone offset from UTC. If the offset is absent, the API will
+ // use the account's timezone as default.
+ string first_purchase_date_time = 9 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Advertiser defined events and their attributes. All the values in
+ // the nested fields are required. Currently this field is in beta.
+ repeated EventAttribute event_attribute = 10
+ [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Advertiser defined events and their attributes. All the values in the
+// nested fields are required.
+message EventAttribute {
+ // Required. Advertiser defined event to be used for remarketing. The accepted
+ // values are "Viewed", "Cart", "Purchased" and "Recommended".
+ string event = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Timestamp at which the event happened.
+ // The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
+ // optional timezone offset from UTC. If the offset is absent, the API will
+ // use the account's timezone as default.
+ string event_date_time = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Item attributes of the event.
+ repeated EventItemAttribute item_attribute = 3
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Event Item attributes of the Customer Match.
+message EventItemAttribute {
+ // Optional. A unique identifier of a product. It can be either the Merchant
+ // Center Item ID or GTIN (Global Trade Item Number).
+ string item_id = 1 [(google.api.field_behavior) = OPTIONAL];
}
// The shopping loyalty related data. Shopping utilizes this data to provide
@@ -236,10 +278,9 @@ message CustomerMatchUserListMetadata {
// Metadata for Store Sales Direct.
message StoreSalesMetadata {
- // This is the fraction of all transactions that are identifiable (i.e.,
- // associated with any form of customer information).
- // Required.
- // The fraction needs to be between 0 and 1 (excluding 0).
+ // This is the fraction of all transactions that are identifiable (for
+ // example, associated with any form of customer information). Required. The
+ // fraction needs to be between 0 and 1 (excluding 0).
optional double loyalty_fraction = 5;
// This is the ratio of sales being uploaded compared to the overall sales
@@ -260,7 +301,7 @@ message StoreSalesMetadata {
}
// Metadata for a third party Store Sales.
-// This product is only for customers on the allow-list. Please contact your
+// This product is only for customers on the allow-list. Contact your
// Google business development representative for details on the upload
// configuration.
message StoreSalesThirdPartyMetadata {
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/policy.proto b/third_party/googleapis/google/ads/googleads/v13/common/policy.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/common/policy.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/policy.proto
index 193a25152..740ad72f0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/policy.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/policy.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/policy_topic_entry_type.proto";
-import "google/ads/googleads/v10/enums/policy_topic_evidence_destination_mismatch_url_type.proto";
-import "google/ads/googleads/v10/enums/policy_topic_evidence_destination_not_working_device.proto";
-import "google/ads/googleads/v10/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto";
+import "google/ads/googleads/v13/enums/policy_topic_entry_type.proto";
+import "google/ads/googleads/v13/enums/policy_topic_evidence_destination_mismatch_url_type.proto";
+import "google/ads/googleads/v13/enums/policy_topic_evidence_destination_not_working_device.proto";
+import "google/ads/googleads/v13/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "PolicyProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing policy information.
@@ -40,7 +40,7 @@ message PolicyViolationKey {
// The text that violates the policy if specified.
// Otherwise, refers to the policy in general
- // (e.g., when requesting to be exempt from the whole policy).
+ // (for example, when requesting to be exempt from the whole policy).
// If not specified for criterion exemptions, the whole policy is implied.
// Must be specified for ad exemptions.
optional string violating_text = 4;
@@ -60,7 +60,7 @@ message PolicyValidationParameter {
// The list of policy violation keys that should not cause a
// PolicyViolationError to be reported. Not all policy violations are
- // exemptable, please refer to the is_exemptible field in the returned
+ // exemptable, refer to the is_exemptible field in the returned
// PolicyViolationError.
//
// Resources violating these polices will be saved, but will not be eligible
@@ -70,8 +70,8 @@ message PolicyValidationParameter {
repeated PolicyViolationKey exempt_policy_violation_keys = 2;
}
-// Policy finding attached to a resource (e.g. alcohol policy associated with
-// a site that sells alcohol).
+// Policy finding attached to a resource (for example, alcohol policy associated
+// with a site that sells alcohol).
//
// Each PolicyTopicEntry has a topic that indicates the specific ads policy
// the entry is about and a type to indicate the effect that the entry will have
@@ -86,14 +86,15 @@ message PolicyTopicEntry {
optional string topic = 5;
// Describes the negative or positive effect this policy will have on serving.
- google.ads.googleads.v10.enums.PolicyTopicEntryTypeEnum.PolicyTopicEntryType type = 2;
+ google.ads.googleads.v13.enums.PolicyTopicEntryTypeEnum.PolicyTopicEntryType
+ type = 2;
// Additional information that explains policy finding
- // (e.g. the brand name for a trademark finding).
+ // (for example, the brand name for a trademark finding).
repeated PolicyTopicEvidence evidences = 3;
- // Indicates how serving of this resource may be affected (e.g. not serving
- // in a country).
+ // Indicates how serving of this resource may be affected (for example, not
+ // serving in a country).
repeated PolicyTopicConstraint constraints = 4;
}
@@ -124,7 +125,9 @@ message PolicyTopicEvidence {
// Evidence of mismatches between the URLs of a resource.
message DestinationMismatch {
// The set of URLs that did not match each other.
- repeated google.ads.googleads.v10.enums.PolicyTopicEvidenceDestinationMismatchUrlTypeEnum.PolicyTopicEvidenceDestinationMismatchUrlType url_types = 1;
+ repeated google.ads.googleads.v13.enums
+ .PolicyTopicEvidenceDestinationMismatchUrlTypeEnum
+ .PolicyTopicEvidenceDestinationMismatchUrlType url_types = 1;
}
// Evidence details when the destination is returning an HTTP error
@@ -134,7 +137,9 @@ message PolicyTopicEvidence {
optional string expanded_url = 7;
// The type of device that failed to load the URL.
- google.ads.googleads.v10.enums.PolicyTopicEvidenceDestinationNotWorkingDeviceEnum.PolicyTopicEvidenceDestinationNotWorkingDevice device = 4;
+ google.ads.googleads.v13.enums
+ .PolicyTopicEvidenceDestinationNotWorkingDeviceEnum
+ .PolicyTopicEvidenceDestinationNotWorkingDevice device = 4;
// The time the URL was last checked.
// The format is "YYYY-MM-DD HH:MM:SS".
@@ -144,7 +149,10 @@ message PolicyTopicEvidence {
// Indicates the reason of the DESTINATION_NOT_WORKING policy finding.
oneof reason {
// The type of DNS error.
- google.ads.googleads.v10.enums.PolicyTopicEvidenceDestinationNotWorkingDnsErrorTypeEnum.PolicyTopicEvidenceDestinationNotWorkingDnsErrorType dns_error_type = 1;
+ google.ads.googleads.v13.enums
+ .PolicyTopicEvidenceDestinationNotWorkingDnsErrorTypeEnum
+ .PolicyTopicEvidenceDestinationNotWorkingDnsErrorType dns_error_type =
+ 1;
// The HTTP error code.
int64 http_error_code = 6;
@@ -189,9 +197,7 @@ message PolicyTopicConstraint {
// Indicates that a policy topic was constrained due to disapproval of the
// website for reseller purposes.
- message ResellerConstraint {
-
- }
+ message ResellerConstraint {}
// Indicates that a resource's ability to serve in a particular country is
// constrained.
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/policy_summary.proto b/third_party/googleapis/google/ads/googleads/v13/common/policy_summary.proto
similarity index 62%
rename from third_party/googleapis/google/ads/googleads/v10/common/policy_summary.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/policy_summary.proto
index a496cac3c..5f0edc9c0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/policy_summary.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/policy_summary.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/common/policy.proto";
-import "google/ads/googleads/v10/enums/policy_approval_status.proto";
-import "google/ads/googleads/v10/enums/policy_review_status.proto";
+import "google/ads/googleads/v13/common/policy.proto";
+import "google/ads/googleads/v13/enums/policy_approval_status.proto";
+import "google/ads/googleads/v13/enums/policy_review_status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "PolicySummaryProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing policy summary.
@@ -37,9 +37,11 @@ message PolicySummary {
repeated PolicyTopicEntry policy_topic_entries = 1;
// Where in the review process the resource is.
- google.ads.googleads.v10.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2;
+ google.ads.googleads.v13.enums.PolicyReviewStatusEnum.PolicyReviewStatus
+ review_status = 2;
// The overall approval status, which is calculated based on
// the status of its individual policy topic entries.
- google.ads.googleads.v10.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3;
+ google.ads.googleads.v13.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus
+ approval_status = 3;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/real_time_bidding_setting.proto b/third_party/googleapis/google/ads/googleads/v13/common/real_time_bidding_setting.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/common/real_time_bidding_setting.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/real_time_bidding_setting.proto
index 7d4ce91a5..9c90f7edd 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/real_time_bidding_setting.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/real_time_bidding_setting.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "RealTimeBiddingSettingProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing RealTimeBiddingSetting
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/segments.proto b/third_party/googleapis/google/ads/googleads/v13/common/segments.proto
similarity index 57%
rename from third_party/googleapis/google/ads/googleads/v10/common/segments.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/segments.proto
index fc30c4eff..64a38f61f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/segments.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/segments.proto
@@ -14,101 +14,123 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
-
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/enums/ad_destination_type.proto";
-import "google/ads/googleads/v10/enums/ad_network_type.proto";
-import "google/ads/googleads/v10/enums/budget_campaign_association_status.proto";
-import "google/ads/googleads/v10/enums/click_type.proto";
-import "google/ads/googleads/v10/enums/conversion_action_category.proto";
-import "google/ads/googleads/v10/enums/conversion_attribution_event_type.proto";
-import "google/ads/googleads/v10/enums/conversion_lag_bucket.proto";
-import "google/ads/googleads/v10/enums/conversion_or_adjustment_lag_bucket.proto";
-import "google/ads/googleads/v10/enums/conversion_value_rule_primary_dimension.proto";
-import "google/ads/googleads/v10/enums/day_of_week.proto";
-import "google/ads/googleads/v10/enums/device.proto";
-import "google/ads/googleads/v10/enums/external_conversion_source.proto";
-import "google/ads/googleads/v10/enums/hotel_date_selection_type.proto";
-import "google/ads/googleads/v10/enums/hotel_price_bucket.proto";
-import "google/ads/googleads/v10/enums/hotel_rate_type.proto";
-import "google/ads/googleads/v10/enums/month_of_year.proto";
-import "google/ads/googleads/v10/enums/placeholder_type.proto";
-import "google/ads/googleads/v10/enums/product_channel.proto";
-import "google/ads/googleads/v10/enums/product_channel_exclusivity.proto";
-import "google/ads/googleads/v10/enums/product_condition.proto";
-import "google/ads/googleads/v10/enums/recommendation_type.proto";
-import "google/ads/googleads/v10/enums/search_engine_results_page_type.proto";
-import "google/ads/googleads/v10/enums/search_term_match_type.proto";
-import "google/ads/googleads/v10/enums/sk_ad_network_ad_event_type.proto";
-import "google/ads/googleads/v10/enums/sk_ad_network_attribution_credit.proto";
-import "google/ads/googleads/v10/enums/sk_ad_network_user_type.proto";
-import "google/ads/googleads/v10/enums/slot.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+package google.ads.googleads.v13.common;
+
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/enums/ad_destination_type.proto";
+import "google/ads/googleads/v13/enums/ad_network_type.proto";
+import "google/ads/googleads/v13/enums/budget_campaign_association_status.proto";
+import "google/ads/googleads/v13/enums/click_type.proto";
+import "google/ads/googleads/v13/enums/conversion_action_category.proto";
+import "google/ads/googleads/v13/enums/conversion_attribution_event_type.proto";
+import "google/ads/googleads/v13/enums/conversion_lag_bucket.proto";
+import "google/ads/googleads/v13/enums/conversion_or_adjustment_lag_bucket.proto";
+import "google/ads/googleads/v13/enums/conversion_value_rule_primary_dimension.proto";
+import "google/ads/googleads/v13/enums/day_of_week.proto";
+import "google/ads/googleads/v13/enums/device.proto";
+import "google/ads/googleads/v13/enums/external_conversion_source.proto";
+import "google/ads/googleads/v13/enums/hotel_date_selection_type.proto";
+import "google/ads/googleads/v13/enums/hotel_price_bucket.proto";
+import "google/ads/googleads/v13/enums/hotel_rate_type.proto";
+import "google/ads/googleads/v13/enums/month_of_year.proto";
+import "google/ads/googleads/v13/enums/placeholder_type.proto";
+import "google/ads/googleads/v13/enums/product_channel.proto";
+import "google/ads/googleads/v13/enums/product_channel_exclusivity.proto";
+import "google/ads/googleads/v13/enums/product_condition.proto";
+import "google/ads/googleads/v13/enums/recommendation_type.proto";
+import "google/ads/googleads/v13/enums/search_engine_results_page_type.proto";
+import "google/ads/googleads/v13/enums/search_term_match_type.proto";
+import "google/ads/googleads/v13/enums/sk_ad_network_ad_event_type.proto";
+import "google/ads/googleads/v13/enums/sk_ad_network_attribution_credit.proto";
+import "google/ads/googleads/v13/enums/sk_ad_network_user_type.proto";
+import "google/ads/googleads/v13/enums/slot.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "SegmentsProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing segment only fields.
// Segment only fields.
message Segments {
+ // Activity account ID.
+ optional int64 activity_account_id = 148;
+
+ // Activity rating.
+ optional int64 activity_rating = 149;
+
+ // Advertiser supplied activity ID.
+ optional string external_activity_id = 150;
+
// Ad Destination type.
- google.ads.googleads.v10.enums.AdDestinationTypeEnum.AdDestinationType ad_destination_type = 136;
+ google.ads.googleads.v13.enums.AdDestinationTypeEnum.AdDestinationType
+ ad_destination_type = 136;
// Ad network type.
- google.ads.googleads.v10.enums.AdNetworkTypeEnum.AdNetworkType ad_network_type = 3;
+ google.ads.googleads.v13.enums.AdNetworkTypeEnum.AdNetworkType
+ ad_network_type = 3;
+
+ // Domain (visible URL) of a participant in the Auction Insights report.
+ optional string auction_insight_domain = 145;
// Budget campaign association status.
BudgetCampaignAssociationStatus budget_campaign_association_status = 134;
// Click type.
- google.ads.googleads.v10.enums.ClickTypeEnum.ClickType click_type = 26;
+ google.ads.googleads.v13.enums.ClickTypeEnum.ClickType click_type = 26;
// Resource name of the conversion action.
- optional string conversion_action = 113;
+ optional string conversion_action = 113 [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/ConversionAction"
+ }];
// Conversion action category.
- google.ads.googleads.v10.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_category = 53;
+ google.ads.googleads.v13.enums.ConversionActionCategoryEnum
+ .ConversionActionCategory conversion_action_category = 53;
// Conversion action name.
optional string conversion_action_name = 114;
// This segments your conversion columns by the original conversion and
- // conversion value vs. the delta if conversions were adjusted. False row has
- // the data as originally stated; While true row has the delta between data
- // now and the data as originally stated. Summing the two together results
- // post-adjustment data.
+ // conversion value versus the delta if conversions were adjusted. False row
+ // has the data as originally stated; While true row has the delta between
+ // data now and the data as originally stated. Summing the two together
+ // results post-adjustment data.
optional bool conversion_adjustment = 115;
// Conversion attribution event type.
- google.ads.googleads.v10.enums.ConversionAttributionEventTypeEnum.ConversionAttributionEventType conversion_attribution_event_type = 2;
+ google.ads.googleads.v13.enums.ConversionAttributionEventTypeEnum
+ .ConversionAttributionEventType conversion_attribution_event_type = 2;
// An enum value representing the number of days between the impression and
// the conversion.
- google.ads.googleads.v10.enums.ConversionLagBucketEnum.ConversionLagBucket conversion_lag_bucket = 50;
+ google.ads.googleads.v13.enums.ConversionLagBucketEnum.ConversionLagBucket
+ conversion_lag_bucket = 50;
// An enum value representing the number of days between the impression and
// the conversion or between the impression and adjustments to the conversion.
- google.ads.googleads.v10.enums.ConversionOrAdjustmentLagBucketEnum.ConversionOrAdjustmentLagBucket conversion_or_adjustment_lag_bucket = 51;
+ google.ads.googleads.v13.enums.ConversionOrAdjustmentLagBucketEnum
+ .ConversionOrAdjustmentLagBucket conversion_or_adjustment_lag_bucket = 51;
// Date to which metrics apply.
- // yyyy-MM-dd format, e.g., 2018-04-17.
+ // yyyy-MM-dd format, for example, 2018-04-17.
optional string date = 79;
- // Day of the week, e.g., MONDAY.
- google.ads.googleads.v10.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5;
+ // Day of the week, for example, MONDAY.
+ google.ads.googleads.v13.enums.DayOfWeekEnum.DayOfWeek day_of_week = 5;
// Device to which metrics apply.
- google.ads.googleads.v10.enums.DeviceEnum.Device device = 1;
+ google.ads.googleads.v13.enums.DeviceEnum.Device device = 1;
// External conversion source.
- google.ads.googleads.v10.enums.ExternalConversionSourceEnum.ExternalConversionSource external_conversion_source = 55;
+ google.ads.googleads.v13.enums.ExternalConversionSourceEnum
+ .ExternalConversionSource external_conversion_source = 55;
// Resource name of the geo target constant that represents an airport.
optional string geo_target_airport = 116;
@@ -157,7 +179,8 @@ message Segments {
optional string hotel_check_in_date = 81;
// Hotel check-in day of week.
- google.ads.googleads.v10.enums.DayOfWeekEnum.DayOfWeek hotel_check_in_day_of_week = 9;
+ google.ads.googleads.v13.enums.DayOfWeekEnum.DayOfWeek
+ hotel_check_in_day_of_week = 9;
// Hotel city.
optional string hotel_city = 82;
@@ -169,7 +192,8 @@ message Segments {
optional string hotel_country = 84;
// Hotel date selection type.
- google.ads.googleads.v10.enums.HotelDateSelectionTypeEnum.HotelDateSelectionType hotel_date_selection_type = 13;
+ google.ads.googleads.v13.enums.HotelDateSelectionTypeEnum
+ .HotelDateSelectionType hotel_date_selection_type = 13;
// Hotel length of stay.
optional int32 hotel_length_of_stay = 85;
@@ -178,10 +202,12 @@ message Segments {
optional string hotel_rate_rule_id = 86;
// Hotel rate type.
- google.ads.googleads.v10.enums.HotelRateTypeEnum.HotelRateType hotel_rate_type = 74;
+ google.ads.googleads.v13.enums.HotelRateTypeEnum.HotelRateType
+ hotel_rate_type = 74;
// Hotel price bucket.
- google.ads.googleads.v10.enums.HotelPriceBucketEnum.HotelPriceBucket hotel_price_bucket = 78;
+ google.ads.googleads.v13.enums.HotelPriceBucketEnum.HotelPriceBucket
+ hotel_price_bucket = 78;
// Hotel state.
optional string hotel_state = 87;
@@ -201,14 +227,15 @@ message Segments {
// yyyy-MM-dd.
optional string month = 90;
- // Month of the year, e.g., January.
- google.ads.googleads.v10.enums.MonthOfYearEnum.MonthOfYear month_of_year = 18;
+ // Month of the year, for example, January.
+ google.ads.googleads.v13.enums.MonthOfYearEnum.MonthOfYear month_of_year = 18;
// Partner hotel ID.
optional string partner_hotel_id = 91;
// Placeholder type. This is only used with feed item metrics.
- google.ads.googleads.v10.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 20;
+ google.ads.googleads.v13.enums.PlaceholderTypeEnum.PlaceholderType
+ placeholder_type = 20;
// Aggregator ID of the product.
optional int64 product_aggregator_id = 132;
@@ -232,13 +259,16 @@ message Segments {
optional string product_brand = 97;
// Channel of the product.
- google.ads.googleads.v10.enums.ProductChannelEnum.ProductChannel product_channel = 30;
+ google.ads.googleads.v13.enums.ProductChannelEnum.ProductChannel
+ product_channel = 30;
// Channel exclusivity of the product.
- google.ads.googleads.v10.enums.ProductChannelExclusivityEnum.ProductChannelExclusivity product_channel_exclusivity = 31;
+ google.ads.googleads.v13.enums.ProductChannelExclusivityEnum
+ .ProductChannelExclusivity product_channel_exclusivity = 31;
// Condition of the product.
- google.ads.googleads.v10.enums.ProductConditionEnum.ProductCondition product_condition = 32;
+ google.ads.googleads.v13.enums.ProductConditionEnum.ProductCondition
+ product_condition = 32;
// Resource name of the geo target constant for the country of sale of the
// product.
@@ -259,6 +289,9 @@ message Segments {
// Custom attribute 4 of the product.
optional string product_custom_attribute4 = 103;
+ // Feed label of the product.
+ optional string product_feed_label = 147;
+
// Item ID of the product.
optional string product_item_id = 104;
@@ -290,21 +323,24 @@ message Segments {
optional string product_type_l5 = 112;
// Quarter as represented by the date of the first day of a quarter.
- // Uses the calendar year for quarters, e.g., the second quarter of 2018
- // starts on 2018-04-01. Formatted as yyyy-MM-dd.
+ // Uses the calendar year for quarters, for example, the second quarter of
+ // 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
optional string quarter = 128;
// Recommendation type.
- google.ads.googleads.v10.enums.RecommendationTypeEnum.RecommendationType recommendation_type = 140;
+ google.ads.googleads.v13.enums.RecommendationTypeEnum.RecommendationType
+ recommendation_type = 140;
// Type of the search engine results page.
- google.ads.googleads.v10.enums.SearchEngineResultsPageTypeEnum.SearchEngineResultsPageType search_engine_results_page_type = 70;
+ google.ads.googleads.v13.enums.SearchEngineResultsPageTypeEnum
+ .SearchEngineResultsPageType search_engine_results_page_type = 70;
// Match type of the keyword that triggered the ad, including variants.
- google.ads.googleads.v10.enums.SearchTermMatchTypeEnum.SearchTermMatchType search_term_match_type = 22;
+ google.ads.googleads.v13.enums.SearchTermMatchTypeEnum.SearchTermMatchType
+ search_term_match_type = 22;
// Position of the ad.
- google.ads.googleads.v10.enums.SlotEnum.Slot slot = 23;
+ google.ads.googleads.v13.enums.SlotEnum.Slot slot = 23;
// Primary dimension of applied conversion value rules.
// NO_RULE_APPLIED shows the total recorded value of conversions that
@@ -313,7 +349,9 @@ message Segments {
// has been applied.
// GEO_LOCATION, DEVICE, AUDIENCE show the net adjustment after value
// rules were applied.
- google.ads.googleads.v10.enums.ConversionValueRulePrimaryDimensionEnum.ConversionValueRulePrimaryDimension conversion_value_rule_primary_dimension = 138;
+ google.ads.googleads.v13.enums.ConversionValueRulePrimaryDimensionEnum
+ .ConversionValueRulePrimaryDimension
+ conversion_value_rule_primary_dimension = 138;
// Resource name of the ad group criterion that represents webpage criterion.
optional string webpage = 129;
@@ -326,32 +364,37 @@ message Segments {
optional int32 year = 131;
// iOS Store Kit Ad Network conversion value.
- // Null value means this segment is not applicable, e.g. non-iOS campaign.
+ // Null value means this segment is not applicable, for example, non-iOS
+ // campaign.
optional int64 sk_ad_network_conversion_value = 137;
// iOS Store Kit Ad Network user type.
- google.ads.googleads.v10.enums.SkAdNetworkUserTypeEnum.SkAdNetworkUserType sk_ad_network_user_type = 141;
+ google.ads.googleads.v13.enums.SkAdNetworkUserTypeEnum.SkAdNetworkUserType
+ sk_ad_network_user_type = 141;
// iOS Store Kit Ad Network ad event type.
- google.ads.googleads.v10.enums.SkAdNetworkAdEventTypeEnum.SkAdNetworkAdEventType sk_ad_network_ad_event_type = 142;
+ google.ads.googleads.v13.enums.SkAdNetworkAdEventTypeEnum
+ .SkAdNetworkAdEventType sk_ad_network_ad_event_type = 142;
// App where the ad that drove the iOS Store Kit Ad Network install was
- // shown. Null value means this segment is not applicable, e.g. non-iOS
- // campaign, or was not present in any postbacks sent by Apple.
+ // shown. Null value means this segment is not applicable, for example,
+ // non-iOS campaign, or was not present in any postbacks sent by Apple.
optional SkAdNetworkSourceApp sk_ad_network_source_app = 143;
// iOS Store Kit Ad Network attribution credit
- google.ads.googleads.v10.enums.SkAdNetworkAttributionCreditEnum.SkAdNetworkAttributionCredit sk_ad_network_attribution_credit = 144;
+ google.ads.googleads.v13.enums.SkAdNetworkAttributionCreditEnum
+ .SkAdNetworkAttributionCredit sk_ad_network_attribution_credit = 144;
// Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics.
// Indicates whether the interaction metrics occurred on the asset itself
// or a different asset or ad unit.
- // Interactions (e.g. clicks) are counted across all the parts of the served
- // ad (e.g. Ad itself and other components like Sitelinks) when they are
- // served together. When interaction_on_this_asset is true, it means the
- // interactions are on this specific asset and when interaction_on_this_asset
- // is false, it means the interactions is not on this specific asset but on
- // other parts of the served ad this asset is served with.
+ // Interactions (for example, clicks) are counted across all the parts of the
+ // served ad (for example, Ad itself and other components like Sitelinks) when
+ // they are served together. When interaction_on_this_asset is true, it means
+ // the interactions are on this specific asset and when
+ // interaction_on_this_asset is false, it means the interactions is not on
+ // this specific asset but on other parts of the served ad this asset is
+ // served with.
optional AssetInteractionTarget asset_interaction_target = 139;
}
@@ -370,7 +413,8 @@ message BudgetCampaignAssociationStatus {
optional string campaign = 1;
// Budget campaign association status.
- google.ads.googleads.v10.enums.BudgetCampaignAssociationStatusEnum.BudgetCampaignAssociationStatus status = 2;
+ google.ads.googleads.v13.enums.BudgetCampaignAssociationStatusEnum
+ .BudgetCampaignAssociationStatus status = 2;
}
// An AssetInteractionTarget segment.
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/simulation.proto b/third_party/googleapis/google/ads/googleads/v13/common/simulation.proto
similarity index 96%
rename from third_party/googleapis/google/ads/googleads/v10/common/simulation.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/simulation.proto
index fbb3f2590..9a1e3fb96 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/simulation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/simulation.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "SimulationProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing simulation points.
@@ -319,8 +319,8 @@ message BudgetSimulationPoint {
message TargetImpressionShareSimulationPoint {
// The simulated target impression share value (in micros) upon which
// projected metrics are based.
- // E.g. 10% impression share, which is equal to 0.1, is stored as 100_000.
- // This value is validated and will not exceed 1M (100%).
+ // For example, 10% impression share, which is equal to 0.1, is stored as
+ // 100_000. This value is validated and will not exceed 1M (100%).
int64 target_impression_share_micros = 1;
// Projected required daily cpc bid ceiling that the advertiser must set to
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/tag_snippet.proto b/third_party/googleapis/google/ads/googleads/v13/common/tag_snippet.proto
similarity index 68%
rename from third_party/googleapis/google/ads/googleads/v10/common/tag_snippet.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/tag_snippet.proto
index b8063f751..262c39ca3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/tag_snippet.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/tag_snippet.proto
@@ -14,30 +14,31 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/tracking_code_page_format.proto";
-import "google/ads/googleads/v10/enums/tracking_code_type.proto";
+import "google/ads/googleads/v13/enums/tracking_code_page_format.proto";
+import "google/ads/googleads/v13/enums/tracking_code_type.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "TagSnippetProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing TagSnippet
// The site tag and event snippet pair for a TrackingCodeType.
message TagSnippet {
// The type of the generated tag snippets for tracking conversions.
- google.ads.googleads.v10.enums.TrackingCodeTypeEnum.TrackingCodeType type = 1;
+ google.ads.googleads.v13.enums.TrackingCodeTypeEnum.TrackingCodeType type = 1;
// The format of the web page where the tracking tag and snippet will be
- // installed, e.g. HTML.
- google.ads.googleads.v10.enums.TrackingCodePageFormatEnum.TrackingCodePageFormat page_format = 2;
+ // installed, for example, HTML.
+ google.ads.googleads.v13.enums.TrackingCodePageFormatEnum
+ .TrackingCodePageFormat page_format = 2;
// The site tag that adds visitors to your basic remarketing lists and sets
// new cookies on your domain.
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/targeting_setting.proto b/third_party/googleapis/google/ads/googleads/v13/common/targeting_setting.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/common/targeting_setting.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/targeting_setting.proto
index bd7dc471a..66ccc6ba5 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/targeting_setting.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/targeting_setting.proto
@@ -14,18 +14,18 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-import "google/ads/googleads/v10/enums/targeting_dimension.proto";
+import "google/ads/googleads/v13/enums/targeting_dimension.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "TargetingSettingProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing TargetingSetting
@@ -47,7 +47,8 @@ message TargetingSetting {
// The list of per-targeting-dimension targeting settings.
message TargetRestriction {
// The targeting dimension that these settings apply to.
- google.ads.googleads.v10.enums.TargetingDimensionEnum.TargetingDimension targeting_dimension = 1;
+ google.ads.googleads.v13.enums.TargetingDimensionEnum.TargetingDimension
+ targeting_dimension = 1;
// Indicates whether to restrict your ads to show only for the criteria you
// have selected for this targeting_dimension, or to target all values for
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/text_label.proto b/third_party/googleapis/google/ads/googleads/v13/common/text_label.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/common/text_label.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/text_label.proto
index bea75462c..4ba07787b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/text_label.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/text_label.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "TextLabelProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// A type of label displaying text on a colored background.
message TextLabel {
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/url_collection.proto b/third_party/googleapis/google/ads/googleads/v13/common/url_collection.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/common/url_collection.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/url_collection.proto
index 37c8feeea..2c75098fa 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/url_collection.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/url_collection.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "UrlCollectionProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file UrlCollection type.
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/user_lists.proto b/third_party/googleapis/google/ads/googleads/v13/common/user_lists.proto
similarity index 59%
rename from third_party/googleapis/google/ads/googleads/v10/common/user_lists.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/user_lists.proto
index 56db4cf3b..57fbcdba7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/user_lists.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/user_lists.proto
@@ -14,26 +14,26 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
-
-import "google/ads/googleads/v10/enums/customer_match_upload_key_type.proto";
-import "google/ads/googleads/v10/enums/user_list_combined_rule_operator.proto";
-import "google/ads/googleads/v10/enums/user_list_crm_data_source_type.proto";
-import "google/ads/googleads/v10/enums/user_list_date_rule_item_operator.proto";
-import "google/ads/googleads/v10/enums/user_list_logical_rule_operator.proto";
-import "google/ads/googleads/v10/enums/user_list_number_rule_item_operator.proto";
-import "google/ads/googleads/v10/enums/user_list_prepopulation_status.proto";
-import "google/ads/googleads/v10/enums/user_list_rule_type.proto";
-import "google/ads/googleads/v10/enums/user_list_string_rule_item_operator.proto";
-
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+package google.ads.googleads.v13.common;
+
+import "google/ads/googleads/v13/enums/customer_match_upload_key_type.proto";
+import "google/ads/googleads/v13/enums/user_list_crm_data_source_type.proto";
+import "google/ads/googleads/v13/enums/user_list_date_rule_item_operator.proto";
+import "google/ads/googleads/v13/enums/user_list_flexible_rule_operator.proto";
+import "google/ads/googleads/v13/enums/user_list_logical_rule_operator.proto";
+import "google/ads/googleads/v13/enums/user_list_number_rule_item_operator.proto";
+import "google/ads/googleads/v13/enums/user_list_prepopulation_status.proto";
+import "google/ads/googleads/v13/enums/user_list_rule_type.proto";
+import "google/ads/googleads/v13/enums/user_list_string_rule_item_operator.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "UserListsProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing user list types.
@@ -49,10 +49,10 @@ message CrmBasedUserListInfo {
// A string that uniquely identifies a mobile application from which the data
// was collected.
// For iOS, the ID string is the 9 digit string that appears at the end of an
- // App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is
- // http://itunes.apple.com/us/app/flood-it!-2/id476943146).
- // For Android, the ID string is the application's package name
- // (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link
+ // App Store URL (for example, "476943146" for "Flood-It! 2" whose App Store
+ // link is http://itunes.apple.com/us/app/flood-it!-2/id476943146). For
+ // Android, the ID string is the application's package name (for example,
+ // "com.labpixies.colordrips" for "Color Drips" given Google Play link
// https://play.google.com/store/apps/details?id=com.labpixies.colordrips).
// Required when creating CrmBasedUserList for uploading mobile advertising
// IDs.
@@ -61,11 +61,13 @@ message CrmBasedUserListInfo {
// Matching key type of the list.
// Mixed data types are not allowed on the same list.
// This field is required for an ADD operation.
- google.ads.googleads.v10.enums.CustomerMatchUploadKeyTypeEnum.CustomerMatchUploadKeyType upload_key_type = 2;
+ google.ads.googleads.v13.enums.CustomerMatchUploadKeyTypeEnum
+ .CustomerMatchUploadKeyType upload_key_type = 2;
// Data source of the list. Default value is FIRST_PARTY.
// Only customers on the allow-list can create third-party sourced CRM lists.
- google.ads.googleads.v10.enums.UserListCrmDataSourceTypeEnum.UserListCrmDataSourceType data_source_type = 3;
+ google.ads.googleads.v13.enums.UserListCrmDataSourceTypeEnum
+ .UserListCrmDataSourceType data_source_type = 3;
}
// A client defined rule based on custom parameters sent by web sites or
@@ -77,9 +79,9 @@ message UserListRuleInfo {
// That is, rule items will be ANDed together within rule item groups and the
// groups themselves will be ORed together.
//
- // Currently AND of ORs (conjunctive normal form) is only supported for
- // ExpressionRuleUserList.
- google.ads.googleads.v10.enums.UserListRuleTypeEnum.UserListRuleType rule_type = 1;
+ // OR of ANDs is the only supported type for FlexibleRuleUserList.
+ google.ads.googleads.v13.enums.UserListRuleTypeEnum.UserListRuleType
+ rule_type = 1;
// List of rule item groups that defines this rule.
// Rule item groups are grouped together based on rule_type.
@@ -122,7 +124,9 @@ message UserListDateRuleItemInfo {
// Date comparison operator.
// This field is required and must be populated when creating new date
// rule item.
- google.ads.googleads.v10.enums.UserListDateRuleItemOperatorEnum.UserListDateRuleItemOperator operator = 1;
+ google.ads.googleads.v13.enums.UserListDateRuleItemOperatorEnum
+ .UserListDateRuleItemOperator
+ operator = 1;
// String representing date value to be compared with the rule variable.
// Supported date format is YYYY-MM-DD.
@@ -140,7 +144,9 @@ message UserListNumberRuleItemInfo {
// Number comparison operator.
// This field is required and must be populated when creating a new number
// rule item.
- google.ads.googleads.v10.enums.UserListNumberRuleItemOperatorEnum.UserListNumberRuleItemOperator operator = 1;
+ google.ads.googleads.v13.enums.UserListNumberRuleItemOperatorEnum
+ .UserListNumberRuleItemOperator
+ operator = 1;
// Number value to be compared with the variable.
// This field is required and must be populated when creating a new number
@@ -153,7 +159,9 @@ message UserListStringRuleItemInfo {
// String comparison operator.
// This field is required and must be populated when creating a new string
// rule item.
- google.ads.googleads.v10.enums.UserListStringRuleItemOperatorEnum.UserListStringRuleItemOperator operator = 1;
+ google.ads.googleads.v13.enums.UserListStringRuleItemOperatorEnum
+ .UserListStringRuleItemOperator
+ operator = 1;
// The right hand side of the string rule item. For URLs or referrer URLs,
// the value can not contain illegal URL chars such as newlines, quotes,
@@ -162,55 +170,37 @@ message UserListStringRuleItemInfo {
optional string value = 3;
}
-// User lists defined by combining two rules, left operand and right operand.
-// There are two operators: AND where left operand and right operand have to be
-// true; AND_NOT where left operand is true but right operand is false.
-message CombinedRuleUserListInfo {
- // Left operand of the combined rule.
- // This field is required and must be populated when creating new combined
- // rule based user list.
- UserListRuleInfo left_operand = 1;
-
- // Right operand of the combined rule.
- // This field is required and must be populated when creating new combined
- // rule based user list.
- UserListRuleInfo right_operand = 2;
-
- // Operator to connect the two operands.
- //
- // Required for creating a combined rule user list.
- google.ads.googleads.v10.enums.UserListCombinedRuleOperatorEnum.UserListCombinedRuleOperator rule_operator = 3;
-}
-
-// Visitors of a page during specific dates.
-message DateSpecificRuleUserListInfo {
- // Boolean rule that defines visitor of a page.
- //
- // Required for creating a date specific rule user list.
+// Flexible rule that wraps the common rule and a lookback window.
+message FlexibleRuleOperandInfo {
+ // List of rule item groups that defines this rule.
+ // Rule item groups are grouped together.
UserListRuleInfo rule = 1;
- // Start date of users visit. If set to 2000-01-01, then the list includes all
- // users before end_date. The date's format should be YYYY-MM-DD.
- //
- // Required for creating a data specific rule user list.
- optional string start_date = 4;
-
- // Last date of users visit. If set to 2037-12-30, then the list includes all
- // users after start_date. The date's format should be YYYY-MM-DD.
- //
- // Required for creating a data specific rule user list.
- optional string end_date = 5;
+ // Lookback window for this rule in days. From now until X days ago.
+ optional int64 lookback_window_days = 2;
}
-// Visitors of a page. The page visit is defined by one boolean rule expression.
-message ExpressionRuleUserListInfo {
- // Boolean rule that defines this user list. The rule consists of a list of
- // rule item groups and each rule item group consists of a list of rule items.
- // All the rule item groups are ORed or ANDed together for evaluation based on
- // rule.rule_type.
- //
- // Required for creating an expression rule user list.
- UserListRuleInfo rule = 1;
+// Flexible rule representation of visitors with one or multiple actions. The
+// flexible user list is defined by two lists of operands – inclusive_operands
+// and exclusive_operands; each operand represents a set of users based on
+// actions they took in a given timeframe. These lists of operands are combined
+// with the AND_NOT operator, so that users represented by the inclusive
+// operands are included in the user list, minus the users represented by the
+// exclusive operands.
+message FlexibleRuleUserListInfo {
+ // Operator that defines how the inclusive operands are combined.
+ google.ads.googleads.v13.enums.UserListFlexibleRuleOperatorEnum
+ .UserListFlexibleRuleOperator inclusive_rule_operator = 1;
+
+ // Rules representing users that should be included in the user list. These
+ // are located on the left side of the AND_NOT operator, and joined together
+ // by either AND/OR as specified by the inclusive_rule_operator.
+ repeated FlexibleRuleOperandInfo inclusive_operands = 2;
+
+ // Rules representing users that should be excluded from the user list. These
+ // are located on the right side of the AND_NOT operator, and joined together
+ // by OR.
+ repeated FlexibleRuleOperandInfo exclusive_operands = 3;
}
// Representation of a userlist that is generated by a rule.
@@ -223,26 +213,17 @@ message RuleBasedUserListInfo {
// list's membership duration and the date when the remarketing tag is added.
// The status will be updated to FINISHED once request is processed, or FAILED
// if the request fails.
- google.ads.googleads.v10.enums.UserListPrepopulationStatusEnum.UserListPrepopulationStatus prepopulation_status = 1;
-
- // Subtypes of rule based user lists.
- oneof rule_based_user_list {
- // User lists defined by combining two rules.
- // There are two operators: AND, where the left and right operands have to
- // be true; AND_NOT where left operand is true but right operand is false.
- CombinedRuleUserListInfo combined_rule_user_list = 2;
-
- // Visitors of a page during specific dates. The visiting periods are
- // defined as follows:
- // Between start_date (inclusive) and end_date (inclusive);
- // Before end_date (exclusive) with start_date = 2000-01-01;
- // After start_date (exclusive) with end_date = 2037-12-30.
- DateSpecificRuleUserListInfo date_specific_rule_user_list = 3;
-
- // Visitors of a page. The page visit is defined by one boolean rule
- // expression.
- ExpressionRuleUserListInfo expression_rule_user_list = 4;
- }
+ google.ads.googleads.v13.enums.UserListPrepopulationStatusEnum
+ .UserListPrepopulationStatus prepopulation_status = 1;
+
+ // Flexible rule representation of visitors with one or multiple actions. The
+ // flexible user list is defined by two lists of operands – inclusive_operands
+ // and exclusive_operands; each operand represents a set of users based on
+ // actions they took in a given timeframe. These lists of operands are
+ // combined with the AND_NOT operator, so that users represented by the
+ // inclusive operands are included in the user list, minus the users
+ // represented by the exclusive operands.
+ FlexibleRuleUserListInfo flexible_rule_user_list = 5;
}
// Represents a user list that is a custom combination of user lists.
@@ -259,7 +240,9 @@ message LogicalUserListInfo {
// list of user lists as operands.
message UserListLogicalRuleInfo {
// The logical operator of the rule.
- google.ads.googleads.v10.enums.UserListLogicalRuleOperatorEnum.UserListLogicalRuleOperator operator = 1;
+ google.ads.googleads.v13.enums.UserListLogicalRuleOperatorEnum
+ .UserListLogicalRuleOperator
+ operator = 1;
// The list of operands of the rule.
repeated LogicalUserListOperandInfo rule_operands = 2;
diff --git a/third_party/googleapis/google/ads/googleads/v10/common/value.proto b/third_party/googleapis/google/ads/googleads/v13/common/value.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/common/value.proto
rename to third_party/googleapis/google/ads/googleads/v13/common/value.proto
index a141fc278..47a969383 100644
--- a/third_party/googleapis/google/ads/googleads/v10/common/value.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/common/value.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.common;
+package google.ads.googleads.v13.common;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Common";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/common;common";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Common";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/common;common";
option java_multiple_files = true;
option java_outer_classname = "ValueProto";
-option java_package = "com.google.ads.googleads.v10.common";
+option java_package = "com.google.ads.googleads.v13.common";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Common";
-option ruby_package = "Google::Ads::GoogleAds::V10::Common";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Common";
+option ruby_package = "Google::Ads::GoogleAds::V13::Common";
// Proto file describing value types.
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/BUILD.bazel b/third_party/googleapis/google/ads/googleads/v13/enums/BUILD.bazel
similarity index 100%
rename from third_party/googleapis/google/ads/googleads/v10/enums/BUILD.bazel
rename to third_party/googleapis/google/ads/googleads/v13/enums/BUILD.bazel
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/access_invitation_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/access_invitation_status.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/access_invitation_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/access_invitation_status.proto
index 65533f172..11805102a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/access_invitation_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/access_invitation_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccessInvitationStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing AccessInvitationStatus enum.
@@ -48,6 +48,4 @@ message AccessInvitationStatusEnum {
// created. Invitations expire 20 days after creation.
EXPIRED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/access_reason.proto b/third_party/googleapis/google/ads/googleads/v13/enums/access_reason.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/access_reason.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/access_reason.proto
index 6c1420d4f..82c714e01 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/access_reason.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/access_reason.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccessReasonProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Indicates the way the resource such as user list is related to a user.
message AccessReasonEnum {
@@ -50,6 +50,4 @@ message AccessReasonEnum {
// The resource is accessible to the user.
AFFILIATED = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/access_role.proto b/third_party/googleapis/google/ads/googleads/v13/enums/access_role.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/access_role.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/access_role.proto
index 9eefaa976..16dc7b1ab 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/access_role.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/access_role.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccessRoleProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing possible access role for user.
message AccessRoleEnum {
@@ -48,6 +48,4 @@ message AccessRoleEnum {
// a true User entity.
EMAIL_ONLY = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/account_budget_proposal_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/account_budget_proposal_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/account_budget_proposal_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/account_budget_proposal_status.proto
index e548db4b3..52ea0b31b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/account_budget_proposal_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/account_budget_proposal_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccountBudgetProposalStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing AccountBudgetProposal statuses.
@@ -52,10 +52,8 @@ message AccountBudgetProposalStatusEnum {
// The proposal has been cancelled by the user.
CANCELLED = 5;
- // The proposal has been rejected by the user, e.g. by rejecting an
+ // The proposal has been rejected by the user, for example, by rejecting an
// acceptance email.
REJECTED = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/account_budget_proposal_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/account_budget_proposal_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/account_budget_proposal_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/account_budget_proposal_type.proto
index acce98059..34d1d260e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/account_budget_proposal_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/account_budget_proposal_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccountBudgetProposalTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing AccountBudgetProposal types.
@@ -49,6 +49,4 @@ message AccountBudgetProposalTypeEnum {
// Identifies a request to remove a budget that hasn't started yet.
REMOVE = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/account_budget_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/account_budget_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/account_budget_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/account_budget_status.proto
index 81cc346bb..5b556ce2b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/account_budget_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/account_budget_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccountBudgetStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing AccountBudget statuses.
@@ -46,6 +46,4 @@ message AccountBudgetStatusEnum {
// The account budget has been cancelled by the user.
CANCELLED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/account_link_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/account_link_status.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/account_link_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/account_link_status.proto
index 78b8dc17b..aa9f28c3e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/account_link_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/account_link_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AccountLinkStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing possible statuses of an account link.
message AccountLinkStatusEnum {
@@ -56,6 +56,4 @@ message AccountLinkStatusEnum {
// The link is revoked by the user who requested the link.
REVOKED = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_customizer_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_customizer_placeholder_field.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_customizer_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_customizer_placeholder_field.proto
index 991565fe8..fb1c77197 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_customizer_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_customizer_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdCustomizerPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Ad Customizer placeholder fields.
@@ -49,6 +49,4 @@ message AdCustomizerPlaceholderFieldEnum {
// Data Type: STRING. String value to be inserted.
STRING = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_destination_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_destination_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_destination_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_destination_type.proto
index 3d30e9ecb..c1182164a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_destination_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_destination_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdDestinationTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing ad destination types.
@@ -70,6 +70,4 @@ message AdDestinationTypeEnum {
// Ad Destination for Conversions with keys unknown
UNMODELED_FOR_CONVERSIONS = 12;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_ad_rotation_mode.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_ad_rotation_mode.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_group_ad_rotation_mode.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_group_ad_rotation_mode.proto
index ed10c892f..bb703e2ab 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_ad_rotation_mode.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_ad_rotation_mode.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdRotationModeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing ad group ad rotation mode.
@@ -46,6 +46,4 @@ message AdGroupAdRotationModeEnum {
// Rotate evenly forever.
ROTATE_FOREVER = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_ad_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_ad_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_group_ad_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_group_ad_status.proto
index 32e496283..e27f7a178 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_ad_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_ad_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing ad group status.
@@ -48,6 +48,4 @@ message AdGroupAdStatusEnum {
// The ad group ad is removed.
REMOVED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_criterion_approval_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_criterion_approval_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_group_criterion_approval_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_group_criterion_approval_status.proto
index a93ce1f40..59497678b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_criterion_approval_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_criterion_approval_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionApprovalStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing approval status for the criterion.
@@ -49,6 +49,4 @@ message AdGroupCriterionApprovalStatusEnum {
// Under review.
UNDER_REVIEW = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_criterion_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_criterion_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_group_criterion_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_group_criterion_status.proto
index fff8f0048..48c657b0d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_criterion_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_criterion_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing AdGroupCriterion statuses.
@@ -48,6 +48,4 @@ message AdGroupCriterionStatusEnum {
// The ad group criterion is removed.
REMOVED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_group_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_group_status.proto
index 159a27f40..f4ca37dfe 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing ad group status.
@@ -48,6 +48,4 @@ message AdGroupStatusEnum {
// The ad group is removed.
REMOVED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_type.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_group_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_group_type.proto
index 1105e54b1..efd3cc123 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_group_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_group_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdGroupTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing ad group types.
@@ -88,7 +88,8 @@ message AdGroupTypeEnum {
// Ad group type for Smart campaigns.
SMART_CAMPAIGN_ADS = 18;
- }
-
+ // Ad group type for Travel campaigns.
+ TRAVEL_ADS = 19;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_network_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_network_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_network_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_network_type.proto
index 69d811916..754070ba9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_network_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_network_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdNetworkTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing ad network types.
@@ -55,6 +55,4 @@ message AdNetworkTypeEnum {
// Cross-network.
MIXED = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_serving_optimization_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_serving_optimization_status.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_serving_optimization_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_serving_optimization_status.proto
index b00eb9427..6bfd48362 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_serving_optimization_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_serving_optimization_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdServingOptimizationStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing ad serving statuses.
@@ -57,6 +57,4 @@ message AdServingOptimizationStatusEnum {
// Ad serving optimization status is not available.
UNAVAILABLE = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_strength.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_strength.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_strength.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_strength.proto
index ca879ebe0..128a4a788 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_strength.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_strength.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdStrengthProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing ad strengths.
@@ -55,6 +55,4 @@ message AdStrengthEnum {
// Excellent strength.
EXCELLENT = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/ad_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/ad_type.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/enums/ad_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/ad_type.proto
index 02c7b4296..4cecb3b33 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/ad_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/ad_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing the ad type.
@@ -60,9 +60,6 @@ message AdTypeEnum {
// The ad is a video ad.
VIDEO_AD = 12;
- // This ad is a Gmail ad.
- GMAIL_AD = 13;
-
// This ad is an Image ad.
IMAGE_AD = 14;
@@ -129,7 +126,8 @@ message AdTypeEnum {
// Discovery carousel ad.
DISCOVERY_CAROUSEL_AD = 36;
- }
-
+ // Travel ad.
+ TRAVEL_AD = 37;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/advertising_channel_sub_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/advertising_channel_sub_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/advertising_channel_sub_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/advertising_channel_sub_type.proto
index 5b4bac1a1..22ddcd0f3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/advertising_channel_sub_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/advertising_channel_sub_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdvertisingChannelSubTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing advertising channel subtypes.
@@ -55,7 +55,8 @@ message AdvertisingChannelSubTypeEnum {
// Gmail Ad campaigns.
DISPLAY_GMAIL_AD = 7;
- // Smart display campaigns.
+ // Smart display campaigns. New campaigns of this sub type cannot be
+ // created.
DISPLAY_SMART_CAMPAIGN = 8;
// Video Outstream campaigns.
@@ -67,7 +68,7 @@ message AdvertisingChannelSubTypeEnum {
// Video campaigns with non-skippable video ads.
VIDEO_NON_SKIPPABLE = 11;
- // App Campaign that allows you to easily promote your Android or iOS app
+ // App Campaign that lets you easily promote your Android or iOS app
// across Google's top properties including Search, Play, YouTube, and the
// Google Display Network.
APP_CAMPAIGN = 12;
@@ -94,7 +95,11 @@ message AdvertisingChannelSubTypeEnum {
// Google Play, YouTube and Display Network. See
// https://support.google.com/google-ads/answer/9441344 to learn more.
APP_CAMPAIGN_FOR_PRE_REGISTRATION = 18;
- }
+ // Video reach campaign with Target Frequency bidding strategy.
+ VIDEO_REACH_TARGET_FREQUENCY = 19;
+ // Travel Activities campaigns.
+ TRAVEL_ACTIVITIES = 20;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/advertising_channel_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/advertising_channel_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/advertising_channel_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/advertising_channel_type.proto
index b3ca13ba3..7b6e85b05 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/advertising_channel_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/advertising_channel_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AdvertisingChannelTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing advertising channel types
@@ -71,7 +71,8 @@ message AdvertisingChannelTypeEnum {
// Discovery campaigns.
DISCOVERY = 12;
- }
-
+ // Travel campaigns.
+ TRAVEL = 13;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/affiliate_location_feed_relationship_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/affiliate_location_feed_relationship_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/affiliate_location_feed_relationship_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/affiliate_location_feed_relationship_type.proto
index 770becea8..25e247db2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/affiliate_location_feed_relationship_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/affiliate_location_feed_relationship_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AffiliateLocationFeedRelationshipTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing relation type for affiliate location feeds.
@@ -41,6 +41,4 @@ message AffiliateLocationFeedRelationshipTypeEnum {
// General retailer relationship.
GENERAL_RETAILER = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/affiliate_location_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/affiliate_location_placeholder_field.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/enums/affiliate_location_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/affiliate_location_placeholder_field.proto
index 03219d507..7d304370b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/affiliate_location_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/affiliate_location_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AffiliateLocationPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Affiliate Location placeholder fields.
@@ -70,6 +70,4 @@ message AffiliateLocationPlaceholderFieldEnum {
// Data Type: STRING. Name of the chain.
CHAIN_NAME = 12;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/age_range_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/age_range_type.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/age_range_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/age_range_type.proto
index 5d1444b8d..58b3d492c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/age_range_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/age_range_type.proto
@@ -14,22 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AgeRangeTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing age range types.
// Container for enum describing the type of demographic age ranges.
message AgeRangeTypeEnum {
- // The type of demographic age ranges (e.g. between 18 and 24 years old).
+ // The type of demographic age ranges (for example, between 18 and 24 years
+ // old).
enum AgeRangeType {
// Not specified.
UNSPECIFIED = 0;
@@ -58,6 +59,4 @@ message AgeRangeTypeEnum {
// Undetermined age range.
AGE_RANGE_UNDETERMINED = 503999;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/app_campaign_app_store.proto b/third_party/googleapis/google/ads/googleads/v13/enums/app_campaign_app_store.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/app_campaign_app_store.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/app_campaign_app_store.proto
index 595ede591..a9c471a56 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/app_campaign_app_store.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/app_campaign_app_store.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppCampaignAppStoreProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing App Campaign app store.
@@ -43,6 +43,4 @@ message AppCampaignAppStoreEnum {
// Google play.
GOOGLE_APP_STORE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/app_campaign_bidding_strategy_goal_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/app_campaign_bidding_strategy_goal_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/app_campaign_bidding_strategy_goal_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/app_campaign_bidding_strategy_goal_type.proto
index b33287e8d..17d900ac5 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/app_campaign_bidding_strategy_goal_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/app_campaign_bidding_strategy_goal_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppCampaignBiddingStrategyGoalTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing App Campaign bidding strategy goal types.
@@ -52,9 +52,9 @@ message AppCampaignBiddingStrategyGoalTypeEnum {
// the long term conversions haven't happened yet.
OPTIMIZE_IN_APP_CONVERSIONS_TARGET_CONVERSION_COST = 4;
- // Aim to maximize all conversions' value, i.e. install + selected in-app
- // conversions while achieving or exceeding target return on advertising
- // spend.
+ // Aim to maximize all conversions' value, for example, install + selected
+ // in-app conversions while achieving or exceeding target return on
+ // advertising spend.
OPTIMIZE_RETURN_ON_ADVERTISING_SPEND = 5;
// Aim to maximize the pre-registration of the app.
@@ -63,6 +63,4 @@ message AppCampaignBiddingStrategyGoalTypeEnum {
// Aim to maximize installation of the app without target cost-per-install.
OPTIMIZE_INSTALLS_WITHOUT_TARGET_INSTALL_COST = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/app_payment_model_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/app_payment_model_type.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/app_payment_model_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/app_payment_model_type.proto
index 4e54fb83c..089bd5c9b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/app_payment_model_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/app_payment_model_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppPaymentModelTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing criteria types.
@@ -40,6 +40,4 @@ message AppPaymentModelTypeEnum {
// Represents paid-for apps.
PAID = 30;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/app_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/app_placeholder_field.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/enums/app_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/app_placeholder_field.proto
index e8dcd3d0d..f15926d84 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/app_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/app_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing App placeholder fields.
@@ -68,6 +68,4 @@ message AppPlaceholderFieldEnum {
// parallel tracking.
FINAL_URL_SUFFIX = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/app_store.proto b/third_party/googleapis/google/ads/googleads/v13/enums/app_store.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/app_store.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/app_store.proto
index 86fc35559..4a7077e04 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/app_store.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/app_store.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppStoreProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing app store types for an app extension.
@@ -43,6 +43,4 @@ message AppStoreEnum {
// Google Play.
GOOGLE_PLAY = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/app_url_operating_system_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/app_url_operating_system_type.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/app_url_operating_system_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/app_url_operating_system_type.proto
index cce44ae35..9245dcefe 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/app_url_operating_system_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/app_url_operating_system_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AppUrlOperatingSystemTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing operating system for a deeplink app URL.
@@ -43,6 +43,4 @@ message AppUrlOperatingSystemTypeEnum {
// The Android operating system.
ANDROID = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/asset_field_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_field_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/asset_field_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/asset_field_type.proto
index 602781401..bafa665ff 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/asset_field_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_field_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetFieldTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing asset type.
@@ -109,7 +109,15 @@ message AssetFieldTypeEnum {
// The asset is linked for use to select a call-to-action.
CALL_TO_ACTION_SELECTION = 25;
- }
+ // The asset is linked for use to select an ad image.
+ AD_IMAGE = 26;
+
+ // The asset is linked for use as a business logo.
+ BUSINESS_LOGO = 27;
+ // The asset is linked for use as a hotel property in a Performance Max for
+ // travel goals campaign.
+ HOTEL_PROPERTY = 28;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/asset_group_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_group_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/asset_group_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/asset_group_status.proto
index f973d6cdd..09bc86373 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/asset_group_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_group_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing asset group status.
@@ -46,6 +46,4 @@ message AssetGroupStatusEnum {
// The asset group is removed.
REMOVED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/asset_link_primary_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_link_primary_status.proto
new file mode 100644
index 000000000..36f2e00c2
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_link_primary_status.proto
@@ -0,0 +1,64 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "AssetLinkPrimaryStatusProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing asset source.
+
+// Provides the primary status of an asset link.
+// For example: a sitelink may be paused for a particular campaign.
+message AssetLinkPrimaryStatusEnum {
+ // Enum Provides insight into why an asset is not serving or not serving
+ // at full capacity for a particular link level. There could be one status
+ // with multiple reasons. For example, a sitelink might be paused by the user,
+ // but also limited in serving due to violation of an alcohol policy. In
+ // this case, the PrimaryStatus will be returned as PAUSED, since the asset's
+ // effective status is determined by its paused state.
+ enum AssetLinkPrimaryStatus {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // The asset is eligible to serve.
+ ELIGIBLE = 2;
+
+ // The user-specified asset link status is paused.
+ PAUSED = 3;
+
+ // The user-specified asset link status is removed.
+ REMOVED = 4;
+
+ // The asset may serve in the future.
+ PENDING = 5;
+
+ // The asset is serving in a partial capacity.
+ LIMITED = 6;
+
+ // The asset is not eligible to serve.
+ NOT_ELIGIBLE = 7;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/asset_link_primary_status_reason.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_link_primary_status_reason.proto
new file mode 100644
index 000000000..c18d3d28d
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_link_primary_status_reason.proto
@@ -0,0 +1,67 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "AssetLinkPrimaryStatusReasonProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing asset source.
+
+// Provides the reason of a primary status.
+// For example: a sitelink may be paused for a particular campaign.
+message AssetLinkPrimaryStatusReasonEnum {
+ // Enum Provides insight into why an asset is not serving or not serving
+ // at full capacity for a particular link level. These reasons are
+ // aggregated to determine a final PrimaryStatus.
+ // For example, a sitelink might be paused by the user,
+ // but also limited in serving due to violation of an alcohol policy. In
+ // this case, the PrimaryStatus will be returned as PAUSED, since the asset's
+ // effective status is determined by its paused state.
+ enum AssetLinkPrimaryStatusReason {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // The asset is paused for its linked rollup level. Contributes to a
+ // PrimaryStatus of PAUSED.
+ ASSET_LINK_PAUSED = 2;
+
+ // The asset is removed for its linked rollup level. Contributes to a
+ // PrimaryStatus of REMOVED.
+ ASSET_LINK_REMOVED = 3;
+
+ // The asset has been marked as disapproved. Contributes to a PrimaryStatus
+ // of NOT_ELIGIBLE
+ ASSET_DISAPPROVED = 4;
+
+ // The asset has not completed policy review. Contributes to a PrimaryStatus
+ // of PENDING.
+ ASSET_UNDER_REVIEW = 5;
+
+ // The asset is approved with policies applied. Contributes to a
+ // PrimaryStatus of LIMITED.
+ ASSET_APPROVED_LABELED = 6;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/asset_link_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_link_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/asset_link_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/asset_link_status.proto
index 214590037..bd730280f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/asset_link_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_link_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetLinkStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing status of an asset link.
@@ -46,6 +46,4 @@ message AssetLinkStatusEnum {
// Asset link is paused.
PAUSED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/asset_offline_evaluation_error_reasons.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_offline_evaluation_error_reasons.proto
new file mode 100644
index 000000000..6521c79f7
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_offline_evaluation_error_reasons.proto
@@ -0,0 +1,63 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "AssetOfflineEvaluationErrorReasonsProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing asset source.
+
+// Provides the quality evaluation disapproval reason of an asset.
+message AssetOfflineEvaluationErrorReasonsEnum {
+ // Enum describing the quality evaluation disapproval reason of an asset.
+ enum AssetOfflineEvaluationErrorReasons {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // One or more descriptions repeats its corresponding row header.
+ PRICE_ASSET_DESCRIPTION_REPEATS_ROW_HEADER = 2;
+
+ // Price asset contains repetitive headers.
+ PRICE_ASSET_REPETITIVE_HEADERS = 3;
+
+ // Price item header is not relevant to the price type.
+ PRICE_ASSET_HEADER_INCOMPATIBLE_WITH_PRICE_TYPE = 4;
+
+ // Price item description is not relevant to the item header.
+ PRICE_ASSET_DESCRIPTION_INCOMPATIBLE_WITH_ITEM_HEADER = 5;
+
+ // Price asset has a price qualifier in a description.
+ PRICE_ASSET_DESCRIPTION_HAS_PRICE_QUALIFIER = 6;
+
+ // Unsupported language for price assets
+ PRICE_ASSET_UNSUPPORTED_LANGUAGE = 7;
+
+ // Human raters identified an issue with the price asset that isn't captured
+ // by other error reasons. The primary purpose of this value is to represent
+ // legacy FeedItem disapprovals that are no longer produced.
+ PRICE_ASSET_OTHER_ERROR = 8;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/asset_performance_label.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_performance_label.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/asset_performance_label.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/asset_performance_label.proto
index 0518a051b..dc676f346 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/asset_performance_label.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_performance_label.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetPerformanceLabelProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing the performance label of an asset.
@@ -55,6 +55,4 @@ message AssetPerformanceLabelEnum {
// Best performing assets.
BEST = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/asset_set_asset_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_set_asset_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/asset_set_asset_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/asset_set_asset_status.proto
index 314d8232a..6a61370c0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/asset_set_asset_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_set_asset_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetSetAssetStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing asset set status.
@@ -44,6 +44,4 @@ message AssetSetAssetStatusEnum {
// The asset set asset is removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/asset_set_link_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_set_link_status.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/enums/asset_set_link_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/asset_set_link_status.proto
index e1ad1f3b2..1c1d6a3ba 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/asset_set_link_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_set_link_status.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetSetLinkStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing asset set status.
// Container for enum describing possible statuses of the linkage between asset
// set and its container.
message AssetSetLinkStatusEnum {
- // The possible statuses of he linkage between asset set and its container.
+ // The possible statuses of the linkage between asset set and its container.
enum AssetSetLinkStatus {
// The status has not been specified.
UNSPECIFIED = 0;
@@ -45,6 +45,4 @@ message AssetSetLinkStatusEnum {
// The linkage between asset set and its container is removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/asset_set_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_set_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/asset_set_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/asset_set_status.proto
index fb367168d..6ed12ebf6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/asset_set_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_set_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetSetStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing asset set status.
@@ -44,6 +44,4 @@ message AssetSetStatusEnum {
// The asset set is removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/asset_set_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_set_type.proto
similarity index 65%
rename from third_party/googleapis/google/ads/googleads/v10/enums/asset_set_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/asset_set_type.proto
index 9528e760c..261fdfd3d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/asset_set_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_set_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetSetTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing asset set type.
@@ -66,7 +66,23 @@ message AssetSetTypeEnum {
// Dynamic jobs asset set.
DYNAMIC_JOBS = 11;
- }
+ // Location sync level asset set.
+ LOCATION_SYNC = 12;
+
+ // Business Profile location group asset set.
+ BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP = 13;
+
+ // Chain location group asset set which can be used for both owned
+ // locations and affiliate locations.
+ CHAIN_DYNAMIC_LOCATION_GROUP = 14;
+ // Static location group asset set which can be used for both owned
+ // locations and affiliate locations.
+ STATIC_LOCATION_GROUP = 15;
+
+ // Hotel Property asset set which is used to link a hotel property feed to
+ // Performance Max for travel goals campaigns.
+ HOTEL_PROPERTY = 16;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/asset_source.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_source.proto
new file mode 100644
index 000000000..fb914686d
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_source.proto
@@ -0,0 +1,47 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "AssetSourceProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing asset source.
+
+// Source of the asset or asset link for who generated the entity.
+// For example, advertiser or automatically created.
+message AssetSourceEnum {
+ // Enum describing possible source of asset.
+ enum AssetSource {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // The asset or asset link is provided by advertiser.
+ ADVERTISER = 2;
+
+ // The asset or asset link is generated by Google.
+ AUTOMATICALLY_CREATED = 3;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/asset_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/asset_type.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/asset_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/asset_type.proto
index 980454414..e28becf7b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/asset_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/asset_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AssetTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing asset type.
@@ -111,7 +111,11 @@ message AssetTypeEnum {
// Dynamic jobs asset.
DYNAMIC_JOBS = 26;
- }
+ // Location asset.
+ LOCATION = 27;
+ // Hotel property asset.
+ HOTEL_PROPERTY = 28;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/async_action_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/async_action_status.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/async_action_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/async_action_status.proto
index 6c3c3ee7d..be4ed0980 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/async_action_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/async_action_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AsyncActionStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing experiment async action status.
@@ -52,6 +52,4 @@ message AsyncActionStatusEnum {
// Action has completed successfully with warnings.
COMPLETED_WITH_WARNING = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/attribution_model.proto b/third_party/googleapis/google/ads/googleads/v13/enums/attribution_model.proto
similarity index 88%
rename from third_party/googleapis/google/ads/googleads/v10/enums/attribution_model.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/attribution_model.proto
index 54f1aa78c..05436e295 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/attribution_model.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/attribution_model.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AttributionModelProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum representing the attribution model that describes how to
// distribute credit for a particular conversion across potentially many prior
@@ -65,6 +65,4 @@ message AttributionModelEnum {
// distribution of credit among clicks using Google Search attribution.
GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN = 106;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/audience_insights_dimension.proto b/third_party/googleapis/google/ads/googleads/v13/enums/audience_insights_dimension.proto
new file mode 100644
index 000000000..f76024bab
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/audience_insights_dimension.proto
@@ -0,0 +1,76 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "AudienceInsightsDimensionProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing a plannable network.
+
+// Container for enum describing audience insights dimensions.
+message AudienceInsightsDimensionEnum {
+ // Possible audience dimensions for use in generating insights.
+ enum AudienceInsightsDimension {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // The value is unknown in this version.
+ UNKNOWN = 1;
+
+ // A Product & Service category.
+ CATEGORY = 2;
+
+ // A Knowledge Graph entity.
+ KNOWLEDGE_GRAPH = 3;
+
+ // A country, represented by a geo target.
+ GEO_TARGET_COUNTRY = 4;
+
+ // A geographic location within a country.
+ SUB_COUNTRY_LOCATION = 5;
+
+ // A YouTube channel.
+ YOUTUBE_CHANNEL = 6;
+
+ // A YouTube Dynamic Lineup.
+ YOUTUBE_DYNAMIC_LINEUP = 7;
+
+ // An Affinity UserInterest.
+ AFFINITY_USER_INTEREST = 8;
+
+ // An In-Market UserInterest.
+ IN_MARKET_USER_INTEREST = 9;
+
+ // A Parental Status value (parent, or not a parent).
+ PARENTAL_STATUS = 10;
+
+ // A household income percentile range.
+ INCOME_RANGE = 11;
+
+ // An age range.
+ AGE_RANGE = 12;
+
+ // A gender.
+ GENDER = 13;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/audience_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/audience_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/audience_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/audience_status.proto
index 3e7be28c2..0b69b713b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/audience_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/audience_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "AudienceStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing audience status.
@@ -44,6 +44,4 @@ message AudienceStatusEnum {
// targeting.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/batch_job_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/batch_job_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/batch_job_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/batch_job_status.proto
index 706e6b79f..0c216a1ba 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/batch_job_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/batch_job_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BatchJobStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing batch job statuses.
@@ -46,6 +46,4 @@ message BatchJobStatusEnum {
// The job is done.
DONE = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/bid_modifier_source.proto b/third_party/googleapis/google/ads/googleads/v13/enums/bid_modifier_source.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/bid_modifier_source.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/bid_modifier_source.proto
index 1ace5726c..3c598f910 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/bid_modifier_source.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/bid_modifier_source.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BidModifierSourceProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing bid modifier source.
@@ -44,6 +44,4 @@ message BidModifierSourceEnum {
// The bid modifier is specified (overridden) at the ad group level.
AD_GROUP = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/bidding_source.proto b/third_party/googleapis/google/ads/googleads/v13/enums/bidding_source.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/bidding_source.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/bidding_source.proto
index 45b1b17db..e4cecdf42 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/bidding_source.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/bidding_source.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BiddingSourceProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing bidding sources.
@@ -48,6 +48,4 @@ message BiddingSourceEnum {
// The bid or target is defined on the ad group criterion.
AD_GROUP_CRITERION = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/bidding_strategy_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/bidding_strategy_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/bidding_strategy_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/bidding_strategy_status.proto
index ec7b6ddcd..84f9eb82e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/bidding_strategy_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/bidding_strategy_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BiddingStrategyStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing BiddingStrategy statuses.
@@ -45,6 +45,4 @@ message BiddingStrategyStatusEnum {
// The bidding strategy is removed.
REMOVED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/bidding_strategy_system_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/bidding_strategy_system_status.proto
new file mode 100644
index 000000000..ab34ef433
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/bidding_strategy_system_status.proto
@@ -0,0 +1,137 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "BiddingStrategySystemStatusProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing BiddingStrategy statuses.
+
+// Message describing BiddingStrategy system statuses.
+message BiddingStrategySystemStatusEnum {
+ // The possible system statuses of a BiddingStrategy.
+ enum BiddingStrategySystemStatus {
+ // Signals that an unexpected error occurred, for example, no bidding
+ // strategy type was found, or no status information was found.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // The bid strategy is active, and AdWords cannot find any specific issues
+ // with the strategy.
+ ENABLED = 2;
+
+ // The bid strategy is learning because it has been recently created or
+ // recently reactivated.
+ LEARNING_NEW = 3;
+
+ // The bid strategy is learning because of a recent setting change.
+ LEARNING_SETTING_CHANGE = 4;
+
+ // The bid strategy is learning because of a recent budget change.
+ LEARNING_BUDGET_CHANGE = 5;
+
+ // The bid strategy is learning because of recent change in number of
+ // campaigns, ad groups or keywords attached to it.
+ LEARNING_COMPOSITION_CHANGE = 6;
+
+ // The bid strategy depends on conversion reporting and the customer
+ // recently modified conversion types that were relevant to the
+ // bid strategy.
+ LEARNING_CONVERSION_TYPE_CHANGE = 7;
+
+ // The bid strategy depends on conversion reporting and the customer
+ // recently changed their conversion settings.
+ LEARNING_CONVERSION_SETTING_CHANGE = 8;
+
+ // The bid strategy is limited by its bid ceiling.
+ LIMITED_BY_CPC_BID_CEILING = 9;
+
+ // The bid strategy is limited by its bid floor.
+ LIMITED_BY_CPC_BID_FLOOR = 10;
+
+ // The bid strategy is limited because there was not enough conversion
+ // traffic over the past weeks.
+ LIMITED_BY_DATA = 11;
+
+ // A significant fraction of keywords in this bid strategy are limited by
+ // budget.
+ LIMITED_BY_BUDGET = 12;
+
+ // The bid strategy cannot reach its target spend because its spend has
+ // been de-prioritized.
+ LIMITED_BY_LOW_PRIORITY_SPEND = 13;
+
+ // A significant fraction of keywords in this bid strategy have a low
+ // Quality Score.
+ LIMITED_BY_LOW_QUALITY = 14;
+
+ // The bid strategy cannot fully spend its budget because of narrow
+ // targeting.
+ LIMITED_BY_INVENTORY = 15;
+
+ // Missing conversion tracking (no pings present) and/or remarketing lists
+ // for SSC.
+ MISCONFIGURED_ZERO_ELIGIBILITY = 16;
+
+ // The bid strategy depends on conversion reporting and the customer is
+ // lacking conversion types that might be reported against this strategy.
+ MISCONFIGURED_CONVERSION_TYPES = 17;
+
+ // The bid strategy depends on conversion reporting and the customer's
+ // conversion settings are misconfigured.
+ MISCONFIGURED_CONVERSION_SETTINGS = 18;
+
+ // There are campaigns outside the bid strategy that share budgets with
+ // campaigns included in the strategy.
+ MISCONFIGURED_SHARED_BUDGET = 19;
+
+ // The campaign has an invalid strategy type and is not serving.
+ MISCONFIGURED_STRATEGY_TYPE = 20;
+
+ // The bid strategy is not active. Either there are no active campaigns,
+ // ad groups or keywords attached to the bid strategy. Or there are no
+ // active budgets connected to the bid strategy.
+ PAUSED = 21;
+
+ // This bid strategy currently does not support status reporting.
+ UNAVAILABLE = 22;
+
+ // There were multiple LEARNING_* system statuses for this bid strategy
+ // during the time in question.
+ MULTIPLE_LEARNING = 23;
+
+ // There were multiple LIMITED_* system statuses for this bid strategy
+ // during the time in question.
+ MULTIPLE_LIMITED = 24;
+
+ // There were multiple MISCONFIGURED_* system statuses for this bid strategy
+ // during the time in question.
+ MULTIPLE_MISCONFIGURED = 25;
+
+ // There were multiple system statuses for this bid strategy during the
+ // time in question.
+ MULTIPLE = 26;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/bidding_strategy_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/bidding_strategy_type.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/enums/bidding_strategy_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/bidding_strategy_type.proto
index ba9aed1df..9c3bda713 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/bidding_strategy_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/bidding_strategy_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BiddingStrategyTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing bidding schemes.
@@ -55,6 +55,10 @@ message BiddingStrategyTypeEnum {
// type.
INVALID = 17;
+ // Manual bidding strategy that allows advertiser to set the bid per
+ // advertiser-specified action.
+ MANUAL_CPA = 18;
+
// Manual click based bidding where user pays per click.
MANUAL_CPC = 3;
@@ -112,6 +116,4 @@ message BiddingStrategyTypeEnum {
// to help get as many clicks as possible within your budget.
TARGET_SPEND = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/billing_setup_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/billing_setup_status.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/billing_setup_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/billing_setup_status.proto
index de3711cb1..5ac1d5b58 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/billing_setup_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/billing_setup_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BillingSetupStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing BillingSetup statuses.
@@ -51,6 +51,4 @@ message BillingSetupStatusEnum {
// The billing setup was cancelled by the user prior to approval.
CANCELLED = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/brand_safety_suitability.proto b/third_party/googleapis/google/ads/googleads/v13/enums/brand_safety_suitability.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/enums/brand_safety_suitability.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/brand_safety_suitability.proto
index bede19c1f..79cb6b41b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/brand_safety_suitability.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/brand_safety_suitability.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BrandSafetySuitabilityProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing brand safety suitability settings.
@@ -66,6 +66,4 @@ message BrandSafetySuitabilityEnum {
// Google video partners.
LIMITED_INVENTORY = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/budget_campaign_association_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/budget_campaign_association_status.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/budget_campaign_association_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/budget_campaign_association_status.proto
index 231dc97bb..b62a544af 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/budget_campaign_association_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/budget_campaign_association_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BudgetCampaignAssociationStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Budget and Campaign association status.
@@ -44,6 +44,4 @@ message BudgetCampaignAssociationStatusEnum {
// The campaign is no longer using the budget.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/budget_delivery_method.proto b/third_party/googleapis/google/ads/googleads/v13/enums/budget_delivery_method.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/budget_delivery_method.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/budget_delivery_method.proto
index 0f8b1fa58..7dddbc77c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/budget_delivery_method.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/budget_delivery_method.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BudgetDeliveryMethodProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Budget delivery methods.
@@ -46,6 +46,4 @@ message BudgetDeliveryMethodEnum {
// and ads will serve as fast as possible.
ACCELERATED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/budget_period.proto b/third_party/googleapis/google/ads/googleads/v13/enums/budget_period.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/budget_period.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/budget_period.proto
index 90d33ccfb..52e6770d9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/budget_period.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/budget_period.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BudgetPeriodProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Budget delivery methods.
@@ -46,6 +46,4 @@ message BudgetPeriodEnum {
// info.
CUSTOM_PERIOD = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/budget_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/budget_status.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/budget_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/budget_status.proto
index c886abf1f..af49a1e2c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/budget_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/budget_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BudgetStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Budget statuses
@@ -43,6 +43,4 @@ message BudgetStatusEnum {
// Budget is removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/budget_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/budget_type.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/enums/budget_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/budget_type.proto
index 887f9c4a3..fabe82f1e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/budget_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/budget_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "BudgetTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Budget types.
@@ -66,6 +66,4 @@ message BudgetTypeEnum {
// AdvertisingChannelType.LOCAL_SERVICES.
LOCAL_SERVICES = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/call_conversion_reporting_state.proto b/third_party/googleapis/google/ads/googleads/v13/enums/call_conversion_reporting_state.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/call_conversion_reporting_state.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/call_conversion_reporting_state.proto
index e8ed00ad6..8fa1a4a63 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/call_conversion_reporting_state.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/call_conversion_reporting_state.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CallConversionReportingStateProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing call conversion reporting state.
@@ -49,6 +49,4 @@ message CallConversionReportingStateEnum {
// (call only ads/call extensions) level.
USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/call_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/call_placeholder_field.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/enums/call_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/call_placeholder_field.proto
index 0596fbb6a..06504b135 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/call_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/call_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CallPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Call placeholder fields.
@@ -59,6 +59,4 @@ message CallPlaceholderFieldEnum {
// USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
CONVERSION_REPORTING_STATE = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/call_to_action_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/call_to_action_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/call_to_action_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/call_to_action_type.proto
index 866538828..60aa9e4f6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/call_to_action_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/call_to_action_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CallToActionTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing call to action type.
@@ -64,6 +64,4 @@ message CallToActionTypeEnum {
// The call to action type is shop now.
SHOP_NOW = 10;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/call_tracking_display_location.proto b/third_party/googleapis/google/ads/googleads/v13/enums/call_tracking_display_location.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/call_tracking_display_location.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/call_tracking_display_location.proto
index a2c7eaef1..9b76b3f52 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/call_tracking_display_location.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/call_tracking_display_location.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CallTrackingDisplayLocationProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing call tracking display location.
@@ -43,6 +43,4 @@ message CallTrackingDisplayLocationEnum {
// The phone call placed from the landing page ad points to.
LANDING_PAGE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/call_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/call_type.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/call_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/call_type.proto
index 1ab32373c..75d79a7fe 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/call_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/call_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CallTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing call types.
@@ -44,6 +44,4 @@ message CallTypeEnum {
// The phone call was a mobile click-to-call.
HIGH_END_MOBILE_SEARCH = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/callout_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/callout_placeholder_field.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/callout_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/callout_placeholder_field.proto
index 1df40061e..697530b97 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/callout_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/callout_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CalloutPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Callout placeholder fields.
@@ -40,6 +40,4 @@ message CalloutPlaceholderFieldEnum {
// Data Type: STRING. Callout text.
CALLOUT_TEXT = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_criterion_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_criterion_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/campaign_criterion_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/campaign_criterion_status.proto
index 03b96d1e3..9d9f7f28d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_criterion_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_criterion_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignCriterionStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing CampaignCriterion statuses.
@@ -48,6 +48,4 @@ message CampaignCriterionStatusEnum {
// The campaign criterion is removed.
REMOVED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_draft_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_draft_status.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/enums/campaign_draft_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/campaign_draft_status.proto
index abf6c336d..c8c812faa 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_draft_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_draft_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignDraftStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing campaign draft status.
@@ -58,6 +58,4 @@ message CampaignDraftStatusEnum {
// campaign.
PROMOTE_FAILED = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_experiment_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_experiment_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/campaign_experiment_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/campaign_experiment_type.proto
index c3ea8b1d5..bbd57e52b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_experiment_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_experiment_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignExperimentTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing campaign experiment type.
@@ -52,6 +52,4 @@ message CampaignExperimentTypeEnum {
// from the BASE campaign to this experiment campaign.
EXPERIMENT = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_group_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_group_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/campaign_group_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/campaign_group_status.proto
index 79bc5265e..275a94c65 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_group_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_group_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignGroupStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing CampaignGroup statuses.
@@ -43,6 +43,4 @@ message CampaignGroupStatusEnum {
// The campaign group has been removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/campaign_primary_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_primary_status.proto
new file mode 100644
index 000000000..a45804d30
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_primary_status.proto
@@ -0,0 +1,73 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "CampaignPrimaryStatusProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing Campaign primary statuses.
+
+// Container for enum describing possible campaign primary status.
+message CampaignPrimaryStatusEnum {
+ // Enum describing the possible campaign primary status. Provides insight into
+ // why a campaign is not serving or not serving optimally. Modification to the
+ // campaign and its related entities might take a while to be reflected in
+ // this status.
+ enum CampaignPrimaryStatus {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // The campaign is eligible to serve.
+ ELIGIBLE = 2;
+
+ // The user-specified campaign status is paused.
+ PAUSED = 3;
+
+ // The user-specified campaign status is removed.
+ REMOVED = 4;
+
+ // The user-specified time for this campaign to end has passed.
+ ENDED = 5;
+
+ // The campaign may serve in the future.
+ PENDING = 6;
+
+ // The campaign or its associated entities have incorrect user-specified
+ // settings.
+ MISCONFIGURED = 7;
+
+ // The campaign or its associated entities are limited by user-specified
+ // settings.
+ LIMITED = 8;
+
+ // The automated bidding system is adjusting to user-specified changes to
+ // the campaign or associated entities.
+ LEARNING = 9;
+
+ // The campaign is not eligible to serve.
+ NOT_ELIGIBLE = 10;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/campaign_primary_status_reason.proto b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_primary_status_reason.proto
new file mode 100644
index 000000000..63a8d335a
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_primary_status_reason.proto
@@ -0,0 +1,145 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "CampaignPrimaryStatusReasonProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing CampaignPrimaryStatusReasons.
+
+// Container for enum describing possible campaign primary status reasons.
+message CampaignPrimaryStatusReasonEnum {
+ // Enum describing the possible campaign primary status reasons. Provides
+ // insight into why a campaign is not serving or not serving optimally. These
+ // reasons are aggregated to determine an overall campaign primary status.
+ enum CampaignPrimaryStatusReason {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // The user-specified campaign status is removed.
+ CAMPAIGN_REMOVED = 2;
+
+ // The user-specified campaign status is paused.
+ CAMPAIGN_PAUSED = 3;
+
+ // The user-specified time for this campaign to start is in the future.
+ CAMPAIGN_PENDING = 4;
+
+ // The user-specified time for this campaign to end has passed.
+ CAMPAIGN_ENDED = 5;
+
+ // The campaign is a draft.
+ CAMPAIGN_DRAFT = 6;
+
+ // The bidding strategy has incorrect user-specified settings.
+ BIDDING_STRATEGY_MISCONFIGURED = 7;
+
+ // The bidding strategy is limited by user-specified settings such as lack
+ // of data or similar.
+ BIDDING_STRATEGY_LIMITED = 8;
+
+ // The automated bidding system is adjusting to user-specified changes to
+ // the bidding strategy.
+ BIDDING_STRATEGY_LEARNING = 9;
+
+ // Campaign could capture more conversion value by adjusting CPA/ROAS
+ // targets.
+ BIDDING_STRATEGY_CONSTRAINED = 10;
+
+ // The budget is limiting the campaign's ability to serve.
+ BUDGET_CONSTRAINED = 11;
+
+ // The budget has incorrect user-specified settings.
+ BUDGET_MISCONFIGURED = 12;
+
+ // Campaign is not targeting all relevant queries.
+ SEARCH_VOLUME_LIMITED = 13;
+
+ // The user-specified ad group statuses are all paused.
+ AD_GROUPS_PAUSED = 14;
+
+ // No eligible ad groups exist in this campaign.
+ NO_AD_GROUPS = 15;
+
+ // The user-specified keyword statuses are all paused.
+ KEYWORDS_PAUSED = 16;
+
+ // No eligible keywords exist in this campaign.
+ NO_KEYWORDS = 17;
+
+ // The user-specified ad group ad statuses are all paused.
+ AD_GROUP_ADS_PAUSED = 18;
+
+ // No eligible ad group ads exist in this campaign.
+ NO_AD_GROUP_ADS = 19;
+
+ // At least one ad in this campaign is limited by policy.
+ HAS_ADS_LIMITED_BY_POLICY = 20;
+
+ // At least one ad in this campaign is disapproved.
+ HAS_ADS_DISAPPROVED = 21;
+
+ // Most ads in this campaign are pending review.
+ MOST_ADS_UNDER_REVIEW = 22;
+
+ // The campaign has a lead form goal, and the lead form extension is
+ // missing.
+ MISSING_LEAD_FORM_EXTENSION = 23;
+
+ // The campaign has a call goal, and the call extension is missing.
+ MISSING_CALL_EXTENSION = 24;
+
+ // The lead form extension is under review.
+ LEAD_FORM_EXTENSION_UNDER_REVIEW = 25;
+
+ // The lead extension is disapproved.
+ LEAD_FORM_EXTENSION_DISAPPROVED = 26;
+
+ // The call extension is under review.
+ CALL_EXTENSION_UNDER_REVIEW = 27;
+
+ // The call extension is disapproved.
+ CALL_EXTENSION_DISAPPROVED = 28;
+
+ // No eligible mobile application ad group criteria exist in this campaign.
+ NO_MOBILE_APPLICATION_AD_GROUP_CRITERIA = 29;
+
+ // The user-specified campaign group status is paused.
+ CAMPAIGN_GROUP_PAUSED = 30;
+
+ // The user-specified times of all group budgets associated with the parent
+ // campaign group has passed.
+ CAMPAIGN_GROUP_ALL_GROUP_BUDGETS_ENDED = 31;
+
+ // The app associated with this ACi campaign is not released in the target
+ // countries of the campaign.
+ APP_NOT_RELEASED = 32;
+
+ // The app associated with this ACi campaign is partially released in the
+ // target countries of the campaign.
+ APP_PARTIALLY_RELEASED = 33;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_serving_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_serving_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/campaign_serving_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/campaign_serving_status.proto
index a1b83b79f..1a6663aa9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_serving_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_serving_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignServingStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Campaign serving statuses.
@@ -54,6 +54,4 @@ message CampaignServingStatusEnum {
// Suspended.
SUSPENDED = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_shared_set_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_shared_set_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/campaign_shared_set_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/campaign_shared_set_status.proto
index 3fef19142..fb28d6098 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_shared_set_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_shared_set_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignSharedSetStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing campaign shared set statuses.
@@ -43,6 +43,4 @@ message CampaignSharedSetStatusEnum {
// The campaign shared set is removed and can no longer be used.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_status.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/enums/campaign_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/campaign_status.proto
index ab4285d1c..9f198de49 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/campaign_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/campaign_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CampaignStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing campaign status.
@@ -37,7 +37,7 @@ message CampaignStatusEnum {
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
- // Campaign is currently serving ads depending on budget information.
+ // Campaign is active and can show ads.
ENABLED = 2;
// Campaign has been paused by the user.
@@ -46,6 +46,4 @@ message CampaignStatusEnum {
// Campaign has been removed.
REMOVED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/chain_relationship_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/chain_relationship_type.proto
new file mode 100644
index 000000000..c084ca75f
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/chain_relationship_type.proto
@@ -0,0 +1,46 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "ChainRelationshipTypeProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing relationship type.
+
+// Container for enum describing possible types of a relationship.
+message ChainRelationshipTypeEnum {
+ // Possible types of a relationship.
+ enum ChainRelationshipType {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // Auto dealer relationship.
+ AUTO_DEALERS = 2;
+
+ // General retailer relationship.
+ GENERAL_RETAILERS = 3;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/change_client_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/change_client_type.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/change_client_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/change_client_type.proto
index 62dba5013..152eea6d1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/change_client_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/change_client_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ChangeClientTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing the sources that the change event resource was
// made through.
@@ -56,7 +56,8 @@ message ChangeClientTypeEnum {
// Changes made by Google Ads API.
GOOGLE_ADS_API = 6;
- // Changes made by Google Ads Editor.
+ // Changes made by Google Ads Editor. This value is a placeholder.
+ // The API does not return these changes.
GOOGLE_ADS_EDITOR = 7;
// Changes made by Google Ads mobile app.
@@ -80,6 +81,4 @@ message ChangeClientTypeEnum {
// changes made by coupon redemption through Google Ads.
OTHER = 13;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/change_event_resource_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/change_event_resource_type.proto
similarity index 88%
rename from third_party/googleapis/google/ads/googleads/v10/enums/change_event_resource_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/change_event_resource_type.proto
index edd6e0cd9..adc0b4b01 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/change_event_resource_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/change_event_resource_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ChangeEventResourceTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing the resource types the ChangeEvent resource supports.
@@ -96,6 +96,4 @@ message ChangeEventResourceTypeEnum {
// A CampaignAssetSet resource change.
CAMPAIGN_ASSET_SET = 20;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/change_status_operation.proto b/third_party/googleapis/google/ads/googleads/v13/enums/change_status_operation.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/change_status_operation.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/change_status_operation.proto
index 18d3ba878..dab2cbfdc 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/change_status_operation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/change_status_operation.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ChangeStatusOperationProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing the change status operations.
@@ -47,6 +47,4 @@ message ChangeStatusOperationEnum {
// The resource was removed.
REMOVED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/change_status_resource_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/change_status_resource_type.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/change_status_resource_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/change_status_resource_type.proto
index 863b5bff7..94c928ab0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/change_status_resource_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/change_status_resource_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ChangeStatusResourceTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing the resource types the ChangeStatus resource supports.
@@ -86,7 +86,8 @@ message ChangeStatusResourceTypeEnum {
// An AdGroupAsset resource change.
AD_GROUP_ASSET = 19;
- }
-
+ // A CombinedAudience resource change.
+ COMBINED_AUDIENCE = 20;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/click_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/click_type.proto
similarity index 93%
rename from third_party/googleapis/google/ads/googleads/v10/enums/click_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/click_type.proto
index 049574a31..6983ea76d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/click_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/click_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ClickTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing click types.
@@ -199,6 +199,4 @@ message ClickTypeEnum {
// Cross-network. From Performance Max and Discovery Campaigns.
CROSS_NETWORK = 57;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/combined_audience_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/combined_audience_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/combined_audience_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/combined_audience_status.proto
index 3a4abf8c3..6b242e870 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/combined_audience_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/combined_audience_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CombinedAudienceStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing combined audience status.
@@ -44,6 +44,4 @@ message CombinedAudienceStatusEnum {
// targeting.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/content_label_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/content_label_type.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/enums/content_label_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/content_label_type.proto
index 1e211e6f7..fc1b38a4f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/content_label_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/content_label_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ContentLabelTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing content label types.
@@ -82,6 +82,4 @@ message ContentLabelTypeEnum {
// Sensitive social issues.
SOCIAL_ISSUES = 17;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_category.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_category.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_category.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_category.proto
index 5c7b39788..d84d61911 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_category.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_category.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionActionCategoryProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing the category of conversions that are associated
// with a ConversionAction.
@@ -105,10 +105,8 @@ message ConversionActionCategoryEnum {
QUALIFIED_LEAD = 22;
// A lead conversion imported from an external source into Google Ads, that
- // has further completed a desired stage as defined by the lead gen
+ // has further completed a chosen stage as defined by the lead gen
// advertiser.
CONVERTED_LEAD = 23;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_counting_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_counting_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_counting_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_counting_type.proto
index 7d658e1d1..e71e0dca4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_counting_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_counting_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionActionCountingTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion action counting type.
@@ -45,6 +45,4 @@ message ConversionActionCountingTypeEnum {
// Count all conversions per click.
MANY_PER_CLICK = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_status.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_status.proto
index 9ee458b3e..4e23c2f03 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionActionStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion action status.
@@ -47,6 +47,4 @@ message ConversionActionStatusEnum {
// appear in the UI.
HIDDEN = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_type.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_type.proto
index 3a98401a5..606be6bcf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_action_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_action_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionActionTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion action type.
@@ -78,42 +78,43 @@ message ConversionActionTypeEnum {
// Read only.
STORE_SALES = 11;
- // Android app first open conversions tracked via Firebase.
+ // Android app first open conversions tracked through Firebase.
FIREBASE_ANDROID_FIRST_OPEN = 12;
- // Android app in app purchase conversions tracked via Firebase.
+ // Android app in app purchase conversions tracked through Firebase.
FIREBASE_ANDROID_IN_APP_PURCHASE = 13;
- // Android app custom conversions tracked via Firebase.
+ // Android app custom conversions tracked through Firebase.
FIREBASE_ANDROID_CUSTOM = 14;
- // iOS app first open conversions tracked via Firebase.
+ // iOS app first open conversions tracked through Firebase.
FIREBASE_IOS_FIRST_OPEN = 15;
- // iOS app in app purchase conversions tracked via Firebase.
+ // iOS app in app purchase conversions tracked through Firebase.
FIREBASE_IOS_IN_APP_PURCHASE = 16;
- // iOS app custom conversions tracked via Firebase.
+ // iOS app custom conversions tracked through Firebase.
FIREBASE_IOS_CUSTOM = 17;
- // Android app first open conversions tracked via Third Party App Analytics.
+ // Android app first open conversions tracked through Third Party App
+ // Analytics.
THIRD_PARTY_APP_ANALYTICS_ANDROID_FIRST_OPEN = 18;
- // Android app in app purchase conversions tracked via Third Party App
+ // Android app in app purchase conversions tracked through Third Party App
// Analytics.
THIRD_PARTY_APP_ANALYTICS_ANDROID_IN_APP_PURCHASE = 19;
- // Android app custom conversions tracked via Third Party App Analytics.
+ // Android app custom conversions tracked through Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_ANDROID_CUSTOM = 20;
- // iOS app first open conversions tracked via Third Party App Analytics.
+ // iOS app first open conversions tracked through Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_IOS_FIRST_OPEN = 21;
- // iOS app in app purchase conversions tracked via Third Party App
+ // iOS app in app purchase conversions tracked through Third Party App
// Analytics.
THIRD_PARTY_APP_ANALYTICS_IOS_IN_APP_PURCHASE = 22;
- // iOS app custom conversions tracked via Third Party App Analytics.
+ // iOS app custom conversions tracked through Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_IOS_CUSTOM = 23;
// Conversions that occur when a user pre-registers a mobile app from the
@@ -166,7 +167,9 @@ message ConversionActionTypeEnum {
// Conversions that occur when a user visits an advertiser's retail store.
// Read only.
STORE_VISITS = 36;
- }
-
+ // Conversions created from website events (such as form submissions or page
+ // loads), that don't use individually coded event snippets.
+ WEBPAGE_CODELESS = 37;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_adjustment_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_adjustment_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_adjustment_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_adjustment_type.proto
index 7b4f4d270..9ca36bced 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_adjustment_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_adjustment_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionAdjustmentTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion adjustment type.
@@ -49,6 +49,4 @@ message ConversionAdjustmentTypeEnum {
// user agent, which can be used by Google to enhance the conversion count.
ENHANCEMENT = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_attribution_event_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_attribution_event_type.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_attribution_event_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_attribution_event_type.proto
index f55c01e33..5c1c9f5c9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_attribution_event_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_attribution_event_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionAttributionEventTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum indicating the event type the conversion is attributed to.
message ConversionAttributionEventTypeEnum {
@@ -41,6 +41,4 @@ message ConversionAttributionEventTypeEnum {
// The conversion is attributed to an interaction.
INTERACTION = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_custom_variable_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_custom_variable_status.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_custom_variable_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_custom_variable_status.proto
index dd7be184c..0bd1ebd2a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_custom_variable_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_custom_variable_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionCustomVariableStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion custom variable status.
@@ -51,6 +51,4 @@ message ConversionCustomVariableStatusEnum {
// until set to ENABLED again.
PAUSED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_environment_enum.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_environment_enum.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_environment_enum.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_environment_enum.proto
index 44a3c141f..9cdecb906 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_environment_enum.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_environment_enum.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionEnvironmentEnumProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum representing the conversion environment an uploaded
-// conversion was recorded on. e.g. App or Web.
+// conversion was recorded on, for example, App or Web.
message ConversionEnvironmentEnum {
// Conversion environment of the uploaded conversion.
enum ConversionEnvironment {
@@ -42,6 +42,4 @@ message ConversionEnvironmentEnum {
// The conversion was recorded on a website.
WEB = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_lag_bucket.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_lag_bucket.proto
similarity index 91%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_lag_bucket.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_lag_bucket.proto
index b858514fb..5a22dd5e6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_lag_bucket.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_lag_bucket.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionLagBucketProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum representing the number of days between impression and
// conversion.
@@ -110,6 +110,4 @@ message ConversionLagBucketEnum {
// 90 days is not.
SIXTY_TO_NINETY_DAYS = 20;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_or_adjustment_lag_bucket.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_or_adjustment_lag_bucket.proto
similarity index 95%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_or_adjustment_lag_bucket.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_or_adjustment_lag_bucket.proto
index b2f5c412a..4dc8524ce 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_or_adjustment_lag_bucket.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_or_adjustment_lag_bucket.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionOrAdjustmentLagBucketProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum representing the number of days between the impression and
// the conversion or between the impression and adjustments to the conversion.
@@ -199,6 +199,4 @@ message ConversionOrAdjustmentLagBucketEnum {
// conversion adjustment lag bucket was available in Google Ads.
ADJUSTMENT_UNKNOWN = 42;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_origin.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_origin.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_origin.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_origin.proto
index 5b1cdf202..90c72e3aa 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_origin.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_origin.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionOriginProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion origin.
@@ -42,11 +42,11 @@ message ConversionOriginEnum {
WEBSITE = 2;
// Conversions reported by an offline pipeline which collects local actions
- // from Google-hosted pages (e.g. Google Maps, Google Place Page, etc) and
- // attributes them to relevant ad events.
+ // from Google-hosted pages (for example, Google Maps, Google Place Page,
+ // etc) and attributes them to relevant ad events.
GOOGLE_HOSTED = 3;
- // Conversion that occurs when a user performs an action via any app
+ // Conversion that occurs when a user performs an action through any app
// platforms.
APP = 4;
@@ -60,6 +60,4 @@ message ConversionOriginEnum {
// Conversion that occurs on YouTube.
YOUTUBE_HOSTED = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_tracking_status_enum.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_tracking_status_enum.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_tracking_status_enum.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_tracking_status_enum.proto
index fe69f3df2..0e092c4fd 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_tracking_status_enum.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_tracking_status_enum.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionTrackingStatusEnumProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum representing the conversion tracking status of the
// customer.
@@ -51,6 +51,4 @@ message ConversionTrackingStatusEnum {
// `login-customer-id`.
CONVERSION_TRACKING_MANAGED_BY_ANOTHER_MANAGER = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_value_rule_primary_dimension.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_value_rule_primary_dimension.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_value_rule_primary_dimension.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_value_rule_primary_dimension.proto
index 3e2b69d16..ef48b2be3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_value_rule_primary_dimension.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_value_rule_primary_dimension.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionValueRulePrimaryDimensionProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion value rule primary dimension.
@@ -59,6 +59,4 @@ message ConversionValueRulePrimaryDimensionEnum {
// When multiple rules are applied.
MULTIPLE = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_value_rule_set_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_value_rule_set_status.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_value_rule_set_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_value_rule_set_status.proto
index 721d2164b..bd46ac2a1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_value_rule_set_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_value_rule_set_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionValueRuleSetStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion value rule set status.
@@ -48,6 +48,4 @@ message ConversionValueRuleSetStatusEnum {
// enabled again.
PAUSED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_value_rule_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_value_rule_status.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/conversion_value_rule_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/conversion_value_rule_status.proto
index 8244fb148..747a9c964 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/conversion_value_rule_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/conversion_value_rule_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ConversionValueRuleStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion value rule status.
@@ -46,6 +46,4 @@ message ConversionValueRuleStatusEnum {
// Conversion Value Rule is paused, but can be re-enabled.
PAUSED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/criterion_category_channel_availability_mode.proto b/third_party/googleapis/google/ads/googleads/v13/enums/criterion_category_channel_availability_mode.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/criterion_category_channel_availability_mode.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/criterion_category_channel_availability_mode.proto
index 9d24212c4..7898c57de 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/criterion_category_channel_availability_mode.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/criterion_category_channel_availability_mode.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CriterionCategoryChannelAvailabilityModeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing the criterion category channel availability mode.
@@ -51,6 +51,4 @@ message CriterionCategoryChannelAvailabilityModeEnum {
// subtype(s).
CHANNEL_TYPE_AND_SUBSET_SUBTYPES = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/criterion_category_locale_availability_mode.proto b/third_party/googleapis/google/ads/googleads/v13/enums/criterion_category_locale_availability_mode.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/enums/criterion_category_locale_availability_mode.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/criterion_category_locale_availability_mode.proto
index ad985417d..567886261 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/criterion_category_locale_availability_mode.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/criterion_category_locale_availability_mode.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CriterionCategoryLocaleAvailabilityModeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing the criterion category locale availability mode.
@@ -54,6 +54,4 @@ message CriterionCategoryLocaleAvailabilityModeEnum {
// pairs.
COUNTRY_AND_LANGUAGE = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/criterion_system_serving_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/criterion_system_serving_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/criterion_system_serving_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/criterion_system_serving_status.proto
index f3942bb8b..2f1373b87 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/criterion_system_serving_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/criterion_system_serving_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CriterionSystemServingStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing approval status for the criterion.
@@ -43,6 +43,4 @@ message CriterionSystemServingStatusEnum {
// Low search volume.
RARELY_SERVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/criterion_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/criterion_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/criterion_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/criterion_type.proto
index a7bf3c6d6..6d3ee4ea3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/criterion_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/criterion_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CriterionTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing criteria types.
@@ -37,10 +37,10 @@ message CriterionTypeEnum {
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
- // Keyword. e.g. 'mars cruise'.
+ // Keyword, for example, 'mars cruise'.
KEYWORD = 2;
- // Placement, aka Website. e.g. 'www.flowers4sale.com'
+ // Placement, also known as Website, for example, 'www.flowers4sale.com'
PLACEMENT = 3;
// Mobile application categories to target.
@@ -85,7 +85,7 @@ message CriterionTypeEnum {
// Proximity.
PROXIMITY = 17;
- // A topic target on the display network (e.g. "Pets & Animals").
+ // A topic target on the display network (for example, "Pets & Animals").
TOPIC = 18;
// Listing scope to target.
@@ -138,7 +138,8 @@ message CriterionTypeEnum {
// Audience
AUDIENCE = 35;
- }
-
+ // Local Services Ads Service ID.
+ LOCAL_SERVICE_ID = 37;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/custom_audience_member_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/custom_audience_member_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/custom_audience_member_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/custom_audience_member_type.proto
index 6a5e33062..f84c5a23b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/custom_audience_member_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/custom_audience_member_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomAudienceMemberTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing custom audience member type.
@@ -49,6 +49,4 @@ message CustomAudienceMemberTypeEnum {
// Users who have installed a mobile app.
APP = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/custom_audience_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/custom_audience_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/custom_audience_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/custom_audience_status.proto
index c1c0819b7..f469a08ea 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/custom_audience_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/custom_audience_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomAudienceStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing custom audience status.
@@ -44,6 +44,4 @@ message CustomAudienceStatusEnum {
// targeting.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/custom_audience_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/custom_audience_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/custom_audience_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/custom_audience_type.proto
index e63dea7e5..52b0387ca 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/custom_audience_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/custom_audience_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomAudienceTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing custom audience type.
@@ -51,6 +51,4 @@ message CustomAudienceTypeEnum {
// Matches users by what they searched on Google Search.
SEARCH = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/custom_conversion_goal_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/custom_conversion_goal_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/custom_conversion_goal_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/custom_conversion_goal_status.proto
index b4e78a8b9..d3d731837 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/custom_conversion_goal_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/custom_conversion_goal_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomConversionGoalStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing custom conversion goal status.
@@ -43,6 +43,4 @@ message CustomConversionGoalStatusEnum {
// The custom conversion goal is removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/custom_interest_member_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/custom_interest_member_type.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/custom_interest_member_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/custom_interest_member_type.proto
index b03297241..f1ef34400 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/custom_interest_member_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/custom_interest_member_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomInterestMemberTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing custom interest member type.
@@ -43,6 +43,4 @@ message CustomInterestMemberTypeEnum {
// Custom interest member type URL.
URL = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/custom_interest_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/custom_interest_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/custom_interest_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/custom_interest_status.proto
index 2d3a373ce..a178d11f3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/custom_interest_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/custom_interest_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomInterestStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing custom interest status.
@@ -44,6 +44,4 @@ message CustomInterestStatusEnum {
// targeting.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/custom_interest_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/custom_interest_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/custom_interest_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/custom_interest_type.proto
index 26d39eaee..b38d0fd85 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/custom_interest_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/custom_interest_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomInterestTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing custom interest type.
@@ -43,6 +43,4 @@ message CustomInterestTypeEnum {
// Allows advertisers to define custom intent audience lists.
CUSTOM_INTENT = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/custom_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/custom_placeholder_field.proto
similarity index 92%
rename from third_party/googleapis/google/ads/googleads/v10/enums/custom_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/custom_placeholder_field.proto
index 5173b79f7..5a45d5e3c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/custom_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/custom_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Custom placeholder fields.
@@ -122,6 +122,4 @@ message CustomPlaceholderFieldEnum {
// Data Type: INT64. iOS app store ID.
IOS_APP_STORE_ID = 21;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/customer_match_upload_key_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/customer_match_upload_key_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/customer_match_upload_key_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/customer_match_upload_key_type.proto
index 05bb51430..a69031d32 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/customer_match_upload_key_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/customer_match_upload_key_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomerMatchUploadKeyTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Indicates what type of data are the user list's members matched from.
message CustomerMatchUploadKeyTypeEnum {
@@ -46,6 +46,4 @@ message CustomerMatchUploadKeyTypeEnum {
// Members are matched from mobile advertising ids.
MOBILE_ADVERTISING_ID = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/customer_pay_per_conversion_eligibility_failure_reason.proto b/third_party/googleapis/google/ads/googleads/v13/enums/customer_pay_per_conversion_eligibility_failure_reason.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/enums/customer_pay_per_conversion_eligibility_failure_reason.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/customer_pay_per_conversion_eligibility_failure_reason.proto
index 88d01c55d..9ec8047f5 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/customer_pay_per_conversion_eligibility_failure_reason.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/customer_pay_per_conversion_eligibility_failure_reason.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomerPayPerConversionEligibilityFailureReasonProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing pay per conversion eligibility failure reasons.
@@ -61,6 +61,4 @@ message CustomerPayPerConversionEligibilityFailureReasonEnum {
// Customer is not eligible due to other reasons.
OTHER = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/customer_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/customer_status.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/customer_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/customer_status.proto
index 3712c8af4..7184bdc23 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/customer_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/customer_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomerStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing possible statuses of a customer.
message CustomerStatusEnum {
@@ -51,6 +51,4 @@ message CustomerStatusEnum {
// Status is permanent and may not be reopened.
CLOSED = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/customizer_attribute_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/customizer_attribute_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/customizer_attribute_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/customizer_attribute_status.proto
index ac79b1abe..0a3d6c20f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/customizer_attribute_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/customizer_attribute_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomizerAttributeStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing customizer attribute status.
@@ -43,6 +43,4 @@ message CustomizerAttributeStatusEnum {
// The customizer attribute is removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/customizer_attribute_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/customizer_attribute_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/customizer_attribute_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/customizer_attribute_type.proto
index 8b315afef..2bee0946f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/customizer_attribute_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/customizer_attribute_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomizerAttributeTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing customizer attribute type.
@@ -49,6 +49,4 @@ message CustomizerAttributeTypeEnum {
// Percentage customizer consisting of a number and a '%'.
PERCENT = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/customizer_value_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/customizer_value_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/customizer_value_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/customizer_value_status.proto
index 6a09e5beb..babdeb6de 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/customizer_value_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/customizer_value_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "CustomizerValueStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing customizer value status.
@@ -43,6 +43,4 @@ message CustomizerValueStatusEnum {
// The customizer value is removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/data_driven_model_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/data_driven_model_status.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/data_driven_model_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/data_driven_model_status.proto
index 15aa7be16..cc490df0b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/data_driven_model_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/data_driven_model_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "DataDrivenModelStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing data-driven model status.
@@ -55,6 +55,4 @@ message DataDrivenModelStatusEnum {
// period.
NEVER_GENERATED = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/day_of_week.proto b/third_party/googleapis/google/ads/googleads/v13/enums/day_of_week.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/enums/day_of_week.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/day_of_week.proto
index fa489e2f5..7951c9960 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/day_of_week.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/day_of_week.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "DayOfWeekProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing days of week.
-// Container for enumeration of days of the week, e.g., "Monday".
+// Container for enumeration of days of the week, for example, "Monday".
message DayOfWeekEnum {
- // Enumerates days of the week, e.g., "Monday".
+ // Enumerates days of the week, for example, "Monday".
enum DayOfWeek {
// Not specified.
UNSPECIFIED = 0;
@@ -58,6 +58,4 @@ message DayOfWeekEnum {
// Sunday.
SUNDAY = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/device.proto b/third_party/googleapis/google/ads/googleads/v13/enums/device.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/device.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/device.proto
index 18a6220d9..47ed4a128 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/device.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/device.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "DeviceProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing devices.
@@ -52,6 +52,4 @@ message DeviceEnum {
// Other device types.
OTHER = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/display_ad_format_setting.proto b/third_party/googleapis/google/ads/googleads/v13/enums/display_ad_format_setting.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/enums/display_ad_format_setting.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/display_ad_format_setting.proto
index dfa1fd59c..52397bd37 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/display_ad_format_setting.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/display_ad_format_setting.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "DisplayAdFormatSettingProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing display ad format settings.
@@ -43,10 +43,8 @@ message DisplayAdFormatSettingEnum {
// Text and image formats.
NON_NATIVE = 3;
- // Native format, i.e. the format rendering is controlled by the publisher
- // and not by Google.
+ // Native format, for example, the format rendering is controlled by the
+ // publisher and not by Google.
NATIVE = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/display_upload_product_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/display_upload_product_type.proto
similarity index 91%
rename from third_party/googleapis/google/ads/googleads/v10/enums/display_upload_product_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/display_upload_product_type.proto
index 197acf82f..98f55a0d7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/display_upload_product_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/display_upload_product_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "DisplayUploadProductTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing display upload product types.
@@ -90,6 +90,4 @@ message DisplayUploadProductTypeEnum {
// used in a hotel campaign.
DYNAMIC_HTML5_HOTEL_AD = 11;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/distance_bucket.proto b/third_party/googleapis/google/ads/googleads/v13/enums/distance_bucket.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/enums/distance_bucket.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/distance_bucket.proto
index 3ad59c380..0731adcc6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/distance_bucket.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/distance_bucket.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "DistanceBucketProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing distance buckets.
@@ -120,6 +120,4 @@ message DistanceBucketEnum {
// User was beyond 40 miles of the location.
BEYOND_40MILES = 28;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/dsa_page_feed_criterion_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/dsa_page_feed_criterion_field.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/dsa_page_feed_criterion_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/dsa_page_feed_criterion_field.proto
index 0530bba0e..d56258c1c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/dsa_page_feed_criterion_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/dsa_page_feed_criterion_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "DsaPageFeedCriterionFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Dynamic Search Ad Page Feed criterion fields.
@@ -44,6 +44,4 @@ message DsaPageFeedCriterionFieldEnum {
// your page feed.
LABEL = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/education_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/education_placeholder_field.proto
similarity index 88%
rename from third_party/googleapis/google/ads/googleads/v10/enums/education_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/education_placeholder_field.proto
index 4e9672aaf..e35647f6c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/education_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/education_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "EducationPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Education placeholder fields.
@@ -71,8 +71,8 @@ message EducationPlaceholderFieldEnum {
ALTERNATIVE_THUMBNAIL_IMAGE_URL = 10;
// Data Type: URL_LIST. Required. Final URLs to be used in ad when using
- // Upgraded URLs; the more specific the better (e.g. the individual URL of a
- // specific program and its location).
+ // Upgraded URLs; the more specific the better (for example, the individual
+ // URL of a specific program and its location).
FINAL_URLS = 11;
// Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded
@@ -104,6 +104,4 @@ message EducationPlaceholderFieldEnum {
// Data Type: INT64. iOS app store ID.
IOS_APP_STORE_ID = 18;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/experiment_metric.proto b/third_party/googleapis/google/ads/googleads/v13/enums/experiment_metric.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/enums/experiment_metric.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/experiment_metric.proto
index 0df2664b6..c4a37d544 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/experiment_metric.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/experiment_metric.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ExperimentMetricProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing experiment metric.
@@ -76,6 +76,4 @@ message ExperimentMetricEnum {
// The goal of the experiment is conversion value.
CONVERSION_VALUE = 14;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/experiment_metric_direction.proto b/third_party/googleapis/google/ads/googleads/v13/enums/experiment_metric_direction.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/experiment_metric_direction.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/experiment_metric_direction.proto
index 64f966f86..b2282c2a1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/experiment_metric_direction.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/experiment_metric_direction.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ExperimentMetricDirectionProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing experiment metric direction.
@@ -54,6 +54,4 @@ message ExperimentMetricDirectionEnum {
// metric.
NO_CHANGE_OR_DECREASE = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/experiment_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/experiment_status.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/experiment_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/experiment_status.proto
index cee57c22a..5e67bfcc7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/experiment_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/experiment_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ExperimentStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing experiment status.
@@ -60,6 +60,4 @@ message ExperimentStatusEnum {
// The experiment has been graduated.
GRADUATED = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/experiment_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/experiment_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/experiment_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/experiment_type.proto
index e938ccb02..5bc6c7cd3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/experiment_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/experiment_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ExperimentTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing experiment type.
@@ -43,9 +43,6 @@ message ExperimentTypeEnum {
// This is an ad variation experiment.
AD_VARIATION = 3;
- // This is a smart display experiment.
- SMART_DISPLAY = 4;
-
// A custom experiment consisting of Video campaigns.
YOUTUBE_CUSTOM = 5;
@@ -70,6 +67,4 @@ message ExperimentTypeEnum {
// A custom experiment consisting of hotel campaigns.
HOTEL_CUSTOM = 12;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/extension_setting_device.proto b/third_party/googleapis/google/ads/googleads/v13/enums/extension_setting_device.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/extension_setting_device.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/extension_setting_device.proto
index df81d6b06..d585dde50 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/extension_setting_device.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/extension_setting_device.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ExtensionSettingDeviceProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing extension setting device type.
@@ -45,6 +45,4 @@ message ExtensionSettingDeviceEnum {
// desktop devices.
DESKTOP = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/extension_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/extension_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/extension_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/extension_type.proto
index ce98bdcdd..8e4a82c4c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/extension_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/extension_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ExtensionTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing extension type.
@@ -77,6 +77,4 @@ message ExtensionTypeEnum {
// Image.
IMAGE = 16;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/external_conversion_source.proto b/third_party/googleapis/google/ads/googleads/v13/enums/external_conversion_source.proto
similarity index 94%
rename from third_party/googleapis/google/ads/googleads/v10/enums/external_conversion_source.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/external_conversion_source.proto
index e67dab06d..00454db9e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/external_conversion_source.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/external_conversion_source.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ExternalConversionSourceProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing the external conversion source that is
// associated with a ConversionAction.
@@ -148,6 +148,4 @@ message ExternalConversionSourceEnum {
// Conversion that is reported by Floodlight for DV360.
DISPLAY_AND_VIDEO_360_FLOODLIGHT = 34;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_attribute_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_attribute_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_attribute_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_attribute_type.proto
index 4b3b31bfb..46b048a1a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_attribute_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_attribute_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedAttributeTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed attribute type.
@@ -76,6 +76,4 @@ message FeedAttributeTypeEnum {
// Price.
PRICE = 14;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_quality_approval_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_quality_approval_status.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_item_quality_approval_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_item_quality_approval_status.proto
index 37549122a..bf43bbb3d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_quality_approval_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_quality_approval_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedItemQualityApprovalStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed item quality evaluation approval statuses.
@@ -45,6 +45,4 @@ message FeedItemQualityApprovalStatusEnum {
// the quality_disapproval_reasons field.
DISAPPROVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_quality_disapproval_reason.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_quality_disapproval_reason.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_item_quality_disapproval_reason.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_item_quality_disapproval_reason.proto
index c7a859b3a..a124c573a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_quality_disapproval_reason.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_quality_disapproval_reason.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedItemQualityDisapprovalReasonProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed item quality disapproval reasons.
@@ -92,6 +92,4 @@ message FeedItemQualityDisapprovalReasonEnum {
// Structured snippet contain promotional text.
STRUCTURED_SNIPPETS_HAS_PROMOTIONAL_TEXT = 19;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_set_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_set_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_item_set_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_item_set_status.proto
index 069785c77..53925eea3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_set_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_set_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedItemSetStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed item set status.
@@ -43,6 +43,4 @@ message FeedItemSetStatusEnum {
// Feed item set has been removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_set_string_filter_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_set_string_filter_type.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_item_set_string_filter_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_item_set_string_filter_type.proto
index b98df0b1c..de3f9098a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_set_string_filter_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_set_string_filter_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedItemSetStringFilterTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// The type of string matching to be used for a dynamic FeedItemSet filter.
message FeedItemSetStringFilterTypeEnum {
@@ -38,6 +38,4 @@ message FeedItemSetStringFilterTypeEnum {
// The dynamic set filter will use exact string matching.
EXACT = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_item_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_item_status.proto
index b265dc925..a5509de29 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedItemStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed item status.
@@ -43,6 +43,4 @@ message FeedItemStatusEnum {
// Feed item has been removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_target_device.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_target_device.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_item_target_device.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_item_target_device.proto
index 99ddc819c..6edf1a7a9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_target_device.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_target_device.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedItemTargetDeviceProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed item target device type.
@@ -41,6 +41,4 @@ message FeedItemTargetDeviceEnum {
// Mobile.
MOBILE = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_target_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_target_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_item_target_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_item_target_status.proto
index 1bda4ab1f..436213d78 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_target_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_target_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedItemTargetStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed item target status.
@@ -43,6 +43,4 @@ message FeedItemTargetStatusEnum {
// Feed item target has been removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_target_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_target_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_item_target_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_item_target_type.proto
index 609f84fc5..b9359a295 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_target_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_target_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedItemTargetTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed item target type status.
@@ -46,6 +46,4 @@ message FeedItemTargetTypeEnum {
// Feed item targets a criterion.
CRITERION = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_validation_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_validation_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_item_validation_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_item_validation_status.proto
index 739b996ab..e91700cbe 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_item_validation_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_item_validation_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedItemValidationStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed item validation statuses.
@@ -46,6 +46,4 @@ message FeedItemValidationStatusEnum {
// Feed item is semantically well-formed.
VALID = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_link_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_link_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_link_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_link_status.proto
index 23817d90d..a94550cab 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_link_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_link_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedLinkStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing status of a feed link.
@@ -43,6 +43,4 @@ message FeedLinkStatusEnum {
// Feed link has been removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_mapping_criterion_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_mapping_criterion_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_mapping_criterion_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_mapping_criterion_type.proto
index b5c54f79d..41a47a968 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_mapping_criterion_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_mapping_criterion_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedMappingCriterionTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing criterion types for feed mappings.
@@ -43,6 +43,4 @@ message FeedMappingCriterionTypeEnum {
// Allows url targeting for your dynamic search ads within a page feed.
DSA_PAGE_FEED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_mapping_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_mapping_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_mapping_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_mapping_status.proto
index 6d9d66044..1efc0c385 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_mapping_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_mapping_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedMappingStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed mapping status.
@@ -43,6 +43,4 @@ message FeedMappingStatusEnum {
// Feed mapping has been removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_origin.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_origin.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_origin.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_origin.proto
index 31536d414..c31054a51 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_origin.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_origin.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedOriginProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed origin.
@@ -46,6 +46,4 @@ message FeedOriginEnum {
// for the placeholder type of the feed.
GOOGLE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/feed_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/feed_status.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/feed_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/feed_status.proto
index 865e9c04a..76ba301d8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/feed_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/feed_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FeedStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed status.
@@ -43,6 +43,4 @@ message FeedStatusEnum {
// Feed has been removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/flight_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/flight_placeholder_field.proto
similarity index 92%
rename from third_party/googleapis/google/ads/googleads/v10/enums/flight_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/flight_placeholder_field.proto
index e3b37b483..9f5561412 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/flight_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/flight_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FlightsPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Flight placeholder fields.
@@ -111,6 +111,4 @@ message FlightPlaceholderFieldEnum {
// Data Type: INT64. iOS app store ID.
IOS_APP_STORE_ID = 18;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/frequency_cap_event_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/frequency_cap_event_type.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/enums/frequency_cap_event_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/frequency_cap_event_type.proto
index ca9d9966c..6e15f5b25 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/frequency_cap_event_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/frequency_cap_event_type.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FrequencyCapEventTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing frequency caps.
// Container for enum describing the type of event that the cap applies to.
message FrequencyCapEventTypeEnum {
- // The type of event that the cap applies to (e.g. impression).
+ // The type of event that the cap applies to (for example, impression).
enum FrequencyCapEventType {
// Not specified.
UNSPECIFIED = 0;
@@ -43,6 +43,4 @@ message FrequencyCapEventTypeEnum {
// The cap applies on video ad views.
VIDEO_VIEW = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/frequency_cap_level.proto b/third_party/googleapis/google/ads/googleads/v13/enums/frequency_cap_level.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/frequency_cap_level.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/frequency_cap_level.proto
index 98335ee25..eefb70972 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/frequency_cap_level.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/frequency_cap_level.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FrequencyCapLevelProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing frequency caps.
@@ -47,6 +47,4 @@ message FrequencyCapLevelEnum {
// The cap is applied at the campaign level.
CAMPAIGN = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/frequency_cap_time_unit.proto b/third_party/googleapis/google/ads/googleads/v13/enums/frequency_cap_time_unit.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/enums/frequency_cap_time_unit.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/frequency_cap_time_unit.proto
index 0be209f9f..d0be269a1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/frequency_cap_time_unit.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/frequency_cap_time_unit.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "FrequencyCapTimeUnitProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing frequency caps.
// Container for enum describing the unit of time the cap is defined at.
message FrequencyCapTimeUnitEnum {
- // Unit of time the cap is defined at (e.g. day, week).
+ // Unit of time the cap is defined at (for example, day, week).
enum FrequencyCapTimeUnit {
// Not specified.
UNSPECIFIED = 0;
@@ -46,6 +46,4 @@ message FrequencyCapTimeUnitEnum {
// The cap would define limit per one month.
MONTH = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/gender_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/gender_type.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/enums/gender_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/gender_type.proto
index d33c7485b..022a1338d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/gender_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/gender_type.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "GenderTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing gender types.
// Container for enum describing the type of demographic genders.
message GenderTypeEnum {
- // The type of demographic genders (e.g. female).
+ // The type of demographic genders (for example, female).
enum GenderType {
// Not specified.
UNSPECIFIED = 0;
@@ -46,6 +46,4 @@ message GenderTypeEnum {
// Undetermined gender.
UNDETERMINED = 20;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/geo_target_constant_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/geo_target_constant_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/geo_target_constant_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/geo_target_constant_status.proto
index 3d72398b1..8f7128f77 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/geo_target_constant_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/geo_target_constant_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "GeoTargetConstantStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing geo target constant statuses.
@@ -45,6 +45,4 @@ message GeoTargetConstantStatusEnum {
// The geo target constant is obsolete and will be removed.
REMOVAL_PLANNED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/geo_targeting_restriction.proto b/third_party/googleapis/google/ads/googleads/v13/enums/geo_targeting_restriction.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/geo_targeting_restriction.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/geo_targeting_restriction.proto
index 4fb38cfea..bbe20226b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/geo_targeting_restriction.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/geo_targeting_restriction.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "GeoTargetingRestrictionProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing GeoTargetingRestriction.
@@ -42,6 +42,4 @@ message GeoTargetingRestrictionEnum {
// the user.
LOCATION_OF_PRESENCE = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/geo_targeting_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/geo_targeting_type.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/geo_targeting_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/geo_targeting_type.proto
index 2f9a7fef6..604b9e648 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/geo_targeting_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/geo_targeting_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "GeoTargetingTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing geo targeting types.
@@ -43,6 +43,4 @@ message GeoTargetingTypeEnum {
// Location of the user issuing the query.
LOCATION_OF_PRESENCE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/goal_config_level.proto b/third_party/googleapis/google/ads/googleads/v13/enums/goal_config_level.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/goal_config_level.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/goal_config_level.proto
index 4fff18586..964a54db9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/goal_config_level.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/goal_config_level.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "GoalConfigLevelProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing goal config level.
@@ -45,6 +45,4 @@ message GoalConfigLevelEnum {
// The goal config is defined at the campaign level.
CAMPAIGN = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/google_ads_field_category.proto b/third_party/googleapis/google/ads/googleads/v13/enums/google_ads_field_category.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/google_ads_field_category.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/google_ads_field_category.proto
index a3b90ce93..7010d81c0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/google_ads_field_category.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/google_ads_field_category.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "GoogleAdsFieldCategoryProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing GoogleAdsField categories.
@@ -54,6 +54,4 @@ message GoogleAdsFieldCategoryEnum {
// search queries.
METRIC = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/google_ads_field_data_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/google_ads_field_data_type.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/enums/google_ads_field_data_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/google_ads_field_data_type.proto
index 7da3fac83..5a8985876 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/google_ads_field_data_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/google_ads_field_data_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "GoogleAdsFieldDataTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing GoogleAdsField data types.
@@ -95,6 +95,4 @@ message GoogleAdsFieldDataTypeEnum {
// Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN
UINT64 = 12;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/google_voice_call_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/google_voice_call_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/google_voice_call_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/google_voice_call_status.proto
index 22c2550c6..ebb1384ee 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/google_voice_call_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/google_voice_call_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "GoogleVoiceCallStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing google voice call status.
@@ -43,6 +43,4 @@ message GoogleVoiceCallStatusEnum {
// The call was received.
RECEIVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/hotel_asset_suggestion_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_asset_suggestion_status.proto
new file mode 100644
index 000000000..1d606d826
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_asset_suggestion_status.proto
@@ -0,0 +1,49 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "HotelAssetSuggestionStatusProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing hotel asset suggestion status.
+
+// Container for enum describing possible statuses of a hotel asset suggestion.
+message HotelAssetSuggestionStatusEnum {
+ // Possible statuses of a hotel asset suggestion.
+ enum HotelAssetSuggestionStatus {
+ // Enum unspecified.
+ UNSPECIFIED = 0;
+
+ // The received error code is not known in this version.
+ UNKNOWN = 1;
+
+ // The hotel asset suggestion was successfully retrieved.
+ SUCCESS = 2;
+
+ // A hotel look up returns nothing.
+ HOTEL_NOT_FOUND = 3;
+
+ // A Google Places ID is invalid and cannot be decoded.
+ INVALID_PLACE_ID = 4;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/hotel_date_selection_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_date_selection_type.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/hotel_date_selection_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/hotel_date_selection_type.proto
index 32b6de008..49fa601e6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/hotel_date_selection_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_date_selection_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "HotelDateSelectionTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing hotel date selection types.
@@ -43,6 +43,4 @@ message HotelDateSelectionTypeEnum {
// Dates selected by the user.
USER_SELECTED = 51;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/hotel_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_placeholder_field.proto
similarity index 92%
rename from third_party/googleapis/google/ads/googleads/v10/enums/hotel_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/hotel_placeholder_field.proto
index b3ce33317..96f5ce836 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/hotel_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "HotelsPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Hotel placeholder fields.
@@ -117,6 +117,4 @@ message HotelPlaceholderFieldEnum {
// Data Type: INT64. iOS app store ID.
IOS_APP_STORE_ID = 21;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/hotel_price_bucket.proto b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_price_bucket.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/hotel_price_bucket.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/hotel_price_bucket.proto
index 25b90373b..42e617397 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/hotel_price_bucket.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_price_bucket.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "HotelPriceBucketProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing hotel price buckets.
@@ -52,6 +52,4 @@ message HotelPriceBucketEnum {
// Partner was the only one shown.
ONLY_PARTNER_SHOWN = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/hotel_rate_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_rate_type.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/hotel_rate_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/hotel_rate_type.proto
index e12bea3b4..bfc166fd5 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/hotel_rate_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_rate_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "HotelRateTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing hotel rate types.
@@ -50,11 +50,9 @@ message HotelRateTypeEnum {
// https://developers.google.com/hotels/hotel-ads/dev-guide/qualified-rates
QUALIFIED_RATE = 4;
- // Rates available to users that satisfy some eligibility criteria. e.g.
- // all signed-in users, 20% of mobile users, all mobile users in Canada,
- // etc.
+ // Rates available to users that satisfy some eligibility criteria, for
+ // example, all signed-in users, 20% of mobile users, all mobile users in
+ // Canada, etc.
PRIVATE_RATE = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/hotel_reconciliation_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_reconciliation_status.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/enums/hotel_reconciliation_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/hotel_reconciliation_status.proto
index 84d802b37..25de334ec 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/hotel_reconciliation_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/hotel_reconciliation_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "HotelReconciliationStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing hotel reconciliation row status.
@@ -55,6 +55,4 @@ message HotelReconciliationStatusEnum {
// days after the check-out date.
CANCELED = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/image_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/image_placeholder_field.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/image_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/image_placeholder_field.proto
index 0290e8e05..fd2233687 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/image_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/image_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ImagePlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Advertiser Provided Image placeholder fields.
@@ -40,6 +40,4 @@ message ImagePlaceholderFieldEnum {
// Data Type: INT64. The asset ID of the image.
ASSET_ID = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/income_range_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/income_range_type.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/income_range_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/income_range_type.proto
index 2ebabb3a2..38ce1fb59 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/income_range_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/income_range_type.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "IncomeRangeTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing income range types.
// Container for enum describing the type of demographic income ranges.
message IncomeRangeTypeEnum {
- // The type of demographic income ranges (e.g. between 0% to 50%).
+ // The type of demographic income ranges (for example, between 0% to 50%).
enum IncomeRangeType {
// Not specified.
UNSPECIFIED = 0;
@@ -58,6 +58,4 @@ message IncomeRangeTypeEnum {
// Undetermined income range.
INCOME_RANGE_UNDETERMINED = 510000;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/interaction_event_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/interaction_event_type.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/interaction_event_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/interaction_event_type.proto
index 1168243c0..7d381aea2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/interaction_event_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/interaction_event_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "InteractionEventTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing types of payable and free interactions.
@@ -50,11 +50,9 @@ message InteractionEventTypeEnum {
// The default InteractionEventType for ad conversion events.
// This is used when an ad conversion row does NOT indicate
- // that the free interactions (i.e., the ad conversions)
+ // that the free interactions (for example, the ad conversions)
// should be 'promoted' and reported as part of the core metrics.
// These are simply other (ad) conversions.
NONE = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/interaction_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/interaction_type.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/interaction_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/interaction_type.proto
index d3cb3164e..5c1b24724 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/interaction_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/interaction_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "InteractionTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing interaction types.
@@ -40,6 +40,4 @@ message InteractionTypeEnum {
// Calls.
CALLS = 8000;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/invoice_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/invoice_type.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/invoice_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/invoice_type.proto
index d4f923915..d29e7a2f1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/invoice_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/invoice_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "InvoiceTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing invoice types.
@@ -43,6 +43,4 @@ message InvoiceTypeEnum {
// An invoice with a positive amount. The account owes a balance.
INVOICE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/job_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/job_placeholder_field.proto
similarity index 88%
rename from third_party/googleapis/google/ads/googleads/v10/enums/job_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/job_placeholder_field.proto
index f1c5d9943..a05f44912 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/job_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/job_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "JobsPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Job placeholder fields.
@@ -78,8 +78,8 @@ message JobPlaceholderFieldEnum {
SALARY = 11;
// Data Type: URL_LIST. Required. Final URLs to be used in ad when using
- // Upgraded URLs; the more specific the better (e.g. the individual URL of a
- // specific job and its location).
+ // Upgraded URLs; the more specific the better (for example, the individual
+ // URL of a specific job and its location).
FINAL_URLS = 12;
// Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded
@@ -108,6 +108,4 @@ message JobPlaceholderFieldEnum {
// Data Type: INT64. iOS app store ID.
IOS_APP_STORE_ID = 19;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_match_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_match_type.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/keyword_match_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/keyword_match_type.proto
index 3d90fa492..ff90f699a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_match_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_match_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "KeywordMatchTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Keyword match types.
@@ -46,6 +46,4 @@ message KeywordMatchTypeEnum {
// Broad match.
BROAD = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_aggregate_metric_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_aggregate_metric_type.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_aggregate_metric_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_aggregate_metric_type.proto
index 36c712439..1b07b6619 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_aggregate_metric_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_aggregate_metric_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanAggregateMetricTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing keyword plan aggregate metric types.
@@ -40,6 +40,4 @@ message KeywordPlanAggregateMetricTypeEnum {
// The device breakdown of aggregate search volume.
DEVICE = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_competition_level.proto b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_competition_level.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_competition_level.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_competition_level.proto
index 765ab35a8..71b3313af 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_competition_level.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_competition_level.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanCompetitionLevelProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Keyword Planner competition levels.
@@ -50,6 +50,4 @@ message KeywordPlanCompetitionLevelEnum {
// High competition. The Competition Index range for this is [67, 100].
HIGH = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_concept_group_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_concept_group_type.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_concept_group_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_concept_group_type.proto
index df2b4db35..e22ff6c84 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_concept_group_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_concept_group_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanConceptGroupTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Keyword Planner Concept Group types.
@@ -51,6 +51,4 @@ message KeywordPlanConceptGroupTypeEnum {
// returned for generic keywords that don't have a brand association.
NON_BRAND = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_forecast_interval.proto b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_forecast_interval.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_forecast_interval.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_forecast_interval.proto
index 1d793b1e9..466260658 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_forecast_interval.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_forecast_interval.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanForecastIntervalProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing keyword plan forecast intervals.
@@ -49,6 +49,4 @@ message KeywordPlanForecastIntervalEnum {
// The next quarter date range for keyword plan.
NEXT_QUARTER = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_keyword_annotation.proto b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_keyword_annotation.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_keyword_annotation.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_keyword_annotation.proto
index 1c7457817..bfdd93316 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_keyword_annotation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_keyword_annotation.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanKeywordAnnotationProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Keyword Planner Keyword annotation types.
@@ -40,6 +40,4 @@ message KeywordPlanKeywordAnnotationEnum {
// Return the keyword concept and concept group data.
KEYWORD_CONCEPT = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_network.proto b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_network.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_network.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_network.proto
index 92f78c581..c474f3c67 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/keyword_plan_network.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/keyword_plan_network.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanNetworkProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Keyword Planner forecastable network types.
@@ -43,6 +43,4 @@ message KeywordPlanNetworkEnum {
// Google Search + Search partners.
GOOGLE_SEARCH_AND_PARTNERS = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/label_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/label_status.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/enums/label_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/label_status.proto
index 1ae1162eb..9d84a99e6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/label_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/label_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "LabelStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing possible status of a label.
message LabelStatusEnum {
@@ -41,6 +41,4 @@ message LabelStatusEnum {
// Label is removed.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/lead_form_call_to_action_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/lead_form_call_to_action_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/lead_form_call_to_action_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/lead_form_call_to_action_type.proto
index 5446efd31..3e6c3b2a2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/lead_form_call_to_action_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/lead_form_call_to_action_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "LeadFormCallToActionTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Describes the type of call-to-action phrases in a lead form.
message LeadFormCallToActionTypeEnum {
@@ -77,6 +77,4 @@ message LeadFormCallToActionTypeEnum {
// Get started.
GET_STARTED = 15;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/lead_form_desired_intent.proto b/third_party/googleapis/google/ads/googleads/v13/enums/lead_form_desired_intent.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/enums/lead_form_desired_intent.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/lead_form_desired_intent.proto
index 5a5c81b3c..b44be7267 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/lead_form_desired_intent.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/lead_form_desired_intent.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "LeadFormDesiredIntentProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
-// Describes the desired level of intent of generated leads.
+// Describes the chosen level of intent of generated leads.
message LeadFormDesiredIntentEnum {
- // Enum describing the desired level of intent of generated leads.
+ // Enum describing the chosen level of intent of generated leads.
enum LeadFormDesiredIntent {
// Not specified.
UNSPECIFIED = 0;
@@ -41,6 +41,4 @@ message LeadFormDesiredIntentEnum {
// Deliver leads that are more qualified.
HIGH_INTENT = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/lead_form_field_user_input_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/lead_form_field_user_input_type.proto
new file mode 100644
index 000000000..bbad4bcbd
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/lead_form_field_user_input_type.proto
@@ -0,0 +1,675 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "LeadFormFieldUserInputTypeProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Describes the input type of a lead form field.
+message LeadFormFieldUserInputTypeEnum {
+ // Enum describing the input type of a lead form field.
+ enum LeadFormFieldUserInputType {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // The user will be asked to fill in their given and family name. This field
+ // cannot be set at the same time as GIVEN_NAME or FAMILY_NAME.
+ FULL_NAME = 2;
+
+ // The user will be asked to fill in their email address.
+ EMAIL = 3;
+
+ // The user will be asked to fill in their phone number.
+ PHONE_NUMBER = 4;
+
+ // The user will be asked to fill in their zip code.
+ POSTAL_CODE = 5;
+
+ // The user will be asked to fill in their street address.
+ STREET_ADDRESS = 8;
+
+ // The user will be asked to fill in their city.
+ CITY = 9;
+
+ // The user will be asked to fill in their region part of the address (for
+ // example, state for US, province for Canada).
+ REGION = 10;
+
+ // The user will be asked to fill in their country.
+ COUNTRY = 11;
+
+ // The user will be asked to fill in their work email address.
+ WORK_EMAIL = 12;
+
+ // The user will be asked to fill in their company name.
+ COMPANY_NAME = 13;
+
+ // The user will be asked to fill in their work phone.
+ WORK_PHONE = 14;
+
+ // The user will be asked to fill in their job title.
+ JOB_TITLE = 15;
+
+ // The user will be asked to fill in their CPF for Brazil users.
+ GOVERNMENT_ISSUED_ID_CPF_BR = 16;
+
+ // The user will be asked to fill in their DNI for Argentina users.
+ GOVERNMENT_ISSUED_ID_DNI_AR = 17;
+
+ // The user will be asked to fill in their DNI for Peru users.
+ GOVERNMENT_ISSUED_ID_DNI_PE = 18;
+
+ // The user will be asked to fill in their RUT for Chile users.
+ GOVERNMENT_ISSUED_ID_RUT_CL = 19;
+
+ // The user will be asked to fill in their CC for Colombia users.
+ GOVERNMENT_ISSUED_ID_CC_CO = 20;
+
+ // The user will be asked to fill in their CI for Ecuador users.
+ GOVERNMENT_ISSUED_ID_CI_EC = 21;
+
+ // The user will be asked to fill in their RFC for Mexico users.
+ GOVERNMENT_ISSUED_ID_RFC_MX = 22;
+
+ // The user will be asked to fill in their first name. This
+ // field can not be set at the same time as FULL_NAME.
+ FIRST_NAME = 23;
+
+ // The user will be asked to fill in their last name. This
+ // field can not be set at the same time as FULL_NAME.
+ LAST_NAME = 24;
+
+ // Question: "Which model are you interested in?"
+ // Category: "Auto"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ VEHICLE_MODEL = 1001;
+
+ // Question: "Which type of vehicle are you interested in?"
+ // Category: "Auto"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ VEHICLE_TYPE = 1002;
+
+ // Question: "What is your preferred dealership?"
+ // Category: "Auto"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ PREFERRED_DEALERSHIP = 1003;
+
+ // Question: "When do you plan on purchasing a vehicle?"
+ // Category: "Auto"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ VEHICLE_PURCHASE_TIMELINE = 1004;
+
+ // Question: "Do you own a vehicle?"
+ // Category: "Auto"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ VEHICLE_OWNERSHIP = 1005;
+
+ // Question: "What vehicle ownership option are you interested in?"
+ // Category: "Auto"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ VEHICLE_PAYMENT_TYPE = 1009;
+
+ // Question: "What type of vehicle condition are you interested in?"
+ // Category: "Auto"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ VEHICLE_CONDITION = 1010;
+
+ // Question: "What size is your company?"
+ // Category: "Business"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ COMPANY_SIZE = 1006;
+
+ // Question: "What is your annual sales volume?"
+ // Category: "Business"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ ANNUAL_SALES = 1007;
+
+ // Question: "How many years have you been in business?"
+ // Category: "Business"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ YEARS_IN_BUSINESS = 1008;
+
+ // Question: "What is your job department?"
+ // Category: "Business"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ JOB_DEPARTMENT = 1011;
+
+ // Question: "What is your job role?"
+ // Category: "Business"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ JOB_ROLE = 1012;
+
+ // Question: "Are you over 18 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_18_AGE = 1078;
+
+ // Question: "Are you over 19 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_19_AGE = 1079;
+
+ // Question: "Are you over 20 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_20_AGE = 1080;
+
+ // Question: "Are you over 21 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_21_AGE = 1081;
+
+ // Question: "Are you over 22 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_22_AGE = 1082;
+
+ // Question: "Are you over 23 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_23_AGE = 1083;
+
+ // Question: "Are you over 24 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_24_AGE = 1084;
+
+ // Question: "Are you over 25 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_25_AGE = 1085;
+
+ // Question: "Are you over 26 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_26_AGE = 1086;
+
+ // Question: "Are you over 27 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_27_AGE = 1087;
+
+ // Question: "Are you over 28 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_28_AGE = 1088;
+
+ // Question: "Are you over 29 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_29_AGE = 1089;
+
+ // Question: "Are you over 30 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_30_AGE = 1090;
+
+ // Question: "Are you over 31 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_31_AGE = 1091;
+
+ // Question: "Are you over 32 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_32_AGE = 1092;
+
+ // Question: "Are you over 33 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_33_AGE = 1093;
+
+ // Question: "Are you over 34 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_34_AGE = 1094;
+
+ // Question: "Are you over 35 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_35_AGE = 1095;
+
+ // Question: "Are you over 36 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_36_AGE = 1096;
+
+ // Question: "Are you over 37 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_37_AGE = 1097;
+
+ // Question: "Are you over 38 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_38_AGE = 1098;
+
+ // Question: "Are you over 39 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_39_AGE = 1099;
+
+ // Question: "Are you over 40 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_40_AGE = 1100;
+
+ // Question: "Are you over 41 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_41_AGE = 1101;
+
+ // Question: "Are you over 42 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_42_AGE = 1102;
+
+ // Question: "Are you over 43 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_43_AGE = 1103;
+
+ // Question: "Are you over 44 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_44_AGE = 1104;
+
+ // Question: "Are you over 45 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_45_AGE = 1105;
+
+ // Question: "Are you over 46 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_46_AGE = 1106;
+
+ // Question: "Are you over 47 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_47_AGE = 1107;
+
+ // Question: "Are you over 48 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_48_AGE = 1108;
+
+ // Question: "Are you over 49 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_49_AGE = 1109;
+
+ // Question: "Are you over 50 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_50_AGE = 1110;
+
+ // Question: "Are you over 51 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_51_AGE = 1111;
+
+ // Question: "Are you over 52 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_52_AGE = 1112;
+
+ // Question: "Are you over 53 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_53_AGE = 1113;
+
+ // Question: "Are you over 54 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_54_AGE = 1114;
+
+ // Question: "Are you over 55 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_55_AGE = 1115;
+
+ // Question: "Are you over 56 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_56_AGE = 1116;
+
+ // Question: "Are you over 57 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_57_AGE = 1117;
+
+ // Question: "Are you over 58 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_58_AGE = 1118;
+
+ // Question: "Are you over 59 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_59_AGE = 1119;
+
+ // Question: "Are you over 60 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_60_AGE = 1120;
+
+ // Question: "Are you over 61 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_61_AGE = 1121;
+
+ // Question: "Are you over 62 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_62_AGE = 1122;
+
+ // Question: "Are you over 63 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_63_AGE = 1123;
+
+ // Question: "Are you over 64 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_64_AGE = 1124;
+
+ // Question: "Are you over 65 years of age?"
+ // Category: "Demographics"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OVER_65_AGE = 1125;
+
+ // Question: "Which program are you interested in?"
+ // Category: "Education"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ EDUCATION_PROGRAM = 1013;
+
+ // Question: "Which course are you interested in?"
+ // Category: "Education"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ EDUCATION_COURSE = 1014;
+
+ // Question: "Which product are you interested in?"
+ // Category: "General"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ PRODUCT = 1016;
+
+ // Question: "Which service are you interested in?"
+ // Category: "General"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ SERVICE = 1017;
+
+ // Question: "Which offer are you interested in?"
+ // Category: "General"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ OFFER = 1018;
+
+ // Question: "Which category are you interested in?"
+ // Category: "General"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ CATEGORY = 1019;
+
+ // Question: "What is your preferred method of contact?"
+ // Category: "General"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ PREFERRED_CONTACT_METHOD = 1020;
+
+ // Question: "What is your preferred location?"
+ // Category: "General"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ PREFERRED_LOCATION = 1021;
+
+ // Question: "What is the best time to contact you?"
+ // Category: "General"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ PREFERRED_CONTACT_TIME = 1022;
+
+ // Question: "When are you looking to make a purchase?"
+ // Category: "General"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ PURCHASE_TIMELINE = 1023;
+
+ // Question: "How many years of work experience do you have?"
+ // Category: "Jobs"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ YEARS_OF_EXPERIENCE = 1048;
+
+ // Question: "What industry do you work in?"
+ // Category: "Jobs"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ JOB_INDUSTRY = 1049;
+
+ // Question: "What is your highest level of education?"
+ // Category: "Jobs"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ LEVEL_OF_EDUCATION = 1050;
+
+ // Question: "What type of property are you looking for?"
+ // Category: "Real Estate"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ PROPERTY_TYPE = 1024;
+
+ // Question: "What do you need a realtor's help with?"
+ // Category: "Real Estate"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ REALTOR_HELP_GOAL = 1025;
+
+ // Question: "What neighborhood are you interested in?"
+ // Category: "Real Estate"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ PROPERTY_COMMUNITY = 1026;
+
+ // Question: "What price range are you looking for?"
+ // Category: "Real Estate"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ PRICE_RANGE = 1027;
+
+ // Question: "How many bedrooms are you looking for?"
+ // Category: "Real Estate"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ NUMBER_OF_BEDROOMS = 1028;
+
+ // Question: "Are you looking for a fully furnished property?"
+ // Category: "Real Estate"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ FURNISHED_PROPERTY = 1029;
+
+ // Question: "Are you looking for properties that allow pets?"
+ // Category: "Real Estate"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ PETS_ALLOWED_PROPERTY = 1030;
+
+ // Question: "What is the next product you plan to purchase?"
+ // Category: "Retail"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ NEXT_PLANNED_PURCHASE = 1031;
+
+ // Question: "Would you like to sign up for an event?"
+ // Category: "Retail"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ EVENT_SIGNUP_INTEREST = 1033;
+
+ // Question: "Where are you interested in shopping?"
+ // Category: "Retail"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ PREFERRED_SHOPPING_PLACES = 1034;
+
+ // Question: "What is your favorite brand?"
+ // Category: "Retail"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ FAVORITE_BRAND = 1035;
+
+ // Question: "Which type of valid commercial license do you have?"
+ // Category: "Transportation"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ TRANSPORTATION_COMMERCIAL_LICENSE_TYPE = 1036;
+
+ // Question: "Interested in booking an event?"
+ // Category: "Travel"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ EVENT_BOOKING_INTEREST = 1038;
+
+ // Question: "What is your destination country?"
+ // Category: "Travel"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ DESTINATION_COUNTRY = 1039;
+
+ // Question: "What is your destination city?"
+ // Category: "Travel"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ DESTINATION_CITY = 1040;
+
+ // Question: "What is your departure country?"
+ // Category: "Travel"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ DEPARTURE_COUNTRY = 1041;
+
+ // Question: "What is your departure city?"
+ // Category: "Travel"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ DEPARTURE_CITY = 1042;
+
+ // Question: "What is your departure date?"
+ // Category: "Travel"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ DEPARTURE_DATE = 1043;
+
+ // Question: "What is your return date?"
+ // Category: "Travel"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ RETURN_DATE = 1044;
+
+ // Question: "How many people are you traveling with?"
+ // Category: "Travel"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ NUMBER_OF_TRAVELERS = 1045;
+
+ // Question: "What is your travel budget?"
+ // Category: "Travel"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ TRAVEL_BUDGET = 1046;
+
+ // Question: "Where do you want to stay during your travel?"
+ // Category: "Travel"
+ // This field is subject to a limit of 5 qualifying questions per form and
+ // cannot be used if values are set using custom_question_fields.
+ TRAVEL_ACCOMMODATION = 1047;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/lead_form_post_submit_call_to_action_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/lead_form_post_submit_call_to_action_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/lead_form_post_submit_call_to_action_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/lead_form_post_submit_call_to_action_type.proto
index 7dcf79e99..79e5f80ac 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/lead_form_post_submit_call_to_action_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/lead_form_post_submit_call_to_action_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "LeadFormPostSubmitCallToActionTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Describes the type of post-submit call-to-action phrases for a lead form.
message LeadFormPostSubmitCallToActionTypeEnum {
@@ -48,6 +48,4 @@ message LeadFormPostSubmitCallToActionTypeEnum {
// Shop now.
SHOP_NOW = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/legacy_app_install_ad_app_store.proto b/third_party/googleapis/google/ads/googleads/v13/enums/legacy_app_install_ad_app_store.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/legacy_app_install_ad_app_store.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/legacy_app_install_ad_app_store.proto
index d25299ef4..7e83ab10a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/legacy_app_install_ad_app_store.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/legacy_app_install_ad_app_store.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "LegacyAppInstallAdAppStoreProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing app store types for a legacy app install ad.
@@ -52,6 +52,4 @@ message LegacyAppInstallAdAppStoreEnum {
// The app is hosted in a Chinese app store.
CN_APP_STORE = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/linked_account_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/linked_account_type.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/enums/linked_account_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/linked_account_type.proto
index 44c016dec..a56f24077 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/linked_account_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/linked_account_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "LinkedAccountTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing different types of Linked accounts.
message LinkedAccountTypeEnum {
@@ -47,7 +47,10 @@ message LinkedAccountTypeEnum {
// A link to Hotel Center.
HOTEL_CENTER = 5;
- }
-
+ // A link to Google Ads account of the partner advertiser.
+ // Increase performance and share data by partnering with businesses that
+ // advertise the same items.
+ ADVERTISING_PARTNER = 6;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/linked_product_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/linked_product_type.proto
new file mode 100644
index 000000000..7a3a63d13
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/linked_product_type.proto
@@ -0,0 +1,45 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "LinkedProductTypeProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Container for enum describing different types of linked products.
+message LinkedProductTypeEnum {
+ // Describes the possible link types for a link between a Google
+ // Ads customer and another product.
+ enum LinkedProductType {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // A link to Data partner.
+ DATA_PARTNER = 2;
+
+ // A link to Google Ads.
+ GOOGLE_ADS = 3;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_bidding_category_level.proto b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_bidding_category_level.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_bidding_category_level.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_bidding_category_level.proto
index e88df09e7..96fc77776 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_bidding_category_level.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_bidding_category_level.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ListingGroupFilterBiddingCategoryLevelProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing listing groups.
@@ -53,6 +53,4 @@ message ListingGroupFilterBiddingCategoryLevelEnum {
// Level 5.
LEVEL5 = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_custom_attribute_index.proto b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_custom_attribute_index.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_custom_attribute_index.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_custom_attribute_index.proto
index f81d1a401..0ff519aa1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_custom_attribute_index.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_custom_attribute_index.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ListingGroupFilterCustomAttributeIndexProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing listing groups.
@@ -53,6 +53,4 @@ message ListingGroupFilterCustomAttributeIndexEnum {
// Fifth listing group filter custom attribute.
INDEX4 = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_product_channel.proto b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_product_channel.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_product_channel.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_product_channel.proto
index 26419f231..9971aa6d6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_product_channel.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_product_channel.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ListingGroupFilterProductChannelProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing listing groups.
@@ -43,6 +43,4 @@ message ListingGroupFilterProductChannelEnum {
// The item is sold in local stores.
LOCAL = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_product_condition.proto b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_product_condition.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_product_condition.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_product_condition.proto
index cd114cbd0..bd0aea416 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_product_condition.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_product_condition.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ListingGroupFilterProductConditionProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing listing groups.
@@ -46,6 +46,4 @@ message ListingGroupFilterProductConditionEnum {
// The product condition is used.
USED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_product_type_level.proto b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_product_type_level.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_product_type_level.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_product_type_level.proto
index 8c7ecb2a7..7e6a29ead 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_product_type_level.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_product_type_level.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ListingGroupFilterProductTypeLevelProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing listing groups.
@@ -52,6 +52,4 @@ message ListingGroupFilterProductTypeLevelEnum {
// Level 5.
LEVEL5 = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_type_enum.proto b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_type_enum.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_type_enum.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_type_enum.proto
index bcb8a5e16..a7db4ae61 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_type_enum.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_type_enum.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ListingGroupFilterTypeEnumProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing listing groups.
@@ -46,6 +46,4 @@ message ListingGroupFilterTypeEnum {
// An excluded listing group filter leaf node.
UNIT_EXCLUDED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_vertical.proto b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_vertical.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_vertical.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_vertical.proto
index efcd165bd..953193960 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_filter_vertical.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_filter_vertical.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ListingGroupFilterVerticalProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing listing groups.
@@ -41,6 +41,4 @@ message ListingGroupFilterVerticalEnum {
// Represents the shopping vertical.
SHOPPING = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/listing_group_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/listing_group_type.proto
index 06ff0368c..d78084636 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/listing_group_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/listing_group_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ListingGroupTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing listing groups.
@@ -45,6 +45,4 @@ message ListingGroupTypeEnum {
// Listing group unit that defines a bid.
UNIT = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/local_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/local_placeholder_field.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/enums/local_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/local_placeholder_field.proto
index b3b44493a..c865671a3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/local_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/local_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "LocalPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Local placeholder fields.
@@ -82,8 +82,8 @@ message LocalPlaceholderFieldEnum {
CONTEXTUAL_KEYWORDS = 13;
// Data Type: URL_LIST. Required. Final URLs to be used in ad when using
- // Upgraded URLs; the more specific the better (e.g. the individual URL of a
- // specific local deal and its location).
+ // Upgraded URLs; the more specific the better (for example, the individual
+ // URL of a specific local deal and its location).
FINAL_URLS = 14;
// Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded
@@ -112,6 +112,4 @@ message LocalPlaceholderFieldEnum {
// Data Type: INT64. iOS app store ID.
IOS_APP_STORE_ID = 20;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/location_extension_targeting_criterion_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/location_extension_targeting_criterion_field.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/location_extension_targeting_criterion_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/location_extension_targeting_criterion_field.proto
index 12163ae42..34afb2d4e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/location_extension_targeting_criterion_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/location_extension_targeting_criterion_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "LocationExtensionTargetingCriterionFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Location Extension Targeting criterion fields.
@@ -55,6 +55,4 @@ message LocationExtensionTargetingCriterionFieldEnum {
// Data Type: STRING. Country code of the business address.
COUNTRY_CODE = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/location_group_radius_units.proto b/third_party/googleapis/google/ads/googleads/v13/enums/location_group_radius_units.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/enums/location_group_radius_units.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/location_group_radius_units.proto
index c8c35b586..059785052 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/location_group_radius_units.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/location_group_radius_units.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "LocationGroupRadiusUnitsProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing location group radius units.
// Container for enum describing unit of radius in location group.
message LocationGroupRadiusUnitsEnum {
- // The unit of radius distance in location group (e.g. MILES)
+ // The unit of radius distance in location group (for example, MILES)
enum LocationGroupRadiusUnits {
// Not specified.
UNSPECIFIED = 0;
@@ -46,6 +46,4 @@ message LocationGroupRadiusUnitsEnum {
// Milli Miles
MILLI_MILES = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/location_ownership_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/location_ownership_type.proto
new file mode 100644
index 000000000..54e8254eb
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/location_ownership_type.proto
@@ -0,0 +1,46 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "LocationOwnershipTypeProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing location ownership type.
+
+// Container for enum describing possible types of a location ownership.
+message LocationOwnershipTypeEnum {
+ // Possible types of a location ownership.
+ enum LocationOwnershipType {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // Business Owner of location(legacy location extension - LE).
+ BUSINESS_OWNER = 2;
+
+ // Affiliate location(Third party location extension - ALE).
+ AFFILIATE = 3;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/location_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/location_placeholder_field.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/location_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/location_placeholder_field.proto
index bfc974653..08f6e935e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/location_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/location_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "LocationPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Location placeholder fields.
@@ -61,6 +61,4 @@ message LocationPlaceholderFieldEnum {
// Data Type: STRING. Phone number of the business.
PHONE_NUMBER = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/location_source_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/location_source_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/location_source_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/location_source_type.proto
index e46671e80..1f1ba5a48 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/location_source_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/location_source_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "LocationSourceTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing location source types.
@@ -43,6 +43,4 @@ message LocationSourceTypeEnum {
// Affiliate (chain) store locations. For example, Best Buy store locations.
AFFILIATE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/preferred_content_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/location_string_filter_type.proto
similarity index 51%
rename from third_party/googleapis/google/ads/googleads/v10/enums/preferred_content_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/location_string_filter_type.proto
index fb7650370..86a9921d7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/preferred_content_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/location_string_filter_type.proto
@@ -14,32 +14,30 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
-option java_outer_classname = "PreferredContentTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_outer_classname = "LocationStringFilterTypeProto";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
-// Proto file describing preferred content criterion type.
+// Proto file describing location string filter type.
-// Container for enumeration of preferred content criterion type.
-message PreferredContentTypeEnum {
- // Enumerates preferred content criterion type.
- enum PreferredContentType {
+// Container for enum describing possible types of a location string filter.
+message LocationStringFilterTypeEnum {
+ // Possible types of a location string filter.
+ enum LocationStringFilterType {
// Not specified.
UNSPECIFIED = 0;
- // The value is unknown in this version.
+ // Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
- // Represents top content on YouTube.
- YOUTUBE_TOP_CONTENT = 400;
+ // The filter will use exact string matching.
+ EXACT = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/manager_link_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/manager_link_status.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/manager_link_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/manager_link_status.proto
index cd6ceb07e..fb58de29a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/manager_link_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/manager_link_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ManagerLinkStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing possible status of a manager and client link.
message ManagerLinkStatusEnum {
@@ -52,6 +52,4 @@ message ManagerLinkStatusEnum {
// canceled it.
CANCELED = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/matching_function_context_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/matching_function_context_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/matching_function_context_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/matching_function_context_type.proto
index 31c0a2441..79f52555c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/matching_function_context_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/matching_function_context_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "MatchingFunctionContextTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing matching function context types.
@@ -46,6 +46,4 @@ message MatchingFunctionContextTypeEnum {
// Feed item set id in the request context.
FEED_ITEM_SET_ID = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/matching_function_operator.proto b/third_party/googleapis/google/ads/googleads/v13/enums/matching_function_operator.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/matching_function_operator.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/matching_function_operator.proto
index cebe3e656..127e6b764 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/matching_function_operator.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/matching_function_operator.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "MatchingFunctionOperatorProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing matching function operators.
@@ -58,6 +58,4 @@ message MatchingFunctionOperatorEnum {
// ConstantOperands.
CONTAINS_ANY = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/media_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/media_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/media_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/media_type.proto
index fa724f3e6..bdebda025 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/media_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/media_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "MediaTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing media types.
@@ -57,6 +57,4 @@ message MediaTypeEnum {
// Animated image, such as animated GIF.
DYNAMIC_IMAGE = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/merchant_center_link_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/merchant_center_link_status.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/merchant_center_link_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/merchant_center_link_status.proto
index 01056e08d..3fd77501e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/merchant_center_link_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/merchant_center_link_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "MerchantCenterLinkStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Merchant Center link statuses.
@@ -46,6 +46,4 @@ message MerchantCenterLinkStatusEnum {
// owner and hasn't been confirmed by the customer.
PENDING = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/message_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/message_placeholder_field.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/message_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/message_placeholder_field.proto
index e5cabec81..22d2e889a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/message_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/message_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "MessagePlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Message placeholder fields.
@@ -54,6 +54,4 @@ message MessagePlaceholderFieldEnum {
// messaging apps when they tap to send you a message.
MESSAGE_TEXT = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/mime_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/mime_type.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/mime_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/mime_type.proto
index 641dc3b8b..0d3283b89 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/mime_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/mime_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "MimeTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing mime types.
@@ -75,6 +75,4 @@ message MimeTypeEnum {
// MIME type of application/x-html5-ad-zip.
HTML5_AD_ZIP = 13;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/minute_of_hour.proto b/third_party/googleapis/google/ads/googleads/v13/enums/minute_of_hour.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/enums/minute_of_hour.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/minute_of_hour.proto
index 51ae76b99..da475f398 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/minute_of_hour.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/minute_of_hour.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "MinuteOfHourProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing days of week.
// Container for enumeration of quarter-hours.
message MinuteOfHourEnum {
- // Enumerates of quarter-hours. E.g. "FIFTEEN"
+ // Enumerates of quarter-hours. For example, "FIFTEEN"
enum MinuteOfHour {
// Not specified.
UNSPECIFIED = 0;
@@ -49,6 +49,4 @@ message MinuteOfHourEnum {
// Forty-five minutes past the hour.
FORTY_FIVE = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/mobile_app_vendor.proto b/third_party/googleapis/google/ads/googleads/v13/enums/mobile_app_vendor.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/mobile_app_vendor.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/mobile_app_vendor.proto
index 33f1a9e44..5e4b12957 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/mobile_app_vendor.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/mobile_app_vendor.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "MobileAppVendorProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing different types of mobile app vendors.
message MobileAppVendorEnum {
@@ -41,6 +41,4 @@ message MobileAppVendorEnum {
// Mobile app vendor for Google app store.
GOOGLE_APP_STORE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/mobile_device_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/mobile_device_type.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/mobile_device_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/mobile_device_type.proto
index 402b434af..0496050f2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/mobile_device_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/mobile_device_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "MobileDeviceTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing mobile device types.
@@ -43,6 +43,4 @@ message MobileDeviceTypeEnum {
// Tablets.
TABLET = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/month_of_year.proto b/third_party/googleapis/google/ads/googleads/v13/enums/month_of_year.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/enums/month_of_year.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/month_of_year.proto
index bd6bbaed2..28a697776 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/month_of_year.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/month_of_year.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "MonthOfYearProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing days of week.
-// Container for enumeration of months of the year, e.g., "January".
+// Container for enumeration of months of the year, for example, "January".
message MonthOfYearEnum {
- // Enumerates months of the year, e.g., "January".
+ // Enumerates months of the year, for example, "January".
enum MonthOfYear {
// Not specified.
UNSPECIFIED = 0;
@@ -73,6 +73,4 @@ message MonthOfYearEnum {
// December.
DECEMBER = 13;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/negative_geo_target_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/negative_geo_target_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/negative_geo_target_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/negative_geo_target_type.proto
index 434e76d79..72ffe75da 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/negative_geo_target_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/negative_geo_target_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "NegativeGeoTargetTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing negative geo target types.
@@ -45,6 +45,4 @@ message NegativeGeoTargetTypeEnum {
// are in advertiser's excluded locations.
PRESENCE = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_failure_reason.proto b/third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_failure_reason.proto
similarity index 55%
rename from third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_failure_reason.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_failure_reason.proto
index 1607d4b30..c3b30d1c4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_failure_reason.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_failure_reason.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "OfflineUserDataJobFailureReasonProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing offline user data job failure reasons.
@@ -43,7 +43,20 @@ message OfflineUserDataJobFailureReasonEnum {
// The uploaded transactions are insufficient.
INSUFFICIENT_TRANSACTIONS = 3;
- }
+ // The average transaction value is unusually high for your account. If this
+ // is intended, contact support to request an exception. Learn more at
+ // https://support.google.com/google-ads/answer/10018944#transaction_value
+ HIGH_AVERAGE_TRANSACTION_VALUE = 4;
+
+ // The average transaction value is unusually low for your account. If this
+ // is intended, contact support to request an exception. Learn more at
+ // https://support.google.com/google-ads/answer/10018944#transaction_value
+ LOW_AVERAGE_TRANSACTION_VALUE = 5;
+ // There's a currency code that you haven't used before in your uploads. If
+ // this is intended, contact support to request an exception. Learn more at
+ // https://support.google.com/google-ads/answer/10018944#Unrecognized_currency
+ NEWLY_OBSERVED_CURRENCY_CODE = 6;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_match_rate_range.proto b/third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_match_rate_range.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_match_rate_range.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_match_rate_range.proto
index 98cc0a882..73635d7a3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_match_rate_range.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_match_rate_range.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "OfflineUserDataJobMatchRateRangeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing reasons match rate ranges for a customer match
// list upload.
@@ -60,10 +60,8 @@ message OfflineUserDataJobMatchRateRangeEnum {
// Match rate range for offline data upload entity is between 81% and 90%.
MATCH_RANGE_81_TO_90 = 9;
- // Match rate range for offline data upload entity more than or equal to
+ // Match rate range for offline data upload entity is more than or equal to
// 91%.
MATCH_RANGE_91_TO_100 = 10;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_status.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_status.proto
index 1df6dfa6d..83180ae32 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "OfflineUserDataJobStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing offline user data job status.
@@ -49,6 +49,4 @@ message OfflineUserDataJobStatusEnum {
// Uploaded data has failed to be processed.
FAILED = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_type.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_type.proto
index d6893c3f8..8095ec9c4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/offline_user_data_job_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/offline_user_data_job_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "OfflineUserDataJobTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing offline user data job types.
@@ -49,6 +49,4 @@ message OfflineUserDataJobTypeEnum {
// Customer Match with attribute data.
CUSTOMER_MATCH_WITH_ATTRIBUTES = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/operating_system_version_operator_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/operating_system_version_operator_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/operating_system_version_operator_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/operating_system_version_operator_type.proto
index d9435aa90..125a6b77a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/operating_system_version_operator_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/operating_system_version_operator_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "OperatingSystemVersionOperatorTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing operating system version operator types.
@@ -43,6 +43,4 @@ message OperatingSystemVersionOperatorTypeEnum {
// Greater than or equals to the specified version.
GREATER_THAN_EQUALS_TO = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/optimization_goal_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/optimization_goal_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/optimization_goal_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/optimization_goal_type.proto
index 85388c944..fa590c058 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/optimization_goal_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/optimization_goal_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "OptimizationGoalTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing optimization goal type.
@@ -51,6 +51,4 @@ message OptimizationGoalTypeEnum {
// is released.
APP_PRE_REGISTRATION = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/parental_status_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/parental_status_type.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/enums/parental_status_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/parental_status_type.proto
index ef499d217..1fca82854 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/parental_status_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/parental_status_type.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ParentalStatusTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing parenal status types.
// Container for enum describing the type of demographic parental statuses.
message ParentalStatusTypeEnum {
- // The type of parental statuses (e.g. not a parent).
+ // The type of parental statuses (for example, not a parent).
enum ParentalStatusType {
// Not specified.
UNSPECIFIED = 0;
@@ -46,6 +46,4 @@ message ParentalStatusTypeEnum {
// Undetermined parental status.
UNDETERMINED = 302;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/payment_mode.proto b/third_party/googleapis/google/ads/googleads/v13/enums/payment_mode.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/payment_mode.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/payment_mode.proto
index 9e162d79a..abebaa0c0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/payment_mode.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/payment_mode.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PaymentModeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing payment modes.
@@ -37,12 +37,12 @@ message PaymentModeEnum {
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
- // Pay per click.
+ // Pay per interaction.
CLICKS = 4;
// Pay per conversion value. This mode is only supported by campaigns with
// AdvertisingChannelType.HOTEL, BiddingStrategyType.COMMISSION, and
- // BudgetType.HOTEL_ADS_COMMISSION.
+ // BudgetType.STANDARD.
CONVERSION_VALUE = 5;
// Pay per conversion. This mode is only supported by campaigns with
@@ -57,6 +57,4 @@ message PaymentModeEnum {
// BudgetType.STANDARD.
GUEST_STAY = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/performance_max_upgrade_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/performance_max_upgrade_status.proto
new file mode 100644
index 000000000..2116e10c8
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/performance_max_upgrade_status.proto
@@ -0,0 +1,53 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "PerformanceMaxUpgradeStatusProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing advertising channel types
+
+// Performance Max Upgrade status for campaign.
+message PerformanceMaxUpgradeStatusEnum {
+ // Performance Max Upgrade status enum for campaign.
+ enum PerformanceMaxUpgradeStatus {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // The campaign is eligible for upgrade to a Performance Max campaign.
+ UPGRADE_ELIBIGLE = 2;
+
+ // The upgrade to a Performance Max campaign is in progress.
+ UPGRADE_IN_PROGRESS = 3;
+
+ // The upgrade to a Performance Max campaign is complete.
+ UPGRADE_COMPLETE = 4;
+
+ // The upgrade to a Performance Max campaign failed.
+ // The campaign will still serve as it was before upgrade was attempted.
+ UPGRADE_FAILED = 5;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/placeholder_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/placeholder_type.proto
similarity index 91%
rename from third_party/googleapis/google/ads/googleads/v10/enums/placeholder_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/placeholder_type.proto
index c3759fa67..0880cb4e0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/placeholder_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/placeholder_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PlaceholderTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing feed placeholder types.
@@ -80,7 +80,7 @@ message PlaceholderTypeEnum {
// feed is composed of three to eight price table rows.
PRICE = 10;
- // Allows you to highlight sales and other promotions that let users see how
+ // Lets you highlight sales and other promotions that let users see how
// they can save by buying now.
PROMOTION = 11;
@@ -117,6 +117,4 @@ message PlaceholderTypeEnum {
// Lets you attach an image to an ad.
IMAGE = 21;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/placement_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/placement_type.proto
similarity index 62%
rename from third_party/googleapis/google/ads/googleads/v10/enums/placement_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/placement_type.proto
index e89e45cd7..71b958db4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/placement_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/placement_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PlacementTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing placement types.
@@ -37,21 +37,22 @@ message PlacementTypeEnum {
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
- // Websites(e.g. 'www.flowers4sale.com').
+ // Websites(for example, 'www.flowers4sale.com').
WEBSITE = 2;
- // Mobile application categories(e.g. 'Games').
+ // Mobile application categories(for example, 'Games').
MOBILE_APP_CATEGORY = 3;
- // mobile applications(e.g. 'mobileapp::2-com.whatsthewordanswers').
+ // mobile applications(for example, 'mobileapp::2-com.whatsthewordanswers').
MOBILE_APPLICATION = 4;
- // YouTube videos(e.g. 'youtube.com/video/wtLJPvx7-ys').
+ // YouTube videos(for example, 'youtube.com/video/wtLJPvx7-ys').
YOUTUBE_VIDEO = 5;
- // YouTube channels(e.g. 'youtube.com::L8ZULXASCc1I_oaOT0NaOQ').
+ // YouTube channels(for example, 'youtube.com::L8ZULXASCc1I_oaOT0NaOQ').
YOUTUBE_CHANNEL = 6;
- }
-
+ // Surfaces owned and operated by Google(for example, 'tv.google.com').
+ GOOGLE_PRODUCTS = 7;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/policy_approval_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/policy_approval_status.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/policy_approval_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/policy_approval_status.proto
index 1bf5723d3..816cba128 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/policy_approval_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/policy_approval_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PolicyApprovalStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing policy approval statuses.
@@ -54,6 +54,4 @@ message PolicyApprovalStatusEnum {
// searching for information about the targeted countries.
AREA_OF_INTEREST_ONLY = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/policy_review_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/policy_review_status.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/policy_review_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/policy_review_status.proto
index 3475e4fa5..8ae69c2d6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/policy_review_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/policy_review_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PolicyReviewStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing policy review statuses.
@@ -53,6 +53,4 @@ message PolicyReviewStatusEnum {
// further review.
ELIGIBLE_MAY_SERVE = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_entry_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_entry_type.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_entry_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_entry_type.proto
index 1a8a0a21c..42e6f22e3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_entry_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_entry_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PolicyTopicEntryTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing policy topic entry types.
@@ -59,6 +59,4 @@ message PolicyTopicEntryTypeEnum {
// through area of interest.
AREA_OF_INTEREST_ONLY = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_evidence_destination_mismatch_url_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_evidence_destination_mismatch_url_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_evidence_destination_mismatch_url_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_evidence_destination_mismatch_url_type.proto
index 221d7b25b..7285cb119 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_evidence_destination_mismatch_url_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_evidence_destination_mismatch_url_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PolicyTopicEvidenceDestinationMismatchUrlTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing policy topic evidence destination mismatch url types.
@@ -55,6 +55,4 @@ message PolicyTopicEvidenceDestinationMismatchUrlTypeEnum {
// The tracking url template, with substituted mobile url.
MOBILE_TRACKING_URL = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_evidence_destination_not_working_device.proto b/third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_evidence_destination_not_working_device.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_evidence_destination_not_working_device.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_evidence_destination_not_working_device.proto
index 65eee4b5e..945bee4ac 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_evidence_destination_not_working_device.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_evidence_destination_not_working_device.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PolicyTopicEvidenceDestinationNotWorkingDeviceProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing device of destination not working policy topic
// evidence.
@@ -50,6 +50,4 @@ message PolicyTopicEvidenceDestinationNotWorkingDeviceEnum {
// Landing page doesn't work on iOS device.
IOS = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto
index 89ca8e40e..c1fcea8e9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/policy_topic_evidence_destination_not_working_dns_error_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PolicyTopicEvidenceDestinationNotWorkingDnsErrorTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing DNS error types of destination not working policy topic
// evidence.
@@ -49,6 +49,4 @@ message PolicyTopicEvidenceDestinationNotWorkingDnsErrorTypeEnum {
// landing page.
GOOGLE_CRAWLER_DNS_ISSUE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/positive_geo_target_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/positive_geo_target_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/positive_geo_target_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/positive_geo_target_type.proto
index b687a7dc8..9123355e9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/positive_geo_target_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/positive_geo_target_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PositiveGeoTargetTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing positive geo target types.
@@ -51,6 +51,4 @@ message PositiveGeoTargetTypeEnum {
// or regularly in advertiser's targeted locations.
PRESENCE = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/price_extension_price_qualifier.proto b/third_party/googleapis/google/ads/googleads/v13/enums/price_extension_price_qualifier.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/price_extension_price_qualifier.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/price_extension_price_qualifier.proto
index a041d4692..dd01b26f7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/price_extension_price_qualifier.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/price_extension_price_qualifier.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PriceExtensionPriceQualifierProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing price extension price qualifier type.
@@ -46,6 +46,4 @@ message PriceExtensionPriceQualifierEnum {
// 'Average' qualifier for the price.
AVERAGE = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/price_extension_price_unit.proto b/third_party/googleapis/google/ads/googleads/v13/enums/price_extension_price_unit.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/price_extension_price_unit.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/price_extension_price_unit.proto
index 1ae283ded..5e4f78081 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/price_extension_price_unit.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/price_extension_price_unit.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PriceExtensionPriceUnitProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing price extension price unit.
@@ -55,6 +55,4 @@ message PriceExtensionPriceUnitEnum {
// Per night.
PER_NIGHT = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/price_extension_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/price_extension_type.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/enums/price_extension_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/price_extension_type.proto
index 938ad7aa4..a1b88cf67 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/price_extension_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/price_extension_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PriceExtensionTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing price extension type.
@@ -64,6 +64,4 @@ message PriceExtensionTypeEnum {
// The type for showing a collection of related service tiers.
SERVICE_TIERS = 10;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/price_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/price_placeholder_field.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/enums/price_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/price_placeholder_field.proto
index 86b891ea7..80b030c31 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/price_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/price_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PricePlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Price placeholder fields.
@@ -64,7 +64,8 @@ message PricePlaceholderFieldEnum {
ITEM_1_DESCRIPTION = 101;
// Data Type: MONEY. The price (money with currency) of item 1 of the table,
- // e.g., 30 USD. The currency must match one of the available currencies.
+ // for example, 30 USD. The currency must match one of the available
+ // currencies.
ITEM_1_PRICE = 102;
// Data Type: STRING. The price unit of item 1 of the table. Must match one
@@ -86,7 +87,8 @@ message PricePlaceholderFieldEnum {
ITEM_2_DESCRIPTION = 201;
// Data Type: MONEY. The price (money with currency) of item 2 of the table,
- // e.g., 30 USD. The currency must match one of the available currencies.
+ // for example, 30 USD. The currency must match one of the available
+ // currencies.
ITEM_2_PRICE = 202;
// Data Type: STRING. The price unit of item 2 of the table. Must match one
@@ -108,7 +110,8 @@ message PricePlaceholderFieldEnum {
ITEM_3_DESCRIPTION = 301;
// Data Type: MONEY. The price (money with currency) of item 3 of the table,
- // e.g., 30 USD. The currency must match one of the available currencies.
+ // for example, 30 USD. The currency must match one of the available
+ // currencies.
ITEM_3_PRICE = 302;
// Data Type: STRING. The price unit of item 3 of the table. Must match one
@@ -130,7 +133,8 @@ message PricePlaceholderFieldEnum {
ITEM_4_DESCRIPTION = 401;
// Data Type: MONEY. The price (money with currency) of item 4 of the table,
- // e.g., 30 USD. The currency must match one of the available currencies.
+ // for example, 30 USD. The currency must match one of the available
+ // currencies.
ITEM_4_PRICE = 402;
// Data Type: STRING. The price unit of item 4 of the table. Must match one
@@ -152,7 +156,8 @@ message PricePlaceholderFieldEnum {
ITEM_5_DESCRIPTION = 501;
// Data Type: MONEY. The price (money with currency) of item 5 of the table,
- // e.g., 30 USD. The currency must match one of the available currencies.
+ // for example, 30 USD. The currency must match one of the available
+ // currencies.
ITEM_5_PRICE = 502;
// Data Type: STRING. The price unit of item 5 of the table. Must match one
@@ -174,7 +179,8 @@ message PricePlaceholderFieldEnum {
ITEM_6_DESCRIPTION = 601;
// Data Type: MONEY. The price (money with currency) of item 6 of the table,
- // e.g., 30 USD. The currency must match one of the available currencies.
+ // for example, 30 USD. The currency must match one of the available
+ // currencies.
ITEM_6_PRICE = 602;
// Data Type: STRING. The price unit of item 6 of the table. Must match one
@@ -196,7 +202,8 @@ message PricePlaceholderFieldEnum {
ITEM_7_DESCRIPTION = 701;
// Data Type: MONEY. The price (money with currency) of item 7 of the table,
- // e.g., 30 USD. The currency must match one of the available currencies.
+ // for example, 30 USD. The currency must match one of the available
+ // currencies.
ITEM_7_PRICE = 702;
// Data Type: STRING. The price unit of item 7 of the table. Must match one
@@ -218,7 +225,8 @@ message PricePlaceholderFieldEnum {
ITEM_8_DESCRIPTION = 801;
// Data Type: MONEY. The price (money with currency) of item 8 of the table,
- // e.g., 30 USD. The currency must match one of the available currencies.
+ // for example, 30 USD. The currency must match one of the available
+ // currencies.
ITEM_8_PRICE = 802;
// Data Type: STRING. The price unit of item 8 of the table. Must match one
@@ -233,6 +241,4 @@ message PricePlaceholderFieldEnum {
// using Upgraded URLs.
ITEM_8_FINAL_MOBILE_URLS = 805;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/product_bidding_category_level.proto b/third_party/googleapis/google/ads/googleads/v13/enums/product_bidding_category_level.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/product_bidding_category_level.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/product_bidding_category_level.proto
index cddc8334b..8dc28986e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/product_bidding_category_level.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/product_bidding_category_level.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ProductBiddingCategoryLevelProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Level of a product bidding category.
message ProductBiddingCategoryLevelEnum {
@@ -50,6 +50,4 @@ message ProductBiddingCategoryLevelEnum {
// Level 5.
LEVEL5 = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/product_bidding_category_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/product_bidding_category_status.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/product_bidding_category_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/product_bidding_category_status.proto
index 66122b75c..3e70bb9de 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/product_bidding_category_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/product_bidding_category_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ProductBiddingCategoryStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing bidding schemes.
@@ -43,6 +43,4 @@ message ProductBiddingCategoryStatusEnum {
// The category is obsolete. Used only for reporting purposes.
OBSOLETE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/product_channel.proto b/third_party/googleapis/google/ads/googleads/v13/enums/product_channel.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/product_channel.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/product_channel.proto
index 0e5273c3a..851d8fe81 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/product_channel.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/product_channel.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ProductChannelProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing bidding schemes.
@@ -43,6 +43,4 @@ message ProductChannelEnum {
// The item is sold in local stores.
LOCAL = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/product_channel_exclusivity.proto b/third_party/googleapis/google/ads/googleads/v13/enums/product_channel_exclusivity.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/product_channel_exclusivity.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/product_channel_exclusivity.proto
index 1538a9b6d..345a9d929 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/product_channel_exclusivity.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/product_channel_exclusivity.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ProductChannelExclusivityProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing bidding schemes.
@@ -45,6 +45,4 @@ message ProductChannelExclusivityEnum {
// it is available for purchase in both ShoppingProductChannels.
MULTI_CHANNEL = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/product_condition.proto b/third_party/googleapis/google/ads/googleads/v13/enums/product_condition.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/product_condition.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/product_condition.proto
index 6ea2532f7..e91577319 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/product_condition.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/product_condition.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ProductConditionProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing bidding schemes.
@@ -46,6 +46,4 @@ message ProductConditionEnum {
// The product condition is used.
USED = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/product_custom_attribute_index.proto b/third_party/googleapis/google/ads/googleads/v13/enums/product_custom_attribute_index.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/product_custom_attribute_index.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/product_custom_attribute_index.proto
index f267dfa20..99c2d7f9c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/product_custom_attribute_index.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/product_custom_attribute_index.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ProductCustomAttributeIndexProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing product custom attributes.
@@ -52,6 +52,4 @@ message ProductCustomAttributeIndexEnum {
// Fifth product custom attribute.
INDEX4 = 11;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/product_type_level.proto b/third_party/googleapis/google/ads/googleads/v13/enums/product_type_level.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/product_type_level.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/product_type_level.proto
index 98d427675..d479a4d55 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/product_type_level.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/product_type_level.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ProductTypeLevelProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing bidding schemes.
@@ -52,6 +52,4 @@ message ProductTypeLevelEnum {
// Level 5.
LEVEL5 = 11;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/promotion_extension_discount_modifier.proto b/third_party/googleapis/google/ads/googleads/v13/enums/promotion_extension_discount_modifier.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/promotion_extension_discount_modifier.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/promotion_extension_discount_modifier.proto
index 159c592c0..6f849bb16 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/promotion_extension_discount_modifier.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/promotion_extension_discount_modifier.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PromotionExtensionDiscountModifierProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing promotion extension discount modifier.
@@ -41,6 +41,4 @@ message PromotionExtensionDiscountModifierEnum {
// 'Up to'.
UP_TO = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/promotion_extension_occasion.proto b/third_party/googleapis/google/ads/googleads/v13/enums/promotion_extension_occasion.proto
similarity index 88%
rename from third_party/googleapis/google/ads/googleads/v10/enums/promotion_extension_occasion.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/promotion_extension_occasion.proto
index 9be881dab..7c46b574d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/promotion_extension_occasion.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/promotion_extension_occasion.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PromotionExtensionOccasionProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing promotion extension occasion.
// Container for enum describing a promotion extension occasion.
-// For more information about the occasions please check:
+// For more information about the occasions check:
// https://support.google.com/google-ads/answer/7367521
message PromotionExtensionOccasionEnum {
// A promotion extension occasion.
@@ -150,6 +150,4 @@ message PromotionExtensionOccasionEnum {
// Available in Japanese: Year-end Gift.
YEAR_END_GIFT = 38;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/promotion_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/promotion_placeholder_field.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/enums/promotion_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/promotion_placeholder_field.proto
index b3c6354d2..ad011b77e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/promotion_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/promotion_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "PromotionPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Promotion placeholder fields.
@@ -41,7 +41,7 @@ message PromotionPlaceholderFieldEnum {
// shown.
PROMOTION_TARGET = 2;
- // Data Type: STRING. Allows you to add "up to" phrase to the promotion,
+ // Data Type: STRING. Lets you add "up to" phrase to the promotion,
// in case you have variable promotion rates.
DISCOUNT_MODIFIER = 3;
@@ -88,6 +88,4 @@ message PromotionPlaceholderFieldEnum {
// tracking.
FINAL_URL_SUFFIX = 15;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/proximity_radius_units.proto b/third_party/googleapis/google/ads/googleads/v13/enums/proximity_radius_units.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/enums/proximity_radius_units.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/proximity_radius_units.proto
index 97c32f849..3fa2720bf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/proximity_radius_units.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/proximity_radius_units.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ProximityRadiusUnitsProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing proximity radius units.
// Container for enum describing unit of radius in proximity.
message ProximityRadiusUnitsEnum {
- // The unit of radius distance in proximity (e.g. MILES)
+ // The unit of radius distance in proximity (for example, MILES)
enum ProximityRadiusUnits {
// Not specified.
UNSPECIFIED = 0;
@@ -43,6 +43,4 @@ message ProximityRadiusUnitsEnum {
// Kilometers
KILOMETERS = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/quality_score_bucket.proto b/third_party/googleapis/google/ads/googleads/v13/enums/quality_score_bucket.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/quality_score_bucket.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/quality_score_bucket.proto
index be3abbf22..431c5e88b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/quality_score_bucket.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/quality_score_bucket.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "QualityScoreBucketProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing quality score buckets.
@@ -46,6 +46,4 @@ message QualityScoreBucketEnum {
// Quality of the creative is above average.
ABOVE_AVERAGE = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/reach_plan_age_range.proto b/third_party/googleapis/google/ads/googleads/v13/enums/reach_plan_age_range.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/enums/reach_plan_age_range.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/reach_plan_age_range.proto
index 57f02b90a..e165c7d31 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/reach_plan_age_range.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/reach_plan_age_range.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ReachPlanAgeRangeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing a plannable age range.
@@ -115,6 +115,4 @@ message ReachPlanAgeRangeEnum {
// 65 years old and beyond.
AGE_RANGE_65_UP = 503006;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/reach_plan_network.proto b/third_party/googleapis/google/ads/googleads/v13/enums/reach_plan_network.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/reach_plan_network.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/reach_plan_network.proto
index c8965f70b..35d1331e6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/reach_plan_network.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/reach_plan_network.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ReachPlanNetworkProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing a plannable network.
@@ -47,6 +47,4 @@ message ReachPlanNetworkEnum {
// network.
YOUTUBE_AND_GOOGLE_VIDEO_PARTNERS = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/real_estate_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/real_estate_placeholder_field.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/enums/real_estate_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/real_estate_placeholder_field.proto
index 5a9ec63ed..f0da410ba 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/real_estate_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/real_estate_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "RealEstatePlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Real Estate placeholder fields.
@@ -78,8 +78,8 @@ message RealEstatePlaceholderFieldEnum {
CONTEXTUAL_KEYWORDS = 12;
// Data Type: URL_LIST. Final URLs to be used in ad when using Upgraded
- // URLs; the more specific the better (e.g. the individual URL of a specific
- // listing and its location).
+ // URLs; the more specific the better (for example, the individual URL of a
+ // specific listing and its location).
FINAL_URLS = 13;
// Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded
@@ -108,6 +108,4 @@ message RealEstatePlaceholderFieldEnum {
// Data Type: INT64. iOS app store ID.
IOS_APP_STORE_ID = 19;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/recommendation_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/recommendation_type.proto
similarity index 67%
rename from third_party/googleapis/google/ads/googleads/v10/enums/recommendation_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/recommendation_type.proto
index 9d42fe07c..94bec8f3a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/recommendation_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/recommendation_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "RecommendationTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Recommendation types.
@@ -71,15 +71,6 @@ message RecommendationTypeEnum {
// given ad group.
OPTIMIZE_AD_ROTATION = 10;
- // Recommendation to add callout extensions to a campaign.
- CALLOUT_EXTENSION = 11;
-
- // Recommendation to add sitelink extensions to a campaign.
- SITELINK_EXTENSION = 12;
-
- // Recommendation to add call extensions to a campaign.
- CALL_EXTENSION = 13;
-
// Recommendation to change an existing keyword from one match type to a
// broader match type.
KEYWORD_MATCH_TYPE = 14;
@@ -111,7 +102,39 @@ message RecommendationTypeEnum {
// Recommendation to add new responsive search ad assets.
RESPONSIVE_SEARCH_AD_ASSET = 21;
- }
+ // Recommendation to upgrade a Smart Shopping campaign to a Performance Max
+ // campaign.
+ UPGRADE_SMART_SHOPPING_CAMPAIGN_TO_PERFORMANCE_MAX = 22;
+
+ // Recommendation to improve strength of responsive search ad.
+ RESPONSIVE_SEARCH_AD_IMPROVE_AD_STRENGTH = 23;
+
+ // Recommendation to update a campaign to use Display Expansion.
+ DISPLAY_EXPANSION_OPT_IN = 24;
+ // Recommendation to upgrade a Local campaign to a Performance Max
+ // campaign.
+ UPGRADE_LOCAL_CAMPAIGN_TO_PERFORMANCE_MAX = 25;
+
+ // Recommendation to raise target CPA when it is too low and there are very
+ // few or no conversions.
+ // It is applied asynchronously and can take minutes
+ // depending on the number of ad groups there is in the related campaign.
+ RAISE_TARGET_CPA_BID_TOO_LOW = 26;
+
+ // Recommendation to raise the budget in advance of a seasonal event that is
+ // forecasted to increase traffic, and change bidding strategy from maximize
+ // conversion value to target ROAS.
+ FORECASTING_SET_TARGET_ROAS = 27;
+
+ // Recommendation to add callout assets to campaign or customer level.
+ CALLOUT_ASSET = 28;
+
+ // Recommendation to add sitelink assets to campaign or customer level.
+ SITELINK_ASSET = 29;
+
+ // Recommendation to add call assets to campaign or customer level.
+ CALL_ASSET = 30;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/resource_change_operation.proto b/third_party/googleapis/google/ads/googleads/v13/enums/resource_change_operation.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/resource_change_operation.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/resource_change_operation.proto
index 483bcc75c..0d3dbcb06 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/resource_change_operation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/resource_change_operation.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ResourceChangeOperationProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing the resource change operations in change event.
@@ -48,6 +48,4 @@ message ResourceChangeOperationEnum {
// The resource was removed.
REMOVE = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/resource_limit_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/resource_limit_type.proto
similarity index 93%
rename from third_party/googleapis/google/ads/googleads/v10/enums/resource_limit_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/resource_limit_type.proto
index 59b01cff4..3af980207 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/resource_limit_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/resource_limit_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ResourceLimitTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing possible resource limit types.
message ResourceLimitTypeEnum {
@@ -140,7 +140,7 @@ message ResourceLimitTypeEnum {
// Number of negative keywords per campaign.
NEGATIVE_KEYWORDS_PER_CAMPAIGN = 28;
- // Number of excluded campaign criteria in placement dimension, e.g.
+ // Number of excluded campaign criteria in placement dimension, for example,
// placement, mobile application, YouTube channel, etc. The API criterion
// type is NOT limited to placement only, and this does not include
// exclusions at the ad group or other levels.
@@ -300,6 +300,12 @@ message ResourceLimitTypeEnum {
// Number of ENABLED price AdGroupAssets per ad group.
PRICE_AD_GROUP_ASSETS_PER_AD_GROUP = 156;
+ // Number of ENABLED ad image CampaignAssets per campaign.
+ AD_IMAGE_CAMPAIGN_ASSETS_PER_CAMPAIGN = 175;
+
+ // Number of ENABLED ad image AdGroupAssets per ad group.
+ AD_IMAGE_AD_GROUP_ASSETS_PER_AD_GROUP = 176;
+
// Number of ENABLED page feed asset sets per customer.
PAGE_FEED_ASSET_SETS_PER_CUSTOMER = 157;
@@ -355,6 +361,12 @@ message ResourceLimitTypeEnum {
// Number of ENABLED assets per dynamic jobs asset set.
ASSETS_PER_DYNAMIC_JOBS_ASSET_SET = 174;
+ // Number of ENABLED business name CampaignAssets per campaign.
+ BUSINESS_NAME_CAMPAIGN_ASSETS_PER_CAMPAIGN = 179;
+
+ // Number of ENABLED business logo CampaignAssets per campaign.
+ BUSINESS_LOGO_CAMPAIGN_ASSETS_PER_CAMPAIGN = 180;
+
// Number of versions per ad.
VERSIONS_PER_AD = 82;
@@ -427,8 +439,8 @@ message ResourceLimitTypeEnum {
// Number of ENABLED keyword plans per user per customer.
// The limit is applied per pair because by default a plan
- // is private to a user of a customer. Each user of a customer has his or
- // her own independent limit.
+ // is private to a user of a customer. Each user of a customer has their own
+ // independent limit.
KEYWORD_PLANS_PER_USER_PER_CUSTOMER = 122;
// Number of keyword plan ad group keywords per keyword plan.
@@ -455,7 +467,11 @@ message ResourceLimitTypeEnum {
// Number of hotel check-in date range bid modifiers per ad agroup.
HOTEL_CHECK_IN_DATE_RANGE_BID_MODIFIERS_PER_AD_GROUP = 132;
- }
+ // Maximum number of asset per hotel property asset set.
+ ENABLED_ASSET_PER_HOTEL_PROPERTY_ASSET_SET = 181;
+ // Maximum number of enabled hotel property assets per asset group.
+ ENABLED_HOTEL_PROPERTY_ASSET_LINKS_PER_ASSET_GROUP = 182;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/response_content_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/response_content_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/response_content_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/response_content_type.proto
index 7188282d4..ca43b1f5b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/response_content_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/response_content_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ResponseContentTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing the response content types used in mutate operations.
@@ -41,6 +41,4 @@ message ResponseContentTypeEnum {
// all mutable fields.
MUTABLE_RESOURCE = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/search_engine_results_page_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/search_engine_results_page_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/search_engine_results_page_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/search_engine_results_page_type.proto
index ea2c4e04d..f2c3ca7bf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/search_engine_results_page_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/search_engine_results_page_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SearchEngineResultsPageTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing search engine results page types.
@@ -47,6 +47,4 @@ message SearchEngineResultsPageTypeEnum {
// page.
ADS_AND_ORGANIC = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/search_term_match_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/search_term_match_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/search_term_match_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/search_term_match_type.proto
index 7d990e3f1..128107744 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/search_term_match_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/search_term_match_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SearchTermMatchTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing search term match types.
@@ -52,6 +52,4 @@ message SearchTermMatchTypeEnum {
// Phrase match (close variant).
NEAR_PHRASE = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/search_term_targeting_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/search_term_targeting_status.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/search_term_targeting_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/search_term_targeting_status.proto
index 19ac90538..e2a43d92b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/search_term_targeting_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/search_term_targeting_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SearchTermTargetingStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing search term targeting statuses.
@@ -51,6 +51,4 @@ message SearchTermTargetingStatusEnum {
// Search term is neither targeted nor excluded.
NONE = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/seasonality_event_scope.proto b/third_party/googleapis/google/ads/googleads/v13/enums/seasonality_event_scope.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/seasonality_event_scope.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/seasonality_event_scope.proto
index 312b155b2..8e786797a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/seasonality_event_scope.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/seasonality_event_scope.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SeasonalityEventScopeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing seasonality event status.
@@ -52,6 +52,4 @@ message SeasonalityEventScopeEnum {
// specified channel types.
CHANNEL = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/seasonality_event_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/seasonality_event_status.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/seasonality_event_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/seasonality_event_status.proto
index 73ab078ef..2bfd686a2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/seasonality_event_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/seasonality_event_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SeasonalityEventStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing seasonality event status.
@@ -46,6 +46,4 @@ message SeasonalityEventStatusEnum {
// The seasonality event is removed.
REMOVED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/served_asset_field_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/served_asset_field_type.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/served_asset_field_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/served_asset_field_type.proto
index f8879b0fc..def423201 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/served_asset_field_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/served_asset_field_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ServedAssetFieldTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing policy review statuses.
@@ -54,6 +54,4 @@ message ServedAssetFieldTypeEnum {
// The asset is used in description 2.
DESCRIPTION_2 = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/shared_set_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/shared_set_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/shared_set_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/shared_set_status.proto
index f770ddfc6..d7989e251 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/shared_set_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/shared_set_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SharedSetStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing shared set statuses.
@@ -43,6 +43,4 @@ message SharedSetStatusEnum {
// The shared set is removed and can no longer be used.
REMOVED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/shared_set_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/shared_set_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/shared_set_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/shared_set_type.proto
index 50d8e4531..c38db4016 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/shared_set_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/shared_set_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SharedSetTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing shared set types.
@@ -43,6 +43,4 @@ message SharedSetTypeEnum {
// A set of placements that can be excluded from targeting.
NEGATIVE_PLACEMENTS = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/simulation_modification_method.proto b/third_party/googleapis/google/ads/googleads/v13/enums/simulation_modification_method.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/simulation_modification_method.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/simulation_modification_method.proto
index 4ec3dd080..019130ece 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/simulation_modification_method.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/simulation_modification_method.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SimulationModificationMethodProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing simulation modification methods.
@@ -52,6 +52,4 @@ message SimulationModificationMethodEnum {
// all ad group targets were scaled by a factor of X.
SCALING = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/simulation_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/simulation_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/simulation_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/simulation_type.proto
index dd907a360..0684e46d3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/simulation_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/simulation_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SimulationTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing simulation types.
@@ -61,6 +61,4 @@ message SimulationTypeEnum {
// The simulation is for a budget.
BUDGET = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/sitelink_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/sitelink_placeholder_field.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/sitelink_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/sitelink_placeholder_field.proto
index 9cec7749b..ae3b2814e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/sitelink_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/sitelink_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SitelinkPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Sitelink placeholder fields.
@@ -62,6 +62,4 @@ message SitelinkPlaceholderFieldEnum {
// tracking.
FINAL_URL_SUFFIX = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/sk_ad_network_ad_event_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/sk_ad_network_ad_event_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/sk_ad_network_ad_event_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/sk_ad_network_ad_event_type.proto
index ea31f4f76..8de6b21c2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/sk_ad_network_ad_event_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/sk_ad_network_ad_event_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SkAdNetworkAdEventTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing SkAdNetwork Ad Event Types.
@@ -47,6 +47,4 @@ message SkAdNetworkAdEventTypeEnum {
// The user viewed the ad.
VIEW = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/sk_ad_network_attribution_credit.proto b/third_party/googleapis/google/ads/googleads/v13/enums/sk_ad_network_attribution_credit.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/sk_ad_network_attribution_credit.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/sk_ad_network_attribution_credit.proto
index e265242dc..31804c2de 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/sk_ad_network_attribution_credit.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/sk_ad_network_attribution_credit.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SkAdNetworkAttributionCreditProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing SkAdNetwork attribution credits.
@@ -48,6 +48,4 @@ message SkAdNetworkAttributionCreditEnum {
// Google qualified for attribution, but didn't win.
CONTRIBUTED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/sk_ad_network_user_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/sk_ad_network_user_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/sk_ad_network_user_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/sk_ad_network_user_type.proto
index ad2b6c2d9..48fffabdb 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/sk_ad_network_user_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/sk_ad_network_user_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SkAdNetworkUserTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing SkAdNetwork user types.
@@ -47,6 +47,4 @@ message SkAdNetworkUserTypeEnum {
// The user has previously installed the app.
REINSTALLER = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/slot.proto b/third_party/googleapis/google/ads/googleads/v13/enums/slot.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/slot.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/slot.proto
index dbdf79ad9..78786a8b9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/slot.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/slot.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SlotProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing slots.
@@ -58,6 +58,4 @@ message SlotEnum {
// Cross-network.
MIXED = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/smart_campaign_not_eligible_reason.proto b/third_party/googleapis/google/ads/googleads/v13/enums/smart_campaign_not_eligible_reason.proto
new file mode 100644
index 000000000..9e17b4b3c
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/smart_campaign_not_eligible_reason.proto
@@ -0,0 +1,59 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "SmartCampaignNotEligibleReasonProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing reasons for why a Smart campaign is not eligible to
+// serve.
+
+// A container for an enum that describes reasons for why a Smart campaign
+// is not eligible to serve.
+message SmartCampaignNotEligibleReasonEnum {
+ // Reasons for why a Smart campaign is not eligible to serve.
+ enum SmartCampaignNotEligibleReason {
+ // The status has not been specified.
+ UNSPECIFIED = 0;
+
+ // The received value is not known in this version.
+ //
+ // This is a response-only value.
+ UNKNOWN = 1;
+
+ // The campaign is not eligible to serve because of an issue with the
+ // account.
+ ACCOUNT_ISSUE = 2;
+
+ // The campaign is not eligible to serve because of a payment issue.
+ BILLING_ISSUE = 3;
+
+ // The business profile location associated with the campaign has been
+ // removed.
+ BUSINESS_PROFILE_LOCATION_REMOVED = 4;
+
+ // All system-generated ads have been disapproved. Consult the
+ // policy_summary field in the AdGroupAd resource for more details.
+ ALL_ADS_DISAPPROVED = 5;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/smart_campaign_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/smart_campaign_status.proto
new file mode 100644
index 000000000..dc151bd3e
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/smart_campaign_status.proto
@@ -0,0 +1,61 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "SmartCampaignStatusProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing Smart campaign statuses.
+
+// A container for an enum that describes Smart campaign statuses.
+message SmartCampaignStatusEnum {
+ // Smart campaign statuses.
+ enum SmartCampaignStatus {
+ // The status has not been specified.
+ UNSPECIFIED = 0;
+
+ // The received value is not known in this version.
+ //
+ // This is a response-only value.
+ UNKNOWN = 1;
+
+ // The campaign was paused.
+ PAUSED = 2;
+
+ // The campaign is not eligible to serve and has issues that may require
+ // intervention.
+ NOT_ELIGIBLE = 3;
+
+ // The campaign is pending the approval of at least one ad.
+ PENDING = 4;
+
+ // The campaign is eligible to serve.
+ ELIGIBLE = 5;
+
+ // The campaign has been removed.
+ REMOVED = 6;
+
+ // The campaign has ended.
+ ENDED = 7;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/spending_limit_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/spending_limit_type.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/spending_limit_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/spending_limit_type.proto
index ae83b6c77..e16954f2a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/spending_limit_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/spending_limit_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SpendingLimitTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing SpendingLimit types.
@@ -41,6 +41,4 @@ message SpendingLimitTypeEnum {
// Infinite, indicates unlimited spending power.
INFINITE = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/structured_snippet_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/structured_snippet_placeholder_field.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/structured_snippet_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/structured_snippet_placeholder_field.proto
index 01b7ae847..0cf81900b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/structured_snippet_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/structured_snippet_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "StructuredSnippetPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Structured Snippet placeholder fields.
@@ -40,7 +40,7 @@ message StructuredSnippetPlaceholderFieldEnum {
// Data Type: STRING. The category of snippet of your products/services.
// Must match exactly one of the predefined structured snippets headers.
// For a list, visit
- // https://developers.google.com/adwords/api/docs/appendix/structured-snippet-headers
+ // https://developers.google.com/google-ads/api/reference/data/structured-snippet-headers
HEADER = 2;
// Data Type: STRING_LIST. Text values that describe your products/services.
@@ -48,6 +48,4 @@ message StructuredSnippetPlaceholderFieldEnum {
// permitted. A snippet can be at most 25 characters.
SNIPPETS = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/summary_row_setting.proto b/third_party/googleapis/google/ads/googleads/v13/enums/summary_row_setting.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/summary_row_setting.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/summary_row_setting.proto
index b7c3907b8..d69377c57 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/summary_row_setting.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/summary_row_setting.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SummaryRowSettingProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing summary row setting.
@@ -47,6 +47,4 @@ message SummaryRowSettingEnum {
// Return summary row only and return no results.
SUMMARY_ROW_ONLY = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/system_managed_entity_source.proto b/third_party/googleapis/google/ads/googleads/v13/enums/system_managed_entity_source.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/system_managed_entity_source.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/system_managed_entity_source.proto
index aa96fff71..ddccf6ee0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/system_managed_entity_source.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/system_managed_entity_source.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "SystemManagedEntitySourceProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing system managed entity sources.
@@ -40,6 +40,4 @@ message SystemManagedResourceSourceEnum {
// Generated ad variations experiment ad.
AD_VARIATIONS = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/target_cpa_opt_in_recommendation_goal.proto b/third_party/googleapis/google/ads/googleads/v13/enums/target_cpa_opt_in_recommendation_goal.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/target_cpa_opt_in_recommendation_goal.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/target_cpa_opt_in_recommendation_goal.proto
index c4480bf3e..c7f0f04b9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/target_cpa_opt_in_recommendation_goal.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/target_cpa_opt_in_recommendation_goal.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "TargetCpaOptInRecommendationGoalProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing TargetCpaOptIn recommendation goals.
@@ -50,6 +50,4 @@ message TargetCpaOptInRecommendationGoalEnum {
// to, yet lower than, the actual CPA (computed for past 28 days).
CLOSEST_CPA = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/enums/target_frequency_time_unit.proto b/third_party/googleapis/google/ads/googleads/v13/enums/target_frequency_time_unit.proto
new file mode 100644
index 000000000..27515bc3c
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/target_frequency_time_unit.proto
@@ -0,0 +1,43 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.enums;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
+option java_multiple_files = true;
+option java_outer_classname = "TargetFrequencyTimeUnitProto";
+option java_package = "com.google.ads.googleads.v13.enums";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
+
+// Proto file describing bidding goal Target Frequency time units.
+
+// Container for enum describing bidding goal Target Frequency time units.
+message TargetFrequencyTimeUnitEnum {
+ // Enum describing time window over which we want to reach Target Frequency.
+ enum TargetFrequencyTimeUnit {
+ // Not specified.
+ UNSPECIFIED = 0;
+
+ // Used for return value only. Represents value unknown in this version.
+ UNKNOWN = 1;
+
+ // Optimize bidding to reach Target Frequency in a week.
+ WEEKLY = 2;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/target_impression_share_location.proto b/third_party/googleapis/google/ads/googleads/v13/enums/target_impression_share_location.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/target_impression_share_location.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/target_impression_share_location.proto
index c1c723a71..5b4615fcc 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/target_impression_share_location.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/target_impression_share_location.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "TargetImpressionShareLocationProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing target impression share goal.
@@ -48,6 +48,4 @@ message TargetImpressionShareLocationEnum {
// Top slot in the top box of ads.
ABSOLUTE_TOP_OF_PAGE = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/targeting_dimension.proto b/third_party/googleapis/google/ads/googleads/v13/enums/targeting_dimension.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/enums/targeting_dimension.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/targeting_dimension.proto
index eb6554e0e..c834f9641 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/targeting_dimension.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/targeting_dimension.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "TargetingDimensionProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing criteria types.
@@ -37,16 +37,16 @@ message TargetingDimensionEnum {
// Used for return value only. Represents value unknown in this version.
UNKNOWN = 1;
- // Keyword criteria, e.g. 'mars cruise'. KEYWORD may be used as a custom bid
- // dimension. Keywords are always a targeting dimension, so may not be set
- // as a target "ALL" dimension with TargetRestriction.
+ // Keyword criteria, for example, 'mars cruise'. KEYWORD may be used as a
+ // custom bid dimension. Keywords are always a targeting dimension, so may
+ // not be set as a target "ALL" dimension with TargetRestriction.
KEYWORD = 2;
// Audience criteria, which include user list, user interest, custom
// affinity, and custom in market.
AUDIENCE = 3;
- // Topic criteria for targeting categories of content, e.g.
+ // Topic criteria for targeting categories of content, for example,
// 'category::Animals>Pets' Used for Display and Video targeting.
TOPIC = 4;
@@ -67,6 +67,4 @@ message TargetingDimensionEnum {
// Criteria for income range targeting.
INCOME_RANGE = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/time_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/time_type.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/time_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/time_type.proto
index 64b46c62a..6665b6a7e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/time_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/time_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "TimeTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing TimeType types.
@@ -44,6 +44,4 @@ message TimeTypeEnum {
// An infinite point in the future.
FOREVER = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/tracking_code_page_format.proto b/third_party/googleapis/google/ads/googleads/v13/enums/tracking_code_page_format.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/tracking_code_page_format.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/tracking_code_page_format.proto
index 8cde85951..dc216bb79 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/tracking_code_page_format.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/tracking_code_page_format.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "TrackingCodePageFormatProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing the format of the web page where the tracking
// tag and snippet will be installed.
@@ -43,6 +43,4 @@ message TrackingCodePageFormatEnum {
// Google AMP page format.
AMP = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/tracking_code_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/tracking_code_type.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/enums/tracking_code_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/tracking_code_type.proto
index 2a31d00f6..436ca1dd1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/tracking_code_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/tracking_code_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "TrackingCodeTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Container for enum describing the type of the generated tag snippets for
// tracking conversions.
@@ -52,6 +52,4 @@ message TrackingCodeTypeEnum {
// a Google forwarding number for call tracking purposes.
WEBSITE_CALL = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/travel_placeholder_field.proto b/third_party/googleapis/google/ads/googleads/v13/enums/travel_placeholder_field.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/enums/travel_placeholder_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/travel_placeholder_field.proto
index 1f7c55da2..1713bf7a7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/travel_placeholder_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/travel_placeholder_field.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "TravelPlaceholderFieldProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing Travel placeholder fields.
@@ -91,8 +91,8 @@ message TravelPlaceholderFieldEnum {
DESTINATION_ADDRESS = 14;
// Data Type: URL_LIST. Required. Final URLs to be used in ad, when using
- // Upgraded URLs; the more specific the better (e.g. the individual URL of a
- // specific travel offer and its location).
+ // Upgraded URLs; the more specific the better (for example, the individual
+ // URL of a specific travel offer and its location).
FINAL_URL = 15;
// Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded
@@ -121,6 +121,4 @@ message TravelPlaceholderFieldEnum {
// Data Type: INT64. iOS app store ID.
IOS_APP_STORE_ID = 21;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_identifier_source.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_identifier_source.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_identifier_source.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_identifier_source.proto
index 9f31232c7..0af0f1fca 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_identifier_source.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_identifier_source.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserIdentifierSourceProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing user identifier source
@@ -47,6 +47,4 @@ message UserIdentifierSourceEnum {
// (partner).
THIRD_PARTY = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_interest_taxonomy_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_interest_taxonomy_type.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_interest_taxonomy_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_interest_taxonomy_type.proto
index 2362d084b..2f4f0dee7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_interest_taxonomy_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_interest_taxonomy_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserInterestTaxonomyTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing the UserInterest taxonomy type
@@ -52,6 +52,4 @@ message UserInterestTaxonomyTypeEnum {
// User interest criteria for new smart phone users.
NEW_SMART_PHONE_USER = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_access_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_access_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_access_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_access_status.proto
index ae062455f..4433955d5 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_access_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_access_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListAccessStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing user list access status.
@@ -43,6 +43,4 @@ message UserListAccessStatusEnum {
// The access is disabled.
DISABLED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_closing_reason.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_closing_reason.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_closing_reason.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_closing_reason.proto
index 35bf665c4..54b5b1933 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_closing_reason.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_closing_reason.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListClosingReasonProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing user list closing reason.
@@ -41,6 +41,4 @@ message UserListClosingReasonEnum {
// The userlist was closed because of not being used for over one year.
UNUSED = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_crm_data_source_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_crm_data_source_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_crm_data_source_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_crm_data_source_type.proto
index 6e6001818..e688510cf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_crm_data_source_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_crm_data_source_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListCrmDataSourceTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Indicates source of Crm upload data.
message UserListCrmDataSourceTypeEnum {
@@ -44,6 +44,4 @@ message UserListCrmDataSourceTypeEnum {
// The uploaded data is from a third-party voter file.
THIRD_PARTY_VOTER_FILE = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_date_rule_item_operator.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_date_rule_item_operator.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_date_rule_item_operator.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_date_rule_item_operator.proto
index 8be9f633f..f04652f3a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_date_rule_item_operator.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_date_rule_item_operator.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListDateRuleItemOperatorProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Supported rule operator for date type.
message UserListDateRuleItemOperatorEnum {
@@ -47,6 +47,4 @@ message UserListDateRuleItemOperatorEnum {
// After.
AFTER = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_combined_rule_operator.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_flexible_rule_operator.proto
similarity index 67%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_combined_rule_operator.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_flexible_rule_operator.proto
index a148b48df..3f28022b8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_combined_rule_operator.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_flexible_rule_operator.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
-option java_outer_classname = "UserListCombinedRuleOperatorProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_outer_classname = "UserListFlexibleRuleOperatorProto";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Logical operator connecting two rules.
-message UserListCombinedRuleOperatorEnum {
+message UserListFlexibleRuleOperatorEnum {
// Enum describing possible user list combined rule operators.
- enum UserListCombinedRuleOperator {
+ enum UserListFlexibleRuleOperator {
// Not specified.
UNSPECIFIED = 0;
@@ -38,9 +38,7 @@ message UserListCombinedRuleOperatorEnum {
// A AND B.
AND = 2;
- // A AND NOT B.
- AND_NOT = 3;
+ // A OR B.
+ OR = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_logical_rule_operator.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_logical_rule_operator.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_logical_rule_operator.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_logical_rule_operator.proto
index 73ce9fd0a..9a214f08b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_logical_rule_operator.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_logical_rule_operator.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListLogicalRuleOperatorProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// The logical operator of the rule.
message UserListLogicalRuleOperatorEnum {
@@ -44,6 +44,4 @@ message UserListLogicalRuleOperatorEnum {
// Not - none of the operands.
NONE = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_membership_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_membership_status.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_membership_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_membership_status.proto
index 02850ed50..c3c236b89 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_membership_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_membership_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListMembershipStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing user list membership status.
@@ -45,6 +45,4 @@ message UserListMembershipStatusEnum {
// Closed status - No new members being added. Cannot be used for targeting.
CLOSED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_number_rule_item_operator.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_number_rule_item_operator.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_number_rule_item_operator.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_number_rule_item_operator.proto
index f0e2c0ac2..12b4d58ca 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_number_rule_item_operator.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_number_rule_item_operator.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListNumberRuleItemOperatorProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Supported rule operator for number type.
message UserListNumberRuleItemOperatorEnum {
@@ -53,6 +53,4 @@ message UserListNumberRuleItemOperatorEnum {
// Less than or equal.
LESS_THAN_OR_EQUAL = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_prepopulation_status.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_prepopulation_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_prepopulation_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_prepopulation_status.proto
index 3df0f1096..0510ee3c3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_prepopulation_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_prepopulation_status.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListPrepopulationStatusProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Indicates status of prepopulation based on the rule.
message UserListPrepopulationStatusEnum {
@@ -44,6 +44,4 @@ message UserListPrepopulationStatusEnum {
// Prepopulation failed.
FAILED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_rule_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_rule_type.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_rule_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_rule_type.proto
index 35b65a981..8368131e0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_rule_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_rule_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListRuleTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Rule based user list rule type.
message UserListRuleTypeEnum {
@@ -41,6 +41,4 @@ message UserListRuleTypeEnum {
// Disjunctive normal form.
OR_OF_ANDS = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_size_range.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_size_range.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_size_range.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_size_range.proto
index b1399dcb8..bc0dda953 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_size_range.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_size_range.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListSizeRangeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing user list size range.
@@ -85,6 +85,4 @@ message UserListSizeRangeEnum {
// User list has over 50 million users.
OVER_FIFTY_MILLION = 17;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_string_rule_item_operator.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_string_rule_item_operator.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_string_rule_item_operator.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_string_rule_item_operator.proto
index efc3ca054..17cb970e8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_string_rule_item_operator.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_string_rule_item_operator.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListStringRuleItemOperatorProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Supported rule operator for string type.
message UserListStringRuleItemOperatorEnum {
@@ -59,6 +59,4 @@ message UserListStringRuleItemOperatorEnum {
// Not ends with.
NOT_ENDS_WITH = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_type.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/enums/user_list_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/user_list_type.proto
index 905cababe..1d721179e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/user_list_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/user_list_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "UserListTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing user list type.
@@ -56,6 +56,4 @@ message UserListTypeEnum {
// emails or other formats.
CRM_BASED = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/value_rule_device_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/value_rule_device_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/value_rule_device_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/value_rule_device_type.proto
index 74511fa7b..56e9ce775 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/value_rule_device_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/value_rule_device_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ValueRuleDeviceTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion value rule device type.
@@ -47,6 +47,4 @@ message ValueRuleDeviceTypeEnum {
// Tablet device.
TABLET = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/value_rule_geo_location_match_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/value_rule_geo_location_match_type.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/value_rule_geo_location_match_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/value_rule_geo_location_match_type.proto
index 3cbae36b7..020157649 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/value_rule_geo_location_match_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/value_rule_geo_location_match_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ValueRuleGeoLocationMatchTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion value rule geo location match type.
@@ -44,6 +44,4 @@ message ValueRuleGeoLocationMatchTypeEnum {
// Only Location of Presence can be used to match.
LOCATION_OF_PRESENCE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/value_rule_operation.proto b/third_party/googleapis/google/ads/googleads/v13/enums/value_rule_operation.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/value_rule_operation.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/value_rule_operation.proto
index 98d0ebd0e..f5e7aedd0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/value_rule_operation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/value_rule_operation.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ValueRuleOperationProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion value rule operation.
@@ -47,6 +47,4 @@ message ValueRuleOperationEnum {
// Set conversion value to provided value.
SET = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/value_rule_set_attachment_type.proto b/third_party/googleapis/google/ads/googleads/v13/enums/value_rule_set_attachment_type.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/value_rule_set_attachment_type.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/value_rule_set_attachment_type.proto
index 75977509d..07042a9cf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/value_rule_set_attachment_type.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/value_rule_set_attachment_type.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ValueRuleSetAttachmentTypeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing where the conversion value rule is attached.
@@ -43,6 +43,4 @@ message ValueRuleSetAttachmentTypeEnum {
// Attached to a campaign.
CAMPAIGN = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/value_rule_set_dimension.proto b/third_party/googleapis/google/ads/googleads/v13/enums/value_rule_set_dimension.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/enums/value_rule_set_dimension.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/value_rule_set_dimension.proto
index 8697b19ee..3627074b4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/value_rule_set_dimension.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/value_rule_set_dimension.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "ValueRuleSetDimensionProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing conversion value rule set dimension.
@@ -50,6 +50,4 @@ message ValueRuleSetDimensionEnum {
// This dimension implies the rule will always apply.
NO_CONDITION = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/vanity_pharma_display_url_mode.proto b/third_party/googleapis/google/ads/googleads/v13/enums/vanity_pharma_display_url_mode.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/vanity_pharma_display_url_mode.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/vanity_pharma_display_url_mode.proto
index c19a7ed03..b1c2871f6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/vanity_pharma_display_url_mode.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/vanity_pharma_display_url_mode.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "VanityPharmaDisplayUrlModeProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing vanity pharma display url modes.
@@ -43,6 +43,4 @@ message VanityPharmaDisplayUrlModeEnum {
// Replace vanity pharma URL with description of the website.
WEBSITE_DESCRIPTION = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/vanity_pharma_text.proto b/third_party/googleapis/google/ads/googleads/v13/enums/vanity_pharma_text.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/enums/vanity_pharma_text.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/vanity_pharma_text.proto
index 7c6e8a943..efa2cefbe 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/vanity_pharma_text.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/vanity_pharma_text.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "VanityPharmaTextProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing vanity pharma texts.
@@ -80,6 +80,4 @@ message VanityPharmaTextEnum {
// vacunas con receta).
PRESCRIPTION_VACCINE_WEBSITE_ES = 13;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/video_thumbnail.proto b/third_party/googleapis/google/ads/googleads/v13/enums/video_thumbnail.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/video_thumbnail.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/video_thumbnail.proto
index 601bff72d..9a3c650c1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/video_thumbnail.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/video_thumbnail.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "VideoThumbnailProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing video thumbnails.
@@ -52,6 +52,4 @@ message VideoThumbnailEnum {
// Thumbnail 3, generated from the video.
THUMBNAIL_3 = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/webpage_condition_operand.proto b/third_party/googleapis/google/ads/googleads/v13/enums/webpage_condition_operand.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/enums/webpage_condition_operand.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/webpage_condition_operand.proto
index fcf11e115..534262b79 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/webpage_condition_operand.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/webpage_condition_operand.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "WebpageConditionOperandProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing webpage condition operand.
@@ -52,6 +52,4 @@ message WebpageConditionOperandEnum {
// Operand denoting a webpage custom label targeting condition.
CUSTOM_LABEL = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/enums/webpage_condition_operator.proto b/third_party/googleapis/google/ads/googleads/v13/enums/webpage_condition_operator.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/enums/webpage_condition_operator.proto
rename to third_party/googleapis/google/ads/googleads/v13/enums/webpage_condition_operator.proto
index 376e46555..25a0ba31c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/enums/webpage_condition_operator.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/enums/webpage_condition_operator.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.enums;
+package google.ads.googleads.v13.enums;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Enums";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/enums;enums";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Enums";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/enums;enums";
option java_multiple_files = true;
option java_outer_classname = "WebpageConditionOperatorProto";
-option java_package = "com.google.ads.googleads.v10.enums";
+option java_package = "com.google.ads.googleads.v13.enums";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Enums";
-option ruby_package = "Google::Ads::GoogleAds::V10::Enums";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Enums";
+option ruby_package = "Google::Ads::GoogleAds::V13::Enums";
// Proto file describing webpage condition operator.
@@ -44,6 +44,4 @@ message WebpageConditionOperatorEnum {
// The argument web condition is part of the compared web condition.
CONTAINS = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/BUILD.bazel b/third_party/googleapis/google/ads/googleads/v13/errors/BUILD.bazel
similarity index 96%
rename from third_party/googleapis/google/ads/googleads/v10/errors/BUILD.bazel
rename to third_party/googleapis/google/ads/googleads/v13/errors/BUILD.bazel
index a74532175..3076a9c48 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/BUILD.bazel
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/BUILD.bazel
@@ -26,8 +26,8 @@ proto_library(
name = "errors_proto",
srcs = glob(["*.proto"]),
deps = [
- "//google/ads/googleads/v10/common:common_proto",
- "//google/ads/googleads/v10/enums:enums_proto",
+ "//google/ads/googleads/v13/common:common_proto",
+ "//google/ads/googleads/v13/enums:enums_proto",
"//google/api:annotations_proto",
"@com_google_protobuf//:duration_proto",
"@com_google_protobuf//:wrappers_proto",
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/access_invitation_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/access_invitation_error.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/errors/access_invitation_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/access_invitation_error.proto
index 5abb15e83..5099ee25f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/access_invitation_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/access_invitation_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AccessInvitationErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing AccessInvitation errors.
@@ -49,7 +49,7 @@ message AccessInvitationErrorEnum {
// Email address cannot be like abc+foo@google.com.
GOOGLE_CONSUMER_ACCOUNT_NOT_ALLOWED = 5;
- // Invalid invitation id.
+ // Invalid invitation ID.
INVALID_INVITATION_ID = 6;
// Email address already has a pending invitation.
@@ -58,10 +58,8 @@ message AccessInvitationErrorEnum {
// Pending invitation limit exceeded for the customer.
PENDING_INVITATIONS_LIMIT_EXCEEDED = 8;
- // Email address doesn't conform to the email domain policy. Please see
+ // Email address doesn't conform to the email domain policy. See
// https://support.google.com/google-ads/answer/2375456
EMAIL_DOMAIN_POLICY_VIOLATED = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/account_budget_proposal_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/account_budget_proposal_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/account_budget_proposal_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/account_budget_proposal_error.proto
index 02c743d01..d7a40a497 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/account_budget_proposal_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/account_budget_proposal_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AccountBudgetProposalErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing account budget proposal errors.
@@ -107,14 +107,20 @@ message AccountBudgetProposalErrorEnum {
// Mutates are not allowed for the given billing setup.
INVALID_BILLING_SETUP = 23;
- // Budget creation failed as it overlaps with an pending budget proposal
+ // Budget creation failed as it overlaps with a pending budget proposal
// or an approved budget.
OVERLAPS_EXISTING_BUDGET = 24;
// The control setting in user's payments profile doesn't allow budget
// creation through API. Log in to Google Ads to create budget.
CANNOT_CREATE_BUDGET_THROUGH_API = 25;
- }
+ // Master service agreement has not been signed yet for the Payments
+ // Profile.
+ INVALID_MASTER_SERVICE_AGREEMENT = 26;
+ // Budget mutates are not allowed because the given billing setup is
+ // canceled.
+ CANCELED_BILLING_SETUP = 27;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/account_link_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/account_link_error.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/errors/account_link_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/account_link_error.proto
index b465b1717..18a9b186f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/account_link_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/account_link_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AccountLinkErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing AccountLink errors.
@@ -39,7 +39,8 @@ message AccountLinkErrorEnum {
// The new link status is invalid.
INVALID_STATUS = 2;
- }
-
+ // The authenticated user doesn't have the permission to do the change.
+ PERMISSION_DENIED = 3;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/ad_customizer_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/ad_customizer_error.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/errors/ad_customizer_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/ad_customizer_error.proto
index 5d0bb95ed..7c1caaa9f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/ad_customizer_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/ad_customizer_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdCustomizerErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ad customizer errors.
@@ -52,6 +52,4 @@ message AdCustomizerErrorEnum {
// A user list referenced in an IF function does not exist.
UNKNOWN_USER_LIST = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/ad_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/ad_error.proto
similarity index 95%
rename from third_party/googleapis/google/ads/googleads/v10/errors/ad_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/ad_error.proto
index bd52a7c5b..23954488b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/ad_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/ad_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ad errors.
@@ -113,12 +113,12 @@ message AdErrorEnum {
// Display Url cannot be specified (applies to Ad Exchange Ads)
DISPLAY_URL_CANNOT_BE_SPECIFIED = 27;
- // Telephone number contains invalid characters or invalid format. Please
- // re-enter your number using digits (0-9), dashes (-), and parentheses
+ // Telephone number contains invalid characters or invalid format.
+ // Re-enter your number using digits (0-9), dashes (-), and parentheses
// only.
DOMESTIC_PHONE_NUMBER_FORMAT = 28;
- // Emergency telephone numbers are not allowed. Please enter a valid
+ // Emergency telephone numbers are not allowed. Enter a valid
// domestic phone number to connect customers to your business.
EMERGENCY_PHONE_NUMBER = 29;
@@ -195,7 +195,7 @@ message AdErrorEnum {
// Wrong number of elements for given element type
INVALID_NUMBER_OF_ELEMENTS = 52;
- // The format of the telephone number is incorrect. Please re-enter the
+ // The format of the telephone number is incorrect. Re-enter the
// number using the correct format.
INVALID_PHONE_NUMBER_FORMAT = 53;
@@ -233,11 +233,11 @@ message AdErrorEnum {
// Description (line 3) must be entered.
MISSING_DESCRIPTION2 = 64;
- // The destination url must contain at least one tag (e.g. {lpurl})
+ // The destination url must contain at least one tag (for example, {lpurl})
MISSING_DESTINATION_URL_TAG = 65;
// The tracking url template of ExpandedDynamicSearchAd must contain at
- // least one tag. (e.g. {lpurl})
+ // least one tag. (for example, {lpurl})
MISSING_LANDING_PAGE_URL_TAG = 66;
// A valid dimension must be specified for this ad.
@@ -345,7 +345,7 @@ message AdErrorEnum {
URL_QUERY_NOT_ALLOWED = 100;
// A url scheme is not allowed in front of tag in tracking url template
- // (e.g. http://{lpurl})
+ // (for example, http://{lpurl})
URL_SCHEME_BEFORE_EXPANDED_DYNAMIC_SEARCH_AD_TAG = 102;
// The user does not have permissions to create a template ad for the given
@@ -438,7 +438,7 @@ message AdErrorEnum {
INCOMPATIBLE_WITH_RESTRICTION_TYPE = 130;
// Consent for call recording is required for creating/updating call only
- // ads. Please see https://support.google.com/google-ads/answer/7412639.
+ // ads. See https://support.google.com/google-ads/answer/7412639.
CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIRED = 131;
// Either an image or a media bundle is required in a display upload ad.
@@ -523,6 +523,4 @@ message AdErrorEnum {
// Images must be unique between different carousel card assets.
DUPLICATE_IMAGE_ACROSS_CAROUSEL_CARDS = 156;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_ad_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_ad_error.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/errors/ad_group_ad_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/ad_group_ad_error.proto
index 1243c1476..8de5c34da 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_ad_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_ad_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ad group ad errors.
@@ -73,6 +73,4 @@ message AdGroupAdErrorEnum {
// are permitted.
CANNOT_UPDATE_DEPRECATED_ADS = 12;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_bid_modifier_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_bid_modifier_error.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/errors/ad_group_bid_modifier_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/ad_group_bid_modifier_error.proto
index fbdc4480f..ec2d7348e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_bid_modifier_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_bid_modifier_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdGroupBidModifierErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ad group bid modifier errors.
@@ -44,6 +44,4 @@ message AdGroupBidModifierErrorEnum {
// campaign is opted out of the same criterion.
CANNOT_OVERRIDE_OPTED_OUT_CAMPAIGN_CRITERION_BID_MODIFIER = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_criterion_customizer_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_criterion_customizer_error.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/errors/ad_group_criterion_customizer_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/ad_group_criterion_customizer_error.proto
index 76005555e..f2810affd 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_criterion_customizer_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_criterion_customizer_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionCustomizerErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ad group criterion customizer errors.
@@ -40,6 +40,4 @@ message AdGroupCriterionCustomizerErrorEnum {
// Only keyword type criterion is allowed to link customizer attribute.
CRITERION_IS_NOT_KEYWORD = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_criterion_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_criterion_error.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/errors/ad_group_criterion_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/ad_group_criterion_error.proto
index 9a8787217..97f2e0b3a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_criterion_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_criterion_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ad group criterion errors.
@@ -71,7 +71,7 @@ message AdGroupCriterionErrorEnum {
// Destination URL was invalid.
INVALID_DESTINATION_URL = 12;
- // The destination url must contain at least one tag (e.g. {lpurl})
+ // The destination url must contain at least one tag (for example, {lpurl})
MISSING_DESTINATION_URL_TAG = 13;
// Keyword-level cpm bid is not supported
@@ -95,7 +95,7 @@ message AdGroupCriterionErrorEnum {
CAMPAIGN_TYPE_NOT_COMPATIBLE_WITH_PARTIAL_FAILURE = 27;
// Operations in the mutate request changes too many shopping ad groups.
- // Please split requests for multiple shopping ad groups across multiple
+ // Split requests for multiple shopping ad groups across multiple
// requests.
OPERATIONS_FOR_TOO_MANY_SHOPPING_ADGROUPS = 28;
@@ -130,6 +130,4 @@ message AdGroupCriterionErrorEnum {
// Final mobile urls are not supported for this criterion type.
FINAL_MOBILE_URLS_NOT_SUPPORTED_FOR_CRITERION_TYPE = 38;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_customizer_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_customizer_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/ad_group_customizer_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/ad_group_customizer_error.proto
index 83ac4b2d9..d59044507 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_customizer_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_customizer_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCustomizerErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ad group customizer errors.
@@ -37,6 +37,4 @@ message AdGroupCustomizerErrorEnum {
// The received error code is not known in this version.
UNKNOWN = 1;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/ad_group_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/ad_group_error.proto
index adf02bca4..60121e824 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdGroupErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ad group errors.
@@ -83,7 +83,9 @@ message AdGroupErrorEnum {
// The field type cannot be excluded because an active ad group-asset link
// of this type exists.
INVALID_EXCLUDED_PARENT_ASSET_FIELD_TYPE = 16;
- }
-
+ // The asset set type is invalid for setting the
+ // excluded_parent_asset_set_types field.
+ INVALID_EXCLUDED_PARENT_ASSET_SET_TYPE = 17;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_feed_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_feed_error.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/errors/ad_group_feed_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/ad_group_feed_error.proto
index bc36bb22f..8c7c7247b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/ad_group_feed_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/ad_group_feed_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdGroupFeedErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ad group feed errors.
@@ -60,6 +60,4 @@ message AdGroupFeedErrorEnum {
// CustomerFeed for the specified feed.
NO_EXISTING_LOCATION_CUSTOMER_FEED = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/ad_parameter_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/ad_parameter_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/ad_parameter_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/ad_parameter_error.proto
index ffe5089bb..ca790cdaf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/ad_parameter_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/ad_parameter_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdParameterErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ad parameter errors.
@@ -43,6 +43,4 @@ message AdParameterErrorEnum {
// The insertion text is invalid.
INVALID_INSERTION_TEXT_FORMAT = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/ad_sharing_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/ad_sharing_error.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/errors/ad_sharing_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/ad_sharing_error.proto
index 781018c72..d66dd7cc0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/ad_sharing_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/ad_sharing_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdSharingErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ad sharing errors.
@@ -47,6 +47,4 @@ message AdSharingErrorEnum {
// Cannot add AdGroupAd on inactive Ad.
CANNOT_SHARE_INACTIVE_AD = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/adx_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/adx_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/adx_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/adx_error.proto
index 1170ec66e..5ab4488b7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/adx_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/adx_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AdxErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing adx errors.
@@ -40,6 +40,4 @@ message AdxErrorEnum {
// Attempt to use non-AdX feature by AdX customer.
UNSUPPORTED_FEATURE = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/asset_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/asset_error.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/errors/asset_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/asset_error.proto
index 872c9c363..c8b90d8fd 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/asset_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/asset_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AssetErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing asset errors.
@@ -142,7 +142,11 @@ message AssetErrorEnum {
// Unique name is required for this asset type.
NAME_CONFLICT_FOR_ASSET_TYPE = 34;
- }
+ // Cannot modify asset source.
+ CANNOT_MODIFY_ASSET_SOURCE = 35;
+ // User can not modify the automatically created asset.
+ CANNOT_MODIFY_AUTOMATICALLY_CREATED_ASSET = 36;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/asset_group_asset_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/asset_group_asset_error.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/errors/asset_group_asset_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/asset_group_asset_error.proto
index a5908c2cf..10ec7a619 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/asset_group_asset_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/asset_group_asset_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupAssetErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing asset group asset errors.
@@ -45,7 +45,9 @@ message AssetGroupAssetErrorEnum {
// Ad customizers are not supported in assetgroup's text assets.
AD_CUSTOMIZER_NOT_SUPPORTED = 4;
- }
-
+ // Cannot add a HotelPropertyAsset to an AssetGroup that isn't linked
+ // to the parent campaign's hotel_property_asset_set field.
+ HOTEL_PROPERTY_ASSET_NOT_LINKED_TO_CAMPAIGN = 5;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/asset_group_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/asset_group_error.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/errors/asset_group_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/asset_group_error.proto
index 108c35943..365b3f830 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/asset_group_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/asset_group_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing asset group errors.
@@ -67,6 +67,4 @@ message AssetGroupErrorEnum {
// Final url and shopping merchant url does not have the same domain.
FINAL_URL_SHOPPING_MERCHANT_HOME_PAGE_URL_DOMAINS_DIFFER = 11;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/asset_group_listing_group_filter_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/asset_group_listing_group_filter_error.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/errors/asset_group_listing_group_filter_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/asset_group_listing_group_filter_error.proto
index d4adb9286..40e799530 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/asset_group_listing_group_filter_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/asset_group_listing_group_filter_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupListingGroupFilterErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing asset group asset errors.
@@ -78,6 +78,4 @@ message AssetGroupListingGroupFilterErrorEnum {
// Dimension can't subdivide everything-else node in its own hierarchy.
CANNOT_REFINE_HIERARCHICAL_EVERYTHING_ELSE = 14;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/asset_link_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/asset_link_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/asset_link_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/asset_link_error.proto
index 1f6ace507..87aa5bebd 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/asset_link_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/asset_link_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AssetLinkErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing asset link errors.
@@ -40,7 +40,7 @@ message AssetLinkErrorEnum {
// Pinning is not supported for the given asset link field.
PINNING_UNSUPPORTED = 2;
- // The given field type is not supported to be added directly via asset
+ // The given field type is not supported to be added directly through asset
// links.
UNSUPPORTED_FIELD_TYPE = 3;
@@ -70,9 +70,9 @@ message AssetLinkErrorEnum {
NOT_ENOUGH_AVAILABLE_ASSET_LINKS_FOR_VALID_COMBINATION = 10;
// Not enough assets with fallback are available. When validating the
- // minimum number of assets, assets without fallback (e.g. assets that
- // contain location tag without default value "{LOCATION(City)}") will not
- // be counted.
+ // minimum number of assets, assets without fallback (for example, assets
+ // that contain location tag without default value "{LOCATION(City)}") will
+ // not be counted.
NOT_ENOUGH_AVAILABLE_ASSET_LINKS_WITH_FALLBACK = 11;
// This is a combination of the
@@ -92,6 +92,9 @@ message AssetLinkErrorEnum {
// field submitted.
YOUTUBE_VIDEO_TOO_SHORT = 15;
+ // The specified field type is excluded for given campaign or ad group.
+ EXCLUDED_PARENT_FIELD_TYPE = 16;
+
// The status is invalid for the operation specified.
INVALID_STATUS = 17;
@@ -100,7 +103,15 @@ message AssetLinkErrorEnum {
// uploaded to YouTube. In both cases, the video duration should eventually
// get resolved.
YOUTUBE_VIDEO_DURATION_NOT_DEFINED = 18;
- }
+ // User cannot create automatically created links.
+ CANNOT_CREATE_AUTOMATICALLY_CREATED_LINKS = 19;
+ // Advertiser links cannot link to automatically created asset.
+ CANNOT_LINK_TO_AUTOMATICALLY_CREATED_ASSET = 20;
+
+ // Automatically created links cannot be changed into adveritser links or
+ // the reverse.
+ CANNOT_MODIFY_ASSET_LINK_SOURCE = 21;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/asset_set_asset_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/asset_set_asset_error.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/errors/asset_set_asset_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/asset_set_asset_error.proto
index 9f0d6f6d3..f3dd6fba1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/asset_set_asset_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/asset_set_asset_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AssetSetAssetErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing asset set asset errors.
@@ -48,7 +48,10 @@ message AssetSetAssetErrorEnum {
// The asset contains duplicate external key with another asset in the asset
// set.
DUPLICATE_EXTERNAL_KEY = 4;
- }
-
+ // When attaching a Location typed Asset to a LocationGroup typed AssetSet,
+ // the AssetSetAsset linkage between the parent LocationSync AssetSet and
+ // the Asset doesn't exist.
+ PARENT_LINKAGE_DOES_NOT_EXIST = 5;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/errors/asset_set_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/asset_set_error.proto
new file mode 100644
index 000000000..7ff8632a8
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/asset_set_error.proto
@@ -0,0 +1,79 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.errors;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
+option java_multiple_files = true;
+option java_outer_classname = "AssetSetErrorProto";
+option java_package = "com.google.ads.googleads.v13.errors";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
+
+// Proto file describing asset set errors.
+
+// Container for enum describing possible asset set errors.
+message AssetSetErrorEnum {
+ // Enum describing possible asset set errors.
+ enum AssetSetError {
+ // Enum unspecified.
+ UNSPECIFIED = 0;
+
+ // The received error code is not known in this version.
+ UNKNOWN = 1;
+
+ // The asset set name matches that of another enabled asset set.
+ DUPLICATE_ASSET_SET_NAME = 2;
+
+ // The type of AssetSet.asset_set_source does not match the type of
+ // AssetSet.location_set.source in its parent AssetSet.
+ INVALID_PARENT_ASSET_SET_TYPE = 3;
+
+ // The asset set source doesn't match its parent AssetSet's data.
+ ASSET_SET_SOURCE_INCOMPATIBLE_WITH_PARENT_ASSET_SET = 4;
+
+ // This AssetSet type cannot be linked to CustomerAssetSet.
+ ASSET_SET_TYPE_CANNOT_BE_LINKED_TO_CUSTOMER = 5;
+
+ // The chain id(s) in ChainSet of a LOCATION_SYNC typed AssetSet is invalid.
+ INVALID_CHAIN_IDS = 6;
+
+ // The relationship type in ChainSet of a LOCATION_SYNC typed AssetSet is
+ // not supported.
+ LOCATION_SYNC_ASSET_SET_DOES_NOT_SUPPORT_RELATIONSHIP_TYPE = 7;
+
+ // There is more than one enabled LocationSync typed AssetSet under one
+ // customer.
+ NOT_UNIQUE_ENABLED_LOCATION_SYNC_TYPED_ASSET_SET = 8;
+
+ // The place id(s) in a LocationSync typed AssetSet is invalid and can't be
+ // decoded.
+ INVALID_PLACE_IDS = 9;
+
+ // The Google Business Profile OAuth info is invalid.
+ OAUTH_INFO_INVALID = 11;
+
+ // The Google Business Profile OAuth info is missing.
+ OAUTH_INFO_MISSING = 12;
+
+ // Can't delete an AssetSet if it has any enabled linkages (e.g.
+ // CustomerAssetSet), or AssetSet is a parent AssetSet and has enabled child
+ // AssetSet associated.
+ CANNOT_DELETE_AS_ENABLED_LINKAGES_EXIST = 10;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/asset_set_link_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/asset_set_link_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/asset_set_link_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/asset_set_link_error.proto
index a486ffe1b..1bdc7fdef 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/asset_set_link_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/asset_set_link_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AssetSetLinkErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing asset set link errors.
@@ -54,6 +54,4 @@ message AssetSetLinkErrorEnum {
// asset set and you attempt to unlink them, this error will be triggered.
ASSET_SET_LINK_CANNOT_BE_REMOVED = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/audience_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/audience_error.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/errors/audience_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/audience_error.proto
index 1317485f5..770a636c3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/audience_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/audience_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AudienceErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing audience errors.
@@ -63,6 +63,4 @@ message AudienceErrorEnum {
// ad group or campaign.
IN_USE = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/errors/audience_insights_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/audience_insights_error.proto
new file mode 100644
index 000000000..98ef924fa
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/audience_insights_error.proto
@@ -0,0 +1,44 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.errors;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
+option java_multiple_files = true;
+option java_outer_classname = "AudienceInsightsErrorProto";
+option java_package = "com.google.ads.googleads.v13.errors";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
+
+// Proto file describing errors generated from AudienceInsightsService.
+
+// Container for enum describing possible errors returned from
+// the AudienceInsightsService.
+message AudienceInsightsErrorEnum {
+ // Enum describing possible errors from AudienceInsightsService.
+ enum AudienceInsightsError {
+ // Enum unspecified.
+ UNSPECIFIED = 0;
+
+ // The received error code is not known in this version.
+ UNKNOWN = 1;
+
+ // The dimensions cannot be used with topic audience combinations.
+ DIMENSION_INCOMPATIBLE_WITH_TOPIC_AUDIENCE_COMBINATIONS = 2;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/authentication_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/authentication_error.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/errors/authentication_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/authentication_error.proto
index 8de6db5c8..87e254765 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/authentication_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/authentication_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AuthenticationErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing authentication errors.
@@ -40,13 +40,13 @@ message AuthenticationErrorEnum {
// Authentication of the request failed.
AUTHENTICATION_ERROR = 2;
- // Client Customer ID is not a number.
+ // Client customer ID is not a number.
CLIENT_CUSTOMER_ID_INVALID = 5;
// No customer found for the provided customer ID.
CUSTOMER_NOT_FOUND = 8;
- // Client's Google Account is deleted.
+ // Client's Google account is deleted.
GOOGLE_ACCOUNT_DELETED = 9;
// Google account login token in the cookie is invalid.
@@ -65,25 +65,25 @@ message AuthenticationErrorEnum {
// User in the cookie is not a valid Ads user.
NOT_ADS_USER = 14;
- // Oauth token in the header is not valid.
+ // OAuth token in the header is not valid.
OAUTH_TOKEN_INVALID = 15;
- // Oauth token in the header has expired.
+ // OAuth token in the header has expired.
OAUTH_TOKEN_EXPIRED = 16;
- // Oauth token in the header has been disabled.
+ // OAuth token in the header has been disabled.
OAUTH_TOKEN_DISABLED = 17;
- // Oauth token in the header has been revoked.
+ // OAuth token in the header has been revoked.
OAUTH_TOKEN_REVOKED = 18;
- // Oauth token HTTP header is malformed.
+ // OAuth token HTTP header is malformed.
OAUTH_TOKEN_HEADER_INVALID = 19;
// Login cookie is not valid.
LOGIN_COOKIE_INVALID = 20;
- // User Id in the header is not a valid id.
+ // User ID in the header is not a valid ID.
USER_ID_INVALID = 22;
// An account administrator changed this account's authentication settings.
@@ -96,6 +96,4 @@ message AuthenticationErrorEnum {
// Google account at https://landing.google.com/advancedprotection.
ADVANCED_PROTECTION_NOT_ENROLLED = 24;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/authorization_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/authorization_error.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/errors/authorization_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/authorization_error.proto
index aca006d5e..8fe5dbbcc 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/authorization_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/authorization_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "AuthorizationErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing authorization errors.
@@ -57,21 +57,22 @@ message AuthorizationErrorEnum {
AUTHORIZATION_ERROR = 6;
// The user does not have permission to perform this action
- // (e.g., ADD, UPDATE, REMOVE) on the resource or call a method.
+ // (for example, ADD, UPDATE, REMOVE) on the resource or call a method.
ACTION_NOT_PERMITTED = 7;
// Signup not complete.
INCOMPLETE_SIGNUP = 8;
- // The customer can't be used because it isn't enabled.
+ // The customer account can't be accessed because it is not yet enabled or
+ // has been deactivated.
CUSTOMER_NOT_ENABLED = 24;
// The developer must sign the terms of service. They can be found here:
// ads.google.com/aw/apicenter
MISSING_TOS = 9;
- // The developer token is not approved. Non-approved developer tokens can
- // only be used with test accounts.
+ // The developer token is only approved for use with test accounts. To
+ // access non-test accounts, apply for Basic or Standard access.
DEVELOPER_TOKEN_NOT_APPROVED = 10;
// The login customer specified does not have access to the account
@@ -88,6 +89,4 @@ message AuthorizationErrorEnum {
// The developer does not have access to the metrics queried.
METRIC_ACCESS_DENIED = 26;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/batch_job_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/batch_job_error.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/errors/batch_job_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/batch_job_error.proto
index 7aa9b5159..798048432 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/batch_job_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/batch_job_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "BatchJobErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing batch job errors.
@@ -56,6 +56,4 @@ message BatchJobErrorEnum {
// The batch job cannot be removed because it has started running.
CAN_ONLY_REMOVE_PENDING_JOB = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/bidding_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/bidding_error.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/errors/bidding_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/bidding_error.proto
index 7fa0ad9b1..9d8d856b0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/bidding_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/bidding_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "BiddingErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing bidding errors.
@@ -55,20 +55,14 @@ message BiddingErrorEnum {
// Bidding strategy is not available for the account type.
BIDDING_STRATEGY_NOT_AVAILABLE_FOR_ACCOUNT_TYPE = 18;
- // Conversion tracking is not enabled in the campaign that has value-based
- // bidding transitions.
- CONVERSION_TRACKING_NOT_ENABLED = 19;
-
- // Not enough conversions tracked for value-based bidding transitions.
- NOT_ENOUGH_CONVERSIONS = 20;
-
// Campaign can not be created with given bidding strategy. It can be
// transitioned to the strategy, once eligible.
CANNOT_CREATE_CAMPAIGN_WITH_BIDDING_STRATEGY = 21;
// Cannot target content network only as campaign uses Page One Promoted
// bidding strategy.
- CANNOT_TARGET_CONTENT_NETWORK_ONLY_WITH_CAMPAIGN_LEVEL_POP_BIDDING_STRATEGY = 23;
+ CANNOT_TARGET_CONTENT_NETWORK_ONLY_WITH_CAMPAIGN_LEVEL_POP_BIDDING_STRATEGY =
+ 23;
// Budget Optimizer and Target Spend bidding strategies are not supported
// for campaigns with AdSchedule targeting.
@@ -106,12 +100,6 @@ message BiddingErrorEnum {
// The field is not compatible with the payment mode.
NOT_COMPATIBLE_WITH_PAYMENT_MODE = 34;
- // The field is not compatible with the budget type.
- NOT_COMPATIBLE_WITH_BUDGET_TYPE = 35;
-
- // The field is not compatible with the bidding strategy type.
- NOT_COMPATIBLE_WITH_BIDDING_STRATEGY_TYPE = 36;
-
// Bidding strategy type is incompatible with shared budget.
BIDDING_STRATEGY_TYPE_INCOMPATIBLE_WITH_SHARED_BUDGET = 37;
@@ -121,11 +109,13 @@ message BiddingErrorEnum {
// The attached bidding strategy and budget must be attached to the same
// campaigns to become aligned.
- BIDDING_STRATEGY_AND_BUDGET_MUST_BE_ATTACHED_TO_THE_SAME_CAMPAIGNS_TO_ALIGN = 39;
+ BIDDING_STRATEGY_AND_BUDGET_MUST_BE_ATTACHED_TO_THE_SAME_CAMPAIGNS_TO_ALIGN =
+ 39;
// The aligned bidding strategy and budget must be removed at the same time.
BIDDING_STRATEGY_AND_BUDGET_MUST_BE_REMOVED_TOGETHER = 40;
- }
-
+ // cpc_bid_floor_micros is greater than cpc_bid_ceiling_micros.
+ CPC_BID_FLOOR_MICROS_GREATER_THAN_CPC_BID_CEILING_MICROS = 41;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/bidding_strategy_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/bidding_strategy_error.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/errors/bidding_strategy_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/bidding_strategy_error.proto
index 8d5a682f6..66360af76 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/bidding_strategy_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/bidding_strategy_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "BiddingStrategyErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing bidding strategy errors.
@@ -54,6 +54,4 @@ message BiddingStrategyErrorEnum {
// strategy goal type.
INCOMPATIBLE_BIDDING_STRATEGY_AND_BIDDING_STRATEGY_GOAL_TYPE = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/billing_setup_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/billing_setup_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/billing_setup_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/billing_setup_error.proto
index 6d2778780..f98c36e16 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/billing_setup_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/billing_setup_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "BillingSetupErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing billing setup errors.
@@ -94,6 +94,10 @@ message BillingSetupErrorEnum {
// approval.
CUSTOMER_NEEDS_INTERNAL_APPROVAL = 17;
+ // Billing setup creation failed because the user needs to accept master
+ // service agreement on the payments profile.
+ PAYMENTS_PROFILE_NEEDS_SERVICE_AGREEMENT_ACCEPTANCE = 18;
+
// Payments account has different currency code than the current customer
// and hence cannot be used to setup billing.
PAYMENTS_ACCOUNT_INELIGIBLE_CURRENCY_CODE_MISMATCH = 19;
@@ -101,7 +105,8 @@ message BillingSetupErrorEnum {
// A start time in the future cannot be used because there is currently no
// active billing setup for this customer.
FUTURE_START_TIME_PROHIBITED = 20;
- }
-
+ // The payments account has maximum number of billing setups.
+ TOO_MANY_BILLING_SETUPS_FOR_PAYMENTS_ACCOUNT = 21;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_budget_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_budget_error.proto
similarity index 88%
rename from third_party/googleapis/google/ads/googleads/v10/errors/campaign_budget_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/campaign_budget_error.proto
index 52e6e5fe3..9ca9ee2ff 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_budget_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_budget_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CampaignBudgetErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing campaign budget errors.
@@ -92,7 +92,8 @@ message CampaignBudgetErrorEnum {
// The period of the budget is not allowed.
INVALID_PERIOD = 19;
- }
-
+ // Cannot use accelerated delivery method on this budget.
+ CANNOT_USE_ACCELERATED_DELIVERY_MODE = 20;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_conversion_goal_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_conversion_goal_error.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/errors/campaign_conversion_goal_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/campaign_conversion_goal_error.proto
index 37198d630..ec35f0a5a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_conversion_goal_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_conversion_goal_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CampaignConversionGoalErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing campaign conversion goal errors.
@@ -40,6 +40,4 @@ message CampaignConversionGoalErrorEnum {
// Campaign is managed by Search Ads 360 but uses Unified Goal.
CANNOT_USE_CAMPAIGN_GOAL_FOR_SEARCH_ADS_360_MANAGED_CAMPAIGN = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_criterion_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_criterion_error.proto
similarity index 68%
rename from third_party/googleapis/google/ads/googleads/v10/errors/campaign_criterion_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/campaign_criterion_error.proto
index 706a55d0b..0758a9029 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_criterion_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_criterion_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CampaignCriterionErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing campaign criterion errors.
@@ -91,7 +91,33 @@ message CampaignCriterionErrorEnum {
// A Smart campaign may not target multiple proximity criteria.
CANNOT_TARGET_MULTIPLE_PROXIMITY_CRITERIA_FOR_SMART_CAMPAIGN = 17;
- }
+ // Location is not launched for Local Services Campaigns.
+ LOCATION_NOT_LAUNCHED_FOR_LOCAL_SERVICES_CAMPAIGN = 18;
+
+ // A Local Services campaign may not target certain criteria types.
+ LOCATION_INVALID_FOR_LOCAL_SERVICES_CAMPAIGN = 19;
+
+ // Country locations are not supported for Local Services campaign.
+ CANNOT_TARGET_COUNTRY_FOR_LOCAL_SERVICES_CAMPAIGN = 20;
+
+ // Location is not within the home country of Local Services campaign.
+ LOCATION_NOT_IN_HOME_COUNTRY_FOR_LOCAL_SERVICES_CAMPAIGN = 21;
+ // Local Services profile does not exist for a particular Local Services
+ // campaign.
+ CANNOT_ADD_OR_REMOVE_LOCATION_FOR_LOCAL_SERVICES_CAMPAIGN = 22;
+
+ // Local Services campaign must have at least one target location.
+ AT_LEAST_ONE_POSITIVE_LOCATION_REQUIRED_FOR_LOCAL_SERVICES_CAMPAIGN = 23;
+
+ // At least one positive local service ID criterion is required for a Local
+ // Services campaign.
+ AT_LEAST_ONE_LOCAL_SERVICE_ID_CRITERION_REQUIRED_FOR_LOCAL_SERVICES_CAMPAIGN =
+ 24;
+
+ // Local service ID is not found under selected categories in local
+ // services campaign setting.
+ LOCAL_SERVICE_ID_NOT_FOUND_FOR_CATEGORY = 25;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_customizer_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_customizer_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/campaign_customizer_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/campaign_customizer_error.proto
index 3b24303ea..66ec10ef9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_customizer_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_customizer_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CampaignCustomizerErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing campaign customizer errors.
@@ -37,6 +37,4 @@ message CampaignCustomizerErrorEnum {
// The received error code is not known in this version.
UNKNOWN = 1;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_draft_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_draft_error.proto
similarity index 88%
rename from third_party/googleapis/google/ads/googleads/v10/errors/campaign_draft_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/campaign_draft_error.proto
index 1138aab02..95d842ae6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_draft_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_draft_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CampaignDraftErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing campaign draft errors.
@@ -72,6 +72,4 @@ message CampaignDraftErrorEnum {
// ListAsyncErrors was called without first promoting the draft.
LIST_ERRORS_FOR_PROMOTED_DRAFT_ONLY = 11;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_error.proto
similarity index 66%
rename from third_party/googleapis/google/ads/googleads/v10/errors/campaign_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/campaign_error.proto
index 12da45cfa..c817849ba 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CampaignErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing campaign errors.
@@ -193,7 +193,88 @@ message CampaignErrorEnum {
// The type of the Budget is not compatible with this Campaign.
INCOMPATIBLE_BUDGET_TYPE = 52;
- }
+ // Category bid list in the local services campaign setting contains
+ // multiple bids for the same category ID.
+ LOCAL_SERVICES_DUPLICATE_CATEGORY_BID = 53;
+
+ // Category bid list in the local services campaign setting contains
+ // a bid for an invalid category ID.
+ LOCAL_SERVICES_INVALID_CATEGORY_BID = 54;
+
+ // Category bid list in the local services campaign setting is missing a
+ // bid for a category ID that must be present.
+ LOCAL_SERVICES_MISSING_CATEGORY_BID = 55;
+
+ // The requested change in status is not supported.
+ INVALID_STATUS_CHANGE = 57;
+
+ // Travel Campaign's travel_account_id does not match any customer links.
+ MISSING_TRAVEL_CUSTOMER_LINK = 58;
+
+ // Travel Campaign's travel_account_id matches an existing customer link
+ // but the customer link is not active.
+ INVALID_TRAVEL_CUSTOMER_LINK = 59;
+
+ // The asset set type is invalid to be set in
+ // excluded_parent_asset_set_types field.
+ INVALID_EXCLUDED_PARENT_ASSET_SET_TYPE = 62;
+
+ // Campaign.hotel_property_asset_set must point to an asset set of type
+ // HOTEL_PROPERTY.
+ ASSET_SET_NOT_A_HOTEL_PROPERTY_ASSET_SET = 63;
+
+ // The hotel property asset set can only be set on Performance Max for
+ // travel goals campaigns.
+ HOTEL_PROPERTY_ASSET_SET_ONLY_FOR_PERFORMANCE_MAX_FOR_TRAVEL_GOALS = 64;
+
+ // Customer's average daily spend is too high to enable this feature.
+ AVERAGE_DAILY_SPEND_TOO_HIGH = 65;
+
+ // Cannot attach the campaign to a deleted campaign group.
+ CANNOT_ATTACH_TO_REMOVED_CAMPAIGN_GROUP = 66;
+
+ // Cannot attach the campaign to this bidding strategy.
+ CANNOT_ATTACH_TO_BIDDING_STRATEGY = 67;
+ // A budget with a different period cannot be assigned to the campaign.
+ CANNOT_CHANGE_BUDGET_PERIOD = 68;
+
+ // Customer does not have enough conversions to enable this feature.
+ NOT_ENOUGH_CONVERSIONS = 71;
+
+ // This campaign type can only have one conversion action.
+ CANNOT_SET_MORE_THAN_ONE_CONVERSION_ACTION = 72;
+
+ // The field is not compatible with the budget type.
+ NOT_COMPATIBLE_WITH_BUDGET_TYPE = 73;
+
+ // The feature is incompatible with ConversionActionType.UPLOAD_CLICKS.
+ NOT_COMPATIBLE_WITH_UPLOAD_CLICKS_CONVERSION = 74;
+
+ // App campaign setting app ID must match selective optimization conversion
+ // action app ID.
+ APP_ID_MUST_MATCH_CONVERSION_ACTION_APP_ID = 76;
+
+ // Selective optimization conversion action with Download category is not
+ // allowed.
+ CONVERSION_ACTION_WITH_DOWNLOAD_CATEGORY_NOT_ALLOWED = 77;
+
+ // One software download for selective optimization conversion action is
+ // required for this campaign conversion action.
+ CONVERSION_ACTION_WITH_DOWNLOAD_CATEGORY_REQUIRED = 78;
+
+ // Conversion tracking is not enabled and is required for this feature.
+ CONVERSION_TRACKING_NOT_ENABLED = 79;
+
+ // The field is not compatible with the bidding strategy type.
+ NOT_COMPATIBLE_WITH_BIDDING_STRATEGY_TYPE = 80;
+
+ // Campaign is not compatible with a conversion tracker that has Google
+ // attribution enabled.
+ NOT_COMPATIBLE_WITH_GOOGLE_ATTRIBUTION_CONVERSIONS = 81;
+
+ // Customer level conversion lag is too high.
+ CONVERSION_LAG_TOO_HIGH = 82;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_experiment_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_experiment_error.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/errors/campaign_experiment_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/campaign_experiment_error.proto
index ec2610dc2..424f08693 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_experiment_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_experiment_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CampaignExperimentErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing campaign experiment errors.
@@ -74,6 +74,4 @@ message CampaignExperimentErrorEnum {
// state, such as REMOVED.
CANNOT_MUTATE_EXPERIMENT_DUE_TO_STATUS = 11;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_feed_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_feed_error.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/errors/campaign_feed_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/campaign_feed_error.proto
index 1dc949cfb..5d9167070 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_feed_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_feed_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CampaignFeedErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing campaign feed errors.
@@ -59,7 +59,8 @@ message CampaignFeedErrorEnum {
// Location CampaignFeeds cannot be created unless there is a location
// CustomerFeed for the specified feed.
NO_EXISTING_LOCATION_CUSTOMER_FEED = 9;
- }
-
+ // Feed is read only.
+ LEGACY_FEED_TYPE_READ_ONLY = 10;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_shared_set_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_shared_set_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/campaign_shared_set_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/campaign_shared_set_error.proto
index ce056087d..148062baf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/campaign_shared_set_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/campaign_shared_set_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CampaignSharedSetErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing campaign shared set errors.
@@ -40,6 +40,4 @@ message CampaignSharedSetErrorEnum {
// The shared set belongs to another customer and permission isn't granted.
SHARED_SET_ACCESS_DENIED = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/change_event_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/change_event_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/change_event_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/change_event_error.proto
index e1353c0be..7e2427179 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/change_event_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/change_event_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ChangeEventErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing change event errors.
@@ -56,6 +56,4 @@ message ChangeEventErrorEnum {
// to 10K.
INVALID_LIMIT_CLAUSE = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/change_status_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/change_status_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/change_status_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/change_status_error.proto
index 9c733abf4..ea06d89e0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/change_status_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/change_status_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ChangeStatusErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing change status errors.
@@ -56,6 +56,4 @@ message ChangeStatusErrorEnum {
// to 10K.
INVALID_LIMIT_CLAUSE = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/collection_size_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/collection_size_error.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/errors/collection_size_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/collection_size_error.proto
index e079d17a7..0d889818d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/collection_size_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/collection_size_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CollectionSizeErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing collection size errors.
@@ -43,6 +43,4 @@ message CollectionSizeErrorEnum {
// Too many.
TOO_MANY = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/context_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/context_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/context_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/context_error.proto
index fa78b40b6..b9d11ccf9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/context_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/context_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ContextErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing context errors.
@@ -43,6 +43,4 @@ message ContextErrorEnum {
// The operation is not allowed for removed resources.
OPERATION_NOT_PERMITTED_FOR_REMOVED_RESOURCE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_action_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_action_error.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/errors/conversion_action_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/conversion_action_error.proto
index fa0e3bcdc..408e23605 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_action_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_action_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ConversionActionErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing conversion action errors.
@@ -75,6 +75,4 @@ message ConversionActionErrorEnum {
// Update of this conversion action isn't supported by Google Ads API.
UPDATE_NOT_SUPPORTED = 11;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_adjustment_upload_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_adjustment_upload_error.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/errors/conversion_adjustment_upload_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/conversion_adjustment_upload_error.proto
index 2f28b7477..886354736 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_adjustment_upload_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_adjustment_upload_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ConversionAdjustmentUploadErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing conversion adjustment upload errors.
@@ -38,7 +38,7 @@ message ConversionAdjustmentUploadErrorEnum {
UNKNOWN = 1;
// The specified conversion action was created too recently.
- // Please try the upload again after 4-6 hours have passed since the
+ // Try the upload again after 4-6 hours have passed since the
// conversion action was created.
TOO_RECENT_CONVERSION_ACTION = 2;
@@ -70,7 +70,8 @@ message ConversionAdjustmentUploadErrorEnum {
// Restatements cannot be reported for a conversion action that always uses
// the default value.
- CANNOT_RESTATE_CONVERSION_ACTION_THAT_ALWAYS_USES_DEFAULT_CONVERSION_VALUE = 10;
+ CANNOT_RESTATE_CONVERSION_ACTION_THAT_ALWAYS_USES_DEFAULT_CONVERSION_VALUE =
+ 10;
// The request contained more than 2000 adjustments.
TOO_MANY_ADJUSTMENTS_IN_REQUEST = 11;
@@ -79,11 +80,11 @@ message ConversionAdjustmentUploadErrorEnum {
TOO_MANY_ADJUSTMENTS = 12;
// A restatement with this timestamp already exists for this conversion. To
- // upload another adjustment, please use a different timestamp.
+ // upload another adjustment, use a different timestamp.
RESTATEMENT_ALREADY_EXISTS = 13;
// This adjustment has the same timestamp as another adjustment in the
- // request for this conversion. To upload another adjustment, please use a
+ // request for this conversion. To upload another adjustment, use a
// different timestamp.
DUPLICATE_ADJUSTMENT_IN_REQUEST = 14;
@@ -116,7 +117,7 @@ message ConversionAdjustmentUploadErrorEnum {
DUPLICATE_ENHANCEMENT_IN_REQUEST = 22;
// Per our customer data policies, enhancement has been prohibited in your
- // account. If you have any questions, please contact your Google
+ // account. If you have any questions, contact your Google
// representative.
CUSTOMER_DATA_POLICY_PROHIBITS_ENHANCEMENT = 23;
@@ -124,7 +125,9 @@ message ConversionAdjustmentUploadErrorEnum {
// does not have an order_id. The order_id is required for an adjustment for
// a WEBPAGE conversion action.
MISSING_ORDER_ID_FOR_WEBPAGE = 24;
- }
-
+ // The order_id contains personally identifiable information (PII), such as
+ // an email address or phone number.
+ ORDER_ID_CONTAINS_PII = 25;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_custom_variable_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_custom_variable_error.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/errors/conversion_custom_variable_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/conversion_custom_variable_error.proto
index bd5edc52a..e64a965ff 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_custom_variable_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_custom_variable_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ConversionCustomVariableErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing conversion custom variable errors.
@@ -47,6 +47,4 @@ message ConversionCustomVariableErrorEnum {
// uses.
RESERVED_TAG = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_goal_campaign_config_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_goal_campaign_config_error.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/errors/conversion_goal_campaign_config_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/conversion_goal_campaign_config_error.proto
index abed434e5..db03f7cb2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_goal_campaign_config_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_goal_campaign_config_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ConversionGoalCampaignConfigErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing conversion goal campaign config errors.
@@ -48,6 +48,4 @@ message ConversionGoalCampaignConfigErrorEnum {
// The campaign is not allowed to use unified goals.
CAMPAIGN_CANNOT_USE_UNIFIED_GOALS = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_upload_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_upload_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/conversion_upload_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/conversion_upload_error.proto
index 3d50f3ac7..bdabcf04c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_upload_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_upload_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ConversionUploadErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing conversion upload errors.
@@ -53,7 +53,7 @@ message ConversionUploadErrorEnum {
EXPIRED_EVENT = 43;
// The click associated with the given identifier or iOS URL parameter
- // occurred too recently. Please try uploading again after 6 hours have
+ // occurred too recently. Try uploading again after 6 hours have
// passed since the click occurred.
TOO_RECENT_EVENT = 44;
@@ -71,7 +71,7 @@ message ConversionUploadErrorEnum {
INVALID_CONVERSION_ACTION = 9;
// The specified conversion action was created too recently.
- // Please try the upload again after 4-6 hours have passed since the
+ // Try the upload again after 4-6 hours have passed since the
// conversion action was created.
TOO_RECENT_CONVERSION_ACTION = 10;
@@ -81,13 +81,15 @@ message ConversionUploadErrorEnum {
// The specified conversion action does not use an external attribution
// model, but external_attribution_data was set.
- EXTERNAL_ATTRIBUTION_DATA_SET_FOR_NON_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION = 12;
+ EXTERNAL_ATTRIBUTION_DATA_SET_FOR_NON_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION =
+ 12;
// The specified conversion action uses an external attribution model, but
// external_attribution_data or one of its contained fields was not set.
// Both external_attribution_credit and external_attribution_model must be
// set for externally attributed conversion actions.
- EXTERNAL_ATTRIBUTION_DATA_NOT_SET_FOR_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION = 13;
+ EXTERNAL_ATTRIBUTION_DATA_NOT_SET_FOR_EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION =
+ 13;
// Order IDs are not supported for conversion actions which use an external
// attribution model.
@@ -101,7 +103,7 @@ message ConversionUploadErrorEnum {
// conversion action combination.
DUPLICATE_ORDER_ID = 16;
- // The call occurred too recently. Please try uploading again after 12 hours
+ // The call occurred too recently. Try uploading again after 12 hours
// have passed since the call occurred.
TOO_RECENT_CALL = 17;
@@ -125,20 +127,20 @@ message ConversionUploadErrorEnum {
UNPARSEABLE_CALLERS_PHONE_NUMBER = 22;
// A conversion with this timestamp already exists for this click. To upload
- // another conversion, please use a different timestamp.
+ // another conversion, use a different timestamp.
CLICK_CONVERSION_ALREADY_EXISTS = 23;
// A conversion with this timestamp already exists for this call. To upload
- // another conversion, please use a different timestamp.
+ // another conversion, use a different timestamp.
CALL_CONVERSION_ALREADY_EXISTS = 24;
// This conversion has the same click and timestamp as another conversion in
- // the request. To upload another conversion for this click, please use a
+ // the request. To upload another conversion for this click, use a
// different timestamp.
DUPLICATE_CLICK_CONVERSION_IN_REQUEST = 25;
// This conversion has the same call and timestamp as another conversion in
- // the request. To upload another conversion for this call, please use a
+ // the request. To upload another conversion for this call, use a
// different timestamp.
DUPLICATE_CALL_CONVERSION_IN_REQUEST = 26;
@@ -162,8 +164,8 @@ message ConversionUploadErrorEnum {
// converted didn't consent to tracking.
CONVERSION_NOT_COMPLIANT_WITH_ATT_POLICY = 32;
- // No click was found for the provided user identifiers that could be
- // applied to the specified conversion action.
+ // No click was found for the provided user identifiers. This may be because
+ // the conversion did not come from a Google Ads campaign.
CLICK_NOT_FOUND = 33;
// The provided user identifier is not a SHA-256 hash. It is either unhashed
@@ -172,7 +174,8 @@ message ConversionUploadErrorEnum {
// Conversion actions which use an external attribution model cannot be used
// with UserIdentifier.
- EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION_NOT_PERMITTED_WITH_USER_IDENTIFIER = 35;
+ EXTERNALLY_ATTRIBUTED_CONVERSION_ACTION_NOT_PERMITTED_WITH_USER_IDENTIFIER =
+ 35;
// The provided user identifier is not supported. ConversionUploadService
// only supports hashed_email and hashed_phone_number.
@@ -187,23 +190,25 @@ message ConversionUploadErrorEnum {
// The specified gbraid could not be decoded.
UNPARSEABLE_GBRAID = 40;
- // Conversion types which use an external attribution model cannot be used
- // with gbraid or wbraid.
- EXTERNALLY_ATTRIBUTED_CONVERSION_TYPE_NOT_PERMITTED_WITH_BRAID = 41;
-
// Conversion actions which use the one-per-click counting type cannot be
// used with gbraid or wbraid.
ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID = 46;
// Per our customer data policies, enhanced conversions have been prohibited
- // in your account. If you have any questions, please contact your Google
+ // in your account. If you have any questions, contact your Google
// representative.
CUSTOMER_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS = 47;
// The customer has not accepted the customer data terms in the conversion
// settings page.
CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMS = 48;
- }
+ // The order_id contains personally identifiable information (PII), such as
+ // an email address or phone number.
+ ORDER_ID_CONTAINS_PII = 49;
+ // The customer has not enabled enhanced conversions for leads in the
+ // conversion settings page.
+ CUSTOMER_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS = 50;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_value_rule_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_value_rule_error.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/errors/conversion_value_rule_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/conversion_value_rule_error.proto
index 2d5754053..cc4287b3c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_value_rule_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_value_rule_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ConversionValueRuleErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing conversion value rule errors.
@@ -38,7 +38,7 @@ message ConversionValueRuleErrorEnum {
UNKNOWN = 1;
// The value rule's geo location condition contains invalid geo target
- // constant(s), i.e. there's no matching geo target.
+ // constant(s), for example, there's no matching geo target.
INVALID_GEO_TARGET_CONSTANT = 2;
// The value rule's geo location condition contains conflicting included and
@@ -85,6 +85,4 @@ message ConversionValueRuleErrorEnum {
// When a value rule is created, it shouldn't have REMOVED status.
CANNOT_ADD_RULE_WITH_STATUS_REMOVED = 13;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_value_rule_set_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_value_rule_set_error.proto
similarity index 92%
rename from third_party/googleapis/google/ads/googleads/v10/errors/conversion_value_rule_set_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/conversion_value_rule_set_error.proto
index d4f708737..470093f66 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/conversion_value_rule_set_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/conversion_value_rule_set_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ConversionValueRuleSetErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing conversion value rule set errors.
@@ -95,6 +95,4 @@ message ConversionValueRuleSetErrorEnum {
// list, only STORE_VISIT, or only STORE_SALE.
UNSUPPORTED_CONVERSION_ACTION_CATEGORIES = 14;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/country_code_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/country_code_error.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/errors/country_code_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/country_code_error.proto
index 99c888d8f..bf77eeac8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/country_code_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/country_code_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CountryCodeErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing country code errors.
@@ -40,6 +40,4 @@ message CountryCodeErrorEnum {
// The country code is invalid.
INVALID_COUNTRY_CODE = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/criterion_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/criterion_error.proto
similarity index 92%
rename from third_party/googleapis/google/ads/googleads/v10/errors/criterion_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/criterion_error.proto
index 86fe6d668..8cd517bce 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/criterion_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/criterion_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CriterionErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing criterion errors.
@@ -282,6 +282,24 @@ message CriterionErrorEnum {
// Cannot set geo target constants and feed item sets at the same time.
CANNOT_SET_GEO_TARGET_CONSTANTS_WITH_FEED_ITEM_SETS = 123;
+ // Cannot set both assetset and feed at the same time.
+ CANNOT_SET_BOTH_ASSET_SET_AND_FEED = 140;
+
+ // Cannot set feed or feed item sets for Customer.
+ CANNOT_SET_FEED_OR_FEED_ITEM_SETS_FOR_CUSTOMER = 142;
+
+ // Cannot set AssetSet criteria for customer.
+ CANNOT_SET_ASSET_SET_FIELD_FOR_CUSTOMER = 150;
+
+ // Cannot set geo target constants and asset sets at the same time.
+ CANNOT_SET_GEO_TARGET_CONSTANTS_WITH_ASSET_SETS = 143;
+
+ // Cannot set asset sets and feed item sets at the same time.
+ CANNOT_SET_ASSET_SETS_WITH_FEED_ITEM_SETS = 144;
+
+ // The location group asset set id is invalid
+ INVALID_LOCATION_GROUP_ASSET_SET = 141;
+
// The location group radius is in the range but not at the valid increment.
INVALID_LOCATION_GROUP_RADIUS = 124;
@@ -301,7 +319,8 @@ message CriterionErrorEnum {
HOTEL_ADVANCE_BOOKING_WINDOW_OVERLAPS_WITH_EXISTING_CRITERION = 83;
// The field is not allowed to be set when the negative field is set to
- // true, e.g. we don't allow bids in negative ad group or campaign criteria.
+ // true, for example, we don't allow bids in negative ad group or campaign
+ // criteria.
FIELD_INCOMPATIBLE_WITH_NEGATIVE_TARGETING = 84;
// The combination of operand and operator in webpage condition is invalid.
@@ -405,9 +424,9 @@ message CriterionErrorEnum {
// Listing group tree is too deep.
LISTING_GROUP_TREE_TOO_DEEP = 118;
- // Listing dimension is invalid (e.g. dimension contains illegal value,
- // dimension type is represented with wrong class, etc). Listing dimension
- // value can not contain "==" or "&+".
+ // Listing dimension is invalid (for example, dimension contains illegal
+ // value, dimension type is represented with wrong class, etc). Listing
+ // dimension value can not contain "==" or "&+".
INVALID_LISTING_DIMENSION = 119;
// Listing dimension type is either invalid for campaigns of this type or
@@ -445,7 +464,7 @@ message CriterionErrorEnum {
// Start date is after end date.
HOTEL_CHECK_IN_DATE_RANGE_REVERSED = 134;
- // Broad match modifier (BMM) keywords can no longer be created. Please see
+ // Broad match modifier (BMM) keywords can no longer be created. See
// https://ads-developers.googleblog.com/2021/06/broad-match-modifier-upcoming-changes.html.
BROAD_MATCH_MODIFIER_KEYWORD_NOT_ALLOWED = 135;
@@ -460,10 +479,8 @@ message CriterionErrorEnum {
AUDIENCE_NOT_ALLOWED_TO_ATTACH_WHEN_AUDIENCE_GROUPED_SET_TO_FALSE = 138;
// Targeting is not allowed for Customer Match lists as per Customer Match
- // policy. Please see
+ // policy. See
// https://support.google.com/google-ads/answer/6299717.
CANNOT_TARGET_CUSTOMER_MATCH_USER_LIST = 139;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/currency_code_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/currency_code_error.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/errors/currency_code_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/currency_code_error.proto
index bc1331e41..39817e938 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/currency_code_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/currency_code_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CurrencyCodeErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing currency code errors.
@@ -40,6 +40,4 @@ message CurrencyCodeErrorEnum {
// The currency code is not supported.
UNSUPPORTED = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/asset_set_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/currency_error.proto
similarity index 56%
rename from third_party/googleapis/google/ads/googleads/v10/errors/asset_set_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/currency_error.proto
index 9ff363a91..ca37ab26f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/asset_set_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/currency_error.proto
@@ -14,32 +14,30 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
-option java_outer_classname = "AssetSetErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_outer_classname = "CurrencyErrorProto";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
-// Proto file describing asset set errors.
+// Proto file describing currency errors.
-// Container for enum describing possible asset set errors.
-message AssetSetErrorEnum {
- // Enum describing possible asset set errors.
- enum AssetSetError {
+// Container for enum describing possible currency errors.
+message CurrencyErrorEnum {
+ // Enum describing possible currency errors.
+ enum CurrencyError {
// Enum unspecified.
UNSPECIFIED = 0;
// The received error code is not known in this version.
UNKNOWN = 1;
- // The asset set name matches that of another enabled asset set.
- DUPLICATE_ASSET_SET_NAME = 2;
+ // Bid must be a multiple of billable unit.
+ VALUE_NOT_MULTIPLE_OF_BILLABLE_UNIT = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/custom_audience_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/custom_audience_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/custom_audience_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/custom_audience_error.proto
index 3f57f6c6d..09cbda7da 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/custom_audience_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/custom_audience_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CustomAudienceErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing custom audience errors.
@@ -61,6 +61,4 @@ message CustomAudienceErrorEnum {
// Change in custom audience type is not allowed.
INVALID_TYPE_CHANGE = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/custom_conversion_goal_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/custom_conversion_goal_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/custom_conversion_goal_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/custom_conversion_goal_error.proto
index f323b5772..8fe8e501c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/custom_conversion_goal_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/custom_conversion_goal_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CustomConversionGoalErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing CustomConversionGoal errors.
@@ -54,6 +54,4 @@ message CustomConversionGoalErrorEnum {
// Custom goal with the same conversion action list already exists.
DUPLICATE_CONVERSION_ACTION_LIST = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/custom_interest_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/custom_interest_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/custom_interest_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/custom_interest_error.proto
index eb40427d6..fe3e58174 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/custom_interest_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/custom_interest_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CustomInterestErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing custom interest errors.
@@ -59,6 +59,4 @@ message CustomInterestErrorEnum {
// Cannot mutate custom interest type.
CANNOT_CHANGE_TYPE = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/customer_client_link_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/customer_client_link_error.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/errors/customer_client_link_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/customer_client_link_error.proto
index a0538233f..0f4c7f4de 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/customer_client_link_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/customer_client_link_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CustomerClientLinkErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing CustomerClientLink errors.
@@ -61,6 +61,4 @@ message CustomerClientLinkErrorEnum {
// Client has too many managers.
CLIENT_HAS_TOO_MANY_MANAGERS = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/customer_customizer_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/customer_customizer_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/customer_customizer_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/customer_customizer_error.proto
index a59548e36..656366ea0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/customer_customizer_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/customer_customizer_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CustomerCustomizerErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing customer customizer errors.
@@ -37,6 +37,4 @@ message CustomerCustomizerErrorEnum {
// The received error code is not known in this version.
UNKNOWN = 1;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/customer_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/customer_error.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/errors/customer_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/customer_error.proto
index c578078f0..64780945a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/customer_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/customer_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CustomerErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Container for enum describing possible customer errors.
message CustomerErrorEnum {
@@ -43,6 +43,4 @@ message CustomerErrorEnum {
// CustomerService cannot get a customer that has not been fully set up.
ACCOUNT_NOT_SET_UP = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/customer_feed_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/customer_feed_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/customer_feed_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/customer_feed_error.proto
index 9e55ff18f..234799a87 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/customer_feed_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/customer_feed_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CustomerFeedErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing customer feed errors.
@@ -59,6 +59,4 @@ message CustomerFeedErrorEnum {
// Placeholder not allowed at the account level.
PLACEHOLDER_TYPE_NOT_ALLOWED_ON_CUSTOMER_FEED = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/customer_manager_link_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/customer_manager_link_error.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/errors/customer_manager_link_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/customer_manager_link_error.proto
index baf640a76..cb9173abc 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/customer_manager_link_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/customer_manager_link_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CustomerManagerLinkErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing CustomerManagerLink errors.
@@ -68,6 +68,4 @@ message CustomerManagerLinkErrorEnum {
// allowed number of accounts
TEST_ACCOUNT_LINKS_TOO_MANY_CHILD_ACCOUNTS = 10;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/customer_user_access_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/customer_user_access_error.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/errors/customer_user_access_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/customer_user_access_error.proto
index 2cf62ec1c..962060935 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/customer_user_access_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/customer_user_access_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CustomerUserAccessErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing CustomerUserAccess errors.
@@ -53,6 +53,4 @@ message CustomerUserAccessErrorEnum {
// Last admin user cannot be removed from a manager.
LAST_ADMIN_USER_OF_MANAGER = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/customizer_attribute_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/customizer_attribute_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/customizer_attribute_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/customizer_attribute_error.proto
index 5c2bcafa2..eb326646b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/customizer_attribute_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/customizer_attribute_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "CustomizerAttributeErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing customizer attribute errors.
@@ -41,6 +41,4 @@ message CustomizerAttributeErrorEnum {
// CustomizerAttribute.
DUPLICATE_CUSTOMIZER_ATTRIBUTE_NAME = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/database_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/database_error.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/errors/database_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/database_error.proto
index be948f4f1..12c3fff2e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/database_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/database_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "DatabaseErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing database errors.
@@ -38,17 +38,15 @@ message DatabaseErrorEnum {
UNKNOWN = 1;
// Multiple requests were attempting to modify the same resource at once.
- // Please retry the request.
+ // Retry the request.
CONCURRENT_MODIFICATION = 2;
// The request conflicted with existing data. This error will usually be
// replaced with a more specific error if the request is retried.
DATA_CONSTRAINT_VIOLATION = 3;
- // The data written is too large. Please split the request into smaller
+ // The data written is too large. Split the request into smaller
// requests.
REQUEST_TOO_LARGE = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/date_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/date_error.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/errors/date_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/date_error.proto
index ce62f1785..cf9bb0c47 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/date_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/date_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "DateErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing date errors.
@@ -67,6 +67,4 @@ message DateErrorEnum {
// Both dates in range are null.
DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL = 10;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/date_range_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/date_range_error.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/errors/date_range_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/date_range_error.proto
index d14e4152d..9f5bba9be 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/date_range_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/date_range_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "DateRangeErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing date range errors.
@@ -52,6 +52,4 @@ message DateRangeErrorEnum {
// Trying to change start date on a resource that has started.
CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/distinct_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/distinct_error.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/errors/distinct_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/distinct_error.proto
index 3058b38e0..be1c40fe3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/distinct_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/distinct_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "DistinctErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing distinct errors.
@@ -43,6 +43,4 @@ message DistinctErrorEnum {
// Duplicate type.
DUPLICATE_TYPE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/enum_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/enum_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/enum_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/enum_error.proto
index 3ae108f62..27c565666 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/enum_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/enum_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "EnumErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing enum errors.
@@ -40,6 +40,4 @@ message EnumErrorEnum {
// The enum value is not permitted.
ENUM_VALUE_NOT_PERMITTED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/errors.proto b/third_party/googleapis/google/ads/googleads/v13/errors/errors.proto
similarity index 60%
rename from third_party/googleapis/google/ads/googleads/v10/errors/errors.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/errors.proto
index 9480008aa..4ef71a01b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/errors.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/errors.proto
@@ -14,160 +14,163 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
-
-import "google/ads/googleads/v10/common/policy.proto";
-import "google/ads/googleads/v10/common/value.proto";
-import "google/ads/googleads/v10/enums/resource_limit_type.proto";
-import "google/ads/googleads/v10/errors/access_invitation_error.proto";
-import "google/ads/googleads/v10/errors/account_budget_proposal_error.proto";
-import "google/ads/googleads/v10/errors/account_link_error.proto";
-import "google/ads/googleads/v10/errors/ad_customizer_error.proto";
-import "google/ads/googleads/v10/errors/ad_error.proto";
-import "google/ads/googleads/v10/errors/ad_group_ad_error.proto";
-import "google/ads/googleads/v10/errors/ad_group_bid_modifier_error.proto";
-import "google/ads/googleads/v10/errors/ad_group_criterion_customizer_error.proto";
-import "google/ads/googleads/v10/errors/ad_group_criterion_error.proto";
-import "google/ads/googleads/v10/errors/ad_group_customizer_error.proto";
-import "google/ads/googleads/v10/errors/ad_group_error.proto";
-import "google/ads/googleads/v10/errors/ad_group_feed_error.proto";
-import "google/ads/googleads/v10/errors/ad_parameter_error.proto";
-import "google/ads/googleads/v10/errors/ad_sharing_error.proto";
-import "google/ads/googleads/v10/errors/adx_error.proto";
-import "google/ads/googleads/v10/errors/asset_error.proto";
-import "google/ads/googleads/v10/errors/asset_group_asset_error.proto";
-import "google/ads/googleads/v10/errors/asset_group_error.proto";
-import "google/ads/googleads/v10/errors/asset_group_listing_group_filter_error.proto";
-import "google/ads/googleads/v10/errors/asset_link_error.proto";
-import "google/ads/googleads/v10/errors/asset_set_asset_error.proto";
-import "google/ads/googleads/v10/errors/asset_set_error.proto";
-import "google/ads/googleads/v10/errors/asset_set_link_error.proto";
-import "google/ads/googleads/v10/errors/audience_error.proto";
-import "google/ads/googleads/v10/errors/authentication_error.proto";
-import "google/ads/googleads/v10/errors/authorization_error.proto";
-import "google/ads/googleads/v10/errors/batch_job_error.proto";
-import "google/ads/googleads/v10/errors/bidding_error.proto";
-import "google/ads/googleads/v10/errors/bidding_strategy_error.proto";
-import "google/ads/googleads/v10/errors/billing_setup_error.proto";
-import "google/ads/googleads/v10/errors/campaign_budget_error.proto";
-import "google/ads/googleads/v10/errors/campaign_conversion_goal_error.proto";
-import "google/ads/googleads/v10/errors/campaign_criterion_error.proto";
-import "google/ads/googleads/v10/errors/campaign_customizer_error.proto";
-import "google/ads/googleads/v10/errors/campaign_draft_error.proto";
-import "google/ads/googleads/v10/errors/campaign_error.proto";
-import "google/ads/googleads/v10/errors/campaign_experiment_error.proto";
-import "google/ads/googleads/v10/errors/campaign_feed_error.proto";
-import "google/ads/googleads/v10/errors/campaign_shared_set_error.proto";
-import "google/ads/googleads/v10/errors/change_event_error.proto";
-import "google/ads/googleads/v10/errors/change_status_error.proto";
-import "google/ads/googleads/v10/errors/collection_size_error.proto";
-import "google/ads/googleads/v10/errors/context_error.proto";
-import "google/ads/googleads/v10/errors/conversion_action_error.proto";
-import "google/ads/googleads/v10/errors/conversion_adjustment_upload_error.proto";
-import "google/ads/googleads/v10/errors/conversion_custom_variable_error.proto";
-import "google/ads/googleads/v10/errors/conversion_goal_campaign_config_error.proto";
-import "google/ads/googleads/v10/errors/conversion_upload_error.proto";
-import "google/ads/googleads/v10/errors/conversion_value_rule_error.proto";
-import "google/ads/googleads/v10/errors/conversion_value_rule_set_error.proto";
-import "google/ads/googleads/v10/errors/country_code_error.proto";
-import "google/ads/googleads/v10/errors/criterion_error.proto";
-import "google/ads/googleads/v10/errors/currency_code_error.proto";
-import "google/ads/googleads/v10/errors/custom_audience_error.proto";
-import "google/ads/googleads/v10/errors/custom_conversion_goal_error.proto";
-import "google/ads/googleads/v10/errors/custom_interest_error.proto";
-import "google/ads/googleads/v10/errors/customer_client_link_error.proto";
-import "google/ads/googleads/v10/errors/customer_customizer_error.proto";
-import "google/ads/googleads/v10/errors/customer_error.proto";
-import "google/ads/googleads/v10/errors/customer_feed_error.proto";
-import "google/ads/googleads/v10/errors/customer_manager_link_error.proto";
-import "google/ads/googleads/v10/errors/customer_user_access_error.proto";
-import "google/ads/googleads/v10/errors/customizer_attribute_error.proto";
-import "google/ads/googleads/v10/errors/database_error.proto";
-import "google/ads/googleads/v10/errors/date_error.proto";
-import "google/ads/googleads/v10/errors/date_range_error.proto";
-import "google/ads/googleads/v10/errors/distinct_error.proto";
-import "google/ads/googleads/v10/errors/enum_error.proto";
-import "google/ads/googleads/v10/errors/experiment_arm_error.proto";
-import "google/ads/googleads/v10/errors/experiment_error.proto";
-import "google/ads/googleads/v10/errors/extension_feed_item_error.proto";
-import "google/ads/googleads/v10/errors/extension_setting_error.proto";
-import "google/ads/googleads/v10/errors/feed_attribute_reference_error.proto";
-import "google/ads/googleads/v10/errors/feed_error.proto";
-import "google/ads/googleads/v10/errors/feed_item_error.proto";
-import "google/ads/googleads/v10/errors/feed_item_set_error.proto";
-import "google/ads/googleads/v10/errors/feed_item_set_link_error.proto";
-import "google/ads/googleads/v10/errors/feed_item_target_error.proto";
-import "google/ads/googleads/v10/errors/feed_item_validation_error.proto";
-import "google/ads/googleads/v10/errors/feed_mapping_error.proto";
-import "google/ads/googleads/v10/errors/field_error.proto";
-import "google/ads/googleads/v10/errors/field_mask_error.proto";
-import "google/ads/googleads/v10/errors/function_error.proto";
-import "google/ads/googleads/v10/errors/function_parsing_error.proto";
-import "google/ads/googleads/v10/errors/geo_target_constant_suggestion_error.proto";
-import "google/ads/googleads/v10/errors/header_error.proto";
-import "google/ads/googleads/v10/errors/id_error.proto";
-import "google/ads/googleads/v10/errors/image_error.proto";
-import "google/ads/googleads/v10/errors/internal_error.proto";
-import "google/ads/googleads/v10/errors/invoice_error.proto";
-import "google/ads/googleads/v10/errors/keyword_plan_ad_group_error.proto";
-import "google/ads/googleads/v10/errors/keyword_plan_ad_group_keyword_error.proto";
-import "google/ads/googleads/v10/errors/keyword_plan_campaign_error.proto";
-import "google/ads/googleads/v10/errors/keyword_plan_campaign_keyword_error.proto";
-import "google/ads/googleads/v10/errors/keyword_plan_error.proto";
-import "google/ads/googleads/v10/errors/keyword_plan_idea_error.proto";
-import "google/ads/googleads/v10/errors/label_error.proto";
-import "google/ads/googleads/v10/errors/language_code_error.proto";
-import "google/ads/googleads/v10/errors/list_operation_error.proto";
-import "google/ads/googleads/v10/errors/manager_link_error.proto";
-import "google/ads/googleads/v10/errors/media_bundle_error.proto";
-import "google/ads/googleads/v10/errors/media_file_error.proto";
-import "google/ads/googleads/v10/errors/media_upload_error.proto";
-import "google/ads/googleads/v10/errors/merchant_center_error.proto";
-import "google/ads/googleads/v10/errors/multiplier_error.proto";
-import "google/ads/googleads/v10/errors/mutate_error.proto";
-import "google/ads/googleads/v10/errors/new_resource_creation_error.proto";
-import "google/ads/googleads/v10/errors/not_allowlisted_error.proto";
-import "google/ads/googleads/v10/errors/not_empty_error.proto";
-import "google/ads/googleads/v10/errors/null_error.proto";
-import "google/ads/googleads/v10/errors/offline_user_data_job_error.proto";
-import "google/ads/googleads/v10/errors/operation_access_denied_error.proto";
-import "google/ads/googleads/v10/errors/operator_error.proto";
-import "google/ads/googleads/v10/errors/partial_failure_error.proto";
-import "google/ads/googleads/v10/errors/payments_account_error.proto";
-import "google/ads/googleads/v10/errors/policy_finding_error.proto";
-import "google/ads/googleads/v10/errors/policy_validation_parameter_error.proto";
-import "google/ads/googleads/v10/errors/policy_violation_error.proto";
-import "google/ads/googleads/v10/errors/query_error.proto";
-import "google/ads/googleads/v10/errors/quota_error.proto";
-import "google/ads/googleads/v10/errors/range_error.proto";
-import "google/ads/googleads/v10/errors/reach_plan_error.proto";
-import "google/ads/googleads/v10/errors/recommendation_error.proto";
-import "google/ads/googleads/v10/errors/region_code_error.proto";
-import "google/ads/googleads/v10/errors/request_error.proto";
-import "google/ads/googleads/v10/errors/resource_access_denied_error.proto";
-import "google/ads/googleads/v10/errors/resource_count_limit_exceeded_error.proto";
-import "google/ads/googleads/v10/errors/setting_error.proto";
-import "google/ads/googleads/v10/errors/shared_criterion_error.proto";
-import "google/ads/googleads/v10/errors/shared_set_error.proto";
-import "google/ads/googleads/v10/errors/size_limit_error.proto";
-import "google/ads/googleads/v10/errors/string_format_error.proto";
-import "google/ads/googleads/v10/errors/string_length_error.proto";
-import "google/ads/googleads/v10/errors/third_party_app_analytics_link_error.proto";
-import "google/ads/googleads/v10/errors/time_zone_error.proto";
-import "google/ads/googleads/v10/errors/url_field_error.proto";
-import "google/ads/googleads/v10/errors/user_data_error.proto";
-import "google/ads/googleads/v10/errors/user_list_error.proto";
-import "google/ads/googleads/v10/errors/youtube_video_registration_error.proto";
+package google.ads.googleads.v13.errors;
+
+import "google/ads/googleads/v13/common/policy.proto";
+import "google/ads/googleads/v13/common/value.proto";
+import "google/ads/googleads/v13/enums/resource_limit_type.proto";
+import "google/ads/googleads/v13/errors/access_invitation_error.proto";
+import "google/ads/googleads/v13/errors/account_budget_proposal_error.proto";
+import "google/ads/googleads/v13/errors/account_link_error.proto";
+import "google/ads/googleads/v13/errors/ad_customizer_error.proto";
+import "google/ads/googleads/v13/errors/ad_error.proto";
+import "google/ads/googleads/v13/errors/ad_group_ad_error.proto";
+import "google/ads/googleads/v13/errors/ad_group_bid_modifier_error.proto";
+import "google/ads/googleads/v13/errors/ad_group_criterion_customizer_error.proto";
+import "google/ads/googleads/v13/errors/ad_group_criterion_error.proto";
+import "google/ads/googleads/v13/errors/ad_group_customizer_error.proto";
+import "google/ads/googleads/v13/errors/ad_group_error.proto";
+import "google/ads/googleads/v13/errors/ad_group_feed_error.proto";
+import "google/ads/googleads/v13/errors/ad_parameter_error.proto";
+import "google/ads/googleads/v13/errors/ad_sharing_error.proto";
+import "google/ads/googleads/v13/errors/adx_error.proto";
+import "google/ads/googleads/v13/errors/asset_error.proto";
+import "google/ads/googleads/v13/errors/asset_group_asset_error.proto";
+import "google/ads/googleads/v13/errors/asset_group_error.proto";
+import "google/ads/googleads/v13/errors/asset_group_listing_group_filter_error.proto";
+import "google/ads/googleads/v13/errors/asset_link_error.proto";
+import "google/ads/googleads/v13/errors/asset_set_asset_error.proto";
+import "google/ads/googleads/v13/errors/asset_set_error.proto";
+import "google/ads/googleads/v13/errors/asset_set_link_error.proto";
+import "google/ads/googleads/v13/errors/audience_error.proto";
+import "google/ads/googleads/v13/errors/audience_insights_error.proto";
+import "google/ads/googleads/v13/errors/authentication_error.proto";
+import "google/ads/googleads/v13/errors/authorization_error.proto";
+import "google/ads/googleads/v13/errors/batch_job_error.proto";
+import "google/ads/googleads/v13/errors/bidding_error.proto";
+import "google/ads/googleads/v13/errors/bidding_strategy_error.proto";
+import "google/ads/googleads/v13/errors/billing_setup_error.proto";
+import "google/ads/googleads/v13/errors/campaign_budget_error.proto";
+import "google/ads/googleads/v13/errors/campaign_conversion_goal_error.proto";
+import "google/ads/googleads/v13/errors/campaign_criterion_error.proto";
+import "google/ads/googleads/v13/errors/campaign_customizer_error.proto";
+import "google/ads/googleads/v13/errors/campaign_draft_error.proto";
+import "google/ads/googleads/v13/errors/campaign_error.proto";
+import "google/ads/googleads/v13/errors/campaign_experiment_error.proto";
+import "google/ads/googleads/v13/errors/campaign_feed_error.proto";
+import "google/ads/googleads/v13/errors/campaign_shared_set_error.proto";
+import "google/ads/googleads/v13/errors/change_event_error.proto";
+import "google/ads/googleads/v13/errors/change_status_error.proto";
+import "google/ads/googleads/v13/errors/collection_size_error.proto";
+import "google/ads/googleads/v13/errors/context_error.proto";
+import "google/ads/googleads/v13/errors/conversion_action_error.proto";
+import "google/ads/googleads/v13/errors/conversion_adjustment_upload_error.proto";
+import "google/ads/googleads/v13/errors/conversion_custom_variable_error.proto";
+import "google/ads/googleads/v13/errors/conversion_goal_campaign_config_error.proto";
+import "google/ads/googleads/v13/errors/conversion_upload_error.proto";
+import "google/ads/googleads/v13/errors/conversion_value_rule_error.proto";
+import "google/ads/googleads/v13/errors/conversion_value_rule_set_error.proto";
+import "google/ads/googleads/v13/errors/country_code_error.proto";
+import "google/ads/googleads/v13/errors/criterion_error.proto";
+import "google/ads/googleads/v13/errors/currency_code_error.proto";
+import "google/ads/googleads/v13/errors/currency_error.proto";
+import "google/ads/googleads/v13/errors/custom_audience_error.proto";
+import "google/ads/googleads/v13/errors/custom_conversion_goal_error.proto";
+import "google/ads/googleads/v13/errors/custom_interest_error.proto";
+import "google/ads/googleads/v13/errors/customer_client_link_error.proto";
+import "google/ads/googleads/v13/errors/customer_customizer_error.proto";
+import "google/ads/googleads/v13/errors/customer_error.proto";
+import "google/ads/googleads/v13/errors/customer_feed_error.proto";
+import "google/ads/googleads/v13/errors/customer_manager_link_error.proto";
+import "google/ads/googleads/v13/errors/customer_user_access_error.proto";
+import "google/ads/googleads/v13/errors/customizer_attribute_error.proto";
+import "google/ads/googleads/v13/errors/database_error.proto";
+import "google/ads/googleads/v13/errors/date_error.proto";
+import "google/ads/googleads/v13/errors/date_range_error.proto";
+import "google/ads/googleads/v13/errors/distinct_error.proto";
+import "google/ads/googleads/v13/errors/enum_error.proto";
+import "google/ads/googleads/v13/errors/experiment_arm_error.proto";
+import "google/ads/googleads/v13/errors/experiment_error.proto";
+import "google/ads/googleads/v13/errors/extension_feed_item_error.proto";
+import "google/ads/googleads/v13/errors/extension_setting_error.proto";
+import "google/ads/googleads/v13/errors/feed_attribute_reference_error.proto";
+import "google/ads/googleads/v13/errors/feed_error.proto";
+import "google/ads/googleads/v13/errors/feed_item_error.proto";
+import "google/ads/googleads/v13/errors/feed_item_set_error.proto";
+import "google/ads/googleads/v13/errors/feed_item_set_link_error.proto";
+import "google/ads/googleads/v13/errors/feed_item_target_error.proto";
+import "google/ads/googleads/v13/errors/feed_item_validation_error.proto";
+import "google/ads/googleads/v13/errors/feed_mapping_error.proto";
+import "google/ads/googleads/v13/errors/field_error.proto";
+import "google/ads/googleads/v13/errors/field_mask_error.proto";
+import "google/ads/googleads/v13/errors/function_error.proto";
+import "google/ads/googleads/v13/errors/function_parsing_error.proto";
+import "google/ads/googleads/v13/errors/geo_target_constant_suggestion_error.proto";
+import "google/ads/googleads/v13/errors/header_error.proto";
+import "google/ads/googleads/v13/errors/id_error.proto";
+import "google/ads/googleads/v13/errors/image_error.proto";
+import "google/ads/googleads/v13/errors/internal_error.proto";
+import "google/ads/googleads/v13/errors/invoice_error.proto";
+import "google/ads/googleads/v13/errors/keyword_plan_ad_group_error.proto";
+import "google/ads/googleads/v13/errors/keyword_plan_ad_group_keyword_error.proto";
+import "google/ads/googleads/v13/errors/keyword_plan_campaign_error.proto";
+import "google/ads/googleads/v13/errors/keyword_plan_campaign_keyword_error.proto";
+import "google/ads/googleads/v13/errors/keyword_plan_error.proto";
+import "google/ads/googleads/v13/errors/keyword_plan_idea_error.proto";
+import "google/ads/googleads/v13/errors/label_error.proto";
+import "google/ads/googleads/v13/errors/language_code_error.proto";
+import "google/ads/googleads/v13/errors/list_operation_error.proto";
+import "google/ads/googleads/v13/errors/manager_link_error.proto";
+import "google/ads/googleads/v13/errors/media_bundle_error.proto";
+import "google/ads/googleads/v13/errors/media_file_error.proto";
+import "google/ads/googleads/v13/errors/media_upload_error.proto";
+import "google/ads/googleads/v13/errors/merchant_center_error.proto";
+import "google/ads/googleads/v13/errors/multiplier_error.proto";
+import "google/ads/googleads/v13/errors/mutate_error.proto";
+import "google/ads/googleads/v13/errors/new_resource_creation_error.proto";
+import "google/ads/googleads/v13/errors/not_allowlisted_error.proto";
+import "google/ads/googleads/v13/errors/not_empty_error.proto";
+import "google/ads/googleads/v13/errors/null_error.proto";
+import "google/ads/googleads/v13/errors/offline_user_data_job_error.proto";
+import "google/ads/googleads/v13/errors/operation_access_denied_error.proto";
+import "google/ads/googleads/v13/errors/operator_error.proto";
+import "google/ads/googleads/v13/errors/partial_failure_error.proto";
+import "google/ads/googleads/v13/errors/payments_account_error.proto";
+import "google/ads/googleads/v13/errors/policy_finding_error.proto";
+import "google/ads/googleads/v13/errors/policy_validation_parameter_error.proto";
+import "google/ads/googleads/v13/errors/policy_violation_error.proto";
+import "google/ads/googleads/v13/errors/query_error.proto";
+import "google/ads/googleads/v13/errors/quota_error.proto";
+import "google/ads/googleads/v13/errors/range_error.proto";
+import "google/ads/googleads/v13/errors/reach_plan_error.proto";
+import "google/ads/googleads/v13/errors/recommendation_error.proto";
+import "google/ads/googleads/v13/errors/region_code_error.proto";
+import "google/ads/googleads/v13/errors/request_error.proto";
+import "google/ads/googleads/v13/errors/resource_access_denied_error.proto";
+import "google/ads/googleads/v13/errors/resource_count_limit_exceeded_error.proto";
+import "google/ads/googleads/v13/errors/setting_error.proto";
+import "google/ads/googleads/v13/errors/shared_criterion_error.proto";
+import "google/ads/googleads/v13/errors/shared_set_error.proto";
+import "google/ads/googleads/v13/errors/size_limit_error.proto";
+import "google/ads/googleads/v13/errors/smart_campaign_error.proto";
+import "google/ads/googleads/v13/errors/string_format_error.proto";
+import "google/ads/googleads/v13/errors/string_length_error.proto";
+import "google/ads/googleads/v13/errors/third_party_app_analytics_link_error.proto";
+import "google/ads/googleads/v13/errors/time_zone_error.proto";
+import "google/ads/googleads/v13/errors/url_field_error.proto";
+import "google/ads/googleads/v13/errors/user_data_error.proto";
+import "google/ads/googleads/v13/errors/user_list_error.proto";
+import "google/ads/googleads/v13/errors/youtube_video_registration_error.proto";
import "google/protobuf/duration.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ErrorsProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing the common error protos
@@ -190,7 +193,7 @@ message GoogleAdsError {
string message = 2;
// The value that triggered the error.
- google.ads.googleads.v10.common.Value trigger = 3;
+ google.ads.googleads.v13.common.Value trigger = 3;
// Describes the part of the request proto that caused the error.
ErrorLocation location = 4;
@@ -250,13 +253,16 @@ message ErrorCode {
AuthenticationErrorEnum.AuthenticationError authentication_error = 17;
// The reasons for the ad group criterion customizer error.
- AdGroupCriterionCustomizerErrorEnum.AdGroupCriterionCustomizerError ad_group_criterion_customizer_error = 161;
+ AdGroupCriterionCustomizerErrorEnum.AdGroupCriterionCustomizerError
+ ad_group_criterion_customizer_error = 161;
// Indicates failure to properly authenticate user.
- AdGroupCriterionErrorEnum.AdGroupCriterionError ad_group_criterion_error = 18;
+ AdGroupCriterionErrorEnum.AdGroupCriterionError ad_group_criterion_error =
+ 18;
// The reasons for the ad group customizer error.
- AdGroupCustomizerErrorEnum.AdGroupCustomizerError ad_group_customizer_error = 159;
+ AdGroupCustomizerErrorEnum.AdGroupCustomizerError
+ ad_group_customizer_error = 159;
// The reasons for the ad customizer error
AdCustomizerErrorEnum.AdCustomizerError ad_customizer_error = 19;
@@ -277,7 +283,8 @@ message ErrorCode {
AssetGroupAssetErrorEnum.AssetGroupAssetError asset_group_asset_error = 149;
// The reasons for the asset group listing group filter error
- AssetGroupListingGroupFilterErrorEnum.AssetGroupListingGroupFilterError asset_group_listing_group_filter_error = 155;
+ AssetGroupListingGroupFilterErrorEnum.AssetGroupListingGroupFilterError
+ asset_group_listing_group_filter_error = 155;
// The reasons for the asset group error
AssetGroupErrorEnum.AssetGroupError asset_group_error = 148;
@@ -295,19 +302,23 @@ message ErrorCode {
BiddingErrorEnum.BiddingError bidding_error = 26;
// The reasons for the campaign criterion error
- CampaignCriterionErrorEnum.CampaignCriterionError campaign_criterion_error = 29;
+ CampaignCriterionErrorEnum.CampaignCriterionError campaign_criterion_error =
+ 29;
// The reasons for the campaign conversion goal error
- CampaignConversionGoalErrorEnum.CampaignConversionGoalError campaign_conversion_goal_error = 166;
+ CampaignConversionGoalErrorEnum.CampaignConversionGoalError
+ campaign_conversion_goal_error = 166;
// The reasons for the campaign customizer error.
- CampaignCustomizerErrorEnum.CampaignCustomizerError campaign_customizer_error = 160;
+ CampaignCustomizerErrorEnum.CampaignCustomizerError
+ campaign_customizer_error = 160;
// The reasons for the collection size error
CollectionSizeErrorEnum.CollectionSizeError collection_size_error = 31;
// The reasons for the conversion goal campaign config error
- ConversionGoalCampaignConfigErrorEnum.ConversionGoalCampaignConfigError conversion_goal_campaign_config_error = 165;
+ ConversionGoalCampaignConfigErrorEnum.ConversionGoalCampaignConfigError
+ conversion_goal_campaign_config_error = 165;
// The reasons for the country code error
CountryCodeErrorEnum.CountryCodeError country_code_error = 109;
@@ -316,16 +327,19 @@ message ErrorCode {
CriterionErrorEnum.CriterionError criterion_error = 32;
// The reasons for the custom conversion goal error
- CustomConversionGoalErrorEnum.CustomConversionGoalError custom_conversion_goal_error = 150;
+ CustomConversionGoalErrorEnum.CustomConversionGoalError
+ custom_conversion_goal_error = 150;
// The reasons for the customer customizer error.
- CustomerCustomizerErrorEnum.CustomerCustomizerError customer_customizer_error = 158;
+ CustomerCustomizerErrorEnum.CustomerCustomizerError
+ customer_customizer_error = 158;
// The reasons for the customer error
CustomerErrorEnum.CustomerError customer_error = 90;
// The reasons for the customizer attribute error.
- CustomizerAttributeErrorEnum.CustomizerAttributeError customizer_attribute_error = 151;
+ CustomizerAttributeErrorEnum.CustomizerAttributeError
+ customizer_attribute_error = 151;
// The reasons for the date error
DateErrorEnum.DateError date_error = 33;
@@ -337,7 +351,8 @@ message ErrorCode {
DistinctErrorEnum.DistinctError distinct_error = 35;
// The reasons for the feed attribute reference error
- FeedAttributeReferenceErrorEnum.FeedAttributeReferenceError feed_attribute_reference_error = 36;
+ FeedAttributeReferenceErrorEnum.FeedAttributeReferenceError
+ feed_attribute_reference_error = 36;
// The reasons for the function error
FunctionErrorEnum.FunctionError function_error = 37;
@@ -370,7 +385,8 @@ message ErrorCode {
MultiplierErrorEnum.MultiplierError multiplier_error = 44;
// The reasons for the new resource creation error
- NewResourceCreationErrorEnum.NewResourceCreationError new_resource_creation_error = 45;
+ NewResourceCreationErrorEnum.NewResourceCreationError
+ new_resource_creation_error = 45;
// The reasons for the not empty error
NotEmptyErrorEnum.NotEmptyError not_empty_error = 46;
@@ -400,19 +416,24 @@ message ErrorCode {
StringLengthErrorEnum.StringLengthError string_length_error = 54;
// The reasons for the operation access denied error
- OperationAccessDeniedErrorEnum.OperationAccessDeniedError operation_access_denied_error = 55;
+ OperationAccessDeniedErrorEnum.OperationAccessDeniedError
+ operation_access_denied_error = 55;
// The reasons for the resource access denied error
- ResourceAccessDeniedErrorEnum.ResourceAccessDeniedError resource_access_denied_error = 56;
+ ResourceAccessDeniedErrorEnum.ResourceAccessDeniedError
+ resource_access_denied_error = 56;
// The reasons for the resource count limit exceeded error
- ResourceCountLimitExceededErrorEnum.ResourceCountLimitExceededError resource_count_limit_exceeded_error = 57;
+ ResourceCountLimitExceededErrorEnum.ResourceCountLimitExceededError
+ resource_count_limit_exceeded_error = 57;
// The reasons for YouTube video registration errors.
- YoutubeVideoRegistrationErrorEnum.YoutubeVideoRegistrationError youtube_video_registration_error = 117;
+ YoutubeVideoRegistrationErrorEnum.YoutubeVideoRegistrationError
+ youtube_video_registration_error = 117;
// The reasons for the ad group bid modifier error
- AdGroupBidModifierErrorEnum.AdGroupBidModifierError ad_group_bid_modifier_error = 59;
+ AdGroupBidModifierErrorEnum.AdGroupBidModifierError
+ ad_group_bid_modifier_error = 59;
// The reasons for the context error
ContextErrorEnum.ContextError context_error = 60;
@@ -427,25 +448,32 @@ message ErrorCode {
SharedCriterionErrorEnum.SharedCriterionError shared_criterion_error = 63;
// The reasons for the campaign shared set error
- CampaignSharedSetErrorEnum.CampaignSharedSetError campaign_shared_set_error = 64;
+ CampaignSharedSetErrorEnum.CampaignSharedSetError
+ campaign_shared_set_error = 64;
// The reasons for the conversion action error
- ConversionActionErrorEnum.ConversionActionError conversion_action_error = 65;
+ ConversionActionErrorEnum.ConversionActionError conversion_action_error =
+ 65;
// The reasons for the conversion adjustment upload error
- ConversionAdjustmentUploadErrorEnum.ConversionAdjustmentUploadError conversion_adjustment_upload_error = 115;
+ ConversionAdjustmentUploadErrorEnum.ConversionAdjustmentUploadError
+ conversion_adjustment_upload_error = 115;
// The reasons for the conversion custom variable error
- ConversionCustomVariableErrorEnum.ConversionCustomVariableError conversion_custom_variable_error = 143;
+ ConversionCustomVariableErrorEnum.ConversionCustomVariableError
+ conversion_custom_variable_error = 143;
// The reasons for the conversion upload error
- ConversionUploadErrorEnum.ConversionUploadError conversion_upload_error = 111;
+ ConversionUploadErrorEnum.ConversionUploadError conversion_upload_error =
+ 111;
// The reasons for the conversion value rule error
- ConversionValueRuleErrorEnum.ConversionValueRuleError conversion_value_rule_error = 145;
+ ConversionValueRuleErrorEnum.ConversionValueRuleError
+ conversion_value_rule_error = 145;
// The reasons for the conversion value rule set error
- ConversionValueRuleSetErrorEnum.ConversionValueRuleSetError conversion_value_rule_set_error = 146;
+ ConversionValueRuleSetErrorEnum.ConversionValueRuleSetError
+ conversion_value_rule_set_error = 146;
// The reasons for the header error.
HeaderErrorEnum.HeaderError header_error = 66;
@@ -463,22 +491,27 @@ message ErrorCode {
KeywordPlanErrorEnum.KeywordPlanError keyword_plan_error = 71;
// The reason for keyword plan campaign error.
- KeywordPlanCampaignErrorEnum.KeywordPlanCampaignError keyword_plan_campaign_error = 72;
+ KeywordPlanCampaignErrorEnum.KeywordPlanCampaignError
+ keyword_plan_campaign_error = 72;
// The reason for keyword plan campaign keyword error.
- KeywordPlanCampaignKeywordErrorEnum.KeywordPlanCampaignKeywordError keyword_plan_campaign_keyword_error = 132;
+ KeywordPlanCampaignKeywordErrorEnum.KeywordPlanCampaignKeywordError
+ keyword_plan_campaign_keyword_error = 132;
// The reason for keyword plan ad group error.
- KeywordPlanAdGroupErrorEnum.KeywordPlanAdGroupError keyword_plan_ad_group_error = 74;
+ KeywordPlanAdGroupErrorEnum.KeywordPlanAdGroupError
+ keyword_plan_ad_group_error = 74;
// The reason for keyword plan ad group keyword error.
- KeywordPlanAdGroupKeywordErrorEnum.KeywordPlanAdGroupKeywordError keyword_plan_ad_group_keyword_error = 133;
+ KeywordPlanAdGroupKeywordErrorEnum.KeywordPlanAdGroupKeywordError
+ keyword_plan_ad_group_keyword_error = 133;
// The reason for keyword idea error.
KeywordPlanIdeaErrorEnum.KeywordPlanIdeaError keyword_plan_idea_error = 76;
// The reasons for account budget proposal errors.
- AccountBudgetProposalErrorEnum.AccountBudgetProposalError account_budget_proposal_error = 77;
+ AccountBudgetProposalErrorEnum.AccountBudgetProposalError
+ account_budget_proposal_error = 77;
// The reasons for the user list error
UserListErrorEnum.UserListError user_list_error = 78;
@@ -493,7 +526,8 @@ message ErrorCode {
FeedErrorEnum.FeedError feed_error = 80;
// The reasons for the geo target constant suggestion error.
- GeoTargetConstantSuggestionErrorEnum.GeoTargetConstantSuggestionError geo_target_constant_suggestion_error = 81;
+ GeoTargetConstantSuggestionErrorEnum.GeoTargetConstantSuggestionError
+ geo_target_constant_suggestion_error = 81;
// The reasons for the campaign draft error
CampaignDraftErrorEnum.CampaignDraftError campaign_draft_error = 82;
@@ -508,10 +542,12 @@ message ErrorCode {
BillingSetupErrorEnum.BillingSetupError billing_setup_error = 87;
// The reasons for the customer client link error
- CustomerClientLinkErrorEnum.CustomerClientLinkError customer_client_link_error = 88;
+ CustomerClientLinkErrorEnum.CustomerClientLinkError
+ customer_client_link_error = 88;
// The reasons for the customer manager link error
- CustomerManagerLinkErrorEnum.CustomerManagerLinkError customer_manager_link_error = 91;
+ CustomerManagerLinkErrorEnum.CustomerManagerLinkError
+ customer_manager_link_error = 91;
// The reasons for the feed mapping error
FeedMappingErrorEnum.FeedMappingError feed_mapping_error = 92;
@@ -529,25 +565,30 @@ message ErrorCode {
CustomInterestErrorEnum.CustomInterestError custom_interest_error = 97;
// The reasons for the campaign experiment error
- CampaignExperimentErrorEnum.CampaignExperimentError campaign_experiment_error = 98;
+ CampaignExperimentErrorEnum.CampaignExperimentError
+ campaign_experiment_error = 98;
// The reasons for the extension feed item error
- ExtensionFeedItemErrorEnum.ExtensionFeedItemError extension_feed_item_error = 100;
+ ExtensionFeedItemErrorEnum.ExtensionFeedItemError
+ extension_feed_item_error = 100;
// The reasons for the ad parameter error
AdParameterErrorEnum.AdParameterError ad_parameter_error = 101;
// The reasons for the feed item validation error
- FeedItemValidationErrorEnum.FeedItemValidationError feed_item_validation_error = 102;
+ FeedItemValidationErrorEnum.FeedItemValidationError
+ feed_item_validation_error = 102;
// The reasons for the extension setting error
- ExtensionSettingErrorEnum.ExtensionSettingError extension_setting_error = 103;
+ ExtensionSettingErrorEnum.ExtensionSettingError extension_setting_error =
+ 103;
// The reasons for the feed item set error
FeedItemSetErrorEnum.FeedItemSetError feed_item_set_error = 140;
// The reasons for the feed item set link error
- FeedItemSetLinkErrorEnum.FeedItemSetLinkError feed_item_set_link_error = 141;
+ FeedItemSetLinkErrorEnum.FeedItemSetLinkError feed_item_set_link_error =
+ 141;
// The reasons for the feed item target error
FeedItemTargetErrorEnum.FeedItemTargetError feed_item_target_error = 104;
@@ -559,13 +600,15 @@ message ErrorCode {
PartialFailureErrorEnum.PartialFailureError partial_failure_error = 112;
// The reasons for the policy validation parameter error
- PolicyValidationParameterErrorEnum.PolicyValidationParameterError policy_validation_parameter_error = 114;
+ PolicyValidationParameterErrorEnum.PolicyValidationParameterError
+ policy_validation_parameter_error = 114;
// The reasons for the size limit error
SizeLimitErrorEnum.SizeLimitError size_limit_error = 118;
// The reasons for the offline user data job error.
- OfflineUserDataJobErrorEnum.OfflineUserDataJobError offline_user_data_job_error = 119;
+ OfflineUserDataJobErrorEnum.OfflineUserDataJobError
+ offline_user_data_job_error = 119;
// The reasons for the not allowlisted error
NotAllowlistedErrorEnum.NotAllowlistedError not_allowlisted_error = 137;
@@ -580,7 +623,8 @@ message ErrorCode {
ExperimentErrorEnum.ExperimentError experiment_error = 123;
// The reasons for the access invitation error
- AccessInvitationErrorEnum.AccessInvitationError access_invitation_error = 124;
+ AccessInvitationErrorEnum.AccessInvitationError access_invitation_error =
+ 124;
// The reasons for the reach plan error
ReachPlanErrorEnum.ReachPlanError reach_plan_error = 125;
@@ -607,10 +651,12 @@ message ErrorCode {
AccountLinkErrorEnum.AccountLinkError account_link_error = 134;
// The reasons for the third party app analytics link mutate error
- ThirdPartyAppAnalyticsLinkErrorEnum.ThirdPartyAppAnalyticsLinkError third_party_app_analytics_link_error = 135;
+ ThirdPartyAppAnalyticsLinkErrorEnum.ThirdPartyAppAnalyticsLinkError
+ third_party_app_analytics_link_error = 135;
// The reasons for the customer user access mutate error
- CustomerUserAccessErrorEnum.CustomerUserAccessError customer_user_access_error = 138;
+ CustomerUserAccessErrorEnum.CustomerUserAccessError
+ customer_user_access_error = 138;
// The reasons for the custom audience error
CustomAudienceErrorEnum.CustomAudienceError custom_audience_error = 139;
@@ -618,8 +664,18 @@ message ErrorCode {
// The reasons for the audience error
AudienceErrorEnum.AudienceError audience_error = 164;
+ // The reasons for the Smart campaign error
+ SmartCampaignErrorEnum.SmartCampaignError smart_campaign_error = 147;
+
// The reasons for the experiment arm error
ExperimentArmErrorEnum.ExperimentArmError experiment_arm_error = 156;
+
+ // The reasons for the Audience Insights error
+ AudienceInsightsErrorEnum.AudienceInsightsError audience_insights_error =
+ 167;
+
+ // The reasons for the currency errors.
+ CurrencyErrorEnum.CurrencyError currency_error = 171;
}
}
@@ -667,7 +723,7 @@ message PolicyViolationDetails {
// Unique identifier for this violation.
// If policy is exemptible, this key may be used to request exemption.
- google.ads.googleads.v10.common.PolicyViolationKey key = 4;
+ google.ads.googleads.v13.common.PolicyViolationKey key = 4;
// Human readable name of the policy.
string external_policy_name = 5;
@@ -683,7 +739,8 @@ message PolicyFindingDetails {
// The list of policy topics for the resource. Contains the PROHIBITED or
// FULLY_LIMITED policy topic entries that prevented the resource from being
// saved (among any other entries the resource may also have).
- repeated google.ads.googleads.v10.common.PolicyTopicEntry policy_topic_entries = 1;
+ repeated google.ads.googleads.v13.common.PolicyTopicEntry
+ policy_topic_entries = 1;
}
// Additional quota error details when there is QuotaError.
@@ -728,7 +785,8 @@ message ResourceCountDetails {
int32 limit = 2;
// The resource limit type which was exceeded.
- google.ads.googleads.v10.enums.ResourceLimitTypeEnum.ResourceLimitType limit_type = 3;
+ google.ads.googleads.v13.enums.ResourceLimitTypeEnum.ResourceLimitType
+ limit_type = 3;
// The count of existing entities.
int32 existing_count = 4;
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/experiment_arm_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/experiment_arm_error.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/errors/experiment_arm_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/experiment_arm_error.proto
index e58ca5a93..93acef70a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/experiment_arm_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/experiment_arm_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ExperimentArmErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing experiment arm errors.
@@ -81,6 +81,4 @@ message ExperimentArmErrorEnum {
// Traffic split is not supported for some channel types.
TRAFFIC_SPLIT_NOT_SUPPORTED_FOR_CHANNEL_TYPE = 15;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/experiment_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/experiment_error.proto
similarity index 88%
rename from third_party/googleapis/google/ads/googleads/v10/errors/experiment_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/experiment_error.proto
index 18444c5c3..ccb4f218d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/experiment_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/experiment_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ExperimentErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing experiment errors.
@@ -38,15 +38,15 @@ message ExperimentErrorEnum {
UNKNOWN = 1;
// The start date of an experiment cannot be set in the past.
- // Please use a start date in the future.
+ // Use a start date in the future.
CANNOT_SET_START_DATE_IN_PAST = 2;
// The end date of an experiment is before its start date.
- // Please use an end date after the start date.
+ // Use an end date after the start date.
END_DATE_BEFORE_START_DATE = 3;
// The start date of an experiment is too far in the future.
- // Please use a start date no more than 1 year in the future.
+ // Use a start date no more than 1 year in the future.
START_DATE_TOO_FAR_IN_FUTURE = 4;
// The experiment has the same name as an existing active experiment.
@@ -115,6 +115,4 @@ message ExperimentErrorEnum {
// Invalid status transition.
STATUS_TRANSITION_INVALID = 25;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/extension_feed_item_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/extension_feed_item_error.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/errors/extension_feed_item_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/extension_feed_item_error.proto
index 69031805f..da4581ec7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/extension_feed_item_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/extension_feed_item_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ExtensionFeedItemErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing extension feed item errors.
@@ -75,8 +75,8 @@ message ExtensionFeedItemErrorEnum {
// requirements.
INVALID_DOMESTIC_PHONE_NUMBER_FORMAT = 12;
- // Vanity phone numbers (i.e. those including letters) are not allowed for
- // call extensions.
+ // Vanity phone numbers (for example, those including letters) are not
+ // allowed for call extensions.
VANITY_PHONE_NUMBER_NOT_ALLOWED = 13;
// Call conversion action provided for a call extension is invalid.
@@ -91,7 +91,7 @@ message ExtensionFeedItemErrorEnum {
CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY = 16;
// Customer hasn't consented for call recording, which is required for
- // creating/updating call feed items. Please see
+ // creating/updating call feed items. See
// https://support.google.com/google-ads/answer/7412639.
CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIRED = 17;
@@ -136,8 +136,8 @@ message ExtensionFeedItemErrorEnum {
// Unknown or unsupported device preference.
INVALID_DEVICE_PREFERENCE = 30;
- // Invalid feed item schedule end time (i.e., endHour = 24 and endMinute !=
- // 0).
+ // Invalid feed item schedule end time (for example, endHour = 24 and
+ // endMinute != 0).
INVALID_SCHEDULE_END = 31;
// Date time zone does not match the account's time zone.
@@ -160,7 +160,7 @@ message ExtensionFeedItemErrorEnum {
// extension feed item.
EXTENSION_TYPE_MISMATCH = 37;
- // The oneof field extension i.e. subtype of extension feed item is
+ // The oneof field extension for example, subtype of extension feed item is
// required.
EXTENSION_SUBTYPE_REQUIRED = 38;
@@ -188,6 +188,4 @@ message ExtensionFeedItemErrorEnum {
// Feed item schedule end time must be after start time.
SCHEDULE_END_NOT_AFTER_START = 46;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/extension_setting_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/extension_setting_error.proto
similarity index 93%
rename from third_party/googleapis/google/ads/googleads/v10/errors/extension_setting_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/extension_setting_error.proto
index 4e76d482f..ab3db9517 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/extension_setting_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/extension_setting_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ExtensionSettingErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing extension setting validation errors.
@@ -116,8 +116,8 @@ message ExtensionSettingErrorEnum {
// requirements.
INVALID_DOMESTIC_PHONE_NUMBER_FORMAT = 25;
- // Vanity phone numbers (i.e. those including letters) are not allowed for
- // call extensions.
+ // Vanity phone numbers (for example, those including letters) are not
+ // allowed for call extensions.
VANITY_PHONE_NUMBER_NOT_ALLOWED = 26;
// Country code provided for a call extension is invalid.
@@ -174,15 +174,15 @@ message ExtensionSettingErrorEnum {
// Unknown or unsupported device preference.
INVALID_DEVICE_PREFERENCE = 43;
- // Invalid feed item schedule end time (i.e., endHour = 24 and
+ // Invalid feed item schedule end time (for example, endHour = 24 and
// endMinute != 0).
INVALID_SCHEDULE_END = 45;
// Date time zone does not match the account's time zone.
DATE_TIME_MUST_BE_IN_ACCOUNT_TIME_ZONE = 47;
- // Overlapping feed item schedule times (e.g., 7-10AM and 8-11AM) are not
- // allowed.
+ // Overlapping feed item schedule times (for example, 7-10AM and 8-11AM) are
+ // not allowed.
OVERLAPPING_SCHEDULES_NOT_ALLOWED = 48;
// Feed item schedule end time must be after start time.
@@ -243,7 +243,7 @@ message ExtensionSettingErrorEnum {
UNSUPPORTED_LANGUAGE = 65;
// Customer hasn't consented for call recording, which is required for
- // adding/updating call extensions. Please see
+ // adding/updating call extensions. See
// https://support.google.com/google-ads/answer/7412639.
CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIRED = 66;
@@ -254,6 +254,4 @@ message ExtensionSettingErrorEnum {
// The extension contains text which has been prohibited on policy grounds.
DISALLOWED_TEXT = 68;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/feed_attribute_reference_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/feed_attribute_reference_error.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/errors/feed_attribute_reference_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/feed_attribute_reference_error.proto
index 7af8d9dd1..b6ea55357 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/feed_attribute_reference_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/feed_attribute_reference_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FeedAttributeReferenceErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing feed attribute reference errors.
@@ -46,6 +46,4 @@ message FeedAttributeReferenceErrorEnum {
// There is no feed attribute in an enabled feed with the given name.
INVALID_FEED_ATTRIBUTE_NAME = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/feed_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/feed_error.proto
similarity index 91%
rename from third_party/googleapis/google/ads/googleads/v10/errors/feed_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/feed_error.proto
index bd9148546..aa1aad314 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/feed_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/feed_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FeedErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing feed errors.
@@ -107,6 +107,4 @@ message FeedErrorEnum {
// Feed-based extension is read-only for this extension type.
LEGACY_EXTENSION_TYPE_READ_ONLY = 24;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/feed_item_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/feed_item_error.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/errors/feed_item_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/feed_item_error.proto
index 066abbb8d..e3cef1987 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/feed_item_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/feed_item_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FeedItemErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing feed item errors.
@@ -63,7 +63,8 @@ message FeedItemErrorEnum {
// The feed attribute value is too large.
SIZE_TOO_LARGE_FOR_MULTI_VALUE_ATTRIBUTE = 10;
- }
-
+ // Feed is read only.
+ LEGACY_FEED_TYPE_READ_ONLY = 11;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/feed_item_set_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/feed_item_set_error.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/errors/feed_item_set_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/feed_item_set_error.proto
index be2dabff9..dcb14de7c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/feed_item_set_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/feed_item_set_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FeedItemSetErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing feed item set errors.
@@ -64,6 +64,4 @@ message FeedItemSetErrorEnum {
// Chain ID specified for AffiliateLocationFeedData is invalid.
DYNAMIC_FILTER_INVALID_CHAIN_IDS = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/feed_item_set_link_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/feed_item_set_link_error.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/errors/feed_item_set_link_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/feed_item_set_link_error.proto
index 29bd732b0..ef76e7412 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/feed_item_set_link_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/feed_item_set_link_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FeedItemSetLinkErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing feed item set link errors.
@@ -44,6 +44,4 @@ message FeedItemSetLinkErrorEnum {
// Cannot add or remove links to a dynamic set.
NO_MUTATE_ALLOWED_FOR_DYNAMIC_SET = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/feed_item_target_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/feed_item_target_error.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/errors/feed_item_target_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/feed_item_target_error.proto
index 79dd48262..3b94fc9a1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/feed_item_target_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/feed_item_target_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FeedItemTargetErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing feed item target errors.
@@ -63,6 +63,4 @@ message FeedItemTargetErrorEnum {
// Duplicate keywords aren't allowed.
DUPLICATE_KEYWORD = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/feed_item_validation_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/feed_item_validation_error.proto
similarity index 96%
rename from third_party/googleapis/google/ads/googleads/v10/errors/feed_item_validation_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/feed_item_validation_error.proto
index 43fc24300..27cc0a041 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/feed_item_validation_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/feed_item_validation_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FeedItemValidationErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing feed item validation errors.
@@ -174,8 +174,8 @@ message FeedItemValidationErrorEnum {
// Advertisers can link a conversion action with a phone number to indicate
// that sufficiently long calls forwarded to that phone number should be
// counted as conversions of the specified type. This is an error message
- // indicating that the conversion action specified is invalid (e.g., the
- // conversion action does not exist within the appropriate Google Ads
+ // indicating that the conversion action specified is invalid (for example,
+ // the conversion action does not exist within the appropriate Google Ads
// account, or it is a type of conversion not appropriate to phone call
// conversions).
INVALID_CALL_CONVERSION_ACTION_ID = 45;
@@ -298,7 +298,7 @@ message FeedItemValidationErrorEnum {
INVALID_FINAL_URL_SUFFIX_FORMAT = 83;
// Consent for call recording, which is required for the use of call
- // extensions, was not provided by the advertiser. Please see
+ // extensions, was not provided by the advertiser. See
// https://support.google.com/google-ads/answer/7412639.
CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIRED = 84;
@@ -370,6 +370,4 @@ message FeedItemValidationErrorEnum {
// An error occurred when validating image.
IMAGE_ERROR_SERVER_ERROR = 107;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/feed_mapping_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/feed_mapping_error.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/errors/feed_mapping_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/feed_mapping_error.proto
index f3e8d38f6..c2ed3ee26 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/feed_mapping_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/feed_mapping_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FeedMappingErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing feed item errors.
@@ -92,7 +92,8 @@ message FeedMappingErrorEnum {
// The "field" oneof was not set in an AttributeFieldMapping.
ATTRIBUTE_FIELD_MAPPING_MISSING_FIELD = 19;
- }
-
+ // Feed is read only.
+ LEGACY_FEED_TYPE_READ_ONLY = 20;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/field_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/field_error.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/errors/field_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/field_error.proto
index 93a9d8532..ee328af83 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/field_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/field_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FieldErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing field errors.
@@ -57,7 +57,8 @@ message FieldErrorEnum {
// The field's value is on a deny-list for this field.
BLOCKED_VALUE = 9;
- }
-
+ // The field's value cannot be modified, except for clearing.
+ FIELD_CAN_ONLY_BE_CLEARED = 10;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/field_mask_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/field_mask_error.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/errors/field_mask_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/field_mask_error.proto
index 616468e85..42a9542ea 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/field_mask_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/field_mask_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FieldMaskErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing field mask errors.
@@ -51,6 +51,4 @@ message FieldMaskErrorEnum {
// all the subfields of the invalid field.
FIELD_HAS_SUBFIELDS = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/function_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/function_error.proto
similarity index 88%
rename from third_party/googleapis/google/ads/googleads/v10/errors/function_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/function_error.proto
index f0b9ab882..8b2a3e049 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/function_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/function_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FunctionErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing function errors.
@@ -86,6 +86,4 @@ message FunctionErrorEnum {
// Invalid attribute name.
INVALID_ATTRIBUTE_NAME = 17;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/function_parsing_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/function_parsing_error.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/errors/function_parsing_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/function_parsing_error.proto
index 905b4566c..e5dd9786f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/function_parsing_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/function_parsing_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "FunctionParsingErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing function parsing errors.
@@ -70,6 +70,4 @@ message FunctionParsingErrorEnum {
// Function had too many operands.
TOO_MANY_OPERANDS = 12;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/geo_target_constant_suggestion_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/geo_target_constant_suggestion_error.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/errors/geo_target_constant_suggestion_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/geo_target_constant_suggestion_error.proto
index 034b2f8fb..1bc05b17e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/geo_target_constant_suggestion_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/geo_target_constant_suggestion_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "GeoTargetConstantSuggestionErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Container for enum describing possible geo target constant suggestion errors.
message GeoTargetConstantSuggestionErrorEnum {
@@ -49,6 +49,4 @@ message GeoTargetConstantSuggestionErrorEnum {
// the request.
REQUEST_PARAMETERS_UNSET = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/header_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/header_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/header_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/header_error.proto
index 0e8d09af2..f6fc6f91e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/header_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/header_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "HeaderErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing header errors.
@@ -43,6 +43,4 @@ message HeaderErrorEnum {
// The linked customer ID could not be validated.
INVALID_LINKED_CUSTOMER_ID = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/id_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/id_error.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/errors/id_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/id_error.proto
index ebffe2680..514f4297f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/id_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/id_error.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "IdErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing id errors.
-// Container for enum describing possible id errors.
+// Container for enum describing possible ID errors.
message IdErrorEnum {
- // Enum describing possible id errors.
+ // Enum describing possible ID errors.
enum IdError {
// Enum unspecified.
UNSPECIFIED = 0;
@@ -37,9 +37,7 @@ message IdErrorEnum {
// The received error code is not known in this version.
UNKNOWN = 1;
- // Id not found
+ // ID not found
NOT_FOUND = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/image_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/image_error.proto
similarity index 93%
rename from third_party/googleapis/google/ads/googleads/v10/errors/image_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/image_error.proto
index 298d37332..87e080443 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/image_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/image_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ImageErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing image errors.
@@ -157,6 +157,4 @@ message ImageErrorEnum {
// Image format is not allowed.
FORMAT_NOT_ALLOWED = 40;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/internal_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/internal_error.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/errors/internal_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/internal_error.proto
index c44c1f941..779ebffd3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/internal_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/internal_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "InternalErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing internal errors.
@@ -51,6 +51,4 @@ message InternalErrorEnum {
// The request took longer than a deadline.
DEADLINE_EXCEEDED = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/invoice_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/invoice_error.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/errors/invoice_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/invoice_error.proto
index cf52d7b63..654f0f77a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/invoice_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/invoice_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "InvoiceErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing invoice errors.
@@ -53,6 +53,4 @@ message InvoiceErrorEnum {
// Cannot request invoices for a non serving customer.
NON_SERVING_CUSTOMER = 6;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_ad_group_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_ad_group_error.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_ad_group_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_ad_group_error.proto
index 770f544db..3dde846e9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_ad_group_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_ad_group_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanAdGroupErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing errors from applying a keyword plan ad group.
@@ -46,6 +46,4 @@ message KeywordPlanAdGroupErrorEnum {
// AdGroup name or other keyword plan AdGroup name in the request.
DUPLICATE_NAME = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_ad_group_keyword_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_ad_group_keyword_error.proto
similarity index 87%
rename from third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_ad_group_keyword_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_ad_group_keyword_error.proto
index ed8bfabc0..a1255725c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_ad_group_keyword_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_ad_group_keyword_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanAdGroupKeywordErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing errors from applying a keyword plan ad group keyword or
// keyword plan campaign keyword.
@@ -65,6 +65,4 @@ message KeywordPlanAdGroupKeywordErrorEnum {
// New broad match modifier (BMM) KpAdGroupKeywords are not allowed.
NEW_BMM_KEYWORDS_NOT_ALLOWED = 9;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_campaign_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_campaign_error.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_campaign_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_campaign_error.proto
index cce2f80d1..7189710fa 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_campaign_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_campaign_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanCampaignErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing errors from applying a keyword plan campaign.
@@ -58,6 +58,4 @@ message KeywordPlanCampaignErrorEnum {
// The number of languages in the keyword plan campaign exceeds limits.
MAX_LANGUAGES_EXCEEDED = 7;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_campaign_keyword_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_campaign_keyword_error.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_campaign_keyword_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_campaign_keyword_error.proto
index 7ad85de1e..d635a05a2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_campaign_keyword_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_campaign_keyword_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanCampaignKeywordErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing errors from applying a keyword plan campaign keyword.
@@ -42,6 +42,4 @@ message KeywordPlanCampaignKeywordErrorEnum {
// Keyword plan campaign keyword is positive.
CAMPAIGN_KEYWORD_IS_POSITIVE = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_error.proto
similarity index 89%
rename from third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_error.proto
index 27675088c..8703be3cc 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing errors from applying keyword plan resources (keyword
// plan, keyword plan campaign, keyword plan ad group or keyword plan keyword)
@@ -84,6 +84,4 @@ message KeywordPlanErrorEnum {
// The plan's name is invalid.
INVALID_NAME = 16;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_idea_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_idea_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_idea_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_idea_error.proto
index 8e2c8ebd2..cba848e52 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/keyword_plan_idea_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/keyword_plan_idea_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanIdeaErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing errors from KeywordPlanIdeaService.
@@ -43,6 +43,4 @@ message KeywordPlanIdeaErrorEnum {
// The input has an invalid value.
INVALID_VALUE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/label_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/label_error.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/errors/label_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/label_error.proto
index dfeefa178..5f76aa869 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/label_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/label_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "LabelErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing label errors.
@@ -66,6 +66,4 @@ message LabelErrorEnum {
// resource.
CANNOT_ATTACH_NON_MANAGER_LABEL_TO_CUSTOMER = 10;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/language_code_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/language_code_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/language_code_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/language_code_error.proto
index d8754bc08..59a0dd60e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/language_code_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/language_code_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "LanguageCodeErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing language code errors.
@@ -43,6 +43,4 @@ message LanguageCodeErrorEnum {
// The language code is not supported.
INVALID_LANGUAGE_CODE = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/list_operation_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/list_operation_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/list_operation_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/list_operation_error.proto
index c51524ef6..b135e1cff 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/list_operation_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/list_operation_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ListOperationErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing list operation errors.
@@ -43,6 +43,4 @@ message ListOperationErrorEnum {
// Duplicate or identical value is sent in multiple list operations.
DUPLICATE_VALUES = 8;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/manager_link_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/manager_link_error.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/errors/manager_link_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/manager_link_error.proto
index ccdf831c5..91f3b8bcf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/manager_link_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/manager_link_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ManagerLinkErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ManagerLink errors.
@@ -96,6 +96,4 @@ message ManagerLinkErrorEnum {
// The link was created with status ACTIVE and not PENDING.
CREATING_ENABLED_LINK_NOT_ALLOWED = 20;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/media_bundle_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/media_bundle_error.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/errors/media_bundle_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/media_bundle_error.proto
index e8ce7f3c3..840c97f35 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/media_bundle_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/media_bundle_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "MediaBundleErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing media bundle errors.
@@ -103,6 +103,4 @@ message MediaBundleErrorEnum {
// Custom exits not allowed in HTML5 entry.
CUSTOM_EXIT_NOT_ALLOWED = 24;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/media_file_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/media_file_error.proto
similarity index 90%
rename from third_party/googleapis/google/ads/googleads/v10/errors/media_file_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/media_file_error.proto
index 32b85d589..81ae4031b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/media_file_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/media_file_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "MediaFileErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing media file errors.
@@ -106,6 +106,4 @@ message MediaFileErrorEnum {
// The YouTube video ID is syntactically valid but the video was not found.
YOU_TUBE_VIDEO_NOT_FOUND = 24;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/media_upload_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/media_upload_error.proto
similarity index 92%
rename from third_party/googleapis/google/ads/googleads/v10/errors/media_upload_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/media_upload_error.proto
index 75ddf57f4..591b7dffe 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/media_upload_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/media_upload_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "MediaUploadErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing media uploading errors.
@@ -111,7 +111,7 @@ message MediaUploadErrorEnum {
MEDIA_BUNDLE_NOT_ALLOWED = 24;
// The media bundle is not compatible with the asset spec product type.
- // (E.g. Gmail, dynamic remarketing, etc.)
+ // (For example, Gmail, dynamic remarketing, etc.)
MEDIA_BUNDLE_NOT_COMPATIBLE_TO_PRODUCT_TYPE = 25;
// A bundle being uploaded that is incompatible with multiple assets for
@@ -145,6 +145,4 @@ message MediaUploadErrorEnum {
// The dimensions of the image are not allowed.
DIMENSIONS_NOT_ALLOWED = 35;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/merchant_center_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/merchant_center_error.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/errors/merchant_center_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/merchant_center_error.proto
index 62cf00bec..f67933604 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/merchant_center_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/merchant_center_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "MerchantCenterErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing merchant center errors.
@@ -43,6 +43,4 @@ message MerchantCenterErrorEnum {
// Customer not allowlisted for Shopping in Performance Max Campaign.
CUSTOMER_NOT_ALLOWED_FOR_SHOPPING_PERFORMANCE_MAX = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/multiplier_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/multiplier_error.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/errors/multiplier_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/multiplier_error.proto
index 6bd8589eb..22d7cb92e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/multiplier_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/multiplier_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "MultiplierErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing multiplier errors.
@@ -49,8 +49,8 @@ message MultiplierErrorEnum {
// A multiplier cannot be set for this bidding strategy
MULTIPLIER_NOT_ALLOWED_FOR_BIDDING_STRATEGY = 5;
- // A multiplier cannot be set when there is no base bid (e.g., content max
- // cpc)
+ // A multiplier cannot be set when there is no base bid (for example,
+ // content max cpc)
MULTIPLIER_NOT_ALLOWED_WHEN_BASE_BID_IS_MISSING = 6;
// A bid multiplier must be specified
@@ -71,9 +71,8 @@ message MultiplierErrorEnum {
// Multiplier causes bid to become less than the minimum bid allowed
BID_LESS_THAN_MIN_ALLOWED_BID_WITH_MULTIPLIER = 12;
- // Multiplier type (cpc vs. cpm) needs to match campaign's bidding strategy
+ // Multiplier type (cpc versus cpm) needs to match campaign's bidding
+ // strategy
MULTIPLIER_AND_BIDDING_STRATEGY_TYPE_MISMATCH = 13;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/mutate_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/mutate_error.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/errors/mutate_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/mutate_error.proto
index 69d2e65fd..4c830835b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/mutate_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/mutate_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "MutateErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing mutate errors.
@@ -65,6 +65,4 @@ message MutateErrorEnum {
// Attempt to write to read-only fields.
RESOURCE_READ_ONLY = 13;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/new_resource_creation_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/new_resource_creation_error.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/errors/new_resource_creation_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/new_resource_creation_error.proto
index 86194df3b..911ab52b4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/new_resource_creation_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/new_resource_creation_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "NewResourceCreationErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing new resource creation errors.
@@ -47,6 +47,4 @@ message NewResourceCreationErrorEnum {
// validation will be done for this child resource.
TEMP_ID_RESOURCE_HAD_ERRORS = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/not_allowlisted_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/not_allowlisted_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/not_allowlisted_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/not_allowlisted_error.proto
index a36e972ea..2813f53f0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/not_allowlisted_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/not_allowlisted_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "NotAllowlistedErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing not allowlisted errors.
@@ -40,6 +40,4 @@ message NotAllowlistedErrorEnum {
// Customer is not allowlisted for accessing this feature.
CUSTOMER_NOT_ALLOWLISTED_FOR_THIS_FEATURE = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/not_empty_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/not_empty_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/not_empty_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/not_empty_error.proto
index 3a73e0e9c..850e52633 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/not_empty_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/not_empty_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "NotEmptyErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing not empty errors.
@@ -40,6 +40,4 @@ message NotEmptyErrorEnum {
// Empty list.
EMPTY_LIST = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/null_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/null_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/null_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/null_error.proto
index 15e3b810d..852408f7b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/null_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/null_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "NullErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing null errors.
@@ -40,6 +40,4 @@ message NullErrorEnum {
// Specified list/container must not contain any null elements
NULL_CONTENT = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/offline_user_data_job_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/offline_user_data_job_error.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/errors/offline_user_data_job_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/offline_user_data_job_error.proto
index 3a5fa5c9b..7f8b59d84 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/offline_user_data_job_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/offline_user_data_job_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "OfflineUserDataJobErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing offline user data job errors.
@@ -131,8 +131,8 @@ message OfflineUserDataJobErrorEnum {
// User attributes cannot be uploaded into a user list.
ATTRIBUTES_NOT_APPLICABLE_FOR_CUSTOMER_MATCH_USER_LIST = 34;
- // Lifetime value bucket must be a number from 1-10, except for remove
- // operation where 0 will be accepted.
+ // Lifetime bucket value must be a number from 0 to 10; 0 is only accepted
+ // for remove operations
LIFETIME_VALUE_BUCKET_NOT_IN_RANGE = 35;
// Identifiers not supported for Customer Match attributes. User attributes
@@ -153,7 +153,19 @@ message OfflineUserDataJobErrorEnum {
// Provided item ID is invalid.
INVALID_ITEM_ID = 40;
- }
+ // First purchase date time cannot be greater than the last purchase date
+ // time.
+ FIRST_PURCHASE_TIME_GREATER_THAN_LAST_PURCHASE_TIME = 42;
+
+ // Provided lifecycle stage is invalid.
+ INVALID_LIFECYCLE_STAGE = 43;
+ // The event value of the Customer Match user attribute is invalid.
+ INVALID_EVENT_VALUE = 44;
+
+ // All the fields are not present in the EventAttribute of the Customer
+ // Match.
+ EVENT_ATTRIBUTE_ALL_FIELDS_ARE_REQUIRED = 45;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/operation_access_denied_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/operation_access_denied_error.proto
similarity index 88%
rename from third_party/googleapis/google/ads/googleads/v10/errors/operation_access_denied_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/operation_access_denied_error.proto
index 9623857ad..e42584197 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/operation_access_denied_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/operation_access_denied_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "OperationAccessDeniedErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing operation access denied errors.
@@ -67,6 +67,4 @@ message OperationAccessDeniedErrorEnum {
// The mutate is not allowed for this customer.
MUTATE_NOT_PERMITTED_FOR_CUSTOMER = 11;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/operator_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/operator_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/operator_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/operator_error.proto
index bd3cefe63..9cf0f86be 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/operator_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/operator_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "OperatorErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing operator errors.
@@ -40,6 +40,4 @@ message OperatorErrorEnum {
// Operator not supported.
OPERATOR_NOT_SUPPORTED = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/partial_failure_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/partial_failure_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/partial_failure_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/partial_failure_error.proto
index 75286f738..1c9d9c8e3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/partial_failure_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/partial_failure_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "PartialFailureErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing partial failure errors.
@@ -41,6 +41,4 @@ message PartialFailureErrorEnum {
// This method requires this field be set to true.
PARTIAL_FAILURE_MODE_REQUIRED = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/payments_account_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/payments_account_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/payments_account_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/payments_account_error.proto
index c4317bdfa..f498786de 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/payments_account_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/payments_account_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "PaymentsAccountErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing payments account service errors.
@@ -40,6 +40,4 @@ message PaymentsAccountErrorEnum {
// Manager customers are not supported for payments account service.
NOT_SUPPORTED_FOR_MANAGER_CUSTOMER = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/policy_finding_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/policy_finding_error.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/errors/policy_finding_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/policy_finding_error.proto
index 983927d21..4252085ac 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/policy_finding_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/policy_finding_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "PolicyFindingErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing policy finding errors.
@@ -44,6 +44,4 @@ message PolicyFindingErrorEnum {
// The given policy topic does not exist.
POLICY_TOPIC_NOT_FOUND = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/policy_validation_parameter_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/policy_validation_parameter_error.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/errors/policy_validation_parameter_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/policy_validation_parameter_error.proto
index 8e99615a6..40aa7468b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/policy_validation_parameter_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/policy_validation_parameter_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "PolicyValidationParameterErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing policy validation parameter errors.
@@ -45,8 +45,7 @@ message PolicyValidationParameterErrorEnum {
// Cannot set ignorable policy topics and exempt policy violation keys in
// the same policy violation parameter.
- CANNOT_SET_BOTH_IGNORABLE_POLICY_TOPICS_AND_EXEMPT_POLICY_VIOLATION_KEYS = 4;
+ CANNOT_SET_BOTH_IGNORABLE_POLICY_TOPICS_AND_EXEMPT_POLICY_VIOLATION_KEYS =
+ 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/policy_violation_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/policy_violation_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/policy_violation_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/policy_violation_error.proto
index 12db62c2c..fa3d3fefa 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/policy_violation_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/policy_violation_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "PolicyViolationErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing policy violation errors.
@@ -40,6 +40,4 @@ message PolicyViolationErrorEnum {
// A policy was violated. See PolicyViolationDetails for more detail.
POLICY_ERROR = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/query_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/query_error.proto
similarity index 93%
rename from third_party/googleapis/google/ads/googleads/v10/errors/query_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/query_error.proto
index 3515b72a5..33e2c4176 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/query_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/query_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "QueryErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing query errors.
@@ -49,7 +49,7 @@ message QueryErrorEnum {
// Field name is invalid.
BAD_FIELD_NAME = 12;
- // Limit value is invalid (i.e. not a number)
+ // Limit value is invalid (for example, not a number)
BAD_LIMIT_VALUE = 15;
// Encountered number can not be parsed.
@@ -121,8 +121,8 @@ message QueryErrorEnum {
// segments.week/segments.month/segments.quarter.
MISALIGNED_DATE_FOR_FILTER = 64;
- // Value passed was not a string when it should have been. I.e., it was a
- // number or unquoted literal.
+ // Value passed was not a string when it should have been. For example, it
+ // was a number or unquoted literal.
INVALID_STRING_VALUE = 57;
// A String value passed to the BETWEEN operator does not parse as a date.
@@ -220,6 +220,4 @@ message QueryErrorEnum {
// limit.
FILTER_HAS_TOO_MANY_VALUES = 63;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/quota_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/quota_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/quota_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/quota_error.proto
index af29dc470..afc66d862 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/quota_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/quota_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "QuotaErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing quota errors.
@@ -46,6 +46,4 @@ message QuotaErrorEnum {
// Too many requests in a short amount of time.
RESOURCE_TEMPORARILY_EXHAUSTED = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/range_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/range_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/range_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/range_error.proto
index f27edd674..a160ab7bd 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/range_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/range_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "RangeErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing range errors.
@@ -43,6 +43,4 @@ message RangeErrorEnum {
// Too high.
TOO_HIGH = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/reach_plan_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/reach_plan_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/reach_plan_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/reach_plan_error.proto
index 1febb521f..21f762517 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/reach_plan_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/reach_plan_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ReachPlanErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing errors generated from ReachPlanService.
@@ -41,6 +41,4 @@ message ReachPlanErrorEnum {
// Not forecastable due to missing rate card data.
NOT_FORECASTABLE_MISSING_RATE = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/recommendation_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/recommendation_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/recommendation_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/recommendation_error.proto
index f3476a6f0..8f3432c8c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/recommendation_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/recommendation_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "RecommendationErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing errors from applying a recommendation.
@@ -37,22 +37,22 @@ message RecommendationErrorEnum {
// The received error code is not known in this version.
UNKNOWN = 1;
- // The specified budget amount is too low e.g. lower than minimum currency
- // unit or lower than ad group minimum cost-per-click.
+ // The specified budget amount is too low for example, lower than minimum
+ // currency unit or lower than ad group minimum cost-per-click.
BUDGET_AMOUNT_TOO_SMALL = 2;
// The specified budget amount is too large.
BUDGET_AMOUNT_TOO_LARGE = 3;
- // The specified budget amount is not a valid amount. e.g. not a multiple
- // of minimum currency unit.
+ // The specified budget amount is not a valid amount, for example, not a
+ // multiple of minimum currency unit.
INVALID_BUDGET_AMOUNT = 4;
// The specified keyword or ad violates ad policy.
POLICY_ERROR = 5;
- // The specified bid amount is not valid. e.g. too many fractional digits,
- // or negative amount.
+ // The specified bid amount is not valid, for example, too many fractional
+ // digits, or negative amount.
INVALID_BID_AMOUNT = 6;
// The number of keywords in ad group have reached the maximum allowed.
@@ -83,6 +83,4 @@ message RecommendationErrorEnum {
// The recommendation apply request was malformed and invalid.
INVALID_APPLY_REQUEST = 15;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/region_code_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/region_code_error.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/errors/region_code_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/region_code_error.proto
index e3d998b0e..92157dd6e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/region_code_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/region_code_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "RegionCodeErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing region code errors.
@@ -40,6 +40,4 @@ message RegionCodeErrorEnum {
// Invalid region code.
INVALID_REGION_CODE = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/request_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/request_error.proto
similarity index 92%
rename from third_party/googleapis/google/ads/googleads/v10/errors/request_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/request_error.proto
index 7d15f8a46..d75f3b28b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/request_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/request_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "RequestErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing request errors.
@@ -112,6 +112,4 @@ message RequestErrorEnum {
// Deadline specified by the client was too short.
RPC_DEADLINE_TOO_SHORT = 33;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/resource_access_denied_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/resource_access_denied_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/resource_access_denied_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/resource_access_denied_error.proto
index 26f4042c2..45b3d5039 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/resource_access_denied_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/resource_access_denied_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ResourceAccessDeniedErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing resource access denied errors.
@@ -40,6 +40,4 @@ message ResourceAccessDeniedErrorEnum {
// User did not have write access.
WRITE_ACCESS_DENIED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/resource_count_limit_exceeded_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/resource_count_limit_exceeded_error.proto
similarity index 91%
rename from third_party/googleapis/google/ads/googleads/v10/errors/resource_count_limit_exceeded_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/resource_count_limit_exceeded_error.proto
index 31f8c3823..57fc97a76 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/resource_count_limit_exceeded_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/resource_count_limit_exceeded_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ResourceCountLimitExceededErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing resource count limit exceeded errors.
@@ -86,6 +86,4 @@ message ResourceCountLimitExceededErrorEnum {
// returned in ErrorDetails.
RESOURCE_LIMIT = 10;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/setting_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/setting_error.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/errors/setting_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/setting_error.proto
index f5dc32a2a..469394287 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/setting_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/setting_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "SettingErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing setting errors.
@@ -52,12 +52,14 @@ message SettingErrorEnum {
// set any of the Demographic CriterionTypeGroups (AGE_RANGE, GENDER,
// PARENT, INCOME_RANGE) to false (it's okay to not set them at all, in
// which case the system will set them to true automatically).
- TARGETING_SETTING_DEMOGRAPHIC_CRITERION_TYPE_GROUPS_MUST_BE_SET_TO_TARGET_ALL = 6;
+ TARGETING_SETTING_DEMOGRAPHIC_CRITERION_TYPE_GROUPS_MUST_BE_SET_TO_TARGET_ALL =
+ 6;
// TargetingSetting cannot change any of
// the Demographic CriterionTypeGroups (AGE_RANGE, GENDER, PARENT,
// INCOME_RANGE) from true to false.
- TARGETING_SETTING_CANNOT_CHANGE_TARGET_ALL_TO_FALSE_FOR_DEMOGRAPHIC_CRITERION_TYPE_GROUP = 7;
+ TARGETING_SETTING_CANNOT_CHANGE_TARGET_ALL_TO_FALSE_FOR_DEMOGRAPHIC_CRITERION_TYPE_GROUP =
+ 7;
// At least one feed id should be present.
DYNAMIC_SEARCH_ADS_SETTING_AT_LEAST_ONE_FEED_ID_MUST_BE_PRESENT = 8;
@@ -77,7 +79,10 @@ message SettingErrorEnum {
// The setting value is not compatible with the campaign type.
SETTING_VALUE_NOT_COMPATIBLE_WITH_CAMPAIGN = 20;
- }
-
+ // Switching from observation setting to targeting setting is not allowed
+ // for Customer Match lists. See
+ // https://support.google.com/google-ads/answer/6299717.
+ BID_ONLY_IS_NOT_ALLOWED_TO_BE_MODIFIED_WITH_CUSTOMER_MATCH_TARGETING = 21;
+ }
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/shared_criterion_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/shared_criterion_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/shared_criterion_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/shared_criterion_error.proto
index 30c5dc942..ef2bf45d7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/shared_criterion_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/shared_criterion_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "SharedCriterionErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing shared criterion errors.
@@ -40,6 +40,4 @@ message SharedCriterionErrorEnum {
// The criterion is not appropriate for the shared set type.
CRITERION_TYPE_NOT_ALLOWED_FOR_SHARED_SET_TYPE = 2;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/shared_set_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/shared_set_error.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/errors/shared_set_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/shared_set_error.proto
index b181eb217..3266cd8d4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/shared_set_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/shared_set_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "SharedSetErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing shared set errors.
@@ -49,6 +49,4 @@ message SharedSetErrorEnum {
// The shared set cannot be removed because it is in use.
SHARED_SET_IN_USE = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/size_limit_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/size_limit_error.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/errors/size_limit_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/size_limit_error.proto
index de13f4552..28dd036a8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/size_limit_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/size_limit_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "SizeLimitErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing size limit errors.
@@ -37,12 +37,12 @@ message SizeLimitErrorEnum {
// The received error code is not known in this version.
UNKNOWN = 1;
- // The number of entries in the request exceeds the system limit.
+ // The number of entries in the request exceeds the system limit, or the
+ // contents of the operations exceed transaction limits due to their size
+ // or complexity. Try reducing the number of entries per request.
REQUEST_SIZE_LIMIT_EXCEEDED = 2;
// The number of entries in the response exceeds the system limit.
RESPONSE_SIZE_LIMIT_EXCEEDED = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/errors/smart_campaign_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/smart_campaign_error.proto
new file mode 100644
index 000000000..a723be08e
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/smart_campaign_error.proto
@@ -0,0 +1,62 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.errors;
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
+option java_multiple_files = true;
+option java_outer_classname = "SmartCampaignErrorProto";
+option java_package = "com.google.ads.googleads.v13.errors";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
+
+// Proto file describing Smart campaign errors.
+
+// Container for enum describing possible Smart campaign errors.
+message SmartCampaignErrorEnum {
+ // Enum describing possible Smart campaign errors.
+ enum SmartCampaignError {
+ // Enum unspecified.
+ UNSPECIFIED = 0;
+
+ // The received error code is not known in this version.
+ UNKNOWN = 1;
+
+ // The business location id is invalid.
+ INVALID_BUSINESS_LOCATION_ID = 2;
+
+ // The SmartCampaignSetting resource is only applicable for campaigns
+ // with advertising channel type SMART.
+ INVALID_CAMPAIGN = 3;
+
+ // The business name or business location id is required.
+ BUSINESS_NAME_OR_BUSINESS_LOCATION_ID_MISSING = 4;
+
+ // A Smart campaign suggestion request field is required.
+ REQUIRED_SUGGESTION_FIELD_MISSING = 5;
+
+ // A location list or proximity is required.
+ GEO_TARGETS_REQUIRED = 6;
+
+ // The locale could not be determined.
+ CANNOT_DETERMINE_SUGGESTION_LOCALE = 7;
+
+ // The final URL could not be crawled.
+ FINAL_URL_NOT_CRAWLABLE = 8;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/string_format_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/string_format_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/string_format_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/string_format_error.proto
index cdeb8def5..be5cd6730 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/string_format_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/string_format_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "StringFormatErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing string format errors.
@@ -43,6 +43,4 @@ message StringFormatErrorEnum {
// The input string value is invalid for the associated field.
INVALID_FORMAT = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/string_length_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/string_length_error.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/errors/string_length_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/string_length_error.proto
index 57f115e4e..63e68334c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/string_length_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/string_length_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "StringLengthErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing string length errors.
@@ -47,6 +47,4 @@ message StringLengthErrorEnum {
// Too long.
TOO_LONG = 3;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/third_party_app_analytics_link_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/third_party_app_analytics_link_error.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/errors/third_party_app_analytics_link_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/third_party_app_analytics_link_error.proto
index 4abc72af9..2de43d4c6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/third_party_app_analytics_link_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/third_party_app_analytics_link_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "ThirdPartyAppAnalyticsLinkErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing ThirdPartyAppAnalyticsLink errors.
@@ -50,6 +50,4 @@ message ThirdPartyAppAnalyticsLinkErrorEnum {
// Regenerating shareable link ID is only allowed on active links
CANNOT_REGENERATE_SHAREABLE_LINK_ID_FOR_REMOVED_LINK = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/time_zone_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/time_zone_error.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/errors/time_zone_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/time_zone_error.proto
index 152ee780a..02c0251a0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/time_zone_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/time_zone_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "TimeZoneErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing time zone errors.
@@ -40,6 +40,4 @@ message TimeZoneErrorEnum {
// Time zone is not valid.
INVALID_TIME_ZONE = 5;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/url_field_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/url_field_error.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/errors/url_field_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/url_field_error.proto
index 48f60f357..0602a6ab6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/url_field_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/url_field_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "UrlFieldErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing url field errors.
@@ -43,9 +43,9 @@ message UrlFieldErrorEnum {
// The tracking url template contains invalid tag.
INVALID_TAG_IN_TRACKING_URL_TEMPLATE = 3;
- // The tracking url template must contain at least one tag (e.g. {lpurl}),
- // This applies only to tracking url template associated with website ads or
- // product ads.
+ // The tracking url template must contain at least one tag (for example,
+ // {lpurl}), This applies only to tracking url template associated with
+ // website ads or product ads.
MISSING_TRACKING_URL_TEMPLATE_TAG = 4;
// The tracking url template must start with a valid protocol (or lpurl
@@ -66,7 +66,7 @@ message UrlFieldErrorEnum {
INVALID_TLD_IN_TRACKING_URL_TEMPLATE = 9;
// The tracking url template contains nested occurrences of the same
- // conditional tag (i.e. {ifmobile:{ifmobile:x}}).
+ // conditional tag (for example, {ifmobile:{ifmobile:x}}).
REDUNDANT_NESTED_TRACKING_URL_TEMPLATE_TAG = 10;
// The final url is invalid.
@@ -76,7 +76,7 @@ message UrlFieldErrorEnum {
INVALID_TAG_IN_FINAL_URL = 12;
// The final url contains nested occurrences of the same conditional tag
- // (i.e. {ifmobile:{ifmobile:x}}).
+ // (for example, {ifmobile:{ifmobile:x}}).
REDUNDANT_NESTED_FINAL_URL_TAG = 13;
// The final url must start with a valid protocol.
@@ -102,7 +102,7 @@ message UrlFieldErrorEnum {
INVALID_TAG_IN_FINAL_MOBILE_URL = 20;
// The final mobile url contains nested occurrences of the same conditional
- // tag (i.e. {ifmobile:{ifmobile:x}}).
+ // tag (for example, {ifmobile:{ifmobile:x}}).
REDUNDANT_NESTED_FINAL_MOBILE_URL_TAG = 21;
// The final mobile url must start with a valid protocol.
@@ -128,7 +128,7 @@ message UrlFieldErrorEnum {
INVALID_TAG_IN_FINAL_APP_URL = 28;
// The final app url contains nested occurrences of the same conditional tag
- // (i.e. {ifmobile:{ifmobile:x}}).
+ // (for example, {ifmobile:{ifmobile:x}}).
REDUNDANT_NESTED_FINAL_APP_URL_TAG = 29;
// More than one app url found for the same OS type.
@@ -137,7 +137,8 @@ message UrlFieldErrorEnum {
// The OS type given for an app url is not valid.
INVALID_OSTYPE = 31;
- // The protocol given for an app url is not valid. (E.g. "android-app://")
+ // The protocol given for an app url is not valid. (For example,
+ // "android-app://")
INVALID_PROTOCOL_FOR_APP_URL = 32;
// The package id (app id) given for an app url is not valid.
@@ -157,7 +158,7 @@ message UrlFieldErrorEnum {
INVALID_TAG_IN_URL_CUSTOM_PARAMETER_VALUE = 41;
// The custom parameter contains nested occurrences of the same conditional
- // tag (i.e. {ifmobile:{ifmobile:x}}).
+ // tag (for example, {ifmobile:{ifmobile:x}}).
REDUNDANT_NESTED_URL_CUSTOM_PARAMETER_TAG = 42;
// The protocol (http:// or https://) is missing.
@@ -175,7 +176,7 @@ message UrlFieldErrorEnum {
// The url contains invalid tag.
INVALID_TAG_IN_URL = 46;
- // The url must contain at least one tag (e.g. {lpurl}).
+ // The url must contain at least one tag (for example, {lpurl}).
MISSING_URL_TAG = 47;
// Duplicate url id.
@@ -191,8 +192,8 @@ message UrlFieldErrorEnum {
// The final url suffix cannot contain {lpurl} related or {ignore} tags.
INVALID_TAG_IN_FINAL_URL_SUFFIX = 51;
- // The top level domain is invalid, e.g. not a public top level domain
- // listed in publicsuffix.org.
+ // The top level domain is invalid, for example, not a public top level
+ // domain listed in publicsuffix.org.
INVALID_TOP_LEVEL_DOMAIN = 53;
// Malformed top level domain in URL.
@@ -210,6 +211,4 @@ message UrlFieldErrorEnum {
// Track parameter is not supported.
VALUE_TRACK_PARAMETER_NOT_SUPPORTED = 58;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/user_data_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/user_data_error.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/errors/user_data_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/user_data_error.proto
index 05a3cd1ef..1b2969cc5 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/user_data_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/user_data_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "UserDataErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing user data errors.
@@ -47,6 +47,4 @@ message UserDataErrorEnum {
// Current user list is not applicable for the given customer.
USER_LIST_NOT_APPLICABLE = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/user_list_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/user_list_error.proto
similarity index 91%
rename from third_party/googleapis/google/ads/googleads/v10/errors/user_list_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/user_list_error.proto
index e6356202a..9ff8903ed 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/user_list_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/user_list_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "UserListErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing user list errors.
@@ -109,7 +109,7 @@ message UserListErrorEnum {
USERLIST_NAME_IS_RESERVED_FOR_SYSTEM_LIST = 32;
// Advertiser needs to be on the allow-list to use remarketing lists created
- // from advertiser uploaded data (e.g., Customer Match lists).
+ // from advertiser uploaded data (for example, Customer Match lists).
ADVERTISER_NOT_ON_ALLOWLIST_FOR_USING_UPLOADED_DATA = 37;
// The provided rule_type is not supported for the user list.
@@ -122,6 +122,4 @@ message UserListErrorEnum {
// types of lists in its rules.
CAN_NOT_MIX_CRM_BASED_IN_LOGICAL_LIST_WITH_OTHER_LISTS = 36;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/errors/youtube_video_registration_error.proto b/third_party/googleapis/google/ads/googleads/v13/errors/youtube_video_registration_error.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/errors/youtube_video_registration_error.proto
rename to third_party/googleapis/google/ads/googleads/v13/errors/youtube_video_registration_error.proto
index 2e75a3b0f..2b65f3ec3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/errors/youtube_video_registration_error.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/errors/youtube_video_registration_error.proto
@@ -14,16 +14,16 @@
syntax = "proto3";
-package google.ads.googleads.v10.errors;
+package google.ads.googleads.v13.errors;
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Errors";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/errors;errors";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Errors";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/errors;errors";
option java_multiple_files = true;
option java_outer_classname = "YoutubeVideoRegistrationErrorProto";
-option java_package = "com.google.ads.googleads.v10.errors";
+option java_package = "com.google.ads.googleads.v13.errors";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Errors";
-option ruby_package = "Google::Ads::GoogleAds::V10::Errors";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Errors";
+option ruby_package = "Google::Ads::GoogleAds::V13::Errors";
// Proto file describing YouTube video registration errors.
@@ -40,12 +40,10 @@ message YoutubeVideoRegistrationErrorEnum {
// Video to be registered wasn't found.
VIDEO_NOT_FOUND = 2;
- // Video to be registered is not accessible (e.g. private).
+ // Video to be registered is not accessible (for example, private).
VIDEO_NOT_ACCESSIBLE = 3;
- // Video to be registered is not eligible (e.g. mature content).
+ // Video to be registered is not eligible (for example, mature content).
VIDEO_NOT_ELIGIBLE = 4;
}
-
-
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/googleads_gapic.yaml b/third_party/googleapis/google/ads/googleads/v13/googleads_gapic.yaml
new file mode 100644
index 000000000..5acd2be90
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/googleads_gapic.yaml
@@ -0,0 +1,26 @@
+type: com.google.api.codegen.ConfigProto
+config_schema_version: 2.0.0
+language_settings:
+ csharp:
+ package_name: Google.Ads.GoogleAds.V13.Services
+ go:
+ package_name: google.golang.org/google/ads/googleads/v13/services
+ java:
+ package_name: com.google.ads.googleads.v13.services
+ nodejs:
+ package_name: v13.services
+ php:
+ package_name: Google\Ads\GoogleAds\V13\Services
+ python:
+ package_name: google.ads.googleads_v13.gapic.services
+ ruby:
+ package_name: Google::Ads::Googleads::V13::Services
+interfaces:
+- name: google.ads.googleads.v13.services.OfflineUserDataJobService
+ methods:
+ - name: RunOfflineUserDataJob
+ long_running:
+ initial_poll_delay_millis: 300000
+ max_poll_delay_millis: 3600000
+ poll_delay_multiplier: 1.25
+ total_poll_timeout_millis: 43200000
diff --git a/third_party/googleapis/google/ads/googleads/v13/googleads_grpc_service_config.json b/third_party/googleapis/google/ads/googleads/v13/googleads_grpc_service_config.json
new file mode 100755
index 000000000..b8b9f2a18
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/googleads_grpc_service_config.json
@@ -0,0 +1,336 @@
+{
+ "methodConfig": [
+ {
+ "name": [
+ {
+ "service": "google.ads.googleads.v13.services.AccountBudgetProposalService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AccountLinkService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupAdLabelService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupAdService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupAssetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupAssetSetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupBidModifierService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupCriterionCustomizerService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupCriterionLabelService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupCriterionService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupCustomizerService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupExtensionSettingService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupFeedService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupLabelService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdGroupService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdParameterService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AdService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AssetGroupAssetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AssetGroupListingGroupFilterService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AssetGroupService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AssetGroupSignalService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AssetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AssetSetAssetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AssetSetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AudienceInsightsService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.AudienceService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.BatchJobService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.BiddingDataExclusionService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.BiddingSeasonalityAdjustmentService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.BiddingStrategyService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.BillingSetupService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignAssetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignAssetSetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignBidModifierService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignBudgetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignConversionGoalService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignCriterionService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignCustomizerService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignDraftService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignExtensionSettingService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignFeedService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignGroupService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignLabelService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CampaignSharedSetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ConversionActionService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ConversionAdjustmentUploadService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ConversionCustomVariableService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ConversionGoalCampaignConfigService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ConversionUploadService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ConversionValueRuleService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ConversionValueRuleSetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomAudienceService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomConversionGoalService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomInterestService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerAssetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerAssetSetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerClientLinkService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerConversionGoalService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerCustomizerService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerExtensionSettingService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerFeedService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerLabelService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerManagerLinkService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerNegativeCriterionService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerUserAccessInvitationService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomerUserAccessService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.CustomizerAttributeService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ExperimentArmService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ExperimentService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ExtensionFeedItemService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.FeedItemService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.FeedItemSetLinkService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.FeedItemSetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.FeedItemTargetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.FeedMappingService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.FeedService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.GeoTargetConstantService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.GoogleAdsFieldService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.GoogleAdsService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.InvoiceService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.KeywordPlanAdGroupKeywordService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.KeywordPlanAdGroupService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.KeywordPlanCampaignKeywordService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.KeywordPlanCampaignService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.KeywordPlanIdeaService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.KeywordPlanService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.KeywordThemeConstantService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.LabelService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.MediaFileService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.MerchantCenterLinkService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.OfflineUserDataJobService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.PaymentsAccountService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ProductLinkService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ReachPlanService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.RecommendationService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.RemarketingActionService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.SharedCriterionService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.SharedSetService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.SmartCampaignSettingService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.SmartCampaignSuggestService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.ThirdPartyAppAnalyticsLinkService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.TravelAssetSuggestionService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.UserDataService"
+ },
+ {
+ "service": "google.ads.googleads.v13.services.UserListService"
+ }
+ ],
+ "timeout": "14400s",
+ "retryPolicy": {
+ "initialBackoff": "5s",
+ "maxBackoff": "60s",
+ "backoffMultiplier": 1.3,
+ "retryableStatusCodes": [
+ "UNAVAILABLE",
+ "DEADLINE_EXCEEDED"
+ ]
+ }
+ }
+ ]
+}
diff --git a/third_party/googleapis/google/ads/googleads/v13/googleads_v13.yaml b/third_party/googleapis/google/ads/googleads/v13/googleads_v13.yaml
new file mode 100644
index 000000000..ac4dd3402
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/googleads_v13.yaml
@@ -0,0 +1,843 @@
+type: google.api.Service
+config_version: 3
+name: googleads.googleapis.com
+title: Google Ads API
+
+apis:
+- name: google.ads.googleads.v13.services.AccountBudgetProposalService
+- name: google.ads.googleads.v13.services.AccountLinkService
+- name: google.ads.googleads.v13.services.AdGroupAdLabelService
+- name: google.ads.googleads.v13.services.AdGroupAdService
+- name: google.ads.googleads.v13.services.AdGroupAssetService
+- name: google.ads.googleads.v13.services.AdGroupAssetSetService
+- name: google.ads.googleads.v13.services.AdGroupBidModifierService
+- name: google.ads.googleads.v13.services.AdGroupCriterionCustomizerService
+- name: google.ads.googleads.v13.services.AdGroupCriterionLabelService
+- name: google.ads.googleads.v13.services.AdGroupCriterionService
+- name: google.ads.googleads.v13.services.AdGroupCustomizerService
+- name: google.ads.googleads.v13.services.AdGroupExtensionSettingService
+- name: google.ads.googleads.v13.services.AdGroupFeedService
+- name: google.ads.googleads.v13.services.AdGroupLabelService
+- name: google.ads.googleads.v13.services.AdGroupService
+- name: google.ads.googleads.v13.services.AdParameterService
+- name: google.ads.googleads.v13.services.AdService
+- name: google.ads.googleads.v13.services.AssetGroupAssetService
+- name: google.ads.googleads.v13.services.AssetGroupListingGroupFilterService
+- name: google.ads.googleads.v13.services.AssetGroupService
+- name: google.ads.googleads.v13.services.AssetGroupSignalService
+- name: google.ads.googleads.v13.services.AssetService
+- name: google.ads.googleads.v13.services.AssetSetAssetService
+- name: google.ads.googleads.v13.services.AssetSetService
+- name: google.ads.googleads.v13.services.AudienceInsightsService
+- name: google.ads.googleads.v13.services.AudienceService
+- name: google.ads.googleads.v13.services.BatchJobService
+- name: google.ads.googleads.v13.services.BiddingDataExclusionService
+- name: google.ads.googleads.v13.services.BiddingSeasonalityAdjustmentService
+- name: google.ads.googleads.v13.services.BiddingStrategyService
+- name: google.ads.googleads.v13.services.BillingSetupService
+- name: google.ads.googleads.v13.services.CampaignAssetService
+- name: google.ads.googleads.v13.services.CampaignAssetSetService
+- name: google.ads.googleads.v13.services.CampaignBidModifierService
+- name: google.ads.googleads.v13.services.CampaignBudgetService
+- name: google.ads.googleads.v13.services.CampaignConversionGoalService
+- name: google.ads.googleads.v13.services.CampaignCriterionService
+- name: google.ads.googleads.v13.services.CampaignCustomizerService
+- name: google.ads.googleads.v13.services.CampaignDraftService
+- name: google.ads.googleads.v13.services.CampaignExtensionSettingService
+- name: google.ads.googleads.v13.services.CampaignFeedService
+- name: google.ads.googleads.v13.services.CampaignGroupService
+- name: google.ads.googleads.v13.services.CampaignLabelService
+- name: google.ads.googleads.v13.services.CampaignService
+- name: google.ads.googleads.v13.services.CampaignSharedSetService
+- name: google.ads.googleads.v13.services.ConversionActionService
+- name: google.ads.googleads.v13.services.ConversionAdjustmentUploadService
+- name: google.ads.googleads.v13.services.ConversionCustomVariableService
+- name: google.ads.googleads.v13.services.ConversionGoalCampaignConfigService
+- name: google.ads.googleads.v13.services.ConversionUploadService
+- name: google.ads.googleads.v13.services.ConversionValueRuleService
+- name: google.ads.googleads.v13.services.ConversionValueRuleSetService
+- name: google.ads.googleads.v13.services.CustomAudienceService
+- name: google.ads.googleads.v13.services.CustomConversionGoalService
+- name: google.ads.googleads.v13.services.CustomInterestService
+- name: google.ads.googleads.v13.services.CustomerAssetService
+- name: google.ads.googleads.v13.services.CustomerAssetSetService
+- name: google.ads.googleads.v13.services.CustomerClientLinkService
+- name: google.ads.googleads.v13.services.CustomerConversionGoalService
+- name: google.ads.googleads.v13.services.CustomerCustomizerService
+- name: google.ads.googleads.v13.services.CustomerExtensionSettingService
+- name: google.ads.googleads.v13.services.CustomerFeedService
+- name: google.ads.googleads.v13.services.CustomerLabelService
+- name: google.ads.googleads.v13.services.CustomerManagerLinkService
+- name: google.ads.googleads.v13.services.CustomerNegativeCriterionService
+- name: google.ads.googleads.v13.services.CustomerService
+- name: google.ads.googleads.v13.services.CustomerUserAccessInvitationService
+- name: google.ads.googleads.v13.services.CustomerUserAccessService
+- name: google.ads.googleads.v13.services.CustomizerAttributeService
+- name: google.ads.googleads.v13.services.ExperimentArmService
+- name: google.ads.googleads.v13.services.ExperimentService
+- name: google.ads.googleads.v13.services.ExtensionFeedItemService
+- name: google.ads.googleads.v13.services.FeedItemService
+- name: google.ads.googleads.v13.services.FeedItemSetLinkService
+- name: google.ads.googleads.v13.services.FeedItemSetService
+- name: google.ads.googleads.v13.services.FeedItemTargetService
+- name: google.ads.googleads.v13.services.FeedMappingService
+- name: google.ads.googleads.v13.services.FeedService
+- name: google.ads.googleads.v13.services.GeoTargetConstantService
+- name: google.ads.googleads.v13.services.GoogleAdsFieldService
+- name: google.ads.googleads.v13.services.GoogleAdsService
+- name: google.ads.googleads.v13.services.InvoiceService
+- name: google.ads.googleads.v13.services.KeywordPlanAdGroupKeywordService
+- name: google.ads.googleads.v13.services.KeywordPlanAdGroupService
+- name: google.ads.googleads.v13.services.KeywordPlanCampaignKeywordService
+- name: google.ads.googleads.v13.services.KeywordPlanCampaignService
+- name: google.ads.googleads.v13.services.KeywordPlanIdeaService
+- name: google.ads.googleads.v13.services.KeywordPlanService
+- name: google.ads.googleads.v13.services.KeywordThemeConstantService
+- name: google.ads.googleads.v13.services.LabelService
+- name: google.ads.googleads.v13.services.MediaFileService
+- name: google.ads.googleads.v13.services.MerchantCenterLinkService
+- name: google.ads.googleads.v13.services.OfflineUserDataJobService
+- name: google.ads.googleads.v13.services.PaymentsAccountService
+- name: google.ads.googleads.v13.services.ProductLinkService
+- name: google.ads.googleads.v13.services.ReachPlanService
+- name: google.ads.googleads.v13.services.RecommendationService
+- name: google.ads.googleads.v13.services.RemarketingActionService
+- name: google.ads.googleads.v13.services.SharedCriterionService
+- name: google.ads.googleads.v13.services.SharedSetService
+- name: google.ads.googleads.v13.services.SmartCampaignSettingService
+- name: google.ads.googleads.v13.services.SmartCampaignSuggestService
+- name: google.ads.googleads.v13.services.ThirdPartyAppAnalyticsLinkService
+- name: google.ads.googleads.v13.services.TravelAssetSuggestionService
+- name: google.ads.googleads.v13.services.UserDataService
+- name: google.ads.googleads.v13.services.UserListService
+
+types:
+- name: google.ads.googleads.v13.errors.GoogleAdsFailure
+- name: google.ads.googleads.v13.resources.BatchJob.BatchJobMetadata
+- name: google.ads.googleads.v13.services.PromoteExperimentMetadata
+- name: google.ads.googleads.v13.services.ScheduleExperimentMetadata
+
+documentation:
+ summary: 'Manage your Google Ads accounts, campaigns, and reports with this API.'
+ overview: |-
+ The Google Ads API enables an app to integrate with the Google Ads
+ platform. You can efficiently retrieve and change your Google Ads data
+ using the API, making it ideal for managing large or complex accounts and
+ campaigns.
+
+backend:
+ rules:
+ - selector: google.ads.googleads.v13.services.AccountBudgetProposalService.MutateAccountBudgetProposal
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AccountLinkService.CreateAccountLink
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.AccountLinkService.MutateAccountLink
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.AdGroupAdLabelService.MutateAdGroupAdLabels
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupAdService.MutateAdGroupAds
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupAssetService.MutateAdGroupAssets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupAssetSetService.MutateAdGroupAssetSets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupBidModifierService.MutateAdGroupBidModifiers
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupCriterionService.MutateAdGroupCriteria
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupCustomizerService.MutateAdGroupCustomizers
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupFeedService.MutateAdGroupFeeds
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupLabelService.MutateAdGroupLabels
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdGroupService.MutateAdGroups
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdParameterService.MutateAdParameters
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdService.GetAd
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AdService.MutateAds
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AssetGroupAssetService.MutateAssetGroupAssets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AssetGroupService.MutateAssetGroups
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AssetGroupSignalService.MutateAssetGroupSignals
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AssetService.MutateAssets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AssetSetAssetService.MutateAssetSetAssets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.AssetSetService.MutateAssetSets
+ deadline: 60.0
+ - selector: 'google.ads.googleads.v13.services.AudienceInsightsService.*'
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.AudienceService.MutateAudiences
+ deadline: 600.0
+ - selector: 'google.ads.googleads.v13.services.BatchJobService.*'
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.BiddingDataExclusionService.MutateBiddingDataExclusions
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.BiddingStrategyService.MutateBiddingStrategies
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.BillingSetupService.MutateBillingSetup
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignAssetService.MutateCampaignAssets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignAssetSetService.MutateCampaignAssetSets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignBidModifierService.MutateCampaignBidModifiers
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignBudgetService.MutateCampaignBudgets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignConversionGoalService.MutateCampaignConversionGoals
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignCriterionService.MutateCampaignCriteria
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignCustomizerService.MutateCampaignCustomizers
+ deadline: 60.0
+ - selector: 'google.ads.googleads.v13.services.CampaignDraftService.*'
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignFeedService.MutateCampaignFeeds
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignGroupService.MutateCampaignGroups
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignLabelService.MutateCampaignLabels
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignService.MutateCampaigns
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CampaignSharedSetService.MutateCampaignSharedSets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.ConversionActionService.MutateConversionActions
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.ConversionAdjustmentUploadService.UploadConversionAdjustments
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.ConversionCustomVariableService.MutateConversionCustomVariables
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.ConversionUploadService.UploadCallConversions
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.ConversionUploadService.UploadClickConversions
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.ConversionValueRuleService.MutateConversionValueRules
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.ConversionValueRuleSetService.MutateConversionValueRuleSets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomAudienceService.MutateCustomAudiences
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.CustomConversionGoalService.MutateCustomConversionGoals
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomInterestService.MutateCustomInterests
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerAssetService.MutateCustomerAssets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerAssetSetService.MutateCustomerAssetSets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerClientLinkService.MutateCustomerClientLink
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerConversionGoalService.MutateCustomerConversionGoals
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerCustomizerService.MutateCustomerCustomizers
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerFeedService.MutateCustomerFeeds
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerLabelService.MutateCustomerLabels
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerManagerLinkService.MoveManagerLink
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerManagerLinkService.MutateCustomerManagerLink
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria
+ deadline: 60.0
+ - selector: 'google.ads.googleads.v13.services.CustomerService.*'
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.CustomerUserAccessService.MutateCustomerUserAccess
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.CustomizerAttributeService.MutateCustomizerAttributes
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.ExperimentArmService.MutateExperimentArms
+ deadline: 60.0
+ - selector: 'google.ads.googleads.v13.services.ExperimentService.*'
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.ExtensionFeedItemService.MutateExtensionFeedItems
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.FeedItemService.MutateFeedItems
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.FeedItemSetLinkService.MutateFeedItemSetLinks
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.FeedItemSetService.MutateFeedItemSets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.FeedItemTargetService.MutateFeedItemTargets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.FeedMappingService.MutateFeedMappings
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.FeedService.MutateFeeds
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.GeoTargetConstantService.SuggestGeoTargetConstants
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.GoogleAdsFieldService.GetGoogleAdsField
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.GoogleAdsFieldService.SearchGoogleAdsFields
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.GoogleAdsService.Mutate
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.GoogleAdsService.Search
+ deadline: 14400.0
+ - selector: google.ads.googleads.v13.services.GoogleAdsService.SearchStream
+ deadline: 14400.0
+ - selector: google.ads.googleads.v13.services.InvoiceService.ListInvoices
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns
+ deadline: 60.0
+ - selector: 'google.ads.googleads.v13.services.KeywordPlanIdeaService.*'
+ deadline: 600.0
+ - selector: 'google.ads.googleads.v13.services.KeywordPlanService.*'
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.KeywordPlanService.MutateKeywordPlans
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.KeywordThemeConstantService.SuggestKeywordThemeConstants
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.LabelService.MutateLabels
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.MediaFileService.MutateMediaFiles
+ deadline: 60.0
+ - selector: 'google.ads.googleads.v13.services.MerchantCenterLinkService.*'
+ deadline: 60.0
+ - selector: 'google.ads.googleads.v13.services.OfflineUserDataJobService.*'
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.PaymentsAccountService.ListPaymentsAccounts
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.ProductLinkService.CreateProductLink
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.ProductLinkService.RemoveProductLink
+ deadline: 600.0
+ - selector: 'google.ads.googleads.v13.services.ReachPlanService.*'
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.RecommendationService.ApplyRecommendation
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.RecommendationService.DismissRecommendation
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.RemarketingActionService.MutateRemarketingActions
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.SharedCriterionService.MutateSharedCriteria
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.SharedSetService.MutateSharedSets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.SmartCampaignSettingService.GetSmartCampaignStatus
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.SmartCampaignSettingService.MutateSmartCampaignSettings
+ deadline: 60.0
+ - selector: 'google.ads.googleads.v13.services.SmartCampaignSuggestService.*'
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.TravelAssetSuggestionService.SuggestTravelAssets
+ deadline: 60.0
+ - selector: google.ads.googleads.v13.services.UserDataService.UploadUserData
+ deadline: 600.0
+ - selector: google.ads.googleads.v13.services.UserListService.MutateUserLists
+ deadline: 60.0
+ - selector: 'google.longrunning.Operations.*'
+ deadline: 60.0
+
+http:
+ rules:
+ - selector: google.longrunning.Operations.CancelOperation
+ post: '/v13/{name=customers/*/operations/*}:cancel'
+ body: '*'
+ - selector: google.longrunning.Operations.DeleteOperation
+ delete: '/v13/{name=customers/*/operations/*}'
+ - selector: google.longrunning.Operations.GetOperation
+ get: '/v13/{name=customers/*/operations/*}'
+ - selector: google.longrunning.Operations.ListOperations
+ get: '/v13/{name=customers/*/operations}'
+ - selector: google.longrunning.Operations.WaitOperation
+ post: '/v13/{name=customers/*/operations/*}:wait'
+ body: '*'
+
+authentication:
+ rules:
+ - selector: google.ads.googleads.v13.services.AccountBudgetProposalService.MutateAccountBudgetProposal
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AccountLinkService.CreateAccountLink
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AccountLinkService.MutateAccountLink
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupAdLabelService.MutateAdGroupAdLabels
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupAdService.MutateAdGroupAds
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupAssetService.MutateAdGroupAssets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupAssetSetService.MutateAdGroupAssetSets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupBidModifierService.MutateAdGroupBidModifiers
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupCriterionService.MutateAdGroupCriteria
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupCustomizerService.MutateAdGroupCustomizers
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupFeedService.MutateAdGroupFeeds
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupLabelService.MutateAdGroupLabels
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdGroupService.MutateAdGroups
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdParameterService.MutateAdParameters
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdService.GetAd
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AdService.MutateAds
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AssetGroupAssetService.MutateAssetGroupAssets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AssetGroupService.MutateAssetGroups
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AssetGroupSignalService.MutateAssetGroupSignals
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AssetService.MutateAssets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AssetSetAssetService.MutateAssetSetAssets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AssetSetService.MutateAssetSets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.AudienceInsightsService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.AudienceService.MutateAudiences
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.BatchJobService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.BiddingDataExclusionService.MutateBiddingDataExclusions
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.BiddingStrategyService.MutateBiddingStrategies
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.BillingSetupService.MutateBillingSetup
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignAssetService.MutateCampaignAssets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignAssetSetService.MutateCampaignAssetSets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignBidModifierService.MutateCampaignBidModifiers
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignBudgetService.MutateCampaignBudgets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignConversionGoalService.MutateCampaignConversionGoals
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignCriterionService.MutateCampaignCriteria
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignCustomizerService.MutateCampaignCustomizers
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.CampaignDraftService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignFeedService.MutateCampaignFeeds
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignGroupService.MutateCampaignGroups
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignLabelService.MutateCampaignLabels
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignService.MutateCampaigns
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CampaignSharedSetService.MutateCampaignSharedSets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ConversionActionService.MutateConversionActions
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ConversionAdjustmentUploadService.UploadConversionAdjustments
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ConversionCustomVariableService.MutateConversionCustomVariables
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfigs
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ConversionUploadService.UploadCallConversions
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ConversionUploadService.UploadClickConversions
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ConversionValueRuleService.MutateConversionValueRules
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ConversionValueRuleSetService.MutateConversionValueRuleSets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomAudienceService.MutateCustomAudiences
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomConversionGoalService.MutateCustomConversionGoals
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomInterestService.MutateCustomInterests
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerAssetService.MutateCustomerAssets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerAssetSetService.MutateCustomerAssetSets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerClientLinkService.MutateCustomerClientLink
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerConversionGoalService.MutateCustomerConversionGoals
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerCustomizerService.MutateCustomerCustomizers
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerFeedService.MutateCustomerFeeds
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerLabelService.MutateCustomerLabels
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerManagerLinkService.MoveManagerLink
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerManagerLinkService.MutateCustomerManagerLink
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.CustomerService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomerUserAccessService.MutateCustomerUserAccess
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.CustomizerAttributeService.MutateCustomizerAttributes
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ExperimentArmService.MutateExperimentArms
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.ExperimentService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ExtensionFeedItemService.MutateExtensionFeedItems
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.FeedItemService.MutateFeedItems
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.FeedItemSetLinkService.MutateFeedItemSetLinks
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.FeedItemSetService.MutateFeedItemSets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.FeedItemTargetService.MutateFeedItemTargets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.FeedMappingService.MutateFeedMappings
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.FeedService.MutateFeeds
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.GeoTargetConstantService.SuggestGeoTargetConstants
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.GoogleAdsFieldService.GetGoogleAdsField
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.GoogleAdsFieldService.SearchGoogleAdsFields
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.GoogleAdsService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.InvoiceService.ListInvoices
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.KeywordPlanIdeaService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.KeywordPlanService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.KeywordThemeConstantService.SuggestKeywordThemeConstants
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.LabelService.MutateLabels
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.MediaFileService.MutateMediaFiles
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.MerchantCenterLinkService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.OfflineUserDataJobService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.PaymentsAccountService.ListPaymentsAccounts
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ProductLinkService.CreateProductLink
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ProductLinkService.RemoveProductLink
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.ReachPlanService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.RecommendationService.ApplyRecommendation
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.RecommendationService.DismissRecommendation
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.RemarketingActionService.MutateRemarketingActions
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.SharedCriterionService.MutateSharedCriteria
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.SharedSetService.MutateSharedSets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.SmartCampaignSettingService.GetSmartCampaignStatus
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.SmartCampaignSettingService.MutateSmartCampaignSettings
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.ads.googleads.v13.services.SmartCampaignSuggestService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.TravelAssetSuggestionService.SuggestTravelAssets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.UserDataService.UploadUserData
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: google.ads.googleads.v13.services.UserListService.MutateUserLists
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
+ - selector: 'google.longrunning.Operations.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/adwords
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/BUILD.bazel b/third_party/googleapis/google/ads/googleads/v13/resources/BUILD.bazel
similarity index 94%
rename from third_party/googleapis/google/ads/googleads/v10/resources/BUILD.bazel
rename to third_party/googleapis/google/ads/googleads/v13/resources/BUILD.bazel
index 26ca619d3..e38f21b01 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/BUILD.bazel
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/BUILD.bazel
@@ -26,9 +26,9 @@ proto_library(
name = "resources_proto",
srcs = glob(["*.proto"]),
deps = [
- "//google/ads/googleads/v10/common:common_proto",
- "//google/ads/googleads/v10/enums:enums_proto",
- "//google/ads/googleads/v10/errors:errors_proto",
+ "//google/ads/googleads/v13/common:common_proto",
+ "//google/ads/googleads/v13/enums:enums_proto",
+ "//google/ads/googleads/v13/errors:errors_proto",
"//google/api:annotations_proto",
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/accessible_bidding_strategy.proto b/third_party/googleapis/google/ads/googleads/v13/resources/accessible_bidding_strategy.proto
similarity index 66%
rename from third_party/googleapis/google/ads/googleads/v10/resources/accessible_bidding_strategy.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/accessible_bidding_strategy.proto
index 1f53b84a5..75d23d0fb 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/accessible_bidding_strategy.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/accessible_bidding_strategy.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/bidding_strategy_type.proto";
-import "google/ads/googleads/v10/enums/target_impression_share_location.proto";
+import "google/ads/googleads/v13/enums/bidding_strategy_type.proto";
+import "google/ads/googleads/v13/enums/target_impression_share_location.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AccessibleBiddingStrategyProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Represents a view of BiddingStrategies owned by and shared with the customer.
//
@@ -45,20 +45,20 @@ message AccessibleBiddingStrategy {
// An automated bidding strategy to help get the most conversion value for
// your campaigns while spending your budget.
message MaximizeConversionValue {
- // Output only. The target return on ad spend (ROAS) option. If set, the bid strategy
- // will maximize revenue while averaging the target return on ad spend. If
- // the target ROAS is high, the bid strategy may not be able to spend the
- // full budget. If the target ROAS is not set, the bid strategy will aim to
- // achieve the highest possible ROAS for the budget.
+ // Output only. The target return on ad spend (ROAS) option. If set, the bid
+ // strategy will maximize revenue while averaging the target return on ad
+ // spend. If the target ROAS is high, the bid strategy may not be able to
+ // spend the full budget. If the target ROAS is not set, the bid strategy
+ // will aim to achieve the highest possible ROAS for the budget.
double target_roas = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// An automated bidding strategy to help get the most conversions for your
// campaigns while spending your budget.
message MaximizeConversions {
- // Output only. The target cost per acquisition (CPA) option. This is the average amount
- // that you would like to spend per acquisition.
- int64 target_cpa = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The target cost per acquisition (CPA) option. This is the
+ // average amount that you would like to spend per acquisition.
+ int64 target_cpa_micros = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// An automated bid strategy that sets bids to help get as many conversions as
@@ -67,7 +67,8 @@ message AccessibleBiddingStrategy {
// Output only. Average CPA target.
// This target should be greater than or equal to minimum billable unit
// based on the currency for the account.
- optional int64 target_cpa_micros = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 target_cpa_micros = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// An automated bidding strategy that sets bids so that a certain percentage
@@ -75,22 +76,26 @@ message AccessibleBiddingStrategy {
// location).
message TargetImpressionShare {
// Output only. The targeted location on the search results page.
- google.ads.googleads.v10.enums.TargetImpressionShareLocationEnum.TargetImpressionShareLocation location = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.TargetImpressionShareLocationEnum
+ .TargetImpressionShareLocation location = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // The desired fraction of ads to be shown in the targeted location in
- // micros. E.g. 1% equals 10,000.
+ // The chosen fraction of ads to be shown in the targeted location in
+ // micros. For example, 1% equals 10,000.
optional int64 location_fraction_micros = 2;
- // Output only. The highest CPC bid the automated bidding system is permitted to specify.
- // This is a required field entered by the advertiser that sets the ceiling
- // and specified in local micros.
- optional int64 cpc_bid_ceiling_micros = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The highest CPC bid the automated bidding system is
+ // permitted to specify. This is a required field entered by the advertiser
+ // that sets the ceiling and specified in local micros.
+ optional int64 cpc_bid_ceiling_micros = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// An automated bidding strategy that helps you maximize revenue while
// averaging a specific target return on ad spend (ROAS).
message TargetRoas {
- // Output only. The desired revenue (based on conversion data) per unit of spend.
+ // Output only. The chosen revenue (based on conversion data) per unit of
+ // spend.
optional double target_roas = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -104,14 +109,13 @@ message AccessibleBiddingStrategy {
// This field is deprecated and should no longer be used. See
// https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html
// for details.
- optional int64 target_spend_micros = 1 [
- deprecated = true,
- (google.api.field_behavior) = OUTPUT_ONLY
- ];
+ optional int64 target_spend_micros = 1
+ [deprecated = true, (google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Maximum bid limit that can be set by the bid strategy.
// The limit applies to all keywords managed by the strategy.
- optional int64 cpc_bid_ceiling_micros = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 cpc_bid_ceiling_micros = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. The resource name of the accessible bidding strategy.
@@ -132,40 +136,45 @@ message AccessibleBiddingStrategy {
string name = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The type of the bidding strategy.
- google.ads.googleads.v10.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BiddingStrategyTypeEnum.BiddingStrategyType
+ type = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The ID of the Customer which owns the bidding strategy.
int64 owner_customer_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. descriptive_name of the Customer which owns the bidding strategy.
+ // Output only. descriptive_name of the Customer which owns the bidding
+ // strategy.
string owner_descriptive_name = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// The bidding scheme.
//
// Only one can be set.
oneof scheme {
- // Output only. An automated bidding strategy to help get the most conversion value for
- // your campaigns while spending your budget.
- MaximizeConversionValue maximize_conversion_value = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. An automated bidding strategy to help get the most conversions for your
- // campaigns while spending your budget.
- MaximizeConversions maximize_conversions = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. A bidding strategy that sets bids to help get as many conversions as
- // possible at the target cost-per-acquisition (CPA) you set.
+ // Output only. An automated bidding strategy to help get the most
+ // conversion value for your campaigns while spending your budget.
+ MaximizeConversionValue maximize_conversion_value = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. An automated bidding strategy to help get the most
+ // conversions for your campaigns while spending your budget.
+ MaximizeConversions maximize_conversions = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. A bidding strategy that sets bids to help get as many
+ // conversions as possible at the target cost-per-acquisition (CPA) you set.
TargetCpa target_cpa = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A bidding strategy that automatically optimizes towards a desired
- // percentage of impressions.
- TargetImpressionShare target_impression_share = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. A bidding strategy that automatically optimizes towards a
+ // chosen percentage of impressions.
+ TargetImpressionShare target_impression_share = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A bidding strategy that helps you maximize revenue while averaging a
- // specific target Return On Ad Spend (ROAS).
+ // Output only. A bidding strategy that helps you maximize revenue while
+ // averaging a specific target Return On Ad Spend (ROAS).
TargetRoas target_roas = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A bid strategy that sets your bids to help get as many clicks as
- // possible within your budget.
+ // Output only. A bid strategy that sets your bids to help get as many
+ // clicks as possible within your budget.
TargetSpend target_spend = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/account_budget.proto b/third_party/googleapis/google/ads/googleads/v13/resources/account_budget.proto
similarity index 61%
rename from third_party/googleapis/google/ads/googleads/v10/resources/account_budget.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/account_budget.proto
index 458df6d6f..bfa411b73 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/account_budget.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/account_budget.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/account_budget_proposal_type.proto";
-import "google/ads/googleads/v10/enums/account_budget_status.proto";
-import "google/ads/googleads/v10/enums/spending_limit_type.proto";
-import "google/ads/googleads/v10/enums/time_type.proto";
+import "google/ads/googleads/v13/enums/account_budget_proposal_type.proto";
+import "google/ads/googleads/v13/enums/account_budget_status.proto";
+import "google/ads/googleads/v13/enums/spending_limit_type.proto";
+import "google/ads/googleads/v13/enums/time_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AccountBudgetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the AccountBudget resource.
@@ -40,8 +40,8 @@ option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
// approval, if any, are found in 'pending_proposal'. Effective details about
// the budget are found in fields prefixed 'approved_', 'adjusted_' and those
// without a prefix. Since some effective details may differ from what the user
-// had originally requested (e.g. spending limit), these differences are
-// juxtaposed via 'proposed_', 'approved_', and possibly 'adjusted_' fields.
+// had originally requested (for example, spending limit), these differences are
+// juxtaposed through 'proposed_', 'approved_', and possibly 'adjusted_' fields.
//
// This resource is mutated using AccountBudgetProposal and cannot be mutated
// directly. A budget may have at most one pending proposal at any given time.
@@ -70,44 +70,53 @@ message AccountBudget {
}
];
- // Output only. The type of this proposal, e.g. END to end the budget associated
- // with this proposal.
- google.ads.googleads.v10.enums.AccountBudgetProposalTypeEnum.AccountBudgetProposalType proposal_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The type of this proposal, for example, END to end the
+ // budget associated with this proposal.
+ google.ads.googleads.v13.enums.AccountBudgetProposalTypeEnum
+ .AccountBudgetProposalType proposal_type = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The name to assign to the account-level budget.
optional string name = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The start time in yyyy-MM-dd HH:mm:ss format.
- optional string start_date_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string start_date_time = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A purchase order number is a value that helps users reference this budget
- // in their monthly invoices.
- optional string purchase_order_number = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. A purchase order number is a value that helps users
+ // reference this budget in their monthly invoices.
+ optional string purchase_order_number = 17
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Notes associated with this budget.
optional string notes = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The time when this account-level budget proposal was created.
- // Formatted as yyyy-MM-dd HH:mm:ss.
- optional string creation_date_time = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The time when this account-level budget proposal was
+ // created. Formatted as yyyy-MM-dd HH:mm:ss.
+ optional string creation_date_time = 19
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The end time of the account-level budget.
oneof end_time {
// Output only. The end time in yyyy-MM-dd HH:mm:ss format.
string end_date_time = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The end time as a well-defined type, e.g. FOREVER.
- google.ads.googleads.v10.enums.TimeTypeEnum.TimeType end_time_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The end time as a well-defined type, for example, FOREVER.
+ google.ads.googleads.v13.enums.TimeTypeEnum.TimeType end_time_type = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The spending limit.
oneof spending_limit {
- // Output only. The spending limit in micros. One million is equivalent to
- // one unit.
- int64 spending_limit_micros = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The spending limit as a well-defined type, e.g. INFINITE.
- google.ads.googleads.v10.enums.SpendingLimitTypeEnum.SpendingLimitType spending_limit_type = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The spending limit in micros. One million is equivalent
+ // to one unit.
+ int64 spending_limit_micros = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The spending limit as a well-defined type, for example,
+ // INFINITE.
+ google.ads.googleads.v13.enums.SpendingLimitTypeEnum.SpendingLimitType
+ spending_limit_type = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
@@ -125,8 +134,8 @@ message AccountBudget {
// Output only. The ID of the account-level budget.
optional int64 id = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The resource name of the billing setup associated with this account-level
- // budget. BillingSetup resource names have the form:
+ // Output only. The resource name of the billing setup associated with this
+ // account-level budget. BillingSetup resource names have the form:
//
// `customers/{customer_id}/billingSetups/{billing_setup_id}`
optional string billing_setup = 24 [
@@ -137,7 +146,8 @@ message AccountBudget {
];
// Output only. The status of this account-level budget.
- google.ads.googleads.v10.enums.AccountBudgetStatusEnum.AccountBudgetStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AccountBudgetStatusEnum.AccountBudgetStatus
+ status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The name of the account-level budget.
optional string name = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -145,19 +155,22 @@ message AccountBudget {
// Output only. The proposed start time of the account-level budget in
// yyyy-MM-dd HH:mm:ss format. If a start time type of NOW was proposed,
// this is the time of request.
- optional string proposed_start_date_time = 26 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string proposed_start_date_time = 26
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The approved start time of the account-level budget in yyyy-MM-dd HH:mm:ss
- // format.
+ // Output only. The approved start time of the account-level budget in
+ // yyyy-MM-dd HH:mm:ss format.
//
// For example, if a new budget is approved after the proposed start time,
// the approved start time is the time of approval.
- optional string approved_start_date_time = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string approved_start_date_time = 27
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The total adjustments amount.
//
// An example of an adjustment is courtesy credits.
- int64 total_adjustments_micros = 33 [(google.api.field_behavior) = OUTPUT_ONLY];
+ int64 total_adjustments_micros = 33
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The value of Ads that have been served, in micros.
//
@@ -165,23 +178,28 @@ message AccountBudget {
// automatically applied to the budget (see total_adjustments_micros).
int64 amount_served_micros = 34 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A purchase order number is a value that helps users reference this budget
- // in their monthly invoices.
- optional string purchase_order_number = 35 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. A purchase order number is a value that helps users reference
+ // this budget in their monthly invoices.
+ optional string purchase_order_number = 35
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Notes associated with the budget.
optional string notes = 36 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The pending proposal to modify this budget, if applicable.
- PendingAccountBudgetProposal pending_proposal = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
+ PendingAccountBudgetProposal pending_proposal = 22
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The proposed end time of the account-level budget.
oneof proposed_end_time {
// Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format.
- string proposed_end_date_time = 28 [(google.api.field_behavior) = OUTPUT_ONLY];
+ string proposed_end_date_time = 28
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The proposed end time as a well-defined type, e.g. FOREVER.
- google.ads.googleads.v10.enums.TimeTypeEnum.TimeType proposed_end_time_type = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The proposed end time as a well-defined type, for example,
+ // FOREVER.
+ google.ads.googleads.v13.enums.TimeTypeEnum.TimeType
+ proposed_end_time_type = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The approved end time of the account-level budget.
@@ -190,20 +208,27 @@ message AccountBudget {
// after the proposed end time, the approved end time is the time of approval.
oneof approved_end_time {
// Output only. The approved end time in yyyy-MM-dd HH:mm:ss format.
- string approved_end_date_time = 29 [(google.api.field_behavior) = OUTPUT_ONLY];
+ string approved_end_date_time = 29
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The approved end time as a well-defined type, e.g. FOREVER.
- google.ads.googleads.v10.enums.TimeTypeEnum.TimeType approved_end_time_type = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The approved end time as a well-defined type, for example,
+ // FOREVER.
+ google.ads.googleads.v13.enums.TimeTypeEnum.TimeType
+ approved_end_time_type = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The proposed spending limit.
oneof proposed_spending_limit {
- // Output only. The proposed spending limit in micros. One million is equivalent to
- // one unit.
- int64 proposed_spending_limit_micros = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The proposed spending limit as a well-defined type, e.g. INFINITE.
- google.ads.googleads.v10.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The proposed spending limit in micros. One million is
+ // equivalent to one unit.
+ int64 proposed_spending_limit_micros = 30
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The proposed spending limit as a well-defined type, for
+ // example, INFINITE.
+ google.ads.googleads.v13.enums.SpendingLimitTypeEnum.SpendingLimitType
+ proposed_spending_limit_type = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The approved spending limit.
@@ -212,15 +237,19 @@ message AccountBudget {
// proposed spending limit at the time the proposal is approved, the approved
// spending limit is set to the amount already spent.
oneof approved_spending_limit {
- // Output only. The approved spending limit in micros. One million is equivalent to
- // one unit. This will only be populated if the proposed spending limit
- // is finite, and will always be greater than or equal to the
+ // Output only. The approved spending limit in micros. One million is
+ // equivalent to one unit. This will only be populated if the proposed
+ // spending limit is finite, and will always be greater than or equal to the
// proposed spending limit.
- int64 approved_spending_limit_micros = 31 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The approved spending limit as a well-defined type, e.g. INFINITE. This
- // will only be populated if the approved spending limit is INFINITE.
- google.ads.googleads.v10.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ int64 approved_spending_limit_micros = 31
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The approved spending limit as a well-defined type, for
+ // example, INFINITE. This will only be populated if the approved spending
+ // limit is INFINITE.
+ google.ads.googleads.v13.enums.SpendingLimitTypeEnum.SpendingLimitType
+ approved_spending_limit_type = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The spending limit after adjustments have been applied. Adjustments are
@@ -228,8 +257,8 @@ message AccountBudget {
//
// This value has the final say on how much the account is allowed to spend.
oneof adjusted_spending_limit {
- // Output only. The adjusted spending limit in micros. One million is equivalent to
- // one unit.
+ // Output only. The adjusted spending limit in micros. One million is
+ // equivalent to one unit.
//
// If the approved spending limit is finite, the adjusted
// spending limit may vary depending on the types of adjustments applied
@@ -240,12 +269,15 @@ message AccountBudget {
//
// For example, a debit adjustment reduces how much the account is
// allowed to spend.
- int64 adjusted_spending_limit_micros = 32 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The adjusted spending limit as a well-defined type, e.g. INFINITE.
- // This will only be populated if the adjusted spending limit is INFINITE,
- // which is guaranteed to be true if the approved spending limit is
- // INFINITE.
- google.ads.googleads.v10.enums.SpendingLimitTypeEnum.SpendingLimitType adjusted_spending_limit_type = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+ int64 adjusted_spending_limit_micros = 32
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The adjusted spending limit as a well-defined type, for
+ // example, INFINITE. This will only be populated if the adjusted spending
+ // limit is INFINITE, which is guaranteed to be true if the approved
+ // spending limit is INFINITE.
+ google.ads.googleads.v13.enums.SpendingLimitTypeEnum.SpendingLimitType
+ adjusted_spending_limit_type = 17
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/account_budget_proposal.proto b/third_party/googleapis/google/ads/googleads/v13/resources/account_budget_proposal.proto
similarity index 57%
rename from third_party/googleapis/google/ads/googleads/v10/resources/account_budget_proposal.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/account_budget_proposal.proto
index ff6ad62ee..9142d6378 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/account_budget_proposal.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/account_budget_proposal.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/account_budget_proposal_status.proto";
-import "google/ads/googleads/v10/enums/account_budget_proposal_type.proto";
-import "google/ads/googleads/v10/enums/spending_limit_type.proto";
-import "google/ads/googleads/v10/enums/time_type.proto";
+import "google/ads/googleads/v13/enums/account_budget_proposal_status.proto";
+import "google/ads/googleads/v13/enums/account_budget_proposal_type.proto";
+import "google/ads/googleads/v13/enums/spending_limit_type.proto";
+import "google/ads/googleads/v13/enums/time_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AccountBudgetProposalProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the AccountBudgetProposal resource.
@@ -39,9 +39,9 @@ option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
// All fields prefixed with 'proposed' may not necessarily be applied directly.
// For example, proposed spending limits may be adjusted before their
// application. This is true if the 'proposed' field has an 'approved'
-// counterpart, e.g. spending limits.
+// counterpart, for example, spending limits.
//
-// Please note that the proposal type (proposal_type) changes which fields are
+// Note that the proposal type (proposal_type) changes which fields are
// required and which must remain empty.
message AccountBudgetProposal {
option (google.api.resource) = {
@@ -63,7 +63,8 @@ message AccountBudgetProposal {
// Output only. The ID of the proposal.
optional int64 id = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. The resource name of the billing setup associated with this proposal.
+ // Immutable. The resource name of the billing setup associated with this
+ // proposal.
optional string billing_setup = 26 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
@@ -71,8 +72,8 @@ message AccountBudgetProposal {
}
];
- // Immutable. The resource name of the account-level budget associated with this
- // proposal.
+ // Immutable. The resource name of the account-level budget associated with
+ // this proposal.
optional string account_budget = 27 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
@@ -80,80 +81,106 @@ message AccountBudgetProposal {
}
];
- // Immutable. The type of this proposal, e.g. END to end the budget associated with this
- // proposal.
- google.ads.googleads.v10.enums.AccountBudgetProposalTypeEnum.AccountBudgetProposalType proposal_type = 4 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. The type of this proposal, for example, END to end the budget
+ // associated with this proposal.
+ google.ads.googleads.v13.enums.AccountBudgetProposalTypeEnum
+ .AccountBudgetProposalType proposal_type = 4
+ [(google.api.field_behavior) = IMMUTABLE];
// Output only. The status of this proposal.
// When a new proposal is created, the status defaults to PENDING.
- google.ads.googleads.v10.enums.AccountBudgetProposalStatusEnum.AccountBudgetProposalStatus status = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AccountBudgetProposalStatusEnum
+ .AccountBudgetProposalStatus status = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. The name to assign to the account-level budget.
optional string proposed_name = 28 [(google.api.field_behavior) = IMMUTABLE];
// Output only. The approved start date time in yyyy-mm-dd hh:mm:ss format.
- optional string approved_start_date_time = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string approved_start_date_time = 30
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. A purchase order number is a value that enables the user to help them
- // reference this budget in their monthly invoices.
- optional string proposed_purchase_order_number = 35 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. A purchase order number is a value that enables the user to help
+ // them reference this budget in their monthly invoices.
+ optional string proposed_purchase_order_number = 35
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Notes associated with this budget.
optional string proposed_notes = 36 [(google.api.field_behavior) = IMMUTABLE];
- // Output only. The date time when this account-level budget proposal was created, which is
- // not the same as its approval date time, if applicable.
- optional string creation_date_time = 37 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The date time when this account-level budget proposal was
+ // created, which is not the same as its approval date time, if applicable.
+ optional string creation_date_time = 37
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The date time when this account-level budget was approved, if applicable.
- optional string approval_date_time = 38 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The date time when this account-level budget was approved, if
+ // applicable.
+ optional string approval_date_time = 38
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The proposed start date time of the account-level budget, which cannot be
// in the past.
oneof proposed_start_time {
// Immutable. The proposed start date time in yyyy-mm-dd hh:mm:ss format.
- string proposed_start_date_time = 29 [(google.api.field_behavior) = IMMUTABLE];
+ string proposed_start_date_time = 29
+ [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The proposed start date time as a well-defined type, e.g. NOW.
- google.ads.googleads.v10.enums.TimeTypeEnum.TimeType proposed_start_time_type = 7 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. The proposed start date time as a well-defined type, for
+ // example, NOW.
+ google.ads.googleads.v13.enums.TimeTypeEnum.TimeType
+ proposed_start_time_type = 7 [(google.api.field_behavior) = IMMUTABLE];
}
// The proposed end date time of the account-level budget, which cannot be in
// the past.
oneof proposed_end_time {
// Immutable. The proposed end date time in yyyy-mm-dd hh:mm:ss format.
- string proposed_end_date_time = 31 [(google.api.field_behavior) = IMMUTABLE];
+ string proposed_end_date_time = 31
+ [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The proposed end date time as a well-defined type, e.g. FOREVER.
- google.ads.googleads.v10.enums.TimeTypeEnum.TimeType proposed_end_time_type = 9 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. The proposed end date time as a well-defined type, for
+ // example, FOREVER.
+ google.ads.googleads.v13.enums.TimeTypeEnum.TimeType
+ proposed_end_time_type = 9 [(google.api.field_behavior) = IMMUTABLE];
}
// The approved end date time of the account-level budget.
oneof approved_end_time {
// Output only. The approved end date time in yyyy-mm-dd hh:mm:ss format.
- string approved_end_date_time = 32 [(google.api.field_behavior) = OUTPUT_ONLY];
+ string approved_end_date_time = 32
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The approved end date time as a well-defined type, e.g. FOREVER.
- google.ads.googleads.v10.enums.TimeTypeEnum.TimeType approved_end_time_type = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The approved end date time as a well-defined type, for
+ // example, FOREVER.
+ google.ads.googleads.v13.enums.TimeTypeEnum.TimeType
+ approved_end_time_type = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The proposed spending limit.
oneof proposed_spending_limit {
- // Immutable. The proposed spending limit in micros. One million is equivalent to
- // one unit.
- int64 proposed_spending_limit_micros = 33 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. The proposed spending limit as a well-defined type, e.g. INFINITE.
- google.ads.googleads.v10.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 11 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. The proposed spending limit in micros. One million is
+ // equivalent to one unit.
+ int64 proposed_spending_limit_micros = 33
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. The proposed spending limit as a well-defined type, for
+ // example, INFINITE.
+ google.ads.googleads.v13.enums.SpendingLimitTypeEnum.SpendingLimitType
+ proposed_spending_limit_type = 11
+ [(google.api.field_behavior) = IMMUTABLE];
}
// The approved spending limit.
oneof approved_spending_limit {
- // Output only. The approved spending limit in micros. One million is equivalent to
- // one unit.
- int64 approved_spending_limit_micros = 34 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The approved spending limit as a well-defined type, e.g. INFINITE.
- google.ads.googleads.v10.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The approved spending limit in micros. One million is
+ // equivalent to one unit.
+ int64 approved_spending_limit_micros = 34
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The approved spending limit as a well-defined type, for
+ // example, INFINITE.
+ google.ads.googleads.v13.enums.SpendingLimitTypeEnum.SpendingLimitType
+ approved_spending_limit_type = 24
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/account_link.proto b/third_party/googleapis/google/ads/googleads/v13/resources/account_link.proto
similarity index 62%
rename from third_party/googleapis/google/ads/googleads/v10/resources/account_link.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/account_link.proto
index 0d1370954..6f8ed0824 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/account_link.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/account_link.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/account_link_status.proto";
-import "google/ads/googleads/v10/enums/linked_account_type.proto";
-import "google/ads/googleads/v10/enums/mobile_app_vendor.proto";
+import "google/ads/googleads/v13/enums/account_link_status.proto";
+import "google/ads/googleads/v13/enums/linked_account_type.proto";
+import "google/ads/googleads/v13/enums/mobile_app_vendor.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AccountLinkProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Represents the data sharing connection between a Google Ads account and
// another account
@@ -51,27 +51,38 @@ message AccountLink {
// Output only. The ID of the link.
// This field is read only.
- optional int64 account_link_id = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 account_link_id = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The status of the link.
- google.ads.googleads.v10.enums.AccountLinkStatusEnum.AccountLinkStatus status = 3;
+ google.ads.googleads.v13.enums.AccountLinkStatusEnum.AccountLinkStatus
+ status = 3;
// Output only. The type of the linked account.
- google.ads.googleads.v10.enums.LinkedAccountTypeEnum.LinkedAccountType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.LinkedAccountTypeEnum.LinkedAccountType type =
+ 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// An account linked to this Google Ads account.
oneof linked_account {
// Immutable. A third party app analytics link.
- ThirdPartyAppAnalyticsLinkIdentifier third_party_app_analytics = 5 [(google.api.field_behavior) = IMMUTABLE];
+ ThirdPartyAppAnalyticsLinkIdentifier third_party_app_analytics = 5
+ [(google.api.field_behavior) = IMMUTABLE];
// Output only. Data partner link.
- DataPartnerLinkIdentifier data_partner = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ DataPartnerLinkIdentifier data_partner = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Google Ads link.
- GoogleAdsLinkIdentifier google_ads = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ GoogleAdsLinkIdentifier google_ads = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Hotel link
- HotelCenterLinkIdentifier hotel_center = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ HotelCenterLinkIdentifier hotel_center = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Advertising Partner link
+ AdvertisingPartnerLinkIdentifier advertising_partner = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
@@ -81,14 +92,15 @@ message ThirdPartyAppAnalyticsLinkIdentifier {
// This field should not be empty when creating a new third
// party app analytics link. It is unable to be modified after the creation of
// the link.
- optional int64 app_analytics_provider_id = 4 [(google.api.field_behavior) = IMMUTABLE];
+ optional int64 app_analytics_provider_id = 4
+ [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. A string that uniquely identifies a mobile application from which the data
- // was collected to the Google Ads API. For iOS, the ID string is the 9 digit
- // string that appears at the end of an App Store URL (e.g., "422689480" for
- // "Gmail" whose App Store link is
+ // Immutable. A string that uniquely identifies a mobile application from
+ // which the data was collected to the Google Ads API. For iOS, the ID string
+ // is the 9 digit string that appears at the end of an App Store URL (for
+ // example, "422689480" for "Gmail" whose App Store link is
// https://apps.apple.com/us/app/gmail-email-by-google/id422689480). For
- // Android, the ID string is the application's package name (e.g.,
+ // Android, the ID string is the application's package name (for example,
// "com.google.android.gm" for "Gmail" given Google Play link
// https://play.google.com/store/apps/details?id=com.google.android.gm)
// This field should not be empty when creating a new third
@@ -100,7 +112,8 @@ message ThirdPartyAppAnalyticsLinkIdentifier {
// This field should not be empty when creating a new third
// party app analytics link. It is unable to be modified after the creation of
// the link.
- google.ads.googleads.v10.enums.MobileAppVendorEnum.MobileAppVendor app_vendor = 3 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.MobileAppVendorEnum.MobileAppVendor
+ app_vendor = 3 [(google.api.field_behavior) = IMMUTABLE];
}
// The identifier for Data Partner account.
@@ -131,3 +144,17 @@ message GoogleAdsLinkIdentifier {
}
];
}
+
+// The identifier for the Advertising Partner Google Ads account.
+message AdvertisingPartnerLinkIdentifier {
+ // Immutable. The resource name of the advertising partner Google Ads account.
+ // This field is required and should not be empty when creating a new
+ // Advertising Partner link. It is unable to be modified after the creation of
+ // the link.
+ optional string customer = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/Customer"
+ }
+ ];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad.proto
similarity index 52%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad.proto
index 7f2a6e610..374e3550f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad.proto
@@ -14,26 +14,26 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/ad_type_infos.proto";
-import "google/ads/googleads/v10/common/custom_parameter.proto";
-import "google/ads/googleads/v10/common/final_app_url.proto";
-import "google/ads/googleads/v10/common/url_collection.proto";
-import "google/ads/googleads/v10/enums/ad_type.proto";
-import "google/ads/googleads/v10/enums/device.proto";
-import "google/ads/googleads/v10/enums/system_managed_entity_source.proto";
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/ad_type_infos.proto";
+import "google/ads/googleads/v13/common/custom_parameter.proto";
+import "google/ads/googleads/v13/common/final_app_url.proto";
+import "google/ads/googleads/v13/common/url_collection.proto";
+import "google/ads/googleads/v13/enums/ad_type.proto";
+import "google/ads/googleads/v13/enums/device.proto";
+import "google/ads/googleads/v13/enums/system_managed_entity_source.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad type.
@@ -50,9 +50,7 @@ message Ad {
// `customers/{customer_id}/ads/{ad_id}`
string resource_name = 37 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Ad"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Ad" }
];
// Output only. The ID of the ad.
@@ -64,7 +62,7 @@ message Ad {
// A list of final app URLs that will be used on mobile if the user has the
// specific app installed.
- repeated google.ads.googleads.v10.common.FinalAppUrl final_app_urls = 35;
+ repeated google.ads.googleads.v13.common.FinalAppUrl final_app_urls = 35;
// The list of possible final mobile URLs after all cross-domain redirects
// for the ad.
@@ -78,119 +76,138 @@ message Ad {
// The list of mappings that can be used to substitute custom parameter tags
// in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
- // For mutates, please use url custom parameter operations.
- repeated google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 10;
+ // For mutates, use url custom parameter operations.
+ repeated google.ads.googleads.v13.common.CustomParameter
+ url_custom_parameters = 10;
// The URL that appears in the ad description for some ad formats.
optional string display_url = 45;
// Output only. The type of ad.
- google.ads.googleads.v10.enums.AdTypeEnum.AdType type = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AdTypeEnum.AdType type = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Indicates if this ad was automatically added by Google Ads and not by a
- // user. For example, this could happen when ads are automatically created as
- // suggestions for new ads based on knowledge of how existing ads are
- // performing.
- optional bool added_by_google_ads = 46 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Indicates if this ad was automatically added by Google Ads and
+ // not by a user. For example, this could happen when ads are automatically
+ // created as suggestions for new ads based on knowledge of how existing ads
+ // are performing.
+ optional bool added_by_google_ads = 46
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The device preference for the ad. You can only specify a preference for
// mobile devices. When this preference is set the ad will be preferred over
// other ads when being displayed on a mobile device. The ad can still be
- // displayed on other device types, e.g. if no other ads are available.
- // If unspecified (no device preference), all devices are targeted.
+ // displayed on other device types, for example, if no other ads are
+ // available. If unspecified (no device preference), all devices are targeted.
// This is only supported by some ad types.
- google.ads.googleads.v10.enums.DeviceEnum.Device device_preference = 20;
+ google.ads.googleads.v13.enums.DeviceEnum.Device device_preference = 20;
// Additional URLs for the ad that are tagged with a unique identifier that
// can be referenced from other fields in the ad.
- repeated google.ads.googleads.v10.common.UrlCollection url_collections = 26;
+ repeated google.ads.googleads.v13.common.UrlCollection url_collections = 26;
- // Immutable. The name of the ad. This is only used to be able to identify the ad. It
- // does not need to be unique and does not affect the served ad. The name
- // field is currently only supported for DisplayUploadAd, ImageAd,
+ // Immutable. The name of the ad. This is only used to be able to identify the
+ // ad. It does not need to be unique and does not affect the served ad. The
+ // name field is currently only supported for DisplayUploadAd, ImageAd,
// ShoppingComparisonListingAd and VideoAd.
optional string name = 47 [(google.api.field_behavior) = IMMUTABLE];
- // Output only. If this ad is system managed, then this field will indicate the source.
- // This field is read-only.
- google.ads.googleads.v10.enums.SystemManagedResourceSourceEnum.SystemManagedResourceSource system_managed_resource_source = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. If this ad is system managed, then this field will indicate
+ // the source. This field is read-only.
+ google.ads.googleads.v13.enums.SystemManagedResourceSourceEnum
+ .SystemManagedResourceSource system_managed_resource_source = 27
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Details pertinent to the ad type. Exactly one value must be set.
oneof ad_data {
// Immutable. Details pertaining to a text ad.
- google.ads.googleads.v10.common.TextAdInfo text_ad = 6 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.TextAdInfo text_ad = 6
+ [(google.api.field_behavior) = IMMUTABLE];
// Details pertaining to an expanded text ad.
- google.ads.googleads.v10.common.ExpandedTextAdInfo expanded_text_ad = 7;
+ google.ads.googleads.v13.common.ExpandedTextAdInfo expanded_text_ad = 7;
// Details pertaining to a call ad.
- google.ads.googleads.v10.common.CallAdInfo call_ad = 49;
+ google.ads.googleads.v13.common.CallAdInfo call_ad = 49;
// Immutable. Details pertaining to an Expanded Dynamic Search Ad.
// This type of ad has its headline, final URLs, and display URL
// auto-generated at serving time according to domain name specific
// information provided by `dynamic_search_ads_setting` linked at the
// campaign level.
- google.ads.googleads.v10.common.ExpandedDynamicSearchAdInfo expanded_dynamic_search_ad = 14 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.ExpandedDynamicSearchAdInfo
+ expanded_dynamic_search_ad = 14
+ [(google.api.field_behavior) = IMMUTABLE];
// Details pertaining to a hotel ad.
- google.ads.googleads.v10.common.HotelAdInfo hotel_ad = 15;
+ google.ads.googleads.v13.common.HotelAdInfo hotel_ad = 15;
// Details pertaining to a Smart Shopping ad.
- google.ads.googleads.v10.common.ShoppingSmartAdInfo shopping_smart_ad = 17;
+ google.ads.googleads.v13.common.ShoppingSmartAdInfo shopping_smart_ad = 17;
// Details pertaining to a Shopping product ad.
- google.ads.googleads.v10.common.ShoppingProductAdInfo shopping_product_ad = 18;
-
- // Immutable. Details pertaining to a Gmail ad.
- google.ads.googleads.v10.common.GmailAdInfo gmail_ad = 21 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.ShoppingProductAdInfo shopping_product_ad =
+ 18;
// Immutable. Details pertaining to an Image ad.
- google.ads.googleads.v10.common.ImageAdInfo image_ad = 22 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.ImageAdInfo image_ad = 22
+ [(google.api.field_behavior) = IMMUTABLE];
// Details pertaining to a Video ad.
- google.ads.googleads.v10.common.VideoAdInfo video_ad = 24;
+ google.ads.googleads.v13.common.VideoAdInfo video_ad = 24;
// Details pertaining to a Video responsive ad.
- google.ads.googleads.v10.common.VideoResponsiveAdInfo video_responsive_ad = 39;
+ google.ads.googleads.v13.common.VideoResponsiveAdInfo video_responsive_ad =
+ 39;
// Details pertaining to a responsive search ad.
- google.ads.googleads.v10.common.ResponsiveSearchAdInfo responsive_search_ad = 25;
+ google.ads.googleads.v13.common.ResponsiveSearchAdInfo
+ responsive_search_ad = 25;
// Details pertaining to a legacy responsive display ad.
- google.ads.googleads.v10.common.LegacyResponsiveDisplayAdInfo legacy_responsive_display_ad = 28;
+ google.ads.googleads.v13.common.LegacyResponsiveDisplayAdInfo
+ legacy_responsive_display_ad = 28;
// Details pertaining to an app ad.
- google.ads.googleads.v10.common.AppAdInfo app_ad = 29;
+ google.ads.googleads.v13.common.AppAdInfo app_ad = 29;
// Immutable. Details pertaining to a legacy app install ad.
- google.ads.googleads.v10.common.LegacyAppInstallAdInfo legacy_app_install_ad = 30 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.LegacyAppInstallAdInfo
+ legacy_app_install_ad = 30 [(google.api.field_behavior) = IMMUTABLE];
// Details pertaining to a responsive display ad.
- google.ads.googleads.v10.common.ResponsiveDisplayAdInfo responsive_display_ad = 31;
+ google.ads.googleads.v13.common.ResponsiveDisplayAdInfo
+ responsive_display_ad = 31;
// Details pertaining to a local ad.
- google.ads.googleads.v10.common.LocalAdInfo local_ad = 32;
+ google.ads.googleads.v13.common.LocalAdInfo local_ad = 32;
// Details pertaining to a display upload ad.
- google.ads.googleads.v10.common.DisplayUploadAdInfo display_upload_ad = 33;
+ google.ads.googleads.v13.common.DisplayUploadAdInfo display_upload_ad = 33;
// Details pertaining to an app engagement ad.
- google.ads.googleads.v10.common.AppEngagementAdInfo app_engagement_ad = 34;
+ google.ads.googleads.v13.common.AppEngagementAdInfo app_engagement_ad = 34;
// Details pertaining to a Shopping Comparison Listing ad.
- google.ads.googleads.v10.common.ShoppingComparisonListingAdInfo shopping_comparison_listing_ad = 36;
+ google.ads.googleads.v13.common.ShoppingComparisonListingAdInfo
+ shopping_comparison_listing_ad = 36;
// Details pertaining to a Smart campaign ad.
- google.ads.googleads.v10.common.SmartCampaignAdInfo smart_campaign_ad = 48;
+ google.ads.googleads.v13.common.SmartCampaignAdInfo smart_campaign_ad = 48;
// Details pertaining to an app pre-registration ad.
- google.ads.googleads.v10.common.AppPreRegistrationAdInfo app_pre_registration_ad = 50;
+ google.ads.googleads.v13.common.AppPreRegistrationAdInfo
+ app_pre_registration_ad = 50;
// Details pertaining to a discovery multi asset ad.
- google.ads.googleads.v10.common.DiscoveryMultiAssetAdInfo discovery_multi_asset_ad = 51;
+ google.ads.googleads.v13.common.DiscoveryMultiAssetAdInfo
+ discovery_multi_asset_ad = 51;
// Details pertaining to a discovery carousel ad.
- google.ads.googleads.v10.common.DiscoveryCarouselAdInfo discovery_carousel_ad = 52;
+ google.ads.googleads.v13.common.DiscoveryCarouselAdInfo
+ discovery_carousel_ad = 52;
+
+ // Details pertaining to a travel ad.
+ google.ads.googleads.v13.common.TravelAdInfo travel_ad = 54;
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group.proto
similarity index 60%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group.proto
index 19f483735..997258bc8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group.proto
@@ -14,28 +14,28 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/custom_parameter.proto";
-import "google/ads/googleads/v10/common/explorer_auto_optimizer_setting.proto";
-import "google/ads/googleads/v10/common/targeting_setting.proto";
-import "google/ads/googleads/v10/enums/ad_group_ad_rotation_mode.proto";
-import "google/ads/googleads/v10/enums/ad_group_status.proto";
-import "google/ads/googleads/v10/enums/ad_group_type.proto";
-import "google/ads/googleads/v10/enums/asset_field_type.proto";
-import "google/ads/googleads/v10/enums/bidding_source.proto";
-import "google/ads/googleads/v10/enums/targeting_dimension.proto";
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/custom_parameter.proto";
+import "google/ads/googleads/v13/common/targeting_setting.proto";
+import "google/ads/googleads/v13/enums/ad_group_ad_rotation_mode.proto";
+import "google/ads/googleads/v13/enums/ad_group_status.proto";
+import "google/ads/googleads/v13/enums/ad_group_type.proto";
+import "google/ads/googleads/v13/enums/asset_field_type.proto";
+import "google/ads/googleads/v13/enums/asset_set_type.proto";
+import "google/ads/googleads/v13/enums/bidding_source.proto";
+import "google/ads/googleads/v13/enums/targeting_dimension.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad group resource.
@@ -48,8 +48,9 @@ message AdGroup {
// Settings for the audience targeting.
message AudienceSetting {
- // Immutable. If true, this ad group uses an Audience resource for audience targeting.
- // If false, this ad group may use audience segment criteria instead.
+ // Immutable. If true, this ad group uses an Audience resource for audience
+ // targeting. If false, this ad group may use audience segment criteria
+ // instead.
bool use_audience_grouped = 1 [(google.api.field_behavior) = IMMUTABLE];
}
@@ -79,17 +80,20 @@ message AdGroup {
optional string name = 35;
// The status of the ad group.
- google.ads.googleads.v10.enums.AdGroupStatusEnum.AdGroupStatus status = 5;
+ google.ads.googleads.v13.enums.AdGroupStatusEnum.AdGroupStatus status = 5;
// Immutable. The type of the ad group.
- google.ads.googleads.v10.enums.AdGroupTypeEnum.AdGroupType type = 12 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.AdGroupTypeEnum.AdGroupType type = 12
+ [(google.api.field_behavior) = IMMUTABLE];
// The ad rotation mode of the ad group.
- google.ads.googleads.v10.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22;
+ google.ads.googleads.v13.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode
+ ad_rotation_mode = 22;
- // Output only. For draft or experiment ad groups, this field is the resource name of the
- // base ad group from which this ad group was created. If a draft or
- // experiment ad group does not have a base ad group, then this field is null.
+ // Output only. For draft or experiment ad groups, this field is the resource
+ // name of the base ad group from which this ad group was created. If a draft
+ // or experiment ad group does not have a base ad group, then this field is
+ // null.
//
// For base ad groups, this field equals the ad group resource name.
//
@@ -106,7 +110,8 @@ message AdGroup {
// The list of mappings used to substitute custom parameter tags in a
// `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
- repeated google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 6;
+ repeated google.ads.googleads.v13.common.CustomParameter
+ url_custom_parameters = 6;
// Immutable. The campaign to which the ad group belongs.
optional string campaign = 38 [
@@ -119,10 +124,11 @@ message AdGroup {
// The maximum CPC (cost-per-click) bid.
optional int64 cpc_bid_micros = 39;
- // Output only. Value will be same as that of the CPC (cost-per-click) bid value when the
- // bidding strategy is one of manual cpc, enhanced cpc, page one promoted or
- // target outrank share, otherwise the value will be null.
- optional int64 effective_cpc_bid_micros = 57 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Value will be same as that of the CPC (cost-per-click) bid
+ // value when the bidding strategy is one of manual cpc, enhanced cpc, page
+ // one promoted or target outrank share, otherwise the value will be null.
+ optional int64 effective_cpc_bid_micros = 57
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The maximum CPM (cost-per-thousand viewable impressions) bid.
optional int64 cpm_bid_micros = 40;
@@ -134,8 +140,8 @@ message AdGroup {
// Otherwise, this value is ignored.
optional int64 target_cpa_micros = 41;
- // Output only. The CPV (cost-per-view) bid.
- optional int64 cpv_bid_micros = 42 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // The CPV (cost-per-view) bid.
+ optional int64 cpv_bid_micros = 42;
// Average amount in micros that the advertiser is willing to pay for every
// thousand times the ad is shown.
@@ -153,38 +159,47 @@ message AdGroup {
// value stored here is 1,000,000 * [fraction].
optional int64 percent_cpc_bid_micros = 45;
- // Settings for the Display Campaign Optimizer, initially termed "Explorer".
- google.ads.googleads.v10.common.ExplorerAutoOptimizerSetting explorer_auto_optimizer_setting = 21;
+ // True if optimized targeting is enabled. Optimized Targeting is the
+ // replacement for Audience Expansion.
+ bool optimized_targeting_enabled = 59;
// Allows advertisers to specify a targeting dimension on which to place
// absolute bids. This is only applicable for campaigns that target only the
// display network and not search.
- google.ads.googleads.v10.enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23;
+ google.ads.googleads.v13.enums.TargetingDimensionEnum.TargetingDimension
+ display_custom_bid_dimension = 23;
// URL template for appending params to Final URL.
optional string final_url_suffix = 46;
// Setting for targeting related features.
- google.ads.googleads.v10.common.TargetingSetting targeting_setting = 25;
+ google.ads.googleads.v13.common.TargetingSetting targeting_setting = 25;
// Immutable. Setting for audience related features.
- AudienceSetting audience_setting = 56 [(google.api.field_behavior) = IMMUTABLE];
+ AudienceSetting audience_setting = 56
+ [(google.api.field_behavior) = IMMUTABLE];
// Output only. The effective target CPA (cost-per-acquisition).
// This field is read-only.
- optional int64 effective_target_cpa_micros = 47 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 effective_target_cpa_micros = 47
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Source of the effective target CPA.
// This field is read-only.
- google.ads.googleads.v10.enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BiddingSourceEnum.BiddingSource
+ effective_target_cpa_source = 29
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The effective target ROAS (return-on-ad-spend).
// This field is read-only.
- optional double effective_target_roas = 48 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional double effective_target_roas = 48
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Source of the effective target ROAS.
// This field is read-only.
- google.ads.googleads.v10.enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BiddingSourceEnum.BiddingSource
+ effective_target_roas_source = 32
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The resource names of labels attached to this ad group.
repeated string labels = 49 [
@@ -197,5 +212,19 @@ message AdGroup {
// The asset field types that should be excluded from this ad group. Asset
// links with these field types will not be inherited by this ad group from
// the upper levels.
- repeated google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;
+ repeated google.ads.googleads.v13.enums.AssetFieldTypeEnum.AssetFieldType
+ excluded_parent_asset_field_types = 54;
+
+ // The asset set types that should be excluded from this ad group. Asset set
+ // links with these types will not be inherited by this ad group from the
+ // upper levels.
+ // Location group types (GMB_DYNAMIC_LOCATION_GROUP,
+ // CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of
+ // LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all
+ // location group asset sets are not allowed to be linked to this ad group,
+ // and all Location Extension (LE) and Affiliate Location Extensions (ALE)
+ // will not be served under this ad group.
+ // Only LOCATION_SYNC is currently supported.
+ repeated google.ads.googleads.v13.enums.AssetSetTypeEnum.AssetSetType
+ excluded_parent_asset_set_types = 58;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad.proto
similarity index 61%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad.proto
index 35b197d9f..fafbe9dfe 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad.proto
@@ -14,25 +14,25 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/policy.proto";
-import "google/ads/googleads/v10/enums/ad_group_ad_status.proto";
-import "google/ads/googleads/v10/enums/ad_strength.proto";
-import "google/ads/googleads/v10/enums/policy_approval_status.proto";
-import "google/ads/googleads/v10/enums/policy_review_status.proto";
-import "google/ads/googleads/v10/resources/ad.proto";
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/policy.proto";
+import "google/ads/googleads/v13/enums/ad_group_ad_status.proto";
+import "google/ads/googleads/v13/enums/ad_strength.proto";
+import "google/ads/googleads/v13/enums/policy_approval_status.proto";
+import "google/ads/googleads/v13/enums/policy_review_status.proto";
+import "google/ads/googleads/v13/resources/ad.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad group ad resource.
@@ -55,7 +55,7 @@ message AdGroupAd {
];
// The status of the ad.
- google.ads.googleads.v10.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3;
+ google.ads.googleads.v13.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3;
// Immutable. The ad group to which the ad belongs.
optional string ad_group = 9 [
@@ -69,14 +69,16 @@ message AdGroupAd {
Ad ad = 5 [(google.api.field_behavior) = IMMUTABLE];
// Output only. Policy information for the ad.
- AdGroupAdPolicySummary policy_summary = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ AdGroupAdPolicySummary policy_summary = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Overall ad strength for this ad group ad.
- google.ads.googleads.v10.enums.AdStrengthEnum.AdStrength ad_strength = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AdStrengthEnum.AdStrength ad_strength = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A list of recommendations to improve the ad strength. For example, a
- // recommendation could be "Your headlines are a little too similar.
- // Try adding more distinct headlines.".
+ // Output only. A list of recommendations to improve the ad strength. For
+ // example, a recommendation could be "Your headlines are a little too
+ // similar. Try adding more distinct headlines.".
repeated string action_items = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The resource names of labels attached to this ad group ad.
@@ -91,12 +93,15 @@ message AdGroupAd {
// Contains policy information for an ad.
message AdGroupAdPolicySummary {
// Output only. The list of policy findings for this ad.
- repeated google.ads.googleads.v10.common.PolicyTopicEntry policy_topic_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.ads.googleads.v13.common.PolicyTopicEntry
+ policy_topic_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Where in the review process this ad is.
- google.ads.googleads.v10.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.PolicyReviewStatusEnum.PolicyReviewStatus
+ review_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The overall approval status of this ad, calculated based on the status of
- // its individual policy topic entries.
- google.ads.googleads.v10.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The overall approval status of this ad, calculated based on
+ // the status of its individual policy topic entries.
+ google.ads.googleads.v13.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus
+ approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad_asset_combination_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad_asset_combination_view.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad_asset_combination_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad_asset_combination_view.proto
index 9edd42561..8e5fb4579 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad_asset_combination_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad_asset_combination_view.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/asset_usage.proto";
+import "google/ads/googleads/v13/common/asset_usage.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdAssetCombinationViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the asset combination view resource.
@@ -40,8 +40,8 @@ message AdGroupAdAssetCombinationView {
pattern: "customers/{customer_id}/adGroupAdAssetCombinationViews/{ad_group_id}~{ad_id}~{asset_combination_id_low}~{asset_combination_id_high}"
};
- // Output only. The resource name of the ad group ad asset combination view. The
- // combination ID is 128 bits long, where the upper 64 bits are stored in
+ // Output only. The resource name of the ad group ad asset combination view.
+ // The combination ID is 128 bits long, where the upper 64 bits are stored in
// asset_combination_id_high, and the lower 64 bits are stored in
// asset_combination_id_low.
// AdGroupAd Asset Combination view resource names have the form:
@@ -54,11 +54,12 @@ message AdGroupAdAssetCombinationView {
];
// Output only. Served assets.
- repeated google.ads.googleads.v10.common.AssetUsage served_assets = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.ads.googleads.v13.common.AssetUsage served_assets = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The status between the asset combination and the latest version of the ad.
- // If true, the asset combination is linked to the latest version of the ad.
- // If false, it means the link once existed but has been removed and is no
- // longer present in the latest version of the ad.
+ // Output only. The status between the asset combination and the latest
+ // version of the ad. If true, the asset combination is linked to the latest
+ // version of the ad. If false, it means the link once existed but has been
+ // removed and is no longer present in the latest version of the ad.
optional bool enabled = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad_asset_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad_asset_view.proto
similarity index 57%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad_asset_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad_asset_view.proto
index d2b753ff4..dd69d4d22 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad_asset_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad_asset_view.proto
@@ -14,29 +14,31 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/policy.proto";
-import "google/ads/googleads/v10/enums/asset_field_type.proto";
-import "google/ads/googleads/v10/enums/asset_performance_label.proto";
-import "google/ads/googleads/v10/enums/policy_approval_status.proto";
-import "google/ads/googleads/v10/enums/policy_review_status.proto";
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/policy.proto";
+import "google/ads/googleads/v13/enums/asset_field_type.proto";
+import "google/ads/googleads/v13/enums/asset_performance_label.proto";
+import "google/ads/googleads/v13/enums/policy_approval_status.proto";
+import "google/ads/googleads/v13/enums/policy_review_status.proto";
+import "google/ads/googleads/v13/enums/served_asset_field_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdAssetViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad group ad asset view resource.
// A link between an AdGroupAd and an Asset.
-// Currently we only support AdGroupAdAssetView for AppAds.
+// Currently we only support AdGroupAdAssetView for AppAds and Responsive Search
+// Ads.
message AdGroupAdAssetView {
option (google.api.resource) = {
type: "googleads.googleapis.com/AdGroupAdAssetView"
@@ -69,36 +71,44 @@ message AdGroupAdAssetView {
// Output only. The asset which is linked to the ad group ad.
optional string asset = 10 [
(google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
];
// Output only. Role that the asset takes in the ad.
- google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType field_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AssetFieldTypeEnum.AssetFieldType field_type =
+ 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The status between the asset and the latest version of the ad. If true, the
- // asset is linked to the latest version of the ad. If false, it means the
- // link once existed but has been removed and is no longer present in the
- // latest version of the ad.
+ // Output only. The status between the asset and the latest version of the ad.
+ // If true, the asset is linked to the latest version of the ad. If false, it
+ // means the link once existed but has been removed and is no longer present
+ // in the latest version of the ad.
optional bool enabled = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Policy information for the ad group ad asset.
- AdGroupAdAssetPolicySummary policy_summary = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ AdGroupAdAssetPolicySummary policy_summary = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Performance of an asset linkage.
- google.ads.googleads.v10.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel performance_label = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel
+ performance_label = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Pinned field.
+ google.ads.googleads.v13.enums.ServedAssetFieldTypeEnum.ServedAssetFieldType
+ pinned_field = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Contains policy information for an ad group ad asset.
message AdGroupAdAssetPolicySummary {
// Output only. The list of policy findings for the ad group ad asset.
- repeated google.ads.googleads.v10.common.PolicyTopicEntry policy_topic_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.ads.googleads.v13.common.PolicyTopicEntry
+ policy_topic_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Where in the review process this ad group ad asset is.
- google.ads.googleads.v10.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.PolicyReviewStatusEnum.PolicyReviewStatus
+ review_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The overall approval status of this ad group ad asset, calculated based on
- // the status of its individual policy topic entries.
- google.ads.googleads.v10.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The overall approval status of this ad group ad asset,
+ // calculated based on the status of its individual policy topic entries.
+ google.ads.googleads.v13.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus
+ approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad_label.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad_label.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad_label.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad_label.proto
index fafffaf2a..9f232988c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_ad_label.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_ad_label.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdLabelProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad group ad label resource.
@@ -58,8 +58,6 @@ message AdGroupAdLabel {
// Immutable. The label assigned to the ad group ad.
optional string label = 5 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Label"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Label" }
];
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_asset.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_asset.proto
new file mode 100644
index 000000000..2501d1ae2
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_asset.proto
@@ -0,0 +1,107 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/asset_policy.proto";
+import "google/ads/googleads/v13/enums/asset_field_type.proto";
+import "google/ads/googleads/v13/enums/asset_link_primary_status.proto";
+import "google/ads/googleads/v13/enums/asset_link_primary_status_reason.proto";
+import "google/ads/googleads/v13/enums/asset_link_status.proto";
+import "google/ads/googleads/v13/enums/asset_source.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "AdGroupAssetProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the AdGroupAsset resource.
+
+// A link between an ad group and an asset.
+message AdGroupAsset {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/AdGroupAsset"
+ pattern: "customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}"
+ };
+
+ // Immutable. The resource name of the ad group asset.
+ // AdGroupAsset resource names have the form:
+ //
+ // `customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AdGroupAsset"
+ }
+ ];
+
+ // Required. Immutable. The ad group to which the asset is linked.
+ string ad_group = 2 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AdGroup"
+ }
+ ];
+
+ // Required. Immutable. The asset which is linked to the ad group.
+ string asset = 3 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
+ ];
+
+ // Required. Immutable. Role that the asset takes under the linked ad group.
+ google.ads.googleads.v13.enums.AssetFieldTypeEnum.AssetFieldType field_type =
+ 4 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.field_behavior) = IMMUTABLE
+ ];
+
+ // Output only. Source of the adgroup asset link.
+ google.ads.googleads.v13.enums.AssetSourceEnum.AssetSource source = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Status of the ad group asset.
+ google.ads.googleads.v13.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
+
+ // Output only. Provides the PrimaryStatus of this asset link.
+ // Primary status is meant essentially to differentiate between the plain
+ // "status" field, which has advertiser set values of enabled, paused, or
+ // removed. The primary status takes into account other signals (for assets
+ // its mainly policy and quality approvals) to come up with a more
+ // comprehensive status to indicate its serving state.
+ google.ads.googleads.v13.enums.AssetLinkPrimaryStatusEnum
+ .AssetLinkPrimaryStatus primary_status = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Provides the details of the primary status and its associated
+ // reasons.
+ repeated google.ads.googleads.v13.common.AssetLinkPrimaryStatusDetails
+ primary_status_details = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Provides a list of reasons for why an asset is not serving or
+ // not serving at full capacity.
+ repeated google.ads.googleads.v13.enums.AssetLinkPrimaryStatusReasonEnum
+ .AssetLinkPrimaryStatusReason primary_status_reasons = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_asset_set.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_asset_set.proto
new file mode 100644
index 000000000..6763c979e
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_asset_set.proto
@@ -0,0 +1,72 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/enums/asset_set_link_status.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "AdGroupAssetSetProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the AdGroupAssetSet resource.
+
+// AdGroupAssetSet is the linkage between an ad group and an asset set.
+// Creating an AdGroupAssetSet links an asset set with an ad group.
+message AdGroupAssetSet {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/AdGroupAssetSet"
+ pattern: "customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}"
+ };
+
+ // Immutable. The resource name of the ad group asset set.
+ // Ad group asset set resource names have the form:
+ //
+ // `customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AdGroupAssetSet"
+ }
+ ];
+
+ // Immutable. The ad group to which this asset set is linked.
+ string ad_group = 2 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AdGroup"
+ }
+ ];
+
+ // Immutable. The asset set which is linked to the ad group.
+ string asset_set = 3 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AssetSet"
+ }
+ ];
+
+ // Output only. The status of the ad group asset set. Read-only.
+ google.ads.googleads.v13.enums.AssetSetLinkStatusEnum.AssetSetLinkStatus
+ status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_audience_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_audience_view.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_audience_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_audience_view.proto
index ae78ff2e5..e78ad0fc1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_audience_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_audience_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAudienceViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad group audience view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_bid_modifier.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_bid_modifier.proto
similarity index 61%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_bid_modifier.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_bid_modifier.proto
index 504cc2851..52f887118 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_bid_modifier.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_bid_modifier.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/enums/bid_modifier_source.proto";
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/enums/bid_modifier_source.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupBidModifierProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad group bid modifier resource.
@@ -68,11 +68,11 @@ message AdGroupBidModifier {
// Use 0 to opt out of a Device type.
optional double bid_modifier = 15;
- // Output only. The base ad group from which this draft/trial adgroup bid modifier was
- // created. If ad_group is a base ad group then this field will be equal to
- // ad_group. If the ad group was created in the draft or trial and has no
- // corresponding base ad group, then this field will be null.
- // This field is readonly.
+ // Output only. The base ad group from which this draft/trial adgroup bid
+ // modifier was created. If ad_group is a base ad group then this field will
+ // be equal to ad_group. If the ad group was created in the draft or trial and
+ // has no corresponding base ad group, then this field will be null. This
+ // field is readonly.
optional string base_ad_group = 16 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -81,31 +81,39 @@ message AdGroupBidModifier {
];
// Output only. Bid modifier source.
- google.ads.googleads.v10.enums.BidModifierSourceEnum.BidModifierSource bid_modifier_source = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BidModifierSourceEnum.BidModifierSource
+ bid_modifier_source = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// The criterion of this ad group bid modifier.
//
// Required in create operations starting in V5.
oneof criterion {
- // Immutable. Criterion for hotel date selection (default dates vs. user selected).
- google.ads.googleads.v10.common.HotelDateSelectionTypeInfo hotel_date_selection_type = 5 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. Criterion for hotel date selection (default dates versus user
+ // selected).
+ google.ads.googleads.v13.common.HotelDateSelectionTypeInfo
+ hotel_date_selection_type = 5 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. Criterion for number of days prior to the stay the booking is being made.
- google.ads.googleads.v10.common.HotelAdvanceBookingWindowInfo hotel_advance_booking_window = 6 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. Criterion for number of days prior to the stay the booking is
+ // being made.
+ google.ads.googleads.v13.common.HotelAdvanceBookingWindowInfo
+ hotel_advance_booking_window = 6
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Criterion for length of hotel stay in nights.
- google.ads.googleads.v10.common.HotelLengthOfStayInfo hotel_length_of_stay = 7 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.HotelLengthOfStayInfo hotel_length_of_stay =
+ 7 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Criterion for day of the week the booking is for.
- google.ads.googleads.v10.common.HotelCheckInDayInfo hotel_check_in_day = 8 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.HotelCheckInDayInfo hotel_check_in_day = 8
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. A device criterion.
- google.ads.googleads.v10.common.DeviceInfo device = 11 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. A preferred content criterion.
- google.ads.googleads.v10.common.PreferredContentInfo preferred_content = 12 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.DeviceInfo device = 11
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Criterion for a hotel check-in date range.
- google.ads.googleads.v10.common.HotelCheckInDateRangeInfo hotel_check_in_date_range = 17 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.HotelCheckInDateRangeInfo
+ hotel_check_in_date_range = 17
+ [(google.api.field_behavior) = IMMUTABLE];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion.proto
similarity index 51%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion.proto
index f77c97af7..05a60f711 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion.proto
@@ -14,27 +14,27 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/common/custom_parameter.proto";
-import "google/ads/googleads/v10/enums/ad_group_criterion_approval_status.proto";
-import "google/ads/googleads/v10/enums/ad_group_criterion_status.proto";
-import "google/ads/googleads/v10/enums/bidding_source.proto";
-import "google/ads/googleads/v10/enums/criterion_system_serving_status.proto";
-import "google/ads/googleads/v10/enums/criterion_type.proto";
-import "google/ads/googleads/v10/enums/quality_score_bucket.proto";
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/common/custom_parameter.proto";
+import "google/ads/googleads/v13/enums/ad_group_criterion_approval_status.proto";
+import "google/ads/googleads/v13/enums/ad_group_criterion_status.proto";
+import "google/ads/googleads/v13/enums/bidding_source.proto";
+import "google/ads/googleads/v13/enums/criterion_system_serving_status.proto";
+import "google/ads/googleads/v13/enums/criterion_type.proto";
+import "google/ads/googleads/v13/enums/quality_score_bucket.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad group criterion resource.
@@ -51,39 +51,50 @@ message AdGroupCriterion {
//
// This field may not be populated if Google does not have enough
// information to determine a value.
- optional int32 quality_score = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int32 quality_score = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The performance of the ad compared to other advertisers.
- google.ads.googleads.v10.enums.QualityScoreBucketEnum.QualityScoreBucket creative_quality_score = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.QualityScoreBucketEnum.QualityScoreBucket
+ creative_quality_score = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The quality score of the landing page.
- google.ads.googleads.v10.enums.QualityScoreBucketEnum.QualityScoreBucket post_click_quality_score = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The click-through rate compared to that of other advertisers.
- google.ads.googleads.v10.enums.QualityScoreBucketEnum.QualityScoreBucket search_predicted_ctr = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.QualityScoreBucketEnum.QualityScoreBucket
+ post_click_quality_score = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The click-through rate compared to that of other
+ // advertisers.
+ google.ads.googleads.v13.enums.QualityScoreBucketEnum.QualityScoreBucket
+ search_predicted_ctr = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Estimates for criterion bids at various positions.
message PositionEstimates {
- // Output only. The estimate of the CPC bid required for ad to be shown on first
- // page of search results.
- optional int64 first_page_cpc_micros = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The estimate of the CPC bid required for ad to be displayed in first
- // position, at the top of the first page of search results.
- optional int64 first_position_cpc_micros = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The estimate of the CPC bid required for ad to be displayed at the top
- // of the first page of search results.
- optional int64 top_of_page_cpc_micros = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Estimate of how many clicks per week you might get by changing your
- // keyword bid to the value in first_position_cpc_micros.
- optional int64 estimated_add_clicks_at_first_position_cpc = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Estimate of how your cost per week might change when changing your
- // keyword bid to the value in first_position_cpc_micros.
- optional int64 estimated_add_cost_at_first_position_cpc = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The estimate of the CPC bid required for ad to be shown on
+ // first page of search results.
+ optional int64 first_page_cpc_micros = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The estimate of the CPC bid required for ad to be displayed
+ // in first position, at the top of the first page of search results.
+ optional int64 first_position_cpc_micros = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The estimate of the CPC bid required for ad to be displayed
+ // at the top of the first page of search results.
+ optional int64 top_of_page_cpc_micros = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Estimate of how many clicks per week you might get by
+ // changing your keyword bid to the value in first_position_cpc_micros.
+ optional int64 estimated_add_clicks_at_first_position_cpc = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Estimate of how your cost per week might change when
+ // changing your keyword bid to the value in first_position_cpc_micros.
+ optional int64 estimated_add_cost_at_first_position_cpc = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Immutable. The resource name of the ad group criterion.
@@ -117,7 +128,8 @@ message AdGroupCriterion {
// excluded. The UI will show each age range as "enabled", since they're
// eligible to see the ads; but AdGroupCriterion.status will show "removed",
// since no positive criterion was added.
- google.ads.googleads.v10.enums.AdGroupCriterionStatusEnum.AdGroupCriterionStatus status = 3;
+ google.ads.googleads.v13.enums.AdGroupCriterionStatusEnum
+ .AdGroupCriterionStatus status = 3;
// Output only. Information regarding the quality of the criterion.
QualityInfo quality_info = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -131,7 +143,8 @@ message AdGroupCriterion {
];
// Output only. The type of the criterion.
- google.ads.googleads.v10.enums.CriterionTypeEnum.CriterionType type = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CriterionTypeEnum.CriterionType type = 25
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. Whether to target (`false`) or exclude (`true`) the criterion.
//
@@ -140,10 +153,14 @@ message AdGroupCriterion {
optional bool negative = 58 [(google.api.field_behavior) = IMMUTABLE];
// Output only. Serving status of the criterion.
- google.ads.googleads.v10.enums.CriterionSystemServingStatusEnum.CriterionSystemServingStatus system_serving_status = 52 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CriterionSystemServingStatusEnum
+ .CriterionSystemServingStatus system_serving_status = 52
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Approval status of the criterion.
- google.ads.googleads.v10.enums.AdGroupCriterionApprovalStatusEnum.AdGroupCriterionApprovalStatus approval_status = 53 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AdGroupCriterionApprovalStatusEnum
+ .AdGroupCriterionApprovalStatus approval_status = 53
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. List of disapproval reasons of the criterion.
//
@@ -151,9 +168,11 @@ message AdGroupCriterion {
// https://support.google.com/adspolicy/answer/6008942
//
// This field is read-only.
- repeated string disapproval_reasons = 59 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated string disapproval_reasons = 59
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The resource names of labels attached to this ad group criterion.
+ // Output only. The resource names of labels attached to this ad group
+ // criterion.
repeated string labels = 60 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -180,31 +199,42 @@ message AdGroupCriterion {
optional int64 percent_cpc_bid_micros = 65;
// Output only. The effective CPC (cost-per-click) bid.
- optional int64 effective_cpc_bid_micros = 66 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 effective_cpc_bid_micros = 66
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The effective CPM (cost-per-thousand viewable impressions) bid.
- optional int64 effective_cpm_bid_micros = 67 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The effective CPM (cost-per-thousand viewable impressions)
+ // bid.
+ optional int64 effective_cpm_bid_micros = 67
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The effective CPV (cost-per-view) bid.
- optional int64 effective_cpv_bid_micros = 68 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 effective_cpv_bid_micros = 68
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The effective Percent CPC bid amount.
- optional int64 effective_percent_cpc_bid_micros = 69 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 effective_percent_cpc_bid_micros = 69
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Source of the effective CPC bid.
- google.ads.googleads.v10.enums.BiddingSourceEnum.BiddingSource effective_cpc_bid_source = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BiddingSourceEnum.BiddingSource
+ effective_cpc_bid_source = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Source of the effective CPM bid.
- google.ads.googleads.v10.enums.BiddingSourceEnum.BiddingSource effective_cpm_bid_source = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BiddingSourceEnum.BiddingSource
+ effective_cpm_bid_source = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Source of the effective CPV bid.
- google.ads.googleads.v10.enums.BiddingSourceEnum.BiddingSource effective_cpv_bid_source = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BiddingSourceEnum.BiddingSource
+ effective_cpv_bid_source = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Source of the effective Percent CPC bid.
- google.ads.googleads.v10.enums.BiddingSourceEnum.BiddingSource effective_percent_cpc_bid_source = 35 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BiddingSourceEnum.BiddingSource
+ effective_percent_cpc_bid_source = 35
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Estimates for criterion bids at various positions.
- PositionEstimates position_estimates = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ PositionEstimates position_estimates = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The list of possible final URLs after all cross-domain redirects for the
// ad.
@@ -221,73 +251,98 @@ message AdGroupCriterion {
// The list of mappings used to substitute custom parameter tags in a
// `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
- repeated google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 14;
+ repeated google.ads.googleads.v13.common.CustomParameter
+ url_custom_parameters = 14;
// The ad group criterion.
//
// Exactly one must be set.
oneof criterion {
// Immutable. Keyword.
- google.ads.googleads.v10.common.KeywordInfo keyword = 27 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.KeywordInfo keyword = 27
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Placement.
- google.ads.googleads.v10.common.PlacementInfo placement = 28 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.PlacementInfo placement = 28
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Mobile app category.
- google.ads.googleads.v10.common.MobileAppCategoryInfo mobile_app_category = 29 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.MobileAppCategoryInfo mobile_app_category =
+ 29 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Mobile application.
- google.ads.googleads.v10.common.MobileApplicationInfo mobile_application = 30 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.MobileApplicationInfo mobile_application =
+ 30 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Listing group.
- google.ads.googleads.v10.common.ListingGroupInfo listing_group = 32 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.ListingGroupInfo listing_group = 32
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Age range.
- google.ads.googleads.v10.common.AgeRangeInfo age_range = 36 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.AgeRangeInfo age_range = 36
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Gender.
- google.ads.googleads.v10.common.GenderInfo gender = 37 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.GenderInfo gender = 37
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Income range.
- google.ads.googleads.v10.common.IncomeRangeInfo income_range = 38 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.IncomeRangeInfo income_range = 38
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Parental status.
- google.ads.googleads.v10.common.ParentalStatusInfo parental_status = 39 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.ParentalStatusInfo parental_status = 39
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. User List.
- google.ads.googleads.v10.common.UserListInfo user_list = 42 [(google.api.field_behavior) = IMMUTABLE];
+ // The Similar Audiences sunset starts May 2023. Refer to
+ // https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html
+ // for other options.
+ google.ads.googleads.v13.common.UserListInfo user_list = 42
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. YouTube Video.
- google.ads.googleads.v10.common.YouTubeVideoInfo youtube_video = 40 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.YouTubeVideoInfo youtube_video = 40
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. YouTube Channel.
- google.ads.googleads.v10.common.YouTubeChannelInfo youtube_channel = 41 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.YouTubeChannelInfo youtube_channel = 41
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Topic.
- google.ads.googleads.v10.common.TopicInfo topic = 43 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.TopicInfo topic = 43
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. User Interest.
- google.ads.googleads.v10.common.UserInterestInfo user_interest = 45 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.UserInterestInfo user_interest = 45
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Webpage
- google.ads.googleads.v10.common.WebpageInfo webpage = 46 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.WebpageInfo webpage = 46
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. App Payment Model.
- google.ads.googleads.v10.common.AppPaymentModelInfo app_payment_model = 47 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.AppPaymentModelInfo app_payment_model = 47
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Custom Affinity.
- google.ads.googleads.v10.common.CustomAffinityInfo custom_affinity = 48 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.CustomAffinityInfo custom_affinity = 48
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Custom Intent.
- google.ads.googleads.v10.common.CustomIntentInfo custom_intent = 49 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.CustomIntentInfo custom_intent = 49
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Custom Audience.
- google.ads.googleads.v10.common.CustomAudienceInfo custom_audience = 74 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.CustomAudienceInfo custom_audience = 74
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Combined Audience.
- google.ads.googleads.v10.common.CombinedAudienceInfo combined_audience = 75 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.CombinedAudienceInfo combined_audience = 75
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Audience.
- google.ads.googleads.v10.common.AudienceInfo audience = 79 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.AudienceInfo audience = 79
+ [(google.api.field_behavior) = IMMUTABLE];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion_customizer.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion_customizer.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion_customizer.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion_customizer.proto
index 119f1edc9..2b2166f75 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion_customizer.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion_customizer.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/customizer_value.proto";
-import "google/ads/googleads/v10/enums/customizer_value_status.proto";
+import "google/ads/googleads/v13/common/customizer_value.proto";
+import "google/ads/googleads/v13/enums/customizer_value_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionCustomizerProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// A customizer value for the associated CustomizerAttribute at the
// AdGroupCriterion level.
@@ -49,8 +49,8 @@ message AdGroupCriterionCustomizer {
}
];
- // Immutable. The ad group criterion to which the customizer attribute is linked.
- // It must be a keyword criterion.
+ // Immutable. The ad group criterion to which the customizer attribute is
+ // linked. It must be a keyword criterion.
optional string ad_group_criterion = 2 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
@@ -58,7 +58,8 @@ message AdGroupCriterionCustomizer {
}
];
- // Required. Immutable. The customizer attribute which is linked to the ad group criterion.
+ // Required. Immutable. The customizer attribute which is linked to the ad
+ // group criterion.
string customizer_attribute = 3 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE,
@@ -68,9 +69,11 @@ message AdGroupCriterionCustomizer {
];
// Output only. The status of the ad group criterion customizer.
- google.ads.googleads.v10.enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CustomizerValueStatusEnum.CustomizerValueStatus
+ status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. The value to associate with the customizer attribute at this level. The
- // value must be of the type specified for the CustomizerAttribute.
- google.ads.googleads.v10.common.CustomizerValue value = 5 [(google.api.field_behavior) = REQUIRED];
+ // Required. The value to associate with the customizer attribute at this
+ // level. The value must be of the type specified for the CustomizerAttribute.
+ google.ads.googleads.v13.common.CustomizerValue value = 5
+ [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion_label.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion_label.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion_label.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion_label.proto
index d946d51ab..84fdc5c68 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion_label.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion_label.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionLabelProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad group criterion label resource.
@@ -58,8 +58,6 @@ message AdGroupCriterionLabel {
// Immutable. The label assigned to the ad group criterion.
optional string label = 5 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Label"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Label" }
];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion_simulation.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion_simulation.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion_simulation.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion_simulation.proto
index 0bdbd71f1..6a548b706 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_criterion_simulation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_criterion_simulation.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/simulation.proto";
-import "google/ads/googleads/v10/enums/simulation_modification_method.proto";
-import "google/ads/googleads/v10/enums/simulation_type.proto";
+import "google/ads/googleads/v13/common/simulation.proto";
+import "google/ads/googleads/v13/enums/simulation_modification_method.proto";
+import "google/ads/googleads/v13/enums/simulation_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionSimulationProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad group criterion simulation resource.
@@ -67,23 +67,31 @@ message AdGroupCriterionSimulation {
optional int64 criterion_id = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The field that the simulation modifies.
- google.ads.googleads.v10.enums.SimulationTypeEnum.SimulationType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SimulationTypeEnum.SimulationType type = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. How the simulation modifies the field.
- google.ads.googleads.v10.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SimulationModificationMethodEnum
+ .SimulationModificationMethod modification_method = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. First day on which the simulation is based, in YYYY-MM-DD format.
+ // Output only. First day on which the simulation is based, in YYYY-MM-DD
+ // format.
optional string start_date = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Last day on which the simulation is based, in YYYY-MM-DD format.
+ // Output only. Last day on which the simulation is based, in YYYY-MM-DD
+ // format.
optional string end_date = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// List of simulation points.
oneof point_list {
// Output only. Simulation points if the simulation type is CPC_BID.
- google.ads.googleads.v10.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.CpcBidSimulationPointList
+ cpc_bid_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Simulation points if the simulation type is PERCENT_CPC_BID.
- google.ads.googleads.v10.common.PercentCpcBidSimulationPointList percent_cpc_bid_point_list = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.PercentCpcBidSimulationPointList
+ percent_cpc_bid_point_list = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_customizer.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_customizer.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_customizer.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_customizer.proto
index bd969d590..a9192d055 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_customizer.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_customizer.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/customizer_value.proto";
-import "google/ads/googleads/v10/enums/customizer_value_status.proto";
+import "google/ads/googleads/v13/common/customizer_value.proto";
+import "google/ads/googleads/v13/enums/customizer_value_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCustomizerProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// A customizer value for the associated CustomizerAttribute at the AdGroup
// level.
@@ -57,7 +57,8 @@ message AdGroupCustomizer {
}
];
- // Required. Immutable. The customizer attribute which is linked to the ad group.
+ // Required. Immutable. The customizer attribute which is linked to the ad
+ // group.
string customizer_attribute = 3 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE,
@@ -67,9 +68,11 @@ message AdGroupCustomizer {
];
// Output only. The status of the ad group customizer.
- google.ads.googleads.v10.enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CustomizerValueStatusEnum.CustomizerValueStatus
+ status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. The value to associate with the customizer attribute at this level. The
- // value must be of the type specified for the CustomizerAttribute.
- google.ads.googleads.v10.common.CustomizerValue value = 5 [(google.api.field_behavior) = REQUIRED];
+ // Required. The value to associate with the customizer attribute at this
+ // level. The value must be of the type specified for the CustomizerAttribute.
+ google.ads.googleads.v13.common.CustomizerValue value = 5
+ [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_extension_setting.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_extension_setting.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_extension_setting.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_extension_setting.proto
index cace6d641..d6e0885a8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_extension_setting.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_extension_setting.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/extension_setting_device.proto";
-import "google/ads/googleads/v10/enums/extension_type.proto";
+import "google/ads/googleads/v13/enums/extension_setting_device.proto";
+import "google/ads/googleads/v13/enums/extension_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupExtensionSettingProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the AdGroupExtensionSetting resource.
@@ -51,11 +51,11 @@ message AdGroupExtensionSetting {
];
// Immutable. The extension type of the ad group extension setting.
- google.ads.googleads.v10.enums.ExtensionTypeEnum.ExtensionType extension_type = 2 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.ExtensionTypeEnum.ExtensionType
+ extension_type = 2 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The resource name of the ad group. The linked extension feed items will
- // serve under this ad group.
- // AdGroup resource names have the form:
+ // Immutable. The resource name of the ad group. The linked extension feed
+ // items will serve under this ad group. AdGroup resource names have the form:
//
// `customers/{customer_id}/adGroups/{ad_group_id}`
optional string ad_group = 6 [
@@ -70,9 +70,10 @@ message AdGroupExtensionSetting {
//
// `customers/{customer_id}/extensionFeedItems/{feed_item_id}`
repeated string extension_feed_items = 7 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ExtensionFeedItem"
- }];
+ type: "googleads.googleapis.com/ExtensionFeedItem"
+ }];
// The device for which the extensions will serve. Optional.
- google.ads.googleads.v10.enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 5;
+ google.ads.googleads.v13.enums.ExtensionSettingDeviceEnum
+ .ExtensionSettingDevice device = 5;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_feed.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_feed.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_feed.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_feed.proto
index 1e9f864ed..912ea3747 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_feed.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_feed.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/matching_function.proto";
-import "google/ads/googleads/v10/enums/feed_link_status.proto";
-import "google/ads/googleads/v10/enums/placeholder_type.proto";
+import "google/ads/googleads/v13/common/matching_function.proto";
+import "google/ads/googleads/v13/enums/feed_link_status.proto";
+import "google/ads/googleads/v13/enums/placeholder_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupFeedProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the AdGroupFeed resource.
@@ -54,9 +54,7 @@ message AdGroupFeed {
// Immutable. The feed being linked to the ad group.
optional string feed = 7 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Feed" }
];
// Immutable. The ad group being linked to the feed.
@@ -69,14 +67,16 @@ message AdGroupFeed {
// Indicates which placeholder types the feed may populate under the connected
// ad group. Required.
- repeated google.ads.googleads.v10.enums.PlaceholderTypeEnum.PlaceholderType placeholder_types = 4;
+ repeated google.ads.googleads.v13.enums.PlaceholderTypeEnum.PlaceholderType
+ placeholder_types = 4;
// Matching function associated with the AdGroupFeed.
// The matching function is used to filter the set of feed items selected.
// Required.
- google.ads.googleads.v10.common.MatchingFunction matching_function = 5;
+ google.ads.googleads.v13.common.MatchingFunction matching_function = 5;
// Output only. Status of the ad group feed.
// This field is read-only.
- google.ads.googleads.v10.enums.FeedLinkStatusEnum.FeedLinkStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.FeedLinkStatusEnum.FeedLinkStatus status = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_label.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_label.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_label.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_label.proto
index 4f72eb241..a2b9c66b7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_label.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_label.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupLabelProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad group label resource.
@@ -58,8 +58,6 @@ message AdGroupLabel {
// Immutable. The label assigned to the ad group.
optional string label = 5 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Label"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Label" }
];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_simulation.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_simulation.proto
similarity index 67%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_group_simulation.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_group_simulation.proto
index 82da61c93..17e73bc66 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_group_simulation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_group_simulation.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/simulation.proto";
-import "google/ads/googleads/v10/enums/simulation_modification_method.proto";
-import "google/ads/googleads/v10/enums/simulation_type.proto";
+import "google/ads/googleads/v13/common/simulation.proto";
+import "google/ads/googleads/v13/enums/simulation_modification_method.proto";
+import "google/ads/googleads/v13/enums/simulation_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupSimulationProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad group simulation resource.
@@ -65,29 +65,38 @@ message AdGroupSimulation {
optional int64 ad_group_id = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The field that the simulation modifies.
- google.ads.googleads.v10.enums.SimulationTypeEnum.SimulationType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SimulationTypeEnum.SimulationType type = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. How the simulation modifies the field.
- google.ads.googleads.v10.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SimulationModificationMethodEnum
+ .SimulationModificationMethod modification_method = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. First day on which the simulation is based, in YYYY-MM-DD format.
+ // Output only. First day on which the simulation is based, in YYYY-MM-DD
+ // format.
optional string start_date = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Last day on which the simulation is based, in YYYY-MM-DD format
+ // Output only. Last day on which the simulation is based, in YYYY-MM-DD
+ // format
optional string end_date = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
// List of simulation points.
oneof point_list {
// Output only. Simulation points if the simulation type is CPC_BID.
- google.ads.googleads.v10.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.CpcBidSimulationPointList
+ cpc_bid_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Simulation points if the simulation type is CPV_BID.
- google.ads.googleads.v10.common.CpvBidSimulationPointList cpv_bid_point_list = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.CpvBidSimulationPointList
+ cpv_bid_point_list = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Simulation points if the simulation type is TARGET_CPA.
- google.ads.googleads.v10.common.TargetCpaSimulationPointList target_cpa_point_list = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.TargetCpaSimulationPointList
+ target_cpa_point_list = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Simulation points if the simulation type is TARGET_ROAS.
- google.ads.googleads.v10.common.TargetRoasSimulationPointList target_roas_point_list = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.TargetRoasSimulationPointList
+ target_roas_point_list = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_parameter.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_parameter.proto
similarity index 88%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_parameter.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_parameter.proto
index 1219a5d86..b4996018d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_parameter.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_parameter.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdParameterProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad parameter resource.
@@ -35,7 +35,7 @@ option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
// be a maximum of two AdParameters per ad group criterion. (One with
// parameter_index = 1 and one with parameter_index = 2.)
// In the ad the parameters are referenced by a placeholder of the form
-// "{param#:value}". E.g. "{param1:$17}"
+// "{param#:value}". For example, "{param1:$17}"
message AdParameter {
option (google.api.resource) = {
type: "googleads.googleapis.com/AdParameter"
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/ad_schedule_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/ad_schedule_view.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/ad_schedule_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/ad_schedule_view.proto
index dc08ad4d5..de9782240 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/ad_schedule_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/ad_schedule_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdScheduleViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ad schedule view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/age_range_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/age_range_view.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/resources/age_range_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/age_range_view.proto
index d3f3445b6..3943b15be 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/age_range_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/age_range_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AgeRangeViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the age range view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/asset.proto b/third_party/googleapis/google/ads/googleads/v13/resources/asset.proto
new file mode 100644
index 000000000..6f9cece0f
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/asset.proto
@@ -0,0 +1,230 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/asset_types.proto";
+import "google/ads/googleads/v13/common/custom_parameter.proto";
+import "google/ads/googleads/v13/common/policy.proto";
+import "google/ads/googleads/v13/enums/asset_field_type.proto";
+import "google/ads/googleads/v13/enums/asset_source.proto";
+import "google/ads/googleads/v13/enums/asset_type.proto";
+import "google/ads/googleads/v13/enums/policy_approval_status.proto";
+import "google/ads/googleads/v13/enums/policy_review_status.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "AssetProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the asset resource.
+
+// Asset is a part of an ad which can be shared across multiple ads.
+// It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc.
+// Assets are immutable and cannot be removed. To stop an asset from serving,
+// remove the asset from the entity that is using it.
+message Asset {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/Asset"
+ pattern: "customers/{customer_id}/assets/{asset_id}"
+ };
+
+ // Immutable. The resource name of the asset.
+ // Asset resource names have the form:
+ //
+ // `customers/{customer_id}/assets/{asset_id}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
+ ];
+
+ // Output only. The ID of the asset.
+ optional int64 id = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Optional name of the asset.
+ optional string name = 12;
+
+ // Output only. Type of the asset.
+ google.ads.googleads.v13.enums.AssetTypeEnum.AssetType type = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // A list of possible final URLs after all cross domain redirects.
+ repeated string final_urls = 14;
+
+ // A list of possible final mobile URLs after all cross domain redirects.
+ repeated string final_mobile_urls = 16;
+
+ // URL template for constructing a tracking URL.
+ optional string tracking_url_template = 17;
+
+ // A list of mappings to be used for substituting URL custom parameter tags in
+ // the tracking_url_template, final_urls, and/or final_mobile_urls.
+ repeated google.ads.googleads.v13.common.CustomParameter
+ url_custom_parameters = 18;
+
+ // URL template for appending params to landing page URLs served with parallel
+ // tracking.
+ optional string final_url_suffix = 19;
+
+ // Output only. Source of the asset.
+ google.ads.googleads.v13.enums.AssetSourceEnum.AssetSource source = 38
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Policy information for the asset.
+ AssetPolicySummary policy_summary = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Policy information for the asset for each FieldType.
+ repeated AssetFieldTypePolicySummary field_type_policy_summaries = 40
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The specific type of the asset.
+ oneof asset_data {
+ // Immutable. A YouTube video asset.
+ google.ads.googleads.v13.common.YoutubeVideoAsset youtube_video_asset = 5
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. A media bundle asset.
+ google.ads.googleads.v13.common.MediaBundleAsset media_bundle_asset = 6
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Output only. An image asset.
+ google.ads.googleads.v13.common.ImageAsset image_asset = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Immutable. A text asset.
+ google.ads.googleads.v13.common.TextAsset text_asset = 8
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // A lead form asset.
+ google.ads.googleads.v13.common.LeadFormAsset lead_form_asset = 9;
+
+ // A book on google asset.
+ google.ads.googleads.v13.common.BookOnGoogleAsset book_on_google_asset = 10;
+
+ // A promotion asset.
+ google.ads.googleads.v13.common.PromotionAsset promotion_asset = 15;
+
+ // A callout asset.
+ google.ads.googleads.v13.common.CalloutAsset callout_asset = 20;
+
+ // A structured snippet asset.
+ google.ads.googleads.v13.common.StructuredSnippetAsset
+ structured_snippet_asset = 21;
+
+ // A sitelink asset.
+ google.ads.googleads.v13.common.SitelinkAsset sitelink_asset = 22;
+
+ // A page feed asset.
+ google.ads.googleads.v13.common.PageFeedAsset page_feed_asset = 23;
+
+ // A dynamic education asset.
+ google.ads.googleads.v13.common.DynamicEducationAsset
+ dynamic_education_asset = 24;
+
+ // A mobile app asset.
+ google.ads.googleads.v13.common.MobileAppAsset mobile_app_asset = 25;
+
+ // A hotel callout asset.
+ google.ads.googleads.v13.common.HotelCalloutAsset hotel_callout_asset = 26;
+
+ // A call asset.
+ google.ads.googleads.v13.common.CallAsset call_asset = 27;
+
+ // A price asset.
+ google.ads.googleads.v13.common.PriceAsset price_asset = 28;
+
+ // Immutable. A call to action asset.
+ google.ads.googleads.v13.common.CallToActionAsset call_to_action_asset = 29
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // A dynamic real estate asset.
+ google.ads.googleads.v13.common.DynamicRealEstateAsset
+ dynamic_real_estate_asset = 30;
+
+ // A dynamic custom asset.
+ google.ads.googleads.v13.common.DynamicCustomAsset dynamic_custom_asset =
+ 31;
+
+ // A dynamic hotels and rentals asset.
+ google.ads.googleads.v13.common.DynamicHotelsAndRentalsAsset
+ dynamic_hotels_and_rentals_asset = 32;
+
+ // A dynamic flights asset.
+ google.ads.googleads.v13.common.DynamicFlightsAsset dynamic_flights_asset =
+ 33;
+
+ // Immutable. A discovery carousel card asset.
+ google.ads.googleads.v13.common.DiscoveryCarouselCardAsset
+ discovery_carousel_card_asset = 34
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // A dynamic travel asset.
+ google.ads.googleads.v13.common.DynamicTravelAsset dynamic_travel_asset =
+ 35;
+
+ // A dynamic local asset.
+ google.ads.googleads.v13.common.DynamicLocalAsset dynamic_local_asset = 36;
+
+ // A dynamic jobs asset.
+ google.ads.googleads.v13.common.DynamicJobsAsset dynamic_jobs_asset = 37;
+
+ // Output only. A location asset.
+ google.ads.googleads.v13.common.LocationAsset location_asset = 39
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Immutable. A hotel property asset.
+ google.ads.googleads.v13.common.HotelPropertyAsset hotel_property_asset = 41
+ [(google.api.field_behavior) = IMMUTABLE];
+ }
+}
+
+// Contains policy information for an asset under AssetFieldType context.
+message AssetFieldTypePolicySummary {
+ // Output only. FieldType of this asset.
+ optional google.ads.googleads.v13.enums.AssetFieldTypeEnum.AssetFieldType
+ asset_field_type = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Source of this asset.
+ optional google.ads.googleads.v13.enums.AssetSourceEnum.AssetSource
+ asset_source = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Policy summary.
+ optional AssetPolicySummary policy_summary_info = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Contains policy information for an asset.
+message AssetPolicySummary {
+ // Output only. The list of policy findings for this asset.
+ repeated google.ads.googleads.v13.common.PolicyTopicEntry
+ policy_topic_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Where in the review process this asset is.
+ google.ads.googleads.v13.enums.PolicyReviewStatusEnum.PolicyReviewStatus
+ review_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The overall approval status of this asset, calculated based on
+ // the status of its individual policy topic entries.
+ google.ads.googleads.v13.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus
+ approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/asset_field_type_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/asset_field_type_view.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/resources/asset_field_type_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/asset_field_type_view.proto
index b9432b68e..9e5cc04f9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/asset_field_type_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/asset_field_type_view.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/asset_field_type.proto";
+import "google/ads/googleads/v13/enums/asset_field_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AssetFieldTypeViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the AssetFieldTypeView resource.
@@ -52,5 +52,6 @@ message AssetFieldTypeView {
];
// Output only. The asset field type of the asset field type view.
- google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType field_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AssetFieldTypeEnum.AssetFieldType field_type =
+ 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/asset_group.proto b/third_party/googleapis/google/ads/googleads/v13/resources/asset_group.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/resources/asset_group.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/asset_group.proto
index 8677cde98..ca8005b85 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/asset_group.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/asset_group.proto
@@ -14,20 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/asset_group_status.proto";
+import "google/ads/googleads/v13/enums/ad_strength.proto";
+import "google/ads/googleads/v13/enums/asset_group_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// An asset group.
// AssetGroupAsset is used to link an asset to the asset group.
@@ -61,8 +62,8 @@ message AssetGroup {
}
];
- // Required. Name of the asset group. Required. It must have a minimum length of 1 and
- // maximum length of 128. It must be unique under a campaign.
+ // Required. Name of the asset group. Required. It must have a minimum length
+ // of 1 and maximum length of 128. It must be unique under a campaign.
string name = 3 [(google.api.field_behavior) = REQUIRED];
// A list of final URLs after all cross domain redirects. In performance max,
@@ -75,7 +76,8 @@ message AssetGroup {
repeated string final_mobile_urls = 5;
// The status of the asset group.
- google.ads.googleads.v10.enums.AssetGroupStatusEnum.AssetGroupStatus status = 6;
+ google.ads.googleads.v13.enums.AssetGroupStatusEnum.AssetGroupStatus status =
+ 6;
// First part of text that may appear appended to the url displayed in
// the ad.
@@ -84,4 +86,8 @@ message AssetGroup {
// Second part of text that may appear appended to the url displayed in
// the ad. This field can only be set when path1 is set.
string path2 = 8;
+
+ // Output only. Overall ad strength of this asset group.
+ google.ads.googleads.v13.enums.AdStrengthEnum.AdStrength ad_strength = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/asset_group_asset.proto b/third_party/googleapis/google/ads/googleads/v13/resources/asset_group_asset.proto
similarity index 66%
rename from third_party/googleapis/google/ads/googleads/v10/resources/asset_group_asset.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/asset_group_asset.proto
index 6b47c38e0..c5d88dd60 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/asset_group_asset.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/asset_group_asset.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/policy_summary.proto";
-import "google/ads/googleads/v10/enums/asset_field_type.proto";
-import "google/ads/googleads/v10/enums/asset_link_status.proto";
-import "google/ads/googleads/v10/enums/asset_performance_label.proto";
+import "google/ads/googleads/v13/common/policy_summary.proto";
+import "google/ads/googleads/v13/enums/asset_field_type.proto";
+import "google/ads/googleads/v13/enums/asset_link_status.proto";
+import "google/ads/googleads/v13/enums/asset_performance_label.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupAssetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// AssetGroupAsset is the link between an asset and an asset group.
// Adding an AssetGroupAsset links an asset with an asset group.
@@ -62,21 +62,22 @@ message AssetGroupAsset {
// Immutable. The asset which this asset group asset is linking.
string asset = 3 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
];
- // The description of the placement of the asset within the asset group. E.g.:
- // HEADLINE, YOUTUBE_VIDEO etc
- google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType field_type = 4;
+ // The description of the placement of the asset within the asset group. For
+ // example: HEADLINE, YOUTUBE_VIDEO etc
+ google.ads.googleads.v13.enums.AssetFieldTypeEnum.AssetFieldType field_type =
+ 4;
// The status of the link between an asset and asset group.
- google.ads.googleads.v10.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
+ google.ads.googleads.v13.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
// Output only. The performance of this asset group asset.
- google.ads.googleads.v10.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel performance_label = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AssetPerformanceLabelEnum.AssetPerformanceLabel
+ performance_label = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The policy information for this asset group asset.
- google.ads.googleads.v10.common.PolicySummary policy_summary = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.PolicySummary policy_summary = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/asset_group_listing_group_filter.proto b/third_party/googleapis/google/ads/googleads/v13/resources/asset_group_listing_group_filter.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/resources/asset_group_listing_group_filter.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/asset_group_listing_group_filter.proto
index 27ede6262..611e09f94 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/asset_group_listing_group_filter.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/asset_group_listing_group_filter.proto
@@ -14,26 +14,26 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/enums/listing_group_filter_bidding_category_level.proto";
-import "google/ads/googleads/v10/enums/listing_group_filter_custom_attribute_index.proto";
-import "google/ads/googleads/v10/enums/listing_group_filter_product_channel.proto";
-import "google/ads/googleads/v10/enums/listing_group_filter_product_condition.proto";
-import "google/ads/googleads/v10/enums/listing_group_filter_product_type_level.proto";
-import "google/ads/googleads/v10/enums/listing_group_filter_type_enum.proto";
-import "google/ads/googleads/v10/enums/listing_group_filter_vertical.proto";
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/enums/listing_group_filter_bidding_category_level.proto";
+import "google/ads/googleads/v13/enums/listing_group_filter_custom_attribute_index.proto";
+import "google/ads/googleads/v13/enums/listing_group_filter_product_channel.proto";
+import "google/ads/googleads/v13/enums/listing_group_filter_product_condition.proto";
+import "google/ads/googleads/v13/enums/listing_group_filter_product_type_level.proto";
+import "google/ads/googleads/v13/enums/listing_group_filter_type_enum.proto";
+import "google/ads/googleads/v13/enums/listing_group_filter_vertical.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupListingGroupFilterProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// AssetGroupListingGroupFilter represents a listing group filter tree node in
// an asset group.
@@ -54,7 +54,8 @@ message AssetGroupListingGroupFilter {
}
];
- // Immutable. The asset group which this asset group listing group filter is part of.
+ // Immutable. The asset group which this asset group listing group filter is
+ // part of.
string asset_group = 2 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
@@ -66,18 +67,22 @@ message AssetGroupListingGroupFilter {
int64 id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. Type of a listing group filter node.
- google.ads.googleads.v10.enums.ListingGroupFilterTypeEnum.ListingGroupFilterType type = 4 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.ListingGroupFilterTypeEnum
+ .ListingGroupFilterType type = 4
+ [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The vertical the current node tree represents. All nodes in the same tree
- // must belong to the same vertical.
- google.ads.googleads.v10.enums.ListingGroupFilterVerticalEnum.ListingGroupFilterVertical vertical = 5 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. The vertical the current node tree represents. All nodes in the
+ // same tree must belong to the same vertical.
+ google.ads.googleads.v13.enums.ListingGroupFilterVerticalEnum
+ .ListingGroupFilterVertical vertical = 5
+ [(google.api.field_behavior) = IMMUTABLE];
// Dimension value with which this listing group is refining its parent.
// Undefined for the root group.
ListingGroupFilterDimension case_value = 6;
- // Immutable. Resource name of the parent listing group subdivision. Null for the root
- // listing group filter node.
+ // Immutable. Resource name of the parent listing group subdivision. Null for
+ // the root listing group filter node.
string parent_listing_group_filter = 7 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
@@ -101,7 +106,8 @@ message ListingGroupFilterDimension {
optional int64 id = 1;
// Indicates the level of the category in the taxonomy.
- google.ads.googleads.v10.enums.ListingGroupFilterBiddingCategoryLevelEnum.ListingGroupFilterBiddingCategoryLevel level = 2;
+ google.ads.googleads.v13.enums.ListingGroupFilterBiddingCategoryLevelEnum
+ .ListingGroupFilterBiddingCategoryLevel level = 2;
}
// Brand of the product.
@@ -113,13 +119,15 @@ message ListingGroupFilterDimension {
// Locality of a product offer.
message ProductChannel {
// Value of the locality.
- google.ads.googleads.v10.enums.ListingGroupFilterProductChannelEnum.ListingGroupFilterProductChannel channel = 1;
+ google.ads.googleads.v13.enums.ListingGroupFilterProductChannelEnum
+ .ListingGroupFilterProductChannel channel = 1;
}
// Condition of a product offer.
message ProductCondition {
// Value of the condition.
- google.ads.googleads.v10.enums.ListingGroupFilterProductConditionEnum.ListingGroupFilterProductCondition condition = 1;
+ google.ads.googleads.v13.enums.ListingGroupFilterProductConditionEnum
+ .ListingGroupFilterProductCondition condition = 1;
}
// Custom attribute of a product offer.
@@ -128,7 +136,8 @@ message ListingGroupFilterDimension {
optional string value = 1;
// Indicates the index of the custom attribute.
- google.ads.googleads.v10.enums.ListingGroupFilterCustomAttributeIndexEnum.ListingGroupFilterCustomAttributeIndex index = 2;
+ google.ads.googleads.v13.enums.ListingGroupFilterCustomAttributeIndexEnum
+ .ListingGroupFilterCustomAttributeIndex index = 2;
}
// Item id of a product offer.
@@ -143,7 +152,8 @@ message ListingGroupFilterDimension {
optional string value = 1;
// Level of the type.
- google.ads.googleads.v10.enums.ListingGroupFilterProductTypeLevelEnum.ListingGroupFilterProductTypeLevel level = 2;
+ google.ads.googleads.v13.enums.ListingGroupFilterProductTypeLevelEnum
+ .ListingGroupFilterProductTypeLevel level = 2;
}
// Dimension of one of the types below is always present.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/asset_group_product_group_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/asset_group_product_group_view.proto
similarity index 86%
rename from third_party/googleapis/google/ads/googleads/v10/resources/asset_group_product_group_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/asset_group_product_group_view.proto
index 9687deb0e..3d77de910 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/asset_group_product_group_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/asset_group_product_group_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupProductGroupViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the AssetGroupProductGroupView resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/asset_group_signal.proto b/third_party/googleapis/google/ads/googleads/v13/resources/asset_group_signal.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/resources/asset_group_signal.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/asset_group_signal.proto
index 693d74c41..63255ec97 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/asset_group_signal.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/asset_group_signal.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/criteria.proto";
+import "google/ads/googleads/v13/common/criteria.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupSignalProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// AssetGroupSignal represents a signal in an asset group. The existence of a
// signal tells the performance max campaign who's most likely to convert.
@@ -58,6 +58,8 @@ message AssetGroupSignal {
}
];
- // Immutable. The signal(audience criterion) to be used by the performance max campaign.
- google.ads.googleads.v10.common.AudienceInfo audience = 3 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. The signal(audience criterion) to be used by the performance max
+ // campaign.
+ google.ads.googleads.v13.common.AudienceInfo audience = 3
+ [(google.api.field_behavior) = IMMUTABLE];
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/asset_set.proto b/third_party/googleapis/google/ads/googleads/v13/resources/asset_set.proto
new file mode 100644
index 000000000..80b04f813
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/asset_set.proto
@@ -0,0 +1,122 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/asset_set_types.proto";
+import "google/ads/googleads/v13/enums/asset_set_status.proto";
+import "google/ads/googleads/v13/enums/asset_set_type.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "AssetSetProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// An asset set representing a collection of assets.
+// Use AssetSetAsset to link an asset to the asset set.
+message AssetSet {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/AssetSet"
+ pattern: "customers/{customer_id}/assetSets/{asset_set_id}"
+ };
+
+ // Merchant ID and Feed Label from Google Merchant Center.
+ message MerchantCenterFeed {
+ // Required. Merchant ID from Google Merchant Center
+ int64 merchant_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. Feed Label from Google Merchant Center.
+ optional string feed_label = 2 [(google.api.field_behavior) = OPTIONAL];
+ }
+
+ // For Performance Max for travel goals campaigns with a Hotel
+ // Center account link. Read-only.
+ message HotelPropertyData {
+ // Output only. The hotel center ID of the partner.
+ optional int64 hotel_center_id = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Name of the hotel partner.
+ optional string partner_name = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Output only. The ID of the asset set.
+ int64 id = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Immutable. The resource name of the asset set.
+ // Asset set resource names have the form:
+ //
+ // `customers/{customer_id}/assetSets/{asset_set_id}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AssetSet"
+ }
+ ];
+
+ // Required. Name of the asset set. Required. It must have a minimum length of
+ // 1 and maximum length of 128.
+ string name = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Immutable. The type of the asset set. Required.
+ google.ads.googleads.v13.enums.AssetSetTypeEnum.AssetSetType type = 3 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.field_behavior) = IMMUTABLE
+ ];
+
+ // Output only. The status of the asset set. Read-only.
+ google.ads.googleads.v13.enums.AssetSetStatusEnum.AssetSetStatus status = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Merchant ID and Feed Label from Google Merchant Center.
+ MerchantCenterFeed merchant_center_feed = 5;
+
+ // Immutable. Parent asset set id for the asset set where the elements of this
+ // asset set come from. For example: the sync level location AssetSet id where
+ // the the elements in LocationGroup AssetSet come from. This field is
+ // required and only applicable for Location Group typed AssetSet.
+ int64 location_group_parent_asset_set_id = 10
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Output only. For Performance Max for travel goals campaigns with a Hotel
+ // Center account link. Read-only.
+ HotelPropertyData hotel_property_data = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Asset set data specific to each asset set type. Not all types have specific
+ // data.
+ oneof asset_set_source {
+ // Location asset set data. This will be used for sync level location
+ // set. This can only be set if AssetSet's type is LOCATION_SYNC.
+ google.ads.googleads.v13.common.LocationSet location_set = 7;
+
+ // Business Profile location group asset set data.
+ google.ads.googleads.v13.common.BusinessProfileLocationGroup
+ business_profile_location_group = 8;
+
+ // Represents information about a Chain dynamic location group.
+ // Only applicable if the sync level AssetSet's type is LOCATION_SYNC and
+ // sync source is chain.
+ google.ads.googleads.v13.common.ChainLocationGroup chain_location_group = 9;
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/asset_set_asset.proto b/third_party/googleapis/google/ads/googleads/v13/resources/asset_set_asset.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/resources/asset_set_asset.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/asset_set_asset.proto
index 1a09c8333..25f54e8c7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/asset_set_asset.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/asset_set_asset.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/asset_set_asset_status.proto";
+import "google/ads/googleads/v13/enums/asset_set_asset_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AssetSetAssetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// AssetSetAsset is the link between an asset and an asset set.
// Adding an AssetSetAsset links an asset with an asset set.
@@ -59,11 +59,10 @@ message AssetSetAsset {
// Immutable. The asset which this asset set asset is linking to.
string asset = 3 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
];
// Output only. The status of the asset set asset. Read-only.
- google.ads.googleads.v10.enums.AssetSetAssetStatusEnum.AssetSetAssetStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AssetSetAssetStatusEnum.AssetSetAssetStatus
+ status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/asset_set_type_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/asset_set_type_view.proto
new file mode 100644
index 000000000..724d2dbe8
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/asset_set_type_view.proto
@@ -0,0 +1,58 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/enums/asset_set_type.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "AssetSetTypeViewProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the AssetSetTypeView resource.
+
+// An asset set type view.
+// This view reports non-overcounted metrics for each asset set type. Child
+// asset set types are not included in this report. Their stats are aggregated
+// under the parent asset set type.
+message AssetSetTypeView {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/AssetSetTypeView"
+ pattern: "customers/{customer_id}/assetSetTypeViews/{asset_set_type}"
+ };
+
+ // Output only. The resource name of the asset set type view.
+ // Asset set type view resource names have the form:
+ //
+ // `customers/{customer_id}/assetSetTypeViews/{asset_set_type}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AssetSetTypeView"
+ }
+ ];
+
+ // Output only. The asset set type of the asset set type view.
+ google.ads.googleads.v13.enums.AssetSetTypeEnum.AssetSetType asset_set_type =
+ 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/audience.proto b/third_party/googleapis/google/ads/googleads/v13/resources/audience.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/resources/audience.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/audience.proto
index 08065edca..d86d4be7b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/audience.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/audience.proto
@@ -14,25 +14,25 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/audiences.proto";
-import "google/ads/googleads/v10/enums/audience_status.proto";
+import "google/ads/googleads/v13/common/audiences.proto";
+import "google/ads/googleads/v13/enums/audience_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AudienceProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Audience resource.
-// Audience is an effective targeting option that allows you to
+// Audience is an effective targeting option that lets you
// intersect different segment attributes, such as detailed demographics and
// affinities, to create audiences that represent sections of your target
// segments.
@@ -58,7 +58,8 @@ message Audience {
// Output only. Status of this audience. Indicates whether the audience
// is enabled or removed.
- google.ads.googleads.v10.enums.AudienceStatusEnum.AudienceStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AudienceStatusEnum.AudienceStatus status = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Required. Name of the audience. It should be unique across all
// audiences. It must have a minimum length of 1 and
@@ -69,8 +70,9 @@ message Audience {
string description = 5;
// Positive dimensions specifying the audience composition.
- repeated google.ads.googleads.v10.common.AudienceDimension dimensions = 6;
+ repeated google.ads.googleads.v13.common.AudienceDimension dimensions = 6;
// Negative dimension specifying the audience composition.
- google.ads.googleads.v10.common.AudienceExclusionDimension exclusion_dimension = 7;
+ google.ads.googleads.v13.common.AudienceExclusionDimension
+ exclusion_dimension = 7;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/batch_job.proto b/third_party/googleapis/google/ads/googleads/v13/resources/batch_job.proto
similarity index 61%
rename from third_party/googleapis/google/ads/googleads/v10/resources/batch_job.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/batch_job.proto
index 4540b7276..1a5227f4f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/batch_job.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/batch_job.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/batch_job_status.proto";
+import "google/ads/googleads/v13/enums/batch_job_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "BatchJobProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the batch job resource.
@@ -45,26 +45,38 @@ message BatchJob {
message BatchJobMetadata {
// Output only. The time when this batch job was created.
// Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
- optional string creation_date_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string creation_date_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time when this batch job started running.
// Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
- optional string start_date_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string start_date_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time when this batch job was completed.
// Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
- optional string completion_date_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string completion_date_time = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The fraction (between 0.0 and 1.0) of mutates that have been processed.
- // This is empty if the job hasn't started running yet.
- optional double estimated_completion_ratio = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The fraction (between 0.0 and 1.0) of mutates that have been
+ // processed. This is empty if the job hasn't started running yet.
+ optional double estimated_completion_ratio = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The number of mutate operations in the batch job.
- optional int64 operation_count = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 operation_count = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The number of mutate operations executed by the batch job.
// Present only if the job has started running.
- optional int64 executed_operation_count = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 executed_operation_count = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Immutable. The approximate upper bound for how long a batch job can be
+ // executed, in seconds. If the job runs more than the given upper bound,
+ // the job will be canceled.
+ optional int32 execution_limit_seconds = 13
+ [(google.api.field_behavior) = IMMUTABLE];
}
// Immutable. The resource name of the batch job.
@@ -81,17 +93,21 @@ message BatchJob {
// Output only. ID of this batch job.
optional int64 id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The next sequence token to use when adding operations. Only set when the
- // batch job status is PENDING.
- optional string next_add_sequence_token = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The next sequence token to use when adding operations. Only
+ // set when the batch job status is PENDING.
+ optional string next_add_sequence_token = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Contains additional information about this batch job.
BatchJobMetadata metadata = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Status of this batch job.
- google.ads.googleads.v10.enums.BatchJobStatusEnum.BatchJobStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The resource name of the long-running operation that can be used to poll
- // for completion. Only set when the batch job status is RUNNING or DONE.
- optional string long_running_operation = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BatchJobStatusEnum.BatchJobStatus status = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The resource name of the long-running operation that can be
+ // used to poll for completion. Only set when the batch job status is RUNNING
+ // or DONE.
+ optional string long_running_operation = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/bidding_data_exclusion.proto b/third_party/googleapis/google/ads/googleads/v13/resources/bidding_data_exclusion.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/resources/bidding_data_exclusion.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/bidding_data_exclusion.proto
index 2d8903dd7..9b3d4f9b6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/bidding_data_exclusion.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/bidding_data_exclusion.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/advertising_channel_type.proto";
-import "google/ads/googleads/v10/enums/device.proto";
-import "google/ads/googleads/v10/enums/seasonality_event_scope.proto";
-import "google/ads/googleads/v10/enums/seasonality_event_status.proto";
+import "google/ads/googleads/v13/enums/advertising_channel_type.proto";
+import "google/ads/googleads/v13/enums/device.proto";
+import "google/ads/googleads/v13/enums/seasonality_event_scope.proto";
+import "google/ads/googleads/v13/enums/seasonality_event_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "BiddingDataExclusionProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Represents a bidding data exclusion.
//
@@ -57,19 +57,23 @@ message BiddingDataExclusion {
int64 data_exclusion_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// The scope of the data exclusion.
- google.ads.googleads.v10.enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3;
+ google.ads.googleads.v13.enums.SeasonalityEventScopeEnum.SeasonalityEventScope
+ scope = 3;
// Output only. The status of the data exclusion.
- google.ads.googleads.v10.enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SeasonalityEventStatusEnum
+ .SeasonalityEventStatus status = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. The inclusive start time of the data exclusion in yyyy-MM-dd HH:mm:ss
- // format.
+ // Required. The inclusive start time of the data exclusion in yyyy-MM-dd
+ // HH:mm:ss format.
//
// A data exclusion is backward looking and should be used for events that
// start in the past and end either in the past or future.
string start_date_time = 5 [(google.api.field_behavior) = REQUIRED];
- // Required. The exclusive end time of the data exclusion in yyyy-MM-dd HH:mm:ss format.
+ // Required. The exclusive end time of the data exclusion in yyyy-MM-dd
+ // HH:mm:ss format.
//
// The length of [start_date_time, end_date_time) interval must be
// within (0, 14 days].
@@ -86,7 +90,7 @@ message BiddingDataExclusion {
// If not specified, all devices will be included in this exclusion.
// Otherwise, only the specified targeted devices will be included in this
// exclusion.
- repeated google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
+ repeated google.ads.googleads.v13.enums.DeviceEnum.Device devices = 9;
// The data exclusion will apply to the campaigns listed when the scope of
// this exclusion is CAMPAIGN. The maximum number of campaigns per event is
@@ -94,8 +98,8 @@ message BiddingDataExclusion {
// Note: a data exclusion with both advertising_channel_types and
// campaign_ids is not supported.
repeated string campaigns = 10 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Campaign"
- }];
+ type: "googleads.googleapis.com/Campaign"
+ }];
// The data_exclusion will apply to all the campaigns under the listed
// channels retroactively as well as going forward when the scope of this
@@ -103,5 +107,6 @@ message BiddingDataExclusion {
// The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
// Note: a data exclusion with both advertising_channel_types and
// campaign_ids is not supported.
- repeated google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 11;
+ repeated google.ads.googleads.v13.enums.AdvertisingChannelTypeEnum
+ .AdvertisingChannelType advertising_channel_types = 11;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/bidding_seasonality_adjustment.proto b/third_party/googleapis/google/ads/googleads/v13/resources/bidding_seasonality_adjustment.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/resources/bidding_seasonality_adjustment.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/bidding_seasonality_adjustment.proto
index ecc9b6dc3..ab43750b2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/bidding_seasonality_adjustment.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/bidding_seasonality_adjustment.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/advertising_channel_type.proto";
-import "google/ads/googleads/v10/enums/device.proto";
-import "google/ads/googleads/v10/enums/seasonality_event_scope.proto";
-import "google/ads/googleads/v10/enums/seasonality_event_status.proto";
+import "google/ads/googleads/v13/enums/advertising_channel_type.proto";
+import "google/ads/googleads/v13/enums/device.proto";
+import "google/ads/googleads/v13/enums/seasonality_event_scope.proto";
+import "google/ads/googleads/v13/enums/seasonality_event_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "BiddingSeasonalityAdjustmentProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Represents a bidding seasonality adjustment.
//
@@ -54,23 +54,27 @@ message BiddingSeasonalityAdjustment {
];
// Output only. The ID of the seasonality adjustment.
- int64 seasonality_adjustment_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ int64 seasonality_adjustment_id = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The scope of the seasonality adjustment.
- google.ads.googleads.v10.enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3;
+ google.ads.googleads.v13.enums.SeasonalityEventScopeEnum.SeasonalityEventScope
+ scope = 3;
// Output only. The status of the seasonality adjustment.
- google.ads.googleads.v10.enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SeasonalityEventStatusEnum
+ .SeasonalityEventStatus status = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd
- // HH:mm:ss format.
+ // Required. The inclusive start time of the seasonality adjustment in
+ // yyyy-MM-dd HH:mm:ss format.
//
// A seasonality adjustment is forward looking and should be used for events
// that start and end in the future.
string start_date_time = 5 [(google.api.field_behavior) = REQUIRED];
- // Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss
- // format.
+ // Required. The exclusive end time of the seasonality adjustment in
+ // yyyy-MM-dd HH:mm:ss format.
//
// The length of [start_date_time, end_date_time) interval must be
// within (0, 14 days].
@@ -87,7 +91,7 @@ message BiddingSeasonalityAdjustment {
// If not specified, all devices will be included in this adjustment.
// Otherwise, only the specified targeted devices will be included in this
// adjustment.
- repeated google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
+ repeated google.ads.googleads.v13.enums.DeviceEnum.Device devices = 9;
// Conversion rate modifier estimated based on expected conversion rate
// changes. When this field is unset or set to 1.0 no adjustment will be
@@ -100,8 +104,8 @@ message BiddingSeasonalityAdjustment {
// Note: a seasonality adjustment with both advertising_channel_types and
// campaign_ids is not supported.
repeated string campaigns = 11 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Campaign"
- }];
+ type: "googleads.googleapis.com/Campaign"
+ }];
// The seasonality adjustment will apply to all the campaigns under the listed
// channels retroactively as well as going forward when the scope of this
@@ -109,5 +113,6 @@ message BiddingSeasonalityAdjustment {
// The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
// Note: a seasonality adjustment with both advertising_channel_types and
// campaign_ids is not supported.
- repeated google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
+ repeated google.ads.googleads.v13.enums.AdvertisingChannelTypeEnum
+ .AdvertisingChannelType advertising_channel_types = 12;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/bidding_strategy.proto b/third_party/googleapis/google/ads/googleads/v13/resources/bidding_strategy.proto
similarity index 66%
rename from third_party/googleapis/google/ads/googleads/v10/resources/bidding_strategy.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/bidding_strategy.proto
index 9fa73b315..2a374fbec 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/bidding_strategy.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/bidding_strategy.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/bidding.proto";
-import "google/ads/googleads/v10/enums/bidding_strategy_status.proto";
-import "google/ads/googleads/v10/enums/bidding_strategy_type.proto";
+import "google/ads/googleads/v13/common/bidding.proto";
+import "google/ads/googleads/v13/enums/bidding_strategy_status.proto";
+import "google/ads/googleads/v13/enums/bidding_strategy_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "BiddingStrategyProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the BiddingStrategy resource
@@ -64,15 +64,18 @@ message BiddingStrategy {
// Output only. The status of the bidding strategy.
//
// This field is read-only.
- google.ads.googleads.v10.enums.BiddingStrategyStatusEnum.BiddingStrategyStatus status = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BiddingStrategyStatusEnum.BiddingStrategyStatus
+ status = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The type of the bidding strategy.
// Create a bidding strategy by setting the bidding scheme.
//
// This field is read-only.
- google.ads.googleads.v10.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BiddingStrategyTypeEnum.BiddingStrategyType
+ type = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code).
+ // Immutable. The currency used by the bidding strategy (ISO 4217 three-letter
+ // code).
//
// For bidding strategies in manager customers, this currency can be set on
// creation and defaults to the manager customer's currency. For serving
@@ -81,7 +84,8 @@ message BiddingStrategy {
// effective_currency_code field returns the currency used by the strategy.
string currency_code = 23 [(google.api.field_behavior) = IMMUTABLE];
- // Output only. The currency used by the bidding strategy (ISO 4217 three-letter code).
+ // Output only. The currency used by the bidding strategy (ISO 4217
+ // three-letter code).
//
// For bidding strategies in manager customers, this is the currency set by
// the advertiser when creating the strategy. For serving customers, this is
@@ -90,17 +94,28 @@ message BiddingStrategy {
// Bidding strategy metrics are reported in this currency.
//
// This field is read-only.
- optional string effective_currency_code = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string effective_currency_code = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // ID of the campaign budget that this portfolio bidding strategy
+ // is aligned with. When a portfolio and a campaign budget are aligned, that
+ // means that they are attached to the same set of campaigns. After a bidding
+ // strategy is aligned with a campaign budget, campaigns that are added to the
+ // bidding strategy must also use the aligned campaign budget.
+ int64 aligned_campaign_budget_id = 25;
// Output only. The number of campaigns attached to this bidding strategy.
//
// This field is read-only.
- optional int64 campaign_count = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 campaign_count = 18
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The number of non-removed campaigns attached to this bidding strategy.
+ // Output only. The number of non-removed campaigns attached to this bidding
+ // strategy.
//
// This field is read-only.
- optional int64 non_removed_campaign_count = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 non_removed_campaign_count = 19
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The bidding scheme.
//
@@ -109,30 +124,33 @@ message BiddingStrategy {
// A bidding strategy that raises bids for clicks that seem more likely to
// lead to a conversion and lowers them for clicks where they seem less
// likely.
- google.ads.googleads.v10.common.EnhancedCpc enhanced_cpc = 7;
+ google.ads.googleads.v13.common.EnhancedCpc enhanced_cpc = 7;
// An automated bidding strategy to help get the most conversion value for
// your campaigns while spending your budget.
- google.ads.googleads.v10.common.MaximizeConversionValue maximize_conversion_value = 21;
+ google.ads.googleads.v13.common.MaximizeConversionValue
+ maximize_conversion_value = 21;
// An automated bidding strategy to help get the most conversions for your
// campaigns while spending your budget.
- google.ads.googleads.v10.common.MaximizeConversions maximize_conversions = 22;
+ google.ads.googleads.v13.common.MaximizeConversions maximize_conversions =
+ 22;
// A bidding strategy that sets bids to help get as many conversions as
// possible at the target cost-per-acquisition (CPA) you set.
- google.ads.googleads.v10.common.TargetCpa target_cpa = 9;
+ google.ads.googleads.v13.common.TargetCpa target_cpa = 9;
- // A bidding strategy that automatically optimizes towards a desired
+ // A bidding strategy that automatically optimizes towards a chosen
// percentage of impressions.
- google.ads.googleads.v10.common.TargetImpressionShare target_impression_share = 48;
+ google.ads.googleads.v13.common.TargetImpressionShare
+ target_impression_share = 48;
// A bidding strategy that helps you maximize revenue while averaging a
// specific target Return On Ad Spend (ROAS).
- google.ads.googleads.v10.common.TargetRoas target_roas = 11;
+ google.ads.googleads.v13.common.TargetRoas target_roas = 11;
// A bid strategy that sets your bids to help get as many clicks as
// possible within your budget.
- google.ads.googleads.v10.common.TargetSpend target_spend = 12;
+ google.ads.googleads.v13.common.TargetSpend target_spend = 12;
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/bidding_strategy_simulation.proto b/third_party/googleapis/google/ads/googleads/v13/resources/bidding_strategy_simulation.proto
similarity index 69%
rename from third_party/googleapis/google/ads/googleads/v10/resources/bidding_strategy_simulation.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/bidding_strategy_simulation.proto
index 3726d607d..290636d7d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/bidding_strategy_simulation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/bidding_strategy_simulation.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/simulation.proto";
-import "google/ads/googleads/v10/enums/simulation_modification_method.proto";
-import "google/ads/googleads/v10/enums/simulation_type.proto";
+import "google/ads/googleads/v13/common/simulation.proto";
+import "google/ads/googleads/v13/enums/simulation_modification_method.proto";
+import "google/ads/googleads/v13/enums/simulation_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "BiddingStrategySimulationProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the bidding strategy simulation resource.
@@ -59,23 +59,30 @@ message BiddingStrategySimulation {
int64 bidding_strategy_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The field that the simulation modifies.
- google.ads.googleads.v10.enums.SimulationTypeEnum.SimulationType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SimulationTypeEnum.SimulationType type = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. How the simulation modifies the field.
- google.ads.googleads.v10.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SimulationModificationMethodEnum
+ .SimulationModificationMethod modification_method = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. First day on which the simulation is based, in YYYY-MM-DD format.
+ // Output only. First day on which the simulation is based, in YYYY-MM-DD
+ // format.
string start_date = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Last day on which the simulation is based, in YYYY-MM-DD format
+ // Output only. Last day on which the simulation is based, in YYYY-MM-DD
+ // format
string end_date = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// List of simulation points.
oneof point_list {
// Output only. Simulation points if the simulation type is TARGET_CPA.
- google.ads.googleads.v10.common.TargetCpaSimulationPointList target_cpa_point_list = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.TargetCpaSimulationPointList
+ target_cpa_point_list = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Simulation points if the simulation type is TARGET_ROAS.
- google.ads.googleads.v10.common.TargetRoasSimulationPointList target_roas_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.TargetRoasSimulationPointList
+ target_roas_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/billing_setup.proto b/third_party/googleapis/google/ads/googleads/v13/resources/billing_setup.proto
similarity index 63%
rename from third_party/googleapis/google/ads/googleads/v10/resources/billing_setup.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/billing_setup.proto
index e664760b8..ba95c9314 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/billing_setup.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/billing_setup.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/billing_setup_status.proto";
-import "google/ads/googleads/v10/enums/time_type.proto";
+import "google/ads/googleads/v13/enums/billing_setup_status.proto";
+import "google/ads/googleads/v13/enums/time_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "BillingSetupProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the BillingSetup resource.
@@ -42,32 +42,42 @@ message BillingSetup {
// Container of payments account information for this billing.
message PaymentsAccountInfo {
- // Output only. A 16 digit id used to identify the payments account associated with the
- // billing setup.
+ // Output only. A 16 digit id used to identify the payments account
+ // associated with the billing setup.
//
- // This must be passed as a string with dashes, e.g. "1234-5678-9012-3456".
- optional string payments_account_id = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // This must be passed as a string with dashes, for example,
+ // "1234-5678-9012-3456".
+ optional string payments_account_id = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. The name of the payments account associated with the billing setup.
+ // Immutable. The name of the payments account associated with the billing
+ // setup.
//
// This enables the user to specify a meaningful name for a payments account
// to aid in reconciling monthly invoices.
//
// This name will be printed in the monthly invoices.
- optional string payments_account_name = 7 [(google.api.field_behavior) = IMMUTABLE];
+ optional string payments_account_name = 7
+ [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. A 12 digit id used to identify the payments profile associated with the
- // billing setup.
+ // Immutable. A 12 digit id used to identify the payments profile associated
+ // with the billing setup.
//
- // This must be passed in as a string with dashes, e.g. "1234-5678-9012".
- optional string payments_profile_id = 8 [(google.api.field_behavior) = IMMUTABLE];
-
- // Output only. The name of the payments profile associated with the billing setup.
- optional string payments_profile_name = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. A secondary payments profile id present in uncommon situations, e.g.
- // when a sequential liability agreement has been arranged.
- optional string secondary_payments_profile_id = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // This must be passed in as a string with dashes, for example,
+ // "1234-5678-9012".
+ optional string payments_profile_id = 8
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Output only. The name of the payments profile associated with the billing
+ // setup.
+ optional string payments_profile_name = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. A secondary payments profile id present in uncommon
+ // situations, for example, when a sequential liability agreement has been
+ // arranged.
+ optional string secondary_payments_profile_id = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Immutable. The resource name of the billing setup.
@@ -85,10 +95,11 @@ message BillingSetup {
optional int64 id = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The status of the billing setup.
- google.ads.googleads.v10.enums.BillingSetupStatusEnum.BillingSetupStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BillingSetupStatusEnum.BillingSetupStatus
+ status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. The resource name of the payments account associated with this billing
- // setup. Payments resource names have the form:
+ // Immutable. The resource name of the payments account associated with this
+ // billing setup. Payments resource names have the form:
//
// `customers/{customer_id}/paymentsAccounts/{payments_account_id}`
// When setting up billing, this is used to signup with an existing payments
@@ -102,12 +113,12 @@ message BillingSetup {
}
];
- // Immutable. The payments account information associated with this billing setup.
- // When setting up billing, this is used to signup with a new payments account
- // (and then payments_account should not be set).
- // When getting a billing setup, this and payments_account will be
- // populated.
- PaymentsAccountInfo payments_account_info = 12 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. The payments account information associated with this billing
+ // setup. When setting up billing, this is used to signup with a new payments
+ // account (and then payments_account should not be set). When getting a
+ // billing setup, this and payments_account will be populated.
+ PaymentsAccountInfo payments_account_info = 12
+ [(google.api.field_behavior) = IMMUTABLE];
// When creating a new billing setup, this is when the setup should take
// effect. NOW is the only acceptable start time if the customer doesn't have
@@ -117,21 +128,24 @@ message BillingSetup {
// However, if the setup was approved (see status) after the requested start
// time, then this is the approval time.
oneof start_time {
- // Immutable. The start date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format. Only a
- // future time is allowed.
+ // Immutable. The start date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss
+ // format. Only a future time is allowed.
string start_date_time = 16 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. The start time as a type. Only NOW is allowed.
- google.ads.googleads.v10.enums.TimeTypeEnum.TimeType start_time_type = 10 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.TimeTypeEnum.TimeType start_time_type = 10
+ [(google.api.field_behavior) = IMMUTABLE];
}
// When the billing setup ends / ended. This is either FOREVER or the start
// time of the next scheduled billing setup.
oneof end_time {
- // Output only. The end date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format.
+ // Output only. The end date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss
+ // format.
string end_date_time = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The end time as a type. The only possible value is FOREVER.
- google.ads.googleads.v10.enums.TimeTypeEnum.TimeType end_time_type = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.TimeTypeEnum.TimeType end_time_type = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/call_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/call_view.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/resources/call_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/call_view.proto
index b64371d25..378b3e88c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/call_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/call_view.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/call_tracking_display_location.proto";
-import "google/ads/googleads/v10/enums/call_type.proto";
-import "google/ads/googleads/v10/enums/google_voice_call_status.proto";
+import "google/ads/googleads/v13/enums/call_tracking_display_location.proto";
+import "google/ads/googleads/v13/enums/call_type.proto";
+import "google/ads/googleads/v13/enums/google_voice_call_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CallViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the call view resource.
@@ -55,8 +55,8 @@ message CallView {
// Output only. Country code of the caller.
string caller_country_code = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Area code of the caller. Null if the call duration is shorter than 15
- // seconds.
+ // Output only. Area code of the caller. Null if the call duration is shorter
+ // than 15 seconds.
string caller_area_code = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The advertiser-provided call duration in seconds.
@@ -69,11 +69,15 @@ message CallView {
string end_call_date_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The call tracking display location.
- google.ads.googleads.v10.enums.CallTrackingDisplayLocationEnum.CallTrackingDisplayLocation call_tracking_display_location = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CallTrackingDisplayLocationEnum
+ .CallTrackingDisplayLocation call_tracking_display_location = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The type of the call.
- google.ads.googleads.v10.enums.CallTypeEnum.CallType type = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CallTypeEnum.CallType type = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The status of the call.
- google.ads.googleads.v10.enums.GoogleVoiceCallStatusEnum.GoogleVoiceCallStatus call_status = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.GoogleVoiceCallStatusEnum.GoogleVoiceCallStatus
+ call_status = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign.proto
similarity index 52%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign.proto
index a0970bca9..79e1ef734 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign.proto
@@ -14,42 +14,47 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/bidding.proto";
-import "google/ads/googleads/v10/common/custom_parameter.proto";
-import "google/ads/googleads/v10/common/frequency_cap.proto";
-import "google/ads/googleads/v10/common/real_time_bidding_setting.proto";
-import "google/ads/googleads/v10/common/targeting_setting.proto";
-import "google/ads/googleads/v10/enums/ad_serving_optimization_status.proto";
-import "google/ads/googleads/v10/enums/advertising_channel_sub_type.proto";
-import "google/ads/googleads/v10/enums/advertising_channel_type.proto";
-import "google/ads/googleads/v10/enums/app_campaign_app_store.proto";
-import "google/ads/googleads/v10/enums/app_campaign_bidding_strategy_goal_type.proto";
-import "google/ads/googleads/v10/enums/asset_field_type.proto";
-import "google/ads/googleads/v10/enums/bidding_strategy_type.proto";
-import "google/ads/googleads/v10/enums/brand_safety_suitability.proto";
-import "google/ads/googleads/v10/enums/campaign_experiment_type.proto";
-import "google/ads/googleads/v10/enums/campaign_serving_status.proto";
-import "google/ads/googleads/v10/enums/campaign_status.proto";
-import "google/ads/googleads/v10/enums/location_source_type.proto";
-import "google/ads/googleads/v10/enums/negative_geo_target_type.proto";
-import "google/ads/googleads/v10/enums/optimization_goal_type.proto";
-import "google/ads/googleads/v10/enums/payment_mode.proto";
-import "google/ads/googleads/v10/enums/positive_geo_target_type.proto";
-import "google/ads/googleads/v10/enums/vanity_pharma_display_url_mode.proto";
-import "google/ads/googleads/v10/enums/vanity_pharma_text.proto";
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/bidding.proto";
+import "google/ads/googleads/v13/common/custom_parameter.proto";
+import "google/ads/googleads/v13/common/frequency_cap.proto";
+import "google/ads/googleads/v13/common/real_time_bidding_setting.proto";
+import "google/ads/googleads/v13/common/targeting_setting.proto";
+import "google/ads/googleads/v13/enums/ad_serving_optimization_status.proto";
+import "google/ads/googleads/v13/enums/advertising_channel_sub_type.proto";
+import "google/ads/googleads/v13/enums/advertising_channel_type.proto";
+import "google/ads/googleads/v13/enums/app_campaign_app_store.proto";
+import "google/ads/googleads/v13/enums/app_campaign_bidding_strategy_goal_type.proto";
+import "google/ads/googleads/v13/enums/asset_field_type.proto";
+import "google/ads/googleads/v13/enums/asset_set_type.proto";
+import "google/ads/googleads/v13/enums/bidding_strategy_system_status.proto";
+import "google/ads/googleads/v13/enums/bidding_strategy_type.proto";
+import "google/ads/googleads/v13/enums/brand_safety_suitability.proto";
+import "google/ads/googleads/v13/enums/campaign_experiment_type.proto";
+import "google/ads/googleads/v13/enums/campaign_primary_status.proto";
+import "google/ads/googleads/v13/enums/campaign_primary_status_reason.proto";
+import "google/ads/googleads/v13/enums/campaign_serving_status.proto";
+import "google/ads/googleads/v13/enums/campaign_status.proto";
+import "google/ads/googleads/v13/enums/location_source_type.proto";
+import "google/ads/googleads/v13/enums/negative_geo_target_type.proto";
+import "google/ads/googleads/v13/enums/optimization_goal_type.proto";
+import "google/ads/googleads/v13/enums/payment_mode.proto";
+import "google/ads/googleads/v13/enums/performance_max_upgrade_status.proto";
+import "google/ads/googleads/v13/enums/positive_geo_target_type.proto";
+import "google/ads/googleads/v13/enums/vanity_pharma_display_url_mode.proto";
+import "google/ads/googleads/v13/enums/vanity_pharma_text.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Campaign resource.
@@ -60,6 +65,32 @@ message Campaign {
pattern: "customers/{customer_id}/campaigns/{campaign_id}"
};
+ // Information about a campaign being upgraded to Performance Max.
+ message PerformanceMaxUpgrade {
+ // Output only. Indicates which Performance Max campaign the campaign is
+ // upgraded to.
+ string performance_max_campaign = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/Campaign"
+ }
+ ];
+
+ // Output only. Indicates legacy campaign upgraded to Performance Max.
+ string pre_upgrade_campaign = 2 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/Campaign"
+ }
+ ];
+
+ // Output only. The upgrade status of a campaign requested to be upgraded to
+ // Performance Max.
+ google.ads.googleads.v13.enums.PerformanceMaxUpgradeStatusEnum
+ .PerformanceMaxUpgradeStatus status = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
// The network settings for the campaign.
message NetworkSettings {
// Whether ads will be served with google.com search results.
@@ -81,16 +112,18 @@ message Campaign {
// Campaign-level settings for hotel ads.
message HotelSettingInfo {
// Immutable. The linked Hotel Center account.
- optional int64 hotel_center_id = 2 [(google.api.field_behavior) = IMMUTABLE];
+ optional int64 hotel_center_id = 2
+ [(google.api.field_behavior) = IMMUTABLE];
}
// The setting for controlling Dynamic Search Ads (DSA).
message DynamicSearchAdsSetting {
- // Required. The Internet domain name that this setting represents, e.g., "google.com"
- // or "www.google.com".
+ // Required. The Internet domain name that this setting represents, for
+ // example, "google.com" or "www.google.com".
string domain_name = 6 [(google.api.field_behavior) = REQUIRED];
- // Required. The language code specifying the language of the domain, e.g., "en".
+ // Required. The language code specifying the language of the domain, for
+ // example, "en".
string language_code = 7 [(google.api.field_behavior) = REQUIRED];
// Whether the campaign uses advertiser supplied URLs exclusively.
@@ -98,8 +131,8 @@ message Campaign {
// The list of page feeds associated with the campaign.
repeated string feeds = 9 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }];
+ type: "googleads.googleapis.com/Feed"
+ }];
}
// The setting for Shopping campaigns. Defines the universe of products that
@@ -112,11 +145,20 @@ message Campaign {
optional int64 merchant_id = 5 [(google.api.field_behavior) = IMMUTABLE];
// Sales country of products to include in the campaign.
- // This field is required for Shopping campaigns.
- // This field is optional for non-Shopping campaigns, but it must be equal
- // to 'ZZ' if set.
+ // Only one of feed_label or sales_country can be set.
+ // Field is immutable except for clearing.
+ // Once this field is cleared, you must use feed_label if you
+ // want to set the sales country.
optional string sales_country = 6;
+ // Feed label of products to include in the campaign.
+ // Only one of feed_label or sales_country can be set.
+ // If used instead of sales_country, the feed_label field accepts country
+ // codes in the same format for example: 'XX'.
+ // Otherwise can be any string used for feed label in Google Merchant
+ // Center.
+ string feed_label = 10;
+
// Priority of the campaign. Campaigns with numerically higher priorities
// take precedence over those with lower priorities.
// This field is required for Shopping campaigns, with values between 0 and
@@ -135,45 +177,53 @@ message Campaign {
// Campaign-level settings for tracking information.
message TrackingSetting {
// Output only. The url used for dynamic tracking.
- optional string tracking_url = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string tracking_url = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Represents a collection of settings related to ads geotargeting.
message GeoTargetTypeSetting {
// The setting used for positive geotargeting in this particular campaign.
- google.ads.googleads.v10.enums.PositiveGeoTargetTypeEnum.PositiveGeoTargetType positive_geo_target_type = 1;
+ google.ads.googleads.v13.enums.PositiveGeoTargetTypeEnum
+ .PositiveGeoTargetType positive_geo_target_type = 1;
// The setting used for negative geotargeting in this particular campaign.
- google.ads.googleads.v10.enums.NegativeGeoTargetTypeEnum.NegativeGeoTargetType negative_geo_target_type = 2;
+ google.ads.googleads.v13.enums.NegativeGeoTargetTypeEnum
+ .NegativeGeoTargetType negative_geo_target_type = 2;
}
// Campaign setting for local campaigns.
message LocalCampaignSetting {
// The location source type for this local campaign.
- google.ads.googleads.v10.enums.LocationSourceTypeEnum.LocationSourceType location_source_type = 1;
+ google.ads.googleads.v13.enums.LocationSourceTypeEnum.LocationSourceType
+ location_source_type = 1;
}
// Campaign-level settings for App Campaigns.
message AppCampaignSetting {
// Represents the goal which the bidding strategy of this app campaign
// should optimize towards.
- google.ads.googleads.v10.enums.AppCampaignBiddingStrategyGoalTypeEnum.AppCampaignBiddingStrategyGoalType bidding_strategy_goal_type = 1;
+ google.ads.googleads.v13.enums.AppCampaignBiddingStrategyGoalTypeEnum
+ .AppCampaignBiddingStrategyGoalType bidding_strategy_goal_type = 1;
// Immutable. A string that uniquely identifies a mobile application.
optional string app_id = 4 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. The application store that distributes this specific app.
- google.ads.googleads.v10.enums.AppCampaignAppStoreEnum.AppCampaignAppStore app_store = 3 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.AppCampaignAppStoreEnum.AppCampaignAppStore
+ app_store = 3 [(google.api.field_behavior) = IMMUTABLE];
}
// Describes how unbranded pharma ads will be displayed.
message VanityPharma {
// The display mode for vanity pharma URLs.
- google.ads.googleads.v10.enums.VanityPharmaDisplayUrlModeEnum.VanityPharmaDisplayUrlMode vanity_pharma_display_url_mode = 1;
+ google.ads.googleads.v13.enums.VanityPharmaDisplayUrlModeEnum
+ .VanityPharmaDisplayUrlMode vanity_pharma_display_url_mode = 1;
// The text that will be displayed in display URL of the text ad when
// website description is the selected display mode for vanity pharma URLs.
- google.ads.googleads.v10.enums.VanityPharmaTextEnum.VanityPharmaText vanity_pharma_text = 2;
+ google.ads.googleads.v13.enums.VanityPharmaTextEnum.VanityPharmaText
+ vanity_pharma_text = 2;
}
// Selective optimization setting for this campaign, which includes a set of
@@ -181,22 +231,50 @@ message Campaign {
message SelectiveOptimization {
// The selected set of conversion actions for optimizing this campaign.
repeated string conversion_actions = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionAction"
- }];
+ type: "googleads.googleapis.com/ConversionAction"
+ }];
}
// Optimization goal setting for this campaign, which includes a set of
// optimization goal types.
message OptimizationGoalSetting {
// The list of optimization goal types.
- repeated google.ads.googleads.v10.enums.OptimizationGoalTypeEnum.OptimizationGoalType optimization_goal_types = 1;
+ repeated google.ads.googleads.v13.enums.OptimizationGoalTypeEnum
+ .OptimizationGoalType optimization_goal_types = 1;
}
// Settings for the audience targeting.
message AudienceSetting {
- // Immutable. If true, this campaign uses an Audience resource for audience targeting.
- // If false, this campaign may use audience segment criteria instead.
- optional bool use_audience_grouped = 1 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. If true, this campaign uses an Audience resource for audience
+ // targeting. If false, this campaign may use audience segment criteria
+ // instead.
+ optional bool use_audience_grouped = 1
+ [(google.api.field_behavior) = IMMUTABLE];
+ }
+
+ // Settings for LocalServicesCampaign subresource.
+ message LocalServicesCampaignSettings {
+ // Categorical level bids associated with MANUAL_CPA bidding strategy.
+ repeated CategoryBid category_bids = 1;
+ }
+
+ // Category bids in LocalServicesReportingCampaignSettings.
+ message CategoryBid {
+ // Category for which the bid will be associated with. For example,
+ // xcat:service_area_business_plumber.
+ optional string category_id = 1;
+
+ // Manual CPA bid for the category. Bid must be greater than the
+ // reserve price associated for that category. Value is in micros
+ // and in the advertiser's currency.
+ optional int64 manual_cpa_bid_micros = 2;
+ }
+
+ // Settings for Travel campaign.
+ message TravelCampaignSettings {
+ // Immutable. The Travel account ID associated with the Travel campaign.
+ optional int64 travel_account_id = 1
+ [(google.api.field_behavior) = IMMUTABLE];
}
// Immutable. The resource name of the campaign.
@@ -222,16 +300,40 @@ message Campaign {
// (code point 0xA) or carriage return (code point 0xD) characters.
optional string name = 58;
+ // Output only. The primary status of the campaign.
+ //
+ // Provides insight into why a campaign is not serving or not serving
+ // optimally. Modification to the campaign and its related entities might take
+ // a while to be reflected in this status.
+ google.ads.googleads.v13.enums.CampaignPrimaryStatusEnum.CampaignPrimaryStatus
+ primary_status = 81 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The primary status reasons of the campaign.
+ //
+ // Provides insight into why a campaign is not serving or not serving
+ // optimally. These reasons are aggregated to determine an overall
+ // CampaignPrimaryStatus.
+ repeated google.ads.googleads.v13.enums.CampaignPrimaryStatusReasonEnum
+ .CampaignPrimaryStatusReason primary_status_reasons = 82
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
// The status of the campaign.
//
// When a new campaign is added, the status defaults to ENABLED.
- google.ads.googleads.v10.enums.CampaignStatusEnum.CampaignStatus status = 5;
+ google.ads.googleads.v13.enums.CampaignStatusEnum.CampaignStatus status = 5;
// Output only. The ad serving status of the campaign.
- google.ads.googleads.v10.enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CampaignServingStatusEnum.CampaignServingStatus
+ serving_status = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The system status of the campaign's bidding strategy.
+ google.ads.googleads.v13.enums.BiddingStrategySystemStatusEnum
+ .BiddingStrategySystemStatus bidding_strategy_system_status = 78
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The ad serving optimization status of the campaign.
- google.ads.googleads.v10.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8;
+ google.ads.googleads.v13.enums.AdServingOptimizationStatusEnum
+ .AdServingOptimizationStatus ad_serving_optimization_status = 8;
// Immutable. The primary serving target for ads within the campaign.
// The targeting options can be refined in `network_settings`.
@@ -241,25 +343,37 @@ message Campaign {
//
// Can be set only when creating campaigns.
// After the campaign is created, the field can not be changed.
- google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.AdvertisingChannelTypeEnum
+ .AdvertisingChannelType advertising_channel_type = 9
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Optional refinement to `advertising_channel_type`.
// Must be a valid sub-type of the parent channel type.
//
// Can be set only when creating campaigns.
// After campaign is created, the field can not be changed.
- google.ads.googleads.v10.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 10 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.AdvertisingChannelSubTypeEnum
+ .AdvertisingChannelSubType advertising_channel_sub_type = 10
+ [(google.api.field_behavior) = IMMUTABLE];
// The URL template for constructing a tracking URL.
optional string tracking_url_template = 60;
// The list of mappings used to substitute custom parameter tags in a
// `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
- repeated google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 12;
+ repeated google.ads.googleads.v13.common.CustomParameter
+ url_custom_parameters = 12;
+
+ // The Local Services Campaign related settings.
+ LocalServicesCampaignSettings local_services_campaign_settings = 75;
+
+ // Settings for Travel campaign.
+ TravelCampaignSettings travel_campaign_settings = 85;
// Settings for Real-Time Bidding, a feature only available for campaigns
// targeting the Ad Exchange network.
- google.ads.googleads.v10.common.RealTimeBiddingSetting real_time_bidding_setting = 39;
+ google.ads.googleads.v13.common.RealTimeBiddingSetting
+ real_time_bidding_setting = 39;
// The network settings for the campaign.
NetworkSettings network_settings = 14;
@@ -274,10 +388,11 @@ message Campaign {
ShoppingSetting shopping_setting = 36;
// Setting for targeting related features.
- google.ads.googleads.v10.common.TargetingSetting targeting_setting = 43;
+ google.ads.googleads.v13.common.TargetingSetting targeting_setting = 43;
// Immutable. Setting for audience related features.
- optional AudienceSetting audience_setting = 73 [(google.api.field_behavior) = IMMUTABLE];
+ optional AudienceSetting audience_setting = 73
+ [(google.api.field_behavior) = IMMUTABLE];
// The setting for ads geotargeting.
GeoTargetTypeSetting geo_target_type_setting = 47;
@@ -297,10 +412,12 @@ message Campaign {
];
// Output only. The type of campaign: normal, draft, or experiment.
- google.ads.googleads.v10.enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CampaignExperimentTypeEnum
+ .CampaignExperimentType experiment_type = 17
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The resource name of the base campaign of a draft or experiment campaign.
- // For base campaigns, this is equal to `resource_name`.
+ // Output only. The resource name of the base campaign of a draft or
+ // experiment campaign. For base campaigns, this is equal to `resource_name`.
//
// This field is read-only.
optional string base_campaign = 56 [
@@ -312,8 +429,8 @@ message Campaign {
// The budget of the campaign.
optional string campaign_budget = 62 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignBudget"
- }];
+ type: "googleads.googleapis.com/CampaignBudget"
+ }];
// Output only. The type of bidding strategy.
//
@@ -322,14 +439,14 @@ message Campaign {
// create a portfolio bidding strategy.
//
// This field is read-only.
- google.ads.googleads.v10.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the
- // unrestricted attributes of the attached portfolio bidding
- // strategy identified by 'bidding_strategy'. Empty, if the campaign does not
- // use a portfolio strategy.
- // Unrestricted strategy attributes are available to all customers
- // with whom the strategy is shared and are read from the
+ google.ads.googleads.v13.enums.BiddingStrategyTypeEnum.BiddingStrategyType
+ bidding_strategy_type = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Resource name of AccessibleBiddingStrategy, a read-only view
+ // of the unrestricted attributes of the attached portfolio bidding strategy
+ // identified by 'bidding_strategy'. Empty, if the campaign does not use a
+ // portfolio strategy. Unrestricted strategy attributes are available to all
+ // customers with whom the strategy is shared and are read from the
// AccessibleBiddingStrategy resource. In contrast, restricted attributes are
// only available to the owner customer of the strategy and their managers.
// Restricted attributes can only be read from the BiddingStrategy resource.
@@ -346,11 +463,13 @@ message Campaign {
// The campaign group this campaign belongs to.
optional string campaign_group = 76 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignGroup"
- }];
+ type: "googleads.googleapis.com/CampaignGroup"
+ }];
// The last day of the campaign in serving customer's timezone in YYYY-MM-DD
- // format.
+ // format. On create, defaults to 2037-12-30, which means the campaign will
+ // run indefinitely. To set an existing campaign to run indefinitely, set this
+ // field to 2037-12-30.
optional string end_date = 64;
// Suffix used to append query parameters to landing pages that are served
@@ -358,10 +477,13 @@ message Campaign {
optional string final_url_suffix = 65;
// A list that limits how often each user will see this campaign's ads.
- repeated google.ads.googleads.v10.common.FrequencyCapEntry frequency_caps = 40;
+ repeated google.ads.googleads.v13.common.FrequencyCapEntry frequency_caps =
+ 40;
// Output only. 3-Tier Brand Safety setting for the campaign.
- google.ads.googleads.v10.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 42 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BrandSafetySuitabilityEnum
+ .BrandSafetySuitability video_brand_safety_suitability = 42
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Describes how unbranded pharma ads will be displayed.
VanityPharma vanity_pharma = 44;
@@ -375,10 +497,11 @@ message Campaign {
OptimizationGoalSetting optimization_goal_setting = 54;
// Output only. Campaign-level settings for tracking information.
- TrackingSetting tracking_setting = 46 [(google.api.field_behavior) = OUTPUT_ONLY];
+ TrackingSetting tracking_setting = 46
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Payment mode for the campaign.
- google.ads.googleads.v10.enums.PaymentModeEnum.PaymentMode payment_mode = 52;
+ google.ads.googleads.v13.enums.PaymentModeEnum.PaymentMode payment_mode = 52;
// Output only. Optimization score of the campaign.
//
@@ -391,12 +514,27 @@ message Campaign {
// https://support.google.com/google-ads/answer/9061546.
//
// This field is read-only.
- optional double optimization_score = 66 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional double optimization_score = 66
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The asset field types that should be excluded from this campaign. Asset
// links with these field types will not be inherited by this campaign from
// the upper level.
- repeated google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69;
+ repeated google.ads.googleads.v13.enums.AssetFieldTypeEnum.AssetFieldType
+ excluded_parent_asset_field_types = 69;
+
+ // The asset set types that should be excluded from this campaign. Asset set
+ // links with these types will not be inherited by this campaign from
+ // the upper level.
+ // Location group types (GMB_DYNAMIC_LOCATION_GROUP,
+ // CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of
+ // LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all
+ // location group asset sets are not allowed to be linked to this campaign,
+ // and all Location Extension (LE) and Affiliate Location Extensions (ALE)
+ // will not be served under this campaign.
+ // Only LOCATION_SYNC is currently supported.
+ repeated google.ads.googleads.v13.enums.AssetSetTypeEnum.AssetSetType
+ excluded_parent_asset_set_types = 80;
// Represents opting out of URL expansion to more targeted URLs. If opted out
// (true), only the final URLs in the asset group or URLs specified in the
@@ -406,63 +544,86 @@ message Campaign {
// false.
optional bool url_expansion_opt_out = 72;
+ // Output only. Information about campaigns being upgraded to Performance Max.
+ PerformanceMaxUpgrade performance_max_upgrade = 77
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Immutable. The set of hotel properties for Performance Max for travel goals
+ // campaigns.
+ optional string hotel_property_asset_set = 83 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AssetSet"
+ }
+ ];
+
// The bidding strategy for the campaign.
//
- // Must be either portfolio (created via BiddingStrategy service) or
+ // Must be either portfolio (created through BiddingStrategy service) or
// standard, that is embedded into the campaign.
oneof campaign_bidding_strategy {
// Portfolio bidding strategy used by campaign.
string bidding_strategy = 67 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/BiddingStrategy"
- }];
+ type: "googleads.googleapis.com/BiddingStrategy"
+ }];
// Commission is an automatic bidding strategy in which the advertiser pays
// a certain portion of the conversion value.
- google.ads.googleads.v10.common.Commission commission = 49;
+ google.ads.googleads.v13.common.Commission commission = 49;
+
+ // Standard Manual CPA bidding strategy.
+ // Manual bidding strategy that allows advertiser to set the bid per
+ // advertiser-specified action. Supported only for Local Services campaigns.
+ google.ads.googleads.v13.common.ManualCpa manual_cpa = 74;
// Standard Manual CPC bidding strategy.
// Manual click-based bidding where user pays per click.
- google.ads.googleads.v10.common.ManualCpc manual_cpc = 24;
+ google.ads.googleads.v13.common.ManualCpc manual_cpc = 24;
// Standard Manual CPM bidding strategy.
// Manual impression-based bidding where user pays per thousand
// impressions.
- google.ads.googleads.v10.common.ManualCpm manual_cpm = 25;
+ google.ads.googleads.v13.common.ManualCpm manual_cpm = 25;
- // Output only. A bidding strategy that pays a configurable amount per video view.
- google.ads.googleads.v10.common.ManualCpv manual_cpv = 37 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. A bidding strategy that pays a configurable amount per video
+ // view.
+ google.ads.googleads.v13.common.ManualCpv manual_cpv = 37
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Standard Maximize Conversions bidding strategy that automatically
// maximizes number of conversions while spending your budget.
- google.ads.googleads.v10.common.MaximizeConversions maximize_conversions = 30;
+ google.ads.googleads.v13.common.MaximizeConversions maximize_conversions =
+ 30;
// Standard Maximize Conversion Value bidding strategy that automatically
// sets bids to maximize revenue while spending your budget.
- google.ads.googleads.v10.common.MaximizeConversionValue maximize_conversion_value = 31;
+ google.ads.googleads.v13.common.MaximizeConversionValue
+ maximize_conversion_value = 31;
// Standard Target CPA bidding strategy that automatically sets bids to
// help get as many conversions as possible at the target
// cost-per-acquisition (CPA) you set.
- google.ads.googleads.v10.common.TargetCpa target_cpa = 26;
+ google.ads.googleads.v13.common.TargetCpa target_cpa = 26;
// Target Impression Share bidding strategy. An automated bidding strategy
- // that sets bids to achieve a desired percentage of impressions.
- google.ads.googleads.v10.common.TargetImpressionShare target_impression_share = 48;
+ // that sets bids to achieve a chosen percentage of impressions.
+ google.ads.googleads.v13.common.TargetImpressionShare
+ target_impression_share = 48;
// Standard Target ROAS bidding strategy that automatically maximizes
// revenue while averaging a specific target return on ad spend (ROAS).
- google.ads.googleads.v10.common.TargetRoas target_roas = 29;
+ google.ads.googleads.v13.common.TargetRoas target_roas = 29;
// Standard Target Spend bidding strategy that automatically sets your bids
// to help get as many clicks as possible within your budget.
- google.ads.googleads.v10.common.TargetSpend target_spend = 27;
+ google.ads.googleads.v13.common.TargetSpend target_spend = 27;
// Standard Percent Cpc bidding strategy where bids are a fraction of the
// advertised price for some good or service.
- google.ads.googleads.v10.common.PercentCpc percent_cpc = 34;
+ google.ads.googleads.v13.common.PercentCpc percent_cpc = 34;
// A bidding strategy that automatically optimizes cost per thousand
// impressions.
- google.ads.googleads.v10.common.TargetCpm target_cpm = 41;
+ google.ads.googleads.v13.common.TargetCpm target_cpm = 41;
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/campaign_asset.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_asset.proto
new file mode 100644
index 000000000..2418ea412
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_asset.proto
@@ -0,0 +1,103 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/asset_policy.proto";
+import "google/ads/googleads/v13/enums/asset_field_type.proto";
+import "google/ads/googleads/v13/enums/asset_link_primary_status.proto";
+import "google/ads/googleads/v13/enums/asset_link_primary_status_reason.proto";
+import "google/ads/googleads/v13/enums/asset_link_status.proto";
+import "google/ads/googleads/v13/enums/asset_source.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "CampaignAssetProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the CampaignAsset resource.
+
+// A link between a Campaign and an Asset.
+message CampaignAsset {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/CampaignAsset"
+ pattern: "customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}"
+ };
+
+ // Immutable. The resource name of the campaign asset.
+ // CampaignAsset resource names have the form:
+ //
+ // `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/CampaignAsset"
+ }
+ ];
+
+ // Immutable. The campaign to which the asset is linked.
+ optional string campaign = 6 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/Campaign"
+ }
+ ];
+
+ // Immutable. The asset which is linked to the campaign.
+ optional string asset = 7 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
+ ];
+
+ // Immutable. Role that the asset takes under the linked campaign.
+ // Required.
+ google.ads.googleads.v13.enums.AssetFieldTypeEnum.AssetFieldType field_type =
+ 4 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Output only. Source of the campaign asset link.
+ google.ads.googleads.v13.enums.AssetSourceEnum.AssetSource source = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Status of the campaign asset.
+ google.ads.googleads.v13.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5;
+
+ // Output only. Provides the PrimaryStatus of this asset link.
+ // Primary status is meant essentially to differentiate between the plain
+ // "status" field, which has advertiser set values of enabled, paused, or
+ // removed. The primary status takes into account other signals (for assets
+ // its mainly policy and quality approvals) to come up with a more
+ // comprehensive status to indicate its serving state.
+ google.ads.googleads.v13.enums.AssetLinkPrimaryStatusEnum
+ .AssetLinkPrimaryStatus primary_status = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Provides the details of the primary status and its associated
+ // reasons.
+ repeated google.ads.googleads.v13.common.AssetLinkPrimaryStatusDetails
+ primary_status_details = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Provides a list of reasons for why an asset is not serving or
+ // not serving at full capacity.
+ repeated google.ads.googleads.v13.enums.AssetLinkPrimaryStatusReasonEnum
+ .AssetLinkPrimaryStatusReason primary_status_reasons = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_asset_set.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_asset_set.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_asset_set.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_asset_set.proto
index e2e3761dc..5dac8fe43 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_asset_set.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_asset_set.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/asset_set_link_status.proto";
+import "google/ads/googleads/v13/enums/asset_set_link_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignAssetSetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the CampaignAsset resource.
@@ -67,5 +67,6 @@ message CampaignAssetSet {
];
// Output only. The status of the campaign asset set asset. Read-only.
- google.ads.googleads.v10.enums.AssetSetLinkStatusEnum.AssetSetLinkStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AssetSetLinkStatusEnum.AssetSetLinkStatus
+ status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_audience_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_audience_view.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_audience_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_audience_view.proto
index dd406a6d5..9be59a733 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_audience_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_audience_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignAudienceViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the campaign audience view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_bid_modifier.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_bid_modifier.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_bid_modifier.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_bid_modifier.proto
index 2e711c9a4..e4277c089 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_bid_modifier.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_bid_modifier.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/criteria.proto";
+import "google/ads/googleads/v13/common/criteria.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignBidModifierProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Campaign Bid Modifier resource.
@@ -69,7 +69,9 @@ message CampaignBidModifier {
//
// Required in create operations starting in V5.
oneof criterion {
- // Immutable. Criterion for interaction type. Only supported for search campaigns.
- google.ads.googleads.v10.common.InteractionTypeInfo interaction_type = 5 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. Criterion for interaction type. Only supported for search
+ // campaigns.
+ google.ads.googleads.v13.common.InteractionTypeInfo interaction_type = 5
+ [(google.api.field_behavior) = IMMUTABLE];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_budget.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_budget.proto
similarity index 66%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_budget.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_budget.proto
index 8febd40e7..bff0bdbe8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_budget.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_budget.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/budget_delivery_method.proto";
-import "google/ads/googleads/v10/enums/budget_period.proto";
-import "google/ads/googleads/v10/enums/budget_status.proto";
-import "google/ads/googleads/v10/enums/budget_type.proto";
+import "google/ads/googleads/v13/enums/budget_delivery_method.proto";
+import "google/ads/googleads/v13/enums/budget_period.proto";
+import "google/ads/googleads/v13/enums/budget_status.proto";
+import "google/ads/googleads/v13/enums/budget_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignBudgetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Budget resource.
@@ -82,13 +82,15 @@ message CampaignBudget {
optional int64 total_amount_micros = 22;
// Output only. The status of this campaign budget. This field is read-only.
- google.ads.googleads.v10.enums.BudgetStatusEnum.BudgetStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.BudgetStatusEnum.BudgetStatus status = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The delivery method that determines the rate at which the campaign budget
// is spent.
//
// Defaults to STANDARD if unspecified in a create operation.
- google.ads.googleads.v10.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod delivery_method = 7;
+ google.ads.googleads.v13.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod
+ delivery_method = 7;
// Specifies whether the budget is explicitly shared. Defaults to true if
// unspecified in a create operation.
@@ -110,46 +112,66 @@ message CampaignBudget {
// Output only. The number of campaigns actively using the budget.
//
// This field is read-only.
- optional int64 reference_count = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 reference_count = 24
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Indicates whether there is a recommended budget for this campaign budget.
+ // Output only. Indicates whether there is a recommended budget for this
+ // campaign budget.
//
// This field is read-only.
- optional bool has_recommended_budget = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional bool has_recommended_budget = 25
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The recommended budget amount. If no recommendation is available, this will
- // be set to the budget amount.
- // Amount is specified in micros, where one million is equivalent to one
- // currency unit.
+ // Output only. The recommended budget amount. If no recommendation is
+ // available, this will be set to the budget amount. Amount is specified in
+ // micros, where one million is equivalent to one currency unit.
//
// This field is read-only.
- optional int64 recommended_budget_amount_micros = 26 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 recommended_budget_amount_micros = 26
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.
- google.ads.googleads.v10.enums.BudgetPeriodEnum.BudgetPeriod period = 13 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. Period over which to spend the budget. Defaults to DAILY if not
+ // specified.
+ google.ads.googleads.v13.enums.BudgetPeriodEnum.BudgetPeriod period = 13
+ [(google.api.field_behavior) = IMMUTABLE];
- // Output only. The estimated change in weekly clicks if the recommended budget is applied.
+ // Output only. The estimated change in weekly clicks if the recommended
+ // budget is applied.
//
// This field is read-only.
- optional int64 recommended_budget_estimated_change_weekly_clicks = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 recommended_budget_estimated_change_weekly_clicks = 27
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The estimated change in weekly cost in micros if the recommended budget is
- // applied. One million is equivalent to one currency unit.
+ // Output only. The estimated change in weekly cost in micros if the
+ // recommended budget is applied. One million is equivalent to one currency
+ // unit.
//
// This field is read-only.
- optional int64 recommended_budget_estimated_change_weekly_cost_micros = 28 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 recommended_budget_estimated_change_weekly_cost_micros = 28
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The estimated change in weekly interactions if the recommended budget is
- // applied.
+ // Output only. The estimated change in weekly interactions if the recommended
+ // budget is applied.
//
// This field is read-only.
- optional int64 recommended_budget_estimated_change_weekly_interactions = 29 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 recommended_budget_estimated_change_weekly_interactions = 29
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The estimated change in weekly views if the recommended budget is applied.
+ // Output only. The estimated change in weekly views if the recommended budget
+ // is applied.
//
// This field is read-only.
- optional int64 recommended_budget_estimated_change_weekly_views = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 recommended_budget_estimated_change_weekly_views = 30
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. The type of the campaign budget.
- google.ads.googleads.v10.enums.BudgetTypeEnum.BudgetType type = 18 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.BudgetTypeEnum.BudgetType type = 18
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // ID of the portfolio bidding strategy that this shared campaign budget
+ // is aligned with. When a bidding strategy and a campaign budget are aligned,
+ // they are attached to the same set of campaigns. After a campaign budget is
+ // aligned with a bidding strategy, campaigns that are added to the campaign
+ // budget must also use the aligned bidding strategy.
+ int64 aligned_bidding_strategy_id = 31;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_conversion_goal.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_conversion_goal.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_conversion_goal.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_conversion_goal.proto
index 2b6a85cc3..60b90421b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_conversion_goal.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_conversion_goal.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/conversion_action_category.proto";
-import "google/ads/googleads/v10/enums/conversion_origin.proto";
+import "google/ads/googleads/v13/enums/conversion_action_category.proto";
+import "google/ads/googleads/v13/enums/conversion_origin.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignConversionGoalProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// The biddability setting for the specified campaign only for all
// conversion actions with a matching category and origin.
@@ -49,7 +49,8 @@ message CampaignConversionGoal {
}
];
- // Immutable. The campaign with which this campaign conversion goal is associated.
+ // Immutable. The campaign with which this campaign conversion goal is
+ // associated.
string campaign = 2 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
@@ -58,10 +59,12 @@ message CampaignConversionGoal {
];
// The conversion category of this campaign conversion goal.
- google.ads.googleads.v10.enums.ConversionActionCategoryEnum.ConversionActionCategory category = 3;
+ google.ads.googleads.v13.enums.ConversionActionCategoryEnum
+ .ConversionActionCategory category = 3;
// The conversion origin of this campaign conversion goal.
- google.ads.googleads.v10.enums.ConversionOriginEnum.ConversionOrigin origin = 4;
+ google.ads.googleads.v13.enums.ConversionOriginEnum.ConversionOrigin origin =
+ 4;
// The biddability of the campaign conversion goal.
bool biddable = 5;
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/campaign_criterion.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_criterion.proto
new file mode 100644
index 000000000..ccb1b0434
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_criterion.proto
@@ -0,0 +1,219 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/enums/campaign_criterion_status.proto";
+import "google/ads/googleads/v13/enums/criterion_type.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "CampaignCriterionProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the Campaign Criterion resource.
+
+// A campaign criterion.
+message CampaignCriterion {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/CampaignCriterion"
+ pattern: "customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}"
+ };
+
+ // Immutable. The resource name of the campaign criterion.
+ // Campaign criterion resource names have the form:
+ //
+ // `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/CampaignCriterion"
+ }
+ ];
+
+ // Immutable. The campaign to which the criterion belongs.
+ optional string campaign = 37 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/Campaign"
+ }
+ ];
+
+ // Output only. The ID of the criterion.
+ //
+ // This field is ignored during mutate.
+ optional int64 criterion_id = 38 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The display name of the criterion.
+ //
+ // This field is ignored for mutates.
+ string display_name = 43 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The modifier for the bids when the criterion matches. The modifier must be
+ // in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.
+ // Use 0 to opt out of a Device type.
+ optional float bid_modifier = 39;
+
+ // Immutable. Whether to target (`false`) or exclude (`true`) the criterion.
+ optional bool negative = 40 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Output only. The type of the criterion.
+ google.ads.googleads.v13.enums.CriterionTypeEnum.CriterionType type = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The status of the criterion.
+ google.ads.googleads.v13.enums.CampaignCriterionStatusEnum
+ .CampaignCriterionStatus status = 35;
+
+ // The campaign criterion.
+ //
+ // Exactly one must be set.
+ oneof criterion {
+ // Immutable. Keyword.
+ google.ads.googleads.v13.common.KeywordInfo keyword = 8
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Placement.
+ google.ads.googleads.v13.common.PlacementInfo placement = 9
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Mobile app category.
+ google.ads.googleads.v13.common.MobileAppCategoryInfo mobile_app_category =
+ 10 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Mobile application.
+ google.ads.googleads.v13.common.MobileApplicationInfo mobile_application =
+ 11 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Location.
+ google.ads.googleads.v13.common.LocationInfo location = 12
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Device.
+ google.ads.googleads.v13.common.DeviceInfo device = 13
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Ad Schedule.
+ google.ads.googleads.v13.common.AdScheduleInfo ad_schedule = 15
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Age range.
+ google.ads.googleads.v13.common.AgeRangeInfo age_range = 16
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Gender.
+ google.ads.googleads.v13.common.GenderInfo gender = 17
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Income range.
+ google.ads.googleads.v13.common.IncomeRangeInfo income_range = 18
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Parental status.
+ google.ads.googleads.v13.common.ParentalStatusInfo parental_status = 19
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. User List.
+ // The Similar Audiences sunset starts May 2023. Refer to
+ // https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html
+ // for other options.
+ google.ads.googleads.v13.common.UserListInfo user_list = 22
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. YouTube Video.
+ google.ads.googleads.v13.common.YouTubeVideoInfo youtube_video = 20
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. YouTube Channel.
+ google.ads.googleads.v13.common.YouTubeChannelInfo youtube_channel = 21
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Proximity.
+ google.ads.googleads.v13.common.ProximityInfo proximity = 23
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Topic.
+ google.ads.googleads.v13.common.TopicInfo topic = 24
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Listing scope.
+ google.ads.googleads.v13.common.ListingScopeInfo listing_scope = 25
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Language.
+ google.ads.googleads.v13.common.LanguageInfo language = 26
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. IpBlock.
+ google.ads.googleads.v13.common.IpBlockInfo ip_block = 27
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. ContentLabel.
+ google.ads.googleads.v13.common.ContentLabelInfo content_label = 28
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Carrier.
+ google.ads.googleads.v13.common.CarrierInfo carrier = 29
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. User Interest.
+ google.ads.googleads.v13.common.UserInterestInfo user_interest = 30
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Webpage.
+ google.ads.googleads.v13.common.WebpageInfo webpage = 31
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Operating system version.
+ google.ads.googleads.v13.common.OperatingSystemVersionInfo
+ operating_system_version = 32 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Mobile Device.
+ google.ads.googleads.v13.common.MobileDeviceInfo mobile_device = 33
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Location Group
+ google.ads.googleads.v13.common.LocationGroupInfo location_group = 34
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Custom Affinity.
+ google.ads.googleads.v13.common.CustomAffinityInfo custom_affinity = 36
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Custom Audience
+ google.ads.googleads.v13.common.CustomAudienceInfo custom_audience = 41
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Combined Audience.
+ google.ads.googleads.v13.common.CombinedAudienceInfo combined_audience = 42
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Smart Campaign Keyword Theme.
+ google.ads.googleads.v13.common.KeywordThemeInfo keyword_theme = 45
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. GLS service campaign criterion.
+ google.ads.googleads.v13.common.LocalServiceIdInfo local_service_id = 46
+ [(google.api.field_behavior) = IMMUTABLE];
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_criterion_simulation.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_criterion_simulation.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_criterion_simulation.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_criterion_simulation.proto
index 81f5f4faf..9c5d82b84 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_criterion_simulation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_criterion_simulation.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/simulation.proto";
-import "google/ads/googleads/v10/enums/simulation_modification_method.proto";
-import "google/ads/googleads/v10/enums/simulation_type.proto";
+import "google/ads/googleads/v13/common/simulation.proto";
+import "google/ads/googleads/v13/enums/simulation_modification_method.proto";
+import "google/ads/googleads/v13/enums/simulation_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignCriterionSimulationProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the campaign criterion simulation resource.
@@ -63,20 +63,26 @@ message CampaignCriterionSimulation {
optional int64 criterion_id = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The field that the simulation modifies.
- google.ads.googleads.v10.enums.SimulationTypeEnum.SimulationType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SimulationTypeEnum.SimulationType type = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. How the simulation modifies the field.
- google.ads.googleads.v10.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SimulationModificationMethodEnum
+ .SimulationModificationMethod modification_method = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. First day on which the simulation is based, in YYYY-MM-DD format.
+ // Output only. First day on which the simulation is based, in YYYY-MM-DD
+ // format.
optional string start_date = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Last day on which the simulation is based, in YYYY-MM-DD format.
+ // Output only. Last day on which the simulation is based, in YYYY-MM-DD
+ // format.
optional string end_date = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// List of simulation points.
oneof point_list {
// Output only. Simulation points if the simulation type is BID_MODIFIER.
- google.ads.googleads.v10.common.BidModifierSimulationPointList bid_modifier_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.BidModifierSimulationPointList
+ bid_modifier_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_customizer.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_customizer.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_customizer.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_customizer.proto
index 6a3002ac7..57a395b7b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_customizer.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_customizer.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/customizer_value.proto";
-import "google/ads/googleads/v10/enums/customizer_value_status.proto";
+import "google/ads/googleads/v13/common/customizer_value.proto";
+import "google/ads/googleads/v13/enums/customizer_value_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignCustomizerProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// A customizer value for the associated CustomizerAttribute at the Campaign
// level.
@@ -57,7 +57,8 @@ message CampaignCustomizer {
}
];
- // Required. Immutable. The customizer attribute which is linked to the campaign.
+ // Required. Immutable. The customizer attribute which is linked to the
+ // campaign.
string customizer_attribute = 3 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE,
@@ -67,9 +68,11 @@ message CampaignCustomizer {
];
// Output only. The status of the campaign customizer.
- google.ads.googleads.v10.enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CustomizerValueStatusEnum.CustomizerValueStatus
+ status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. The value to associate with the customizer attribute at this level. The
- // value must be of the type specified for the CustomizerAttribute.
- google.ads.googleads.v10.common.CustomizerValue value = 5 [(google.api.field_behavior) = REQUIRED];
+ // Required. The value to associate with the customizer attribute at this
+ // level. The value must be of the type specified for the CustomizerAttribute.
+ google.ads.googleads.v13.common.CustomizerValue value = 5
+ [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_draft.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_draft.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_draft.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_draft.proto
index 0ec53921d..d952be03c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_draft.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_draft.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/campaign_draft_status.proto";
+import "google/ads/googleads/v13/enums/campaign_draft_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignDraftProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Campaign Draft resource.
@@ -71,8 +71,8 @@ message CampaignDraft {
// (code point 0xA) or carriage return (code point 0xD) characters.
optional string name = 11;
- // Output only. Resource name of the Campaign that results from overlaying the draft
- // changes onto the base campaign.
+ // Output only. Resource name of the Campaign that results from overlaying the
+ // draft changes onto the base campaign.
//
// This field is read-only.
optional string draft_campaign = 12 [
@@ -85,13 +85,17 @@ message CampaignDraft {
// Output only. The status of the campaign draft. This field is read-only.
//
// When a new campaign draft is added, the status defaults to PROPOSED.
- google.ads.googleads.v10.enums.CampaignDraftStatusEnum.CampaignDraftStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CampaignDraftStatusEnum.CampaignDraftStatus
+ status = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Whether there is an experiment based on this draft currently serving.
- optional bool has_experiment_running = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Whether there is an experiment based on this draft currently
+ // serving.
+ optional bool has_experiment_running = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The resource name of the long-running operation that can be used to poll
- // for completion of draft promotion. This is only set if the draft promotion
- // is in progress or finished.
- optional string long_running_operation = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The resource name of the long-running operation that can be
+ // used to poll for completion of draft promotion. This is only set if the
+ // draft promotion is in progress or finished.
+ optional string long_running_operation = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_extension_setting.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_extension_setting.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_extension_setting.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_extension_setting.proto
index 613a8a280..6f7b5ffed 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_extension_setting.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_extension_setting.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/extension_setting_device.proto";
-import "google/ads/googleads/v10/enums/extension_type.proto";
+import "google/ads/googleads/v13/enums/extension_setting_device.proto";
+import "google/ads/googleads/v13/enums/extension_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignExtensionSettingProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the CampaignExtensionSetting resource.
@@ -51,11 +51,12 @@ message CampaignExtensionSetting {
];
// Immutable. The extension type of the customer extension setting.
- google.ads.googleads.v10.enums.ExtensionTypeEnum.ExtensionType extension_type = 2 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.ExtensionTypeEnum.ExtensionType
+ extension_type = 2 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The resource name of the campaign. The linked extension feed items will
- // serve under this campaign.
- // Campaign resource names have the form:
+ // Immutable. The resource name of the campaign. The linked extension feed
+ // items will serve under this campaign. Campaign resource names have the
+ // form:
//
// `customers/{customer_id}/campaigns/{campaign_id}`
optional string campaign = 6 [
@@ -70,9 +71,10 @@ message CampaignExtensionSetting {
//
// `customers/{customer_id}/extensionFeedItems/{feed_item_id}`
repeated string extension_feed_items = 7 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ExtensionFeedItem"
- }];
+ type: "googleads.googleapis.com/ExtensionFeedItem"
+ }];
// The device for which the extensions will serve. Optional.
- google.ads.googleads.v10.enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 5;
+ google.ads.googleads.v13.enums.ExtensionSettingDeviceEnum
+ .ExtensionSettingDevice device = 5;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_feed.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_feed.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_feed.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_feed.proto
index 2dd70118f..2d94fa527 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_feed.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_feed.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/matching_function.proto";
-import "google/ads/googleads/v10/enums/feed_link_status.proto";
-import "google/ads/googleads/v10/enums/placeholder_type.proto";
+import "google/ads/googleads/v13/common/matching_function.proto";
+import "google/ads/googleads/v13/enums/feed_link_status.proto";
+import "google/ads/googleads/v13/enums/placeholder_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignFeedProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the CampaignFeed resource.
@@ -54,9 +54,7 @@ message CampaignFeed {
// Immutable. The feed to which the CampaignFeed belongs.
optional string feed = 7 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Feed" }
];
// Immutable. The campaign to which the CampaignFeed belongs.
@@ -69,14 +67,16 @@ message CampaignFeed {
// Indicates which placeholder types the feed may populate under the connected
// campaign. Required.
- repeated google.ads.googleads.v10.enums.PlaceholderTypeEnum.PlaceholderType placeholder_types = 4;
+ repeated google.ads.googleads.v13.enums.PlaceholderTypeEnum.PlaceholderType
+ placeholder_types = 4;
// Matching function associated with the CampaignFeed.
// The matching function is used to filter the set of feed items selected.
// Required.
- google.ads.googleads.v10.common.MatchingFunction matching_function = 5;
+ google.ads.googleads.v13.common.MatchingFunction matching_function = 5;
// Output only. Status of the campaign feed.
// This field is read-only.
- google.ads.googleads.v10.enums.FeedLinkStatusEnum.FeedLinkStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.FeedLinkStatusEnum.FeedLinkStatus status = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_group.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_group.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_group.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_group.proto
index 6f4a9d7bb..baae2cd3a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_group.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_group.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/campaign_group_status.proto";
+import "google/ads/googleads/v13/enums/campaign_group_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignGroupProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Campaign group resource.
@@ -64,5 +64,6 @@ message CampaignGroup {
// The status of the campaign group.
//
// When a new campaign group is added, the status defaults to ENABLED.
- google.ads.googleads.v10.enums.CampaignGroupStatusEnum.CampaignGroupStatus status = 5;
+ google.ads.googleads.v13.enums.CampaignGroupStatusEnum.CampaignGroupStatus
+ status = 5;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_label.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_label.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_label.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_label.proto
index c5abc4b46..322b1c9a4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_label.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_label.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignLabelProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the campaign label resource.
@@ -58,8 +58,6 @@ message CampaignLabel {
// Immutable. The label assigned to the campaign.
optional string label = 5 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Label"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Label" }
];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_shared_set.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_shared_set.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_shared_set.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_shared_set.proto
index 1cf5034ea..2f6b21bcd 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_shared_set.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_shared_set.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/campaign_shared_set_status.proto";
+import "google/ads/googleads/v13/enums/campaign_shared_set_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignSharedSetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the CampaignSharedSet resource.
@@ -58,12 +58,12 @@ message CampaignSharedSet {
}
];
- // Immutable. The shared set associated with the campaign. This may be a negative keyword
- // shared set of another customer. This customer should be a manager of the
- // other customer, otherwise the campaign shared set will exist but have no
- // serving effect. Only negative keyword shared sets can be associated with
- // Shopping campaigns. Only negative placement shared sets can be associated
- // with Display mobile app campaigns.
+ // Immutable. The shared set associated with the campaign. This may be a
+ // negative keyword shared set of another customer. This customer should be a
+ // manager of the other customer, otherwise the campaign shared set will exist
+ // but have no serving effect. Only negative keyword shared sets can be
+ // associated with Shopping campaigns. Only negative placement shared sets can
+ // be associated with Display mobile app campaigns.
optional string shared_set = 6 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
@@ -72,5 +72,7 @@ message CampaignSharedSet {
];
// Output only. The status of this campaign shared set. Read only.
- google.ads.googleads.v10.enums.CampaignSharedSetStatusEnum.CampaignSharedSetStatus status = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CampaignSharedSetStatusEnum
+ .CampaignSharedSetStatus status = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_simulation.proto b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_simulation.proto
similarity index 55%
rename from third_party/googleapis/google/ads/googleads/v10/resources/campaign_simulation.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/campaign_simulation.proto
index 27145cd8d..51bd5d471 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/campaign_simulation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/campaign_simulation.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/simulation.proto";
-import "google/ads/googleads/v10/enums/simulation_modification_method.proto";
-import "google/ads/googleads/v10/enums/simulation_type.proto";
+import "google/ads/googleads/v13/common/simulation.proto";
+import "google/ads/googleads/v13/enums/simulation_modification_method.proto";
+import "google/ads/googleads/v13/enums/simulation_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CampaignSimulationProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the campaign simulation resource.
@@ -37,18 +37,18 @@ option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
// channel type, simulation type and simulation modification
// method is detailed below respectively.
//
-// SEARCH - CPC_BID - UNIFORM
-// SEARCH - CPC_BID - SCALING
-// SEARCH - TARGET_CPA - UNIFORM
-// SEARCH - TARGET_CPA - SCALING
-// SEARCH - TARGET_ROAS - UNIFORM
-// SEARCH - TARGET_IMPRESSION_SHARE - UNIFORM
-// SEARCH - BUDGET - UNIFORM
-// SHOPPING - BUDGET - UNIFORM
-// SHOPPING - TARGET_ROAS - UNIFORM
-// MULTIPLE - TARGET_CPA - UNIFORM
-// OWNED_AND_OPERATED - TARGET_CPA - DEFAULT
-// DISPLAY - TARGET_CPA - UNIFORM
+// * SEARCH - CPC_BID - UNIFORM
+// * SEARCH - CPC_BID - SCALING
+// * SEARCH - TARGET_CPA - UNIFORM
+// * SEARCH - TARGET_CPA - SCALING
+// * SEARCH - TARGET_ROAS - UNIFORM
+// * SEARCH - TARGET_IMPRESSION_SHARE - UNIFORM
+// * SEARCH - BUDGET - UNIFORM
+// * SHOPPING - BUDGET - UNIFORM
+// * SHOPPING - TARGET_ROAS - UNIFORM
+// * MULTI_CHANNEL - TARGET_CPA - UNIFORM
+// * DISCOVERY - TARGET_CPA - DEFAULT
+// * DISPLAY - TARGET_CPA - UNIFORM
message CampaignSimulation {
option (google.api.resource) = {
type: "googleads.googleapis.com/CampaignSimulation"
@@ -70,32 +70,44 @@ message CampaignSimulation {
int64 campaign_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The field that the simulation modifies.
- google.ads.googleads.v10.enums.SimulationTypeEnum.SimulationType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SimulationTypeEnum.SimulationType type = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. How the simulation modifies the field.
- google.ads.googleads.v10.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SimulationModificationMethodEnum
+ .SimulationModificationMethod modification_method = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. First day on which the simulation is based, in YYYY-MM-DD format.
+ // Output only. First day on which the simulation is based, in YYYY-MM-DD
+ // format.
string start_date = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Last day on which the simulation is based, in YYYY-MM-DD format
+ // Output only. Last day on which the simulation is based, in YYYY-MM-DD
+ // format
string end_date = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// List of simulation points.
oneof point_list {
// Output only. Simulation points if the simulation type is CPC_BID.
- google.ads.googleads.v10.common.CpcBidSimulationPointList cpc_bid_point_list = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.CpcBidSimulationPointList
+ cpc_bid_point_list = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Simulation points if the simulation type is TARGET_CPA.
- google.ads.googleads.v10.common.TargetCpaSimulationPointList target_cpa_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.TargetCpaSimulationPointList
+ target_cpa_point_list = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Simulation points if the simulation type is TARGET_ROAS.
- google.ads.googleads.v10.common.TargetRoasSimulationPointList target_roas_point_list = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.TargetRoasSimulationPointList
+ target_roas_point_list = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Simulation points if the simulation type is TARGET_IMPRESSION_SHARE.
- google.ads.googleads.v10.common.TargetImpressionShareSimulationPointList target_impression_share_point_list = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Simulation points if the simulation type is
+ // TARGET_IMPRESSION_SHARE.
+ google.ads.googleads.v13.common.TargetImpressionShareSimulationPointList
+ target_impression_share_point_list = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Simulation points if the simulation type is BUDGET.
- google.ads.googleads.v10.common.BudgetSimulationPointList budget_point_list = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.BudgetSimulationPointList
+ budget_point_list = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/carrier_constant.proto b/third_party/googleapis/google/ads/googleads/v13/resources/carrier_constant.proto
similarity index 83%
rename from third_party/googleapis/google/ads/googleads/v10/resources/carrier_constant.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/carrier_constant.proto
index a9b73cf4f..1c164a39b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/carrier_constant.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/carrier_constant.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CarrierConstantProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Carrier constant resource.
@@ -54,7 +54,7 @@ message CarrierConstant {
// Output only. The full name of the carrier in English.
optional string name = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The country code of the country where the carrier is located, e.g., "AR",
- // "FR", etc.
+ // Output only. The country code of the country where the carrier is located,
+ // for example, "AR", "FR", etc.
optional string country_code = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/change_event.proto b/third_party/googleapis/google/ads/googleads/v13/resources/change_event.proto
similarity index 60%
rename from third_party/googleapis/google/ads/googleads/v10/resources/change_event.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/change_event.proto
index 4fecc9381..f849ac219 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/change_event.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/change_event.proto
@@ -14,52 +14,49 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/enums/change_client_type.proto";
-import "google/ads/googleads/v10/enums/change_event_resource_type.proto";
-import "google/ads/googleads/v10/enums/resource_change_operation.proto";
-import "google/ads/googleads/v10/resources/ad.proto";
-import "google/ads/googleads/v10/resources/ad_group.proto";
-import "google/ads/googleads/v10/resources/ad_group_ad.proto";
-import "google/ads/googleads/v10/resources/ad_group_asset.proto";
-import "google/ads/googleads/v10/resources/ad_group_bid_modifier.proto";
-import "google/ads/googleads/v10/resources/ad_group_criterion.proto";
-import "google/ads/googleads/v10/resources/ad_group_feed.proto";
-import "google/ads/googleads/v10/resources/asset.proto";
-import "google/ads/googleads/v10/resources/asset_set.proto";
-import "google/ads/googleads/v10/resources/asset_set_asset.proto";
-import "google/ads/googleads/v10/resources/campaign.proto";
-import "google/ads/googleads/v10/resources/campaign_asset.proto";
-import "google/ads/googleads/v10/resources/campaign_asset_set.proto";
-import "google/ads/googleads/v10/resources/campaign_budget.proto";
-import "google/ads/googleads/v10/resources/campaign_criterion.proto";
-import "google/ads/googleads/v10/resources/campaign_feed.proto";
-import "google/ads/googleads/v10/resources/customer_asset.proto";
-import "google/ads/googleads/v10/resources/feed.proto";
-import "google/ads/googleads/v10/resources/feed_item.proto";
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/enums/change_client_type.proto";
+import "google/ads/googleads/v13/enums/change_event_resource_type.proto";
+import "google/ads/googleads/v13/enums/resource_change_operation.proto";
+import "google/ads/googleads/v13/resources/ad.proto";
+import "google/ads/googleads/v13/resources/ad_group.proto";
+import "google/ads/googleads/v13/resources/ad_group_ad.proto";
+import "google/ads/googleads/v13/resources/ad_group_asset.proto";
+import "google/ads/googleads/v13/resources/ad_group_bid_modifier.proto";
+import "google/ads/googleads/v13/resources/ad_group_criterion.proto";
+import "google/ads/googleads/v13/resources/ad_group_feed.proto";
+import "google/ads/googleads/v13/resources/asset.proto";
+import "google/ads/googleads/v13/resources/asset_set.proto";
+import "google/ads/googleads/v13/resources/asset_set_asset.proto";
+import "google/ads/googleads/v13/resources/campaign.proto";
+import "google/ads/googleads/v13/resources/campaign_asset.proto";
+import "google/ads/googleads/v13/resources/campaign_asset_set.proto";
+import "google/ads/googleads/v13/resources/campaign_budget.proto";
+import "google/ads/googleads/v13/resources/campaign_criterion.proto";
+import "google/ads/googleads/v13/resources/campaign_feed.proto";
+import "google/ads/googleads/v13/resources/customer_asset.proto";
+import "google/ads/googleads/v13/resources/feed.proto";
+import "google/ads/googleads/v13/resources/feed_item.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ChangeEventProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Change Event resource.
-// Describes the granular change of returned resource of certain resource types.
-// Changes made through UI, API and new versions of Editor
-// by external users (including external users, and internal users that can be
-// shown externally) in the past 30 days will be shown. The change shows the old
-// values of the changed fields before the change and the new values right after
-// the change. ChangeEvent could have up to 3 minutes delay to reflect a new
-// change.
+// Describes the granular change of returned resources of certain resource
+// types. Changes made through the UI or API in the past 30 days are included.
+// Previous and new values of the changed fields are shown. ChangeEvent could
+// have up to 3 minutes delay to reflect a new change.
message ChangeEvent {
option (google.api.resource) = {
type: "googleads.googleapis.com/ChangeEvent"
@@ -76,19 +73,23 @@ message ChangeEvent {
AdGroup ad_group = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == AD_GROUP_CRITERION.
- AdGroupCriterion ad_group_criterion = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ AdGroupCriterion ad_group_criterion = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == CAMPAIGN.
Campaign campaign = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == CAMPAIGN_BUDGET.
- CampaignBudget campaign_budget = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ CampaignBudget campaign_budget = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == AD_GROUP_BID_MODIFIER.
- AdGroupBidModifier ad_group_bid_modifier = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ AdGroupBidModifier ad_group_bid_modifier = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == CAMPAIGN_CRITERION.
- CampaignCriterion campaign_criterion = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ CampaignCriterion campaign_criterion = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == FEED.
Feed feed = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -109,22 +110,27 @@ message ChangeEvent {
Asset asset = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == CUSTOMER_ASSET.
- CustomerAsset customer_asset = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ CustomerAsset customer_asset = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == CAMPAIGN_ASSET.
- CampaignAsset campaign_asset = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ CampaignAsset campaign_asset = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == AD_GROUP_ASSET.
- AdGroupAsset ad_group_asset = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
+ AdGroupAsset ad_group_asset = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == ASSET_SET.
AssetSet asset_set = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == ASSET_SET_ASSET.
- AssetSetAsset asset_set_asset = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
+ AssetSetAsset asset_set_asset = 18
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Set if change_resource_type == CAMPAIGN_ASSET_SET.
- CampaignAssetSet campaign_asset_set = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
+ CampaignAssetSet campaign_asset_set = 19
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. The resource name of the change event.
@@ -143,28 +149,36 @@ message ChangeEvent {
// Output only. The type of the changed resource. This dictates what resource
// will be set in old_resource and new_resource.
- google.ads.googleads.v10.enums.ChangeEventResourceTypeEnum.ChangeEventResourceType change_resource_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.ChangeEventResourceTypeEnum
+ .ChangeEventResourceType change_resource_type = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The Simply resource this change occurred on.
string change_resource_name = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Where the change was made through.
- google.ads.googleads.v10.enums.ChangeClientTypeEnum.ChangeClientType client_type = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.ChangeClientTypeEnum.ChangeClientType
+ client_type = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The email of the user who made this change.
string user_email = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The old resource before the change. Only changed fields will be populated.
+ // Output only. The old resource before the change. Only changed fields will
+ // be populated.
ChangedResource old_resource = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The new resource after the change. Only changed fields will be populated.
+ // Output only. The new resource after the change. Only changed fields will be
+ // populated.
ChangedResource new_resource = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The operation on the changed resource.
- google.ads.googleads.v10.enums.ResourceChangeOperationEnum.ResourceChangeOperation resource_change_operation = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.ResourceChangeOperationEnum
+ .ResourceChangeOperation resource_change_operation = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. A list of fields that are changed in the returned resource.
- google.protobuf.FieldMask changed_fields = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.FieldMask changed_fields = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The Campaign affected by this change.
string campaign = 11 [
@@ -185,9 +199,7 @@ message ChangeEvent {
// Output only. The Feed affected by this change.
string feed = 13 [
(google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Feed" }
];
// Output only. The FeedItem affected by this change.
@@ -201,8 +213,6 @@ message ChangeEvent {
// Output only. The Asset affected by this change.
string asset = 20 [
(google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/change_status.proto b/third_party/googleapis/google/ads/googleads/v13/resources/change_status.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/resources/change_status.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/change_status.proto
index 6a675afb3..e98026e46 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/change_status.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/change_status.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/change_status_operation.proto";
-import "google/ads/googleads/v10/enums/change_status_resource_type.proto";
+import "google/ads/googleads/v13/enums/change_status_operation.proto";
+import "google/ads/googleads/v13/enums/change_status_resource_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ChangeStatusProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Change Status resource.
@@ -51,13 +51,17 @@ message ChangeStatus {
}
];
- // Output only. Time at which the most recent change has occurred on this resource.
- optional string last_change_date_time = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Time at which the most recent change has occurred on this
+ // resource.
+ optional string last_change_date_time = 24
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Represents the type of the changed resource. This dictates what fields
- // will be set. For example, for AD_GROUP, campaign and ad_group fields will
- // be set.
- google.ads.googleads.v10.enums.ChangeStatusResourceTypeEnum.ChangeStatusResourceType resource_type = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Represents the type of the changed resource. This dictates
+ // what fields will be set. For example, for AD_GROUP, campaign and ad_group
+ // fields will be set.
+ google.ads.googleads.v13.enums.ChangeStatusResourceTypeEnum
+ .ChangeStatusResourceType resource_type = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The Campaign affected by this change.
optional string campaign = 17 [
@@ -76,7 +80,8 @@ message ChangeStatus {
];
// Output only. Represents the status of the changed resource.
- google.ads.googleads.v10.enums.ChangeStatusOperationEnum.ChangeStatusOperation resource_status = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.ChangeStatusOperationEnum.ChangeStatusOperation
+ resource_status = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The AdGroupAd affected by this change.
optional string ad_group_ad = 25 [
@@ -105,9 +110,7 @@ message ChangeStatus {
// Output only. The Feed affected by this change.
optional string feed = 28 [
(google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Feed" }
];
// Output only. The FeedItem affected by this change.
@@ -161,9 +164,7 @@ message ChangeStatus {
// Output only. The Asset affected by this change.
string asset = 35 [
(google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
];
// Output only. The CustomerAsset affected by this change.
@@ -189,4 +190,12 @@ message ChangeStatus {
type: "googleads.googleapis.com/AdGroupAsset"
}
];
+
+ // Output only. The CombinedAudience affected by this change.
+ string combined_audience = 40 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/CombinedAudience"
+ }
+ ];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/click_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/click_view.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/resources/click_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/click_view.proto
index dd4f9b096..ba91bb0e5 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/click_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/click_view.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/click_location.proto";
-import "google/ads/googleads/v10/common/criteria.proto";
+import "google/ads/googleads/v13/common/click_location.proto";
+import "google/ads/googleads/v13/common/criteria.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ClickViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ClickView resource.
@@ -58,13 +58,15 @@ message ClickView {
// Output only. The Google Click ID.
optional string gclid = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The location criteria matching the area of interest associated with the
- // impression.
- google.ads.googleads.v10.common.ClickLocation area_of_interest = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The location criteria matching the area of interest associated
+ // with the impression.
+ google.ads.googleads.v13.common.ClickLocation area_of_interest = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The location criteria matching the location of presence associated with the
- // impression.
- google.ads.googleads.v10.common.ClickLocation location_of_presence = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The location criteria matching the location of presence
+ // associated with the impression.
+ google.ads.googleads.v13.common.ClickLocation location_of_presence = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Page number in search results where the ad was shown.
optional int64 page_number = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -93,8 +95,8 @@ message ClickView {
}
];
- // Output only. The associated keyword, if one exists and the click corresponds to the
- // SEARCH channel.
+ // Output only. The associated keyword, if one exists and the click
+ // corresponds to the SEARCH channel.
string keyword = 13 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -103,5 +105,6 @@ message ClickView {
];
// Output only. Basic information about the associated keyword, if it exists.
- google.ads.googleads.v10.common.KeywordInfo keyword_info = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.KeywordInfo keyword_info = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/combined_audience.proto b/third_party/googleapis/google/ads/googleads/v13/resources/combined_audience.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/resources/combined_audience.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/combined_audience.proto
index 2bf695e6e..1b0a7962e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/combined_audience.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/combined_audience.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/combined_audience_status.proto";
+import "google/ads/googleads/v13/enums/combined_audience_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CombinedAudienceProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Combined Audience resource.
@@ -53,12 +53,14 @@ message CombinedAudience {
// Output only. ID of the combined audience.
int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Status of this combined audience. Indicates whether the combined audience
- // is enabled or removed.
- google.ads.googleads.v10.enums.CombinedAudienceStatusEnum.CombinedAudienceStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Status of this combined audience. Indicates whether the
+ // combined audience is enabled or removed.
+ google.ads.googleads.v13.enums.CombinedAudienceStatusEnum
+ .CombinedAudienceStatus status = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Name of the combined audience. It should be unique across all combined
- // audiences.
+ // Output only. Name of the combined audience. It should be unique across all
+ // combined audiences.
string name = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Description of this combined audience.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/conversion_action.proto b/third_party/googleapis/google/ads/googleads/v13/resources/conversion_action.proto
similarity index 69%
rename from third_party/googleapis/google/ads/googleads/v10/resources/conversion_action.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/conversion_action.proto
index 7296f3542..e8fa5621d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/conversion_action.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/conversion_action.proto
@@ -14,28 +14,28 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/tag_snippet.proto";
-import "google/ads/googleads/v10/enums/attribution_model.proto";
-import "google/ads/googleads/v10/enums/conversion_action_category.proto";
-import "google/ads/googleads/v10/enums/conversion_action_counting_type.proto";
-import "google/ads/googleads/v10/enums/conversion_action_status.proto";
-import "google/ads/googleads/v10/enums/conversion_action_type.proto";
-import "google/ads/googleads/v10/enums/conversion_origin.proto";
-import "google/ads/googleads/v10/enums/data_driven_model_status.proto";
-import "google/ads/googleads/v10/enums/mobile_app_vendor.proto";
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/tag_snippet.proto";
+import "google/ads/googleads/v13/enums/attribution_model.proto";
+import "google/ads/googleads/v13/enums/conversion_action_category.proto";
+import "google/ads/googleads/v13/enums/conversion_action_counting_type.proto";
+import "google/ads/googleads/v13/enums/conversion_action_status.proto";
+import "google/ads/googleads/v13/enums/conversion_action_type.proto";
+import "google/ads/googleads/v13/enums/conversion_origin.proto";
+import "google/ads/googleads/v13/enums/data_driven_model_status.proto";
+import "google/ads/googleads/v13/enums/mobile_app_vendor.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ConversionActionProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Conversion Action resource.
@@ -49,11 +49,14 @@ message ConversionAction {
// Settings related to this conversion action's attribution model.
message AttributionModelSettings {
// The attribution model type of this conversion action.
- google.ads.googleads.v10.enums.AttributionModelEnum.AttributionModel attribution_model = 1;
-
- // Output only. The status of the data-driven attribution model for the conversion
- // action.
- google.ads.googleads.v10.enums.DataDrivenModelStatusEnum.DataDrivenModelStatus data_driven_model_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AttributionModelEnum.AttributionModel
+ attribution_model = 1;
+
+ // Output only. The status of the data-driven attribution model for the
+ // conversion action.
+ google.ads.googleads.v13.enums.DataDrivenModelStatusEnum
+ .DataDrivenModelStatus data_driven_model_status = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Settings related to the value for conversion events associated with this
@@ -91,6 +94,12 @@ message ConversionAction {
// Output only. The Firebase project ID of the conversion.
optional string project_id = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The GA property ID of the conversion.
+ int64 property_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The GA property name of the conversion.
+ string property_name = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Immutable. The resource name of the conversion action.
@@ -114,13 +123,16 @@ message ConversionAction {
optional string name = 22;
// The status of this conversion action for conversion event accrual.
- google.ads.googleads.v10.enums.ConversionActionStatusEnum.ConversionActionStatus status = 4;
+ google.ads.googleads.v13.enums.ConversionActionStatusEnum
+ .ConversionActionStatus status = 4;
// Immutable. The type of this conversion action.
- google.ads.googleads.v10.enums.ConversionActionTypeEnum.ConversionActionType type = 5 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.ConversionActionTypeEnum.ConversionActionType
+ type = 5 [(google.api.field_behavior) = IMMUTABLE];
// Output only. The conversion origin of this conversion action.
- google.ads.googleads.v10.enums.ConversionOriginEnum.ConversionOrigin origin = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.ConversionOriginEnum.ConversionOrigin origin =
+ 30 [(google.api.field_behavior) = OUTPUT_ONLY];
// If a conversion action's primary_for_goal bit is false, the conversion
// action is non-biddable for all campaigns regardless of their customer
@@ -130,15 +142,16 @@ message ConversionAction {
// primary_for_goal = false conversion action, that conversion action is
// still biddable.
// By default, primary_for_goal will be true if not set. In V9,
- // primary_for_goal can only be set to false after creation via an 'update'
- // operation because it's not declared as optional.
+ // primary_for_goal can only be set to false after creation through an
+ // 'update' operation because it's not declared as optional.
optional bool primary_for_goal = 31;
// The category of conversions reported for this conversion action.
- google.ads.googleads.v10.enums.ConversionActionCategoryEnum.ConversionActionCategory category = 6;
+ google.ads.googleads.v13.enums.ConversionActionCategoryEnum
+ .ConversionActionCategory category = 6;
- // Output only. The resource name of the conversion action owner customer, or null if this
- // is a system-defined conversion action.
+ // Output only. The resource name of the conversion action owner customer, or
+ // null if this is a system-defined conversion action.
optional string owner_customer = 23 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -151,7 +164,7 @@ message ConversionAction {
optional bool include_in_conversions_metric = 24;
// The maximum number of days that may elapse between an interaction
- // (e.g., a click) and a conversion event.
+ // (for example, a click) and a conversion event.
optional int64 click_through_lookback_window_days = 25;
// The maximum number of days which may elapse between an impression and a
@@ -163,13 +176,15 @@ message ConversionAction {
ValueSettings value_settings = 11;
// How to count conversion events for the conversion action.
- google.ads.googleads.v10.enums.ConversionActionCountingTypeEnum.ConversionActionCountingType counting_type = 12;
+ google.ads.googleads.v13.enums.ConversionActionCountingTypeEnum
+ .ConversionActionCountingType counting_type = 12;
// Settings related to this conversion action's attribution model.
AttributionModelSettings attribution_model_settings = 13;
// Output only. The snippets used for tracking conversions.
- repeated google.ads.googleads.v10.common.TagSnippet tag_snippets = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.ads.googleads.v13.common.TagSnippet tag_snippets = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The phone call duration in seconds after which a conversion should be
// reported for this conversion action.
@@ -181,11 +196,15 @@ message ConversionAction {
optional string app_id = 28;
// Output only. Mobile app vendor for an app conversion action.
- google.ads.googleads.v10.enums.MobileAppVendorEnum.MobileAppVendor mobile_app_vendor = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.MobileAppVendorEnum.MobileAppVendor
+ mobile_app_vendor = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Firebase settings for Firebase conversion types.
- FirebaseSettings firebase_settings = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
+ FirebaseSettings firebase_settings = 18
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Third Party App Analytics settings for third party conversion types.
- ThirdPartyAppAnalyticsSettings third_party_app_analytics_settings = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Third Party App Analytics settings for third party conversion
+ // types.
+ ThirdPartyAppAnalyticsSettings third_party_app_analytics_settings = 19
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/conversion_custom_variable.proto b/third_party/googleapis/google/ads/googleads/v13/resources/conversion_custom_variable.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/resources/conversion_custom_variable.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/conversion_custom_variable.proto
index f42cc2e2b..43605a4da 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/conversion_custom_variable.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/conversion_custom_variable.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/conversion_custom_variable_status.proto";
+import "google/ads/googleads/v13/enums/conversion_custom_variable_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ConversionCustomVariableProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Conversion Custom Variable resource.
@@ -59,12 +59,11 @@ message ConversionCustomVariable {
// There should not be any extra spaces before and after.
string name = 3 [(google.api.field_behavior) = REQUIRED];
- // Required. Immutable. The tag of the conversion custom variable. It is used in the event snippet
- // and sent to Google Ads along with conversion pings. For conversion uploads
- // in Google Ads API, the resource name of the conversion custom variable is
- // used.
- // Tag should be unique. The maximum size of tag is 100 bytes.
- // There should not be any extra spaces before and after.
+ // Required. Immutable. The tag of the conversion custom variable. It is used
+ // in the event snippet and sent to Google Ads along with conversion pings.
+ // For conversion uploads in Google Ads API, the resource name of the
+ // conversion custom variable is used. Tag should be unique. The maximum size
+ // of tag is 100 bytes. There should not be any extra spaces before and after.
// Currently only lowercase letters, numbers and underscores are allowed in
// the tag.
string tag = 4 [
@@ -73,9 +72,11 @@ message ConversionCustomVariable {
];
// The status of the conversion custom variable for conversion event accrual.
- google.ads.googleads.v10.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5;
+ google.ads.googleads.v13.enums.ConversionCustomVariableStatusEnum
+ .ConversionCustomVariableStatus status = 5;
- // Output only. The resource name of the customer that owns the conversion custom variable.
+ // Output only. The resource name of the customer that owns the conversion
+ // custom variable.
string owner_customer = 6 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/conversion_goal_campaign_config.proto b/third_party/googleapis/google/ads/googleads/v13/resources/conversion_goal_campaign_config.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/resources/conversion_goal_campaign_config.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/conversion_goal_campaign_config.proto
index d7118d64b..c8686ff67 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/conversion_goal_campaign_config.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/conversion_goal_campaign_config.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/goal_config_level.proto";
+import "google/ads/googleads/v13/enums/goal_config_level.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ConversionGoalCampaignConfigProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Conversion goal settings for a Campaign.
message ConversionGoalCampaignConfig {
@@ -47,7 +47,8 @@ message ConversionGoalCampaignConfig {
}
];
- // Immutable. The campaign with which this conversion goal campaign config is associated.
+ // Immutable. The campaign with which this conversion goal campaign config is
+ // associated.
string campaign = 2 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
@@ -56,10 +57,11 @@ message ConversionGoalCampaignConfig {
];
// The level of goal config the campaign is using.
- google.ads.googleads.v10.enums.GoalConfigLevelEnum.GoalConfigLevel goal_config_level = 3;
+ google.ads.googleads.v13.enums.GoalConfigLevelEnum.GoalConfigLevel
+ goal_config_level = 3;
// The custom conversion goal the campaign is using for optimization.
string custom_conversion_goal = 4 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomConversionGoal"
- }];
+ type: "googleads.googleapis.com/CustomConversionGoal"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/conversion_value_rule.proto b/third_party/googleapis/google/ads/googleads/v13/resources/conversion_value_rule.proto
similarity index 61%
rename from third_party/googleapis/google/ads/googleads/v10/resources/conversion_value_rule.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/conversion_value_rule.proto
index 87d85f1a0..a44ffc2d1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/conversion_value_rule.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/conversion_value_rule.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/conversion_value_rule_status.proto";
-import "google/ads/googleads/v10/enums/value_rule_device_type.proto";
-import "google/ads/googleads/v10/enums/value_rule_geo_location_match_type.proto";
-import "google/ads/googleads/v10/enums/value_rule_operation.proto";
+import "google/ads/googleads/v13/enums/conversion_value_rule_status.proto";
+import "google/ads/googleads/v13/enums/value_rule_device_type.proto";
+import "google/ads/googleads/v13/enums/value_rule_geo_location_match_type.proto";
+import "google/ads/googleads/v13/enums/value_rule_operation.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ConversionValueRuleProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Conversion Value Rule resource.
@@ -44,7 +44,8 @@ message ConversionValueRule {
// Action applied when rule is applied.
message ValueRuleAction {
// Specifies applied operation.
- google.ads.googleads.v10.enums.ValueRuleOperationEnum.ValueRuleOperation operation = 1;
+ google.ads.googleads.v13.enums.ValueRuleOperationEnum.ValueRuleOperation
+ operation = 1;
// Specifies applied value.
double value = 2;
@@ -53,39 +54,47 @@ message ConversionValueRule {
// Condition on Geo dimension.
message ValueRuleGeoLocationCondition {
// Geo locations that advertisers want to exclude.
- repeated string excluded_geo_target_constants = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/GeoTargetConstant"
- }];
+ repeated string excluded_geo_target_constants = 1
+ [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/GeoTargetConstant"
+ }];
// Excluded Geo location match type.
- google.ads.googleads.v10.enums.ValueRuleGeoLocationMatchTypeEnum.ValueRuleGeoLocationMatchType excluded_geo_match_type = 2;
+ google.ads.googleads.v13.enums.ValueRuleGeoLocationMatchTypeEnum
+ .ValueRuleGeoLocationMatchType excluded_geo_match_type = 2;
// Geo locations that advertisers want to include.
- repeated string geo_target_constants = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/GeoTargetConstant"
- }];
+ repeated string geo_target_constants = 3
+ [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/GeoTargetConstant"
+ }];
// Included Geo location match type.
- google.ads.googleads.v10.enums.ValueRuleGeoLocationMatchTypeEnum.ValueRuleGeoLocationMatchType geo_match_type = 4;
+ google.ads.googleads.v13.enums.ValueRuleGeoLocationMatchTypeEnum
+ .ValueRuleGeoLocationMatchType geo_match_type = 4;
}
// Condition on Device dimension.
message ValueRuleDeviceCondition {
// Value for device type condition.
- repeated google.ads.googleads.v10.enums.ValueRuleDeviceTypeEnum.ValueRuleDeviceType device_types = 1;
+ repeated google.ads.googleads.v13.enums.ValueRuleDeviceTypeEnum
+ .ValueRuleDeviceType device_types = 1;
}
// Condition on Audience dimension.
message ValueRuleAudienceCondition {
// User Lists.
+ // The Similar Audiences sunset starts May 2023. Refer to
+ // https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html
+ // for other options.
repeated string user_lists = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/UserList"
- }];
+ type: "googleads.googleapis.com/UserList"
+ }];
// User Interests.
repeated string user_interests = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/UserInterest"
- }];
+ type: "googleads.googleapis.com/UserInterest"
+ }];
}
// Immutable. The resource name of the conversion value rule.
@@ -116,11 +125,10 @@ message ConversionValueRule {
// Condition for audience that must be satisfied for the value rule to apply.
ValueRuleAudienceCondition audience_condition = 6;
- // Output only. The resource name of the conversion value rule's owner customer.
- // When the value rule is inherited from a manager
- // customer, owner_customer will be the resource name of the manager whereas
- // the customer in the resource_name will be of the requesting serving
- // customer.
+ // Output only. The resource name of the conversion value rule's owner
+ // customer. When the value rule is inherited from a manager customer,
+ // owner_customer will be the resource name of the manager whereas the
+ // customer in the resource_name will be of the requesting serving customer.
// ** Read-only **
string owner_customer = 7 [
(google.api.field_behavior) = OUTPUT_ONLY,
@@ -130,5 +138,6 @@ message ConversionValueRule {
];
// The status of the conversion value rule.
- google.ads.googleads.v10.enums.ConversionValueRuleStatusEnum.ConversionValueRuleStatus status = 8;
+ google.ads.googleads.v13.enums.ConversionValueRuleStatusEnum
+ .ConversionValueRuleStatus status = 8;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/conversion_value_rule_set.proto b/third_party/googleapis/google/ads/googleads/v13/resources/conversion_value_rule_set.proto
similarity index 61%
rename from third_party/googleapis/google/ads/googleads/v10/resources/conversion_value_rule_set.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/conversion_value_rule_set.proto
index c8d9da75a..960bbbe59 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/conversion_value_rule_set.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/conversion_value_rule_set.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/conversion_action_category.proto";
-import "google/ads/googleads/v10/enums/conversion_value_rule_set_status.proto";
-import "google/ads/googleads/v10/enums/value_rule_set_attachment_type.proto";
-import "google/ads/googleads/v10/enums/value_rule_set_dimension.proto";
+import "google/ads/googleads/v13/enums/conversion_action_category.proto";
+import "google/ads/googleads/v13/enums/conversion_value_rule_set_status.proto";
+import "google/ads/googleads/v13/enums/value_rule_set_attachment_type.proto";
+import "google/ads/googleads/v13/enums/value_rule_set_dimension.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ConversionValueRuleSetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Conversion Value Rule Set resource.
@@ -56,9 +56,10 @@ message ConversionValueRuleSet {
int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Resource names of rules within the rule set.
- repeated string conversion_value_rules = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionValueRule"
- }];
+ repeated string conversion_value_rules = 3
+ [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/ConversionValueRule"
+ }];
// Defines dimensions for Value Rule conditions. The condition types of value
// rules within this value rule set must be of these dimensions. The first
@@ -66,13 +67,13 @@ message ConversionValueRuleSet {
// When using value rule primary dimension segmentation, conversion values
// will be segmented into the values adjusted by value rules and the original
// values, if some value rules apply.
- repeated google.ads.googleads.v10.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4;
+ repeated google.ads.googleads.v13.enums.ValueRuleSetDimensionEnum
+ .ValueRuleSetDimension dimensions = 4;
- // Output only. The resource name of the conversion value rule set's owner customer.
- // When the value rule set is inherited from a manager
- // customer, owner_customer will be the resource name of the manager whereas
- // the customer in the resource_name will be of the requesting serving
- // customer.
+ // Output only. The resource name of the conversion value rule set's owner
+ // customer. When the value rule set is inherited from a manager customer,
+ // owner_customer will be the resource name of the manager whereas the
+ // customer in the resource_name will be of the requesting serving customer.
// ** Read-only **
string owner_customer = 5 [
(google.api.field_behavior) = OUTPUT_ONLY,
@@ -81,19 +82,27 @@ message ConversionValueRuleSet {
}
];
- // Immutable. Defines the scope where the conversion value rule set is attached.
- google.ads.googleads.v10.enums.ValueRuleSetAttachmentTypeEnum.ValueRuleSetAttachmentType attachment_type = 6 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. Defines the scope where the conversion value rule set is
+ // attached.
+ google.ads.googleads.v13.enums.ValueRuleSetAttachmentTypeEnum
+ .ValueRuleSetAttachmentType attachment_type = 6
+ [(google.api.field_behavior) = IMMUTABLE];
// The resource name of the campaign when the conversion value rule
// set is attached to a campaign.
string campaign = 7 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Campaign"
- }];
+ type: "googleads.googleapis.com/Campaign"
+ }];
// Output only. The status of the conversion value rule set.
// ** Read-only **
- google.ads.googleads.v10.enums.ConversionValueRuleSetStatusEnum.ConversionValueRuleSetStatus status = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.ConversionValueRuleSetStatusEnum
+ .ConversionValueRuleSetStatus status = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. The conversion action categories of the conversion value rule set.
- repeated google.ads.googleads.v10.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. The conversion action categories of the conversion value rule
+ // set.
+ repeated google.ads.googleads.v13.enums.ConversionActionCategoryEnum
+ .ConversionActionCategory conversion_action_categories = 9
+ [(google.api.field_behavior) = IMMUTABLE];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/currency_constant.proto b/third_party/googleapis/google/ads/googleads/v13/resources/currency_constant.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/resources/currency_constant.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/currency_constant.proto
index 1c3b001ed..9c09cf973 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/currency_constant.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/currency_constant.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CurrencyConstantProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Currency Constant resource.
@@ -48,16 +48,18 @@ message CurrencyConstant {
}
];
- // Output only. ISO 4217 three-letter currency code, e.g. "USD"
+ // Output only. ISO 4217 three-letter currency code, for example, "USD"
optional string code = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Full English name of the currency.
optional string name = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Standard symbol for describing this currency, e.g. '$' for US Dollars.
+ // Output only. Standard symbol for describing this currency, for example, '$'
+ // for US Dollars.
optional string symbol = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The billable unit for this currency. Billed amounts should be multiples of
- // this value.
- optional int64 billable_unit_micros = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The billable unit for this currency. Billed amounts should be
+ // multiples of this value.
+ optional int64 billable_unit_micros = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/custom_audience.proto b/third_party/googleapis/google/ads/googleads/v13/resources/custom_audience.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/resources/custom_audience.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/custom_audience.proto
index 71cef4f17..ad84596a2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/custom_audience.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/custom_audience.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/custom_audience_member_type.proto";
-import "google/ads/googleads/v10/enums/custom_audience_status.proto";
-import "google/ads/googleads/v10/enums/custom_audience_type.proto";
+import "google/ads/googleads/v13/enums/custom_audience_member_type.proto";
+import "google/ads/googleads/v13/enums/custom_audience_status.proto";
+import "google/ads/googleads/v13/enums/custom_audience_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomAudienceProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Custom Audience resource.
@@ -54,9 +54,10 @@ message CustomAudience {
// Output only. ID of the custom audience.
int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Status of this custom audience. Indicates whether the custom audience is
- // enabled or removed.
- google.ads.googleads.v10.enums.CustomAudienceStatusEnum.CustomAudienceStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Status of this custom audience. Indicates whether the custom
+ // audience is enabled or removed.
+ google.ads.googleads.v13.enums.CustomAudienceStatusEnum.CustomAudienceStatus
+ status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Name of the custom audience. It should be unique for all custom audiences
// created by a customer.
@@ -66,7 +67,8 @@ message CustomAudience {
// Type of the custom audience.
// ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom
// audience but kept for existing audiences)
- google.ads.googleads.v10.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5;
+ google.ads.googleads.v13.enums.CustomAudienceTypeEnum.CustomAudienceType
+ type = 5;
// Description of this custom audience.
string description = 6;
@@ -81,7 +83,8 @@ message CustomAudience {
// PLACE_CATEGORY or APP. It can only be created or removed but not changed.
message CustomAudienceMember {
// The type of custom audience member, KEYWORD, URL, PLACE_CATEGORY or APP.
- google.ads.googleads.v10.enums.CustomAudienceMemberTypeEnum.CustomAudienceMemberType member_type = 1;
+ google.ads.googleads.v13.enums.CustomAudienceMemberTypeEnum
+ .CustomAudienceMemberType member_type = 1;
// The CustomAudienceMember value. One field is populated depending on the
// member type.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/custom_conversion_goal.proto b/third_party/googleapis/google/ads/googleads/v13/resources/custom_conversion_goal.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/resources/custom_conversion_goal.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/custom_conversion_goal.proto
index b2347c5e4..74b6d43f6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/custom_conversion_goal.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/custom_conversion_goal.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/custom_conversion_goal_status.proto";
+import "google/ads/googleads/v13/enums/custom_conversion_goal_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomConversionGoalProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Custom conversion goal that can make arbitrary conversion actions biddable.
message CustomConversionGoal {
@@ -55,9 +55,10 @@ message CustomConversionGoal {
// Conversion actions that the custom conversion goal makes biddable.
repeated string conversion_actions = 4 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionAction"
- }];
+ type: "googleads.googleapis.com/ConversionAction"
+ }];
// The status of the custom conversion goal.
- google.ads.googleads.v10.enums.CustomConversionGoalStatusEnum.CustomConversionGoalStatus status = 5;
+ google.ads.googleads.v13.enums.CustomConversionGoalStatusEnum
+ .CustomConversionGoalStatus status = 5;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/custom_interest.proto b/third_party/googleapis/google/ads/googleads/v13/resources/custom_interest.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/resources/custom_interest.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/custom_interest.proto
index 2fe77eb59..8589ddbd6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/custom_interest.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/custom_interest.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/custom_interest_member_type.proto";
-import "google/ads/googleads/v10/enums/custom_interest_status.proto";
-import "google/ads/googleads/v10/enums/custom_interest_type.proto";
+import "google/ads/googleads/v13/enums/custom_interest_member_type.proto";
+import "google/ads/googleads/v13/enums/custom_interest_status.proto";
+import "google/ads/googleads/v13/enums/custom_interest_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomInterestProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Custom Interest resource.
@@ -56,7 +56,8 @@ message CustomInterest {
// Status of this custom interest. Indicates whether the custom interest is
// enabled or removed.
- google.ads.googleads.v10.enums.CustomInterestStatusEnum.CustomInterestStatus status = 3;
+ google.ads.googleads.v13.enums.CustomInterestStatusEnum.CustomInterestStatus
+ status = 3;
// Name of the custom interest. It should be unique across the same custom
// affinity audience.
@@ -65,7 +66,8 @@ message CustomInterest {
// Type of the custom interest, CUSTOM_AFFINITY or CUSTOM_INTENT.
// By default the type is set to CUSTOM_AFFINITY.
- google.ads.googleads.v10.enums.CustomInterestTypeEnum.CustomInterestType type = 5;
+ google.ads.googleads.v13.enums.CustomInterestTypeEnum.CustomInterestType
+ type = 5;
// Description of this custom interest audience.
optional string description = 10;
@@ -80,7 +82,8 @@ message CustomInterest {
// It is immutable, that is, it can only be created or removed but not changed.
message CustomInterestMember {
// The type of custom interest member, KEYWORD or URL.
- google.ads.googleads.v10.enums.CustomInterestMemberTypeEnum.CustomInterestMemberType member_type = 1;
+ google.ads.googleads.v13.enums.CustomInterestMemberTypeEnum
+ .CustomInterestMemberType member_type = 1;
// Keyword text when member_type is KEYWORD or URL string when
// member_type is URL.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer.proto
similarity index 53%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer.proto
index 9d582115a..2402506fd 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/conversion_tracking_status_enum.proto";
-import "google/ads/googleads/v10/enums/customer_pay_per_conversion_eligibility_failure_reason.proto";
-import "google/ads/googleads/v10/enums/customer_status.proto";
+import "google/ads/googleads/v13/enums/conversion_tracking_status_enum.proto";
+import "google/ads/googleads/v13/enums/customer_pay_per_conversion_eligibility_failure_reason.proto";
+import "google/ads/googleads/v13/enums/customer_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Customer resource.
@@ -66,18 +66,22 @@ message Customer {
optional string time_zone = 22 [(google.api.field_behavior) = IMMUTABLE];
// The URL template for constructing a tracking URL out of parameters.
+ // Only mutable in an `update` operation.
optional string tracking_url_template = 23;
- // The URL template for appending params to the final URL
+ // The URL template for appending params to the final URL.
+ // Only mutable in an `update` operation.
optional string final_url_suffix = 24;
// Whether auto-tagging is enabled for the customer.
optional bool auto_tagging_enabled = 25;
- // Output only. Whether the Customer has a Partners program badge. If the Customer is not
- // associated with the Partners program, this will be false. For more
- // information, see https://support.google.com/partners/answer/3125774.
- optional bool has_partners_badge = 26 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Whether the Customer has a Partners program badge. If the
+ // Customer is not associated with the Partners program, this will be false.
+ // For more information, see
+ // https://support.google.com/partners/answer/3125774.
+ optional bool has_partners_badge = 26
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Whether the customer is a manager.
optional bool manager = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -85,18 +89,26 @@ message Customer {
// Output only. Whether the customer is a test account.
optional bool test_account = 28 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Call reporting setting for a customer.
+ // Call reporting setting for a customer. Only mutable in an `update`
+ // operation.
CallReportingSetting call_reporting_setting = 10;
// Output only. Conversion tracking setting for a customer.
- ConversionTrackingSetting conversion_tracking_setting = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ ConversionTrackingSetting conversion_tracking_setting = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Remarketing setting for a customer.
- RemarketingSetting remarketing_setting = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ RemarketingSetting remarketing_setting = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If
- // the list is empty, the customer is eligible. This field is read-only.
- repeated google.ads.googleads.v10.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Reasons why the customer is not eligible to use
+ // PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible.
+ // This field is read-only.
+ repeated google.ads.googleads.v13.enums
+ .CustomerPayPerConversionEligibilityFailureReasonEnum
+ .CustomerPayPerConversionEligibilityFailureReason
+ pay_per_conversion_eligibility_failure_reasons = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Optimization score of the customer.
//
@@ -108,7 +120,8 @@ message Customer {
// https://support.google.com/google-ads/answer/9061546.
//
// This field is read-only.
- optional double optimization_score = 29 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional double optimization_score = 29
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Optimization score weight of the customer.
//
@@ -120,15 +133,37 @@ message Customer {
// customers.
//
// This field is read-only.
- double optimization_score_weight = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
+ double optimization_score_weight = 30
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The status of the customer.
- google.ads.googleads.v10.enums.CustomerStatusEnum.CustomerStatus status = 36 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CustomerStatusEnum.CustomerStatus status = 36
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. True if feed based location has been migrated to asset based
+ // location.
+ optional bool location_asset_auto_migration_done = 38
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. True if feed based image has been migrated to asset based
+ // image.
+ optional bool image_asset_auto_migration_done = 39
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Timestamp of migration from feed based location to asset base
+ // location in yyyy-MM-dd HH:mm:ss format.
+ optional string location_asset_auto_migration_done_date_time = 40
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Timestamp of migration from feed based image to asset base
+ // image in yyyy-MM-dd HH:mm:ss format.
+ optional string image_asset_auto_migration_done_date_time = 41
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Call reporting setting for a customer.
+// Call reporting setting for a customer. Only mutable in an `update` operation.
message CallReportingSetting {
- // Enable reporting of phone call events by redirecting them via Google
+ // Enable reporting of phone call events by redirecting them through Google
// System.
optional bool call_reporting_enabled = 10;
@@ -138,50 +173,59 @@ message CallReportingSetting {
// Customer-level call conversion action to attribute a call conversion to.
// If not set a default conversion action is used. Only in effect when
// call_conversion_reporting_enabled is set to true.
- optional string call_conversion_action = 12 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionAction"
- }];
+ optional string call_conversion_action = 12
+ [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/ConversionAction"
+ }];
}
// A collection of customer-wide settings related to Google Ads Conversion
// Tracking.
message ConversionTrackingSetting {
- // Output only. The conversion tracking id used for this account. This id is automatically
- // assigned after any conversion tracking feature is used. If the customer
- // doesn't use conversion tracking, this is 0. This field is read-only.
- optional int64 conversion_tracking_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The conversion tracking id of the customer's manager. This is set when the
- // customer is opted into cross account conversion tracking, and it overrides
- // conversion_tracking_id. This field can only be managed through the Google
- // Ads UI. This field is read-only.
- optional int64 cross_account_conversion_tracking_id = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Whether the customer has accepted customer data terms. If using
- // cross-account conversion tracking, this value is inherited from the
+ // Output only. The conversion tracking id used for this account. This id
+ // doesn't indicate whether the customer uses conversion tracking
+ // (conversion_tracking_status does). This field is read-only.
+ optional int64 conversion_tracking_id = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The conversion tracking id of the customer's manager. This is
+ // set when the customer is opted into cross account conversion tracking, and
+ // it overrides conversion_tracking_id. This field can only be managed through
+ // the Google Ads UI. This field is read-only.
+ optional int64 cross_account_conversion_tracking_id = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Whether the customer has accepted customer data terms. If
+ // using cross-account conversion tracking, this value is inherited from the
// manager. This field is read-only. For more
// information, see https://support.google.com/adspolicy/answer/7475709.
- bool accepted_customer_data_terms = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ bool accepted_customer_data_terms = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Conversion tracking status. It indicates whether the customer is using
- // conversion tracking, and who is the conversion tracking owner of this
- // customer. If this customer is using cross-account conversion tracking,
+ // Output only. Conversion tracking status. It indicates whether the customer
+ // is using conversion tracking, and who is the conversion tracking owner of
+ // this customer. If this customer is using cross-account conversion tracking,
// the value returned will differ based on the `login-customer-id` of the
// request.
- google.ads.googleads.v10.enums.ConversionTrackingStatusEnum.ConversionTrackingStatus conversion_tracking_status = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.ConversionTrackingStatusEnum
+ .ConversionTrackingStatus conversion_tracking_status = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Whether the customer is opted-in for enhanced conversions
// for leads. If using cross-account conversion tracking, this value is
// inherited from the manager. This field is read-only.
- bool enhanced_conversions_for_leads_enabled = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ bool enhanced_conversions_for_leads_enabled = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The resource name of the customer where conversions are created and
- // managed. This field is read-only.
- string google_ads_conversion_customer = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The resource name of the customer where conversions are
+ // created and managed. This field is read-only.
+ string google_ads_conversion_customer = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Remarketing setting for a customer.
message RemarketingSetting {
// Output only. The Google tag.
- optional string google_global_site_tag = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string google_global_site_tag = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/customer_asset.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_asset.proto
new file mode 100644
index 000000000..e08b5e282
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_asset.proto
@@ -0,0 +1,98 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/asset_policy.proto";
+import "google/ads/googleads/v13/enums/asset_field_type.proto";
+import "google/ads/googleads/v13/enums/asset_link_primary_status.proto";
+import "google/ads/googleads/v13/enums/asset_link_primary_status_reason.proto";
+import "google/ads/googleads/v13/enums/asset_link_status.proto";
+import "google/ads/googleads/v13/enums/asset_source.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "CustomerAssetProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the CustomerAsset resource.
+
+// A link between a customer and an asset.
+message CustomerAsset {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/CustomerAsset"
+ pattern: "customers/{customer_id}/customerAssets/{asset_id}~{field_type}"
+ };
+
+ // Immutable. The resource name of the customer asset.
+ // CustomerAsset resource names have the form:
+ //
+ // `customers/{customer_id}/customerAssets/{asset_id}~{field_type}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/CustomerAsset"
+ }
+ ];
+
+ // Required. Immutable. The asset which is linked to the customer.
+ string asset = 2 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
+ ];
+
+ // Required. Immutable. Role that the asset takes for the customer link.
+ google.ads.googleads.v13.enums.AssetFieldTypeEnum.AssetFieldType field_type =
+ 3 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.field_behavior) = IMMUTABLE
+ ];
+
+ // Output only. Source of the customer asset link.
+ google.ads.googleads.v13.enums.AssetSourceEnum.AssetSource source = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Status of the customer asset.
+ google.ads.googleads.v13.enums.AssetLinkStatusEnum.AssetLinkStatus status = 4;
+
+ // Output only. Provides the PrimaryStatus of this asset link.
+ // Primary status is meant essentially to differentiate between the plain
+ // "status" field, which has advertiser set values of enabled, paused, or
+ // removed. The primary status takes into account other signals (for assets
+ // its mainly policy and quality approvals) to come up with a more
+ // comprehensive status to indicate its serving state.
+ google.ads.googleads.v13.enums.AssetLinkPrimaryStatusEnum
+ .AssetLinkPrimaryStatus primary_status = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Provides the details of the primary status and its associated
+ // reasons.
+ repeated google.ads.googleads.v13.common.AssetLinkPrimaryStatusDetails
+ primary_status_details = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Provides a list of reasons for why an asset is not serving or
+ // not serving at full capacity.
+ repeated google.ads.googleads.v13.enums.AssetLinkPrimaryStatusReasonEnum
+ .AssetLinkPrimaryStatusReason primary_status_reasons = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/customer_asset_set.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_asset_set.proto
new file mode 100644
index 000000000..c60ae79b2
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_asset_set.proto
@@ -0,0 +1,72 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/enums/asset_set_link_status.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "CustomerAssetSetProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the CustomerAssetSet resource.
+
+// CustomerAssetSet is the linkage between a customer and an asset set.
+// Adding a CustomerAssetSet links an asset set with a customer.
+message CustomerAssetSet {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/CustomerAssetSet"
+ pattern: "customers/{customer_id}/customerAssetSets/{asset_set_id}"
+ };
+
+ // Immutable. The resource name of the customer asset set.
+ // Asset set asset resource names have the form:
+ //
+ // `customers/{customer_id}/customerAssetSets/{asset_set_id}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/CustomerAssetSet"
+ }
+ ];
+
+ // Immutable. The asset set which is linked to the customer.
+ string asset_set = 2 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AssetSet"
+ }
+ ];
+
+ // Immutable. The customer to which this asset set is linked.
+ string customer = 3 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/Customer"
+ }
+ ];
+
+ // Output only. The status of the customer asset set asset. Read-only.
+ google.ads.googleads.v13.enums.AssetSetLinkStatusEnum.AssetSetLinkStatus
+ status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_client.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_client.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer_client.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer_client.proto
index 5e142edb0..6bab27520 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_client.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_client.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/customer_status.proto";
+import "google/ads/googleads/v13/enums/customer_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerClientProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the CustomerClient resource.
@@ -64,12 +64,12 @@ message CustomerClient {
// Read only.
optional bool hidden = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Distance between given customer and client. For self link, the level value
- // will be 0. Read only.
+ // Output only. Distance between given customer and client. For self link, the
+ // level value will be 0. Read only.
optional int64 level = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Common Locale Data Repository (CLDR) string representation of the
- // time zone of the client, e.g. America/Los_Angeles. Read only.
+ // Output only. Common Locale Data Repository (CLDR) string representation of
+ // the time zone of the client, for example, America/Los_Angeles. Read only.
optional string time_zone = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Identifies if the client is a test account. Read only.
@@ -79,26 +79,28 @@ message CustomerClient {
optional bool manager = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Descriptive name for the client. Read only.
- optional string descriptive_name = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string descriptive_name = 18
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Currency code (e.g. 'USD', 'EUR') for the client. Read only.
- optional string currency_code = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Currency code (for example, 'USD', 'EUR') for the client. Read
+ // only.
+ optional string currency_code = 19
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The ID of the client customer. Read only.
optional int64 id = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The resource names of the labels owned by the requesting customer that are
- // applied to the client customer.
- // Label resource names have the form:
+ // Output only. The resource names of the labels owned by the requesting
+ // customer that are applied to the client customer. Label resource names have
+ // the form:
//
// `customers/{customer_id}/labels/{label_id}`
repeated string applied_labels = 21 [
(google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Label"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Label" }
];
// Output only. The status of the client customer. Read only.
- google.ads.googleads.v10.enums.CustomerStatusEnum.CustomerStatus status = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CustomerStatusEnum.CustomerStatus status = 22
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_client_link.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_client_link.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer_client_link.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer_client_link.proto
index 7f769aafe..ae4b554d7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_client_link.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_client_link.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/manager_link_status.proto";
+import "google/ads/googleads/v13/enums/manager_link_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerClientLinkProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the CustomerClientLink resource.
@@ -57,10 +57,12 @@ message CustomerClientLink {
];
// Output only. This is uniquely identifies a customer client link. Read only.
- optional int64 manager_link_id = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 manager_link_id = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// This is the status of the link between client and manager.
- google.ads.googleads.v10.enums.ManagerLinkStatusEnum.ManagerLinkStatus status = 5;
+ google.ads.googleads.v13.enums.ManagerLinkStatusEnum.ManagerLinkStatus
+ status = 5;
// The visibility of the link. Users can choose whether or not to see hidden
// links in the Google Ads UI.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_conversion_goal.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_conversion_goal.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer_conversion_goal.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer_conversion_goal.proto
index 3e9b20748..b89f7e41f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_conversion_goal.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_conversion_goal.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/conversion_action_category.proto";
-import "google/ads/googleads/v10/enums/conversion_origin.proto";
+import "google/ads/googleads/v13/enums/conversion_action_category.proto";
+import "google/ads/googleads/v13/enums/conversion_origin.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerConversionGoalProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Biddability control for conversion actions with a matching category and
// origin.
@@ -51,12 +51,14 @@ message CustomerConversionGoal {
// The conversion category of this customer conversion goal. Only
// conversion actions that have this category will be included in this goal.
- google.ads.googleads.v10.enums.ConversionActionCategoryEnum.ConversionActionCategory category = 2;
+ google.ads.googleads.v13.enums.ConversionActionCategoryEnum
+ .ConversionActionCategory category = 2;
// The conversion origin of this customer conversion goal. Only
// conversion actions that have this conversion origin will be included in
// this goal.
- google.ads.googleads.v10.enums.ConversionOriginEnum.ConversionOrigin origin = 3;
+ google.ads.googleads.v13.enums.ConversionOriginEnum.ConversionOrigin origin =
+ 3;
// The biddability of the customer conversion goal.
bool biddable = 4;
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_customizer.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_customizer.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer_customizer.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer_customizer.proto
index 7b5d8d7c0..b51cc95d1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_customizer.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_customizer.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/customizer_value.proto";
-import "google/ads/googleads/v10/enums/customizer_value_status.proto";
+import "google/ads/googleads/v13/common/customizer_value.proto";
+import "google/ads/googleads/v13/enums/customizer_value_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerCustomizerProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// A customizer value for the associated CustomizerAttribute at the Customer
// level.
@@ -49,7 +49,8 @@ message CustomerCustomizer {
}
];
- // Required. Immutable. The customizer attribute which is linked to the customer.
+ // Required. Immutable. The customizer attribute which is linked to the
+ // customer.
string customizer_attribute = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE,
@@ -59,9 +60,11 @@ message CustomerCustomizer {
];
// Output only. The status of the customer customizer attribute.
- google.ads.googleads.v10.enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CustomizerValueStatusEnum.CustomizerValueStatus
+ status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. The value to associate with the customizer attribute at this level. The
- // value must be of the type specified for the CustomizerAttribute.
- google.ads.googleads.v10.common.CustomizerValue value = 4 [(google.api.field_behavior) = REQUIRED];
+ // Required. The value to associate with the customizer attribute at this
+ // level. The value must be of the type specified for the CustomizerAttribute.
+ google.ads.googleads.v13.common.CustomizerValue value = 4
+ [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_extension_setting.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_extension_setting.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer_extension_setting.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer_extension_setting.proto
index b17980bc2..c94b99028 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_extension_setting.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_extension_setting.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/extension_setting_device.proto";
-import "google/ads/googleads/v10/enums/extension_type.proto";
+import "google/ads/googleads/v13/enums/extension_setting_device.proto";
+import "google/ads/googleads/v13/enums/extension_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerExtensionSettingProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the CustomerExtensionSetting resource.
@@ -51,16 +51,18 @@ message CustomerExtensionSetting {
];
// Immutable. The extension type of the customer extension setting.
- google.ads.googleads.v10.enums.ExtensionTypeEnum.ExtensionType extension_type = 2 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.ExtensionTypeEnum.ExtensionType
+ extension_type = 2 [(google.api.field_behavior) = IMMUTABLE];
// The resource names of the extension feed items to serve under the customer.
// ExtensionFeedItem resource names have the form:
//
// `customers/{customer_id}/extensionFeedItems/{feed_item_id}`
repeated string extension_feed_items = 5 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ExtensionFeedItem"
- }];
+ type: "googleads.googleapis.com/ExtensionFeedItem"
+ }];
// The device for which the extensions will serve. Optional.
- google.ads.googleads.v10.enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 4;
+ google.ads.googleads.v13.enums.ExtensionSettingDeviceEnum
+ .ExtensionSettingDevice device = 4;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_feed.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_feed.proto
similarity index 68%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer_feed.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer_feed.proto
index 746c335df..627cbf886 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_feed.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_feed.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/matching_function.proto";
-import "google/ads/googleads/v10/enums/feed_link_status.proto";
-import "google/ads/googleads/v10/enums/placeholder_type.proto";
+import "google/ads/googleads/v13/common/matching_function.proto";
+import "google/ads/googleads/v13/enums/feed_link_status.proto";
+import "google/ads/googleads/v13/enums/placeholder_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerFeedProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the CustomerFeed resource.
@@ -54,21 +54,21 @@ message CustomerFeed {
// Immutable. The feed being linked to the customer.
optional string feed = 6 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Feed" }
];
// Indicates which placeholder types the feed may populate under the connected
// customer. Required.
- repeated google.ads.googleads.v10.enums.PlaceholderTypeEnum.PlaceholderType placeholder_types = 3;
+ repeated google.ads.googleads.v13.enums.PlaceholderTypeEnum.PlaceholderType
+ placeholder_types = 3;
// Matching function associated with the CustomerFeed.
// The matching function is used to filter the set of feed items selected.
// Required.
- google.ads.googleads.v10.common.MatchingFunction matching_function = 4;
+ google.ads.googleads.v13.common.MatchingFunction matching_function = 4;
// Output only. Status of the customer feed.
// This field is read-only.
- google.ads.googleads.v10.enums.FeedLinkStatusEnum.FeedLinkStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.FeedLinkStatusEnum.FeedLinkStatus status = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_label.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_label.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer_label.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer_label.proto
index 7ae9ab54b..9ae985cd8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_label.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_label.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerLabelProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the customer label resource.
@@ -49,8 +49,8 @@ message CustomerLabel {
}
];
- // Output only. The resource name of the customer to which the label is attached.
- // Read only.
+ // Output only. The resource name of the customer to which the label is
+ // attached. Read only.
optional string customer = 4 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -64,8 +64,6 @@ message CustomerLabel {
// validated when creating a new CustomerLabel.
optional string label = 5 [
(google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Label"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Label" }
];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_manager_link.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_manager_link.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer_manager_link.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer_manager_link.proto
index e4aebf838..5aafbf04d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_manager_link.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_manager_link.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/manager_link_status.proto";
+import "google/ads/googleads/v13/enums/manager_link_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerManagerLinkProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the CustomerManagerLink resource.
@@ -57,8 +57,10 @@ message CustomerManagerLink {
];
// Output only. ID of the customer-manager link. This field is read only.
- optional int64 manager_link_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 manager_link_id = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Status of the link between the customer and the manager.
- google.ads.googleads.v10.enums.ManagerLinkStatusEnum.ManagerLinkStatus status = 5;
+ google.ads.googleads.v13.enums.ManagerLinkStatusEnum.ManagerLinkStatus
+ status = 5;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_negative_criterion.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_negative_criterion.proto
similarity index 61%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer_negative_criterion.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer_negative_criterion.proto
index b17b4d49d..2bbc1a326 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_negative_criterion.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_negative_criterion.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/enums/criterion_type.proto";
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/enums/criterion_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerNegativeCriterionProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Customer Negative Criterion resource.
@@ -54,28 +54,35 @@ message CustomerNegativeCriterion {
optional int64 id = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The type of the criterion.
- google.ads.googleads.v10.enums.CriterionTypeEnum.CriterionType type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CriterionTypeEnum.CriterionType type = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The customer negative criterion.
//
// Exactly one must be set.
oneof criterion {
// Immutable. ContentLabel.
- google.ads.googleads.v10.common.ContentLabelInfo content_label = 4 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.ContentLabelInfo content_label = 4
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. MobileApplication.
- google.ads.googleads.v10.common.MobileApplicationInfo mobile_application = 5 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.MobileApplicationInfo mobile_application = 5
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. MobileAppCategory.
- google.ads.googleads.v10.common.MobileAppCategoryInfo mobile_app_category = 6 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.MobileAppCategoryInfo mobile_app_category =
+ 6 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Placement.
- google.ads.googleads.v10.common.PlacementInfo placement = 7 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.PlacementInfo placement = 7
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. YouTube Video.
- google.ads.googleads.v10.common.YouTubeVideoInfo youtube_video = 8 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.YouTubeVideoInfo youtube_video = 8
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. YouTube Channel.
- google.ads.googleads.v10.common.YouTubeChannelInfo youtube_channel = 9 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.YouTubeChannelInfo youtube_channel = 9
+ [(google.api.field_behavior) = IMMUTABLE];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_user_access.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_user_access.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer_user_access.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer_user_access.proto
index 4a950bb2c..fb805434c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_user_access.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_user_access.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/access_role.proto";
+import "google/ads/googleads/v13/enums/access_role.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerUserAccessProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the CustomerUserAccess resource.
@@ -57,15 +57,17 @@ message CustomerUserAccess {
optional string email_address = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Access role of the user.
- google.ads.googleads.v10.enums.AccessRoleEnum.AccessRole access_role = 4;
+ google.ads.googleads.v13.enums.AccessRoleEnum.AccessRole access_role = 4;
// Output only. The customer user access creation time.
// Read only field
// The format is "YYYY-MM-DD HH:MM:SS".
// Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
- optional string access_creation_date_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string access_creation_date_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The email address of the inviter user.
// Read only field
- optional string inviter_user_email_address = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string inviter_user_email_address = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customer_user_access_invitation.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customer_user_access_invitation.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customer_user_access_invitation.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customer_user_access_invitation.proto
index eb074bc79..da9ab7b73 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customer_user_access_invitation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customer_user_access_invitation.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/access_invitation_status.proto";
-import "google/ads/googleads/v10/enums/access_role.proto";
+import "google/ads/googleads/v13/enums/access_invitation_status.proto";
+import "google/ads/googleads/v13/enums/access_role.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomerUserAccessInvitationProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the CustomerUserAccessInvitation resource.
@@ -54,7 +54,8 @@ message CustomerUserAccessInvitation {
int64 invitation_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. Access role of the user.
- google.ads.googleads.v10.enums.AccessRoleEnum.AccessRole access_role = 3 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.AccessRoleEnum.AccessRole access_role = 3
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Email address the invitation was sent to.
// This can differ from the email address of the account
@@ -68,5 +69,7 @@ message CustomerUserAccessInvitation {
string creation_date_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Invitation status of the user.
- google.ads.googleads.v10.enums.AccessInvitationStatusEnum.AccessInvitationStatus invitation_status = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AccessInvitationStatusEnum
+ .AccessInvitationStatus invitation_status = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/customizer_attribute.proto b/third_party/googleapis/google/ads/googleads/v13/resources/customizer_attribute.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/resources/customizer_attribute.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/customizer_attribute.proto
index fdfd8150f..2cbf76591 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/customizer_attribute.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/customizer_attribute.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/customizer_attribute_status.proto";
-import "google/ads/googleads/v10/enums/customizer_attribute_type.proto";
+import "google/ads/googleads/v13/enums/customizer_attribute_status.proto";
+import "google/ads/googleads/v13/enums/customizer_attribute_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "CustomizerAttributeProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// A customizer attribute.
// Use CustomerCustomizer, CampaignCustomizer, AdGroupCustomizer, or
@@ -55,17 +55,21 @@ message CustomizerAttribute {
// Output only. The ID of the customizer attribute.
int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. Immutable. Name of the customizer attribute. Required. It must have a minimum length
- // of 1 and maximum length of 40. Name of an enabled customizer attribute must
- // be unique (case insensitive).
+ // Required. Immutable. Name of the customizer attribute. Required. It must
+ // have a minimum length of 1 and maximum length of 40. Name of an enabled
+ // customizer attribute must be unique (case insensitive).
string name = 3 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
];
// Immutable. The type of the customizer attribute.
- google.ads.googleads.v10.enums.CustomizerAttributeTypeEnum.CustomizerAttributeType type = 4 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.CustomizerAttributeTypeEnum
+ .CustomizerAttributeType type = 4
+ [(google.api.field_behavior) = IMMUTABLE];
// Output only. The status of the customizer attribute.
- google.ads.googleads.v10.enums.CustomizerAttributeStatusEnum.CustomizerAttributeStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CustomizerAttributeStatusEnum
+ .CustomizerAttributeStatus status = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/detail_placement_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/detail_placement_view.proto
similarity index 63%
rename from third_party/googleapis/google/ads/googleads/v10/resources/detail_placement_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/detail_placement_view.proto
index bdd4a47da..39a3662b2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/detail_placement_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/detail_placement_view.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/placement_type.proto";
+import "google/ads/googleads/v13/enums/placement_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "DetailPlacementViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the detail placement view resource.
@@ -49,22 +49,25 @@ message DetailPlacementView {
}
];
- // Output only. The automatic placement string at detail level, e. g. website URL, mobile
- // application ID, or a YouTube video ID.
+ // Output only. The automatic placement string at detail level, e. g. website
+ // URL, mobile application ID, or a YouTube video ID.
optional string placement = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The display name is URL name for websites, YouTube video name for YouTube
- // videos, and translated mobile app name for mobile apps.
+ // Output only. The display name is URL name for websites, YouTube video name
+ // for YouTube videos, and translated mobile app name for mobile apps.
optional string display_name = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. URL of the group placement, e.g. domain, link to the mobile application in
- // app store, or a YouTube channel URL.
- optional string group_placement_target_url = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. URL of the group placement, for example, domain, link to the
+ // mobile application in app store, or a YouTube channel URL.
+ optional string group_placement_target_url = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. URL of the placement, e.g. website, link to the mobile application in app
- // store, or a YouTube video URL.
+ // Output only. URL of the placement, for example, website, link to the mobile
+ // application in app store, or a YouTube video URL.
optional string target_url = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Type of the placement, e.g. Website, YouTube Video, and Mobile Application.
- google.ads.googleads.v10.enums.PlacementTypeEnum.PlacementType placement_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Type of the placement, for example, Website, YouTube Video,
+ // and Mobile Application.
+ google.ads.googleads.v13.enums.PlacementTypeEnum.PlacementType
+ placement_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/detailed_demographic.proto b/third_party/googleapis/google/ads/googleads/v13/resources/detailed_demographic.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/resources/detailed_demographic.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/detailed_demographic.proto
index 29bcf6365..98b412bc8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/detailed_demographic.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/detailed_demographic.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/criterion_category_availability.proto";
+import "google/ads/googleads/v13/common/criterion_category_availability.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "DetailedDemographicProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Detailed Demographic resource.
@@ -53,8 +53,8 @@ message DetailedDemographic {
// Output only. The ID of the detailed demographic.
int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The name of the detailed demographic. E.g."Highest Level of Educational
- // Attainment"
+ // Output only. The name of the detailed demographic. For example,"Highest
+ // Level of Educational Attainment"
string name = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The parent of the detailed_demographic.
@@ -65,9 +65,11 @@ message DetailedDemographic {
}
];
- // Output only. True if the detailed demographic is launched to all channels and locales.
+ // Output only. True if the detailed demographic is launched to all channels
+ // and locales.
bool launched_to_all = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Availability information of the detailed demographic.
- repeated google.ads.googleads.v10.common.CriterionCategoryAvailability availabilities = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.ads.googleads.v13.common.CriterionCategoryAvailability
+ availabilities = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/display_keyword_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/display_keyword_view.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/display_keyword_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/display_keyword_view.proto
index 46dd72bd0..910d46d2f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/display_keyword_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/display_keyword_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "DisplayKeywordViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the display keyword view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/distance_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/distance_view.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/resources/distance_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/distance_view.proto
index 61a94d2e1..4d7b6c698 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/distance_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/distance_view.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/distance_bucket.proto";
+import "google/ads/googleads/v13/enums/distance_bucket.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "DistanceViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the DistanceView resource.
@@ -54,8 +54,10 @@ message DistanceView {
];
// Output only. Grouping of user distance from location extensions.
- google.ads.googleads.v10.enums.DistanceBucketEnum.DistanceBucket distance_bucket = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.DistanceBucketEnum.DistanceBucket
+ distance_bucket = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. True if the DistanceBucket is using the metric system, false otherwise.
+ // Output only. True if the DistanceBucket is using the metric system, false
+ // otherwise.
optional bool metric_system = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/domain_category.proto b/third_party/googleapis/google/ads/googleads/v13/resources/domain_category.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/resources/domain_category.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/domain_category.proto
index 2cf74eedf..4c131f8ff 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/domain_category.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/domain_category.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "DomainCategoryProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Domain Category resource.
@@ -59,31 +59,36 @@ message DomainCategory {
}
];
- // Output only. Recommended category for the website domain. e.g. if you have a website
- // about electronics, the categories could be "cameras", "televisions", etc.
+ // Output only. Recommended category for the website domain, for example, if
+ // you have a website about electronics, the categories could be "cameras",
+ // "televisions", etc.
optional string category = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The language code specifying the language of the website. e.g. "en" for
- // English. The language can be specified in the DynamicSearchAdsSetting
- // required for dynamic search ads. This is the language of the pages from
- // your website that you want Google Ads to find, create ads for,
- // and match searches with.
- optional string language_code = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The language code specifying the language of the website, for
+ // example, "en" for English. The language can be specified in the
+ // DynamicSearchAdsSetting required for dynamic search ads. This is the
+ // language of the pages from your website that you want Google Ads to find,
+ // create ads for, and match searches with.
+ optional string language_code = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The domain for the website. The domain can be specified in the
// DynamicSearchAdsSetting required for dynamic search ads.
optional string domain = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Fraction of pages on your site that this category matches.
- optional double coverage_fraction = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional double coverage_fraction = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The position of this category in the set of categories. Lower numbers
- // indicate a better match for the domain. null indicates not recommended.
+ // Output only. The position of this category in the set of categories. Lower
+ // numbers indicate a better match for the domain. null indicates not
+ // recommended.
optional int64 category_rank = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Indicates whether this category has sub-categories.
optional bool has_children = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The recommended cost per click for the category.
- optional int64 recommended_cpc_bid_micros = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 recommended_cpc_bid_micros = 17
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/dynamic_search_ads_search_term_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/dynamic_search_ads_search_term_view.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/dynamic_search_ads_search_term_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/dynamic_search_ads_search_term_view.proto
index b7f6fef70..b0373046e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/dynamic_search_ads_search_term_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/dynamic_search_ads_search_term_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "DynamicSearchAdsSearchTermViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Dynamic Search Ads Search Term View resource.
@@ -71,15 +71,18 @@ message DynamicSearchAdsSearchTermView {
// Output only. True if query matches a negative keyword.
//
// This field is read-only.
- optional bool has_negative_keyword = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional bool has_negative_keyword = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. True if query is added to targeted keywords.
//
// This field is read-only.
- optional bool has_matching_keyword = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional bool has_matching_keyword = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. True if query matches a negative url.
//
// This field is read-only.
- optional bool has_negative_url = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional bool has_negative_url = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/expanded_landing_page_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/expanded_landing_page_view.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/resources/expanded_landing_page_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/expanded_landing_page_view.proto
index 4db8994e4..9489c105a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/expanded_landing_page_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/expanded_landing_page_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ExpandedLandingPageViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the expanded landing page view resource.
@@ -50,5 +50,6 @@ message ExpandedLandingPageView {
];
// Output only. The final URL that clicks are directed to.
- optional string expanded_final_url = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string expanded_final_url = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/experiment.proto b/third_party/googleapis/google/ads/googleads/v13/resources/experiment.proto
similarity index 68%
rename from third_party/googleapis/google/ads/googleads/v10/resources/experiment.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/experiment.proto
index 421484f86..fe8e05cd1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/experiment.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/experiment.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/metric_goal.proto";
-import "google/ads/googleads/v10/enums/async_action_status.proto";
-import "google/ads/googleads/v10/enums/experiment_status.proto";
-import "google/ads/googleads/v10/enums/experiment_type.proto";
+import "google/ads/googleads/v13/common/metric_goal.proto";
+import "google/ads/googleads/v13/enums/async_action_status.proto";
+import "google/ads/googleads/v13/enums/experiment_status.proto";
+import "google/ads/googleads/v13/enums/experiment_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ExperimentProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Experiment resource.
@@ -56,8 +56,8 @@ message Experiment {
// Output only. The ID of the experiment. Read only.
optional int64 experiment_id = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. The name of the experiment. It must have a minimum length of 1 and
- // maximum length of 1024. It must be unique under a customer.
+ // Required. The name of the experiment. It must have a minimum length of 1
+ // and maximum length of 1024. It must be unique under a customer.
string name = 10 [(google.api.field_behavior) = REQUIRED];
// The description of the experiment. It must have a minimum length of 1 and
@@ -70,11 +70,13 @@ message Experiment {
// name is base campaign name + suffix.
string suffix = 12;
- // The product/feature that uses this experiment.
- google.ads.googleads.v10.enums.ExperimentTypeEnum.ExperimentType type = 13;
+ // Required. The product/feature that uses this experiment.
+ google.ads.googleads.v13.enums.ExperimentTypeEnum.ExperimentType type = 13
+ [(google.api.field_behavior) = REQUIRED];
- // The Advertiser-desired status of this experiment.
- google.ads.googleads.v10.enums.ExperimentStatusEnum.ExperimentStatus status = 14;
+ // The Advertiser-chosen status of this experiment.
+ google.ads.googleads.v13.enums.ExperimentStatusEnum.ExperimentStatus status =
+ 14;
// Date when the experiment starts. By default, the experiment starts
// now or on the campaign's start date, whichever is later. If this field is
@@ -94,13 +96,15 @@ message Experiment {
optional string end_date = 16;
// The goals of this experiment.
- repeated google.ads.googleads.v10.common.MetricGoal goals = 17;
+ repeated google.ads.googleads.v13.common.MetricGoal goals = 17;
- // Output only. The resource name of the long-running operation that can be used to poll
- // for completion of experiment schedule or promote. The most recent long
- // running operation is returned.
- optional string long_running_operation = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The resource name of the long-running operation that can be
+ // used to poll for completion of experiment schedule or promote. The most
+ // recent long running operation is returned.
+ optional string long_running_operation = 18
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The status of the experiment promotion process.
- google.ads.googleads.v10.enums.AsyncActionStatusEnum.AsyncActionStatus promote_status = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AsyncActionStatusEnum.AsyncActionStatus
+ promote_status = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/experiment_arm.proto b/third_party/googleapis/google/ads/googleads/v13/resources/experiment_arm.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/experiment_arm.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/experiment_arm.proto
index f47afcf63..9028d42c9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/experiment_arm.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/experiment_arm.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ExperimentArmProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Experiment arm resource.
@@ -50,15 +50,15 @@ message ExperimentArm {
];
// Immutable. The experiment to which the ExperimentArm belongs.
- string trial = 2 [
+ string experiment = 8 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
type: "googleads.googleapis.com/Experiment"
}
];
- // Required. The name of the experiment arm. It must have a minimum length of 1 and
- // maximum length of 1024. It must be unique under an experiment.
+ // Required. The name of the experiment arm. It must have a minimum length of
+ // 1 and maximum length of 1024. It must be unique under an experiment.
string name = 3 [(google.api.field_behavior) = REQUIRED];
// Whether this arm is a control arm. A control arm is the arm against
@@ -71,8 +71,8 @@ message ExperimentArm {
// List of campaigns in the trial arm. The max length is one.
repeated string campaigns = 6 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Campaign"
- }];
+ type: "googleads.googleapis.com/Campaign"
+ }];
// Output only. The in design campaigns in the treatment experiment arm.
repeated string in_design_campaigns = 7 [
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/extension_feed_item.proto b/third_party/googleapis/google/ads/googleads/v13/resources/extension_feed_item.proto
similarity index 56%
rename from third_party/googleapis/google/ads/googleads/v10/resources/extension_feed_item.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/extension_feed_item.proto
index 1ea8e35c3..4ce3964f7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/extension_feed_item.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/extension_feed_item.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/common/extensions.proto";
-import "google/ads/googleads/v10/enums/extension_type.proto";
-import "google/ads/googleads/v10/enums/feed_item_status.proto";
-import "google/ads/googleads/v10/enums/feed_item_target_device.proto";
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/common/extensions.proto";
+import "google/ads/googleads/v13/enums/extension_type.proto";
+import "google/ads/googleads/v13/enums/feed_item_status.proto";
+import "google/ads/googleads/v13/enums/feed_item_target_device.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ExtensionFeedItemProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ExtensionFeedItem resource.
@@ -58,7 +58,8 @@ message ExtensionFeedItem {
// Output only. The extension type of the extension feed item.
// This field is read-only.
- google.ads.googleads.v10.enums.ExtensionTypeEnum.ExtensionType extension_type = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.ExtensionTypeEnum.ExtensionType
+ extension_type = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
// Start time in which this feed item is effective and can begin serving. The
// time is in the customer's time zone.
@@ -75,63 +76,72 @@ message ExtensionFeedItem {
// List of non-overlapping schedules specifying all time intervals
// for which the feed item may serve. There can be a maximum of 6 schedules
// per day.
- repeated google.ads.googleads.v10.common.AdScheduleInfo ad_schedules = 16;
+ repeated google.ads.googleads.v13.common.AdScheduleInfo ad_schedules = 16;
// The targeted device.
- google.ads.googleads.v10.enums.FeedItemTargetDeviceEnum.FeedItemTargetDevice device = 17;
+ google.ads.googleads.v13.enums.FeedItemTargetDeviceEnum.FeedItemTargetDevice
+ device = 17;
// The targeted geo target constant.
- optional string targeted_geo_target_constant = 30 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/GeoTargetConstant"
- }];
+ optional string targeted_geo_target_constant = 30
+ [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/GeoTargetConstant"
+ }];
// The targeted keyword.
- google.ads.googleads.v10.common.KeywordInfo targeted_keyword = 22;
+ google.ads.googleads.v13.common.KeywordInfo targeted_keyword = 22;
// Output only. Status of the feed item.
// This field is read-only.
- google.ads.googleads.v10.enums.FeedItemStatusEnum.FeedItemStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.FeedItemStatusEnum.FeedItemStatus status = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Extension type.
oneof extension {
// Sitelink extension.
- google.ads.googleads.v10.common.SitelinkFeedItem sitelink_feed_item = 2;
+ google.ads.googleads.v13.common.SitelinkFeedItem sitelink_feed_item = 2;
// Structured snippet extension.
- google.ads.googleads.v10.common.StructuredSnippetFeedItem structured_snippet_feed_item = 3;
+ google.ads.googleads.v13.common.StructuredSnippetFeedItem
+ structured_snippet_feed_item = 3;
// App extension.
- google.ads.googleads.v10.common.AppFeedItem app_feed_item = 7;
+ google.ads.googleads.v13.common.AppFeedItem app_feed_item = 7;
// Call extension.
- google.ads.googleads.v10.common.CallFeedItem call_feed_item = 8;
+ google.ads.googleads.v13.common.CallFeedItem call_feed_item = 8;
// Callout extension.
- google.ads.googleads.v10.common.CalloutFeedItem callout_feed_item = 9;
+ google.ads.googleads.v13.common.CalloutFeedItem callout_feed_item = 9;
// Text message extension.
- google.ads.googleads.v10.common.TextMessageFeedItem text_message_feed_item = 10;
+ google.ads.googleads.v13.common.TextMessageFeedItem text_message_feed_item =
+ 10;
// Price extension.
- google.ads.googleads.v10.common.PriceFeedItem price_feed_item = 11;
+ google.ads.googleads.v13.common.PriceFeedItem price_feed_item = 11;
// Promotion extension.
- google.ads.googleads.v10.common.PromotionFeedItem promotion_feed_item = 12;
+ google.ads.googleads.v13.common.PromotionFeedItem promotion_feed_item = 12;
- // Output only. Location extension. Locations are synced from a Business Profile into a
- // feed. This field is read-only.
- google.ads.googleads.v10.common.LocationFeedItem location_feed_item = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Location extension. Locations are synced from a Business
+ // Profile into a feed. This field is read-only.
+ google.ads.googleads.v13.common.LocationFeedItem location_feed_item = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Affiliate location extension. Feed locations are populated by Google Ads
- // based on a chain ID.
- // This field is read-only.
- google.ads.googleads.v10.common.AffiliateLocationFeedItem affiliate_location_feed_item = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Affiliate location extension. Feed locations are populated
+ // by Google Ads based on a chain ID. This field is read-only.
+ google.ads.googleads.v13.common.AffiliateLocationFeedItem
+ affiliate_location_feed_item = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Hotel Callout extension.
- google.ads.googleads.v10.common.HotelCalloutFeedItem hotel_callout_feed_item = 23;
+ google.ads.googleads.v13.common.HotelCalloutFeedItem
+ hotel_callout_feed_item = 23;
// Immutable. Advertiser provided image extension.
- google.ads.googleads.v10.common.ImageFeedItem image_feed_item = 31 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.ImageFeedItem image_feed_item = 31
+ [(google.api.field_behavior) = IMMUTABLE];
}
// Targeting at either the campaign or ad group level. Feed items that target
@@ -139,12 +149,12 @@ message ExtensionFeedItem {
oneof serving_resource_targeting {
// The targeted campaign.
string targeted_campaign = 28 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Campaign"
- }];
+ type: "googleads.googleapis.com/Campaign"
+ }];
// The targeted ad group.
string targeted_ad_group = 29 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroup"
- }];
+ type: "googleads.googleapis.com/AdGroup"
+ }];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/feed.proto b/third_party/googleapis/google/ads/googleads/v13/resources/feed.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/resources/feed.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/feed.proto
index 2aea8efcb..334b59112 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/feed.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/feed.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/affiliate_location_feed_relationship_type.proto";
-import "google/ads/googleads/v10/enums/feed_attribute_type.proto";
-import "google/ads/googleads/v10/enums/feed_origin.proto";
-import "google/ads/googleads/v10/enums/feed_status.proto";
+import "google/ads/googleads/v13/enums/affiliate_location_feed_relationship_type.proto";
+import "google/ads/googleads/v13/enums/feed_attribute_type.proto";
+import "google/ads/googleads/v13/enums/feed_origin.proto";
+import "google/ads/googleads/v13/enums/feed_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "FeedProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Feed resource.
@@ -96,7 +96,8 @@ message Feed {
repeated int64 chain_ids = 3;
// The relationship the chains have with the advertiser.
- google.ads.googleads.v10.enums.AffiliateLocationFeedRelationshipTypeEnum.AffiliateLocationFeedRelationshipType relationship_type = 2;
+ google.ads.googleads.v13.enums.AffiliateLocationFeedRelationshipTypeEnum
+ .AffiliateLocationFeedRelationshipType relationship_type = 2;
}
// Immutable. The resource name of the feed.
@@ -105,9 +106,7 @@ message Feed {
// `customers/{customer_id}/feeds/{feed_id}`
string resource_name = 1 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Feed" }
];
// Output only. The ID of the feed.
@@ -128,11 +127,13 @@ message Feed {
repeated FeedAttributeOperation attribute_operations = 9;
// Immutable. Specifies who manages the FeedAttributes for the Feed.
- google.ads.googleads.v10.enums.FeedOriginEnum.FeedOrigin origin = 5 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.FeedOriginEnum.FeedOrigin origin = 5
+ [(google.api.field_behavior) = IMMUTABLE];
// Output only. Status of the feed.
// This field is read-only.
- google.ads.googleads.v10.enums.FeedStatusEnum.FeedStatus status = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.FeedStatusEnum.FeedStatus status = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The system data for the Feed. This data specifies information for
// generating the feed items of the system generated feed.
@@ -158,7 +159,8 @@ message FeedAttribute {
optional string name = 6;
// Data type for feed attribute. Required.
- google.ads.googleads.v10.enums.FeedAttributeTypeEnum.FeedAttributeType type = 3;
+ google.ads.googleads.v13.enums.FeedAttributeTypeEnum.FeedAttributeType type =
+ 3;
// Indicates that data corresponding to this attribute is part of a
// FeedItem's unique key. It defaults to false if it is unspecified. Note
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/feed_item.proto b/third_party/googleapis/google/ads/googleads/v13/resources/feed_item.proto
similarity index 60%
rename from third_party/googleapis/google/ads/googleads/v10/resources/feed_item.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/feed_item.proto
index 28bcc96da..8f87abcb7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/feed_item.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/feed_item.proto
@@ -14,31 +14,31 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/custom_parameter.proto";
-import "google/ads/googleads/v10/common/feed_common.proto";
-import "google/ads/googleads/v10/common/policy.proto";
-import "google/ads/googleads/v10/enums/feed_item_quality_approval_status.proto";
-import "google/ads/googleads/v10/enums/feed_item_quality_disapproval_reason.proto";
-import "google/ads/googleads/v10/enums/feed_item_status.proto";
-import "google/ads/googleads/v10/enums/feed_item_validation_status.proto";
-import "google/ads/googleads/v10/enums/geo_targeting_restriction.proto";
-import "google/ads/googleads/v10/enums/placeholder_type.proto";
-import "google/ads/googleads/v10/enums/policy_approval_status.proto";
-import "google/ads/googleads/v10/enums/policy_review_status.proto";
-import "google/ads/googleads/v10/errors/feed_item_validation_error.proto";
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/custom_parameter.proto";
+import "google/ads/googleads/v13/common/feed_common.proto";
+import "google/ads/googleads/v13/common/policy.proto";
+import "google/ads/googleads/v13/enums/feed_item_quality_approval_status.proto";
+import "google/ads/googleads/v13/enums/feed_item_quality_disapproval_reason.proto";
+import "google/ads/googleads/v13/enums/feed_item_status.proto";
+import "google/ads/googleads/v13/enums/feed_item_validation_status.proto";
+import "google/ads/googleads/v13/enums/geo_targeting_restriction.proto";
+import "google/ads/googleads/v13/enums/placeholder_type.proto";
+import "google/ads/googleads/v13/enums/policy_approval_status.proto";
+import "google/ads/googleads/v13/enums/policy_review_status.proto";
+import "google/ads/googleads/v13/errors/feed_item_validation_error.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "FeedItemProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the FeedItem resource.
@@ -63,9 +63,7 @@ message FeedItem {
// Immutable. The feed to which this feed item belongs.
optional string feed = 11 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Feed" }
];
// Output only. The ID of this feed item.
@@ -88,23 +86,27 @@ message FeedItem {
// Geo targeting restriction specifies the type of location that can be used
// for targeting.
- google.ads.googleads.v10.enums.GeoTargetingRestrictionEnum.GeoTargetingRestriction geo_targeting_restriction = 7;
+ google.ads.googleads.v13.enums.GeoTargetingRestrictionEnum
+ .GeoTargetingRestriction geo_targeting_restriction = 7;
// The list of mappings used to substitute custom parameter tags in a
// `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
- repeated google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 8;
+ repeated google.ads.googleads.v13.common.CustomParameter
+ url_custom_parameters = 8;
// Output only. Status of the feed item.
// This field is read-only.
- google.ads.googleads.v10.enums.FeedItemStatusEnum.FeedItemStatus status = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. List of info about a feed item's validation and approval state for active
- // feed mappings. There will be an entry in the list for each type of feed
- // mapping associated with the feed, e.g. a feed with a sitelink and a call
- // feed mapping would cause every feed item associated with that feed to have
- // an entry in this list for both sitelink and call.
+ google.ads.googleads.v13.enums.FeedItemStatusEnum.FeedItemStatus status = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. List of info about a feed item's validation and approval state
+ // for active feed mappings. There will be an entry in the list for each type
+ // of feed mapping associated with the feed, for example, a feed with a
+ // sitelink and a call feed mapping would cause every feed item associated
+ // with that feed to have an entry in this list for both sitelink and call.
// This field is read-only.
- repeated FeedItemPlaceholderPolicyInfo policy_infos = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated FeedItemPlaceholderPolicyInfo policy_infos = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A feed item attribute value.
@@ -133,7 +135,7 @@ message FeedItemAttributeValue {
// Price value. Should be set if feed_attribute_id refers to a feed attribute
// of type PRICE.
- google.ads.googleads.v10.common.Money price_value = 6;
+ google.ads.googleads.v13.common.Money price_value = 6;
// Repeated int64 value. Should be set if feed_attribute_id refers to a feed
// attribute of type INT64_LIST.
@@ -163,51 +165,68 @@ message FeedItemAttributeValue {
// specified placeholder type.
message FeedItemPlaceholderPolicyInfo {
// Output only. The placeholder type.
- google.ads.googleads.v10.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type_enum = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.PlaceholderTypeEnum.PlaceholderType
+ placeholder_type_enum = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The FeedMapping that contains the placeholder type.
- optional string feed_mapping_resource_name = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string feed_mapping_resource_name = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Where the placeholder type is in the review process.
- google.ads.googleads.v10.enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.PolicyReviewStatusEnum.PolicyReviewStatus
+ review_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The overall approval status of the placeholder type, calculated based on
- // the status of its individual policy topic entries.
- google.ads.googleads.v10.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The overall approval status of the placeholder type,
+ // calculated based on the status of its individual policy topic entries.
+ google.ads.googleads.v13.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus
+ approval_status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The list of policy findings for the placeholder type.
- repeated google.ads.googleads.v10.common.PolicyTopicEntry policy_topic_entries = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.ads.googleads.v13.common.PolicyTopicEntry
+ policy_topic_entries = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The validation status of the palceholder type.
- google.ads.googleads.v10.enums.FeedItemValidationStatusEnum.FeedItemValidationStatus validation_status = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.FeedItemValidationStatusEnum
+ .FeedItemValidationStatus validation_status = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. List of placeholder type validation errors.
- repeated FeedItemValidationError validation_errors = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated FeedItemValidationError validation_errors = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Placeholder type quality evaluation approval status.
- google.ads.googleads.v10.enums.FeedItemQualityApprovalStatusEnum.FeedItemQualityApprovalStatus quality_approval_status = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. List of placeholder type quality evaluation disapproval reasons.
- repeated google.ads.googleads.v10.enums.FeedItemQualityDisapprovalReasonEnum.FeedItemQualityDisapprovalReason quality_disapproval_reasons = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.FeedItemQualityApprovalStatusEnum
+ .FeedItemQualityApprovalStatus quality_approval_status = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. List of placeholder type quality evaluation disapproval
+ // reasons.
+ repeated google.ads.googleads.v13.enums.FeedItemQualityDisapprovalReasonEnum
+ .FeedItemQualityDisapprovalReason quality_disapproval_reasons = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Stores a validation error and the set of offending feed attributes which
// together are responsible for causing a feed item validation error.
message FeedItemValidationError {
- // Output only. Error code indicating what validation error was triggered. The description
- // of the error can be found in the 'description' field.
- google.ads.googleads.v10.errors.FeedItemValidationErrorEnum.FeedItemValidationError validation_error = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Error code indicating what validation error was triggered. The
+ // description of the error can be found in the 'description' field.
+ google.ads.googleads.v13.errors.FeedItemValidationErrorEnum
+ .FeedItemValidationError validation_error = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The description of the validation error.
optional string description = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Set of feed attributes in the feed item flagged during validation. If
- // empty, no specific feed attributes can be associated with the error
- // (e.g. error across the entire feed item).
- repeated int64 feed_attribute_ids = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Set of feed attributes in the feed item flagged during
+ // validation. If empty, no specific feed attributes can be associated with
+ // the error (for example, error across the entire feed item).
+ repeated int64 feed_attribute_ids = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Any extra information related to this error which is not captured by
- // validation_error and feed_attribute_id (e.g. placeholder field IDs when
- // feed_attribute_id is not mapped). Note that extra_info is not localized.
+ // Output only. Any extra information related to this error which is not
+ // captured by validation_error and feed_attribute_id (for example,
+ // placeholder field IDs when feed_attribute_id is not mapped). Note that
+ // extra_info is not localized.
optional string extra_info = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/feed_item_set.proto b/third_party/googleapis/google/ads/googleads/v13/resources/feed_item_set.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/resources/feed_item_set.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/feed_item_set.proto
index be177c815..2e40e8b2d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/feed_item_set.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/feed_item_set.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/feed_item_set_filter_type_infos.proto";
-import "google/ads/googleads/v10/enums/feed_item_set_status.proto";
+import "google/ads/googleads/v13/common/feed_item_set_filter_type_infos.proto";
+import "google/ads/googleads/v13/enums/feed_item_set_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "FeedItemSetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Represents a set of feed items. The set can be used and shared among certain
// feed item features. For instance, the set can be referenced within the
@@ -49,13 +49,11 @@ message FeedItemSet {
}
];
- // Immutable. The resource name of the feed containing the feed items in the set.
- // Immutable. Required.
+ // Immutable. The resource name of the feed containing the feed items in the
+ // set. Immutable. Required.
string feed = 2 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Feed" }
];
// Output only. ID of the set.
@@ -66,18 +64,21 @@ message FeedItemSet {
// Output only. Status of the feed item set.
// This field is read-only.
- google.ads.googleads.v10.enums.FeedItemSetStatusEnum.FeedItemSetStatus status = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.FeedItemSetStatusEnum.FeedItemSetStatus
+ status = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Represents a filter on locations in a feed item set.
// Only applicable if the parent Feed of the FeedItemSet is a LOCATION feed.
oneof dynamic_set_filter {
// Filter for dynamic location set.
// It is only used for sets of locations.
- google.ads.googleads.v10.common.DynamicLocationSetFilter dynamic_location_set_filter = 5;
+ google.ads.googleads.v13.common.DynamicLocationSetFilter
+ dynamic_location_set_filter = 5;
// Filter for dynamic affiliate location set.
// This field doesn't apply generally to feed item sets. It is only used for
// sets of affiliate locations.
- google.ads.googleads.v10.common.DynamicAffiliateLocationSetFilter dynamic_affiliate_location_set_filter = 6;
+ google.ads.googleads.v13.common.DynamicAffiliateLocationSetFilter
+ dynamic_affiliate_location_set_filter = 6;
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/feed_item_set_link.proto b/third_party/googleapis/google/ads/googleads/v13/resources/feed_item_set_link.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/resources/feed_item_set_link.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/feed_item_set_link.proto
index 086475f6e..2a8c04cb5 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/feed_item_set_link.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/feed_item_set_link.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "FeedItemSetLinkProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the FeedItemSetLink resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/feed_item_target.proto b/third_party/googleapis/google/ads/googleads/v13/resources/feed_item_target.proto
similarity index 68%
rename from third_party/googleapis/google/ads/googleads/v10/resources/feed_item_target.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/feed_item_target.proto
index 9bfacf164..e05b31c90 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/feed_item_target.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/feed_item_target.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/enums/feed_item_target_device.proto";
-import "google/ads/googleads/v10/enums/feed_item_target_status.proto";
-import "google/ads/googleads/v10/enums/feed_item_target_type.proto";
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/enums/feed_item_target_device.proto";
+import "google/ads/googleads/v13/enums/feed_item_target_status.proto";
+import "google/ads/googleads/v13/enums/feed_item_target_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "FeedItemTargetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the FeedItemTarget resource.
@@ -59,15 +59,19 @@ message FeedItemTarget {
}
];
- // Output only. The target type of this feed item target. This field is read-only.
- google.ads.googleads.v10.enums.FeedItemTargetTypeEnum.FeedItemTargetType feed_item_target_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The target type of this feed item target. This field is
+ // read-only.
+ google.ads.googleads.v13.enums.FeedItemTargetTypeEnum.FeedItemTargetType
+ feed_item_target_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The ID of the targeted resource. This field is read-only.
- optional int64 feed_item_target_id = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 feed_item_target_id = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Status of the feed item target.
// This field is read-only.
- google.ads.googleads.v10.enums.FeedItemTargetStatusEnum.FeedItemTargetStatus status = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.FeedItemTargetStatusEnum.FeedItemTargetStatus
+ status = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
// The targeted resource.
oneof target {
@@ -88,7 +92,8 @@ message FeedItemTarget {
];
// Immutable. The targeted keyword.
- google.ads.googleads.v10.common.KeywordInfo keyword = 7 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.KeywordInfo keyword = 7
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. The targeted geo target constant resource name.
string geo_target_constant = 16 [
@@ -99,9 +104,11 @@ message FeedItemTarget {
];
// Immutable. The targeted device.
- google.ads.googleads.v10.enums.FeedItemTargetDeviceEnum.FeedItemTargetDevice device = 9 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.FeedItemTargetDeviceEnum.FeedItemTargetDevice
+ device = 9 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. The targeted schedule.
- google.ads.googleads.v10.common.AdScheduleInfo ad_schedule = 10 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.AdScheduleInfo ad_schedule = 10
+ [(google.api.field_behavior) = IMMUTABLE];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/feed_mapping.proto b/third_party/googleapis/google/ads/googleads/v13/resources/feed_mapping.proto
new file mode 100644
index 000000000..5b1d596ca
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/feed_mapping.proto
@@ -0,0 +1,234 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/enums/ad_customizer_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/affiliate_location_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/app_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/call_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/callout_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/custom_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/dsa_page_feed_criterion_field.proto";
+import "google/ads/googleads/v13/enums/education_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/feed_mapping_criterion_type.proto";
+import "google/ads/googleads/v13/enums/feed_mapping_status.proto";
+import "google/ads/googleads/v13/enums/flight_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/hotel_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/image_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/job_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/local_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/location_extension_targeting_criterion_field.proto";
+import "google/ads/googleads/v13/enums/location_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/message_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/placeholder_type.proto";
+import "google/ads/googleads/v13/enums/price_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/promotion_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/real_estate_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/sitelink_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/structured_snippet_placeholder_field.proto";
+import "google/ads/googleads/v13/enums/travel_placeholder_field.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "FeedMappingProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the FeedMapping resource.
+
+// A feed mapping.
+message FeedMapping {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/FeedMapping"
+ pattern: "customers/{customer_id}/feedMappings/{feed_id}~{feed_mapping_id}"
+ };
+
+ // Immutable. The resource name of the feed mapping.
+ // Feed mapping resource names have the form:
+ //
+ // `customers/{customer_id}/feedMappings/{feed_id}~{feed_mapping_id}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/FeedMapping"
+ }
+ ];
+
+ // Immutable. The feed of this feed mapping.
+ optional string feed = 7 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Feed" }
+ ];
+
+ // Immutable. Feed attributes to field mappings. These mappings are a
+ // one-to-many relationship meaning that 1 feed attribute can be used to
+ // populate multiple placeholder fields, but 1 placeholder field can only draw
+ // data from 1 feed attribute. Ad Customizer is an exception, 1 placeholder
+ // field can be mapped to multiple feed attributes. Required.
+ repeated AttributeFieldMapping attribute_field_mappings = 5
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Output only. Status of the feed mapping.
+ // This field is read-only.
+ google.ads.googleads.v13.enums.FeedMappingStatusEnum.FeedMappingStatus
+ status = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Feed mapping target. Can be either a placeholder or a criterion. For a
+ // given feed, the active FeedMappings must have unique targets. Required.
+ oneof target {
+ // Immutable. The placeholder type of this mapping (for example, if the
+ // mapping maps feed attributes to placeholder fields).
+ google.ads.googleads.v13.enums.PlaceholderTypeEnum.PlaceholderType
+ placeholder_type = 3 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. The criterion type of this mapping (for example, if the
+ // mapping maps feed attributes to criterion fields).
+ google.ads.googleads.v13.enums.FeedMappingCriterionTypeEnum
+ .FeedMappingCriterionType criterion_type = 4
+ [(google.api.field_behavior) = IMMUTABLE];
+ }
+}
+
+// Maps from feed attribute id to a placeholder or criterion field id.
+message AttributeFieldMapping {
+ // Immutable. Feed attribute from which to map.
+ optional int64 feed_attribute_id = 24
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Output only. The placeholder field ID. If a placeholder field enum is not
+ // published in the current API version, then this field will be populated and
+ // the field oneof will be empty. This field is read-only.
+ optional int64 field_id = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Placeholder or criterion field to be populated using data from
+ // the above feed attribute. Required.
+ oneof field {
+ // Immutable. Sitelink Placeholder Fields.
+ google.ads.googleads.v13.enums.SitelinkPlaceholderFieldEnum
+ .SitelinkPlaceholderField sitelink_field = 3
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Call Placeholder Fields.
+ google.ads.googleads.v13.enums.CallPlaceholderFieldEnum.CallPlaceholderField
+ call_field = 4 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. App Placeholder Fields.
+ google.ads.googleads.v13.enums.AppPlaceholderFieldEnum.AppPlaceholderField
+ app_field = 5 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Output only. Location Placeholder Fields. This field is read-only.
+ google.ads.googleads.v13.enums.LocationPlaceholderFieldEnum
+ .LocationPlaceholderField location_field = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Affiliate Location Placeholder Fields. This field is
+ // read-only.
+ google.ads.googleads.v13.enums.AffiliateLocationPlaceholderFieldEnum
+ .AffiliateLocationPlaceholderField affiliate_location_field = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Immutable. Callout Placeholder Fields.
+ google.ads.googleads.v13.enums.CalloutPlaceholderFieldEnum
+ .CalloutPlaceholderField callout_field = 8
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Structured Snippet Placeholder Fields.
+ google.ads.googleads.v13.enums.StructuredSnippetPlaceholderFieldEnum
+ .StructuredSnippetPlaceholderField structured_snippet_field = 9
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Message Placeholder Fields.
+ google.ads.googleads.v13.enums.MessagePlaceholderFieldEnum
+ .MessagePlaceholderField message_field = 10
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Price Placeholder Fields.
+ google.ads.googleads.v13.enums.PricePlaceholderFieldEnum
+ .PricePlaceholderField price_field = 11
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Promotion Placeholder Fields.
+ google.ads.googleads.v13.enums.PromotionPlaceholderFieldEnum
+ .PromotionPlaceholderField promotion_field = 12
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Ad Customizer Placeholder Fields
+ google.ads.googleads.v13.enums.AdCustomizerPlaceholderFieldEnum
+ .AdCustomizerPlaceholderField ad_customizer_field = 13
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Dynamic Search Ad Page Feed Fields.
+ google.ads.googleads.v13.enums.DsaPageFeedCriterionFieldEnum
+ .DsaPageFeedCriterionField dsa_page_feed_field = 14
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Location Target Fields.
+ google.ads.googleads.v13.enums.LocationExtensionTargetingCriterionFieldEnum
+ .LocationExtensionTargetingCriterionField
+ location_extension_targeting_field = 15
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Education Placeholder Fields
+ google.ads.googleads.v13.enums.EducationPlaceholderFieldEnum
+ .EducationPlaceholderField education_field = 16
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Flight Placeholder Fields
+ google.ads.googleads.v13.enums.FlightPlaceholderFieldEnum
+ .FlightPlaceholderField flight_field = 17
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Custom Placeholder Fields
+ google.ads.googleads.v13.enums.CustomPlaceholderFieldEnum
+ .CustomPlaceholderField custom_field = 18
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Hotel Placeholder Fields
+ google.ads.googleads.v13.enums.HotelPlaceholderFieldEnum
+ .HotelPlaceholderField hotel_field = 19
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Real Estate Placeholder Fields
+ google.ads.googleads.v13.enums.RealEstatePlaceholderFieldEnum
+ .RealEstatePlaceholderField real_estate_field = 20
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Travel Placeholder Fields
+ google.ads.googleads.v13.enums.TravelPlaceholderFieldEnum
+ .TravelPlaceholderField travel_field = 21
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Local Placeholder Fields
+ google.ads.googleads.v13.enums.LocalPlaceholderFieldEnum
+ .LocalPlaceholderField local_field = 22
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Job Placeholder Fields
+ google.ads.googleads.v13.enums.JobPlaceholderFieldEnum.JobPlaceholderField
+ job_field = 23 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Image Placeholder Fields
+ google.ads.googleads.v13.enums.ImagePlaceholderFieldEnum
+ .ImagePlaceholderField image_field = 26
+ [(google.api.field_behavior) = IMMUTABLE];
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/feed_placeholder_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/feed_placeholder_view.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/resources/feed_placeholder_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/feed_placeholder_view.proto
index 302261391..312341ccb 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/feed_placeholder_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/feed_placeholder_view.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/placeholder_type.proto";
+import "google/ads/googleads/v13/enums/placeholder_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "FeedPlaceholderViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the FeedPlaceholderView resource.
@@ -50,5 +50,6 @@ message FeedPlaceholderView {
];
// Output only. The placeholder type of the feed placeholder view.
- google.ads.googleads.v10.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.PlaceholderTypeEnum.PlaceholderType
+ placeholder_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/gender_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/gender_view.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/resources/gender_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/gender_view.proto
index 519f169d9..3d81544cb 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/gender_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/gender_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "GenderViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the gender view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/geo_target_constant.proto b/third_party/googleapis/google/ads/googleads/v13/resources/geo_target_constant.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/resources/geo_target_constant.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/geo_target_constant.proto
index 02f4b76fa..a4e5f0765 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/geo_target_constant.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/geo_target_constant.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/geo_target_constant_status.proto";
+import "google/ads/googleads/v13/enums/geo_target_constant_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "GeoTargetConstantProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the geo target constant resource.
@@ -55,18 +55,22 @@ message GeoTargetConstant {
// Output only. Geo target constant English name.
optional string name = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The ISO-3166-1 alpha-2 country code that is associated with the target.
+ // Output only. The ISO-3166-1 alpha-2 country code that is associated with
+ // the target.
optional string country_code = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Geo target constant target type.
optional string target_type = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Geo target constant status.
- google.ads.googleads.v10.enums.GeoTargetConstantStatusEnum.GeoTargetConstantStatus status = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.GeoTargetConstantStatusEnum
+ .GeoTargetConstantStatus status = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The fully qualified English name, consisting of the target's name and that
- // of its parent and country.
- optional string canonical_name = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The fully qualified English name, consisting of the target's
+ // name and that of its parent and country.
+ optional string canonical_name = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The resource name of the parent geo target constant.
// Geo target constant resource names have the form:
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/geographic_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/geographic_view.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/resources/geographic_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/geographic_view.proto
index 10366267d..215f2660e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/geographic_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/geographic_view.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/geo_targeting_type.proto";
+import "google/ads/googleads/v13/enums/geo_targeting_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "GeographicViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the geographic view resource.
@@ -55,8 +55,10 @@ message GeographicView {
];
// Output only. Type of the geo targeting of the campaign.
- google.ads.googleads.v10.enums.GeoTargetingTypeEnum.GeoTargetingType location_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.GeoTargetingTypeEnum.GeoTargetingType
+ location_type = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Criterion Id for the country.
- optional int64 country_criterion_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 country_criterion_id = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/google_ads_field.proto b/third_party/googleapis/google/ads/googleads/v13/resources/google_ads_field.proto
similarity index 67%
rename from third_party/googleapis/google/ads/googleads/v10/resources/google_ads_field.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/google_ads_field.proto
index 84956dc37..3371a1598 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/google_ads_field.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/google_ads_field.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/google_ads_field_category.proto";
-import "google/ads/googleads/v10/enums/google_ads_field_data_type.proto";
+import "google/ads/googleads/v13/enums/google_ads_field_category.proto";
+import "google/ads/googleads/v13/enums/google_ads_field_data_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "GoogleAdsFieldProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Google Ads Field resource.
@@ -54,7 +54,9 @@ message GoogleAdsField {
optional string name = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The category of the artifact.
- google.ads.googleads.v10.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.GoogleAdsFieldCategoryEnum
+ .GoogleAdsFieldCategory category = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Whether the artifact can be used in a SELECT clause in search
// queries.
@@ -64,30 +66,32 @@ message GoogleAdsField {
// queries.
optional bool filterable = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Whether the artifact can be used in a ORDER BY clause in search
- // queries.
+ // Output only. Whether the artifact can be used in a ORDER BY clause in
+ // search queries.
optional bool sortable = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The names of all resources, segments, and metrics that are selectable with
- // the described artifact.
- repeated string selectable_with = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The names of all resources, segments, and metrics that are
+ // selectable with the described artifact.
+ repeated string selectable_with = 25
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The names of all resources that are selectable with the described
- // artifact. Fields from these resources do not segment metrics when included
- // in search queries.
+ // Output only. The names of all resources that are selectable with the
+ // described artifact. Fields from these resources do not segment metrics when
+ // included in search queries.
//
// This field is only set for artifacts whose category is RESOURCE.
- repeated string attribute_resources = 26 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated string attribute_resources = 26
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. This field lists the names of all metrics that are selectable with the
- // described artifact when it is used in the FROM clause.
- // It is only set for artifacts whose category is RESOURCE.
+ // Output only. This field lists the names of all metrics that are selectable
+ // with the described artifact when it is used in the FROM clause. It is only
+ // set for artifacts whose category is RESOURCE.
repeated string metrics = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. This field lists the names of all artifacts, whether a segment or another
- // resource, that segment metrics when included in search queries and when the
- // described artifact is used in the FROM clause. It is only set for artifacts
- // whose category is RESOURCE.
+ // Output only. This field lists the names of all artifacts, whether a segment
+ // or another resource, that segment metrics when included in search queries
+ // and when the described artifact is used in the FROM clause. It is only set
+ // for artifacts whose category is RESOURCE.
repeated string segments = 28 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Values the artifact can assume if it is a field of type ENUM.
@@ -95,9 +99,11 @@ message GoogleAdsField {
// This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
repeated string enum_values = 29 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. This field determines the operators that can be used with the artifact
- // in WHERE clauses.
- google.ads.googleads.v10.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. This field determines the operators that can be used with the
+ // artifact in WHERE clauses.
+ google.ads.googleads.v13.enums.GoogleAdsFieldDataTypeEnum
+ .GoogleAdsFieldDataType data_type = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The URL of proto describing the artifact's data type.
optional string type_url = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/group_placement_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/group_placement_view.proto
similarity index 69%
rename from third_party/googleapis/google/ads/googleads/v10/resources/group_placement_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/group_placement_view.proto
index 830681df0..3498b9ff3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/group_placement_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/group_placement_view.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/placement_type.proto";
+import "google/ads/googleads/v13/enums/placement_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "GroupPlacementViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the group placement view resource.
@@ -49,17 +49,20 @@ message GroupPlacementView {
}
];
- // Output only. The automatic placement string at group level, e. g. web domain, mobile
- // app ID, or a YouTube channel ID.
+ // Output only. The automatic placement string at group level, e. g. web
+ // domain, mobile app ID, or a YouTube channel ID.
optional string placement = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Domain name for websites and YouTube channel name for YouTube channels.
+ // Output only. Domain name for websites and YouTube channel name for YouTube
+ // channels.
optional string display_name = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. URL of the group placement, e.g. domain, link to the mobile application in
- // app store, or a YouTube channel URL.
+ // Output only. URL of the group placement, for example, domain, link to the
+ // mobile application in app store, or a YouTube channel URL.
optional string target_url = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Type of the placement, e.g. Website, YouTube Channel, Mobile Application.
- google.ads.googleads.v10.enums.PlacementTypeEnum.PlacementType placement_type = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Type of the placement, for example, Website, YouTube Channel,
+ // Mobile Application.
+ google.ads.googleads.v13.enums.PlacementTypeEnum.PlacementType
+ placement_type = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/hotel_group_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/hotel_group_view.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/hotel_group_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/hotel_group_view.proto
index 0c6c57786..1f45a1b8d 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/hotel_group_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/hotel_group_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "HotelGroupViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the hotel group view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/hotel_performance_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/hotel_performance_view.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/hotel_performance_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/hotel_performance_view.proto
index c4a812934..57b3925a6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/hotel_performance_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/hotel_performance_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "HotelPerformanceViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the hotel performance view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/hotel_reconciliation.proto b/third_party/googleapis/google/ads/googleads/v13/resources/hotel_reconciliation.proto
similarity index 61%
rename from third_party/googleapis/google/ads/googleads/v10/resources/hotel_reconciliation.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/hotel_reconciliation.proto
index 1d9e7d962..140f4cf39 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/hotel_reconciliation.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/hotel_reconciliation.proto
@@ -14,26 +14,26 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/hotel_reconciliation_status.proto";
+import "google/ads/googleads/v13/enums/hotel_reconciliation_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "HotelReconciliationProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the hotel reconciliation resource.
// A hotel reconciliation. It contains conversion information from Hotel
// bookings to reconcile with advertiser records. These rows may be updated
-// or canceled before billing via Bulk Uploads.
+// or canceled before billing through Bulk Uploads.
message HotelReconciliation {
option (google.api.resource) = {
type: "googleads.googleapis.com/HotelReconciliation"
@@ -51,18 +51,20 @@ message HotelReconciliation {
}
];
- // Required. Output only. The commission ID is Google's ID for this booking. Every booking event is
- // assigned a Commission ID to help you match it to a guest stay.
+ // Required. Output only. The commission ID is Google's ID for this booking.
+ // Every booking event is assigned a Commission ID to help you match it to a
+ // guest stay.
string commission_id = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = OUTPUT_ONLY
];
- // Output only. The order ID is the identifier for this booking as provided in the
- // 'transaction_id' parameter of the conversion tracking tag.
+ // Output only. The order ID is the identifier for this booking as provided in
+ // the 'transaction_id' parameter of the conversion tracking tag.
string order_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The resource name for the Campaign associated with the conversion.
+ // Output only. The resource name for the Campaign associated with the
+ // conversion.
string campaign = 11 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -70,46 +72,48 @@ message HotelReconciliation {
}
];
- // Output only. Identifier for the Hotel Center account which provides the rates for the
- // Hotel campaign.
+ // Output only. Identifier for the Hotel Center account which provides the
+ // rates for the Hotel campaign.
int64 hotel_center_id = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Unique identifier for the booked property, as provided in the Hotel Center
- // feed. The hotel ID comes from the 'ID' parameter of the conversion tracking
- // tag.
+ // Output only. Unique identifier for the booked property, as provided in the
+ // Hotel Center feed. The hotel ID comes from the 'ID' parameter of the
+ // conversion tracking tag.
string hotel_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Check-in date recorded when the booking is made. If the check-in date is
- // modified at reconciliation, the revised date will then take the place of
- // the original date in this column. Format is YYYY-MM-DD.
+ // Output only. Check-in date recorded when the booking is made. If the
+ // check-in date is modified at reconciliation, the revised date will then
+ // take the place of the original date in this column. Format is YYYY-MM-DD.
string check_in_date = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Check-out date recorded when the booking is made. If the check-in date is
- // modified at reconciliation, the revised date will then take the place of
- // the original date in this column. Format is YYYY-MM-DD.
+ // Output only. Check-out date recorded when the booking is made. If the
+ // check-in date is modified at reconciliation, the revised date will then
+ // take the place of the original date in this column. Format is YYYY-MM-DD.
string check_out_date = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. Output only. Reconciled value is the final value of a booking as paid by the guest. If
- // original booking value changes for any reason, such as itinerary changes or
- // room upsells, the reconciled value should be the full final amount
- // collected. If a booking is canceled, the reconciled value should include
- // the value of any cancellation fees or non-refundable nights charged. Value
- // is in millionths of the base unit currency. For example, $12.35 would be
- // represented as 12350000. Currency unit is in the default customer currency.
+ // Required. Output only. Reconciled value is the final value of a booking as
+ // paid by the guest. If original booking value changes for any reason, such
+ // as itinerary changes or room upsells, the reconciled value should be the
+ // full final amount collected. If a booking is canceled, the reconciled value
+ // should include the value of any cancellation fees or non-refundable nights
+ // charged. Value is in millionths of the base unit currency. For example,
+ // $12.35 would be represented as 12350000. Currency unit is in the default
+ // customer currency.
int64 reconciled_value_micros = 8 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = OUTPUT_ONLY
];
- // Output only. Whether a given booking has been billed. Once billed, a booking can't be
- // modified.
+ // Output only. Whether a given booking has been billed. Once billed, a
+ // booking can't be modified.
bool billed = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. Output only. Current status of a booking with regards to reconciliation and billing.
- // Bookings should be reconciled within 45 days after the check-out date.
- // Any booking not reconciled within 45 days will be billed at its original
- // value.
- google.ads.googleads.v10.enums.HotelReconciliationStatusEnum.HotelReconciliationStatus status = 10 [
+ // Required. Output only. Current status of a booking with regards to
+ // reconciliation and billing. Bookings should be reconciled within 45 days
+ // after the check-out date. Any booking not reconciled within 45 days will be
+ // billed at its original value.
+ google.ads.googleads.v13.enums.HotelReconciliationStatusEnum
+ .HotelReconciliationStatus status = 10 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = OUTPUT_ONLY
];
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/income_range_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/income_range_view.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/income_range_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/income_range_view.proto
index 211cf3f82..e61a18119 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/income_range_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/income_range_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "IncomeRangeViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the income range view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/invoice.proto b/third_party/googleapis/google/ads/googleads/v13/resources/invoice.proto
new file mode 100644
index 000000000..539e553b0
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/invoice.proto
@@ -0,0 +1,372 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/dates.proto";
+import "google/ads/googleads/v13/enums/invoice_type.proto";
+import "google/ads/googleads/v13/enums/month_of_year.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "InvoiceProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the Invoice resource.
+
+// An invoice. All invoice information is snapshotted to match the PDF invoice.
+// For invoices older than the launch of InvoiceService, the snapshotted
+// information may not match the PDF invoice.
+message Invoice {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/Invoice"
+ pattern: "customers/{customer_id}/invoices/{invoice_id}"
+ };
+
+ // Represents a summarized view at account level.
+ // AccountSummary fields are accessible only to customers on the allow-list.
+ message AccountSummary {
+ // Output only. The account associated with the account summary.
+ optional string customer = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Pretax billing correction subtotal amount, in micros.
+ optional int64 billing_correction_subtotal_amount_micros = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Tax on billing correction, in micros.
+ optional int64 billing_correction_tax_amount_micros = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Total billing correction amount, in micros.
+ optional int64 billing_correction_total_amount_micros = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Pretax coupon adjustment subtotal amount, in micros.
+ optional int64 coupon_adjustment_subtotal_amount_micros = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Tax on coupon adjustment, in micros.
+ optional int64 coupon_adjustment_tax_amount_micros = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Total coupon adjustment amount, in micros.
+ optional int64 coupon_adjustment_total_amount_micros = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Pretax excess credit adjustment subtotal amount, in micros.
+ optional int64 excess_credit_adjustment_subtotal_amount_micros = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Tax on excess credit adjustment, in micros.
+ optional int64 excess_credit_adjustment_tax_amount_micros = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Total excess credit adjustment amount, in micros.
+ optional int64 excess_credit_adjustment_total_amount_micros = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Pretax regulatory costs subtotal amount, in micros.
+ optional int64 regulatory_costs_subtotal_amount_micros = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Tax on regulatory costs, in micros.
+ optional int64 regulatory_costs_tax_amount_micros = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Total regulatory costs amount, in micros.
+ optional int64 regulatory_costs_total_amount_micros = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Total pretax subtotal amount attributable to the account
+ // during the service period, in micros.
+ optional int64 subtotal_amount_micros = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Total tax amount attributable to the account during the
+ // service period, in micros.
+ optional int64 tax_amount_micros = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Total amount attributable to the account during the service
+ // period, in micros. This equals the sum of the subtotal_amount_micros and
+ // tax_amount_micros.
+ optional int64 total_amount_micros = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Represents a summarized account budget billable cost.
+ message AccountBudgetSummary {
+ // Output only. The resource name of the customer associated with this
+ // account budget. This contains the customer ID, which appears on the
+ // invoice PDF as "Account ID". Customer resource names have the form:
+ //
+ // `customers/{customer_id}`
+ optional string customer = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The descriptive name of the account budget's customer. It
+ // appears on the invoice PDF as "Account".
+ optional string customer_descriptive_name = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The resource name of the account budget associated with this
+ // summarized billable cost. AccountBudget resource names have the form:
+ //
+ // `customers/{customer_id}/accountBudgets/{account_budget_id}`
+ optional string account_budget = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The name of the account budget. It appears on the invoice
+ // PDF as "Account budget".
+ optional string account_budget_name = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The purchase order number of the account budget. It appears
+ // on the invoice PDF as "Purchase order".
+ optional string purchase_order_number = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The pretax subtotal amount attributable to this budget
+ // during the service period, in micros.
+ optional int64 subtotal_amount_micros = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The tax amount attributable to this budget during the
+ // service period, in micros.
+ optional int64 tax_amount_micros = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The total amount attributable to this budget during the
+ // service period, in micros. This equals the sum of the account budget
+ // subtotal amount and the account budget tax amount.
+ optional int64 total_amount_micros = 17
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The billable activity date range of the account budget,
+ // within the service date range of this invoice. The end date is inclusive.
+ // This can be different from the account budget's start and end time.
+ google.ads.googleads.v13.common.DateRange billable_activity_date_range = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Accessible only to customers on the allow-list.
+ // The pretax served amount attributable to this budget during the service
+ // period, in micros. This is only useful to reconcile invoice and delivery
+ // data.
+ optional int64 served_amount_micros = 18
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Accessible only to customers on the allow-list.
+ // The pretax billed amount attributable to this budget during the
+ // service period, in micros. This does not account for any adjustments.
+ optional int64 billed_amount_micros = 19
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Accessible only to customers on the allow-list.
+ // The pretax overdelivery amount attributable to this budget during the
+ // service period, in micros (negative value).
+ optional int64 overdelivery_amount_micros = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Accessible only to customers on the allow-list.
+ // The pretax invalid activity amount attributable to this budget in
+ // previous months, in micros (negative value).
+ optional int64 invalid_activity_amount_micros = 21
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The list of summarized invalid activity credits with
+ // original linkages.
+ repeated InvalidActivitySummary invalid_activity_summaries = 22
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Details about the invalid activity for the invoice that contain
+ // additional details about invoice against which corrections are made.
+ message InvalidActivitySummary {
+ // Output only. Original month of service related to this invalid activity
+ // credit.
+ optional google.ads.googleads.v13.enums.MonthOfYearEnum.MonthOfYear
+ original_month_of_service = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Original year of service related to this invalid activity
+ // credit.
+ optional string original_year_of_service = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Original invoice number related to this invalid activity
+ // credit.
+ optional string original_invoice_id = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Original account budget name related to this invalid
+ // activity credit.
+ optional string original_account_budget_name = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Original purchase order number related to this invalid
+ // activity credit.
+ optional string original_purchase_order_number = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Invalid activity amount in micros.
+ optional int64 amount_micros = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Output only. The resource name of the invoice. Multiple customers can share
+ // a given invoice, so multiple resource names may point to the same invoice.
+ // Invoice resource names have the form:
+ //
+ // `customers/{customer_id}/invoices/{invoice_id}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/Invoice"
+ }
+ ];
+
+ // Output only. The ID of the invoice. It appears on the invoice PDF as
+ // "Invoice number".
+ optional string id = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The type of invoice.
+ google.ads.googleads.v13.enums.InvoiceTypeEnum.InvoiceType type = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The resource name of this invoice's billing setup.
+ //
+ // `customers/{customer_id}/billingSetups/{billing_setup_id}`
+ optional string billing_setup = 26
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. A 16 digit ID used to identify the payments account associated
+ // with the billing setup, for example, "1234-5678-9012-3456". It appears on
+ // the invoice PDF as "Billing Account Number".
+ optional string payments_account_id = 27
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. A 12 digit ID used to identify the payments profile associated
+ // with the billing setup, for example, "1234-5678-9012". It appears on the
+ // invoice PDF as "Billing ID".
+ optional string payments_profile_id = 28
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The issue date in yyyy-mm-dd format. It appears on the invoice
+ // PDF as either "Issue date" or "Invoice date".
+ optional string issue_date = 29 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The due date in yyyy-mm-dd format.
+ optional string due_date = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The service period date range of this invoice. The end date is
+ // inclusive.
+ google.ads.googleads.v13.common.DateRange service_date_range = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The currency code. All costs are returned in this currency. A
+ // subset of the currency codes derived from the ISO 4217 standard is
+ // supported.
+ optional string currency_code = 31
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The pretax subtotal amount of invoice level adjustments, in
+ // micros.
+ int64 adjustments_subtotal_amount_micros = 19
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The sum of taxes on the invoice level adjustments, in micros.
+ int64 adjustments_tax_amount_micros = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The total amount of invoice level adjustments, in micros.
+ int64 adjustments_total_amount_micros = 21
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The pretax subtotal amount of invoice level regulatory costs,
+ // in micros.
+ int64 regulatory_costs_subtotal_amount_micros = 22
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The sum of taxes on the invoice level regulatory costs, in
+ // micros.
+ int64 regulatory_costs_tax_amount_micros = 23
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The total amount of invoice level regulatory costs, in micros.
+ int64 regulatory_costs_total_amount_micros = 24
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The pretax subtotal amount, in micros. This equals the
+ // sum of the AccountBudgetSummary subtotal amounts,
+ // Invoice.adjustments_subtotal_amount_micros, and
+ // Invoice.regulatory_costs_subtotal_amount_micros.
+ // Starting with v6, the Invoice.regulatory_costs_subtotal_amount_micros is no
+ // longer included.
+ optional int64 subtotal_amount_micros = 33
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The sum of all taxes on the invoice, in micros. This equals
+ // the sum of the AccountBudgetSummary tax amounts, plus taxes not associated
+ // with a specific account budget.
+ optional int64 tax_amount_micros = 34
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The total amount, in micros. This equals the sum of
+ // Invoice.subtotal_amount_micros and Invoice.tax_amount_micros.
+ // Starting with v6, Invoice.regulatory_costs_subtotal_amount_micros is
+ // also added as it is no longer already included in
+ // Invoice.tax_amount_micros.
+ optional int64 total_amount_micros = 35
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The resource name of the original invoice corrected, wrote
+ // off, or canceled by this invoice, if applicable. If `corrected_invoice` is
+ // set, `replaced_invoices` will not be set. Invoice resource names have the
+ // form:
+ //
+ // `customers/{customer_id}/invoices/{invoice_id}`
+ optional string corrected_invoice = 36
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The resource name of the original invoice(s) being rebilled or
+ // replaced by this invoice, if applicable. There might be multiple replaced
+ // invoices due to invoice consolidation. The replaced invoices may not belong
+ // to the same payments account. If `replaced_invoices` is set,
+ // `corrected_invoice` will not be set. Invoice resource names have the form:
+ //
+ // `customers/{customer_id}/invoices/{invoice_id}`
+ repeated string replaced_invoices = 37
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The URL to a PDF copy of the invoice. Users need to pass in
+ // their OAuth token to request the PDF with this URL.
+ optional string pdf_url = 38 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The list of summarized account budget information associated
+ // with this invoice.
+ repeated AccountBudgetSummary account_budget_summaries = 18
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The list of summarized account information associated with
+ // this invoice.
+ repeated AccountSummary account_summaries = 39
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan.proto b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan.proto
index 6e381b314..f78d4bc15 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/dates.proto";
-import "google/ads/googleads/v10/enums/keyword_plan_forecast_interval.proto";
+import "google/ads/googleads/v13/common/dates.proto";
+import "google/ads/googleads/v13/enums/keyword_plan_forecast_interval.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the keyword plan resource.
@@ -70,12 +70,14 @@ message KeywordPlanForecastPeriod {
// Required. The date used for forecasting the Plan.
oneof interval {
// A future date range relative to the current date used for forecasting.
- google.ads.googleads.v10.enums.KeywordPlanForecastIntervalEnum.KeywordPlanForecastInterval date_interval = 1;
+ google.ads.googleads.v13.enums.KeywordPlanForecastIntervalEnum
+ .KeywordPlanForecastInterval date_interval = 1;
- // The custom date range used for forecasting.
+ // The custom date range used for forecasting. It cannot be greater than
+ // a year.
// The start and end dates must be in the future. Otherwise, an error will
// be returned when the forecasting action is performed.
// The start and end dates are inclusive.
- google.ads.googleads.v10.common.DateRange date_range = 2;
+ google.ads.googleads.v13.common.DateRange date_range = 2;
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_ad_group.proto b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_ad_group.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_ad_group.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_ad_group.proto
index f0e36f5f5..c19ea6eeb 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_ad_group.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_ad_group.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanAdGroupProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the keyword plan ad group resource.
@@ -51,8 +51,8 @@ message KeywordPlanAdGroup {
// The keyword plan campaign to which this ad group belongs.
optional string keyword_plan_campaign = 6 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlanCampaign"
- }];
+ type: "googleads.googleapis.com/KeywordPlanCampaign"
+ }];
// Output only. The ID of the keyword plan ad group.
optional int64 id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_ad_group_keyword.proto b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_ad_group_keyword.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_ad_group_keyword.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_ad_group_keyword.proto
index 578337f52..3ebceaa18 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_ad_group_keyword.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_ad_group_keyword.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/keyword_match_type.proto";
+import "google/ads/googleads/v13/enums/keyword_match_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanAdGroupKeywordProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the keyword plan ad group keyword resource.
@@ -52,8 +52,8 @@ message KeywordPlanAdGroupKeyword {
// The Keyword Plan ad group to which this keyword belongs.
optional string keyword_plan_ad_group = 8 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlanAdGroup"
- }];
+ type: "googleads.googleapis.com/KeywordPlanAdGroup"
+ }];
// Output only. The ID of the Keyword Plan keyword.
optional int64 id = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -62,13 +62,13 @@ message KeywordPlanAdGroupKeyword {
optional string text = 10;
// The keyword match type.
- google.ads.googleads.v10.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5;
+ google.ads.googleads.v13.enums.KeywordMatchTypeEnum.KeywordMatchType
+ match_type = 5;
- // A keyword level max cpc bid in micros (e.g. $1 = 1mm). The currency is the
- // same as the account currency code. This will override any CPC bid set at
- // the keyword plan ad group level.
- // Not applicable for negative keywords. (negative = true)
- // This field is Optional.
+ // A keyword level max cpc bid in micros (for example, $1 = 1mm). The currency
+ // is the same as the account currency code. This will override any CPC bid
+ // set at the keyword plan ad group level. Not applicable for negative
+ // keywords. (negative = true) This field is Optional.
optional int64 cpc_bid_micros = 11;
// Immutable. If true, the keyword is negative.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_campaign.proto b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_campaign.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_campaign.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_campaign.proto
index e53e2dfd4..e39a0b9ae 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_campaign.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_campaign.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/keyword_plan_network.proto";
+import "google/ads/googleads/v13/enums/keyword_plan_network.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanCampaignProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the keyword plan campaign resource.
@@ -52,8 +52,8 @@ message KeywordPlanCampaign {
// The keyword plan this campaign belongs to.
optional string keyword_plan = 9 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlan"
- }];
+ type: "googleads.googleapis.com/KeywordPlan"
+ }];
// Output only. The ID of the Keyword Plan campaign.
optional int64 id = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -67,14 +67,15 @@ message KeywordPlanCampaign {
// The languages targeted for the Keyword Plan campaign.
// Max allowed: 1.
repeated string language_constants = 12 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/LanguageConstant"
- }];
+ type: "googleads.googleapis.com/LanguageConstant"
+ }];
// Targeting network.
//
// This field is required and should not be empty when creating Keyword Plan
// campaigns.
- google.ads.googleads.v10.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 6;
+ google.ads.googleads.v13.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork
+ keyword_plan_network = 6;
// A default max cpc bid in micros, and in the account currency, for all ad
// groups under the campaign.
@@ -92,6 +93,6 @@ message KeywordPlanCampaign {
message KeywordPlanGeoTarget {
// Required. The resource name of the geo target.
optional string geo_target_constant = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/GeoTargetConstant"
- }];
+ type: "googleads.googleapis.com/GeoTargetConstant"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_campaign_keyword.proto b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_campaign_keyword.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_campaign_keyword.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_campaign_keyword.proto
index 33a539a42..27eaa6acd 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_plan_campaign_keyword.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_plan_campaign_keyword.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/keyword_match_type.proto";
+import "google/ads/googleads/v13/enums/keyword_match_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanCampaignKeywordProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the keyword plan negative keyword resource.
@@ -52,8 +52,8 @@ message KeywordPlanCampaignKeyword {
// The Keyword Plan campaign to which this negative keyword belongs.
optional string keyword_plan_campaign = 8 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlanCampaign"
- }];
+ type: "googleads.googleapis.com/KeywordPlanCampaign"
+ }];
// Output only. The ID of the Keyword Plan negative keyword.
optional int64 id = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -62,7 +62,8 @@ message KeywordPlanCampaignKeyword {
optional string text = 10;
// The keyword match type.
- google.ads.googleads.v10.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5;
+ google.ads.googleads.v13.enums.KeywordMatchTypeEnum.KeywordMatchType
+ match_type = 5;
// Immutable. If true, the keyword is negative.
// Must be set to true. Only negative campaign keywords are supported.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_theme_constant.proto b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_theme_constant.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/keyword_theme_constant.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/keyword_theme_constant.proto
index ab85f7bbe..793a54bc8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_theme_constant.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_theme_constant.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "KeywordThemeConstantProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Smart Campaign keyword theme constant resource.
@@ -53,9 +53,9 @@ message KeywordThemeConstant {
// localized.
optional string country_code = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The ISO-639-1 language code with 2 letters of the constant, eg. "en".
- // To display and query matching purpose, the keyword theme needs to be
- // localized.
+ // Output only. The ISO-639-1 language code with 2 letters of the constant,
+ // eg. "en". To display and query matching purpose, the keyword theme needs to
+ // be localized.
optional string language_code = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The display name of the keyword theme or sub keyword theme.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_view.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/resources/keyword_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/keyword_view.proto
index b4fa7de55..b9bd60469 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/keyword_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/keyword_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "KeywordViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the keyword view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/label.proto b/third_party/googleapis/google/ads/googleads/v13/resources/label.proto
similarity index 68%
rename from third_party/googleapis/google/ads/googleads/v10/resources/label.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/label.proto
index dcc68f77c..1f43226c8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/label.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/label.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/text_label.proto";
-import "google/ads/googleads/v10/enums/label_status.proto";
+import "google/ads/googleads/v13/common/text_label.proto";
+import "google/ads/googleads/v13/enums/label_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "LabelProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// A label.
message Label {
@@ -42,12 +42,10 @@ message Label {
// `customers/{customer_id}/labels/{label_id}`
string resource_name = 1 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Label"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Label" }
];
- // Output only. Id of the label. Read only.
+ // Output only. ID of the label. Read only.
optional int64 id = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// The name of the label.
@@ -58,8 +56,9 @@ message Label {
optional string name = 7;
// Output only. Status of the label. Read only.
- google.ads.googleads.v10.enums.LabelStatusEnum.LabelStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.LabelStatusEnum.LabelStatus status = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// A type of label displaying text on a colored background.
- google.ads.googleads.v10.common.TextLabel text_label = 5;
+ google.ads.googleads.v13.common.TextLabel text_label = 5;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/landing_page_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/landing_page_view.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/resources/landing_page_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/landing_page_view.proto
index ae0365f96..3627436e3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/landing_page_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/landing_page_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "LandingPageViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the landing page view resource.
@@ -50,5 +50,6 @@ message LandingPageView {
];
// Output only. The advertiser-specified final URL.
- optional string unexpanded_final_url = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string unexpanded_final_url = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/language_constant.proto b/third_party/googleapis/google/ads/googleads/v13/resources/language_constant.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/resources/language_constant.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/language_constant.proto
index c0ba053a3..907e51750 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/language_constant.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/language_constant.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "LanguageConstantProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the language constant resource.
@@ -51,11 +51,12 @@ message LanguageConstant {
// Output only. The ID of the language constant.
optional int64 id = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The language code, e.g. "en_US", "en_AU", "es", "fr", etc.
+ // Output only. The language code, for example, "en_US", "en_AU", "es", "fr",
+ // etc.
optional string code = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The full name of the language in English, e.g., "English (US)", "Spanish",
- // etc.
+ // Output only. The full name of the language in English, for example,
+ // "English (US)", "Spanish", etc.
optional string name = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Whether the language is targetable.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/lead_form_submission_data.proto b/third_party/googleapis/google/ads/googleads/v13/resources/lead_form_submission_data.proto
similarity index 69%
rename from third_party/googleapis/google/ads/googleads/v10/resources/lead_form_submission_data.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/lead_form_submission_data.proto
index 2249ceb48..2a2066906 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/lead_form_submission_data.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/lead_form_submission_data.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/lead_form_field_user_input_type.proto";
+import "google/ads/googleads/v13/enums/lead_form_field_user_input_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "LeadFormSubmissionDataProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the lead form submission data resource.
@@ -55,9 +55,7 @@ message LeadFormSubmissionData {
// Output only. Asset associated with the submitted lead form.
string asset = 3 [
(google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
];
// Output only. Campaign associated with the submitted lead form.
@@ -69,7 +67,12 @@ message LeadFormSubmissionData {
];
// Output only. Submission data associated with a lead form.
- repeated LeadFormSubmissionField lead_form_submission_fields = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated LeadFormSubmissionField lead_form_submission_fields = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Submission data associated with a custom lead form.
+ repeated CustomLeadFormSubmissionField custom_lead_form_submission_fields = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. AdGroup associated with the submitted lead form.
string ad_group = 6 [
@@ -90,16 +93,30 @@ message LeadFormSubmissionData {
// Output only. Google Click Id associated with the submissed lead form.
string gclid = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The date and time at which the lead form was submitted. The format is
- // "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
+ // Output only. The date and time at which the lead form was submitted. The
+ // format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01
+ // 12:32:45-08:00".
string submission_date_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Fields in the submitted lead form.
message LeadFormSubmissionField {
// Output only. Field type for lead form fields.
- google.ads.googleads.v10.enums.LeadFormFieldUserInputTypeEnum.LeadFormFieldUserInputType field_type = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.LeadFormFieldUserInputTypeEnum
+ .LeadFormFieldUserInputType field_type = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Field value for lead form fields.
string field_value = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
+
+// Fields in the submitted custom question
+message CustomLeadFormSubmissionField {
+ // Output only. Question text for custom question, maximum number of
+ // characters is 300.
+ string question_text = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Field value for custom question response, maximum number of
+ // characters is 70.
+ string field_value = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/life_event.proto b/third_party/googleapis/google/ads/googleads/v13/resources/life_event.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/resources/life_event.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/life_event.proto
index efe8bc015..0787a7807 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/life_event.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/life_event.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/criterion_category_availability.proto";
+import "google/ads/googleads/v13/common/criterion_category_availability.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "LifeEventProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Life Event resource.
@@ -53,7 +53,7 @@ message LifeEvent {
// Output only. The ID of the life event.
int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The name of the life event. E.g.,"Recently Moved"
+ // Output only. The name of the life event, for example,"Recently Moved"
string name = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The parent of the life_event.
@@ -64,9 +64,11 @@ message LifeEvent {
}
];
- // Output only. True if the life event is launched to all channels and locales.
+ // Output only. True if the life event is launched to all channels and
+ // locales.
bool launched_to_all = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Availability information of the life event.
- repeated google.ads.googleads.v10.common.CriterionCategoryAvailability availabilities = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.ads.googleads.v13.common.CriterionCategoryAvailability
+ availabilities = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/location_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/location_view.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/location_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/location_view.proto
index 7da30fac1..c1a31a63e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/location_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/location_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "LocationViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the location view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/managed_placement_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/managed_placement_view.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/managed_placement_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/managed_placement_view.proto
index 18afabba2..b0aebac4e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/managed_placement_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/managed_placement_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ManagedPlacementViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Managed Placement view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/media_file.proto b/third_party/googleapis/google/ads/googleads/v13/resources/media_file.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/resources/media_file.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/media_file.proto
index e7f6d5dd8..0eaf7ce69 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/media_file.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/media_file.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/media_type.proto";
-import "google/ads/googleads/v10/enums/mime_type.proto";
+import "google/ads/googleads/v13/enums/media_type.proto";
+import "google/ads/googleads/v13/enums/mime_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "MediaFileProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the media file resource.
@@ -54,17 +54,19 @@ message MediaFile {
optional int64 id = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. Type of the media file.
- google.ads.googleads.v10.enums.MediaTypeEnum.MediaType type = 5 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.MediaTypeEnum.MediaType type = 5
+ [(google.api.field_behavior) = IMMUTABLE];
// Output only. The mime type of the media file.
- google.ads.googleads.v10.enums.MimeTypeEnum.MimeType mime_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.MimeTypeEnum.MimeType mime_type = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. The URL of where the original media file was downloaded from (or a file
- // name). Only used for media of type AUDIO and IMAGE.
+ // Immutable. The URL of where the original media file was downloaded from (or
+ // a file name). Only used for media of type AUDIO and IMAGE.
optional string source_url = 13 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The name of the media file. The name can be used by clients to help
- // identify previously uploaded media.
+ // Immutable. The name of the media file. The name can be used by clients to
+ // help identify previously uploaded media.
optional string name = 14 [(google.api.field_behavior) = IMMUTABLE];
// Output only. The size of the media file in bytes.
@@ -75,7 +77,8 @@ message MediaFile {
// Immutable. Encapsulates an Image.
MediaImage image = 3 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. A ZIP archive media the content of which contains HTML5 assets.
+ // Immutable. A ZIP archive media the content of which contains HTML5
+ // assets.
MediaBundle media_bundle = 4 [(google.api.field_behavior) = IMMUTABLE];
// Output only. Encapsulates an Audio.
@@ -92,10 +95,12 @@ message MediaImage {
optional bytes data = 4 [(google.api.field_behavior) = IMMUTABLE];
// Output only. The url to the full size version of the image.
- optional string full_size_image_url = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string full_size_image_url = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The url to the preview size version of the image.
- optional string preview_size_image_url = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string preview_size_image_url = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Represents a ZIP archive media the content of which contains HTML5 assets.
@@ -104,7 +109,7 @@ message MediaBundle {
optional bytes data = 3 [(google.api.field_behavior) = IMMUTABLE];
// Output only. The url to access the uploaded zipped data.
- // E.g. https://tpc.googlesyndication.com/simgad/123
+ // For example, https://tpc.googlesyndication.com/simgad/123
// This field is read-only.
optional string url = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -112,25 +117,29 @@ message MediaBundle {
// Encapsulates an Audio.
message MediaAudio {
// Output only. The duration of the Audio in milliseconds.
- optional int64 ad_duration_millis = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 ad_duration_millis = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Encapsulates a Video.
message MediaVideo {
// Output only. The duration of the Video in milliseconds.
- optional int64 ad_duration_millis = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 ad_duration_millis = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. The YouTube video ID (as seen in YouTube URLs). Adding prefix
// "https://www.youtube.com/watch?v=" to this ID will get the YouTube
// streaming URL for this video.
- optional string youtube_video_id = 6 [(google.api.field_behavior) = IMMUTABLE];
+ optional string youtube_video_id = 6
+ [(google.api.field_behavior) = IMMUTABLE];
- // Output only. The Advertising Digital Identification code for this video, as defined by
- // the American Association of Advertising Agencies, used mainly for
- // television commercials.
- optional string advertising_id_code = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The Advertising Digital Identification code for this video, as
+ // defined by the American Association of Advertising Agencies, used mainly
+ // for television commercials.
+ optional string advertising_id_code = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The Industry Standard Commercial Identifier code for this video, used
- // mainly for television commercials.
+ // Output only. The Industry Standard Commercial Identifier code for this
+ // video, used mainly for television commercials.
optional string isci_code = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/merchant_center_link.proto b/third_party/googleapis/google/ads/googleads/v13/resources/merchant_center_link.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/resources/merchant_center_link.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/merchant_center_link.proto
index f23a16f91..05af4b919 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/merchant_center_link.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/merchant_center_link.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/merchant_center_link_status.proto";
+import "google/ads/googleads/v13/enums/merchant_center_link_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "MerchantCenterLinkProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Merchant Center link resource.
@@ -56,8 +56,10 @@ message MerchantCenterLink {
// Output only. The name of the Merchant Center account.
// This field is readonly.
- optional string merchant_center_account_name = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string merchant_center_account_name = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The status of the link.
- google.ads.googleads.v10.enums.MerchantCenterLinkStatusEnum.MerchantCenterLinkStatus status = 5;
+ google.ads.googleads.v13.enums.MerchantCenterLinkStatusEnum
+ .MerchantCenterLinkStatus status = 5;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/mobile_app_category_constant.proto b/third_party/googleapis/google/ads/googleads/v13/resources/mobile_app_category_constant.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/resources/mobile_app_category_constant.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/mobile_app_category_constant.proto
index 5a20d3d66..98779e495 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/mobile_app_category_constant.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/mobile_app_category_constant.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "MobileAppCategoryConstantProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Mobile App Category Constant resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/mobile_device_constant.proto b/third_party/googleapis/google/ads/googleads/v13/resources/mobile_device_constant.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/resources/mobile_device_constant.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/mobile_device_constant.proto
index fe2dcee95..5cff27305 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/mobile_device_constant.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/mobile_device_constant.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/mobile_device_type.proto";
+import "google/ads/googleads/v13/enums/mobile_device_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "MobileDeviceConstantProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the mobile device constant resource.
@@ -56,11 +56,14 @@ message MobileDeviceConstant {
optional string name = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The manufacturer of the mobile device.
- optional string manufacturer_name = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string manufacturer_name = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The operating system of the mobile device.
- optional string operating_system_name = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string operating_system_name = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The type of mobile device.
- google.ads.googleads.v10.enums.MobileDeviceTypeEnum.MobileDeviceType type = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.MobileDeviceTypeEnum.MobileDeviceType type = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/offline_user_data_job.proto b/third_party/googleapis/google/ads/googleads/v13/resources/offline_user_data_job.proto
similarity index 58%
rename from third_party/googleapis/google/ads/googleads/v10/resources/offline_user_data_job.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/offline_user_data_job.proto
index d00f61fb9..4e00a4ecc 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/offline_user_data_job.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/offline_user_data_job.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/offline_user_data.proto";
-import "google/ads/googleads/v10/enums/offline_user_data_job_failure_reason.proto";
-import "google/ads/googleads/v10/enums/offline_user_data_job_match_rate_range.proto";
-import "google/ads/googleads/v10/enums/offline_user_data_job_status.proto";
-import "google/ads/googleads/v10/enums/offline_user_data_job_type.proto";
+import "google/ads/googleads/v13/common/offline_user_data.proto";
+import "google/ads/googleads/v13/enums/offline_user_data_job_failure_reason.proto";
+import "google/ads/googleads/v13/enums/offline_user_data_job_match_rate_range.proto";
+import "google/ads/googleads/v13/enums/offline_user_data_job_status.proto";
+import "google/ads/googleads/v13/enums/offline_user_data_job_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "OfflineUserDataJobProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the offline user data job resource.
@@ -63,32 +63,44 @@ message OfflineUserDataJob {
optional int64 external_id = 10 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Type of the job.
- google.ads.googleads.v10.enums.OfflineUserDataJobTypeEnum.OfflineUserDataJobType type = 4 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.enums.OfflineUserDataJobTypeEnum
+ .OfflineUserDataJobType type = 4
+ [(google.api.field_behavior) = IMMUTABLE];
// Output only. Status of the job.
- google.ads.googleads.v10.enums.OfflineUserDataJobStatusEnum.OfflineUserDataJobStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.OfflineUserDataJobStatusEnum
+ .OfflineUserDataJobStatus status = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Reason for the processing failure, if status is FAILED.
- google.ads.googleads.v10.enums.OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason failure_reason = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.OfflineUserDataJobFailureReasonEnum
+ .OfflineUserDataJobFailureReason failure_reason = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Metadata of offline user data job depicting match rate range.
- OfflineUserDataJobMetadata operation_metadata = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ OfflineUserDataJobMetadata operation_metadata = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Metadata of the job.
oneof metadata {
// Immutable. Metadata for data updates to a CRM-based user list.
- google.ads.googleads.v10.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.CustomerMatchUserListMetadata
+ customer_match_user_list_metadata = 7
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Metadata for store sales data update.
- google.ads.googleads.v10.common.StoreSalesMetadata store_sales_metadata = 8 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.StoreSalesMetadata store_sales_metadata = 8
+ [(google.api.field_behavior) = IMMUTABLE];
}
}
// Metadata of offline user data job.
message OfflineUserDataJobMetadata {
- // Output only. Match rate of the Customer Match user list upload. Describes the estimated
- // match rate when the status of the job is "RUNNING" and final match rate
- // when the final match rate is available after the status of the job is
- // "SUCCESS/FAILED".
- google.ads.googleads.v10.enums.OfflineUserDataJobMatchRateRangeEnum.OfflineUserDataJobMatchRateRange match_rate_range = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Match rate of the Customer Match user list upload. Describes
+ // the estimated match rate when the status of the job is "RUNNING" and final
+ // match rate when the final match rate is available after the status of the
+ // job is "SUCCESS/FAILED".
+ google.ads.googleads.v13.enums.OfflineUserDataJobMatchRateRangeEnum
+ .OfflineUserDataJobMatchRateRange match_rate_range = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/operating_system_version_constant.proto b/third_party/googleapis/google/ads/googleads/v13/resources/operating_system_version_constant.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/resources/operating_system_version_constant.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/operating_system_version_constant.proto
index 98165ec95..ee91d4ecf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/operating_system_version_constant.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/operating_system_version_constant.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/operating_system_version_operator_type.proto";
+import "google/ads/googleads/v13/enums/operating_system_version_operator_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "OperatingSystemVersionConstantProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the operating system version constant resource.
@@ -58,12 +58,16 @@ message OperatingSystemVersionConstant {
optional string name = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The OS Major Version number.
- optional int32 os_major_version = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int32 os_major_version = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The OS Minor Version number.
- optional int32 os_minor_version = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int32 os_minor_version = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Determines whether this constant represents a single version or a range of
- // versions.
- google.ads.googleads.v10.enums.OperatingSystemVersionOperatorTypeEnum.OperatingSystemVersionOperatorType operator_type = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Determines whether this constant represents a single version
+ // or a range of versions.
+ google.ads.googleads.v13.enums.OperatingSystemVersionOperatorTypeEnum
+ .OperatingSystemVersionOperatorType operator_type = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/paid_organic_search_term_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/paid_organic_search_term_view.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/resources/paid_organic_search_term_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/paid_organic_search_term_view.proto
index 2dd6d606c..c90a6a0a6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/paid_organic_search_term_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/paid_organic_search_term_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "PaidOrganicSearchTermViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the PaidOrganicSearchTermView resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/parental_status_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/parental_status_view.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/parental_status_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/parental_status_view.proto
index e06c57328..f8cf8fad3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/parental_status_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/parental_status_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ParentalStatusViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the parental status view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/payments_account.proto b/third_party/googleapis/google/ads/googleads/v13/resources/payments_account.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/resources/payments_account.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/payments_account.proto
index c4da0d416..666deb710 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/payments_account.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/payments_account.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "PaymentsAccountProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the PaymentsAccount resource.
@@ -49,7 +49,8 @@ message PaymentsAccount {
];
// Output only. A 16 digit ID used to identify a payments account.
- optional string payments_account_id = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string payments_account_id = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The name of the payments account.
optional string name = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -57,15 +58,19 @@ message PaymentsAccount {
// Output only. The currency code of the payments account.
// A subset of the currency codes derived from the ISO 4217 standard is
// supported.
- optional string currency_code = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string currency_code = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A 12 digit ID used to identify the payments profile associated with the
- // payments account.
- optional string payments_profile_id = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. A 12 digit ID used to identify the payments profile associated
+ // with the payments account.
+ optional string payments_profile_id = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A secondary payments profile ID present in uncommon situations, e.g.
- // when a sequential liability agreement has been arranged.
- optional string secondary_payments_profile_id = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. A secondary payments profile ID present in uncommon
+ // situations, for example, when a sequential liability agreement has been
+ // arranged.
+ optional string secondary_payments_profile_id = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Paying manager of this payment account.
optional string paying_manager_customer = 13 [
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/per_store_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/per_store_view.proto
new file mode 100644
index 000000000..432bc25ff
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/per_store_view.proto
@@ -0,0 +1,55 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "PerStoreViewProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the PerStoreView resource.
+
+// A per store view.
+// This view provides per store impression reach and local action conversion
+// stats for advertisers.
+message PerStoreView {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/PerStoreView"
+ pattern: "customers/{customer_id}/perStoreViews/{place_id}"
+ };
+
+ // Output only. The resource name of the per store view.
+ // Per Store view resource names have the form:
+ //
+ // `customers/{customer_id}/perStoreViews/{place_id}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/PerStoreView"
+ }
+ ];
+
+ // Output only. The place ID of the per store view.
+ string place_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/product_bidding_category_constant.proto b/third_party/googleapis/google/ads/googleads/v13/resources/product_bidding_category_constant.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/resources/product_bidding_category_constant.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/product_bidding_category_constant.proto
index 3785cdf0b..6d77d529b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/product_bidding_category_constant.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/product_bidding_category_constant.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/product_bidding_category_level.proto";
-import "google/ads/googleads/v10/enums/product_bidding_category_status.proto";
+import "google/ads/googleads/v13/enums/product_bidding_category_level.proto";
+import "google/ads/googleads/v13/enums/product_bidding_category_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ProductBiddingCategoryConstantProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ProductBiddingCategoryConstant resource.
@@ -56,7 +56,8 @@ message ProductBiddingCategoryConstant {
// this article: https://support.google.com/merchants/answer/6324436.
optional int64 id = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Two-letter upper-case country code of the product bidding category.
+ // Output only. Two-letter upper-case country code of the product bidding
+ // category.
optional string country_code = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Resource name of the parent product bidding category.
@@ -68,15 +69,21 @@ message ProductBiddingCategoryConstant {
];
// Output only. Level of the product bidding category.
- google.ads.googleads.v10.enums.ProductBiddingCategoryLevelEnum.ProductBiddingCategoryLevel level = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.ProductBiddingCategoryLevelEnum
+ .ProductBiddingCategoryLevel level = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Status of the product bidding category.
- google.ads.googleads.v10.enums.ProductBiddingCategoryStatusEnum.ProductBiddingCategoryStatus status = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.ProductBiddingCategoryStatusEnum
+ .ProductBiddingCategoryStatus status = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Language code of the product bidding category.
- optional string language_code = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional string language_code = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Display value of the product bidding category localized according to
- // language_code.
- optional string localized_name = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Display value of the product bidding category localized
+ // according to language_code.
+ optional string localized_name = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/product_group_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/product_group_view.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/resources/product_group_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/product_group_view.proto
index f7e266fd6..3d5137150 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/product_group_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/product_group_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ProductGroupViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ProductGroup View resource.
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/product_link.proto b/third_party/googleapis/google/ads/googleads/v13/resources/product_link.proto
new file mode 100644
index 000000000..280eabf91
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/product_link.proto
@@ -0,0 +1,93 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/enums/linked_product_type.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "ProductLinkProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Represents the data sharing connection between a Google
+// Ads customer and another product.
+message ProductLink {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/ProductLink"
+ pattern: "customers/{customer_id}/productLinks/{product_link_id}"
+ };
+
+ // Immutable. Resource name of the product link.
+ // ProductLink resource names have the form:
+ //
+ // `customers/{customer_id}/productLinks/{product_link_id} `
+ string resource_name = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/ProductLink"
+ }
+ ];
+
+ // Output only. The ID of the link.
+ // This field is read only.
+ optional int64 product_link_id = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The type of the linked product.
+ google.ads.googleads.v13.enums.LinkedProductTypeEnum.LinkedProductType type =
+ 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // A product linked to this account.
+ oneof linked_product {
+ // Immutable. Data partner link.
+ DataPartnerIdentifier data_partner = 4
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Google Ads link.
+ GoogleAdsIdentifier google_ads = 5
+ [(google.api.field_behavior) = IMMUTABLE];
+ }
+}
+
+// The identifier for Data Partner account.
+message DataPartnerIdentifier {
+ // Immutable. The customer ID of the Data partner account.
+ // This field is required and should not be empty when creating a new
+ // data partner link. It is unable to be modified after the creation of
+ // the link.
+ optional int64 data_partner_id = 1 [(google.api.field_behavior) = IMMUTABLE];
+}
+
+// The identifier for Google Ads account.
+message GoogleAdsIdentifier {
+ // Immutable. The resource name of the Google Ads account.
+ // This field is required and should not be empty when creating a new
+ // Google Ads link. It is unable to be modified after the creation of
+ // the link.
+ optional string customer = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/Customer"
+ }
+ ];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/qualifying_question.proto b/third_party/googleapis/google/ads/googleads/v13/resources/qualifying_question.proto
new file mode 100644
index 000000000..04bead0d1
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/qualifying_question.proto
@@ -0,0 +1,58 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "QualifyingQuestionProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the PerStoreView resource.
+
+// Qualifying Questions for Lead Form.
+message QualifyingQuestion {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/QualifyingQuestion"
+ pattern: "qualifyingQuestions/{qualifying_question_id}"
+ };
+
+ // Output only. The resource name of the qualifying question.
+ //
+ // 'qualifyingQuestions/{qualifyingQuestionId}'
+ string resource_name = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/QualifyingQuestion"
+ }
+ ];
+
+ // Output only. The id of the qualifying question.
+ int64 qualifying_question_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The locale of the qualifying question.
+ string locale = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The qualifying question.
+ string text = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/recommendation.proto b/third_party/googleapis/google/ads/googleads/v13/resources/recommendation.proto
new file mode 100644
index 000000000..afed550d3
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/recommendation.proto
@@ -0,0 +1,559 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/enums/keyword_match_type.proto";
+import "google/ads/googleads/v13/enums/recommendation_type.proto";
+import "google/ads/googleads/v13/enums/target_cpa_opt_in_recommendation_goal.proto";
+import "google/ads/googleads/v13/resources/ad.proto";
+import "google/ads/googleads/v13/resources/asset.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "RecommendationProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the Recommendation resource.
+
+// A recommendation.
+message Recommendation {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/Recommendation"
+ pattern: "customers/{customer_id}/recommendations/{recommendation_id}"
+ };
+
+ // The impact of making the change as described in the recommendation.
+ // Some types of recommendations may not have impact information.
+ message RecommendationImpact {
+ // Output only. Base metrics at the time the recommendation was generated.
+ RecommendationMetrics base_metrics = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Estimated metrics if the recommendation is applied.
+ RecommendationMetrics potential_metrics = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Weekly account performance metrics. For some recommendation types, these
+ // are averaged over the past 90-day period and hence can be fractional.
+ message RecommendationMetrics {
+ // Output only. Number of ad impressions.
+ optional double impressions = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Number of ad clicks.
+ optional double clicks = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Cost (in micros) for advertising, in the local currency for
+ // the account.
+ optional int64 cost_micros = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Number of conversions.
+ optional double conversions = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Number of video views for a video ad campaign.
+ optional double video_views = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The budget recommendation for budget constrained campaigns.
+ message CampaignBudgetRecommendation {
+ // The impact estimates for a given budget amount.
+ message CampaignBudgetRecommendationOption {
+ // Output only. The budget amount for this option.
+ optional int64 budget_amount_micros = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The impact estimate if budget is changed to amount
+ // specified in this option.
+ RecommendationImpact impact = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Output only. The current budget amount in micros.
+ optional int64 current_budget_amount_micros = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The recommended budget amount in micros.
+ optional int64 recommended_budget_amount_micros = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The budget amounts and associated impact estimates for some
+ // values of possible budget amounts.
+ repeated CampaignBudgetRecommendationOption budget_options = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The keyword recommendation.
+ message KeywordRecommendation {
+ // Output only. The recommended keyword.
+ google.ads.googleads.v13.common.KeywordInfo keyword = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The recommended CPC (cost-per-click) bid.
+ optional int64 recommended_cpc_bid_micros = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The text ad recommendation.
+ message TextAdRecommendation {
+ // Output only. Recommended ad.
+ Ad ad = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Creation date of the recommended ad.
+ // YYYY-MM-DD format, for example, 2018-04-17.
+ optional string creation_date = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Date, if present, is the earliest when the recommendation
+ // will be auto applied. YYYY-MM-DD format, for example, 2018-04-17.
+ optional string auto_apply_date = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The Target CPA opt-in recommendation.
+ message TargetCpaOptInRecommendation {
+ // The Target CPA opt-in option with impact estimate.
+ message TargetCpaOptInRecommendationOption {
+ // Output only. The goal achieved by this option.
+ google.ads.googleads.v13.enums.TargetCpaOptInRecommendationGoalEnum
+ .TargetCpaOptInRecommendationGoal goal = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Average CPA target.
+ optional int64 target_cpa_micros = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The minimum campaign budget, in local currency for the
+ // account, required to achieve the target CPA. Amount is specified in
+ // micros, where one million is equivalent to one currency unit.
+ optional int64 required_campaign_budget_amount_micros = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The impact estimate if this option is selected.
+ RecommendationImpact impact = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Output only. The available goals and corresponding options for Target CPA
+ // strategy.
+ repeated TargetCpaOptInRecommendationOption options = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The recommended average CPA target. See required budget
+ // amount and impact of using this recommendation in options list.
+ optional int64 recommended_target_cpa_micros = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The Maximize Conversions Opt-In recommendation.
+ message MaximizeConversionsOptInRecommendation {
+ // Output only. The recommended new budget amount.
+ optional int64 recommended_budget_amount_micros = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The Enhanced Cost-Per-Click Opt-In recommendation.
+ message EnhancedCpcOptInRecommendation {}
+
+ // The Search Partners Opt-In recommendation.
+ message SearchPartnersOptInRecommendation {}
+
+ // The Maximize Clicks opt-in recommendation.
+ message MaximizeClicksOptInRecommendation {
+ // Output only. The recommended new budget amount.
+ // Only set if the current budget is too high.
+ optional int64 recommended_budget_amount_micros = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The Optimize Ad Rotation recommendation.
+ message OptimizeAdRotationRecommendation {}
+
+ // The callout asset recommendation.
+ message CalloutAssetRecommendation {
+ // Output only. New callout extension assets recommended at the campaign
+ // level.
+ repeated Asset recommended_campaign_callout_assets = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. New callout extension assets recommended at the customer
+ // level.
+ repeated Asset recommended_customer_callout_assets = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The sitelink asset recommendation.
+ message SitelinkAssetRecommendation {
+ // Output only. New sitelink extension assets recommended at the campaign
+ // level.
+ repeated Asset recommended_campaign_sitelink_assets = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. New sitelink extension assets recommended at the customer
+ // level.
+ repeated Asset recommended_customer_sitelink_assets = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The call asset recommendation.
+ message CallAssetRecommendation {}
+
+ // The keyword match type recommendation.
+ message KeywordMatchTypeRecommendation {
+ // Output only. The existing keyword where the match type should be more
+ // broad.
+ google.ads.googleads.v13.common.KeywordInfo keyword = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The recommended new match type.
+ google.ads.googleads.v13.enums.KeywordMatchTypeEnum.KeywordMatchType
+ recommended_match_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The move unused budget recommendation.
+ message MoveUnusedBudgetRecommendation {
+ // Output only. The excess budget's resource_name.
+ optional string excess_campaign_budget = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The recommendation for the constrained budget to increase.
+ CampaignBudgetRecommendation budget_recommendation = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The Target ROAS opt-in recommendation.
+ message TargetRoasOptInRecommendation {
+ // Output only. The recommended target ROAS (revenue per unit of spend).
+ // The value is between 0.01 and 1000.0, inclusive.
+ optional double recommended_target_roas = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The minimum campaign budget, in local currency for the
+ // account, required to achieve the target ROAS. Amount is specified in
+ // micros, where one million is equivalent to one currency unit.
+ optional int64 required_campaign_budget_amount_micros = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The add responsive search ad asset recommendation.
+ message ResponsiveSearchAdAssetRecommendation {
+ // Output only. The recommended assets. This is populated only with the new
+ // headlines and/or descriptions, and is otherwise empty.
+ Ad recommended_assets = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The responsive search ad improve ad strength recommendation.
+ message ResponsiveSearchAdImproveAdStrengthRecommendation {
+ // Output only. The current ad to be updated.
+ Ad current_ad = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The updated ad.
+ Ad recommended_ad = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The add responsive search ad recommendation.
+ message ResponsiveSearchAdRecommendation {
+ // Output only. Recommended ad.
+ Ad ad = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The use broad match keyword recommendation.
+ message UseBroadMatchKeywordRecommendation {
+ // Output only. Sample of keywords to be expanded to Broad Match.
+ repeated google.ads.googleads.v13.common.KeywordInfo keyword = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Total number of keywords to be expanded to Broad Match in
+ // the campaign.
+ int64 suggested_keywords_count = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Total number of keywords in the campaign.
+ int64 campaign_keywords_count = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Whether the associated campaign uses a shared budget.
+ bool campaign_uses_shared_budget = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The budget recommended to avoid becoming budget constrained
+ // after applying the recommendation.
+ int64 required_campaign_budget_amount_micros = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The upgrade a Smart Shopping campaign to a Performance Max campaign
+ // recommendation.
+ message UpgradeSmartShoppingCampaignToPerformanceMaxRecommendation {
+ // Output only. ID of Merchant Center account.
+ int64 merchant_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Country whose products from merchant's inventory should be
+ // included.
+ string sales_country_code = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The raise target CPA bid too low recommendation.
+ message RaiseTargetCpaBidTooLowRecommendation {
+ // Output only. A number greater than 1.0 indicating the factor by which we
+ // recommend the target CPA should be increased.
+ optional double recommended_target_multiplier = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The current average target CPA of the campaign, in micros of
+ // customer local currency.
+ optional int64 average_target_cpa_micros = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The Display Expansion opt-in recommendation.
+ message DisplayExpansionOptInRecommendation {}
+
+ // The Upgrade Local campaign to Performance Max campaign recommendation.
+ message UpgradeLocalCampaignToPerformanceMaxRecommendation {}
+
+ // The forecasting set target ROAS recommendation.
+ message ForecastingSetTargetRoasRecommendation {
+ // Output only. The recommended target ROAS (revenue per unit of spend).
+ // The value is between 0.01 and 1000.0, inclusive.
+ double recommended_target_roas = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The campaign budget.
+ CampaignBudget campaign_budget = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // A campaign budget shared amongst various budget recommendation types.
+ message CampaignBudget {
+ // Output only. Current budget amount.
+ int64 current_amount_micros = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Recommended budget amount.
+ int64 recommended_new_amount_micros = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The date when the new budget would start being used.
+ // This field will be set for the following recommendation types:
+ // FORECASTING_SET_TARGET_ROAS. YYYY-MM-DD format, for example, 2018-04-17.
+ string new_start_date = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Immutable. The resource name of the recommendation.
+ //
+ // `customers/{customer_id}/recommendations/{recommendation_id}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/Recommendation"
+ }
+ ];
+
+ // Output only. The type of recommendation.
+ google.ads.googleads.v13.enums.RecommendationTypeEnum.RecommendationType
+ type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The impact on account performance as a result of applying the
+ // recommendation.
+ RecommendationImpact impact = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The budget targeted by this recommendation. This will be set
+ // only when the recommendation affects a single campaign budget.
+ //
+ // This field will be set for the following recommendation types:
+ // CAMPAIGN_BUDGET, FORECASTING_CAMPAIGN_BUDGET, MARGINAL_ROI_CAMPAIGN_BUDGET,
+ // MOVE_UNUSED_BUDGET
+ optional string campaign_budget = 24 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/CampaignBudget"
+ }
+ ];
+
+ // Output only. The campaign targeted by this recommendation.
+ //
+ // This field will be set for the following recommendation types:
+ // CALL_EXTENSION, CALLOUT_EXTENSION, ENHANCED_CPC_OPT_IN,
+ // USE_BROAD_MATCH_KEYWORD, KEYWORD, KEYWORD_MATCH_TYPE,
+ // UPGRADE_LOCAL_CAMPAIGN_TO_PERFORMANCE_MAX, MAXIMIZE_CLICKS_OPT_IN,
+ // MAXIMIZE_CONVERSIONS_OPT_IN, OPTIMIZE_AD_ROTATION,
+ // RESPONSIVE_SEARCH_AD,
+ // RESPONSIVE_SEARCH_AD_ASSET,
+ // SEARCH_PARTNERS_OPT_IN,
+ // DISPLAY_EXPANSION_OPT_IN, SITELINK_EXTENSION, TARGET_CPA_OPT_IN,
+ // TARGET_ROAS_OPT_IN, TEXT_AD,
+ // UPGRADE_SMART_SHOPPING_CAMPAIGN_TO_PERFORMANCE_MAX ,
+ // RAISE_TARGET_CPA_BID_TOO_LOW, FORECASTING_SET_TARGET_ROAS
+ optional string campaign = 25 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/Campaign"
+ }
+ ];
+
+ // Output only. The ad group targeted by this recommendation. This will be set
+ // only when the recommendation affects a single ad group.
+ //
+ // This field will be set for the following recommendation types:
+ // KEYWORD, OPTIMIZE_AD_ROTATION, RESPONSIVE_SEARCH_AD,
+ // RESPONSIVE_SEARCH_AD_ASSET, TEXT_AD
+ optional string ad_group = 26 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AdGroup"
+ }
+ ];
+
+ // Output only. Whether the recommendation is dismissed or not.
+ optional bool dismissed = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The campaigns targeted by this recommendation.
+ //
+ // This field will be set for the following recommendation types:
+ // CAMPAIGN_BUDGET, FORECASTING_CAMPAIGN_BUDGET,
+ // MARGINAL_ROI_CAMPAIGN_BUDGET and MOVE_UNUSED_BUDGET
+ repeated string campaigns = 38 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/Campaign"
+ }
+ ];
+
+ // The details of recommendation.
+ oneof recommendation {
+ // Output only. The campaign budget recommendation.
+ CampaignBudgetRecommendation campaign_budget_recommendation = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The forecasting campaign budget recommendation.
+ CampaignBudgetRecommendation forecasting_campaign_budget_recommendation = 22
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The keyword recommendation.
+ KeywordRecommendation keyword_recommendation = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Add expanded text ad recommendation.
+ TextAdRecommendation text_ad_recommendation = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The TargetCPA opt-in recommendation.
+ TargetCpaOptInRecommendation target_cpa_opt_in_recommendation = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The MaximizeConversions Opt-In recommendation.
+ MaximizeConversionsOptInRecommendation
+ maximize_conversions_opt_in_recommendation = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The Enhanced Cost-Per-Click Opt-In recommendation.
+ EnhancedCpcOptInRecommendation enhanced_cpc_opt_in_recommendation = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The Search Partners Opt-In recommendation.
+ SearchPartnersOptInRecommendation search_partners_opt_in_recommendation = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The MaximizeClicks Opt-In recommendation.
+ MaximizeClicksOptInRecommendation maximize_clicks_opt_in_recommendation = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The Optimize Ad Rotation recommendation.
+ OptimizeAdRotationRecommendation optimize_ad_rotation_recommendation = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The keyword match type recommendation.
+ KeywordMatchTypeRecommendation keyword_match_type_recommendation = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The move unused budget recommendation.
+ MoveUnusedBudgetRecommendation move_unused_budget_recommendation = 21
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The Target ROAS opt-in recommendation.
+ TargetRoasOptInRecommendation target_roas_opt_in_recommendation = 23
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The add responsive search ad recommendation.
+ ResponsiveSearchAdRecommendation responsive_search_ad_recommendation = 28
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The marginal ROI campaign budget recommendation.
+ CampaignBudgetRecommendation marginal_roi_campaign_budget_recommendation =
+ 29 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The use broad match keyword recommendation.
+ UseBroadMatchKeywordRecommendation use_broad_match_keyword_recommendation =
+ 30 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The responsive search ad asset recommendation.
+ ResponsiveSearchAdAssetRecommendation
+ responsive_search_ad_asset_recommendation = 31
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The upgrade a Smart Shopping campaign to a Performance Max
+ // campaign recommendation.
+ UpgradeSmartShoppingCampaignToPerformanceMaxRecommendation
+ upgrade_smart_shopping_campaign_to_performance_max_recommendation = 32
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The responsive search ad improve ad strength recommendation.
+ ResponsiveSearchAdImproveAdStrengthRecommendation
+ responsive_search_ad_improve_ad_strength_recommendation = 33
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The Display Expansion opt-in recommendation.
+ DisplayExpansionOptInRecommendation
+ display_expansion_opt_in_recommendation = 34
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The upgrade a Local campaign to a Performance Max campaign
+ // recommendation.
+ UpgradeLocalCampaignToPerformanceMaxRecommendation
+ upgrade_local_campaign_to_performance_max_recommendation = 35
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The raise target CPA bid too low recommendation.
+ RaiseTargetCpaBidTooLowRecommendation
+ raise_target_cpa_bid_too_low_recommendation = 36
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The forecasting set target ROAS recommendation.
+ ForecastingSetTargetRoasRecommendation
+ forecasting_set_target_roas_recommendation = 37
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The callout asset recommendation.
+ CalloutAssetRecommendation callout_asset_recommendation = 39
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The sitelink asset recommendation.
+ SitelinkAssetRecommendation sitelink_asset_recommendation = 40
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The call asset recommendation.
+ CallAssetRecommendation call_asset_recommendation = 41
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/remarketing_action.proto b/third_party/googleapis/google/ads/googleads/v13/resources/remarketing_action.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/resources/remarketing_action.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/remarketing_action.proto
index 231e6bf48..2d908b8d2 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/remarketing_action.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/remarketing_action.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/tag_snippet.proto";
+import "google/ads/googleads/v13/common/tag_snippet.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "RemarketingActionProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Remarketing Action resource.
@@ -61,5 +61,6 @@ message RemarketingAction {
optional string name = 6;
// Output only. The snippets used for tracking remarketing actions.
- repeated google.ads.googleads.v10.common.TagSnippet tag_snippets = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.ads.googleads.v13.common.TagSnippet tag_snippets = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/search_term_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/search_term_view.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/resources/search_term_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/search_term_view.proto
index ffc46cd91..7c7e28e84 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/search_term_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/search_term_view.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/search_term_targeting_status.proto";
+import "google/ads/googleads/v13/enums/search_term_targeting_status.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "SearchTermViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the SearchTermView resource.
@@ -63,5 +63,7 @@ message SearchTermView {
// Output only. Indicates whether the search term is currently one of your
// targeted or excluded keywords.
- google.ads.googleads.v10.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SearchTermTargetingStatusEnum
+ .SearchTermTargetingStatus status = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/shared_criterion.proto b/third_party/googleapis/google/ads/googleads/v13/resources/shared_criterion.proto
similarity index 63%
rename from third_party/googleapis/google/ads/googleads/v10/resources/shared_criterion.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/shared_criterion.proto
index 4d70c8e91..51844e531 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/shared_criterion.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/shared_criterion.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/enums/criterion_type.proto";
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/enums/criterion_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "SharedCriterionProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the SharedCriterion resource.
@@ -64,28 +64,35 @@ message SharedCriterion {
optional int64 criterion_id = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The type of the criterion.
- google.ads.googleads.v10.enums.CriterionTypeEnum.CriterionType type = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.CriterionTypeEnum.CriterionType type = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The criterion.
//
// Exactly one must be set.
oneof criterion {
// Immutable. Keyword.
- google.ads.googleads.v10.common.KeywordInfo keyword = 3 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.KeywordInfo keyword = 3
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. YouTube Video.
- google.ads.googleads.v10.common.YouTubeVideoInfo youtube_video = 5 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.YouTubeVideoInfo youtube_video = 5
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. YouTube Channel.
- google.ads.googleads.v10.common.YouTubeChannelInfo youtube_channel = 6 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.YouTubeChannelInfo youtube_channel = 6
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Placement.
- google.ads.googleads.v10.common.PlacementInfo placement = 7 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.PlacementInfo placement = 7
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Mobile App Category.
- google.ads.googleads.v10.common.MobileAppCategoryInfo mobile_app_category = 8 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.MobileAppCategoryInfo mobile_app_category =
+ 8 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Mobile application.
- google.ads.googleads.v10.common.MobileApplicationInfo mobile_application = 9 [(google.api.field_behavior) = IMMUTABLE];
+ google.ads.googleads.v13.common.MobileApplicationInfo mobile_application = 9
+ [(google.api.field_behavior) = IMMUTABLE];
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/shared_set.proto b/third_party/googleapis/google/ads/googleads/v13/resources/shared_set.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/resources/shared_set.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/shared_set.proto
index 70c75ec8c..ceeb94b01 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/shared_set.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/shared_set.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/enums/shared_set_status.proto";
-import "google/ads/googleads/v10/enums/shared_set_type.proto";
+import "google/ads/googleads/v13/enums/shared_set_status.proto";
+import "google/ads/googleads/v13/enums/shared_set_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "SharedSetProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the SharedSet resource.
@@ -54,9 +54,10 @@ message SharedSet {
// Output only. The ID of this shared set. Read only.
optional int64 id = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. The type of this shared set: each shared set holds only a single kind
- // of resource. Required. Immutable.
- google.ads.googleads.v10.enums.SharedSetTypeEnum.SharedSetType type = 3 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. The type of this shared set: each shared set holds only a single
+ // kind of resource. Required. Immutable.
+ google.ads.googleads.v13.enums.SharedSetTypeEnum.SharedSetType type = 3
+ [(google.api.field_behavior) = IMMUTABLE];
// The name of this shared set. Required.
// Shared Sets must have names that are unique among active shared sets of
@@ -66,11 +67,15 @@ message SharedSet {
optional string name = 9;
// Output only. The status of this shared set. Read only.
- google.ads.googleads.v10.enums.SharedSetStatusEnum.SharedSetStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.SharedSetStatusEnum.SharedSetStatus status = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The number of shared criteria within this shared set. Read only.
+ // Output only. The number of shared criteria within this shared set. Read
+ // only.
optional int64 member_count = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The number of campaigns associated with this shared set. Read only.
- optional int64 reference_count = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The number of campaigns associated with this shared set. Read
+ // only.
+ optional int64 reference_count = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/shopping_performance_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/shopping_performance_view.proto
similarity index 84%
rename from third_party/googleapis/google/ads/googleads/v10/resources/shopping_performance_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/shopping_performance_view.proto
index e9a740524..8dd4b8427 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/shopping_performance_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/shopping_performance_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ShoppingPerformanceViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the ShoppingPerformanceView resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/smart_campaign_search_term_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/smart_campaign_search_term_view.proto
similarity index 85%
rename from third_party/googleapis/google/ads/googleads/v10/resources/smart_campaign_search_term_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/smart_campaign_search_term_view.proto
index 84b67a3b5..f44c6dfcf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/smart_campaign_search_term_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/smart_campaign_search_term_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "SmartCampaignSearchTermViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the SmartCampaignSearchTermView resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/smart_campaign_setting.proto b/third_party/googleapis/google/ads/googleads/v13/resources/smart_campaign_setting.proto
similarity index 55%
rename from third_party/googleapis/google/ads/googleads/v10/resources/smart_campaign_setting.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/smart_campaign_setting.proto
index 677b83295..6bee0ff48 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/smart_campaign_setting.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/smart_campaign_setting.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "SmartCampaignSettingProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Smart campaign setting resource.
@@ -46,6 +46,15 @@ message SmartCampaignSetting {
optional string country_code = 2;
}
+ // Settings for configuring a business profile optimized for ads as this
+ // campaign's landing page.
+ message AdOptimizedBusinessProfileSetting {
+ // Enabling a lead form on your business profile enables prospective
+ // customers to contact your business by filling out a simple form,
+ // and you'll receive their information through email.
+ optional bool include_lead_form = 1;
+ }
+
// Immutable. The resource name of the Smart campaign setting.
// Smart campaign setting resource names have the form:
//
@@ -68,23 +77,36 @@ message SmartCampaignSetting {
// Phone number and country code.
PhoneNumber phone_number = 3;
- // Landing page url given by user for this Campaign.
- string final_url = 4;
-
- // The ISO-639-1 language code to advertise in.
+ // The language code to advertise in from the set of
+ // [supported language codes]
+ // (https://developers.google.com/google-ads/api/reference/data/codes-formats#languages).
string advertising_language_code = 7;
+ // The landing page of this campaign.
+ oneof landing_page {
+ // The user-provided landing page URL for this Campaign.
+ string final_url = 8;
+
+ // Settings for configuring a business profile optimized for ads as this
+ // campaign's landing page. This campaign must be linked to a business
+ // profile to use this option. For more information on this feature,
+ // consult https://support.google.com/google-ads/answer/9827068.
+ AdOptimizedBusinessProfileSetting ad_optimized_business_profile_setting = 9;
+ }
+
// The business setting of this campaign.
oneof business_setting {
// The name of the business.
string business_name = 5;
- // The ID of the Business Profile location.
- // The location ID can be fetched by Business Profile API with its form:
- // accounts/{accountId}/locations/{locationId}. The last {locationId}
- // component from the Business Profile API represents the
- // business_location_id. See the [Business Profile API]
- // (https://developers.google.com/my-business/reference/rest/v4/accounts.locations)
- int64 business_location_id = 6;
+ // The resource name of a Business Profile location.
+ // Business Profile location resource names can be fetched through the
+ // Business Profile API and adhere to the following format:
+ // `locations/{locationId}`.
+ //
+ // See the [Business Profile API]
+ // (https://developers.google.com/my-business/reference/businessinformation/rest/v1/accounts.locations)
+ // for additional details.
+ string business_profile_location = 10;
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/third_party_app_analytics_link.proto b/third_party/googleapis/google/ads/googleads/v13/resources/third_party_app_analytics_link.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/resources/third_party_app_analytics_link.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/third_party_app_analytics_link.proto
index fd92680a8..e063f2bc0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/third_party_app_analytics_link.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/third_party_app_analytics_link.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "ThirdPartyAppAnalyticsLinkProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// A data sharing connection, allowing the import of third party app analytics
// into a Google Ads Customer.
@@ -47,8 +47,9 @@ message ThirdPartyAppAnalyticsLink {
}
];
- // Output only. The shareable link ID that should be provided to the third party when
- // setting up app analytics. This is able to be regenerated using regenerate
- // method in the ThirdPartyAppAnalyticsLinkService.
- optional string shareable_link_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The shareable link ID that should be provided to the third
+ // party when setting up app analytics. This is able to be regenerated using
+ // regenerate method in the ThirdPartyAppAnalyticsLinkService.
+ optional string shareable_link_id = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/topic_constant.proto b/third_party/googleapis/google/ads/googleads/v13/resources/topic_constant.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/resources/topic_constant.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/topic_constant.proto
index 052e097ce..c906212d3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/topic_constant.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/topic_constant.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "TopicConstantProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the Topic Constant resource.
@@ -61,10 +61,10 @@ message TopicConstant {
}
];
- // Output only. The category to target or exclude. Each subsequent element in the array
- // describes a more specific sub-category. For example,
+ // Output only. The category to target or exclude. Each subsequent element in
+ // the array describes a more specific sub-category. For example,
// {"Pets & Animals", "Pets", "Dogs"} represents the
// "Pets & Animals/Pets/Dogs" category. List of available topic categories at
- // https://developers.google.com/adwords/api/docs/appendix/verticals
+ // https://developers.google.com/google-ads/api/reference/data/verticals
repeated string path = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/topic_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/topic_view.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/resources/topic_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/topic_view.proto
index aead6be62..d66975b96 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/topic_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/topic_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "TopicViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the topic view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/travel_activity_group_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/travel_activity_group_view.proto
new file mode 100644
index 000000000..99586d66f
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/travel_activity_group_view.proto
@@ -0,0 +1,50 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "TravelActivityGroupViewProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the travel activity group view resource.
+
+// A travel activity group view.
+message TravelActivityGroupView {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/TravelActivityGroupView"
+ pattern: "customers/{customer_id}/travelActivityGroupViews/{ad_group_id}~{criterion_id}"
+ };
+
+ // Output only. The resource name of the travel activity group view.
+ // Travel Activity Group view resource names have the form:
+ //
+ // `customers/{customer_id}/travelActivityGroupViews/{ad_group_id}~{criterion_id}`
+ string resource_name = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/TravelActivityGroupView"
+ }
+ ];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v13/resources/travel_activity_performance_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/travel_activity_performance_view.proto
new file mode 100644
index 000000000..68f49cce6
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/travel_activity_performance_view.proto
@@ -0,0 +1,50 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.resources;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
+option java_multiple_files = true;
+option java_outer_classname = "TravelActivityPerformanceViewProto";
+option java_package = "com.google.ads.googleads.v13.resources";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
+
+// Proto file describing the travel activity performance view resource.
+
+// A travel activity performance view.
+message TravelActivityPerformanceView {
+ option (google.api.resource) = {
+ type: "googleads.googleapis.com/TravelActivityPerformanceView"
+ pattern: "customers/{customer_id}/travelActivityPerformanceViews"
+ };
+
+ // Output only. The resource name of the travel activity performance view.
+ // Travel Activity performance view resource names have the form:
+ //
+ // `customers/{customer_id}/travelActivityPerformanceView`
+ string resource_name = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/TravelActivityPerformanceView"
+ }
+ ];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/user_interest.proto b/third_party/googleapis/google/ads/googleads/v13/resources/user_interest.proto
similarity index 69%
rename from third_party/googleapis/google/ads/googleads/v10/resources/user_interest.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/user_interest.proto
index af352355c..9117d9496 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/user_interest.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/user_interest.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
-import "google/ads/googleads/v10/common/criterion_category_availability.proto";
-import "google/ads/googleads/v10/enums/user_interest_taxonomy_type.proto";
+import "google/ads/googleads/v13/common/criterion_category_availability.proto";
+import "google/ads/googleads/v13/enums/user_interest_taxonomy_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "UserInterestProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the User Interest resource.
@@ -51,10 +51,13 @@ message UserInterest {
];
// Output only. Taxonomy type of the user interest.
- google.ads.googleads.v10.enums.UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType taxonomy_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.UserInterestTaxonomyTypeEnum
+ .UserInterestTaxonomyType taxonomy_type = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The ID of the user interest.
- optional int64 user_interest_id = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 user_interest_id = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The name of the user interest.
optional string name = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -67,9 +70,12 @@ message UserInterest {
}
];
- // Output only. True if the user interest is launched to all channels and locales.
- optional bool launched_to_all = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. True if the user interest is launched to all channels and
+ // locales.
+ optional bool launched_to_all = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Availability information of the user interest.
- repeated google.ads.googleads.v10.common.CriterionCategoryAvailability availabilities = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.ads.googleads.v13.common.CriterionCategoryAvailability
+ availabilities = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/user_list.proto b/third_party/googleapis/google/ads/googleads/v13/resources/user_list.proto
similarity index 58%
rename from third_party/googleapis/google/ads/googleads/v10/resources/user_list.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/user_list.proto
index 4fb4ea0b9..0c8160689 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/user_list.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/user_list.proto
@@ -14,26 +14,26 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
-
-import "google/ads/googleads/v10/common/user_lists.proto";
-import "google/ads/googleads/v10/enums/access_reason.proto";
-import "google/ads/googleads/v10/enums/user_list_access_status.proto";
-import "google/ads/googleads/v10/enums/user_list_closing_reason.proto";
-import "google/ads/googleads/v10/enums/user_list_membership_status.proto";
-import "google/ads/googleads/v10/enums/user_list_size_range.proto";
-import "google/ads/googleads/v10/enums/user_list_type.proto";
+package google.ads.googleads.v13.resources;
+
+import "google/ads/googleads/v13/common/user_lists.proto";
+import "google/ads/googleads/v13/enums/access_reason.proto";
+import "google/ads/googleads/v13/enums/user_list_access_status.proto";
+import "google/ads/googleads/v13/enums/user_list_closing_reason.proto";
+import "google/ads/googleads/v13/enums/user_list_membership_status.proto";
+import "google/ads/googleads/v13/enums/user_list_size_range.proto";
+import "google/ads/googleads/v13/enums/user_list_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "UserListProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the User List resource.
@@ -58,15 +58,15 @@ message UserList {
// Output only. Id of the user list.
optional int64 id = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A flag that indicates if a user may edit a list. Depends on the list
- // ownership and list type. For example, external remarketing user lists are
- // not editable.
+ // Output only. An option that indicates if a user may edit a list. Depends on
+ // the list ownership and list type. For example, external remarketing user
+ // lists are not editable.
//
// This field is read-only.
optional bool read_only = 26 [(google.api.field_behavior) = OUTPUT_ONLY];
// Name of this user list. Depending on its access_reason, the user list name
- // may not be unique (e.g. if access_reason=SHARED)
+ // may not be unique (for example, if access_reason=SHARED)
optional string name = 27;
// Description of this user list.
@@ -75,7 +75,8 @@ message UserList {
// Membership status of this user list. Indicates whether a user list is open
// or active. Only open user lists can accumulate more users and can be
// targeted to.
- google.ads.googleads.v10.enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6;
+ google.ads.googleads.v13.enums.UserListMembershipStatusEnum
+ .UserListMembershipStatus membership_status = 6;
// An ID from external system. It is used by user list sellers to correlate
// IDs on their systems.
@@ -89,85 +90,101 @@ message UserList {
// It'll be ignored for logical_user_list.
optional int64 membership_life_span = 30;
- // Output only. Estimated number of users in this user list, on the Google Display Network.
- // This value is null if the number of users has not yet been determined.
+ // Output only. Estimated number of users in this user list, on the Google
+ // Display Network. This value is null if the number of users has not yet been
+ // determined.
//
// This field is read-only.
- optional int64 size_for_display = 31 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 size_for_display = 31
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Size range in terms of number of users of the UserList, on the Google
- // Display Network.
+ // Output only. Size range in terms of number of users of the UserList, on the
+ // Google Display Network.
//
// This field is read-only.
- google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.UserListSizeRangeEnum.UserListSizeRange
+ size_range_for_display = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Estimated number of users in this user list in the google.com domain.
- // These are the users available for targeting in Search campaigns.
+ // Output only. Estimated number of users in this user list in the google.com
+ // domain. These are the users available for targeting in Search campaigns.
// This value is null if the number of users has not yet been determined.
//
// This field is read-only.
- optional int64 size_for_search = 32 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 size_for_search = 32
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Size range in terms of number of users of the UserList, for Search ads.
+ // Output only. Size range in terms of number of users of the UserList, for
+ // Search ads.
//
// This field is read-only.
- google.ads.googleads.v10.enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.UserListSizeRangeEnum.UserListSizeRange
+ size_range_for_search = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Type of this list.
//
// This field is read-only.
- google.ads.googleads.v10.enums.UserListTypeEnum.UserListType type = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.UserListTypeEnum.UserListType type = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Indicating the reason why this user list membership status is closed. It is
// only populated on lists that were automatically closed due to inactivity,
// and will be cleared once the list membership status becomes open.
- google.ads.googleads.v10.enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14;
+ google.ads.googleads.v13.enums.UserListClosingReasonEnum.UserListClosingReason
+ closing_reason = 14;
- // Output only. Indicates the reason this account has been granted access to the list.
- // The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED.
+ // Output only. Indicates the reason this account has been granted access to
+ // the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED.
//
// This field is read-only.
- google.ads.googleads.v10.enums.AccessReasonEnum.AccessReason access_reason = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.enums.AccessReasonEnum.AccessReason access_reason =
+ 15 [(google.api.field_behavior) = OUTPUT_ONLY];
// Indicates if this share is still enabled. When a UserList is shared with
// the user this field is set to ENABLED. Later the userList owner can decide
// to revoke the share and make it DISABLED.
// The default value of this field is set to ENABLED.
- google.ads.googleads.v10.enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16;
+ google.ads.googleads.v13.enums.UserListAccessStatusEnum.UserListAccessStatus
+ account_user_list_status = 16;
// Indicates if this user list is eligible for Google Search Network.
optional bool eligible_for_search = 33;
- // Output only. Indicates this user list is eligible for Google Display Network.
+ // Output only. Indicates this user list is eligible for Google Display
+ // Network.
//
// This field is read-only.
- optional bool eligible_for_display = 34 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional bool eligible_for_display = 34
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Indicates match rate for Customer Match lists. The range of this field is
- // [0-100]. This will be null for other list types or when it's not possible
- // to calculate the match rate.
+ // Output only. Indicates match rate for Customer Match lists. The range of
+ // this field is [0-100]. This will be null for other list types or when it's
+ // not possible to calculate the match rate.
//
// This field is read-only.
- optional int32 match_rate_percentage = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int32 match_rate_percentage = 24
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The user list.
//
// Exactly one must be set.
oneof user_list {
// User list of CRM users provided by the advertiser.
- google.ads.googleads.v10.common.CrmBasedUserListInfo crm_based_user_list = 19;
+ google.ads.googleads.v13.common.CrmBasedUserListInfo crm_based_user_list =
+ 19;
// Output only. User list which are similar to users from another UserList.
// These lists are readonly and automatically created by google.
- google.ads.googleads.v10.common.SimilarUserListInfo similar_user_list = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.ads.googleads.v13.common.SimilarUserListInfo similar_user_list = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// User list generated by a rule.
- google.ads.googleads.v10.common.RuleBasedUserListInfo rule_based_user_list = 21;
+ google.ads.googleads.v13.common.RuleBasedUserListInfo rule_based_user_list =
+ 21;
// User list that is a custom combination of user lists and user interests.
- google.ads.googleads.v10.common.LogicalUserListInfo logical_user_list = 22;
+ google.ads.googleads.v13.common.LogicalUserListInfo logical_user_list = 22;
// User list targeting as a collection of conversion or remarketing actions.
- google.ads.googleads.v10.common.BasicUserListInfo basic_user_list = 23;
+ google.ads.googleads.v13.common.BasicUserListInfo basic_user_list = 23;
}
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/user_location_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/user_location_view.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/resources/user_location_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/user_location_view.proto
index 9ca210fb9..5973cc04a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/user_location_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/user_location_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "UserLocationViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the user location view resource.
@@ -54,8 +54,10 @@ message UserLocationView {
];
// Output only. Criterion Id for the country.
- optional int64 country_criterion_id = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 country_criterion_id = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Indicates whether location was targeted or not.
- optional bool targeting_location = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional bool targeting_location = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/video.proto b/third_party/googleapis/google/ads/googleads/v13/resources/video.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/resources/video.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/video.proto
index 64a7d0bb8..588cf13af 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/video.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/video.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "VideoProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the video resource.
@@ -43,9 +43,7 @@ message Video {
// `customers/{customer_id}/videos/{video_id}`
string resource_name = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Video"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Video" }
];
// Output only. The ID of the video.
@@ -55,7 +53,8 @@ message Video {
optional string channel_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The duration of the video in milliseconds.
- optional int64 duration_millis = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ optional int64 duration_millis = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The title of the video.
optional string title = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
diff --git a/third_party/googleapis/google/ads/googleads/v10/resources/webpage_view.proto b/third_party/googleapis/google/ads/googleads/v13/resources/webpage_view.proto
similarity index 81%
rename from third_party/googleapis/google/ads/googleads/v10/resources/webpage_view.proto
rename to third_party/googleapis/google/ads/googleads/v13/resources/webpage_view.proto
index 9c7b73664..89b0036e7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/resources/webpage_view.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/resources/webpage_view.proto
@@ -14,19 +14,19 @@
syntax = "proto3";
-package google.ads.googleads.v10.resources;
+package google.ads.googleads.v13.resources;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Resources";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "WebpageViewProto";
-option java_package = "com.google.ads.googleads.v10.resources";
+option java_package = "com.google.ads.googleads.v13.resources";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
-option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Resources";
+option ruby_package = "Google::Ads::GoogleAds::V13::Resources";
// Proto file describing the webpage view resource.
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/BUILD.bazel b/third_party/googleapis/google/ads/googleads/v13/services/BUILD.bazel
similarity index 94%
rename from third_party/googleapis/google/ads/googleads/v10/services/BUILD.bazel
rename to third_party/googleapis/google/ads/googleads/v13/services/BUILD.bazel
index e66fe59ab..1555f6f8c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/BUILD.bazel
+++ b/third_party/googleapis/google/ads/googleads/v13/services/BUILD.bazel
@@ -27,10 +27,10 @@ proto_library(
name = "services_proto",
srcs = glob(["*.proto"]),
deps = [
- "//google/ads/googleads/v10/common:common_proto",
- "//google/ads/googleads/v10/enums:enums_proto",
- "//google/ads/googleads/v10/errors:errors_proto",
- "//google/ads/googleads/v10/resources:resources_proto",
+ "//google/ads/googleads/v13/common:common_proto",
+ "//google/ads/googleads/v13/enums:enums_proto",
+ "//google/ads/googleads/v13/errors:errors_proto",
+ "//google/ads/googleads/v13/resources:resources_proto",
"//google/api:annotations_proto",
"//google/api:client_proto",
"//google/api:field_behavior_proto",
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/account_budget_proposal_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/account_budget_proposal_service.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/services/account_budget_proposal_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/account_budget_proposal_service.proto
index fd47d7676..682c283b0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/account_budget_proposal_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/account_budget_proposal_service.proto
@@ -14,27 +14,27 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/account_budget_proposal.proto";
+import "google/ads/googleads/v13/resources/account_budget_proposal.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AccountBudgetProposalServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AccountBudgetProposal service.
-// A service for managing account-level budgets via proposals.
+// A service for managing account-level budgets through proposals.
//
// A proposal is a request to create a new budget or make changes to an
// existing one.
@@ -64,9 +64,10 @@ service AccountBudgetProposalService {
// [QuotaError]()
// [RequestError]()
// [StringLengthError]()
- rpc MutateAccountBudgetProposal(MutateAccountBudgetProposalRequest) returns (MutateAccountBudgetProposalResponse) {
+ rpc MutateAccountBudgetProposal(MutateAccountBudgetProposalRequest)
+ returns (MutateAccountBudgetProposalResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/accountBudgetProposals:mutate"
+ post: "/v13/customers/{customer_id=*}/accountBudgetProposals:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operation";
@@ -74,13 +75,15 @@ service AccountBudgetProposalService {
}
// Request message for
-// [AccountBudgetProposalService.MutateAccountBudgetProposal][google.ads.googleads.v10.services.AccountBudgetProposalService.MutateAccountBudgetProposal].
+// [AccountBudgetProposalService.MutateAccountBudgetProposal][google.ads.googleads.v13.services.AccountBudgetProposalService.MutateAccountBudgetProposal].
message MutateAccountBudgetProposalRequest {
// Required. The ID of the customer.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The operation to perform on an individual account-level budget proposal.
- AccountBudgetProposalOperation operation = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The operation to perform on an individual account-level budget
+ // proposal.
+ AccountBudgetProposalOperation operation = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -104,7 +107,7 @@ message AccountBudgetProposalOperation {
// existing budget, end an actively running budget, or remove an approved
// budget scheduled to start in the future.
// No resource name is expected for the new proposal.
- google.ads.googleads.v10.resources.AccountBudgetProposal create = 2;
+ google.ads.googleads.v13.resources.AccountBudgetProposal create = 2;
// Remove operation: A resource name for the removed proposal is expected,
// in this format:
@@ -112,8 +115,8 @@ message AccountBudgetProposalOperation {
// `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}`
// A request may be cancelled iff it is pending.
string remove = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AccountBudgetProposal"
- }];
+ type: "googleads.googleapis.com/AccountBudgetProposal"
+ }];
}
}
@@ -127,6 +130,6 @@ message MutateAccountBudgetProposalResponse {
message MutateAccountBudgetProposalResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AccountBudgetProposal"
- }];
+ type: "googleads.googleapis.com/AccountBudgetProposal"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/account_link_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/account_link_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/account_link_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/account_link_service.proto
index 4ec6c56db..24d065c59 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/account_link_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/account_link_service.proto
@@ -14,9 +14,9 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/account_link.proto";
+import "google/ads/googleads/v13/resources/account_link.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -24,14 +24,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AccountLinkServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// This service allows management of links between Google Ads accounts and other
// accounts.
@@ -52,9 +52,10 @@ service AccountLinkService {
// [QuotaError]()
// [RequestError]()
// [ThirdPartyAppAnalyticsLinkError]()
- rpc CreateAccountLink(CreateAccountLinkRequest) returns (CreateAccountLinkResponse) {
+ rpc CreateAccountLink(CreateAccountLinkRequest)
+ returns (CreateAccountLinkResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/accountLinks:create"
+ post: "/v13/customers/{customer_id=*}/accountLinks:create"
body: "*"
};
option (google.api.method_signature) = "customer_id,account_link";
@@ -62,7 +63,7 @@ service AccountLinkService {
// Creates or removes an account link.
// From V5, create is not supported through
- // AccountLinkService.MutateAccountLink. Please use
+ // AccountLinkService.MutateAccountLink. Use
// AccountLinkService.CreateAccountLink instead.
//
// List of thrown errors:
@@ -75,9 +76,10 @@ service AccountLinkService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateAccountLink(MutateAccountLinkRequest) returns (MutateAccountLinkResponse) {
+ rpc MutateAccountLink(MutateAccountLinkRequest)
+ returns (MutateAccountLinkResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/accountLinks:mutate"
+ post: "/v13/customers/{customer_id=*}/accountLinks:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operation";
@@ -85,25 +87,27 @@ service AccountLinkService {
}
// Request message for
-// [AccountLinkService.CreateAccountLink][google.ads.googleads.v10.services.AccountLinkService.CreateAccountLink].
+// [AccountLinkService.CreateAccountLink][google.ads.googleads.v13.services.AccountLinkService.CreateAccountLink].
message CreateAccountLinkRequest {
// Required. The ID of the customer for which the account link is created.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The account link to be created.
- google.ads.googleads.v10.resources.AccountLink account_link = 2 [(google.api.field_behavior) = REQUIRED];
+ google.ads.googleads.v13.resources.AccountLink account_link = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Response message for
-// [AccountLinkService.CreateAccountLink][google.ads.googleads.v10.services.AccountLinkService.CreateAccountLink].
+// [AccountLinkService.CreateAccountLink][google.ads.googleads.v13.services.AccountLinkService.CreateAccountLink].
message CreateAccountLinkResponse {
// Returned for successful operations. Resource name of the account link.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AccountLink"
- }];
+ type: "googleads.googleapis.com/AccountLink"
+ }];
}
-// Request message for [AccountLinkService.MutateAccountLink][google.ads.googleads.v10.services.AccountLinkService.MutateAccountLink].
+// Request message for
+// [AccountLinkService.MutateAccountLink][google.ads.googleads.v13.services.AccountLinkService.MutateAccountLink].
message MutateAccountLinkRequest {
// Required. The ID of the customer being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
@@ -131,15 +135,15 @@ message AccountLinkOperation {
oneof operation {
// Update operation: The account link is expected to have
// a valid resource name.
- google.ads.googleads.v10.resources.AccountLink update = 2;
+ google.ads.googleads.v13.resources.AccountLink update = 2;
// Remove operation: A resource name for the account link to remove is
// expected, in this format:
//
// `customers/{customer_id}/accountLinks/{account_link_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AccountLink"
- }];
+ type: "googleads.googleapis.com/AccountLink"
+ }];
}
}
@@ -150,8 +154,8 @@ message MutateAccountLinkResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -159,6 +163,6 @@ message MutateAccountLinkResponse {
message MutateAccountLinkResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AccountLink"
- }];
+ type: "googleads.googleapis.com/AccountLink"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_ad_label_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_ad_label_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_ad_label_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_ad_label_service.proto
index a2f62385e..f1e8b1d2c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_ad_label_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_ad_label_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/ad_group_ad_label.proto";
+import "google/ads/googleads/v13/resources/ad_group_ad_label.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdLabelServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Ad Group Ad Label service.
@@ -53,22 +53,25 @@ service AdGroupAdLabelService {
// [NewResourceCreationError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateAdGroupAdLabels(MutateAdGroupAdLabelsRequest) returns (MutateAdGroupAdLabelsResponse) {
+ rpc MutateAdGroupAdLabels(MutateAdGroupAdLabelsRequest)
+ returns (MutateAdGroupAdLabelsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adGroupAdLabels:mutate"
+ post: "/v13/customers/{customer_id=*}/adGroupAdLabels:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AdGroupAdLabelService.MutateAdGroupAdLabels][google.ads.googleads.v10.services.AdGroupAdLabelService.MutateAdGroupAdLabels].
+// Request message for
+// [AdGroupAdLabelService.MutateAdGroupAdLabels][google.ads.googleads.v13.services.AdGroupAdLabelService.MutateAdGroupAdLabels].
message MutateAdGroupAdLabelsRequest {
// Required. ID of the customer whose ad group ad labels are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on ad group ad labels.
- repeated AdGroupAdLabelOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AdGroupAdLabelOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -87,15 +90,15 @@ message AdGroupAdLabelOperation {
oneof operation {
// Create operation: No resource name is expected for the new ad group ad
// label.
- google.ads.googleads.v10.resources.AdGroupAdLabel create = 1;
+ google.ads.googleads.v13.resources.AdGroupAdLabel create = 1;
// Remove operation: A resource name for the ad group ad label
// being removed, in this format:
//
- // `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}_{label_id}`
+ // `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupAdLabel"
- }];
+ type: "googleads.googleapis.com/AdGroupAdLabel"
+ }];
}
}
@@ -103,8 +106,8 @@ message AdGroupAdLabelOperation {
message MutateAdGroupAdLabelsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -115,6 +118,6 @@ message MutateAdGroupAdLabelsResponse {
message MutateAdGroupAdLabelResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupAdLabel"
- }];
+ type: "googleads.googleapis.com/AdGroupAdLabel"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_ad_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_ad_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_ad_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_ad_service.proto
index 4d0cb7b99..b2dd4e6f5 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_ad_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_ad_service.proto
@@ -14,11 +14,11 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/common/policy.proto";
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/ad_group_ad.proto";
+import "google/ads/googleads/v13/common/policy.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad_group_ad.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -26,14 +26,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Ad Group Ad service.
@@ -88,22 +88,25 @@ service AdGroupAdService {
// [StringFormatError]()
// [StringLengthError]()
// [UrlFieldError]()
- rpc MutateAdGroupAds(MutateAdGroupAdsRequest) returns (MutateAdGroupAdsResponse) {
+ rpc MutateAdGroupAds(MutateAdGroupAdsRequest)
+ returns (MutateAdGroupAdsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adGroupAds:mutate"
+ post: "/v13/customers/{customer_id=*}/adGroupAds:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AdGroupAdService.MutateAdGroupAds][google.ads.googleads.v10.services.AdGroupAdService.MutateAdGroupAds].
+// Request message for
+// [AdGroupAdService.MutateAdGroupAds][google.ads.googleads.v13.services.AdGroupAdService.MutateAdGroupAds].
message MutateAdGroupAdsRequest {
// Required. The ID of the customer whose ads are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual ads.
- repeated AdGroupAdOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AdGroupAdOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -117,7 +120,8 @@ message MutateAdGroupAdsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on an ad group ad.
@@ -126,23 +130,24 @@ message AdGroupAdOperation {
google.protobuf.FieldMask update_mask = 4;
// Configuration for how policies are validated.
- google.ads.googleads.v10.common.PolicyValidationParameter policy_validation_parameter = 5;
+ google.ads.googleads.v13.common.PolicyValidationParameter
+ policy_validation_parameter = 5;
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new ad.
- google.ads.googleads.v10.resources.AdGroupAd create = 1;
+ google.ads.googleads.v13.resources.AdGroupAd create = 1;
// Update operation: The ad is expected to have a valid resource name.
- google.ads.googleads.v10.resources.AdGroupAd update = 2;
+ google.ads.googleads.v13.resources.AdGroupAd update = 2;
// Remove operation: A resource name for the removed ad is expected,
// in this format:
//
// `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupAd"
- }];
+ type: "googleads.googleapis.com/AdGroupAd"
+ }];
}
}
@@ -150,8 +155,8 @@ message AdGroupAdOperation {
message MutateAdGroupAdsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -162,11 +167,11 @@ message MutateAdGroupAdsResponse {
message MutateAdGroupAdResult {
// The resource name returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupAd"
- }];
+ type: "googleads.googleapis.com/AdGroupAd"
+ }];
// The mutated ad group ad with only mutable fields after mutate. The field
// will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AdGroupAd ad_group_ad = 2;
+ google.ads.googleads.v13.resources.AdGroupAd ad_group_ad = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_asset_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_asset_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_asset_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_asset_service.proto
index eb484ab1d..596995f42 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_asset_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_asset_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/ad_group_asset.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad_group_asset.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAssetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AdGroupAsset service.
@@ -56,22 +56,25 @@ service AdGroupAssetService {
// [NotAllowlistedError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateAdGroupAssets(MutateAdGroupAssetsRequest) returns (MutateAdGroupAssetsResponse) {
+ rpc MutateAdGroupAssets(MutateAdGroupAssetsRequest)
+ returns (MutateAdGroupAssetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adGroupAssets:mutate"
+ post: "/v13/customers/{customer_id=*}/adGroupAssets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AdGroupAssetService.MutateAdGroupAssets][google.ads.googleads.v10.services.AdGroupAssetService.MutateAdGroupAssets].
+// Request message for
+// [AdGroupAssetService.MutateAdGroupAssets][google.ads.googleads.v13.services.AdGroupAssetService.MutateAdGroupAssets].
message MutateAdGroupAssetsRequest {
// Required. The ID of the customer whose ad group assets are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual ad group assets.
- repeated AdGroupAssetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AdGroupAssetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -85,7 +88,8 @@ message MutateAdGroupAssetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on an ad group asset.
@@ -97,19 +101,19 @@ message AdGroupAssetOperation {
oneof operation {
// Create operation: No resource name is expected for the new ad group
// asset.
- google.ads.googleads.v10.resources.AdGroupAsset create = 1;
+ google.ads.googleads.v13.resources.AdGroupAsset create = 1;
// Update operation: The ad group asset is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.AdGroupAsset update = 3;
+ google.ads.googleads.v13.resources.AdGroupAsset update = 3;
// Remove operation: A resource name for the removed ad group asset is
// expected, in this format:
//
// `customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupAsset"
- }];
+ type: "googleads.googleapis.com/AdGroupAsset"
+ }];
}
}
@@ -117,8 +121,8 @@ message AdGroupAssetOperation {
message MutateAdGroupAssetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 1;
// All results for the mutate.
@@ -129,11 +133,11 @@ message MutateAdGroupAssetsResponse {
message MutateAdGroupAssetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupAsset"
- }];
+ type: "googleads.googleapis.com/AdGroupAsset"
+ }];
// The mutated ad group asset with only mutable fields after
// mutate. The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AdGroupAsset ad_group_asset = 2;
+ google.ads.googleads.v13.resources.AdGroupAsset ad_group_asset = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/services/ad_group_asset_set_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_asset_set_service.proto
new file mode 100644
index 000000000..0ae2b5133
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_asset_set_service.proto
@@ -0,0 +1,123 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.services;
+
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad_group_asset_set.proto";
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/rpc/status.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
+option java_multiple_files = true;
+option java_outer_classname = "AdGroupAssetSetServiceProto";
+option java_package = "com.google.ads.googleads.v13.services";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
+
+// Proto file describing the AdGroupAssetSet service.
+
+// Service to manage ad group asset set
+service AdGroupAssetSetService {
+ option (google.api.default_host) = "googleads.googleapis.com";
+ option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";
+
+ // Creates, or removes ad group asset sets. Operation statuses are
+ // returned.
+ rpc MutateAdGroupAssetSets(MutateAdGroupAssetSetsRequest)
+ returns (MutateAdGroupAssetSetsResponse) {
+ option (google.api.http) = {
+ post: "/v13/customers/{customer_id=*}/adGroupAssetSets:mutate"
+ body: "*"
+ };
+ option (google.api.method_signature) = "customer_id,operations";
+ }
+}
+
+// Request message for
+// [AdGroupAssetSetService.MutateAdGroupAssetSets][google.ads.googleads.v13.services.AdGroupAssetSetService.MutateAdGroupAssetSets].
+message MutateAdGroupAssetSetsRequest {
+ // Required. The ID of the customer whose ad group asset sets are being
+ // modified.
+ string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The list of operations to perform on individual ad group asset
+ // sets.
+ repeated AdGroupAssetSetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
+
+ // If true, successful operations will be carried out and invalid
+ // operations will return errors. If false, all operations will be carried
+ // out in one transaction if and only if they are all valid.
+ // Default is false.
+ bool partial_failure = 3;
+
+ // If true, the request is validated but not executed. Only errors are
+ // returned, not results.
+ bool validate_only = 4;
+
+ // The response content type setting. Determines whether the mutable resource
+ // or just the resource name should be returned post mutation.
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
+}
+
+// A single operation (create, remove) on an ad group asset set.
+message AdGroupAssetSetOperation {
+ // The mutate operation.
+ oneof operation {
+ // Create operation: No resource name is expected for the new ad group asset
+ // set.
+ google.ads.googleads.v13.resources.AdGroupAssetSet create = 1;
+
+ // Remove operation: A resource name for the removed ad group asset set is
+ // expected, in this format:
+ // `customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}`
+ string remove = 2 [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AdGroupAssetSet"
+ }];
+ }
+}
+
+// Response message for an ad group asset set mutate.
+message MutateAdGroupAssetSetsResponse {
+ // All results for the mutate.
+ repeated MutateAdGroupAssetSetResult results = 1;
+
+ // Errors that pertain to operation failures in the partial failure mode.
+ // Returned only when partial_failure = true and all errors occur inside the
+ // operations. If any errors occur outside the operations (e.g. auth errors),
+ // we return an RPC level error.
+ google.rpc.Status partial_failure_error = 2;
+}
+
+// The result for the ad group asset set mutate.
+message MutateAdGroupAssetSetResult {
+ // Returned for successful operations.
+ string resource_name = 1 [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/AdGroupAssetSet"
+ }];
+
+ // The mutated ad group asset set with only mutable fields after mutate. The
+ // field will only be returned when response_content_type is set to
+ // "MUTABLE_RESOURCE".
+ google.ads.googleads.v13.resources.AdGroupAssetSet ad_group_asset_set = 2;
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_bid_modifier_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_bid_modifier_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_bid_modifier_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_bid_modifier_service.proto
index 0df5cea6c..a6d2283ef 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_bid_modifier_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_bid_modifier_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/ad_group_bid_modifier.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad_group_bid_modifier.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupBidModifierServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Ad Group Bid Modifier service.
@@ -68,22 +68,27 @@ service AdGroupBidModifierService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateAdGroupBidModifiers(MutateAdGroupBidModifiersRequest) returns (MutateAdGroupBidModifiersResponse) {
+ rpc MutateAdGroupBidModifiers(MutateAdGroupBidModifiersRequest)
+ returns (MutateAdGroupBidModifiersResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adGroupBidModifiers:mutate"
+ post: "/v13/customers/{customer_id=*}/adGroupBidModifiers:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AdGroupBidModifierService.MutateAdGroupBidModifiers][google.ads.googleads.v10.services.AdGroupBidModifierService.MutateAdGroupBidModifiers].
+// Request message for
+// [AdGroupBidModifierService.MutateAdGroupBidModifiers][google.ads.googleads.v13.services.AdGroupBidModifierService.MutateAdGroupBidModifiers].
message MutateAdGroupBidModifiersRequest {
- // Required. ID of the customer whose ad group bid modifiers are being modified.
+ // Required. ID of the customer whose ad group bid modifiers are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual ad group bid modifiers.
- repeated AdGroupBidModifierOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual ad group bid
+ // modifiers.
+ repeated AdGroupBidModifierOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -97,7 +102,8 @@ message MutateAdGroupBidModifiersRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove, update) on an ad group bid modifier.
@@ -109,19 +115,19 @@ message AdGroupBidModifierOperation {
oneof operation {
// Create operation: No resource name is expected for the new ad group bid
// modifier.
- google.ads.googleads.v10.resources.AdGroupBidModifier create = 1;
+ google.ads.googleads.v13.resources.AdGroupBidModifier create = 1;
// Update operation: The ad group bid modifier is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.AdGroupBidModifier update = 2;
+ google.ads.googleads.v13.resources.AdGroupBidModifier update = 2;
// Remove operation: A resource name for the removed ad group bid modifier
// is expected, in this format:
//
// `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupBidModifier"
- }];
+ type: "googleads.googleapis.com/AdGroupBidModifier"
+ }];
}
}
@@ -129,8 +135,8 @@ message AdGroupBidModifierOperation {
message MutateAdGroupBidModifiersResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -141,11 +147,12 @@ message MutateAdGroupBidModifiersResponse {
message MutateAdGroupBidModifierResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupBidModifier"
- }];
+ type: "googleads.googleapis.com/AdGroupBidModifier"
+ }];
// The mutated ad group bid modifier with only mutable fields after mutate.
// The field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AdGroupBidModifier ad_group_bid_modifier = 2;
+ google.ads.googleads.v13.resources.AdGroupBidModifier ad_group_bid_modifier =
+ 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_criterion_customizer_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_criterion_customizer_service.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_criterion_customizer_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_criterion_customizer_service.proto
index c0d5f62ee..dee236874 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_criterion_customizer_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_criterion_customizer_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/ad_group_criterion_customizer.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad_group_criterion_customizer.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionCustomizerServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AdGroupCriterionCustomizer service.
@@ -42,9 +42,11 @@ service AdGroupCriterionCustomizerService {
// Creates, updates or removes ad group criterion customizers. Operation
// statuses are returned.
- rpc MutateAdGroupCriterionCustomizers(MutateAdGroupCriterionCustomizersRequest) returns (MutateAdGroupCriterionCustomizersResponse) {
+ rpc MutateAdGroupCriterionCustomizers(
+ MutateAdGroupCriterionCustomizersRequest)
+ returns (MutateAdGroupCriterionCustomizersResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate"
+ post: "/v13/customers/{customer_id=*}/AdGroupCriterionCustomizers:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -52,15 +54,16 @@ service AdGroupCriterionCustomizerService {
}
// Request message for
-// [AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers][google.ads.googleads.v10.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers].
+// [AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers][google.ads.googleads.v13.services.AdGroupCriterionCustomizerService.MutateAdGroupCriterionCustomizers].
message MutateAdGroupCriterionCustomizersRequest {
- // Required. The ID of the customer whose ad group criterion customizers are being
- // modified.
+ // Required. The ID of the customer whose ad group criterion customizers are
+ // being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual ad group criterion
- // customizers.
- repeated AdGroupCriterionCustomizerOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual ad group
+ // criterion customizers.
+ repeated AdGroupCriterionCustomizerOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -74,24 +77,25 @@ message MutateAdGroupCriterionCustomizersRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
-// A single operation (create, remove) on an customizer attribute.
+// A single operation (create, remove) on a customizer attribute.
message AdGroupCriterionCustomizerOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new ad group
// criterion customizer.
- google.ads.googleads.v10.resources.AdGroupCriterionCustomizer create = 1;
+ google.ads.googleads.v13.resources.AdGroupCriterionCustomizer create = 1;
// Remove operation: A resource name for the removed ad group criterion
// customizer is expected, in this format:
//
// `customers/{customer_id}/adGroupCriterionCustomizers/{ad_group_id}~{criterion_id}~{customizer_attribute_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupCriterionCustomizer"
- }];
+ type: "googleads.googleapis.com/AdGroupCriterionCustomizer"
+ }];
}
}
@@ -102,8 +106,8 @@ message MutateAdGroupCriterionCustomizersResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -111,11 +115,12 @@ message MutateAdGroupCriterionCustomizersResponse {
message MutateAdGroupCriterionCustomizerResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupCriterionCustomizer"
- }];
+ type: "googleads.googleapis.com/AdGroupCriterionCustomizer"
+ }];
// The mutated AdGroupCriterionCustomizer with only mutable fields after
// mutate. The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AdGroupCriterionCustomizer ad_group_criterion_customizer = 2;
+ google.ads.googleads.v13.resources.AdGroupCriterionCustomizer
+ ad_group_criterion_customizer = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_criterion_label_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_criterion_label_service.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_criterion_label_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_criterion_label_service.proto
index 92096d618..215279922 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_criterion_label_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_criterion_label_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/ad_group_criterion_label.proto";
+import "google/ads/googleads/v13/resources/ad_group_criterion_label.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionLabelServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Ad Group Criterion Label service.
@@ -51,9 +51,10 @@ service AdGroupCriterionLabelService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateAdGroupCriterionLabels(MutateAdGroupCriterionLabelsRequest) returns (MutateAdGroupCriterionLabelsResponse) {
+ rpc MutateAdGroupCriterionLabels(MutateAdGroupCriterionLabelsRequest)
+ returns (MutateAdGroupCriterionLabelsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adGroupCriterionLabels:mutate"
+ post: "/v13/customers/{customer_id=*}/adGroupCriterionLabels:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -61,13 +62,15 @@ service AdGroupCriterionLabelService {
}
// Request message for
-// [AdGroupCriterionLabelService.MutateAdGroupCriterionLabels][google.ads.googleads.v10.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels].
+// [AdGroupCriterionLabelService.MutateAdGroupCriterionLabels][google.ads.googleads.v13.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels].
message MutateAdGroupCriterionLabelsRequest {
- // Required. ID of the customer whose ad group criterion labels are being modified.
+ // Required. ID of the customer whose ad group criterion labels are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on ad group criterion labels.
- repeated AdGroupCriterionLabelOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AdGroupCriterionLabelOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -86,15 +89,15 @@ message AdGroupCriterionLabelOperation {
oneof operation {
// Create operation: No resource name is expected for the new ad group
// label.
- google.ads.googleads.v10.resources.AdGroupCriterionLabel create = 1;
+ google.ads.googleads.v13.resources.AdGroupCriterionLabel create = 1;
// Remove operation: A resource name for the ad group criterion label
// being removed, in this format:
//
// `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupCriterionLabel"
- }];
+ type: "googleads.googleapis.com/AdGroupCriterionLabel"
+ }];
}
}
@@ -102,8 +105,8 @@ message AdGroupCriterionLabelOperation {
message MutateAdGroupCriterionLabelsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -114,6 +117,6 @@ message MutateAdGroupCriterionLabelsResponse {
message MutateAdGroupCriterionLabelResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupCriterionLabel"
- }];
+ type: "googleads.googleapis.com/AdGroupCriterionLabel"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_criterion_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_criterion_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_criterion_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_criterion_service.proto
index 1666fe0cb..938763c05 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_criterion_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_criterion_service.proto
@@ -14,11 +14,11 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/common/policy.proto";
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/ad_group_criterion.proto";
+import "google/ads/googleads/v13/common/policy.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad_group_criterion.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -26,14 +26,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCriterionServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Ad Group Criterion service.
@@ -78,22 +78,25 @@ service AdGroupCriterionService {
// [StringFormatError]()
// [StringLengthError]()
// [UrlFieldError]()
- rpc MutateAdGroupCriteria(MutateAdGroupCriteriaRequest) returns (MutateAdGroupCriteriaResponse) {
+ rpc MutateAdGroupCriteria(MutateAdGroupCriteriaRequest)
+ returns (MutateAdGroupCriteriaResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adGroupCriteria:mutate"
+ post: "/v13/customers/{customer_id=*}/adGroupCriteria:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AdGroupCriterionService.MutateAdGroupCriteria][google.ads.googleads.v10.services.AdGroupCriterionService.MutateAdGroupCriteria].
+// Request message for
+// [AdGroupCriterionService.MutateAdGroupCriteria][google.ads.googleads.v13.services.AdGroupCriterionService.MutateAdGroupCriteria].
message MutateAdGroupCriteriaRequest {
// Required. ID of the customer whose criteria are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual criteria.
- repeated AdGroupCriterionOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AdGroupCriterionOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -107,7 +110,8 @@ message MutateAdGroupCriteriaRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove, update) on an ad group criterion.
@@ -117,31 +121,32 @@ message AdGroupCriterionOperation {
// The list of policy violation keys that should not cause a
// PolicyViolationError to be reported. Not all policy violations are
- // exemptable, please refer to the is_exemptible field in the returned
+ // exemptable, refer to the is_exemptible field in the returned
// PolicyViolationError.
//
// Resources violating these polices will be saved, but will not be eligible
// to serve. They may begin serving at a later time due to a change in
// policies, re-review of the resource, or a change in advertiser
// certificates.
- repeated google.ads.googleads.v10.common.PolicyViolationKey exempt_policy_violation_keys = 5;
+ repeated google.ads.googleads.v13.common.PolicyViolationKey
+ exempt_policy_violation_keys = 5;
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new criterion.
- google.ads.googleads.v10.resources.AdGroupCriterion create = 1;
+ google.ads.googleads.v13.resources.AdGroupCriterion create = 1;
// Update operation: The criterion is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.AdGroupCriterion update = 2;
+ google.ads.googleads.v13.resources.AdGroupCriterion update = 2;
// Remove operation: A resource name for the removed criterion is expected,
// in this format:
//
// `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupCriterion"
- }];
+ type: "googleads.googleapis.com/AdGroupCriterion"
+ }];
}
}
@@ -149,8 +154,8 @@ message AdGroupCriterionOperation {
message MutateAdGroupCriteriaResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -161,11 +166,11 @@ message MutateAdGroupCriteriaResponse {
message MutateAdGroupCriterionResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupCriterion"
- }];
+ type: "googleads.googleapis.com/AdGroupCriterion"
+ }];
// The mutated ad group criterion with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AdGroupCriterion ad_group_criterion = 2;
+ google.ads.googleads.v13.resources.AdGroupCriterion ad_group_criterion = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_customizer_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_customizer_service.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_customizer_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_customizer_service.proto
index dd9740e42..e936dcd4e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_customizer_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_customizer_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/ad_group_customizer.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad_group_customizer.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupCustomizerServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AdGroupCustomizer service.
@@ -42,9 +42,10 @@ service AdGroupCustomizerService {
// Creates, updates or removes ad group customizers. Operation statuses are
// returned.
- rpc MutateAdGroupCustomizers(MutateAdGroupCustomizersRequest) returns (MutateAdGroupCustomizersResponse) {
+ rpc MutateAdGroupCustomizers(MutateAdGroupCustomizersRequest)
+ returns (MutateAdGroupCustomizersResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adGroupCustomizers:mutate"
+ post: "/v13/customers/{customer_id=*}/adGroupCustomizers:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -52,13 +53,16 @@ service AdGroupCustomizerService {
}
// Request message for
-// [AdGroupCustomizerService.MutateAdGroupCustomizers][google.ads.googleads.v10.services.AdGroupCustomizerService.MutateAdGroupCustomizers].
+// [AdGroupCustomizerService.MutateAdGroupCustomizers][google.ads.googleads.v13.services.AdGroupCustomizerService.MutateAdGroupCustomizers].
message MutateAdGroupCustomizersRequest {
- // Required. The ID of the customer whose ad group customizers are being modified.
+ // Required. The ID of the customer whose ad group customizers are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual ad group customizers.
- repeated AdGroupCustomizerOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual ad group
+ // customizers.
+ repeated AdGroupCustomizerOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -72,23 +76,24 @@ message MutateAdGroupCustomizersRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
-// A single operation (create, remove) on an customizer attribute.
+// A single operation (create, remove) on a customizer attribute.
message AdGroupCustomizerOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new ad group
// customizer
- google.ads.googleads.v10.resources.AdGroupCustomizer create = 1;
+ google.ads.googleads.v13.resources.AdGroupCustomizer create = 1;
// Remove operation: A resource name for the removed ad group customizer is
// expected, in this format:
// `customers/{customer_id}/adGroupCustomizers/{ad_group_id}~{customizer_attribute_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupCustomizer"
- }];
+ type: "googleads.googleapis.com/AdGroupCustomizer"
+ }];
}
}
@@ -99,8 +104,8 @@ message MutateAdGroupCustomizersResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -108,11 +113,11 @@ message MutateAdGroupCustomizersResponse {
message MutateAdGroupCustomizerResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupCustomizer"
- }];
+ type: "googleads.googleapis.com/AdGroupCustomizer"
+ }];
// The mutated AdGroupCustomizer with only mutable fields after mutate.
// The field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AdGroupCustomizer ad_group_customizer = 2;
+ google.ads.googleads.v13.resources.AdGroupCustomizer ad_group_customizer = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_extension_setting_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_extension_setting_service.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_extension_setting_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_extension_setting_service.proto
index 81d0dbc54..b4278d4f4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_extension_setting_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_extension_setting_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/ad_group_extension_setting.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad_group_extension_setting.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupExtensionSettingServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AdGroupExtensionSetting service.
@@ -73,9 +73,10 @@ service AdGroupExtensionSettingService {
// [StringFormatError]()
// [StringLengthError]()
// [UrlFieldError]()
- rpc MutateAdGroupExtensionSettings(MutateAdGroupExtensionSettingsRequest) returns (MutateAdGroupExtensionSettingsResponse) {
+ rpc MutateAdGroupExtensionSettings(MutateAdGroupExtensionSettingsRequest)
+ returns (MutateAdGroupExtensionSettingsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adGroupExtensionSettings:mutate"
+ post: "/v13/customers/{customer_id=*}/adGroupExtensionSettings:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -83,15 +84,16 @@ service AdGroupExtensionSettingService {
}
// Request message for
-// [AdGroupExtensionSettingService.MutateAdGroupExtensionSettings][google.ads.googleads.v10.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings].
+// [AdGroupExtensionSettingService.MutateAdGroupExtensionSettings][google.ads.googleads.v13.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings].
message MutateAdGroupExtensionSettingsRequest {
- // Required. The ID of the customer whose ad group extension settings are being
- // modified.
+ // Required. The ID of the customer whose ad group extension settings are
+ // being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual ad group extension
- // settings.
- repeated AdGroupExtensionSettingOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual ad group
+ // extension settings.
+ repeated AdGroupExtensionSettingOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -111,25 +113,26 @@ message AdGroupExtensionSettingOperation {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new ad group
// extension setting.
- google.ads.googleads.v10.resources.AdGroupExtensionSetting create = 1;
+ google.ads.googleads.v13.resources.AdGroupExtensionSetting create = 1;
// Update operation: The ad group extension setting is expected to have a
// valid resource name.
- google.ads.googleads.v10.resources.AdGroupExtensionSetting update = 2;
+ google.ads.googleads.v13.resources.AdGroupExtensionSetting update = 2;
// Remove operation: A resource name for the removed ad group extension
// setting is expected, in this format:
//
// `customers/{customer_id}/adGroupExtensionSettings/{ad_group_id}~{extension_type}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupExtensionSetting"
- }];
+ type: "googleads.googleapis.com/AdGroupExtensionSetting"
+ }];
}
}
@@ -137,8 +140,8 @@ message AdGroupExtensionSettingOperation {
message MutateAdGroupExtensionSettingsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -149,11 +152,12 @@ message MutateAdGroupExtensionSettingsResponse {
message MutateAdGroupExtensionSettingResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupExtensionSetting"
- }];
+ type: "googleads.googleapis.com/AdGroupExtensionSetting"
+ }];
// The mutated AdGroupExtensionSetting with only mutable fields after mutate.
// The field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AdGroupExtensionSetting ad_group_extension_setting = 2;
+ google.ads.googleads.v13.resources.AdGroupExtensionSetting
+ ad_group_extension_setting = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_feed_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_feed_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_feed_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_feed_service.proto
index ede0b347b..68a671dfc 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_feed_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_feed_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/ad_group_feed.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad_group_feed.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupFeedServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AdGroupFeed service.
@@ -67,22 +67,25 @@ service AdGroupFeedService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateAdGroupFeeds(MutateAdGroupFeedsRequest) returns (MutateAdGroupFeedsResponse) {
+ rpc MutateAdGroupFeeds(MutateAdGroupFeedsRequest)
+ returns (MutateAdGroupFeedsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adGroupFeeds:mutate"
+ post: "/v13/customers/{customer_id=*}/adGroupFeeds:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AdGroupFeedService.MutateAdGroupFeeds][google.ads.googleads.v10.services.AdGroupFeedService.MutateAdGroupFeeds].
+// Request message for
+// [AdGroupFeedService.MutateAdGroupFeeds][google.ads.googleads.v13.services.AdGroupFeedService.MutateAdGroupFeeds].
message MutateAdGroupFeedsRequest {
// Required. The ID of the customer whose ad group feeds are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual ad group feeds.
- repeated AdGroupFeedOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AdGroupFeedOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -96,7 +99,8 @@ message MutateAdGroupFeedsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on an ad group feed.
@@ -107,19 +111,19 @@ message AdGroupFeedOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new ad group feed.
- google.ads.googleads.v10.resources.AdGroupFeed create = 1;
+ google.ads.googleads.v13.resources.AdGroupFeed create = 1;
// Update operation: The ad group feed is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.AdGroupFeed update = 2;
+ google.ads.googleads.v13.resources.AdGroupFeed update = 2;
// Remove operation: A resource name for the removed ad group feed is
// expected, in this format:
//
// `customers/{customer_id}/adGroupFeeds/{ad_group_id}~{feed_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupFeed"
- }];
+ type: "googleads.googleapis.com/AdGroupFeed"
+ }];
}
}
@@ -127,8 +131,8 @@ message AdGroupFeedOperation {
message MutateAdGroupFeedsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -139,11 +143,11 @@ message MutateAdGroupFeedsResponse {
message MutateAdGroupFeedResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupFeed"
- }];
+ type: "googleads.googleapis.com/AdGroupFeed"
+ }];
// The mutated ad group feed with only mutable fields after mutate. The field
// will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AdGroupFeed ad_group_feed = 2;
+ google.ads.googleads.v13.resources.AdGroupFeed ad_group_feed = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_label_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_label_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_label_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_label_service.proto
index 6e334fc22..42e6c5998 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_label_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_label_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/ad_group_label.proto";
+import "google/ads/googleads/v13/resources/ad_group_label.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupLabelServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Ad Group Label service.
@@ -54,22 +54,25 @@ service AdGroupLabelService {
// [NewResourceCreationError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateAdGroupLabels(MutateAdGroupLabelsRequest) returns (MutateAdGroupLabelsResponse) {
+ rpc MutateAdGroupLabels(MutateAdGroupLabelsRequest)
+ returns (MutateAdGroupLabelsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adGroupLabels:mutate"
+ post: "/v13/customers/{customer_id=*}/adGroupLabels:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AdGroupLabelService.MutateAdGroupLabels][google.ads.googleads.v10.services.AdGroupLabelService.MutateAdGroupLabels].
+// Request message for
+// [AdGroupLabelService.MutateAdGroupLabels][google.ads.googleads.v13.services.AdGroupLabelService.MutateAdGroupLabels].
message MutateAdGroupLabelsRequest {
// Required. ID of the customer whose ad group labels are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on ad group labels.
- repeated AdGroupLabelOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AdGroupLabelOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -88,15 +91,15 @@ message AdGroupLabelOperation {
oneof operation {
// Create operation: No resource name is expected for the new ad group
// label.
- google.ads.googleads.v10.resources.AdGroupLabel create = 1;
+ google.ads.googleads.v13.resources.AdGroupLabel create = 1;
// Remove operation: A resource name for the ad group label
// being removed, in this format:
//
// `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupLabel"
- }];
+ type: "googleads.googleapis.com/AdGroupLabel"
+ }];
}
}
@@ -104,8 +107,8 @@ message AdGroupLabelOperation {
message MutateAdGroupLabelsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -116,6 +119,6 @@ message MutateAdGroupLabelsResponse {
message MutateAdGroupLabelResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroupLabel"
- }];
+ type: "googleads.googleapis.com/AdGroupLabel"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_service.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_group_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_group_service.proto
index 732efd25d..e15bfc80a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_group_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_group_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/ad_group.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad_group.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdGroupServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Ad Group service.
@@ -77,20 +77,22 @@ service AdGroupService {
// [UrlFieldError]()
rpc MutateAdGroups(MutateAdGroupsRequest) returns (MutateAdGroupsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adGroups:mutate"
+ post: "/v13/customers/{customer_id=*}/adGroups:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AdGroupService.MutateAdGroups][google.ads.googleads.v10.services.AdGroupService.MutateAdGroups].
+// Request message for
+// [AdGroupService.MutateAdGroups][google.ads.googleads.v13.services.AdGroupService.MutateAdGroups].
message MutateAdGroupsRequest {
// Required. The ID of the customer whose ad groups are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual ad groups.
- repeated AdGroupOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AdGroupOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -104,7 +106,8 @@ message MutateAdGroupsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on an ad group.
@@ -115,18 +118,18 @@ message AdGroupOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new ad group.
- google.ads.googleads.v10.resources.AdGroup create = 1;
+ google.ads.googleads.v13.resources.AdGroup create = 1;
// Update operation: The ad group is expected to have a valid resource name.
- google.ads.googleads.v10.resources.AdGroup update = 2;
+ google.ads.googleads.v13.resources.AdGroup update = 2;
// Remove operation: A resource name for the removed ad group is expected,
// in this format:
//
// `customers/{customer_id}/adGroups/{ad_group_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroup"
- }];
+ type: "googleads.googleapis.com/AdGroup"
+ }];
}
}
@@ -134,8 +137,8 @@ message AdGroupOperation {
message MutateAdGroupsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -146,10 +149,10 @@ message MutateAdGroupsResponse {
message MutateAdGroupResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdGroup"
- }];
+ type: "googleads.googleapis.com/AdGroup"
+ }];
// The mutated ad group with only mutable fields after mutate. The field will
// only be returned when response_content_type is set to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AdGroup ad_group = 2;
+ google.ads.googleads.v13.resources.AdGroup ad_group = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_parameter_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_parameter_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_parameter_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_parameter_service.proto
index d6e0a7352..d4581c8cf 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_parameter_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_parameter_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/ad_parameter.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad_parameter.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdParameterServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Ad Parameter service.
@@ -57,22 +57,25 @@ service AdParameterService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateAdParameters(MutateAdParametersRequest) returns (MutateAdParametersResponse) {
+ rpc MutateAdParameters(MutateAdParametersRequest)
+ returns (MutateAdParametersResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/adParameters:mutate"
+ post: "/v13/customers/{customer_id=*}/adParameters:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AdParameterService.MutateAdParameters][google.ads.googleads.v10.services.AdParameterService.MutateAdParameters]
+// Request message for
+// [AdParameterService.MutateAdParameters][google.ads.googleads.v13.services.AdParameterService.MutateAdParameters]
message MutateAdParametersRequest {
// Required. The ID of the customer whose ad parameters are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual ad parameters.
- repeated AdParameterOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AdParameterOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -86,7 +89,8 @@ message MutateAdParametersRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on ad parameter.
@@ -97,19 +101,19 @@ message AdParameterOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new ad parameter.
- google.ads.googleads.v10.resources.AdParameter create = 1;
+ google.ads.googleads.v13.resources.AdParameter create = 1;
// Update operation: The ad parameter is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.AdParameter update = 2;
+ google.ads.googleads.v13.resources.AdParameter update = 2;
// Remove operation: A resource name for the ad parameter to remove is
// expected in this format:
//
// `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdParameter"
- }];
+ type: "googleads.googleapis.com/AdParameter"
+ }];
}
}
@@ -117,8 +121,8 @@ message AdParameterOperation {
message MutateAdParametersResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -129,11 +133,11 @@ message MutateAdParametersResponse {
message MutateAdParameterResult {
// The resource name returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AdParameter"
- }];
+ type: "googleads.googleapis.com/AdParameter"
+ }];
// The mutated AdParameter with only mutable fields after mutate. The field
// will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AdParameter ad_parameter = 2;
+ google.ads.googleads.v13.resources.AdParameter ad_parameter = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/ad_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/ad_service.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/services/ad_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/ad_service.proto
index 495ec97f4..79d1fabea 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/ad_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/ad_service.proto
@@ -14,11 +14,11 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/common/policy.proto";
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/ad.proto";
+import "google/ads/googleads/v13/common/policy.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/ad.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -26,14 +26,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AdServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Ad service.
@@ -51,9 +51,9 @@ service AdService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc GetAd(GetAdRequest) returns (google.ads.googleads.v10.resources.Ad) {
+ rpc GetAd(GetAdRequest) returns (google.ads.googleads.v13.resources.Ad) {
option (google.api.http) = {
- get: "/v10/{resource_name=customers/*/ads/*}"
+ get: "/v13/{resource_name=customers/*/ads/*}"
};
option (google.api.method_signature) = "resource_name";
}
@@ -102,25 +102,25 @@ service AdService {
// [UrlFieldError]()
rpc MutateAds(MutateAdsRequest) returns (MutateAdsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/ads:mutate"
+ post: "/v13/customers/{customer_id=*}/ads:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AdService.GetAd][google.ads.googleads.v10.services.AdService.GetAd].
+// Request message for
+// [AdService.GetAd][google.ads.googleads.v13.services.AdService.GetAd].
message GetAdRequest {
// Required. The resource name of the ad to fetch.
string resource_name = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "googleads.googleapis.com/Ad"
- }
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Ad" }
];
}
-// Request message for [AdService.MutateAds][google.ads.googleads.v10.services.AdService.MutateAds].
+// Request message for
+// [AdService.MutateAds][google.ads.googleads.v13.services.AdService.MutateAds].
message MutateAdsRequest {
// Required. The ID of the customer whose ads are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
@@ -136,7 +136,8 @@ message MutateAdsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -149,7 +150,8 @@ message AdOperation {
google.protobuf.FieldMask update_mask = 2;
// Configuration for how policies are validated.
- google.ads.googleads.v10.common.PolicyValidationParameter policy_validation_parameter = 3;
+ google.ads.googleads.v13.common.PolicyValidationParameter
+ policy_validation_parameter = 3;
// The mutate operation.
oneof operation {
@@ -157,7 +159,7 @@ message AdOperation {
// in this format:
//
// `customers/{customer_id}/ads/{ad_id}`
- google.ads.googleads.v10.resources.Ad update = 1;
+ google.ads.googleads.v13.resources.Ad update = 1;
}
}
@@ -165,8 +167,8 @@ message AdOperation {
message MutateAdsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -176,11 +178,11 @@ message MutateAdsResponse {
// The result for the ad mutate.
message MutateAdResult {
// The resource name returned for successful operations.
- string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Ad"
- }];
+ string resource_name = 1 [
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Ad" }
+ ];
// The mutated ad with only mutable fields after mutate. The field will only
// be returned when response_content_type is set to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.Ad ad = 2;
+ google.ads.googleads.v13.resources.Ad ad = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/asset_group_asset_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/asset_group_asset_service.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/services/asset_group_asset_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/asset_group_asset_service.proto
index 2b2ff2616..066964286 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/asset_group_asset_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/asset_group_asset_service.proto
@@ -14,9 +14,9 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/asset_group_asset.proto";
+import "google/ads/googleads/v13/resources/asset_group_asset.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -24,14 +24,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupAssetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AssetGroupAsset service.
@@ -42,22 +42,27 @@ service AssetGroupAssetService {
// Creates, updates or removes asset group assets. Operation statuses are
// returned.
- rpc MutateAssetGroupAssets(MutateAssetGroupAssetsRequest) returns (MutateAssetGroupAssetsResponse) {
+ rpc MutateAssetGroupAssets(MutateAssetGroupAssetsRequest)
+ returns (MutateAssetGroupAssetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/assetGroupAssets:mutate"
+ post: "/v13/customers/{customer_id=*}/assetGroupAssets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AssetGroupAssetService.MutateAssetGroupAssets][google.ads.googleads.v10.services.AssetGroupAssetService.MutateAssetGroupAssets].
+// Request message for
+// [AssetGroupAssetService.MutateAssetGroupAssets][google.ads.googleads.v13.services.AssetGroupAssetService.MutateAssetGroupAssets].
message MutateAssetGroupAssetsRequest {
- // Required. The ID of the customer whose asset group assets are being modified.
+ // Required. The ID of the customer whose asset group assets are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual asset group assets.
- repeated AssetGroupAssetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual asset group
+ // assets.
+ repeated AssetGroupAssetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -78,19 +83,19 @@ message AssetGroupAssetOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new asset group
- // asset
- google.ads.googleads.v10.resources.AssetGroupAsset create = 1;
+ // asset.
+ google.ads.googleads.v13.resources.AssetGroupAsset create = 1;
- // Update operation: The asset group asset sis expected to have a valid
+ // Update operation: The asset group asset is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.AssetGroupAsset update = 2;
+ google.ads.googleads.v13.resources.AssetGroupAsset update = 2;
// Remove operation: A resource name for the removed asset group asset is
// expected, in this format:
// `customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetGroupAsset"
- }];
+ type: "googleads.googleapis.com/AssetGroupAsset"
+ }];
}
}
@@ -101,8 +106,8 @@ message MutateAssetGroupAssetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -110,6 +115,6 @@ message MutateAssetGroupAssetsResponse {
message MutateAssetGroupAssetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetGroupAsset"
- }];
+ type: "googleads.googleapis.com/AssetGroupAsset"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/asset_group_listing_group_filter_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/asset_group_listing_group_filter_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/asset_group_listing_group_filter_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/asset_group_listing_group_filter_service.proto
index 1e4e577bf..06b0a17ca 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/asset_group_listing_group_filter_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/asset_group_listing_group_filter_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/asset_group_listing_group_filter.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/asset_group_listing_group_filter.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupListingGroupFilterServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AssetGroupListingGroupFilter service.
@@ -42,9 +42,11 @@ service AssetGroupListingGroupFilterService {
// Creates, updates or removes asset group listing group filters. Operation
// statuses are returned.
- rpc MutateAssetGroupListingGroupFilters(MutateAssetGroupListingGroupFiltersRequest) returns (MutateAssetGroupListingGroupFiltersResponse) {
+ rpc MutateAssetGroupListingGroupFilters(
+ MutateAssetGroupListingGroupFiltersRequest)
+ returns (MutateAssetGroupListingGroupFiltersResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate"
+ post: "/v13/customers/{customer_id=*}/assetGroupListingGroupFilters:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -52,17 +54,18 @@ service AssetGroupListingGroupFilterService {
}
// Request message for
-// [AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters][google.ads.googleads.v10.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters].
+// [AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters][google.ads.googleads.v13.services.AssetGroupListingGroupFilterService.MutateAssetGroupListingGroupFilters].
// partial_failure is not supported because the tree needs to be validated
// together.
message MutateAssetGroupListingGroupFiltersRequest {
- // Required. The ID of the customer whose asset group listing group filters are being
- // modified.
+ // Required. The ID of the customer whose asset group listing group filters
+ // are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual asset group listing group
- // filters.
- repeated AssetGroupListingGroupFilterOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual asset group
+ // listing group filters.
+ repeated AssetGroupListingGroupFilterOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -70,7 +73,8 @@ message MutateAssetGroupListingGroupFiltersRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 4;
}
// A single operation (create, remove) on an asset group listing group filter.
@@ -82,11 +86,11 @@ message AssetGroupListingGroupFilterOperation {
oneof operation {
// Create operation: No resource name is expected for the new asset group
// listing group filter.
- google.ads.googleads.v10.resources.AssetGroupListingGroupFilter create = 1;
+ google.ads.googleads.v13.resources.AssetGroupListingGroupFilter create = 1;
// Update operation: The asset group listing group filter is expected to
// have a valid resource name.
- google.ads.googleads.v10.resources.AssetGroupListingGroupFilter update = 2;
+ google.ads.googleads.v13.resources.AssetGroupListingGroupFilter update = 2;
// Remove operation: A resource name for the removed asset group listing
// group filter is expected, in this format:
@@ -95,8 +99,8 @@ message AssetGroupListingGroupFilterOperation {
// parent_listing_group_id. If multiple entities are being deleted, the
// mutates must be in the correct order.
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetGroupListingGroupFilter"
- }];
+ type: "googleads.googleapis.com/AssetGroupListingGroupFilter"
+ }];
}
}
@@ -110,11 +114,12 @@ message MutateAssetGroupListingGroupFiltersResponse {
message MutateAssetGroupListingGroupFilterResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetGroupListingGroupFilter"
- }];
+ type: "googleads.googleapis.com/AssetGroupListingGroupFilter"
+ }];
// The mutated AssetGroupListingGroupFilter with only mutable fields after
// mutate. The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AssetGroupListingGroupFilter asset_group_listing_group_filter = 2;
+ google.ads.googleads.v13.resources.AssetGroupListingGroupFilter
+ asset_group_listing_group_filter = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/asset_group_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/asset_group_service.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/services/asset_group_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/asset_group_service.proto
index fcbd54260..ee2118bb3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/asset_group_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/asset_group_service.proto
@@ -14,9 +14,9 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/asset_group.proto";
+import "google/ads/googleads/v13/resources/asset_group.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -24,14 +24,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AssetGroup service.
@@ -42,22 +42,25 @@ service AssetGroupService {
// Creates, updates or removes asset groups. Operation statuses are
// returned.
- rpc MutateAssetGroups(MutateAssetGroupsRequest) returns (MutateAssetGroupsResponse) {
+ rpc MutateAssetGroups(MutateAssetGroupsRequest)
+ returns (MutateAssetGroupsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/assetGroups:mutate"
+ post: "/v13/customers/{customer_id=*}/assetGroups:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AssetGroupService.MutateAssetGroups][google.ads.googleads.v10.services.AssetGroupService.MutateAssetGroups].
+// Request message for
+// [AssetGroupService.MutateAssetGroups][google.ads.googleads.v13.services.AssetGroupService.MutateAssetGroups].
message MutateAssetGroupsRequest {
// Required. The ID of the customer whose asset groups are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual asset groups.
- repeated AssetGroupOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AssetGroupOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -72,18 +75,18 @@ message AssetGroupOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new asset group
- google.ads.googleads.v10.resources.AssetGroup create = 1;
+ google.ads.googleads.v13.resources.AssetGroup create = 1;
// Update operation: The asset group is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.AssetGroup update = 2;
+ google.ads.googleads.v13.resources.AssetGroup update = 2;
// Remove operation: A resource name for the removed asset group is
// expected, in this format:
// `customers/{customer_id}/assetGroups/{asset_group_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetGroup"
- }];
+ type: "googleads.googleapis.com/AssetGroup"
+ }];
}
}
@@ -94,8 +97,8 @@ message MutateAssetGroupsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -103,6 +106,6 @@ message MutateAssetGroupsResponse {
message MutateAssetGroupResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetGroup"
- }];
+ type: "googleads.googleapis.com/AssetGroup"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/asset_group_signal_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/asset_group_signal_service.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/services/asset_group_signal_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/asset_group_signal_service.proto
index 801324136..50227e425 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/asset_group_signal_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/asset_group_signal_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/asset_group_signal.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/asset_group_signal.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AssetGroupSignalServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AssetGroupSignal service.
@@ -42,9 +42,10 @@ service AssetGroupSignalService {
// Creates or removes asset group signals. Operation statuses are
// returned.
- rpc MutateAssetGroupSignals(MutateAssetGroupSignalsRequest) returns (MutateAssetGroupSignalsResponse) {
+ rpc MutateAssetGroupSignals(MutateAssetGroupSignalsRequest)
+ returns (MutateAssetGroupSignalsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/assetGroupSignals:mutate"
+ post: "/v13/customers/{customer_id=*}/assetGroupSignals:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -52,13 +53,16 @@ service AssetGroupSignalService {
}
// Request message for
-// [AssetGroupSignalService.MutateAssetGroupSignals][google.ads.googleads.v10.services.AssetGroupSignalService.MutateAssetGroupSignals].
+// [AssetGroupSignalService.MutateAssetGroupSignals][google.ads.googleads.v13.services.AssetGroupSignalService.MutateAssetGroupSignals].
message MutateAssetGroupSignalsRequest {
- // Required. The ID of the customer whose asset group signals are being modified.
+ // Required. The ID of the customer whose asset group signals are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual asset group signals.
- repeated AssetGroupSignalOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual asset group
+ // signals.
+ repeated AssetGroupSignalOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid operations
// will return errors. If false, all operations will be carried out in one
@@ -71,7 +75,8 @@ message MutateAssetGroupSignalsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove) on an asset group signal.
@@ -80,14 +85,14 @@ message AssetGroupSignalOperation {
oneof operation {
// Create operation: No resource name is expected for the new asset group
// signal.
- google.ads.googleads.v10.resources.AssetGroupSignal create = 1;
+ google.ads.googleads.v13.resources.AssetGroupSignal create = 1;
// Remove operation: A resource name for the removed asset group signal is
// expected, in this format:
// `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{criterion_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetGroupSignal"
- }];
+ type: "googleads.googleapis.com/AssetGroupSignal"
+ }];
}
}
@@ -98,8 +103,8 @@ message MutateAssetGroupSignalsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -107,11 +112,11 @@ message MutateAssetGroupSignalsResponse {
message MutateAssetGroupSignalResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetGroupSignal"
- }];
+ type: "googleads.googleapis.com/AssetGroupSignal"
+ }];
// The mutated AssetGroupSignal with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AssetGroupSignal asset_group_signal = 2;
+ google.ads.googleads.v13.resources.AssetGroupSignal asset_group_signal = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/asset_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/asset_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/asset_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/asset_service.proto
index f64fae9b5..05e0449fc 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/asset_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/asset_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/asset.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/asset.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AssetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Asset service.
@@ -75,20 +75,22 @@ service AssetService {
// [YoutubeVideoRegistrationError]()
rpc MutateAssets(MutateAssetsRequest) returns (MutateAssetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/assets:mutate"
+ post: "/v13/customers/{customer_id=*}/assets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AssetService.MutateAssets][google.ads.googleads.v10.services.AssetService.MutateAssets]
+// Request message for
+// [AssetService.MutateAssets][google.ads.googleads.v13.services.AssetService.MutateAssets]
message MutateAssetsRequest {
// Required. The ID of the customer whose assets are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual assets.
- repeated AssetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AssetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -98,7 +100,8 @@ message MutateAssetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 3;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 3;
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -106,8 +109,9 @@ message MutateAssetsRequest {
}
// A single operation to create an asset. Supported asset types are
-// YoutubeVideoAsset, MediaBundleAsset, ImageAsset, and LeadFormAsset. TextAsset
-// should be created with Ad inline.
+// YoutubeVideoAsset, MediaBundleAsset, ImageAsset, LeadFormAsset,
+// LocationAsset, and ImageAsset. TextAsset can be created with an Ad inline,
+// but it can also be created apart from an Ad like other assets.
message AssetOperation {
// FieldMask that determines which resource fields are modified in an update.
google.protobuf.FieldMask update_mask = 3;
@@ -115,13 +119,13 @@ message AssetOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new asset.
- google.ads.googleads.v10.resources.Asset create = 1;
+ google.ads.googleads.v13.resources.Asset create = 1;
// Update operation: The asset is expected to have a valid resource name in
// this format:
//
// `customers/{customer_id}/assets/{asset_id}`
- google.ads.googleads.v10.resources.Asset update = 2;
+ google.ads.googleads.v13.resources.Asset update = 2;
}
}
@@ -129,8 +133,8 @@ message AssetOperation {
message MutateAssetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -140,11 +144,11 @@ message MutateAssetsResponse {
// The result for the asset mutate.
message MutateAssetResult {
// The resource name returned for successful operations.
- string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Asset"
- }];
+ string resource_name = 1 [
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" }
+ ];
// The mutated asset with only mutable fields after mutate. The field will
// only be returned when response_content_type is set to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.Asset asset = 2;
+ google.ads.googleads.v13.resources.Asset asset = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/asset_set_asset_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/asset_set_asset_service.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/services/asset_set_asset_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/asset_set_asset_service.proto
index 35f1b88a7..d77aa8fe9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/asset_set_asset_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/asset_set_asset_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/asset_set_asset.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/asset_set_asset.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AssetSetAssetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AssetSetAsset service.
@@ -42,22 +42,25 @@ service AssetSetAssetService {
// Creates, updates or removes asset set assets. Operation statuses are
// returned.
- rpc MutateAssetSetAssets(MutateAssetSetAssetsRequest) returns (MutateAssetSetAssetsResponse) {
+ rpc MutateAssetSetAssets(MutateAssetSetAssetsRequest)
+ returns (MutateAssetSetAssetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/assetSetAssets:mutate"
+ post: "/v13/customers/{customer_id=*}/assetSetAssets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AssetSetAssetService.MutateAssetSetAssets][google.ads.googleads.v10.services.AssetSetAssetService.MutateAssetSetAssets].
+// Request message for
+// [AssetSetAssetService.MutateAssetSetAssets][google.ads.googleads.v13.services.AssetSetAssetService.MutateAssetSetAssets].
message MutateAssetSetAssetsRequest {
// Required. The ID of the customer whose asset set assets are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual asset set assets.
- repeated AssetSetAssetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AssetSetAssetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -71,7 +74,8 @@ message MutateAssetSetAssetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove) on an asset set asset.
@@ -80,14 +84,14 @@ message AssetSetAssetOperation {
oneof operation {
// Create operation: No resource name is expected for the new asset set
// asset
- google.ads.googleads.v10.resources.AssetSetAsset create = 1;
+ google.ads.googleads.v13.resources.AssetSetAsset create = 1;
// Remove operation: A resource name for the removed asset set asset is
// expected, in this format:
// `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetSetAsset"
- }];
+ type: "googleads.googleapis.com/AssetSetAsset"
+ }];
}
}
@@ -98,8 +102,8 @@ message MutateAssetSetAssetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -107,11 +111,11 @@ message MutateAssetSetAssetsResponse {
message MutateAssetSetAssetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetSetAsset"
- }];
+ type: "googleads.googleapis.com/AssetSetAsset"
+ }];
// The mutated asset set asset with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AssetSetAsset asset_set_asset = 2;
+ google.ads.googleads.v13.resources.AssetSetAsset asset_set_asset = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/asset_set_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/asset_set_service.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/services/asset_set_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/asset_set_service.proto
index a795ed576..ed8ad15ae 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/asset_set_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/asset_set_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/asset_set.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/asset_set.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AssetSetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the AssetSet service.
@@ -43,22 +43,25 @@ service AssetSetService {
// Creates, updates or removes asset sets. Operation statuses are
// returned.
- rpc MutateAssetSets(MutateAssetSetsRequest) returns (MutateAssetSetsResponse) {
+ rpc MutateAssetSets(MutateAssetSetsRequest)
+ returns (MutateAssetSetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/assetSets:mutate"
+ post: "/v13/customers/{customer_id=*}/assetSets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AssetSetService.MutateAssetSets][google.ads.googleads.v10.services.AssetSetService.MutateAssetSets].
+// Request message for
+// [AssetSetService.MutateAssetSets][google.ads.googleads.v13.services.AssetSetService.MutateAssetSets].
message MutateAssetSetsRequest {
// Required. The ID of the customer whose asset sets are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual asset sets.
- repeated AssetSetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AssetSetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -72,7 +75,8 @@ message MutateAssetSetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove) on an asset set.
@@ -83,18 +87,18 @@ message AssetSetOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new asset set
- google.ads.googleads.v10.resources.AssetSet create = 1;
+ google.ads.googleads.v13.resources.AssetSet create = 1;
// Update operation: The asset set is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.AssetSet update = 2;
+ google.ads.googleads.v13.resources.AssetSet update = 2;
// Remove operation: A resource name for the removed asset set is
// expected, in this format:
// `customers/{customer_id}/assetSets/{asset_set_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetSet"
- }];
+ type: "googleads.googleapis.com/AssetSet"
+ }];
}
}
@@ -105,8 +109,8 @@ message MutateAssetSetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -114,10 +118,10 @@ message MutateAssetSetsResponse {
message MutateAssetSetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/AssetSet"
- }];
+ type: "googleads.googleapis.com/AssetSet"
+ }];
// The mutated asset set with only mutable fields after mutate. The field will
// only be returned when response_content_type is set to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.AssetSet asset_set = 2;
+ google.ads.googleads.v13.resources.AssetSet asset_set = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/services/audience_insights_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/audience_insights_service.proto
new file mode 100644
index 000000000..07fc0a039
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/services/audience_insights_service.proto
@@ -0,0 +1,507 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.services;
+
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/enums/audience_insights_dimension.proto";
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
+option java_multiple_files = true;
+option java_outer_classname = "AudienceInsightsServiceProto";
+option java_package = "com.google.ads.googleads.v13.services";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
+
+// Proto file describing the audience insights service.
+
+// Audience Insights Service helps users find information about groups of
+// people and how they can be reached with Google Ads. Accessible to
+// allowlisted customers only.
+service AudienceInsightsService {
+ option (google.api.default_host) = "googleads.googleapis.com";
+ option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";
+
+ // Creates a saved report that can be viewed in the Insights Finder tool.
+ //
+ // List of thrown errors:
+ // [AuthenticationError]()
+ // [AuthorizationError]()
+ // [FieldError]()
+ // [HeaderError]()
+ // [InternalError]()
+ // [QuotaError]()
+ // [RangeError]()
+ // [RequestError]()
+ rpc GenerateInsightsFinderReport(GenerateInsightsFinderReportRequest)
+ returns (GenerateInsightsFinderReportResponse) {
+ option (google.api.http) = {
+ post: "/v13/customers/{customer_id=*}:generateInsightsFinderReport"
+ body: "*"
+ };
+ option (google.api.method_signature) =
+ "customer_id,baseline_audience,specific_audience";
+ }
+
+ // Searches for audience attributes that can be used to generate insights.
+ //
+ // List of thrown errors:
+ // [AuthenticationError]()
+ // [AuthorizationError]()
+ // [FieldError]()
+ // [HeaderError]()
+ // [InternalError]()
+ // [QuotaError]()
+ // [RangeError]()
+ // [RequestError]()
+ rpc ListAudienceInsightsAttributes(ListAudienceInsightsAttributesRequest)
+ returns (ListAudienceInsightsAttributesResponse) {
+ option (google.api.http) = {
+ post: "/v13/customers/{customer_id=*}:searchAudienceInsightsAttributes"
+ body: "*"
+ };
+ option (google.api.method_signature) = "customer_id,dimensions,query_text";
+ }
+
+ // Lists date ranges for which audience insights data can be requested.
+ //
+ // List of thrown errors:
+ // [AuthenticationError]()
+ // [AuthorizationError]()
+ // [FieldError]()
+ // [HeaderError]()
+ // [InternalError]()
+ // [QuotaError]()
+ // [RangeError]()
+ // [RequestError]()
+ rpc ListInsightsEligibleDates(ListInsightsEligibleDatesRequest)
+ returns (ListInsightsEligibleDatesResponse) {
+ option (google.api.http) = {
+ post: "/v13/audienceInsights:listInsightsEligibleDates"
+ body: "*"
+ };
+ }
+
+ // Returns a collection of attributes that are represented in an audience of
+ // interest, with metrics that compare each attribute's share of the audience
+ // with its share of a baseline audience.
+ //
+ // List of thrown errors:
+ // [AudienceInsightsError]()
+ // [AuthenticationError]()
+ // [AuthorizationError]()
+ // [FieldError]()
+ // [HeaderError]()
+ // [InternalError]()
+ // [QuotaError]()
+ // [RangeError]()
+ // [RequestError]()
+ rpc GenerateAudienceCompositionInsights(
+ GenerateAudienceCompositionInsightsRequest)
+ returns (GenerateAudienceCompositionInsightsResponse) {
+ option (google.api.http) = {
+ post: "/v13/customers/{customer_id=*}:generateAudienceCompositionInsights"
+ body: "*"
+ };
+ option (google.api.method_signature) = "customer_id,audience,dimensions";
+ }
+}
+
+// Request message for
+// [AudienceInsightsService.GenerateInsightsFinderReport][google.ads.googleads.v13.services.AudienceInsightsService.GenerateInsightsFinderReport].
+message GenerateInsightsFinderReportRequest {
+ // Required. The ID of the customer.
+ string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. A baseline audience for this report, typically all people in a
+ // region.
+ BasicInsightsAudience baseline_audience = 2
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The specific audience of interest for this report. The insights
+ // in the report will be based on attributes more prevalent in this audience
+ // than in the report's baseline audience.
+ BasicInsightsAudience specific_audience = 3
+ [(google.api.field_behavior) = REQUIRED];
+
+ // The name of the customer being planned for. This is a user-defined value.
+ string customer_insights_group = 4;
+}
+
+// The response message for
+// [AudienceInsightsService.GenerateInsightsFinderReport][google.ads.googleads.v13.services.AudienceInsightsService.GenerateInsightsFinderReport],
+// containing the shareable URL for the report.
+message GenerateInsightsFinderReportResponse {
+ // An HTTPS URL providing a deep link into the Insights Finder UI with the
+ // report inputs filled in according to the request.
+ string saved_report_url = 1;
+}
+
+// Request message for
+// [AudienceInsightsService.GenerateAudienceCompositionInsights][google.ads.googleads.v13.services.AudienceInsightsService.GenerateAudienceCompositionInsights].
+message GenerateAudienceCompositionInsightsRequest {
+ // Required. The ID of the customer.
+ string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The audience of interest for which insights are being requested.
+ InsightsAudience audience = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // The one-month range of historical data to use for insights, in the format
+ // "yyyy-mm". If unset, insights will be returned for the last thirty days of
+ // data.
+ string data_month = 3;
+
+ // Required. The audience dimensions for which composition insights should be
+ // returned.
+ repeated google.ads.googleads.v13.enums.AudienceInsightsDimensionEnum
+ .AudienceInsightsDimension dimensions = 4
+ [(google.api.field_behavior) = REQUIRED];
+
+ // The name of the customer being planned for. This is a user-defined value.
+ string customer_insights_group = 5;
+}
+
+// Response message for
+// [AudienceInsightsService.GenerateAudienceCompositionInsights][google.ads.googleads.v13.services.AudienceInsightsService.GenerateAudienceCompositionInsights].
+message GenerateAudienceCompositionInsightsResponse {
+ // The contents of the insights report, organized into sections.
+ // Each section is associated with one of the AudienceInsightsDimension values
+ // in the request. There may be more than one section per dimension.
+ repeated AudienceCompositionSection sections = 1;
+}
+
+// Request message for
+// [AudienceInsightsService.ListAudienceInsightsAttributes][google.ads.googleads.v13.services.AudienceInsightsService.ListAudienceInsightsAttributes].
+message ListAudienceInsightsAttributesRequest {
+ // Required. The ID of the customer.
+ string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The types of attributes to be returned.
+ repeated google.ads.googleads.v13.enums.AudienceInsightsDimensionEnum
+ .AudienceInsightsDimension dimensions = 2
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. A free text query. Attributes matching or related to this string
+ // will be returned.
+ string query_text = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // The name of the customer being planned for. This is a user-defined value.
+ string customer_insights_group = 4;
+
+ // If SUB_COUNTRY_LOCATION attributes are one of the requested dimensions and
+ // this field is present, then the SUB_COUNTRY_LOCATION attributes returned
+ // will be located in these countries. If this field is absent, then location
+ // attributes are not filtered by country. Setting this field when
+ // SUB_COUNTRY_LOCATION attributes are not requested will return an error.
+ repeated google.ads.googleads.v13.common.LocationInfo
+ location_country_filters = 5;
+}
+
+// Response message for
+// [AudienceInsightsService.ListAudienceInsightsAttributes][google.ads.googleads.v13.services.AudienceInsightsService.ListAudienceInsightsAttributes].
+message ListAudienceInsightsAttributesResponse {
+ // The attributes matching the search query.
+ repeated AudienceInsightsAttributeMetadata attributes = 1;
+}
+
+// Request message for [AudienceInsightsService.ListAudienceInsightsDates][].
+message ListInsightsEligibleDatesRequest {}
+
+// Response message for [AudienceInsightsService.ListAudienceInsightsDates][].
+message ListInsightsEligibleDatesResponse {
+ // The months for which AudienceInsights data is currently
+ // available, each represented as a string in the form "YYYY-MM".
+ repeated string data_months = 1;
+}
+
+// An audience attribute that can be used to request insights about the
+// audience.
+message AudienceInsightsAttribute {
+ // An audience attribute.
+ oneof attribute {
+ // An audience attribute defined by an age range.
+ google.ads.googleads.v13.common.AgeRangeInfo age_range = 1;
+
+ // An audience attribute defined by a gender.
+ google.ads.googleads.v13.common.GenderInfo gender = 2;
+
+ // An audience attribute defined by a geographic location.
+ google.ads.googleads.v13.common.LocationInfo location = 3;
+
+ // An Affinity or In-Market audience.
+ google.ads.googleads.v13.common.UserInterestInfo user_interest = 4;
+
+ // An audience attribute defined by interest in a topic represented by a
+ // Knowledge Graph entity.
+ AudienceInsightsEntity entity = 5;
+
+ // An audience attribute defined by interest in a Product & Service
+ // category.
+ AudienceInsightsCategory category = 6;
+
+ // A YouTube Dynamic Lineup
+ AudienceInsightsDynamicLineup dynamic_lineup = 7;
+
+ // A Parental Status value (parent, or not a parent).
+ google.ads.googleads.v13.common.ParentalStatusInfo parental_status = 8;
+
+ // A household income percentile range.
+ google.ads.googleads.v13.common.IncomeRangeInfo income_range = 9;
+
+ // A YouTube channel.
+ google.ads.googleads.v13.common.YouTubeChannelInfo youtube_channel = 10;
+ }
+}
+
+// An entity or category representing a topic that defines an audience.
+message AudienceInsightsTopic {
+ // An entity or category attribute.
+ oneof topic {
+ // A Knowledge Graph entity
+ AudienceInsightsEntity entity = 1;
+
+ // A Product & Service category
+ AudienceInsightsCategory category = 2;
+ }
+}
+
+// A Knowledge Graph entity, represented by its machine id.
+message AudienceInsightsEntity {
+ // Required. The machine id (mid) of the Knowledge Graph entity.
+ string knowledge_graph_machine_id = 1
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// A Product and Service category.
+message AudienceInsightsCategory {
+ // Required. The criterion id of the category.
+ string category_id = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+// A YouTube Dynamic Lineup.
+message AudienceInsightsDynamicLineup {
+ // Required. The numeric ID of the dynamic lineup.
+ string dynamic_lineup_id = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+// A description of an audience used for requesting insights.
+message BasicInsightsAudience {
+ // Required. The countries for this audience.
+ repeated google.ads.googleads.v13.common.LocationInfo country_location = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Sub-country geographic location attributes. If present, each of these
+ // must be contained in one of the countries in this audience.
+ repeated google.ads.googleads.v13.common.LocationInfo sub_country_locations =
+ 2;
+
+ // Gender for the audience. If absent, the audience does not restrict by
+ // gender.
+ google.ads.googleads.v13.common.GenderInfo gender = 3;
+
+ // Age ranges for the audience. If absent, the audience represents all people
+ // over 18 that match the other attributes.
+ repeated google.ads.googleads.v13.common.AgeRangeInfo age_ranges = 4;
+
+ // User interests defining this audience. Affinity and In-Market audiences
+ // are supported.
+ repeated google.ads.googleads.v13.common.UserInterestInfo user_interests = 5;
+
+ // Topics, represented by Knowledge Graph entities and/or Product & Service
+ // categories, that this audience is interested in.
+ repeated AudienceInsightsTopic topics = 6;
+}
+
+// An audience attribute, with metadata about it, returned in response to a
+// search.
+message AudienceInsightsAttributeMetadata {
+ // The type of the attribute.
+ google.ads.googleads.v13.enums.AudienceInsightsDimensionEnum
+ .AudienceInsightsDimension dimension = 1;
+
+ // The attribute itself.
+ AudienceInsightsAttribute attribute = 2;
+
+ // The human-readable name of the attribute.
+ string display_name = 3;
+
+ // A relevance score for this attribute, between 0 and 1.
+ double score = 4;
+
+ // A string that supplements the display_name to identify the attribute.
+ // If the dimension is TOPIC, this is a brief description of the
+ // Knowledge Graph entity, such as "American singer-songwriter".
+ // If the dimension is CATEGORY, this is the complete path to the category in
+ // The Product & Service taxonomy, for example
+ // "/Apparel/Clothing/Outerwear".
+ string display_info = 5;
+
+ // Metadata specific to the dimension of this attribute.
+ oneof dimension_metadata {
+ // Special metadata for a YouTube channel.
+ YouTubeChannelAttributeMetadata youtube_channel_metadata = 6;
+
+ // Special metadata for a YouTube Dynamic Lineup.
+ DynamicLineupAttributeMetadata dynamic_attribute_metadata = 7;
+
+ // Special metadata for a Location.
+ LocationAttributeMetadata location_attribute_metadata = 8;
+ }
+}
+
+// Metadata associated with a YouTube channel attribute.
+message YouTubeChannelAttributeMetadata {
+ // The approximate number of subscribers to the YouTube channel.
+ int64 subscriber_count = 1;
+}
+
+// Metadata associated with a Dynamic Lineup attribute.
+message DynamicLineupAttributeMetadata {
+ // The national market associated with the lineup.
+ google.ads.googleads.v13.common.LocationInfo inventory_country = 1;
+
+ // The median number of impressions per month on this lineup.
+ optional int64 median_monthly_inventory = 2;
+
+ // The lower end of a range containing the number of channels in the lineup.
+ optional int64 channel_count_lower_bound = 3;
+
+ // The upper end of a range containing the number of channels in the lineup.
+ optional int64 channel_count_upper_bound = 4;
+}
+
+// Metadata associated with a Location attribute.
+message LocationAttributeMetadata {
+ // The country location of the sub country location.
+ google.ads.googleads.v13.common.LocationInfo country_location = 1;
+}
+
+// A set of users, defined by various characteristics, for which insights can
+// be requested in AudienceInsightsService.
+message InsightsAudience {
+ // Required. The countries for the audience.
+ repeated google.ads.googleads.v13.common.LocationInfo country_locations = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Sub-country geographic location attributes. If present, each of these
+ // must be contained in one of the countries in this audience. If absent, the
+ // audience is geographically to the country_locations and no further.
+ repeated google.ads.googleads.v13.common.LocationInfo sub_country_locations =
+ 2;
+
+ // Gender for the audience. If absent, the audience does not restrict by
+ // gender.
+ google.ads.googleads.v13.common.GenderInfo gender = 3;
+
+ // Age ranges for the audience. If absent, the audience represents all people
+ // over 18 that match the other attributes.
+ repeated google.ads.googleads.v13.common.AgeRangeInfo age_ranges = 4;
+
+ // Parental status for the audience. If absent, the audience does not
+ // restrict by parental status.
+ google.ads.googleads.v13.common.ParentalStatusInfo parental_status = 5;
+
+ // Household income percentile ranges for the audience. If absent, the
+ // audience does not restrict by household income range.
+ repeated google.ads.googleads.v13.common.IncomeRangeInfo income_ranges = 6;
+
+ // Dynamic lineups representing the YouTube content viewed by the audience.
+ repeated AudienceInsightsDynamicLineup dynamic_lineups = 7;
+
+ // A combination of entity, category and user interest attributes defining the
+ // audience. The combination has a logical AND-of-ORs structure: Attributes
+ // within each InsightsAudienceAttributeGroup are combined with OR, and
+ // the combinations themselves are combined together with AND. For example,
+ // the expression (Entity OR Affinity) AND (In-Market OR Category) can be
+ // formed using two InsightsAudienceAttributeGroups with two Attributes
+ // each.
+ repeated InsightsAudienceAttributeGroup topic_audience_combinations = 8;
+}
+
+// A list of AudienceInsightsAttributes.
+message InsightsAudienceAttributeGroup {
+ // Required. A collection of audience attributes to be combined with logical
+ // OR. Attributes need not all be the same dimension. Only Knowledge Graph
+ // entities, Product & Service Categories, and Affinity and In-Market
+ // audiences are supported in this context.
+ repeated AudienceInsightsAttribute attributes = 1
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// A collection of related attributes of the same type in an audience
+// composition insights report.
+message AudienceCompositionSection {
+ // The type of the attributes in this section.
+ google.ads.googleads.v13.enums.AudienceInsightsDimensionEnum
+ .AudienceInsightsDimension dimension = 1;
+
+ // The most relevant segments for this audience. If dimension is GENDER,
+ // AGE_RANGE or PARENTAL_STATUS, then this list of attributes is exhaustive.
+ repeated AudienceCompositionAttribute top_attributes = 3;
+
+ // Additional attributes for this audience, grouped into clusters. Only
+ // populated if dimension is YOUTUBE_CHANNEL.
+ repeated AudienceCompositionAttributeCluster clustered_attributes = 4;
+}
+
+// A collection of related attributes, with metadata and metrics, in an audience
+// composition insights report.
+message AudienceCompositionAttributeCluster {
+ // The name of this cluster of attributes
+ string cluster_display_name = 1;
+
+ // If the dimension associated with this cluster is YOUTUBE_CHANNEL, then
+ // cluster_metrics are metrics associated with the cluster as a whole.
+ // For other dimensions, this field is unset.
+ AudienceCompositionMetrics cluster_metrics = 3;
+
+ // The individual attributes that make up this cluster, with metadata and
+ // metrics.
+ repeated AudienceCompositionAttribute attributes = 4;
+}
+
+// The share and index metrics associated with an attribute in an audience
+// composition insights report.
+message AudienceCompositionMetrics {
+ // The fraction (from 0 to 1 inclusive) of the baseline audience that match
+ // the attribute.
+ double baseline_audience_share = 1;
+
+ // The fraction (from 0 to 1 inclusive) of the specific audience that match
+ // the attribute.
+ double audience_share = 2;
+
+ // The ratio of audience_share to baseline_audience_share, or zero if this
+ // ratio is undefined or is not meaningful.
+ double index = 3;
+
+ // A relevance score from 0 to 1 inclusive.
+ double score = 4;
+}
+
+// An audience attribute with metadata and metrics.
+message AudienceCompositionAttribute {
+ // The attribute with its metadata.
+ AudienceInsightsAttributeMetadata attribute_metadata = 1;
+
+ // Share and index metrics for the attribute.
+ AudienceCompositionMetrics metrics = 2;
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/audience_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/audience_service.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/services/audience_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/audience_service.proto
index c2da858ae..381597b9f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/audience_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/audience_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/audience.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/audience.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "AudienceServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Audience service.
@@ -45,22 +45,25 @@ service AudienceService {
//
// List of thrown errors:
// [AudienceError]()
- rpc MutateAudiences(MutateAudiencesRequest) returns (MutateAudiencesResponse) {
+ rpc MutateAudiences(MutateAudiencesRequest)
+ returns (MutateAudiencesResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/audiences:mutate"
+ post: "/v13/customers/{customer_id=*}/audiences:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [AudienceService.MutateAudiences][google.ads.googleads.v10.services.AudienceService.MutateAudiences].
+// Request message for
+// [AudienceService.MutateAudiences][google.ads.googleads.v13.services.AudienceService.MutateAudiences].
message MutateAudiencesRequest {
// Required. The ID of the customer whose audiences are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual audiences.
- repeated AudienceOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated AudienceOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid operations
// will return errors. If false, all operations will be carried out in one
@@ -73,7 +76,8 @@ message MutateAudiencesRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// Response message for an audience mutate.
@@ -83,8 +87,8 @@ message MutateAudiencesResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -96,11 +100,11 @@ message AudienceOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new audience
- google.ads.googleads.v10.resources.Audience create = 1;
+ google.ads.googleads.v13.resources.Audience create = 1;
// Update operation: The audience is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.Audience update = 2;
+ google.ads.googleads.v13.resources.Audience update = 2;
}
}
@@ -108,11 +112,11 @@ message AudienceOperation {
message MutateAudienceResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Audience"
- }];
+ type: "googleads.googleapis.com/Audience"
+ }];
// The mutated Audience with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.Audience audience = 2;
+ google.ads.googleads.v13.resources.Audience audience = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/batch_job_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/batch_job_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/batch_job_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/batch_job_service.proto
index 42d9c6734..c9a367e5b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/batch_job_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/batch_job_service.proto
@@ -14,26 +14,27 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/batch_job.proto";
-import "google/ads/googleads/v10/services/google_ads_service.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/batch_job.proto";
+import "google/ads/googleads/v13/services/google_ads_service.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "BatchJobServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the BatchJobService.
@@ -54,7 +55,7 @@ service BatchJobService {
// [ResourceCountLimitExceededError]()
rpc MutateBatchJob(MutateBatchJobRequest) returns (MutateBatchJobResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/batchJobs:mutate"
+ post: "/v13/customers/{customer_id=*}/batchJobs:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operation";
@@ -71,9 +72,10 @@ service BatchJobService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc ListBatchJobResults(ListBatchJobResultsRequest) returns (ListBatchJobResultsResponse) {
+ rpc ListBatchJobResults(ListBatchJobResultsRequest)
+ returns (ListBatchJobResultsResponse) {
option (google.api.http) = {
- get: "/v10/{resource_name=customers/*/batchJobs/*}:listResults"
+ get: "/v13/{resource_name=customers/*/batchJobs/*}:listResults"
};
option (google.api.method_signature) = "resource_name";
}
@@ -94,13 +96,13 @@ service BatchJobService {
// [RequestError]()
rpc RunBatchJob(RunBatchJobRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
- post: "/v10/{resource_name=customers/*/batchJobs/*}:run"
+ post: "/v13/{resource_name=customers/*/batchJobs/*}:run"
body: "*"
};
option (google.api.method_signature) = "resource_name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
- metadata_type: "google.ads.googleads.v10.resources.BatchJob.BatchJobMetadata"
+ metadata_type: "google.ads.googleads.v13.resources.BatchJob.BatchJobMetadata"
};
}
@@ -115,17 +117,20 @@ service BatchJobService {
// [QuotaError]()
// [RequestError]()
// [ResourceCountLimitExceededError]()
- rpc AddBatchJobOperations(AddBatchJobOperationsRequest) returns (AddBatchJobOperationsResponse) {
+ rpc AddBatchJobOperations(AddBatchJobOperationsRequest)
+ returns (AddBatchJobOperationsResponse) {
option (google.api.http) = {
- post: "/v10/{resource_name=customers/*/batchJobs/*}:addOperations"
+ post: "/v13/{resource_name=customers/*/batchJobs/*}:addOperations"
body: "*"
};
- option (google.api.method_signature) = "resource_name,sequence_token,mutate_operations";
+ option (google.api.method_signature) =
+ "resource_name,sequence_token,mutate_operations";
option (google.api.method_signature) = "resource_name,mutate_operations";
}
}
-// Request message for [BatchJobService.MutateBatchJob][google.ads.googleads.v10.services.BatchJobService.MutateBatchJob].
+// Request message for
+// [BatchJobService.MutateBatchJob][google.ads.googleads.v13.services.BatchJobService.MutateBatchJob].
message MutateBatchJobRequest {
// Required. The ID of the customer for which to create a batch job.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
@@ -139,19 +144,20 @@ message BatchJobOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new batch job.
- google.ads.googleads.v10.resources.BatchJob create = 1;
+ google.ads.googleads.v13.resources.BatchJob create = 1;
// Remove operation: The batch job must not have been run. A resource name
// for the removed batch job is expected, in this format:
//
// `customers/{customer_id}/batchJobs/{batch_job_id}`
string remove = 4 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/BatchJob"
- }];
+ type: "googleads.googleapis.com/BatchJob"
+ }];
}
}
-// Response message for [BatchJobService.MutateBatchJob][google.ads.googleads.v10.services.BatchJobService.MutateBatchJob].
+// Response message for
+// [BatchJobService.MutateBatchJob][google.ads.googleads.v13.services.BatchJobService.MutateBatchJob].
message MutateBatchJobResponse {
// The result for the mutate.
MutateBatchJobResult result = 1;
@@ -161,11 +167,12 @@ message MutateBatchJobResponse {
message MutateBatchJobResult {
// The resource name of the batch job.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/BatchJob"
- }];
+ type: "googleads.googleapis.com/BatchJob"
+ }];
}
-// Request message for [BatchJobService.RunBatchJob][google.ads.googleads.v10.services.BatchJobService.RunBatchJob].
+// Request message for
+// [BatchJobService.RunBatchJob][google.ads.googleads.v13.services.BatchJobService.RunBatchJob].
message RunBatchJobRequest {
// Required. The resource name of the BatchJob to run.
string resource_name = 1 [
@@ -176,7 +183,8 @@ message RunBatchJobRequest {
];
}
-// Request message for [BatchJobService.AddBatchJobOperations][google.ads.googleads.v10.services.BatchJobService.AddBatchJobOperations].
+// Request message for
+// [BatchJobService.AddBatchJobOperations][google.ads.googleads.v13.services.BatchJobService.AddBatchJobOperations].
message AddBatchJobOperationsRequest {
// Required. The resource name of the batch job.
string resource_name = 1 [
@@ -203,10 +211,12 @@ message AddBatchJobOperationsRequest {
// explicitly set to "customers/1234/campaigns/-1", and creating an ad group
// in the second operation with the campaign field also set to
// "customers/1234/campaigns/-1".
- repeated MutateOperation mutate_operations = 3 [(google.api.field_behavior) = REQUIRED];
+ repeated MutateOperation mutate_operations = 3
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [BatchJobService.AddBatchJobOperations][google.ads.googleads.v10.services.BatchJobService.AddBatchJobOperations].
+// Response message for
+// [BatchJobService.AddBatchJobOperations][google.ads.googleads.v13.services.BatchJobService.AddBatchJobOperations].
message AddBatchJobOperationsResponse {
// The total number of operations added so far for this batch job.
int64 total_operations = 1;
@@ -217,9 +227,11 @@ message AddBatchJobOperationsResponse {
string next_sequence_token = 2;
}
-// Request message for [BatchJobService.ListBatchJobResults][google.ads.googleads.v10.services.BatchJobService.ListBatchJobResults].
+// Request message for
+// [BatchJobService.ListBatchJobResults][google.ads.googleads.v13.services.BatchJobService.ListBatchJobResults].
message ListBatchJobResultsRequest {
- // Required. The resource name of the batch job whose results are being listed.
+ // Required. The resource name of the batch job whose results are being
+ // listed.
string resource_name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -240,10 +252,12 @@ message ListBatchJobResultsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 4;
}
-// Response message for [BatchJobService.ListBatchJobResults][google.ads.googleads.v10.services.BatchJobService.ListBatchJobResults].
+// Response message for
+// [BatchJobService.ListBatchJobResults][google.ads.googleads.v13.services.BatchJobService.ListBatchJobResults].
message ListBatchJobResultsResponse {
// The list of rows that matched the query.
repeated BatchJobResult results = 1;
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/bidding_data_exclusion_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/bidding_data_exclusion_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/bidding_data_exclusion_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/bidding_data_exclusion_service.proto
index 6c24a2e32..05c49dd79 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/bidding_data_exclusion_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/bidding_data_exclusion_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/bidding_data_exclusion.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/bidding_data_exclusion.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "BiddingDataExclusionServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Service to manage bidding data exclusions.
service BiddingDataExclusionService {
@@ -41,9 +41,10 @@ service BiddingDataExclusionService {
// Creates, updates, or removes data exclusions.
// Operation statuses are returned.
- rpc MutateBiddingDataExclusions(MutateBiddingDataExclusionsRequest) returns (MutateBiddingDataExclusionsResponse) {
+ rpc MutateBiddingDataExclusions(MutateBiddingDataExclusionsRequest)
+ returns (MutateBiddingDataExclusionsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/biddingDataExclusions:mutate"
+ post: "/v13/customers/{customer_id=*}/biddingDataExclusions:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -51,13 +52,14 @@ service BiddingDataExclusionService {
}
// Request message for
-// [BiddingDataExclusionService.MutateBiddingDataExclusions][google.ads.googleads.v10.services.BiddingDataExclusionService.MutateBiddingDataExclusions].
+// [BiddingDataExclusionService.MutateBiddingDataExclusions][google.ads.googleads.v13.services.BiddingDataExclusionService.MutateBiddingDataExclusions].
message MutateBiddingDataExclusionsRequest {
// Required. ID of the customer whose data exclusions are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual data exclusions.
- repeated BiddingDataExclusionOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated BiddingDataExclusionOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -71,7 +73,8 @@ message MutateBiddingDataExclusionsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove, update) on a data exclusion.
@@ -83,19 +86,19 @@ message BiddingDataExclusionOperation {
oneof operation {
// Create operation: No resource name is expected for the new data
// exclusion.
- google.ads.googleads.v10.resources.BiddingDataExclusion create = 1;
+ google.ads.googleads.v13.resources.BiddingDataExclusion create = 1;
// Update operation: The data exclusion is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.BiddingDataExclusion update = 2;
+ google.ads.googleads.v13.resources.BiddingDataExclusion update = 2;
// Remove operation: A resource name for the removed data exclusion
// is expected, in this format:
//
// `customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/BiddingDataExclusion"
- }];
+ type: "googleads.googleapis.com/BiddingDataExclusion"
+ }];
}
}
@@ -103,8 +106,8 @@ message BiddingDataExclusionOperation {
message MutateBiddingDataExclusionsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -115,11 +118,12 @@ message MutateBiddingDataExclusionsResponse {
message MutateBiddingDataExclusionsResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/BiddingDataExclusion"
- }];
+ type: "googleads.googleapis.com/BiddingDataExclusion"
+ }];
// The mutated bidding data exclusion with only mutable fields after mutate.
// The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.BiddingDataExclusion bidding_data_exclusion = 2;
+ google.ads.googleads.v13.resources.BiddingDataExclusion
+ bidding_data_exclusion = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/bidding_seasonality_adjustment_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/bidding_seasonality_adjustment_service.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/services/bidding_seasonality_adjustment_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/bidding_seasonality_adjustment_service.proto
index 1baecdb7c..f625c48eb 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/bidding_seasonality_adjustment_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/bidding_seasonality_adjustment_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/bidding_seasonality_adjustment.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/bidding_seasonality_adjustment.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "BiddingSeasonalityAdjustmentServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Service to manage bidding seasonality adjustments.
service BiddingSeasonalityAdjustmentService {
@@ -41,9 +41,11 @@ service BiddingSeasonalityAdjustmentService {
// Creates, updates, or removes seasonality adjustments.
// Operation statuses are returned.
- rpc MutateBiddingSeasonalityAdjustments(MutateBiddingSeasonalityAdjustmentsRequest) returns (MutateBiddingSeasonalityAdjustmentsResponse) {
+ rpc MutateBiddingSeasonalityAdjustments(
+ MutateBiddingSeasonalityAdjustmentsRequest)
+ returns (MutateBiddingSeasonalityAdjustmentsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate"
+ post: "/v13/customers/{customer_id=*}/biddingSeasonalityAdjustments:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -51,13 +53,16 @@ service BiddingSeasonalityAdjustmentService {
}
// Request message for
-// [BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments][google.ads.googleads.v10.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments].
+// [BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments][google.ads.googleads.v13.services.BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments].
message MutateBiddingSeasonalityAdjustmentsRequest {
- // Required. ID of the customer whose seasonality adjustments are being modified.
+ // Required. ID of the customer whose seasonality adjustments are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual seasonality adjustments.
- repeated BiddingSeasonalityAdjustmentOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual seasonality
+ // adjustments.
+ repeated BiddingSeasonalityAdjustmentOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -71,7 +76,8 @@ message MutateBiddingSeasonalityAdjustmentsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove, update) on a seasonality adjustment.
@@ -83,19 +89,19 @@ message BiddingSeasonalityAdjustmentOperation {
oneof operation {
// Create operation: No resource name is expected for the new seasonality
// adjustment.
- google.ads.googleads.v10.resources.BiddingSeasonalityAdjustment create = 1;
+ google.ads.googleads.v13.resources.BiddingSeasonalityAdjustment create = 1;
// Update operation: The seasonality adjustment is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.BiddingSeasonalityAdjustment update = 2;
+ google.ads.googleads.v13.resources.BiddingSeasonalityAdjustment update = 2;
// Remove operation: A resource name for the removed seasonality adjustment
// is expected, in this format:
//
// `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/BiddingSeasonalityAdjustment"
- }];
+ type: "googleads.googleapis.com/BiddingSeasonalityAdjustment"
+ }];
}
}
@@ -103,8 +109,8 @@ message BiddingSeasonalityAdjustmentOperation {
message MutateBiddingSeasonalityAdjustmentsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -115,11 +121,12 @@ message MutateBiddingSeasonalityAdjustmentsResponse {
message MutateBiddingSeasonalityAdjustmentsResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/BiddingSeasonalityAdjustment"
- }];
+ type: "googleads.googleapis.com/BiddingSeasonalityAdjustment"
+ }];
// The mutated bidding seasonality adjustment with only mutable fields after
// mutate. The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.BiddingSeasonalityAdjustment bidding_seasonality_adjustment = 2;
+ google.ads.googleads.v13.resources.BiddingSeasonalityAdjustment
+ bidding_seasonality_adjustment = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/bidding_strategy_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/bidding_strategy_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/bidding_strategy_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/bidding_strategy_service.proto
index 3306a9d29..7bd0fed85 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/bidding_strategy_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/bidding_strategy_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/bidding_strategy.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/bidding_strategy.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "BiddingStrategyServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Bidding Strategy service.
@@ -71,22 +71,27 @@ service BiddingStrategyService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateBiddingStrategies(MutateBiddingStrategiesRequest) returns (MutateBiddingStrategiesResponse) {
+ rpc MutateBiddingStrategies(MutateBiddingStrategiesRequest)
+ returns (MutateBiddingStrategiesResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/biddingStrategies:mutate"
+ post: "/v13/customers/{customer_id=*}/biddingStrategies:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [BiddingStrategyService.MutateBiddingStrategies][google.ads.googleads.v10.services.BiddingStrategyService.MutateBiddingStrategies].
+// Request message for
+// [BiddingStrategyService.MutateBiddingStrategies][google.ads.googleads.v13.services.BiddingStrategyService.MutateBiddingStrategies].
message MutateBiddingStrategiesRequest {
- // Required. The ID of the customer whose bidding strategies are being modified.
+ // Required. The ID of the customer whose bidding strategies are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual bidding strategies.
- repeated BiddingStrategyOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual bidding
+ // strategies.
+ repeated BiddingStrategyOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -100,7 +105,8 @@ message MutateBiddingStrategiesRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a bidding strategy.
@@ -112,19 +118,19 @@ message BiddingStrategyOperation {
oneof operation {
// Create operation: No resource name is expected for the new bidding
// strategy.
- google.ads.googleads.v10.resources.BiddingStrategy create = 1;
+ google.ads.googleads.v13.resources.BiddingStrategy create = 1;
// Update operation: The bidding strategy is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.BiddingStrategy update = 2;
+ google.ads.googleads.v13.resources.BiddingStrategy update = 2;
// Remove operation: A resource name for the removed bidding strategy is
// expected, in this format:
//
// `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/BiddingStrategy"
- }];
+ type: "googleads.googleapis.com/BiddingStrategy"
+ }];
}
}
@@ -132,8 +138,8 @@ message BiddingStrategyOperation {
message MutateBiddingStrategiesResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -144,11 +150,11 @@ message MutateBiddingStrategiesResponse {
message MutateBiddingStrategyResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/BiddingStrategy"
- }];
+ type: "googleads.googleapis.com/BiddingStrategy"
+ }];
// The mutated bidding strategy with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.BiddingStrategy bidding_strategy = 2;
+ google.ads.googleads.v13.resources.BiddingStrategy bidding_strategy = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/billing_setup_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/billing_setup_service.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/services/billing_setup_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/billing_setup_service.proto
index 1c07a9829..2168ceb50 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/billing_setup_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/billing_setup_service.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/billing_setup.proto";
+import "google/ads/googleads/v13/resources/billing_setup.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "BillingSetupServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the BillingSetup service.
@@ -59,9 +59,10 @@ service BillingSetupService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateBillingSetup(MutateBillingSetupRequest) returns (MutateBillingSetupResponse) {
+ rpc MutateBillingSetup(MutateBillingSetupRequest)
+ returns (MutateBillingSetupResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/billingSetups:mutate"
+ post: "/v13/customers/{customer_id=*}/billingSetups:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operation";
@@ -70,7 +71,8 @@ service BillingSetupService {
// Request message for billing setup mutate operations.
message MutateBillingSetupRequest {
- // Required. Id of the customer to apply the billing setup mutate operation to.
+ // Required. Id of the customer to apply the billing setup mutate operation
+ // to.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The operation to perform.
@@ -85,15 +87,15 @@ message BillingSetupOperation {
oneof operation {
// Creates a billing setup. No resource name is expected for the new billing
// setup.
- google.ads.googleads.v10.resources.BillingSetup create = 2;
+ google.ads.googleads.v13.resources.BillingSetup create = 2;
// Resource name of the billing setup to remove. A setup cannot be
// removed unless it is in a pending state or its scheduled start time is in
// the future. The resource name looks like
// `customers/{customer_id}/billingSetups/{billing_id}`.
string remove = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/BillingSetup"
- }];
+ type: "googleads.googleapis.com/BillingSetup"
+ }];
}
}
@@ -107,6 +109,6 @@ message MutateBillingSetupResponse {
message MutateBillingSetupResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/BillingSetup"
- }];
+ type: "googleads.googleapis.com/BillingSetup"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_asset_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_asset_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_asset_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_asset_service.proto
index a0a84cbd5..1161d98c3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_asset_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_asset_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_asset.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign_asset.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignAssetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CampaignAsset service.
@@ -57,22 +57,25 @@ service CampaignAssetService {
// [NotAllowlistedError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateCampaignAssets(MutateCampaignAssetsRequest) returns (MutateCampaignAssetsResponse) {
+ rpc MutateCampaignAssets(MutateCampaignAssetsRequest)
+ returns (MutateCampaignAssetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignAssets:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignAssets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CampaignAssetService.MutateCampaignAssets][google.ads.googleads.v10.services.CampaignAssetService.MutateCampaignAssets].
+// Request message for
+// [CampaignAssetService.MutateCampaignAssets][google.ads.googleads.v13.services.CampaignAssetService.MutateCampaignAssets].
message MutateCampaignAssetsRequest {
// Required. The ID of the customer whose campaign assets are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual campaign assets.
- repeated CampaignAssetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CampaignAssetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -86,7 +89,8 @@ message MutateCampaignAssetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a campaign asset.
@@ -98,19 +102,19 @@ message CampaignAssetOperation {
oneof operation {
// Create operation: No resource name is expected for the new campaign
// asset.
- google.ads.googleads.v10.resources.CampaignAsset create = 1;
+ google.ads.googleads.v13.resources.CampaignAsset create = 1;
// Update operation: The campaign asset is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.CampaignAsset update = 3;
+ google.ads.googleads.v13.resources.CampaignAsset update = 3;
// Remove operation: A resource name for the removed campaign asset is
// expected, in this format:
//
// `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignAsset"
- }];
+ type: "googleads.googleapis.com/CampaignAsset"
+ }];
}
}
@@ -118,8 +122,8 @@ message CampaignAssetOperation {
message MutateCampaignAssetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 1;
// All results for the mutate.
@@ -130,11 +134,11 @@ message MutateCampaignAssetsResponse {
message MutateCampaignAssetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignAsset"
- }];
+ type: "googleads.googleapis.com/CampaignAsset"
+ }];
// The mutated campaign asset with only mutable fields after
// mutate. The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignAsset campaign_asset = 2;
+ google.ads.googleads.v13.resources.CampaignAsset campaign_asset = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_asset_set_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_asset_set_service.proto
similarity index 70%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_asset_set_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_asset_set_service.proto
index dfca68307..463da9571 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_asset_set_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_asset_set_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_asset_set.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign_asset_set.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignAssetSetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CampaignAssetSet service.
@@ -42,22 +42,27 @@ service CampaignAssetSetService {
// Creates, updates or removes campaign asset sets. Operation statuses are
// returned.
- rpc MutateCampaignAssetSets(MutateCampaignAssetSetsRequest) returns (MutateCampaignAssetSetsResponse) {
+ rpc MutateCampaignAssetSets(MutateCampaignAssetSetsRequest)
+ returns (MutateCampaignAssetSetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignAssetSets:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignAssetSets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CampaignAssetSetService.MutateCampaignAssetSets][google.ads.googleads.v10.services.CampaignAssetSetService.MutateCampaignAssetSets].
+// Request message for
+// [CampaignAssetSetService.MutateCampaignAssetSets][google.ads.googleads.v13.services.CampaignAssetSetService.MutateCampaignAssetSets].
message MutateCampaignAssetSetsRequest {
- // Required. The ID of the customer whose campaign asset sets are being modified.
+ // Required. The ID of the customer whose campaign asset sets are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual campaign asset sets.
- repeated CampaignAssetSetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual campaign asset
+ // sets.
+ repeated CampaignAssetSetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -71,7 +76,8 @@ message MutateCampaignAssetSetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove) on a campaign asset set.
@@ -80,14 +86,14 @@ message CampaignAssetSetOperation {
oneof operation {
// Create operation: No resource name is expected for the new campaign asset
// set.
- google.ads.googleads.v10.resources.CampaignAssetSet create = 1;
+ google.ads.googleads.v13.resources.CampaignAssetSet create = 1;
// Remove operation: A resource name for the removed campaign asset set is
// expected, in this format:
// `customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignAssetSet"
- }];
+ type: "googleads.googleapis.com/CampaignAssetSet"
+ }];
}
}
@@ -98,8 +104,8 @@ message MutateCampaignAssetSetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -107,11 +113,11 @@ message MutateCampaignAssetSetsResponse {
message MutateCampaignAssetSetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignAssetSet"
- }];
+ type: "googleads.googleapis.com/CampaignAssetSet"
+ }];
// The mutated campaign asset set with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignAssetSet campaign_asset_set = 2;
+ google.ads.googleads.v13.resources.CampaignAssetSet campaign_asset_set = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_bid_modifier_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_bid_modifier_service.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_bid_modifier_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_bid_modifier_service.proto
index d14485894..70b3fd4b6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_bid_modifier_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_bid_modifier_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_bid_modifier.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign_bid_modifier.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignBidModifierServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Campaign Bid Modifier service.
@@ -67,9 +67,10 @@ service CampaignBidModifierService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateCampaignBidModifiers(MutateCampaignBidModifiersRequest) returns (MutateCampaignBidModifiersResponse) {
+ rpc MutateCampaignBidModifiers(MutateCampaignBidModifiersRequest)
+ returns (MutateCampaignBidModifiersResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignBidModifiers:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignBidModifiers:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -77,13 +78,16 @@ service CampaignBidModifierService {
}
// Request message for
-// [CampaignBidModifierService.MutateCampaignBidModifiers][google.ads.googleads.v10.services.CampaignBidModifierService.MutateCampaignBidModifiers].
+// [CampaignBidModifierService.MutateCampaignBidModifiers][google.ads.googleads.v13.services.CampaignBidModifierService.MutateCampaignBidModifiers].
message MutateCampaignBidModifiersRequest {
- // Required. ID of the customer whose campaign bid modifiers are being modified.
+ // Required. ID of the customer whose campaign bid modifiers are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual campaign bid modifiers.
- repeated CampaignBidModifierOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual campaign bid
+ // modifiers.
+ repeated CampaignBidModifierOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -97,7 +101,8 @@ message MutateCampaignBidModifiersRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove, update) on a campaign bid modifier.
@@ -109,19 +114,19 @@ message CampaignBidModifierOperation {
oneof operation {
// Create operation: No resource name is expected for the new campaign bid
// modifier.
- google.ads.googleads.v10.resources.CampaignBidModifier create = 1;
+ google.ads.googleads.v13.resources.CampaignBidModifier create = 1;
// Update operation: The campaign bid modifier is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.CampaignBidModifier update = 2;
+ google.ads.googleads.v13.resources.CampaignBidModifier update = 2;
// Remove operation: A resource name for the removed campaign bid modifier
// is expected, in this format:
//
// `customers/{customer_id}/CampaignBidModifiers/{campaign_id}~{criterion_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignBidModifier"
- }];
+ type: "googleads.googleapis.com/CampaignBidModifier"
+ }];
}
}
@@ -129,8 +134,8 @@ message CampaignBidModifierOperation {
message MutateCampaignBidModifiersResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -141,11 +146,12 @@ message MutateCampaignBidModifiersResponse {
message MutateCampaignBidModifierResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignBidModifier"
- }];
+ type: "googleads.googleapis.com/CampaignBidModifier"
+ }];
// The mutated campaign bid modifier with only mutable fields after mutate.
// The field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignBidModifier campaign_bid_modifier = 2;
+ google.ads.googleads.v13.resources.CampaignBidModifier campaign_bid_modifier =
+ 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_budget_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_budget_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_budget_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_budget_service.proto
index 0f37eb1af..b6abf5070 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_budget_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_budget_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_budget.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign_budget.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignBudgetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Campaign Budget service.
@@ -62,22 +62,25 @@ service CampaignBudgetService {
// [RequestError]()
// [ResourceCountLimitExceededError]()
// [StringLengthError]()
- rpc MutateCampaignBudgets(MutateCampaignBudgetsRequest) returns (MutateCampaignBudgetsResponse) {
+ rpc MutateCampaignBudgets(MutateCampaignBudgetsRequest)
+ returns (MutateCampaignBudgetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignBudgets:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignBudgets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CampaignBudgetService.MutateCampaignBudgets][google.ads.googleads.v10.services.CampaignBudgetService.MutateCampaignBudgets].
+// Request message for
+// [CampaignBudgetService.MutateCampaignBudgets][google.ads.googleads.v13.services.CampaignBudgetService.MutateCampaignBudgets].
message MutateCampaignBudgetsRequest {
// Required. The ID of the customer whose campaign budgets are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual campaign budgets.
- repeated CampaignBudgetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CampaignBudgetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -91,7 +94,8 @@ message MutateCampaignBudgetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a campaign budget.
@@ -102,19 +106,19 @@ message CampaignBudgetOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new budget.
- google.ads.googleads.v10.resources.CampaignBudget create = 1;
+ google.ads.googleads.v13.resources.CampaignBudget create = 1;
// Update operation: The campaign budget is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.CampaignBudget update = 2;
+ google.ads.googleads.v13.resources.CampaignBudget update = 2;
// Remove operation: A resource name for the removed budget is expected, in
// this format:
//
// `customers/{customer_id}/campaignBudgets/{budget_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignBudget"
- }];
+ type: "googleads.googleapis.com/CampaignBudget"
+ }];
}
}
@@ -122,8 +126,8 @@ message CampaignBudgetOperation {
message MutateCampaignBudgetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -134,11 +138,11 @@ message MutateCampaignBudgetsResponse {
message MutateCampaignBudgetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignBudget"
- }];
+ type: "googleads.googleapis.com/CampaignBudget"
+ }];
// The mutated campaign budget with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignBudget campaign_budget = 2;
+ google.ads.googleads.v13.resources.CampaignBudget campaign_budget = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_conversion_goal_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_conversion_goal_service.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_conversion_goal_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_conversion_goal_service.proto
index 1c827c9ac..764edee14 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_conversion_goal_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_conversion_goal_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/campaign_conversion_goal.proto";
+import "google/ads/googleads/v13/resources/campaign_conversion_goal.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignConversionGoalServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CampaignConversionGoal service.
@@ -41,9 +41,10 @@ service CampaignConversionGoalService {
// Creates, updates or removes campaign conversion goals. Operation statuses
// are returned.
- rpc MutateCampaignConversionGoals(MutateCampaignConversionGoalsRequest) returns (MutateCampaignConversionGoalsResponse) {
+ rpc MutateCampaignConversionGoals(MutateCampaignConversionGoalsRequest)
+ returns (MutateCampaignConversionGoalsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignConversionGoals:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignConversionGoals:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -51,13 +52,16 @@ service CampaignConversionGoalService {
}
// Request message for
-// [CampaignConversionGoalService.MutateCampaignConversionGoals][google.ads.googleads.v10.services.CampaignConversionGoalService.MutateCampaignConversionGoals].
+// [CampaignConversionGoalService.MutateCampaignConversionGoals][google.ads.googleads.v13.services.CampaignConversionGoalService.MutateCampaignConversionGoals].
message MutateCampaignConversionGoalsRequest {
- // Required. The ID of the customer whose campaign conversion goals are being modified.
+ // Required. The ID of the customer whose campaign conversion goals are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual campaign conversion goal.
- repeated CampaignConversionGoalOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual campaign
+ // conversion goal.
+ repeated CampaignConversionGoalOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -73,7 +77,7 @@ message CampaignConversionGoalOperation {
oneof operation {
// Update operation: The customer conversion goal is expected to have a
// valid resource name.
- google.ads.googleads.v10.resources.CampaignConversionGoal update = 1;
+ google.ads.googleads.v13.resources.CampaignConversionGoal update = 1;
}
}
@@ -87,6 +91,6 @@ message MutateCampaignConversionGoalsResponse {
message MutateCampaignConversionGoalResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignConversionGoal"
- }];
+ type: "googleads.googleapis.com/CampaignConversionGoal"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_criterion_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_criterion_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_criterion_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_criterion_service.proto
index 1fc7a6ca5..79394eaf4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_criterion_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_criterion_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_criterion.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign_criterion.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignCriterionServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Campaign Criterion service.
@@ -73,22 +73,25 @@ service CampaignCriterionService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateCampaignCriteria(MutateCampaignCriteriaRequest) returns (MutateCampaignCriteriaResponse) {
+ rpc MutateCampaignCriteria(MutateCampaignCriteriaRequest)
+ returns (MutateCampaignCriteriaResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignCriteria:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignCriteria:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CampaignCriterionService.MutateCampaignCriteria][google.ads.googleads.v10.services.CampaignCriterionService.MutateCampaignCriteria].
+// Request message for
+// [CampaignCriterionService.MutateCampaignCriteria][google.ads.googleads.v13.services.CampaignCriterionService.MutateCampaignCriteria].
message MutateCampaignCriteriaRequest {
// Required. The ID of the customer whose criteria are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual criteria.
- repeated CampaignCriterionOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CampaignCriterionOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -102,7 +105,8 @@ message MutateCampaignCriteriaRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a campaign criterion.
@@ -113,19 +117,19 @@ message CampaignCriterionOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new criterion.
- google.ads.googleads.v10.resources.CampaignCriterion create = 1;
+ google.ads.googleads.v13.resources.CampaignCriterion create = 1;
// Update operation: The criterion is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.CampaignCriterion update = 2;
+ google.ads.googleads.v13.resources.CampaignCriterion update = 2;
// Remove operation: A resource name for the removed criterion is expected,
// in this format:
//
// `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignCriterion"
- }];
+ type: "googleads.googleapis.com/CampaignCriterion"
+ }];
}
}
@@ -133,8 +137,8 @@ message CampaignCriterionOperation {
message MutateCampaignCriteriaResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -145,11 +149,11 @@ message MutateCampaignCriteriaResponse {
message MutateCampaignCriterionResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignCriterion"
- }];
+ type: "googleads.googleapis.com/CampaignCriterion"
+ }];
// The mutated campaign criterion with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignCriterion campaign_criterion = 2;
+ google.ads.googleads.v13.resources.CampaignCriterion campaign_criterion = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_customizer_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_customizer_service.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_customizer_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_customizer_service.proto
index 91bfc664e..c934281cd 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_customizer_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_customizer_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_customizer.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign_customizer.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignCustomizerServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CampaignCustomizer service.
@@ -42,9 +42,10 @@ service CampaignCustomizerService {
// Creates, updates or removes campaign customizers. Operation statuses are
// returned.
- rpc MutateCampaignCustomizers(MutateCampaignCustomizersRequest) returns (MutateCampaignCustomizersResponse) {
+ rpc MutateCampaignCustomizers(MutateCampaignCustomizersRequest)
+ returns (MutateCampaignCustomizersResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignCustomizers:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignCustomizers:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -52,13 +53,16 @@ service CampaignCustomizerService {
}
// Request message for
-// [CampaignCustomizerService.MutateCampaignCustomizers][google.ads.googleads.v10.services.CampaignCustomizerService.MutateCampaignCustomizers].
+// [CampaignCustomizerService.MutateCampaignCustomizers][google.ads.googleads.v13.services.CampaignCustomizerService.MutateCampaignCustomizers].
message MutateCampaignCustomizersRequest {
- // Required. The ID of the customer whose campaign customizers are being modified.
+ // Required. The ID of the customer whose campaign customizers are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual campaign customizers.
- repeated CampaignCustomizerOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual campaign
+ // customizers.
+ repeated CampaignCustomizerOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -72,35 +76,36 @@ message MutateCampaignCustomizersRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
-// A single operation (create, remove) on an customizer attribute.
+// A single operation (create, remove) on a customizer attribute.
message CampaignCustomizerOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new campaign
// customizer
- google.ads.googleads.v10.resources.CampaignCustomizer create = 1;
+ google.ads.googleads.v13.resources.CampaignCustomizer create = 1;
// Remove operation: A resource name for the removed campaign customizer is
// expected, in this format:
// `customers/{customer_id}/campaignCustomizers/{campaign_id}~{customizer_attribute_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignCustomizer"
- }];
+ type: "googleads.googleapis.com/CampaignCustomizer"
+ }];
}
}
-// Response message for an campaign customizer mutate.
+// Response message for a campaign customizer mutate.
message MutateCampaignCustomizersResponse {
// All results for the mutate.
repeated MutateCampaignCustomizerResult results = 1;
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -108,11 +113,11 @@ message MutateCampaignCustomizersResponse {
message MutateCampaignCustomizerResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignCustomizer"
- }];
+ type: "googleads.googleapis.com/CampaignCustomizer"
+ }];
// The mutated CampaignCustomizer with only mutable fields after mutate.
// The field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignCustomizer campaign_customizer = 2;
+ google.ads.googleads.v13.resources.CampaignCustomizer campaign_customizer = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_draft_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_draft_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_draft_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_draft_service.proto
index 4eb2e0455..4024c9fb7 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_draft_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_draft_service.proto
@@ -14,26 +14,27 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_draft.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign_draft.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignDraftServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Campaign Draft service.
@@ -56,9 +57,10 @@ service CampaignDraftService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateCampaignDrafts(MutateCampaignDraftsRequest) returns (MutateCampaignDraftsResponse) {
+ rpc MutateCampaignDrafts(MutateCampaignDraftsRequest)
+ returns (MutateCampaignDraftsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignDrafts:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignDrafts:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -71,8 +73,8 @@ service CampaignDraftService {
// is done. Only a done status is returned in the response. See the status
// in the Campaign Draft resource to determine if the promotion was
// successful. If the LRO failed, use
- // [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v10.services.CampaignDraftService.ListCampaignDraftAsyncErrors] to view the list of
- // error reasons.
+ // [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v13.services.CampaignDraftService.ListCampaignDraftAsyncErrors]
+ // to view the list of error reasons.
//
// List of thrown errors:
// [AuthenticationError]()
@@ -82,9 +84,10 @@ service CampaignDraftService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc PromoteCampaignDraft(PromoteCampaignDraftRequest) returns (google.longrunning.Operation) {
+ rpc PromoteCampaignDraft(PromoteCampaignDraftRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
- post: "/v10/{campaign_draft=customers/*/campaignDrafts/*}:promote"
+ post: "/v13/{campaign_draft=customers/*/campaignDrafts/*}:promote"
body: "*"
};
option (google.api.method_signature) = "campaign_draft";
@@ -105,21 +108,24 @@ service CampaignDraftService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc ListCampaignDraftAsyncErrors(ListCampaignDraftAsyncErrorsRequest) returns (ListCampaignDraftAsyncErrorsResponse) {
+ rpc ListCampaignDraftAsyncErrors(ListCampaignDraftAsyncErrorsRequest)
+ returns (ListCampaignDraftAsyncErrorsResponse) {
option (google.api.http) = {
- get: "/v10/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors"
+ get: "/v13/{resource_name=customers/*/campaignDrafts/*}:listAsyncErrors"
};
option (google.api.method_signature) = "resource_name";
}
}
-// Request message for [CampaignDraftService.MutateCampaignDrafts][google.ads.googleads.v10.services.CampaignDraftService.MutateCampaignDrafts].
+// Request message for
+// [CampaignDraftService.MutateCampaignDrafts][google.ads.googleads.v13.services.CampaignDraftService.MutateCampaignDrafts].
message MutateCampaignDraftsRequest {
// Required. The ID of the customer whose campaign drafts are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual campaign drafts.
- repeated CampaignDraftOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CampaignDraftOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -133,10 +139,12 @@ message MutateCampaignDraftsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
-// Request message for [CampaignDraftService.PromoteCampaignDraft][google.ads.googleads.v10.services.CampaignDraftService.PromoteCampaignDraft].
+// Request message for
+// [CampaignDraftService.PromoteCampaignDraft][google.ads.googleads.v13.services.CampaignDraftService.PromoteCampaignDraft].
message PromoteCampaignDraftRequest {
// Required. The resource name of the campaign draft to promote.
string campaign_draft = 1 [
@@ -160,19 +168,19 @@ message CampaignDraftOperation {
oneof operation {
// Create operation: No resource name is expected for the new campaign
// draft.
- google.ads.googleads.v10.resources.CampaignDraft create = 1;
+ google.ads.googleads.v13.resources.CampaignDraft create = 1;
// Update operation: The campaign draft is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.CampaignDraft update = 2;
+ google.ads.googleads.v13.resources.CampaignDraft update = 2;
// Remove operation: The campaign draft is expected to have a valid
// resource name, in this format:
//
// `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignDraft"
- }];
+ type: "googleads.googleapis.com/CampaignDraft"
+ }];
}
}
@@ -180,8 +188,8 @@ message CampaignDraftOperation {
message MutateCampaignDraftsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -192,18 +200,20 @@ message MutateCampaignDraftsResponse {
message MutateCampaignDraftResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignDraft"
- }];
+ type: "googleads.googleapis.com/CampaignDraft"
+ }];
// The mutated campaign draft with only mutable fields after mutate. The field
// will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignDraft campaign_draft = 2;
+ google.ads.googleads.v13.resources.CampaignDraft campaign_draft = 2;
}
-// Request message for [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v10.services.CampaignDraftService.ListCampaignDraftAsyncErrors].
+// Request message for
+// [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v13.services.CampaignDraftService.ListCampaignDraftAsyncErrors].
message ListCampaignDraftAsyncErrorsRequest {
- // Required. The name of the campaign draft from which to retrieve the async errors.
+ // Required. The name of the campaign draft from which to retrieve the async
+ // errors.
string resource_name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -223,7 +233,8 @@ message ListCampaignDraftAsyncErrorsRequest {
int32 page_size = 3;
}
-// Response message for [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v10.services.CampaignDraftService.ListCampaignDraftAsyncErrors].
+// Response message for
+// [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v13.services.CampaignDraftService.ListCampaignDraftAsyncErrors].
message ListCampaignDraftAsyncErrorsResponse {
// Details of the errors when performing the asynchronous operation.
repeated google.rpc.Status errors = 1;
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_extension_setting_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_extension_setting_service.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_extension_setting_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_extension_setting_service.proto
index dbac6ea33..0bfe6840b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_extension_setting_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_extension_setting_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_extension_setting.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign_extension_setting.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignExtensionSettingServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CampaignExtensionSetting service.
@@ -72,9 +72,10 @@ service CampaignExtensionSettingService {
// [StringFormatError]()
// [StringLengthError]()
// [UrlFieldError]()
- rpc MutateCampaignExtensionSettings(MutateCampaignExtensionSettingsRequest) returns (MutateCampaignExtensionSettingsResponse) {
+ rpc MutateCampaignExtensionSettings(MutateCampaignExtensionSettingsRequest)
+ returns (MutateCampaignExtensionSettingsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignExtensionSettings:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignExtensionSettings:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -82,15 +83,16 @@ service CampaignExtensionSettingService {
}
// Request message for
-// [CampaignExtensionSettingService.MutateCampaignExtensionSettings][google.ads.googleads.v10.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings].
+// [CampaignExtensionSettingService.MutateCampaignExtensionSettings][google.ads.googleads.v13.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings].
message MutateCampaignExtensionSettingsRequest {
- // Required. The ID of the customer whose campaign extension settings are being
- // modified.
+ // Required. The ID of the customer whose campaign extension settings are
+ // being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual campaign extension
- // settings.
- repeated CampaignExtensionSettingOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual campaign
+ // extension settings.
+ repeated CampaignExtensionSettingOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -104,7 +106,8 @@ message MutateCampaignExtensionSettingsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a campaign extension setting.
@@ -116,19 +119,19 @@ message CampaignExtensionSettingOperation {
oneof operation {
// Create operation: No resource name is expected for the new campaign
// extension setting.
- google.ads.googleads.v10.resources.CampaignExtensionSetting create = 1;
+ google.ads.googleads.v13.resources.CampaignExtensionSetting create = 1;
// Update operation: The campaign extension setting is expected to have a
// valid resource name.
- google.ads.googleads.v10.resources.CampaignExtensionSetting update = 2;
+ google.ads.googleads.v13.resources.CampaignExtensionSetting update = 2;
// Remove operation: A resource name for the removed campaign extension
// setting is expected, in this format:
//
// `customers/{customer_id}/campaignExtensionSettings/{campaign_id}~{extension_type}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignExtensionSetting"
- }];
+ type: "googleads.googleapis.com/CampaignExtensionSetting"
+ }];
}
}
@@ -136,8 +139,8 @@ message CampaignExtensionSettingOperation {
message MutateCampaignExtensionSettingsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -148,11 +151,12 @@ message MutateCampaignExtensionSettingsResponse {
message MutateCampaignExtensionSettingResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignExtensionSetting"
- }];
+ type: "googleads.googleapis.com/CampaignExtensionSetting"
+ }];
// The mutated campaign extension setting with only mutable fields after
// mutate. The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignExtensionSetting campaign_extension_setting = 2;
+ google.ads.googleads.v13.resources.CampaignExtensionSetting
+ campaign_extension_setting = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_feed_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_feed_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_feed_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_feed_service.proto
index 6a0c1bdc1..eab730c12 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_feed_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_feed_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_feed.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign_feed.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignFeedServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CampaignFeed service.
@@ -68,22 +68,25 @@ service CampaignFeedService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateCampaignFeeds(MutateCampaignFeedsRequest) returns (MutateCampaignFeedsResponse) {
+ rpc MutateCampaignFeeds(MutateCampaignFeedsRequest)
+ returns (MutateCampaignFeedsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignFeeds:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignFeeds:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CampaignFeedService.MutateCampaignFeeds][google.ads.googleads.v10.services.CampaignFeedService.MutateCampaignFeeds].
+// Request message for
+// [CampaignFeedService.MutateCampaignFeeds][google.ads.googleads.v13.services.CampaignFeedService.MutateCampaignFeeds].
message MutateCampaignFeedsRequest {
// Required. The ID of the customer whose campaign feeds are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual campaign feeds.
- repeated CampaignFeedOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CampaignFeedOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -97,7 +100,8 @@ message MutateCampaignFeedsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a campaign feed.
@@ -108,19 +112,19 @@ message CampaignFeedOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new campaign feed.
- google.ads.googleads.v10.resources.CampaignFeed create = 1;
+ google.ads.googleads.v13.resources.CampaignFeed create = 1;
// Update operation: The campaign feed is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.CampaignFeed update = 2;
+ google.ads.googleads.v13.resources.CampaignFeed update = 2;
// Remove operation: A resource name for the removed campaign feed is
// expected, in this format:
//
// `customers/{customer_id}/campaignFeeds/{campaign_id}~{feed_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignFeed"
- }];
+ type: "googleads.googleapis.com/CampaignFeed"
+ }];
}
}
@@ -128,8 +132,8 @@ message CampaignFeedOperation {
message MutateCampaignFeedsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -140,11 +144,11 @@ message MutateCampaignFeedsResponse {
message MutateCampaignFeedResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignFeed"
- }];
+ type: "googleads.googleapis.com/CampaignFeed"
+ }];
// The mutated campaign feed with only mutable fields after mutate. The field
// will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignFeed campaign_feed = 2;
+ google.ads.googleads.v13.resources.CampaignFeed campaign_feed = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_group_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_group_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_group_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_group_service.proto
index e6c6825c3..b2ab73bfc 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_group_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_group_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_group.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign_group.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignGroupServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Campaign group service.
@@ -43,22 +43,25 @@ service CampaignGroupService {
// Creates, updates, or removes campaign groups. Operation statuses are
// returned.
- rpc MutateCampaignGroups(MutateCampaignGroupsRequest) returns (MutateCampaignGroupsResponse) {
+ rpc MutateCampaignGroups(MutateCampaignGroupsRequest)
+ returns (MutateCampaignGroupsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignGroups:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignGroups:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CampaignGroupService.MutateCampaignGroups][google.ads.googleads.v10.services.CampaignGroupService.MutateCampaignGroups].
+// Request message for
+// [CampaignGroupService.MutateCampaignGroups][google.ads.googleads.v13.services.CampaignGroupService.MutateCampaignGroups].
message MutateCampaignGroupsRequest {
// Required. The ID of the customer whose campaign groups are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual campaign groups.
- repeated CampaignGroupOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CampaignGroupOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -72,7 +75,8 @@ message MutateCampaignGroupsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a campaign group.
@@ -84,19 +88,19 @@ message CampaignGroupOperation {
oneof operation {
// Create operation: No resource name is expected for the new campaign
// group.
- google.ads.googleads.v10.resources.CampaignGroup create = 1;
+ google.ads.googleads.v13.resources.CampaignGroup create = 1;
// Update operation: The campaign group is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.CampaignGroup update = 2;
+ google.ads.googleads.v13.resources.CampaignGroup update = 2;
// Remove operation: A resource name for the removed campaign group is
// expected, in this format:
//
// `customers/{customer_id}/campaignGroups/{campaign_group_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignGroup"
- }];
+ type: "googleads.googleapis.com/CampaignGroup"
+ }];
}
}
@@ -107,8 +111,8 @@ message MutateCampaignGroupsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
}
@@ -125,5 +129,5 @@ message MutateCampaignGroupResult {
// The mutated campaign group with only mutable fields after mutate. The field
// will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignGroup campaign_group = 2;
+ google.ads.googleads.v13.resources.CampaignGroup campaign_group = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_label_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_label_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_label_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_label_service.proto
index 7833c8969..e5f859de1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_label_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_label_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/campaign_label.proto";
+import "google/ads/googleads/v13/resources/campaign_label.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignLabelServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Campaign Label service.
@@ -54,22 +54,27 @@ service CampaignLabelService {
// [NewResourceCreationError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateCampaignLabels(MutateCampaignLabelsRequest) returns (MutateCampaignLabelsResponse) {
+ rpc MutateCampaignLabels(MutateCampaignLabelsRequest)
+ returns (MutateCampaignLabelsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignLabels:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignLabels:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CampaignLabelService.MutateCampaignLabels][google.ads.googleads.v10.services.CampaignLabelService.MutateCampaignLabels].
+// Request message for
+// [CampaignLabelService.MutateCampaignLabels][google.ads.googleads.v13.services.CampaignLabelService.MutateCampaignLabels].
message MutateCampaignLabelsRequest {
- // Required. ID of the customer whose campaign-label relationships are being modified.
+ // Required. ID of the customer whose campaign-label relationships are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on campaign-label relationships.
- repeated CampaignLabelOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on campaign-label
+ // relationships.
+ repeated CampaignLabelOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -88,15 +93,15 @@ message CampaignLabelOperation {
oneof operation {
// Create operation: No resource name is expected for the new campaign-label
// relationship.
- google.ads.googleads.v10.resources.CampaignLabel create = 1;
+ google.ads.googleads.v13.resources.CampaignLabel create = 1;
// Remove operation: A resource name for the campaign-label relationship
// being removed, in this format:
//
// `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignLabel"
- }];
+ type: "googleads.googleapis.com/CampaignLabel"
+ }];
}
}
@@ -104,8 +109,8 @@ message CampaignLabelOperation {
message MutateCampaignLabelsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -116,6 +121,6 @@ message MutateCampaignLabelsResponse {
message MutateCampaignLabelResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignLabel"
- }];
+ type: "googleads.googleapis.com/CampaignLabel"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_service.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_service.proto
index 4c32ea8ba..175f69c60 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Campaign service.
@@ -79,22 +79,25 @@ service CampaignService {
// [StringFormatError]()
// [StringLengthError]()
// [UrlFieldError]()
- rpc MutateCampaigns(MutateCampaignsRequest) returns (MutateCampaignsResponse) {
+ rpc MutateCampaigns(MutateCampaignsRequest)
+ returns (MutateCampaignsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaigns:mutate"
+ post: "/v13/customers/{customer_id=*}/campaigns:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CampaignService.MutateCampaigns][google.ads.googleads.v10.services.CampaignService.MutateCampaigns].
+// Request message for
+// [CampaignService.MutateCampaigns][google.ads.googleads.v13.services.CampaignService.MutateCampaigns].
message MutateCampaignsRequest {
// Required. The ID of the customer whose campaigns are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual campaigns.
- repeated CampaignOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CampaignOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -108,7 +111,8 @@ message MutateCampaignsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a campaign.
@@ -119,19 +123,19 @@ message CampaignOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new campaign.
- google.ads.googleads.v10.resources.Campaign create = 1;
+ google.ads.googleads.v13.resources.Campaign create = 1;
// Update operation: The campaign is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.Campaign update = 2;
+ google.ads.googleads.v13.resources.Campaign update = 2;
// Remove operation: A resource name for the removed campaign is
// expected, in this format:
//
// `customers/{customer_id}/campaigns/{campaign_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Campaign"
- }];
+ type: "googleads.googleapis.com/Campaign"
+ }];
}
}
@@ -139,8 +143,8 @@ message CampaignOperation {
message MutateCampaignsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -151,10 +155,10 @@ message MutateCampaignsResponse {
message MutateCampaignResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Campaign"
- }];
+ type: "googleads.googleapis.com/Campaign"
+ }];
// The mutated campaign with only mutable fields after mutate. The field will
// only be returned when response_content_type is set to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.Campaign campaign = 2;
+ google.ads.googleads.v13.resources.Campaign campaign = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/campaign_shared_set_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/campaign_shared_set_service.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/services/campaign_shared_set_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/campaign_shared_set_service.proto
index 7ce8b9774..482efe9d4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/campaign_shared_set_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/campaign_shared_set_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/campaign_shared_set.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/campaign_shared_set.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CampaignSharedSetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Campaign Shared Set service.
@@ -65,22 +65,27 @@ service CampaignSharedSetService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateCampaignSharedSets(MutateCampaignSharedSetsRequest) returns (MutateCampaignSharedSetsResponse) {
+ rpc MutateCampaignSharedSets(MutateCampaignSharedSetsRequest)
+ returns (MutateCampaignSharedSetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/campaignSharedSets:mutate"
+ post: "/v13/customers/{customer_id=*}/campaignSharedSets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CampaignSharedSetService.MutateCampaignSharedSets][google.ads.googleads.v10.services.CampaignSharedSetService.MutateCampaignSharedSets].
+// Request message for
+// [CampaignSharedSetService.MutateCampaignSharedSets][google.ads.googleads.v13.services.CampaignSharedSetService.MutateCampaignSharedSets].
message MutateCampaignSharedSetsRequest {
- // Required. The ID of the customer whose campaign shared sets are being modified.
+ // Required. The ID of the customer whose campaign shared sets are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual campaign shared sets.
- repeated CampaignSharedSetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual campaign shared
+ // sets.
+ repeated CampaignSharedSetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -94,24 +99,25 @@ message MutateCampaignSharedSetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
-// A single operation (create, remove) on an campaign shared set.
+// A single operation (create, remove) on a campaign shared set.
message CampaignSharedSetOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new campaign
// shared set.
- google.ads.googleads.v10.resources.CampaignSharedSet create = 1;
+ google.ads.googleads.v13.resources.CampaignSharedSet create = 1;
// Remove operation: A resource name for the removed campaign shared set is
// expected, in this format:
//
// `customers/{customer_id}/campaignSharedSets/{campaign_id}~{shared_set_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignSharedSet"
- }];
+ type: "googleads.googleapis.com/CampaignSharedSet"
+ }];
}
}
@@ -119,8 +125,8 @@ message CampaignSharedSetOperation {
message MutateCampaignSharedSetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -131,11 +137,11 @@ message MutateCampaignSharedSetsResponse {
message MutateCampaignSharedSetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CampaignSharedSet"
- }];
+ type: "googleads.googleapis.com/CampaignSharedSet"
+ }];
// The mutated campaign shared set with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CampaignSharedSet campaign_shared_set = 2;
+ google.ads.googleads.v13.resources.CampaignSharedSet campaign_shared_set = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/conversion_action_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/conversion_action_service.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/services/conversion_action_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/conversion_action_service.proto
index 2c19affa7..f55a2296b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/conversion_action_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/conversion_action_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/conversion_action.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/conversion_action.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ConversionActionServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Conversion Action service.
@@ -61,22 +61,27 @@ service ConversionActionService {
// [RequestError]()
// [ResourceCountLimitExceededError]()
// [StringLengthError]()
- rpc MutateConversionActions(MutateConversionActionsRequest) returns (MutateConversionActionsResponse) {
+ rpc MutateConversionActions(MutateConversionActionsRequest)
+ returns (MutateConversionActionsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/conversionActions:mutate"
+ post: "/v13/customers/{customer_id=*}/conversionActions:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [ConversionActionService.MutateConversionActions][google.ads.googleads.v10.services.ConversionActionService.MutateConversionActions].
+// Request message for
+// [ConversionActionService.MutateConversionActions][google.ads.googleads.v13.services.ConversionActionService.MutateConversionActions].
message MutateConversionActionsRequest {
- // Required. The ID of the customer whose conversion actions are being modified.
+ // Required. The ID of the customer whose conversion actions are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual conversion actions.
- repeated ConversionActionOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual conversion
+ // actions.
+ repeated ConversionActionOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -90,7 +95,8 @@ message MutateConversionActionsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a conversion action.
@@ -102,28 +108,29 @@ message ConversionActionOperation {
oneof operation {
// Create operation: No resource name is expected for the new conversion
// action.
- google.ads.googleads.v10.resources.ConversionAction create = 1;
+ google.ads.googleads.v13.resources.ConversionAction create = 1;
// Update operation: The conversion action is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.ConversionAction update = 2;
+ google.ads.googleads.v13.resources.ConversionAction update = 2;
// Remove operation: A resource name for the removed conversion action is
// expected, in this format:
//
// `customers/{customer_id}/conversionActions/{conversion_action_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionAction"
- }];
+ type: "googleads.googleapis.com/ConversionAction"
+ }];
}
}
-// Response message for [ConversionActionService.MutateConversionActions][google.ads.googleads.v10.services.ConversionActionService.MutateConversionActions].
+// Response message for
+// [ConversionActionService.MutateConversionActions][google.ads.googleads.v13.services.ConversionActionService.MutateConversionActions].
message MutateConversionActionsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -134,11 +141,11 @@ message MutateConversionActionsResponse {
message MutateConversionActionResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionAction"
- }];
+ type: "googleads.googleapis.com/ConversionAction"
+ }];
// The mutated conversion action with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.ConversionAction conversion_action = 2;
+ google.ads.googleads.v13.resources.ConversionAction conversion_action = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/conversion_adjustment_upload_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/conversion_adjustment_upload_service.proto
similarity index 82%
rename from third_party/googleapis/google/ads/googleads/v10/services/conversion_adjustment_upload_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/conversion_adjustment_upload_service.proto
index 3aa68eec7..26618419e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/conversion_adjustment_upload_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/conversion_adjustment_upload_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/common/offline_user_data.proto";
-import "google/ads/googleads/v10/enums/conversion_adjustment_type.proto";
+import "google/ads/googleads/v13/common/offline_user_data.proto";
+import "google/ads/googleads/v13/enums/conversion_adjustment_type.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ConversionAdjustmentUploadServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Service to upload conversion adjustments.
service ConversionAdjustmentUploadService {
@@ -47,23 +47,26 @@ service ConversionAdjustmentUploadService {
// [PartialFailureError]()
// [QuotaError]()
// [RequestError]()
- rpc UploadConversionAdjustments(UploadConversionAdjustmentsRequest) returns (UploadConversionAdjustmentsResponse) {
+ rpc UploadConversionAdjustments(UploadConversionAdjustmentsRequest)
+ returns (UploadConversionAdjustmentsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:uploadConversionAdjustments"
+ post: "/v13/customers/{customer_id=*}:uploadConversionAdjustments"
body: "*"
};
- option (google.api.method_signature) = "customer_id,conversion_adjustments,partial_failure";
+ option (google.api.method_signature) =
+ "customer_id,conversion_adjustments,partial_failure";
}
}
// Request message for
-// [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v10.services.ConversionAdjustmentUploadService.UploadConversionAdjustments].
+// [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v13.services.ConversionAdjustmentUploadService.UploadConversionAdjustments].
message UploadConversionAdjustmentsRequest {
// Required. The ID of the customer performing the upload.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The conversion adjustments that are being uploaded.
- repeated ConversionAdjustment conversion_adjustments = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated ConversionAdjustment conversion_adjustments = 2
+ [(google.api.field_behavior) = REQUIRED];
// Required. If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried out
@@ -80,13 +83,12 @@ message UploadConversionAdjustmentsRequest {
}
// Response message for
-// [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v10.services.ConversionAdjustmentUploadService.UploadConversionAdjustments].
+// [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v13.services.ConversionAdjustmentUploadService.UploadConversionAdjustments].
message UploadConversionAdjustmentsResponse {
// Errors that pertain to conversion adjustment failures in the partial
// failure mode. Returned when all errors occur inside the adjustments. If any
- // errors occur outside the adjustments (e.g. auth errors), we return an RPC
- // level error.
- // See
+ // errors occur outside the adjustments (for example, auth errors), we return
+ // an RPC level error. See
// https://developers.google.com/google-ads/api/docs/best-practices/partial-failures
// for more information about partial failure.
google.rpc.Status partial_failure_error = 1;
@@ -117,11 +119,12 @@ message ConversionAdjustment {
// The date time at which the adjustment occurred. Must be after the
// conversion_date_time. The timezone must be specified. The format is
- // "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
+ // "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
optional string adjustment_date_time = 9;
// The adjustment type.
- google.ads.googleads.v10.enums.ConversionAdjustmentTypeEnum.ConversionAdjustmentType adjustment_type = 5;
+ google.ads.googleads.v13.enums.ConversionAdjustmentTypeEnum
+ .ConversionAdjustmentType adjustment_type = 5;
// Information needed to restate the conversion's value.
// Required for restatements. Should not be supplied for retractions. An error
@@ -136,7 +139,7 @@ message ConversionAdjustment {
// ConversionAdjustmentUploadService only accepts user identifiers in
// enhancements. The maximum number of user identifiers for each
// enhancement is 5.
- repeated google.ads.googleads.v10.common.UserIdentifier user_identifiers = 10;
+ repeated google.ads.googleads.v13.common.UserIdentifier user_identifiers = 10;
// The user agent to enhance the original conversion. This can be found in
// your user's HTTP request header when they convert on your web page.
@@ -162,7 +165,7 @@ message RestatementValue {
// The currency of the restated value. If not provided, then the default
// currency from the conversion action is used, and if that is not set then
// the account currency is used. This is the ISO 4217 3-character currency
- // code e.g. USD or EUR.
+ // code for example, USD or EUR.
optional string currency_code = 4;
}
@@ -175,7 +178,7 @@ message GclidDateTimePair {
// The date time at which the original conversion for this adjustment
// occurred. The timezone must be specified. The format is "yyyy-mm-dd
- // hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
+ // hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
optional string conversion_date_time = 4;
}
@@ -192,9 +195,10 @@ message ConversionAdjustmentResult {
optional string conversion_action = 7;
// The date time at which the adjustment occurred. The format is
- // "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
+ // "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
optional string adjustment_date_time = 8;
// The adjustment type.
- google.ads.googleads.v10.enums.ConversionAdjustmentTypeEnum.ConversionAdjustmentType adjustment_type = 5;
+ google.ads.googleads.v13.enums.ConversionAdjustmentTypeEnum
+ .ConversionAdjustmentType adjustment_type = 5;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/conversion_custom_variable_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/conversion_custom_variable_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/conversion_custom_variable_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/conversion_custom_variable_service.proto
index 22f28417e..ab353bba1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/conversion_custom_variable_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/conversion_custom_variable_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/conversion_custom_variable.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/conversion_custom_variable.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ConversionCustomVariableServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Conversion Custom Variable service.
@@ -53,9 +53,10 @@ service ConversionCustomVariableService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateConversionCustomVariables(MutateConversionCustomVariablesRequest) returns (MutateConversionCustomVariablesResponse) {
+ rpc MutateConversionCustomVariables(MutateConversionCustomVariablesRequest)
+ returns (MutateConversionCustomVariablesResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/conversionCustomVariables:mutate"
+ post: "/v13/customers/{customer_id=*}/conversionCustomVariables:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -63,15 +64,16 @@ service ConversionCustomVariableService {
}
// Request message for
-// [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v10.services.ConversionCustomVariableService.MutateConversionCustomVariables].
+// [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v13.services.ConversionCustomVariableService.MutateConversionCustomVariables].
message MutateConversionCustomVariablesRequest {
- // Required. The ID of the customer whose conversion custom variables are being
- // modified.
+ // Required. The ID of the customer whose conversion custom variables are
+ // being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual conversion custom
// variables.
- repeated ConversionCustomVariableOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated ConversionCustomVariableOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -85,7 +87,8 @@ message MutateConversionCustomVariablesRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update) on a conversion custom variable.
@@ -97,21 +100,21 @@ message ConversionCustomVariableOperation {
oneof operation {
// Create operation: No resource name is expected for the new conversion
// custom variable.
- google.ads.googleads.v10.resources.ConversionCustomVariable create = 1;
+ google.ads.googleads.v13.resources.ConversionCustomVariable create = 1;
// Update operation: The conversion custom variable is expected to have a
// valid resource name.
- google.ads.googleads.v10.resources.ConversionCustomVariable update = 2;
+ google.ads.googleads.v13.resources.ConversionCustomVariable update = 2;
}
}
// Response message for
-// [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v10.services.ConversionCustomVariableService.MutateConversionCustomVariables].
+// [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v13.services.ConversionCustomVariableService.MutateConversionCustomVariables].
message MutateConversionCustomVariablesResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 1;
// All results for the mutate.
@@ -122,11 +125,12 @@ message MutateConversionCustomVariablesResponse {
message MutateConversionCustomVariableResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionCustomVariable"
- }];
+ type: "googleads.googleapis.com/ConversionCustomVariable"
+ }];
// The mutated conversion custom variable with only mutable fields after
// mutate. The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.ConversionCustomVariable conversion_custom_variable = 2;
+ google.ads.googleads.v13.resources.ConversionCustomVariable
+ conversion_custom_variable = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/conversion_goal_campaign_config_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/conversion_goal_campaign_config_service.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/services/conversion_goal_campaign_config_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/conversion_goal_campaign_config_service.proto
index d582a0af4..22a7676c8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/conversion_goal_campaign_config_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/conversion_goal_campaign_config_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/conversion_goal_campaign_config.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/conversion_goal_campaign_config.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ConversionGoalCampaignConfigServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the ConversionGoalCampaignConfig service.
@@ -42,9 +42,11 @@ service ConversionGoalCampaignConfigService {
// Creates, updates or removes conversion goal campaign config. Operation
// statuses are returned.
- rpc MutateConversionGoalCampaignConfigs(MutateConversionGoalCampaignConfigsRequest) returns (MutateConversionGoalCampaignConfigsResponse) {
+ rpc MutateConversionGoalCampaignConfigs(
+ MutateConversionGoalCampaignConfigsRequest)
+ returns (MutateConversionGoalCampaignConfigsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate"
+ post: "/v13/customers/{customer_id=*}/conversionGoalCampaignConfigs:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -54,12 +56,14 @@ service ConversionGoalCampaignConfigService {
// Request message for
// [ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfig][].
message MutateConversionGoalCampaignConfigsRequest {
- // Required. The ID of the customer whose custom conversion goals are being modified.
+ // Required. The ID of the customer whose custom conversion goals are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual conversion goal campaign
- // config.
- repeated ConversionGoalCampaignConfigOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual conversion goal
+ // campaign config.
+ repeated ConversionGoalCampaignConfigOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -67,7 +71,8 @@ message MutateConversionGoalCampaignConfigsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 4;
}
// A single operation (update) on a conversion goal campaign config.
@@ -79,7 +84,7 @@ message ConversionGoalCampaignConfigOperation {
oneof operation {
// Update operation: The conversion goal campaign config is expected to have
// a valid resource name.
- google.ads.googleads.v10.resources.ConversionGoalCampaignConfig update = 1;
+ google.ads.googleads.v13.resources.ConversionGoalCampaignConfig update = 1;
}
}
@@ -93,11 +98,12 @@ message MutateConversionGoalCampaignConfigsResponse {
message MutateConversionGoalCampaignConfigResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionGoalCampaignConfig"
- }];
+ type: "googleads.googleapis.com/ConversionGoalCampaignConfig"
+ }];
// The mutated ConversionGoalCampaignConfig with only mutable fields after
// mutate. The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.ConversionGoalCampaignConfig conversion_goal_campaign_config = 2;
+ google.ads.googleads.v13.resources.ConversionGoalCampaignConfig
+ conversion_goal_campaign_config = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/conversion_upload_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/conversion_upload_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/conversion_upload_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/conversion_upload_service.proto
index 707407144..a70e1caa9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/conversion_upload_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/conversion_upload_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/common/offline_user_data.proto";
-import "google/ads/googleads/v10/enums/conversion_environment_enum.proto";
+import "google/ads/googleads/v13/common/offline_user_data.proto";
+import "google/ads/googleads/v13/enums/conversion_environment_enum.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ConversionUploadServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Service to upload conversions.
service ConversionUploadService {
@@ -49,12 +49,14 @@ service ConversionUploadService {
// [PartialFailureError]()
// [QuotaError]()
// [RequestError]()
- rpc UploadClickConversions(UploadClickConversionsRequest) returns (UploadClickConversionsResponse) {
+ rpc UploadClickConversions(UploadClickConversionsRequest)
+ returns (UploadClickConversionsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:uploadClickConversions"
+ post: "/v13/customers/{customer_id=*}:uploadClickConversions"
body: "*"
};
- option (google.api.method_signature) = "customer_id,conversions,partial_failure";
+ option (google.api.method_signature) =
+ "customer_id,conversions,partial_failure";
}
// Processes the given call conversions.
@@ -67,22 +69,26 @@ service ConversionUploadService {
// [PartialFailureError]()
// [QuotaError]()
// [RequestError]()
- rpc UploadCallConversions(UploadCallConversionsRequest) returns (UploadCallConversionsResponse) {
+ rpc UploadCallConversions(UploadCallConversionsRequest)
+ returns (UploadCallConversionsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:uploadCallConversions"
+ post: "/v13/customers/{customer_id=*}:uploadCallConversions"
body: "*"
};
- option (google.api.method_signature) = "customer_id,conversions,partial_failure";
+ option (google.api.method_signature) =
+ "customer_id,conversions,partial_failure";
}
}
-// Request message for [ConversionUploadService.UploadClickConversions][google.ads.googleads.v10.services.ConversionUploadService.UploadClickConversions].
+// Request message for
+// [ConversionUploadService.UploadClickConversions][google.ads.googleads.v13.services.ConversionUploadService.UploadClickConversions].
message UploadClickConversionsRequest {
// Required. The ID of the customer performing the upload.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The conversions that are being uploaded.
- repeated ClickConversion conversions = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated ClickConversion conversions = 2
+ [(google.api.field_behavior) = REQUIRED];
// Required. If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -96,14 +102,35 @@ message UploadClickConversionsRequest {
// If true, the request is validated but not executed. Only errors are
// returned, not results.
bool validate_only = 4;
+
+ // If true, the API will perform all upload checks and return errors if
+ // any are found. If false, it will perform only basic input validation,
+ // skip subsequent upload checks, and return success even if no click
+ // was found for the provided `user_identifiers`.
+ //
+ // This setting only affects Enhanced conversions for leads uploads that use
+ // `user_identifiers` instead of `GCLID`, `GBRAID`, or `WBRAID`. When
+ // uploading enhanced conversions for leads, you should upload all conversion
+ // events to the API, including those that may not come from Google Ads
+ // campaigns. The upload of an event that is not from a Google Ads campaign
+ // will result in a `CLICK_NOT_FOUND` error if this field is set to `true`.
+ // Since these errors are expected for such events, set this field to `false`
+ // so you can confirm your uploads are properly formatted but ignore
+ // `CLICK_NOT_FOUND` errors from all of the conversions that are not from a
+ // Google Ads campaign. This will allow you to focus only on errors that you
+ // can address.
+ //
+ // Default is false.
+ bool debug_enabled = 5;
}
-// Response message for [ConversionUploadService.UploadClickConversions][google.ads.googleads.v10.services.ConversionUploadService.UploadClickConversions].
+// Response message for
+// [ConversionUploadService.UploadClickConversions][google.ads.googleads.v13.services.ConversionUploadService.UploadClickConversions].
message UploadClickConversionsResponse {
// Errors that pertain to conversion failures in the partial failure mode.
// Returned when all errors occur inside the conversions. If any errors occur
- // outside the conversions (e.g. auth errors), we return an RPC level error.
- // See
+ // outside the conversions (for example, auth errors), we return an RPC level
+ // error. See
// https://developers.google.com/google-ads/api/docs/best-practices/partial-failures
// for more information about partial failure.
google.rpc.Status partial_failure_error = 1;
@@ -114,13 +141,15 @@ message UploadClickConversionsResponse {
repeated ClickConversionResult results = 2;
}
-// Request message for [ConversionUploadService.UploadCallConversions][google.ads.googleads.v10.services.ConversionUploadService.UploadCallConversions].
+// Request message for
+// [ConversionUploadService.UploadCallConversions][google.ads.googleads.v13.services.ConversionUploadService.UploadCallConversions].
message UploadCallConversionsRequest {
// Required. The ID of the customer performing the upload.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The conversions that are being uploaded.
- repeated CallConversion conversions = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CallConversion conversions = 2
+ [(google.api.field_behavior) = REQUIRED];
// Required. If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -136,12 +165,13 @@ message UploadCallConversionsRequest {
bool validate_only = 4;
}
-// Response message for [ConversionUploadService.UploadCallConversions][google.ads.googleads.v10.services.ConversionUploadService.UploadCallConversions].
+// Response message for
+// [ConversionUploadService.UploadCallConversions][google.ads.googleads.v13.services.ConversionUploadService.UploadCallConversions].
message UploadCallConversionsResponse {
// Errors that pertain to conversion failures in the partial failure mode.
// Returned when all errors occur inside the conversions. If any errors occur
- // outside the conversions (e.g. auth errors), we return an RPC level error.
- // See
+ // outside the conversions (for example, auth errors), we return an RPC level
+ // error. See
// https://developers.google.com/google-ads/api/docs/best-practices/partial-failures
// for more information about partial failure.
google.rpc.Status partial_failure_error = 1;
@@ -173,7 +203,7 @@ message ClickConversion {
// The date time at which the conversion occurred. Must be after
// the click time. The timezone must be specified. The format is
- // "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
+ // "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
optional string conversion_date_time = 11;
// The value of the conversion for the advertiser.
@@ -201,21 +231,22 @@ message ClickConversion {
// The user identifiers associated with this conversion. Only hashed_email and
// hashed_phone_number are supported for conversion uploads. The maximum
// number of user identifiers for each conversion is 5.
- repeated google.ads.googleads.v10.common.UserIdentifier user_identifiers = 17;
+ repeated google.ads.googleads.v13.common.UserIdentifier user_identifiers = 17;
- // The environment this conversion was recorded on. e.g. App or Web.
- google.ads.googleads.v10.enums.ConversionEnvironmentEnum.ConversionEnvironment conversion_environment = 20;
+ // The environment this conversion was recorded on, for example, App or Web.
+ google.ads.googleads.v13.enums.ConversionEnvironmentEnum.ConversionEnvironment
+ conversion_environment = 20;
}
// A call conversion.
message CallConversion {
// The caller id from which this call was placed. Caller id is expected to be
- // in E.164 format with preceding '+' sign. e.g. "+16502531234".
+ // in E.164 format with preceding '+' sign, for example, "+16502531234".
optional string caller_id = 7;
// The date time at which the call occurred. The timezone must be specified.
// The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm",
- // e.g. "2019-01-01 12:32:45-08:00".
+ // for example, "2019-01-01 12:32:45-08:00".
optional string call_start_date_time = 8;
// Resource name of the conversion action associated with this conversion.
@@ -226,7 +257,7 @@ message CallConversion {
// The date time at which the conversion occurred. Must be after the call
// time. The timezone must be specified. The format is
- // "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
+ // "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
optional string conversion_date_time = 10;
// The value of the conversion for the advertiser.
@@ -267,13 +298,13 @@ message ClickConversionResult {
optional string conversion_action = 5;
// The date time at which the conversion occurred. The format is
- // "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
+ // "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
optional string conversion_date_time = 6;
// The user identifiers associated with this conversion. Only hashed_email and
// hashed_phone_number are supported for conversion uploads. The maximum
// number of user identifiers for each conversion is 5.
- repeated google.ads.googleads.v10.common.UserIdentifier user_identifiers = 7;
+ repeated google.ads.googleads.v13.common.UserIdentifier user_identifiers = 7;
}
// Identifying information for a successfully processed CallConversionUpload.
@@ -283,14 +314,14 @@ message CallConversionResult {
optional string caller_id = 5;
// The date time at which the call occurred. The format is
- // "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
+ // "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
optional string call_start_date_time = 6;
// Resource name of the conversion action associated with this conversion.
optional string conversion_action = 7;
// The date time at which the conversion occurred. The format is
- // "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
+ // "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
optional string conversion_date_time = 8;
}
@@ -302,8 +333,8 @@ message CustomVariable {
// use the conversion custom variable id as the sole identifier of the
// conversion custom variable.
string conversion_custom_variable = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionCustomVariable"
- }];
+ type: "googleads.googleapis.com/ConversionCustomVariable"
+ }];
// The value string of this custom variable.
// The value of the custom variable should not contain private customer data,
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/conversion_value_rule_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/conversion_value_rule_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/conversion_value_rule_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/conversion_value_rule_service.proto
index 8ebe316aa..35628554c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/conversion_value_rule_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/conversion_value_rule_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/conversion_value_rule.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/conversion_value_rule.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ConversionValueRuleServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Conversion Value Rule service.
@@ -43,9 +43,10 @@ service ConversionValueRuleService {
// Creates, updates, or removes conversion value rules. Operation statuses are
// returned.
- rpc MutateConversionValueRules(MutateConversionValueRulesRequest) returns (MutateConversionValueRulesResponse) {
+ rpc MutateConversionValueRules(MutateConversionValueRulesRequest)
+ returns (MutateConversionValueRulesResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/conversionValueRules:mutate"
+ post: "/v13/customers/{customer_id=*}/conversionValueRules:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -53,13 +54,16 @@ service ConversionValueRuleService {
}
// Request message for
-// [ConversionValueRuleService.MutateConversionValueRules][google.ads.googleads.v10.services.ConversionValueRuleService.MutateConversionValueRules].
+// [ConversionValueRuleService.MutateConversionValueRules][google.ads.googleads.v13.services.ConversionValueRuleService.MutateConversionValueRules].
message MutateConversionValueRulesRequest {
- // Required. The ID of the customer whose conversion value rules are being modified.
+ // Required. The ID of the customer whose conversion value rules are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual conversion value rules.
- repeated ConversionValueRuleOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual conversion value
+ // rules.
+ repeated ConversionValueRuleOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -73,7 +77,8 @@ message MutateConversionValueRulesRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 4;
}
// A single operation (create, update, remove) on a conversion value rule.
@@ -85,32 +90,32 @@ message ConversionValueRuleOperation {
oneof operation {
// Create operation: No resource name is expected for the new conversion
// value rule.
- google.ads.googleads.v10.resources.ConversionValueRule create = 1;
+ google.ads.googleads.v13.resources.ConversionValueRule create = 1;
// Update operation: The conversion value rule is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.ConversionValueRule update = 2;
+ google.ads.googleads.v13.resources.ConversionValueRule update = 2;
// Remove operation: A resource name for the removed conversion value rule
// is expected, in this format:
//
// `customers/{customer_id}/conversionValueRules/{conversion_value_rule_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionValueRule"
- }];
+ type: "googleads.googleapis.com/ConversionValueRule"
+ }];
}
}
// Response message for
-// [ConversionValueRuleService.MutateConversionValueRules][google.ads.googleads.v10.services.ConversionValueRuleService.MutateConversionValueRules].
+// [ConversionValueRuleService.MutateConversionValueRules][google.ads.googleads.v13.services.ConversionValueRuleService.MutateConversionValueRules].
message MutateConversionValueRulesResponse {
// All results for the mutate.
repeated MutateConversionValueRuleResult results = 2;
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
}
@@ -118,11 +123,12 @@ message MutateConversionValueRulesResponse {
message MutateConversionValueRuleResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionValueRule"
- }];
+ type: "googleads.googleapis.com/ConversionValueRule"
+ }];
// The mutated conversion value rule with only mutable fields after
// mutate. The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.ConversionValueRule conversion_value_rule = 2;
+ google.ads.googleads.v13.resources.ConversionValueRule conversion_value_rule =
+ 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/conversion_value_rule_set_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/conversion_value_rule_set_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/conversion_value_rule_set_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/conversion_value_rule_set_service.proto
index 11cc208f0..9e51181de 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/conversion_value_rule_set_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/conversion_value_rule_set_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/conversion_value_rule_set.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/conversion_value_rule_set.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ConversionValueRuleSetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Conversion Value Rule Set service.
@@ -43,9 +43,10 @@ service ConversionValueRuleSetService {
// Creates, updates or removes conversion value rule sets. Operation statuses
// are returned.
- rpc MutateConversionValueRuleSets(MutateConversionValueRuleSetsRequest) returns (MutateConversionValueRuleSetsResponse) {
+ rpc MutateConversionValueRuleSets(MutateConversionValueRuleSetsRequest)
+ returns (MutateConversionValueRuleSetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/conversionValueRuleSets:mutate"
+ post: "/v13/customers/{customer_id=*}/conversionValueRuleSets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -53,13 +54,16 @@ service ConversionValueRuleSetService {
}
// Request message for
-// [ConversionValueRuleSetService.MutateConversionValueRuleSets][google.ads.googleads.v10.services.ConversionValueRuleSetService.MutateConversionValueRuleSets].
+// [ConversionValueRuleSetService.MutateConversionValueRuleSets][google.ads.googleads.v13.services.ConversionValueRuleSetService.MutateConversionValueRuleSets].
message MutateConversionValueRuleSetsRequest {
- // Required. The ID of the customer whose conversion value rule sets are being modified.
+ // Required. The ID of the customer whose conversion value rule sets are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual conversion value rule sets.
- repeated ConversionValueRuleSetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual conversion value
+ // rule sets.
+ repeated ConversionValueRuleSetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -73,7 +77,8 @@ message MutateConversionValueRuleSetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 4;
}
// A single operation (create, update, remove) on a conversion value rule set.
@@ -85,32 +90,32 @@ message ConversionValueRuleSetOperation {
oneof operation {
// Create operation: No resource name is expected for the new conversion
// value rule set.
- google.ads.googleads.v10.resources.ConversionValueRuleSet create = 1;
+ google.ads.googleads.v13.resources.ConversionValueRuleSet create = 1;
// Update operation: The conversion value rule set is expected to have a
// valid resource name.
- google.ads.googleads.v10.resources.ConversionValueRuleSet update = 2;
+ google.ads.googleads.v13.resources.ConversionValueRuleSet update = 2;
// Remove operation: A resource name for the removed conversion value rule
// set is expected, in this format:
//
// `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionValueRuleSet"
- }];
+ type: "googleads.googleapis.com/ConversionValueRuleSet"
+ }];
}
}
// Response message for
-// [ConversionValueRuleSetService.MutateConversionValueRuleSets][google.ads.googleads.v10.services.ConversionValueRuleSetService.MutateConversionValueRuleSets].
+// [ConversionValueRuleSetService.MutateConversionValueRuleSets][google.ads.googleads.v13.services.ConversionValueRuleSetService.MutateConversionValueRuleSets].
message MutateConversionValueRuleSetsResponse {
// All results for the mutate.
repeated MutateConversionValueRuleSetResult results = 1;
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -118,11 +123,12 @@ message MutateConversionValueRuleSetsResponse {
message MutateConversionValueRuleSetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ConversionValueRuleSet"
- }];
+ type: "googleads.googleapis.com/ConversionValueRuleSet"
+ }];
// The mutated conversion value rule set with only mutable fields after
// mutate. The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.ConversionValueRuleSet conversion_value_rule_set = 2;
+ google.ads.googleads.v13.resources.ConversionValueRuleSet
+ conversion_value_rule_set = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/custom_audience_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/custom_audience_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/custom_audience_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/custom_audience_service.proto
index ca4ee6be5..5751c9d42 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/custom_audience_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/custom_audience_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/custom_audience.proto";
+import "google/ads/googleads/v13/resources/custom_audience.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomAudienceServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Custom Audience service.
@@ -55,22 +55,25 @@ service CustomAudienceService {
// [PolicyViolationError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateCustomAudiences(MutateCustomAudiencesRequest) returns (MutateCustomAudiencesResponse) {
+ rpc MutateCustomAudiences(MutateCustomAudiencesRequest)
+ returns (MutateCustomAudiencesResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customAudiences:mutate"
+ post: "/v13/customers/{customer_id=*}/customAudiences:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CustomAudienceService.MutateCustomAudiences][google.ads.googleads.v10.services.CustomAudienceService.MutateCustomAudiences].
+// Request message for
+// [CustomAudienceService.MutateCustomAudiences][google.ads.googleads.v13.services.CustomAudienceService.MutateCustomAudiences].
message MutateCustomAudiencesRequest {
// Required. The ID of the customer whose custom audiences are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual custom audiences.
- repeated CustomAudienceOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CustomAudienceOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -86,19 +89,19 @@ message CustomAudienceOperation {
oneof operation {
// Create operation: No resource name is expected for the new custom
// audience.
- google.ads.googleads.v10.resources.CustomAudience create = 1;
+ google.ads.googleads.v13.resources.CustomAudience create = 1;
// Update operation: The custom audience is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.CustomAudience update = 2;
+ google.ads.googleads.v13.resources.CustomAudience update = 2;
// Remove operation: A resource name for the removed custom audience is
// expected, in this format:
//
// `customers/{customer_id}/customAudiences/{custom_audience_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomAudience"
- }];
+ type: "googleads.googleapis.com/CustomAudience"
+ }];
}
}
@@ -112,6 +115,6 @@ message MutateCustomAudiencesResponse {
message MutateCustomAudienceResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomAudience"
- }];
+ type: "googleads.googleapis.com/CustomAudience"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/custom_conversion_goal_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/custom_conversion_goal_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/custom_conversion_goal_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/custom_conversion_goal_service.proto
index 121632fa1..59f2d8f11 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/custom_conversion_goal_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/custom_conversion_goal_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/custom_conversion_goal.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/custom_conversion_goal.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomConversionGoalServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CustomConversionGoal service.
@@ -42,9 +42,10 @@ service CustomConversionGoalService {
// Creates, updates or removes custom conversion goals. Operation statuses
// are returned.
- rpc MutateCustomConversionGoals(MutateCustomConversionGoalsRequest) returns (MutateCustomConversionGoalsResponse) {
+ rpc MutateCustomConversionGoals(MutateCustomConversionGoalsRequest)
+ returns (MutateCustomConversionGoalsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customConversionGoals:mutate"
+ post: "/v13/customers/{customer_id=*}/customConversionGoals:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -52,13 +53,16 @@ service CustomConversionGoalService {
}
// Request message for
-// [CustomConversionGoalService.MutateCustomConversionGoals][google.ads.googleads.v10.services.CustomConversionGoalService.MutateCustomConversionGoals].
+// [CustomConversionGoalService.MutateCustomConversionGoals][google.ads.googleads.v13.services.CustomConversionGoalService.MutateCustomConversionGoals].
message MutateCustomConversionGoalsRequest {
- // Required. The ID of the customer whose custom conversion goals are being modified.
+ // Required. The ID of the customer whose custom conversion goals are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual custom conversion goal.
- repeated CustomConversionGoalOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual custom conversion
+ // goal.
+ repeated CustomConversionGoalOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -66,7 +70,8 @@ message MutateCustomConversionGoalsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 4;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 4;
}
// A single operation (create, remove) on a custom conversion goal.
@@ -78,19 +83,19 @@ message CustomConversionGoalOperation {
oneof operation {
// Create operation: No resource name is expected for the new custom
// conversion goal
- google.ads.googleads.v10.resources.CustomConversionGoal create = 1;
+ google.ads.googleads.v13.resources.CustomConversionGoal create = 1;
// Update operation: The custom conversion goal is expected to have a
// valid resource name.
- google.ads.googleads.v10.resources.CustomConversionGoal update = 2;
+ google.ads.googleads.v13.resources.CustomConversionGoal update = 2;
// Remove operation: A resource name for the removed custom conversion goal
// is expected, in this format:
//
// 'customers/{customer_id}/conversionActions/{ConversionGoal.custom_goal_config.conversion_type_ids}'
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomConversionGoal"
- }];
+ type: "googleads.googleapis.com/CustomConversionGoal"
+ }];
}
}
@@ -104,11 +109,12 @@ message MutateCustomConversionGoalsResponse {
message MutateCustomConversionGoalResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomConversionGoal"
- }];
+ type: "googleads.googleapis.com/CustomConversionGoal"
+ }];
// The mutated CustomConversionGoal with only mutable fields after mutate.
// The field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CustomConversionGoal custom_conversion_goal = 2;
+ google.ads.googleads.v13.resources.CustomConversionGoal
+ custom_conversion_goal = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/custom_interest_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/custom_interest_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/custom_interest_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/custom_interest_service.proto
index 5c451a5df..33c27561c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/custom_interest_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/custom_interest_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/custom_interest.proto";
+import "google/ads/googleads/v13/resources/custom_interest.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomInterestServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Custom Interest service.
@@ -53,22 +53,25 @@ service CustomInterestService {
// [QuotaError]()
// [RequestError]()
// [StringLengthError]()
- rpc MutateCustomInterests(MutateCustomInterestsRequest) returns (MutateCustomInterestsResponse) {
+ rpc MutateCustomInterests(MutateCustomInterestsRequest)
+ returns (MutateCustomInterestsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customInterests:mutate"
+ post: "/v13/customers/{customer_id=*}/customInterests:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CustomInterestService.MutateCustomInterests][google.ads.googleads.v10.services.CustomInterestService.MutateCustomInterests].
+// Request message for
+// [CustomInterestService.MutateCustomInterests][google.ads.googleads.v13.services.CustomInterestService.MutateCustomInterests].
message MutateCustomInterestsRequest {
// Required. The ID of the customer whose custom interests are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual custom interests.
- repeated CustomInterestOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CustomInterestOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -84,11 +87,11 @@ message CustomInterestOperation {
oneof operation {
// Create operation: No resource name is expected for the new custom
// interest.
- google.ads.googleads.v10.resources.CustomInterest create = 1;
+ google.ads.googleads.v13.resources.CustomInterest create = 1;
// Update operation: The custom interest is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.CustomInterest update = 2;
+ google.ads.googleads.v13.resources.CustomInterest update = 2;
}
}
@@ -102,6 +105,6 @@ message MutateCustomInterestsResponse {
message MutateCustomInterestResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomInterest"
- }];
+ type: "googleads.googleapis.com/CustomInterest"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_asset_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_asset_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_asset_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_asset_service.proto
index 9c5ea6a4a..38b12e4b0 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_asset_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_asset_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/customer_asset.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/customer_asset.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerAssetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CustomerAsset service.
@@ -54,22 +54,25 @@ service CustomerAssetService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateCustomerAssets(MutateCustomerAssetsRequest) returns (MutateCustomerAssetsResponse) {
+ rpc MutateCustomerAssets(MutateCustomerAssetsRequest)
+ returns (MutateCustomerAssetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customerAssets:mutate"
+ post: "/v13/customers/{customer_id=*}/customerAssets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CustomerAssetService.MutateCustomerAssets][google.ads.googleads.v10.services.CustomerAssetService.MutateCustomerAssets].
+// Request message for
+// [CustomerAssetService.MutateCustomerAssets][google.ads.googleads.v13.services.CustomerAssetService.MutateCustomerAssets].
message MutateCustomerAssetsRequest {
// Required. The ID of the customer whose customer assets are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual customer assets.
- repeated CustomerAssetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CustomerAssetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -83,7 +86,8 @@ message MutateCustomerAssetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a customer asset.
@@ -95,19 +99,19 @@ message CustomerAssetOperation {
oneof operation {
// Create operation: No resource name is expected for the new customer
// asset.
- google.ads.googleads.v10.resources.CustomerAsset create = 1;
+ google.ads.googleads.v13.resources.CustomerAsset create = 1;
// Update operation: The customer asset is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.CustomerAsset update = 3;
+ google.ads.googleads.v13.resources.CustomerAsset update = 3;
// Remove operation: A resource name for the removed customer asset is
// expected, in this format:
//
// `customers/{customer_id}/customerAssets/{asset_id}~{field_type}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerAsset"
- }];
+ type: "googleads.googleapis.com/CustomerAsset"
+ }];
}
}
@@ -115,8 +119,8 @@ message CustomerAssetOperation {
message MutateCustomerAssetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 1;
// All results for the mutate.
@@ -127,11 +131,11 @@ message MutateCustomerAssetsResponse {
message MutateCustomerAssetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerAsset"
- }];
+ type: "googleads.googleapis.com/CustomerAsset"
+ }];
// The mutated customer asset with only mutable fields after
// mutate. The field will only be returned when response_content_type is set
// to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CustomerAsset customer_asset = 2;
+ google.ads.googleads.v13.resources.CustomerAsset customer_asset = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/services/customer_asset_set_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_asset_set_service.proto
new file mode 100644
index 000000000..409293bbb
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_asset_set_service.proto
@@ -0,0 +1,123 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.services;
+
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/customer_asset_set.proto";
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/rpc/status.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
+option java_multiple_files = true;
+option java_outer_classname = "CustomerAssetSetServiceProto";
+option java_package = "com.google.ads.googleads.v13.services";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
+
+// Proto file describing the CustomerAssetSet service.
+
+// Service to manage customer asset set
+service CustomerAssetSetService {
+ option (google.api.default_host) = "googleads.googleapis.com";
+ option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";
+
+ // Creates, or removes customer asset sets. Operation statuses are
+ // returned.
+ rpc MutateCustomerAssetSets(MutateCustomerAssetSetsRequest)
+ returns (MutateCustomerAssetSetsResponse) {
+ option (google.api.http) = {
+ post: "/v13/customers/{customer_id=*}/customerAssetSets:mutate"
+ body: "*"
+ };
+ option (google.api.method_signature) = "customer_id,operations";
+ }
+}
+
+// Request message for
+// [CustomerAssetSetService.MutateCustomerAssetSets][google.ads.googleads.v13.services.CustomerAssetSetService.MutateCustomerAssetSets].
+message MutateCustomerAssetSetsRequest {
+ // Required. The ID of the customer whose customer asset sets are being
+ // modified.
+ string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The list of operations to perform on individual customer asset
+ // sets.
+ repeated CustomerAssetSetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
+
+ // If true, successful operations will be carried out and invalid
+ // operations will return errors. If false, all operations will be carried
+ // out in one transaction if and only if they are all valid.
+ // Default is false.
+ bool partial_failure = 3;
+
+ // If true, the request is validated but not executed. Only errors are
+ // returned, not results.
+ bool validate_only = 4;
+
+ // The response content type setting. Determines whether the mutable resource
+ // or just the resource name should be returned post mutation.
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
+}
+
+// A single operation (create, remove) on a customer asset set.
+message CustomerAssetSetOperation {
+ // The mutate operation.
+ oneof operation {
+ // Create operation: No resource name is expected for the new customer asset
+ // set.
+ google.ads.googleads.v13.resources.CustomerAssetSet create = 1;
+
+ // Remove operation: A resource name for the removed customer asset set is
+ // expected, in this format:
+ // `customers/{customer_id}/customerAssetSets/{asset_set_id}`
+ string remove = 2 [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/CustomerAssetSet"
+ }];
+ }
+}
+
+// Response message for a customer asset set mutate.
+message MutateCustomerAssetSetsResponse {
+ // All results for the mutate.
+ repeated MutateCustomerAssetSetResult results = 1;
+
+ // Errors that pertain to operation failures in the partial failure mode.
+ // Returned only when partial_failure = true and all errors occur inside the
+ // operations. If any errors occur outside the operations (e.g. auth errors),
+ // we return an RPC level error.
+ google.rpc.Status partial_failure_error = 2;
+}
+
+// The result for the customer asset set mutate.
+message MutateCustomerAssetSetResult {
+ // Returned for successful operations.
+ string resource_name = 1 [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/CustomerAssetSet"
+ }];
+
+ // The mutated customer asset set with only mutable fields after mutate. The
+ // field will only be returned when response_content_type is set to
+ // "MUTABLE_RESOURCE".
+ google.ads.googleads.v13.resources.CustomerAssetSet customer_asset_set = 2;
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_client_link_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_client_link_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_client_link_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_client_link_service.proto
index 592be55d7..30506df38 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_client_link_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_client_link_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/customer_client_link.proto";
+import "google/ads/googleads/v13/resources/customer_client_link.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerClientLinkServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Service to manage customer client links.
service CustomerClientLinkService {
@@ -52,22 +52,25 @@ service CustomerClientLinkService {
// [NewResourceCreationError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateCustomerClientLink(MutateCustomerClientLinkRequest) returns (MutateCustomerClientLinkResponse) {
+ rpc MutateCustomerClientLink(MutateCustomerClientLinkRequest)
+ returns (MutateCustomerClientLinkResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customerClientLinks:mutate"
+ post: "/v13/customers/{customer_id=*}/customerClientLinks:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operation";
}
}
-// Request message for [CustomerClientLinkService.MutateCustomerClientLink][google.ads.googleads.v10.services.CustomerClientLinkService.MutateCustomerClientLink].
+// Request message for
+// [CustomerClientLinkService.MutateCustomerClientLink][google.ads.googleads.v13.services.CustomerClientLinkService.MutateCustomerClientLink].
message MutateCustomerClientLinkRequest {
// Required. The ID of the customer whose customer link are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The operation to perform on the individual CustomerClientLink.
- CustomerClientLinkOperation operation = 2 [(google.api.field_behavior) = REQUIRED];
+ CustomerClientLinkOperation operation = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -82,10 +85,10 @@ message CustomerClientLinkOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new link.
- google.ads.googleads.v10.resources.CustomerClientLink create = 1;
+ google.ads.googleads.v13.resources.CustomerClientLink create = 1;
// Update operation: The link is expected to have a valid resource name.
- google.ads.googleads.v10.resources.CustomerClientLink update = 2;
+ google.ads.googleads.v13.resources.CustomerClientLink update = 2;
}
}
@@ -99,6 +102,6 @@ message MutateCustomerClientLinkResponse {
message MutateCustomerClientLinkResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerClientLink"
- }];
+ type: "googleads.googleapis.com/CustomerClientLink"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_conversion_goal_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_conversion_goal_service.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_conversion_goal_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_conversion_goal_service.proto
index 35bcf7b1c..f285bf17c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_conversion_goal_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_conversion_goal_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/customer_conversion_goal.proto";
+import "google/ads/googleads/v13/resources/customer_conversion_goal.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerConversionGoalServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CustomerConversionGoal service.
@@ -41,9 +41,10 @@ service CustomerConversionGoalService {
// Creates, updates or removes customer conversion goals. Operation statuses
// are returned.
- rpc MutateCustomerConversionGoals(MutateCustomerConversionGoalsRequest) returns (MutateCustomerConversionGoalsResponse) {
+ rpc MutateCustomerConversionGoals(MutateCustomerConversionGoalsRequest)
+ returns (MutateCustomerConversionGoalsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customerConversionGoals:mutate"
+ post: "/v13/customers/{customer_id=*}/customerConversionGoals:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -51,13 +52,16 @@ service CustomerConversionGoalService {
}
// Request message for
-// [CustomerConversionGoalService.MutateCustomerConversionGoals][google.ads.googleads.v10.services.CustomerConversionGoalService.MutateCustomerConversionGoals].
+// [CustomerConversionGoalService.MutateCustomerConversionGoals][google.ads.googleads.v13.services.CustomerConversionGoalService.MutateCustomerConversionGoals].
message MutateCustomerConversionGoalsRequest {
- // Required. The ID of the customer whose customer conversion goals are being modified.
+ // Required. The ID of the customer whose customer conversion goals are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual customer conversion goal.
- repeated CustomerConversionGoalOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual customer
+ // conversion goal.
+ repeated CustomerConversionGoalOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -73,7 +77,7 @@ message CustomerConversionGoalOperation {
oneof operation {
// Update operation: The customer conversion goal is expected to have a
// valid resource name.
- google.ads.googleads.v10.resources.CustomerConversionGoal update = 1;
+ google.ads.googleads.v13.resources.CustomerConversionGoal update = 1;
}
}
@@ -87,6 +91,6 @@ message MutateCustomerConversionGoalsResponse {
message MutateCustomerConversionGoalResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerConversionGoal"
- }];
+ type: "googleads.googleapis.com/CustomerConversionGoal"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_customizer_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_customizer_service.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_customizer_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_customizer_service.proto
index c8cce1917..67c2ae0cc 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_customizer_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_customizer_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/customer_customizer.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/customer_customizer.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerCustomizerServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CustomerCustomizer service.
@@ -42,9 +42,10 @@ service CustomerCustomizerService {
// Creates, updates or removes customer customizers. Operation statuses are
// returned.
- rpc MutateCustomerCustomizers(MutateCustomerCustomizersRequest) returns (MutateCustomerCustomizersResponse) {
+ rpc MutateCustomerCustomizers(MutateCustomerCustomizersRequest)
+ returns (MutateCustomerCustomizersResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/CustomerCustomizers:mutate"
+ post: "/v13/customers/{customer_id=*}/CustomerCustomizers:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -52,13 +53,16 @@ service CustomerCustomizerService {
}
// Request message for
-// [CustomerCustomizerService.MutateCustomerCustomizers][google.ads.googleads.v10.services.CustomerCustomizerService.MutateCustomerCustomizers].
+// [CustomerCustomizerService.MutateCustomerCustomizers][google.ads.googleads.v13.services.CustomerCustomizerService.MutateCustomerCustomizers].
message MutateCustomerCustomizersRequest {
- // Required. The ID of the customer whose customer customizers are being modified.
+ // Required. The ID of the customer whose customer customizers are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual customer customizers.
- repeated CustomerCustomizerOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual customer
+ // customizers.
+ repeated CustomerCustomizerOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -72,35 +76,36 @@ message MutateCustomerCustomizersRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
-// A single operation (create, remove) on an customizer attribute.
+// A single operation (create, remove) on a customizer attribute.
message CustomerCustomizerOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new customer
// customizer
- google.ads.googleads.v10.resources.CustomerCustomizer create = 1;
+ google.ads.googleads.v13.resources.CustomerCustomizer create = 1;
// Remove operation: A resource name for the removed customer customizer is
// expected, in this format:
// `customers/{customer_id}/customerCustomizers/{customizer_attribute_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerCustomizer"
- }];
+ type: "googleads.googleapis.com/CustomerCustomizer"
+ }];
}
}
-// Response message for an customizer attribute mutate.
+// Response message for a customizer attribute mutate.
message MutateCustomerCustomizersResponse {
// All results for the mutate.
repeated MutateCustomerCustomizerResult results = 1;
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -108,11 +113,11 @@ message MutateCustomerCustomizersResponse {
message MutateCustomerCustomizerResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerCustomizer"
- }];
+ type: "googleads.googleapis.com/CustomerCustomizer"
+ }];
// The mutated CustomerCustomizer with only mutable fields after mutate.
// The field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CustomerCustomizer customer_customizer = 2;
+ google.ads.googleads.v13.resources.CustomerCustomizer customer_customizer = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_extension_setting_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_extension_setting_service.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_extension_setting_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_extension_setting_service.proto
index a217afe3b..286953c4c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_extension_setting_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_extension_setting_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/customer_extension_setting.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/customer_extension_setting.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerExtensionSettingServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CustomerExtensionSetting service.
@@ -70,9 +70,10 @@ service CustomerExtensionSettingService {
// [StringFormatError]()
// [StringLengthError]()
// [UrlFieldError]()
- rpc MutateCustomerExtensionSettings(MutateCustomerExtensionSettingsRequest) returns (MutateCustomerExtensionSettingsResponse) {
+ rpc MutateCustomerExtensionSettings(MutateCustomerExtensionSettingsRequest)
+ returns (MutateCustomerExtensionSettingsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customerExtensionSettings:mutate"
+ post: "/v13/customers/{customer_id=*}/customerExtensionSettings:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -80,15 +81,16 @@ service CustomerExtensionSettingService {
}
// Request message for
-// [CustomerExtensionSettingService.MutateCustomerExtensionSettings][google.ads.googleads.v10.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings].
+// [CustomerExtensionSettingService.MutateCustomerExtensionSettings][google.ads.googleads.v13.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings].
message MutateCustomerExtensionSettingsRequest {
- // Required. The ID of the customer whose customer extension settings are being
- // modified.
+ // Required. The ID of the customer whose customer extension settings are
+ // being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual customer extension
- // settings.
- repeated CustomerExtensionSettingOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual customer
+ // extension settings.
+ repeated CustomerExtensionSettingOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -102,7 +104,8 @@ message MutateCustomerExtensionSettingsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a customer extension setting.
@@ -114,19 +117,19 @@ message CustomerExtensionSettingOperation {
oneof operation {
// Create operation: No resource name is expected for the new customer
// extension setting.
- google.ads.googleads.v10.resources.CustomerExtensionSetting create = 1;
+ google.ads.googleads.v13.resources.CustomerExtensionSetting create = 1;
// Update operation: The customer extension setting is expected to have a
// valid resource name.
- google.ads.googleads.v10.resources.CustomerExtensionSetting update = 2;
+ google.ads.googleads.v13.resources.CustomerExtensionSetting update = 2;
// Remove operation: A resource name for the removed customer extension
// setting is expected, in this format:
//
// `customers/{customer_id}/customerExtensionSettings/{extension_type}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerExtensionSetting"
- }];
+ type: "googleads.googleapis.com/CustomerExtensionSetting"
+ }];
}
}
@@ -134,8 +137,8 @@ message CustomerExtensionSettingOperation {
message MutateCustomerExtensionSettingsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -146,11 +149,12 @@ message MutateCustomerExtensionSettingsResponse {
message MutateCustomerExtensionSettingResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerExtensionSetting"
- }];
+ type: "googleads.googleapis.com/CustomerExtensionSetting"
+ }];
// The mutated CustomerExtensionSetting with only mutable fields after mutate.
// The field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CustomerExtensionSetting customer_extension_setting = 2;
+ google.ads.googleads.v13.resources.CustomerExtensionSetting
+ customer_extension_setting = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_feed_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_feed_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_feed_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_feed_service.proto
index 4a48a10f2..bffafd943 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_feed_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_feed_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/customer_feed.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/customer_feed.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerFeedServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CustomerFeed service.
@@ -67,22 +67,25 @@ service CustomerFeedService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateCustomerFeeds(MutateCustomerFeedsRequest) returns (MutateCustomerFeedsResponse) {
+ rpc MutateCustomerFeeds(MutateCustomerFeedsRequest)
+ returns (MutateCustomerFeedsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customerFeeds:mutate"
+ post: "/v13/customers/{customer_id=*}/customerFeeds:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CustomerFeedService.MutateCustomerFeeds][google.ads.googleads.v10.services.CustomerFeedService.MutateCustomerFeeds].
+// Request message for
+// [CustomerFeedService.MutateCustomerFeeds][google.ads.googleads.v13.services.CustomerFeedService.MutateCustomerFeeds].
message MutateCustomerFeedsRequest {
// Required. The ID of the customer whose customer feeds are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual customer feeds.
- repeated CustomerFeedOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CustomerFeedOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -96,7 +99,8 @@ message MutateCustomerFeedsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on a customer feed.
@@ -107,19 +111,19 @@ message CustomerFeedOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new customer feed.
- google.ads.googleads.v10.resources.CustomerFeed create = 1;
+ google.ads.googleads.v13.resources.CustomerFeed create = 1;
// Update operation: The customer feed is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.CustomerFeed update = 2;
+ google.ads.googleads.v13.resources.CustomerFeed update = 2;
// Remove operation: A resource name for the removed customer feed is
// expected, in this format:
//
// `customers/{customer_id}/customerFeeds/{feed_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerFeed"
- }];
+ type: "googleads.googleapis.com/CustomerFeed"
+ }];
}
}
@@ -127,8 +131,8 @@ message CustomerFeedOperation {
message MutateCustomerFeedsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -139,11 +143,11 @@ message MutateCustomerFeedsResponse {
message MutateCustomerFeedResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerFeed"
- }];
+ type: "googleads.googleapis.com/CustomerFeed"
+ }];
// The mutated customer feed with only mutable fields after mutate. The field
// will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CustomerFeed customer_feed = 2;
+ google.ads.googleads.v13.resources.CustomerFeed customer_feed = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_label_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_label_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_label_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_label_service.proto
index 07bedd9ce..3ce5bd1e8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_label_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_label_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/customer_label.proto";
+import "google/ads/googleads/v13/resources/customer_label.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerLabelServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Customer Label service.
@@ -52,22 +52,27 @@ service CustomerLabelService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateCustomerLabels(MutateCustomerLabelsRequest) returns (MutateCustomerLabelsResponse) {
+ rpc MutateCustomerLabels(MutateCustomerLabelsRequest)
+ returns (MutateCustomerLabelsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customerLabels:mutate"
+ post: "/v13/customers/{customer_id=*}/customerLabels:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [CustomerLabelService.MutateCustomerLabels][google.ads.googleads.v10.services.CustomerLabelService.MutateCustomerLabels].
+// Request message for
+// [CustomerLabelService.MutateCustomerLabels][google.ads.googleads.v13.services.CustomerLabelService.MutateCustomerLabels].
message MutateCustomerLabelsRequest {
- // Required. ID of the customer whose customer-label relationships are being modified.
+ // Required. ID of the customer whose customer-label relationships are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on customer-label relationships.
- repeated CustomerLabelOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on customer-label
+ // relationships.
+ repeated CustomerLabelOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -86,15 +91,15 @@ message CustomerLabelOperation {
oneof operation {
// Create operation: No resource name is expected for the new customer-label
// relationship.
- google.ads.googleads.v10.resources.CustomerLabel create = 1;
+ google.ads.googleads.v13.resources.CustomerLabel create = 1;
// Remove operation: A resource name for the customer-label relationship
// being removed, in this format:
//
// `customers/{customer_id}/customerLabels/{label_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerLabel"
- }];
+ type: "googleads.googleapis.com/CustomerLabel"
+ }];
}
}
@@ -102,8 +107,8 @@ message CustomerLabelOperation {
message MutateCustomerLabelsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -114,6 +119,6 @@ message MutateCustomerLabelsResponse {
message MutateCustomerLabelResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerLabel"
- }];
+ type: "googleads.googleapis.com/CustomerLabel"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_manager_link_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_manager_link_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_manager_link_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_manager_link_service.proto
index 88346e6b1..57599eb58 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_manager_link_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_manager_link_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/customer_manager_link.proto";
+import "google/ads/googleads/v13/resources/customer_manager_link.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerManagerLinkServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Service to manage customer-manager links.
service CustomerManagerLinkService {
@@ -51,9 +51,10 @@ service CustomerManagerLinkService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateCustomerManagerLink(MutateCustomerManagerLinkRequest) returns (MutateCustomerManagerLinkResponse) {
+ rpc MutateCustomerManagerLink(MutateCustomerManagerLinkRequest)
+ returns (MutateCustomerManagerLinkResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customerManagerLinks:mutate"
+ post: "/v13/customers/{customer_id=*}/customerManagerLinks:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -61,7 +62,7 @@ service CustomerManagerLinkService {
// Moves a client customer to a new manager customer.
// This simplifies the complex request that requires two operations to move
- // a client customer to a new manager. i.e:
+ // a client customer to a new manager, for example:
// 1. Update operation with Status INACTIVE (previous manager) and,
// 2. Update operation with Status ACTIVE (new manager).
//
@@ -75,29 +76,36 @@ service CustomerManagerLinkService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc MoveManagerLink(MoveManagerLinkRequest) returns (MoveManagerLinkResponse) {
+ rpc MoveManagerLink(MoveManagerLinkRequest)
+ returns (MoveManagerLinkResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customerManagerLinks:moveManagerLink"
+ post: "/v13/customers/{customer_id=*}/customerManagerLinks:moveManagerLink"
body: "*"
};
- option (google.api.method_signature) = "customer_id,previous_customer_manager_link,new_manager";
+ option (google.api.method_signature) =
+ "customer_id,previous_customer_manager_link,new_manager";
}
}
-// Request message for [CustomerManagerLinkService.MutateCustomerManagerLink][google.ads.googleads.v10.services.CustomerManagerLinkService.MutateCustomerManagerLink].
+// Request message for
+// [CustomerManagerLinkService.MutateCustomerManagerLink][google.ads.googleads.v13.services.CustomerManagerLinkService.MutateCustomerManagerLink].
message MutateCustomerManagerLinkRequest {
- // Required. The ID of the customer whose customer manager links are being modified.
+ // Required. The ID of the customer whose customer manager links are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual customer manager links.
- repeated CustomerManagerLinkOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual customer manager
+ // links.
+ repeated CustomerManagerLinkOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
bool validate_only = 3;
}
-// Request message for [CustomerManagerLinkService.MoveManagerLink][google.ads.googleads.v10.services.CustomerManagerLinkService.MoveManagerLink].
+// Request message for
+// [CustomerManagerLinkService.MoveManagerLink][google.ads.googleads.v13.services.CustomerManagerLinkService.MoveManagerLink].
message MoveManagerLinkRequest {
// Required. The ID of the client customer that is being moved.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
@@ -105,10 +113,12 @@ message MoveManagerLinkRequest {
// Required. The resource name of the previous CustomerManagerLink.
// The resource name has the form:
// `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`
- string previous_customer_manager_link = 2 [(google.api.field_behavior) = REQUIRED];
+ string previous_customer_manager_link = 2
+ [(google.api.field_behavior) = REQUIRED];
- // Required. The resource name of the new manager customer that the client wants to move
- // to. Customer resource names have the format: "customers/{customer_id}"
+ // Required. The resource name of the new manager customer that the client
+ // wants to move to. Customer resource names have the format:
+ // "customers/{customer_id}"
string new_manager = 3 [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
@@ -128,7 +138,7 @@ message CustomerManagerLinkOperation {
// The mutate operation.
oneof operation {
// Update operation: The link is expected to have a valid resource name.
- google.ads.googleads.v10.resources.CustomerManagerLink update = 2;
+ google.ads.googleads.v13.resources.CustomerManagerLink update = 2;
}
}
@@ -144,14 +154,14 @@ message MoveManagerLinkResponse {
// resource of the newly created link between client customer and new manager
// customer.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerManagerLink"
- }];
+ type: "googleads.googleapis.com/CustomerManagerLink"
+ }];
}
// The result for the customer manager link mutate.
message MutateCustomerManagerLinkResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerManagerLink"
- }];
+ type: "googleads.googleapis.com/CustomerManagerLink"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_negative_criterion_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_negative_criterion_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_negative_criterion_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_negative_criterion_service.proto
index 03480990a..7ad929fa9 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_negative_criterion_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_negative_criterion_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/customer_negative_criterion.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/customer_negative_criterion.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerNegativeCriterionServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Customer Negative Criterion service.
@@ -53,9 +53,10 @@ service CustomerNegativeCriterionService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateCustomerNegativeCriteria(MutateCustomerNegativeCriteriaRequest) returns (MutateCustomerNegativeCriteriaResponse) {
+ rpc MutateCustomerNegativeCriteria(MutateCustomerNegativeCriteriaRequest)
+ returns (MutateCustomerNegativeCriteriaResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customerNegativeCriteria:mutate"
+ post: "/v13/customers/{customer_id=*}/customerNegativeCriteria:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -63,13 +64,14 @@ service CustomerNegativeCriterionService {
}
// Request message for
-// [CustomerNegativeCriterionService.MutateCustomerNegativeCriteria][google.ads.googleads.v10.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria].
+// [CustomerNegativeCriterionService.MutateCustomerNegativeCriteria][google.ads.googleads.v13.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria].
message MutateCustomerNegativeCriteriaRequest {
// Required. The ID of the customer whose criteria are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual criteria.
- repeated CustomerNegativeCriterionOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CustomerNegativeCriterionOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -83,7 +85,8 @@ message MutateCustomerNegativeCriteriaRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create or remove) on a customer level negative criterion.
@@ -91,15 +94,15 @@ message CustomerNegativeCriterionOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new criterion.
- google.ads.googleads.v10.resources.CustomerNegativeCriterion create = 1;
+ google.ads.googleads.v13.resources.CustomerNegativeCriterion create = 1;
// Remove operation: A resource name for the removed criterion is expected,
// in this format:
//
// `customers/{customer_id}/customerNegativeCriteria/{criterion_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerNegativeCriterion"
- }];
+ type: "googleads.googleapis.com/CustomerNegativeCriterion"
+ }];
}
}
@@ -107,8 +110,8 @@ message CustomerNegativeCriterionOperation {
message MutateCustomerNegativeCriteriaResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -119,10 +122,11 @@ message MutateCustomerNegativeCriteriaResponse {
message MutateCustomerNegativeCriteriaResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerNegativeCriterion"
- }];
+ type: "googleads.googleapis.com/CustomerNegativeCriterion"
+ }];
// The mutated criterion with only mutable fields after mutate. The field will
// only be returned when response_content_type is set to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CustomerNegativeCriterion customer_negative_criterion = 2;
+ google.ads.googleads.v13.resources.CustomerNegativeCriterion
+ customer_negative_criterion = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_service.proto
similarity index 69%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_service.proto
index c356d1c38..04bad9d5e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_service.proto
@@ -14,25 +14,25 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/access_role.proto";
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/customer.proto";
+import "google/ads/googleads/v13/enums/access_role.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/customer.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Customer service.
@@ -55,7 +55,7 @@ service CustomerService {
// [UrlFieldError]()
rpc MutateCustomer(MutateCustomerRequest) returns (MutateCustomerResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:mutate"
+ post: "/v13/customers/{customer_id=*}:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operation";
@@ -71,9 +71,10 @@ service CustomerService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse) {
+ rpc ListAccessibleCustomers(ListAccessibleCustomersRequest)
+ returns (ListAccessibleCustomersResponse) {
option (google.api.http) = {
- get: "/v10/customers:listAccessibleCustomers"
+ get: "/v13/customers:listAccessibleCustomers"
};
}
@@ -91,16 +92,18 @@ service CustomerService {
// [RequestError]()
// [StringLengthError]()
// [TimeZoneError]()
- rpc CreateCustomerClient(CreateCustomerClientRequest) returns (CreateCustomerClientResponse) {
+ rpc CreateCustomerClient(CreateCustomerClientRequest)
+ returns (CreateCustomerClientResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:createCustomerClient"
+ post: "/v13/customers/{customer_id=*}:createCustomerClient"
body: "*"
};
option (google.api.method_signature) = "customer_id,customer_client";
}
}
-// Request message for [CustomerService.MutateCustomer][google.ads.googleads.v10.services.CustomerService.MutateCustomer].
+// Request message for
+// [CustomerService.MutateCustomer][google.ads.googleads.v13.services.CustomerService.MutateCustomer].
message MutateCustomerRequest {
// Required. The ID of the customer being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
@@ -114,17 +117,21 @@ message MutateCustomerRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 6;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 6;
}
-// Request message for [CustomerService.CreateCustomerClient][google.ads.googleads.v10.services.CustomerService.CreateCustomerClient].
+// Request message for
+// [CustomerService.CreateCustomerClient][google.ads.googleads.v13.services.CustomerService.CreateCustomerClient].
message CreateCustomerClientRequest {
- // Required. The ID of the Manager under whom client customer is being created.
+ // Required. The ID of the Manager under whom client customer is being
+ // created.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The new client customer to create. The resource name on this customer
- // will be ignored.
- google.ads.googleads.v10.resources.Customer customer_client = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The new client customer to create. The resource name on this
+ // customer will be ignored.
+ google.ads.googleads.v13.resources.Customer customer_client = 2
+ [(google.api.field_behavior) = REQUIRED];
// Email address of the user who should be invited on the created client
// customer. Accessible only to customers on the allow-list.
@@ -132,7 +139,7 @@ message CreateCustomerClientRequest {
// The proposed role of user on the created client customer.
// Accessible only to customers on the allow-list.
- google.ads.googleads.v10.enums.AccessRoleEnum.AccessRole access_role = 4;
+ google.ads.googleads.v13.enums.AccessRoleEnum.AccessRole access_role = 4;
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -142,7 +149,7 @@ message CreateCustomerClientRequest {
// A single update on a customer.
message CustomerOperation {
// Mutate operation. Only updates are supported for customer.
- google.ads.googleads.v10.resources.Customer update = 1;
+ google.ads.googleads.v13.resources.Customer update = 1;
// FieldMask that determines which resource fields are modified in an update.
google.protobuf.FieldMask update_mask = 2;
@@ -150,10 +157,11 @@ message CustomerOperation {
// Response message for CreateCustomerClient mutate.
message CreateCustomerClientResponse {
- // The resource name of the newly created customer client.
+ // The resource name of the newly created customer. Customer resource names
+ // have the form: `customers/{customer_id}`.
string resource_name = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Customer"
- }];
+ type: "googleads.googleapis.com/Customer"
+ }];
// Link for inviting user to access the created customer. Accessible to
// allowlisted customers only.
@@ -170,20 +178,20 @@ message MutateCustomerResponse {
message MutateCustomerResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Customer"
- }];
+ type: "googleads.googleapis.com/Customer"
+ }];
// The mutated customer with only mutable fields after mutate. The fields will
// only be returned when response_content_type is set to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.Customer customer = 2;
+ google.ads.googleads.v13.resources.Customer customer = 2;
}
-// Request message for [CustomerService.ListAccessibleCustomers][google.ads.googleads.v10.services.CustomerService.ListAccessibleCustomers].
-message ListAccessibleCustomersRequest {
+// Request message for
+// [CustomerService.ListAccessibleCustomers][google.ads.googleads.v13.services.CustomerService.ListAccessibleCustomers].
+message ListAccessibleCustomersRequest {}
-}
-
-// Response message for [CustomerService.ListAccessibleCustomers][google.ads.googleads.v10.services.CustomerService.ListAccessibleCustomers].
+// Response message for
+// [CustomerService.ListAccessibleCustomers][google.ads.googleads.v13.services.CustomerService.ListAccessibleCustomers].
message ListAccessibleCustomersResponse {
// Resource name of customers directly accessible by the
// user authenticating the call.
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_user_access_invitation_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_user_access_invitation_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_user_access_invitation_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_user_access_invitation_service.proto
index 4e056b625..f25eed12b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_user_access_invitation_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_user_access_invitation_service.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/customer_user_access_invitation.proto";
+import "google/ads/googleads/v13/resources/customer_user_access_invitation.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerUserAccessInvitationServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CustomerUserAccessInvitation service.
@@ -49,9 +49,11 @@ service CustomerUserAccessInvitationService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateCustomerUserAccessInvitation(MutateCustomerUserAccessInvitationRequest) returns (MutateCustomerUserAccessInvitationResponse) {
+ rpc MutateCustomerUserAccessInvitation(
+ MutateCustomerUserAccessInvitationRequest)
+ returns (MutateCustomerUserAccessInvitationResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customerUserAccessInvitations:mutate"
+ post: "/v13/customers/{customer_id=*}/customerUserAccessInvitations:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operation";
@@ -65,7 +67,8 @@ message MutateCustomerUserAccessInvitationRequest {
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The operation to perform on the access invitation
- CustomerUserAccessInvitationOperation operation = 2 [(google.api.field_behavior) = REQUIRED];
+ CustomerUserAccessInvitationOperation operation = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// A single operation (create or remove) on customer user access invitation.
@@ -74,15 +77,15 @@ message CustomerUserAccessInvitationOperation {
oneof operation {
// Create operation: No resource name is expected for the new access
// invitation.
- google.ads.googleads.v10.resources.CustomerUserAccessInvitation create = 1;
+ google.ads.googleads.v13.resources.CustomerUserAccessInvitation create = 1;
// Remove operation: A resource name for the revoke invitation is
// expected, in this format:
//
// `customers/{customer_id}/customerUserAccessInvitations/{invitation_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerUserAccessInvitation"
- }];
+ type: "googleads.googleapis.com/CustomerUserAccessInvitation"
+ }];
}
}
@@ -96,6 +99,6 @@ message MutateCustomerUserAccessInvitationResponse {
message MutateCustomerUserAccessInvitationResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerUserAccessInvitation"
- }];
+ type: "googleads.googleapis.com/CustomerUserAccessInvitation"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customer_user_access_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customer_user_access_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/customer_user_access_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customer_user_access_service.proto
index 9364a9d18..8daf33b1b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customer_user_access_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customer_user_access_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/customer_user_access.proto";
+import "google/ads/googleads/v13/resources/customer_user_access.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomerUserAccessServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// This service manages the permissions of a user on a given customer.
service CustomerUserAccessService {
@@ -50,9 +50,10 @@ service CustomerUserAccessService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateCustomerUserAccess(MutateCustomerUserAccessRequest) returns (MutateCustomerUserAccessResponse) {
+ rpc MutateCustomerUserAccess(MutateCustomerUserAccessRequest)
+ returns (MutateCustomerUserAccessResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customerUserAccesses:mutate"
+ post: "/v13/customers/{customer_id=*}/customerUserAccesses:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operation";
@@ -60,13 +61,14 @@ service CustomerUserAccessService {
}
// Mutate Request for
-// [CustomerUserAccessService.MutateCustomerUserAccess][google.ads.googleads.v10.services.CustomerUserAccessService.MutateCustomerUserAccess].
+// [CustomerUserAccessService.MutateCustomerUserAccess][google.ads.googleads.v13.services.CustomerUserAccessService.MutateCustomerUserAccess].
message MutateCustomerUserAccessRequest {
// Required. The ID of the customer being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The operation to perform on the customer
- CustomerUserAccessOperation operation = 2 [(google.api.field_behavior) = REQUIRED];
+ CustomerUserAccessOperation operation = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// A single operation (update, remove) on customer user access.
@@ -78,15 +80,15 @@ message CustomerUserAccessOperation {
oneof operation {
// Update operation: The customer user access is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.CustomerUserAccess update = 1;
+ google.ads.googleads.v13.resources.CustomerUserAccess update = 1;
// Remove operation: A resource name for the removed access is
// expected, in this format:
//
// `customers/{customer_id}/customerUserAccesses/{CustomerUserAccess.user_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerUserAccess"
- }];
+ type: "googleads.googleapis.com/CustomerUserAccess"
+ }];
}
}
@@ -100,6 +102,6 @@ message MutateCustomerUserAccessResponse {
message MutateCustomerUserAccessResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomerUserAccess"
- }];
+ type: "googleads.googleapis.com/CustomerUserAccess"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/customizer_attribute_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/customizer_attribute_service.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/services/customizer_attribute_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/customizer_attribute_service.proto
index 64754cfa2..d8c61ce45 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/customizer_attribute_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/customizer_attribute_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/customizer_attribute.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/customizer_attribute.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "CustomizerAttributeServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the CustomizerAttribute service.
@@ -43,9 +43,10 @@ service CustomizerAttributeService {
// Creates, updates or removes customizer attributes. Operation statuses are
// returned.
- rpc MutateCustomizerAttributes(MutateCustomizerAttributesRequest) returns (MutateCustomizerAttributesResponse) {
+ rpc MutateCustomizerAttributes(MutateCustomizerAttributesRequest)
+ returns (MutateCustomizerAttributesResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/customizerAttributes:mutate"
+ post: "/v13/customers/{customer_id=*}/customizerAttributes:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -53,13 +54,16 @@ service CustomizerAttributeService {
}
// Request message for
-// [CustomizerAttributeService.MutateCustomizerAttributes][google.ads.googleads.v10.services.CustomizerAttributeService.MutateCustomizerAttributes].
+// [CustomizerAttributeService.MutateCustomizerAttributes][google.ads.googleads.v13.services.CustomizerAttributeService.MutateCustomizerAttributes].
message MutateCustomizerAttributesRequest {
- // Required. The ID of the customer whose customizer attributes are being modified.
+ // Required. The ID of the customer whose customizer attributes are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual customizer attributes.
- repeated CustomizerAttributeOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual customizer
+ // attributes.
+ repeated CustomizerAttributeOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -73,10 +77,11 @@ message MutateCustomizerAttributesRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
-// A single operation (create, remove) on an customizer attribute.
+// A single operation (create, remove) on a customizer attribute.
message CustomizerAttributeOperation {
// FieldMask that determines which resource fields are modified in an update.
google.protobuf.FieldMask update_mask = 4;
@@ -85,26 +90,26 @@ message CustomizerAttributeOperation {
oneof operation {
// Create operation: No resource name is expected for the new customizer
// attribute
- google.ads.googleads.v10.resources.CustomizerAttribute create = 1;
+ google.ads.googleads.v13.resources.CustomizerAttribute create = 1;
// Remove operation: A resource name for the removed customizer attribute is
// expected, in this format:
// `customers/{customer_id}/customizerAttributes/{customizer_attribute_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomizerAttribute"
- }];
+ type: "googleads.googleapis.com/CustomizerAttribute"
+ }];
}
}
-// Response message for an customizer attribute mutate.
+// Response message for a customizer attribute mutate.
message MutateCustomizerAttributesResponse {
// All results for the mutate.
repeated MutateCustomizerAttributeResult results = 1;
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -112,11 +117,12 @@ message MutateCustomizerAttributesResponse {
message MutateCustomizerAttributeResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/CustomizerAttribute"
- }];
+ type: "googleads.googleapis.com/CustomizerAttribute"
+ }];
// The mutated CustomizerAttribute with only mutable fields after mutate.
// The field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.CustomizerAttribute customizer_attribute = 2;
+ google.ads.googleads.v13.resources.CustomizerAttribute customizer_attribute =
+ 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/experiment_arm_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/experiment_arm_service.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/services/experiment_arm_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/experiment_arm_service.proto
index d17a65198..61906d576 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/experiment_arm_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/experiment_arm_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/experiment_arm.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/experiment_arm.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ExperimentArmServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Experiment Arm service.
@@ -52,22 +52,25 @@ service ExperimentArmService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateExperimentArms(MutateExperimentArmsRequest) returns (MutateExperimentArmsResponse) {
+ rpc MutateExperimentArms(MutateExperimentArmsRequest)
+ returns (MutateExperimentArmsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/experimentArms:mutate"
+ post: "/v13/customers/{customer_id=*}/experimentArms:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [ExperimentArmService.MutateExperimentArms][google.ads.googleads.v10.services.ExperimentArmService.MutateExperimentArms].
+// Request message for
+// [ExperimentArmService.MutateExperimentArms][google.ads.googleads.v13.services.ExperimentArmService.MutateExperimentArms].
message MutateExperimentArmsRequest {
// Required. The ID of the customer whose experiments are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual experiment arm.
- repeated ExperimentArmOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated ExperimentArmOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -81,7 +84,8 @@ message MutateExperimentArmsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation on an experiment arm.
@@ -92,19 +96,19 @@ message ExperimentArmOperation {
// The mutate operation.
oneof operation {
// Create operation
- google.ads.googleads.v10.resources.ExperimentArm create = 1;
+ google.ads.googleads.v13.resources.ExperimentArm create = 1;
// Update operation: The experiment arm is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.ExperimentArm update = 2;
+ google.ads.googleads.v13.resources.ExperimentArm update = 2;
// Remove operation: The experiment arm is expected to have a valid
// resource name, in this format:
//
// `customers/{customer_id}/experiments/{campaign_experiment_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ExperimentArm"
- }];
+ type: "googleads.googleapis.com/ExperimentArm"
+ }];
}
}
@@ -112,8 +116,8 @@ message ExperimentArmOperation {
message MutateExperimentArmsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 1;
// All results for the mutate.
@@ -124,11 +128,11 @@ message MutateExperimentArmsResponse {
message MutateExperimentArmResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ExperimentArm"
- }];
+ type: "googleads.googleapis.com/ExperimentArm"
+ }];
// The mutated experiment arm with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.ExperimentArm experiment_arm = 2;
+ google.ads.googleads.v13.resources.ExperimentArm experiment_arm = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/experiment_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/experiment_service.proto
similarity index 79%
rename from third_party/googleapis/google/ads/googleads/v10/services/experiment_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/experiment_service.proto
index 13ea236c3..992a9b96f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/experiment_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/experiment_service.proto
@@ -14,9 +14,9 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/experiment.proto";
+import "google/ads/googleads/v13/resources/experiment.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -26,14 +26,14 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ExperimentServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Experiment service.
@@ -52,9 +52,10 @@ service ExperimentService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateExperiments(MutateExperimentsRequest) returns (MutateExperimentsResponse) {
+ rpc MutateExperiments(MutateExperimentsRequest)
+ returns (MutateExperimentsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/experiments:mutate"
+ post: "/v13/customers/{customer_id=*}/experiments:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -74,7 +75,7 @@ service ExperimentService {
// [RequestError]()
rpc EndExperiment(EndExperimentRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
- post: "/v10/{experiment=customers/*/experiments/*}:endExperiment"
+ post: "/v13/{experiment=customers/*/experiments/*}:endExperiment"
body: "*"
};
option (google.api.method_signature) = "experiment";
@@ -91,9 +92,10 @@ service ExperimentService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc ListExperimentAsyncErrors(ListExperimentAsyncErrorsRequest) returns (ListExperimentAsyncErrorsResponse) {
+ rpc ListExperimentAsyncErrors(ListExperimentAsyncErrorsRequest)
+ returns (ListExperimentAsyncErrorsResponse) {
option (google.api.http) = {
- get: "/v10/{resource_name=customers/*/experiments/*}:listExperimentAsyncErrors"
+ get: "/v13/{resource_name=customers/*/experiments/*}:listExperimentAsyncErrors"
};
option (google.api.method_signature) = "resource_name";
}
@@ -109,12 +111,14 @@ service ExperimentService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc GraduateExperiment(GraduateExperimentRequest) returns (google.protobuf.Empty) {
+ rpc GraduateExperiment(GraduateExperimentRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
- post: "/v10/{experiment=customers/*/experiments/*}:graduateExperiment"
+ post: "/v13/{experiment=customers/*/experiments/*}:graduateExperiment"
body: "*"
};
- option (google.api.method_signature) = "experiment,campaign_budget_mappings";
+ option (google.api.method_signature) =
+ "experiment,campaign_budget_mappings";
}
// Schedule an experiment. The in design campaign
@@ -141,15 +145,16 @@ service ExperimentService {
// [QuotaError]()
// [RangeError]()
// [RequestError]()
- rpc ScheduleExperiment(ScheduleExperimentRequest) returns (google.longrunning.Operation) {
+ rpc ScheduleExperiment(ScheduleExperimentRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
- post: "/v10/{resource_name=customers/*/experiments/*}:scheduleExperiment"
+ post: "/v13/{resource_name=customers/*/experiments/*}:scheduleExperiment"
body: "*"
};
option (google.api.method_signature) = "resource_name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
- metadata_type: "google.ads.googleads.v10.services.ScheduleExperimentMetadata"
+ metadata_type: "google.ads.googleads.v13.services.ScheduleExperimentMetadata"
};
}
@@ -169,26 +174,29 @@ service ExperimentService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc PromoteExperiment(PromoteExperimentRequest) returns (google.longrunning.Operation) {
+ rpc PromoteExperiment(PromoteExperimentRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
- post: "/v10/{resource_name=customers/*/experiments/*}:promoteExperiment"
+ post: "/v13/{resource_name=customers/*/experiments/*}:promoteExperiment"
body: "*"
};
option (google.api.method_signature) = "resource_name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
- metadata_type: "google.ads.googleads.v10.services.PromoteExperimentMetadata"
+ metadata_type: "google.ads.googleads.v13.services.PromoteExperimentMetadata"
};
}
}
-// Request message for [ExperimentService.MutateExperiments][google.ads.googleads.v10.services.ExperimentService.MutateExperiments].
+// Request message for
+// [ExperimentService.MutateExperiments][google.ads.googleads.v13.services.ExperimentService.MutateExperiments].
message MutateExperimentsRequest {
// Required. The ID of the customer whose experiments are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual experiments.
- repeated ExperimentOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated ExperimentOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -209,19 +217,19 @@ message ExperimentOperation {
// The mutate operation.
oneof operation {
// Create operation
- google.ads.googleads.v10.resources.Experiment create = 1;
+ google.ads.googleads.v13.resources.Experiment create = 1;
// Update operation: The experiment is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.Experiment update = 2;
+ google.ads.googleads.v13.resources.Experiment update = 2;
// Remove operation: The experiment is expected to have a valid
// resource name, in this format:
//
// `customers/{customer_id}/experiments/{campaign_experiment_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Experiment"
- }];
+ type: "googleads.googleapis.com/Experiment"
+ }];
}
}
@@ -229,8 +237,8 @@ message ExperimentOperation {
message MutateExperimentsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 1;
// All results for the mutate.
@@ -241,11 +249,12 @@ message MutateExperimentsResponse {
message MutateExperimentResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Experiment"
- }];
+ type: "googleads.googleapis.com/Experiment"
+ }];
}
-// Request message for [ExperimentService.EndExperiment][google.ads.googleads.v10.services.ExperimentService.EndExperiment].
+// Request message for
+// [ExperimentService.EndExperiment][google.ads.googleads.v13.services.ExperimentService.EndExperiment].
message EndExperimentRequest {
// Required. The resource name of the campaign experiment to end.
string experiment = 1 [
@@ -261,7 +270,7 @@ message EndExperimentRequest {
}
// Request message for
-// [ExperimentService.ListExperimentAsyncErrors][google.ads.googleads.v10.services.ExperimentService.ListExperimentAsyncErrors].
+// [ExperimentService.ListExperimentAsyncErrors][google.ads.googleads.v13.services.ExperimentService.ListExperimentAsyncErrors].
message ListExperimentAsyncErrorsRequest {
// Required. The name of the experiment from which to retrieve the async
// errors.
@@ -286,7 +295,7 @@ message ListExperimentAsyncErrorsRequest {
}
// Response message for
-// [ExperimentService.ListExperimentAsyncErrors][google.ads.googleads.v10.services.ExperimentService.ListExperimentAsyncErrors].
+// [ExperimentService.ListExperimentAsyncErrors][google.ads.googleads.v13.services.ExperimentService.ListExperimentAsyncErrors].
message ListExperimentAsyncErrorsResponse {
// details of the errors when performing the asynchronous operation.
repeated google.rpc.Status errors = 1;
@@ -298,7 +307,8 @@ message ListExperimentAsyncErrorsResponse {
string next_page_token = 2;
}
-// Request message for [ExperimentService.GraduateExperiment][google.ads.googleads.v10.services.ExperimentService.GraduateExperiment].
+// Request message for
+// [ExperimentService.GraduateExperiment][google.ads.googleads.v13.services.ExperimentService.GraduateExperiment].
message GraduateExperimentRequest {
// Required. The experiment to be graduated.
string experiment = 1 [
@@ -308,10 +318,11 @@ message GraduateExperimentRequest {
}
];
- // Required. List of campaign budget mappings for graduation. Each campaign that
- // appears here will graduate, and will be assigned a new budget that is
+ // Required. List of campaign budget mappings for graduation. Each campaign
+ // that appears here will graduate, and will be assigned a new budget that is
// paired with it in the mapping. The maximum size is one.
- repeated CampaignBudgetMapping campaign_budget_mappings = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CampaignBudgetMapping campaign_budget_mappings = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -328,7 +339,8 @@ message CampaignBudgetMapping {
}
];
- // Required. The budget that should be attached to the graduating experiment campaign.
+ // Required. The budget that should be attached to the graduating experiment
+ // campaign.
string campaign_budget = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -337,7 +349,8 @@ message CampaignBudgetMapping {
];
}
-// Request message for [ExperimentService.ScheduleExperiment][google.ads.googleads.v10.services.ExperimentService.ScheduleExperiment].
+// Request message for
+// [ExperimentService.ScheduleExperiment][google.ads.googleads.v13.services.ExperimentService.ScheduleExperiment].
message ScheduleExperimentRequest {
// Required. The scheduled experiment.
string resource_name = 1 [
@@ -363,7 +376,8 @@ message ScheduleExperimentMetadata {
];
}
-// Request message for [ExperimentService.PromoteExperiment][google.ads.googleads.v10.services.ExperimentService.PromoteExperiment].
+// Request message for
+// [ExperimentService.PromoteExperiment][google.ads.googleads.v13.services.ExperimentService.PromoteExperiment].
message PromoteExperimentRequest {
// Required. The resource name of the experiment to promote.
string resource_name = 1 [
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/extension_feed_item_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/extension_feed_item_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/extension_feed_item_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/extension_feed_item_service.proto
index ee9bc3344..2bf38e549 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/extension_feed_item_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/extension_feed_item_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/extension_feed_item.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/extension_feed_item.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ExtensionFeedItemServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the ExtensionFeedItem service.
@@ -68,23 +68,27 @@ service ExtensionFeedItemService {
// [SizeLimitError]()
// [StringLengthError]()
// [UrlFieldError]()
- rpc MutateExtensionFeedItems(MutateExtensionFeedItemsRequest) returns (MutateExtensionFeedItemsResponse) {
+ rpc MutateExtensionFeedItems(MutateExtensionFeedItemsRequest)
+ returns (MutateExtensionFeedItemsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/extensionFeedItems:mutate"
+ post: "/v13/customers/{customer_id=*}/extensionFeedItems:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [ExtensionFeedItemService.MutateExtensionFeedItems][google.ads.googleads.v10.services.ExtensionFeedItemService.MutateExtensionFeedItems].
+// Request message for
+// [ExtensionFeedItemService.MutateExtensionFeedItems][google.ads.googleads.v13.services.ExtensionFeedItemService.MutateExtensionFeedItems].
message MutateExtensionFeedItemsRequest {
// Required. The ID of the customer whose extension feed items are being
// modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual extension feed items.
- repeated ExtensionFeedItemOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual extension feed
+ // items.
+ repeated ExtensionFeedItemOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -98,7 +102,8 @@ message MutateExtensionFeedItemsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on an extension feed item.
@@ -110,19 +115,19 @@ message ExtensionFeedItemOperation {
oneof operation {
// Create operation: No resource name is expected for the new extension
// feed item.
- google.ads.googleads.v10.resources.ExtensionFeedItem create = 1;
+ google.ads.googleads.v13.resources.ExtensionFeedItem create = 1;
// Update operation: The extension feed item is expected to have a
// valid resource name.
- google.ads.googleads.v10.resources.ExtensionFeedItem update = 2;
+ google.ads.googleads.v13.resources.ExtensionFeedItem update = 2;
// Remove operation: A resource name for the removed extension feed item
// is expected, in this format:
//
// `customers/{customer_id}/extensionFeedItems/{feed_item_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ExtensionFeedItem"
- }];
+ type: "googleads.googleapis.com/ExtensionFeedItem"
+ }];
}
}
@@ -130,8 +135,8 @@ message ExtensionFeedItemOperation {
message MutateExtensionFeedItemsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -142,11 +147,11 @@ message MutateExtensionFeedItemsResponse {
message MutateExtensionFeedItemResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ExtensionFeedItem"
- }];
+ type: "googleads.googleapis.com/ExtensionFeedItem"
+ }];
// The mutated extension feed item with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.ExtensionFeedItem extension_feed_item = 2;
+ google.ads.googleads.v13.resources.ExtensionFeedItem extension_feed_item = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/feed_item_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/feed_item_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/feed_item_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/feed_item_service.proto
index 22495819a..030b690ec 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/feed_item_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/feed_item_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/feed_item.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/feed_item.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "FeedItemServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the FeedItem service.
@@ -70,22 +70,25 @@ service FeedItemService {
// [StringFormatError]()
// [StringLengthError]()
// [UrlFieldError]()
- rpc MutateFeedItems(MutateFeedItemsRequest) returns (MutateFeedItemsResponse) {
+ rpc MutateFeedItems(MutateFeedItemsRequest)
+ returns (MutateFeedItemsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/feedItems:mutate"
+ post: "/v13/customers/{customer_id=*}/feedItems:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [FeedItemService.MutateFeedItems][google.ads.googleads.v10.services.FeedItemService.MutateFeedItems].
+// Request message for
+// [FeedItemService.MutateFeedItems][google.ads.googleads.v13.services.FeedItemService.MutateFeedItems].
message MutateFeedItemsRequest {
// Required. The ID of the customer whose feed items are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual feed items.
- repeated FeedItemOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated FeedItemOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -99,7 +102,8 @@ message MutateFeedItemsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on an feed item.
@@ -110,19 +114,19 @@ message FeedItemOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new feed item.
- google.ads.googleads.v10.resources.FeedItem create = 1;
+ google.ads.googleads.v13.resources.FeedItem create = 1;
// Update operation: The feed item is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.FeedItem update = 2;
+ google.ads.googleads.v13.resources.FeedItem update = 2;
// Remove operation: A resource name for the removed feed item is
// expected, in this format:
//
// `customers/{customer_id}/feedItems/{feed_id}~{feed_item_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/FeedItem"
- }];
+ type: "googleads.googleapis.com/FeedItem"
+ }];
}
}
@@ -130,8 +134,8 @@ message FeedItemOperation {
message MutateFeedItemsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -142,10 +146,10 @@ message MutateFeedItemsResponse {
message MutateFeedItemResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/FeedItem"
- }];
+ type: "googleads.googleapis.com/FeedItem"
+ }];
// The mutated feed item with only mutable fields after mutate. The field will
// only be returned when response_content_type is set to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.FeedItem feed_item = 2;
+ google.ads.googleads.v13.resources.FeedItem feed_item = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/feed_item_set_link_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/feed_item_set_link_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/feed_item_set_link_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/feed_item_set_link_service.proto
index ad212e5ce..a57084ea4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/feed_item_set_link_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/feed_item_set_link_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/feed_item_set_link.proto";
+import "google/ads/googleads/v13/resources/feed_item_set_link.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "FeedItemSetLinkServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the FeedItemSetLink service.
@@ -48,22 +48,27 @@ service FeedItemSetLinkService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateFeedItemSetLinks(MutateFeedItemSetLinksRequest) returns (MutateFeedItemSetLinksResponse) {
+ rpc MutateFeedItemSetLinks(MutateFeedItemSetLinksRequest)
+ returns (MutateFeedItemSetLinksResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/feedItemSetLinks:mutate"
+ post: "/v13/customers/{customer_id=*}/feedItemSetLinks:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [FeedItemSetLinkService.MutateFeedItemSetLinks][google.ads.googleads.v10.services.FeedItemSetLinkService.MutateFeedItemSetLinks].
+// Request message for
+// [FeedItemSetLinkService.MutateFeedItemSetLinks][google.ads.googleads.v13.services.FeedItemSetLinkService.MutateFeedItemSetLinks].
message MutateFeedItemSetLinksRequest {
- // Required. The ID of the customer whose feed item set links are being modified.
+ // Required. The ID of the customer whose feed item set links are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual feed item set links.
- repeated FeedItemSetLinkOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual feed item set
+ // links.
+ repeated FeedItemSetLinkOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -82,15 +87,15 @@ message FeedItemSetLinkOperation {
oneof operation {
// Create operation: No resource name is expected for the
// new feed item set link.
- google.ads.googleads.v10.resources.FeedItemSetLink create = 1;
+ google.ads.googleads.v13.resources.FeedItemSetLink create = 1;
// Remove operation: A resource name for the removed feed item set link is
// expected, in this format:
//
// `customers/{customer_id}/feedItemSetLinks/{feed_id}_{feed_item_set_id}_{feed_item_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/FeedItemSetLink"
- }];
+ type: "googleads.googleapis.com/FeedItemSetLink"
+ }];
}
}
@@ -101,8 +106,8 @@ message MutateFeedItemSetLinksResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -110,6 +115,6 @@ message MutateFeedItemSetLinksResponse {
message MutateFeedItemSetLinkResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/FeedItemSetLink"
- }];
+ type: "googleads.googleapis.com/FeedItemSetLink"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/feed_item_set_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/feed_item_set_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/feed_item_set_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/feed_item_set_service.proto
index d32a3ee36..e1c3c2c3b 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/feed_item_set_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/feed_item_set_service.proto
@@ -14,9 +14,9 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/feed_item_set.proto";
+import "google/ads/googleads/v13/resources/feed_item_set.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -24,14 +24,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "FeedItemSetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the FeedItemSet service.
@@ -51,22 +51,25 @@ service FeedItemSetService {
// [MutateError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateFeedItemSets(MutateFeedItemSetsRequest) returns (MutateFeedItemSetsResponse) {
+ rpc MutateFeedItemSets(MutateFeedItemSetsRequest)
+ returns (MutateFeedItemSetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/feedItemSets:mutate"
+ post: "/v13/customers/{customer_id=*}/feedItemSets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [FeedItemSetService.MutateFeedItemSets][google.ads.googleads.v10.services.FeedItemSetService.MutateFeedItemSets].
+// Request message for
+// [FeedItemSetService.MutateFeedItemSets][google.ads.googleads.v13.services.FeedItemSetService.MutateFeedItemSets].
message MutateFeedItemSetsRequest {
// Required. The ID of the customer whose feed item sets are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual feed item sets.
- repeated FeedItemSetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated FeedItemSetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -87,18 +90,18 @@ message FeedItemSetOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new feed item set
- google.ads.googleads.v10.resources.FeedItemSet create = 1;
+ google.ads.googleads.v13.resources.FeedItemSet create = 1;
// Update operation: The feed item set is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.FeedItemSet update = 2;
+ google.ads.googleads.v13.resources.FeedItemSet update = 2;
// Remove operation: A resource name for the removed feed item is
// expected, in this format:
// `customers/{customer_id}/feedItems/{feed_id}~{feed_item_set_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/FeedItemSet"
- }];
+ type: "googleads.googleapis.com/FeedItemSet"
+ }];
}
}
@@ -109,8 +112,8 @@ message MutateFeedItemSetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -118,6 +121,6 @@ message MutateFeedItemSetsResponse {
message MutateFeedItemSetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/FeedItemSet"
- }];
+ type: "googleads.googleapis.com/FeedItemSet"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/feed_item_target_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/feed_item_target_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/feed_item_target_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/feed_item_target_service.proto
index 3d8b3eb9e..8a1091d28 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/feed_item_target_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/feed_item_target_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/feed_item_target.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/feed_item_target.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "FeedItemTargetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the FeedItemTarget service.
@@ -62,22 +62,27 @@ service FeedItemTargetService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateFeedItemTargets(MutateFeedItemTargetsRequest) returns (MutateFeedItemTargetsResponse) {
+ rpc MutateFeedItemTargets(MutateFeedItemTargetsRequest)
+ returns (MutateFeedItemTargetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/feedItemTargets:mutate"
+ post: "/v13/customers/{customer_id=*}/feedItemTargets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [FeedItemTargetService.MutateFeedItemTargets][google.ads.googleads.v10.services.FeedItemTargetService.MutateFeedItemTargets].
+// Request message for
+// [FeedItemTargetService.MutateFeedItemTargets][google.ads.googleads.v13.services.FeedItemTargetService.MutateFeedItemTargets].
message MutateFeedItemTargetsRequest {
- // Required. The ID of the customer whose feed item targets are being modified.
+ // Required. The ID of the customer whose feed item targets are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual feed item targets.
- repeated FeedItemTargetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual feed item
+ // targets.
+ repeated FeedItemTargetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -87,7 +92,8 @@ message MutateFeedItemTargetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -100,15 +106,15 @@ message FeedItemTargetOperation {
oneof operation {
// Create operation: No resource name is expected for the new feed item
// target.
- google.ads.googleads.v10.resources.FeedItemTarget create = 1;
+ google.ads.googleads.v13.resources.FeedItemTarget create = 1;
// Remove operation: A resource name for the removed feed item target is
// expected, in this format:
//
// `customers/{customer_id}/feedItemTargets/{feed_id}~{feed_item_id}~{feed_item_target_type}~{feed_item_target_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/FeedItemTarget"
- }];
+ type: "googleads.googleapis.com/FeedItemTarget"
+ }];
}
}
@@ -116,8 +122,8 @@ message FeedItemTargetOperation {
message MutateFeedItemTargetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -128,11 +134,11 @@ message MutateFeedItemTargetsResponse {
message MutateFeedItemTargetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/FeedItemTarget"
- }];
+ type: "googleads.googleapis.com/FeedItemTarget"
+ }];
// The mutated feed item target with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.FeedItemTarget feed_item_target = 2;
+ google.ads.googleads.v13.resources.FeedItemTarget feed_item_target = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/feed_mapping_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/feed_mapping_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/feed_mapping_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/feed_mapping_service.proto
index 2cb96a630..06b4aaa2f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/feed_mapping_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/feed_mapping_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/feed_mapping.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/feed_mapping.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "FeedMappingServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the FeedMapping service.
@@ -63,22 +63,25 @@ service FeedMappingService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateFeedMappings(MutateFeedMappingsRequest) returns (MutateFeedMappingsResponse) {
+ rpc MutateFeedMappings(MutateFeedMappingsRequest)
+ returns (MutateFeedMappingsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/feedMappings:mutate"
+ post: "/v13/customers/{customer_id=*}/feedMappings:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [FeedMappingService.MutateFeedMappings][google.ads.googleads.v10.services.FeedMappingService.MutateFeedMappings].
+// Request message for
+// [FeedMappingService.MutateFeedMappings][google.ads.googleads.v13.services.FeedMappingService.MutateFeedMappings].
message MutateFeedMappingsRequest {
// Required. The ID of the customer whose feed mappings are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual feed mappings.
- repeated FeedMappingOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated FeedMappingOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -92,7 +95,8 @@ message MutateFeedMappingsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove) on a feed mapping.
@@ -100,15 +104,15 @@ message FeedMappingOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new feed mapping.
- google.ads.googleads.v10.resources.FeedMapping create = 1;
+ google.ads.googleads.v13.resources.FeedMapping create = 1;
// Remove operation: A resource name for the removed feed mapping is
// expected, in this format:
//
// `customers/{customer_id}/feedMappings/{feed_id}~{feed_mapping_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/FeedMapping"
- }];
+ type: "googleads.googleapis.com/FeedMapping"
+ }];
}
}
@@ -116,8 +120,8 @@ message FeedMappingOperation {
message MutateFeedMappingsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -128,11 +132,11 @@ message MutateFeedMappingsResponse {
message MutateFeedMappingResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/FeedMapping"
- }];
+ type: "googleads.googleapis.com/FeedMapping"
+ }];
// The mutated feed mapping with only mutable fields after mutate. The field
// will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.FeedMapping feed_mapping = 2;
+ google.ads.googleads.v13.resources.FeedMapping feed_mapping = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/feed_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/feed_service.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/services/feed_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/feed_service.proto
index b9401d3e7..c6ec74896 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/feed_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/feed_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/feed.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/feed.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "FeedServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Feed service.
@@ -71,20 +71,22 @@ service FeedService {
// [StringLengthError]()
rpc MutateFeeds(MutateFeedsRequest) returns (MutateFeedsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/feeds:mutate"
+ post: "/v13/customers/{customer_id=*}/feeds:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [FeedService.MutateFeeds][google.ads.googleads.v10.services.FeedService.MutateFeeds].
+// Request message for
+// [FeedService.MutateFeeds][google.ads.googleads.v13.services.FeedService.MutateFeeds].
message MutateFeedsRequest {
// Required. The ID of the customer whose feeds are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual feeds.
- repeated FeedOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated FeedOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -98,7 +100,8 @@ message MutateFeedsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on an feed.
@@ -109,19 +112,19 @@ message FeedOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new feed.
- google.ads.googleads.v10.resources.Feed create = 1;
+ google.ads.googleads.v13.resources.Feed create = 1;
// Update operation: The feed is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.Feed update = 2;
+ google.ads.googleads.v13.resources.Feed update = 2;
// Remove operation: A resource name for the removed feed is
// expected, in this format:
//
// `customers/{customer_id}/feeds/{feed_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }];
+ type: "googleads.googleapis.com/Feed"
+ }];
}
}
@@ -129,8 +132,8 @@ message FeedOperation {
message MutateFeedsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -140,11 +143,11 @@ message MutateFeedsResponse {
// The result for the feed mutate.
message MutateFeedResult {
// Returned for successful operations.
- string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Feed"
- }];
+ string resource_name = 1 [
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Feed" }
+ ];
// The mutated feed with only mutable fields after mutate. The field will only
// be returned when response_content_type is set to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.Feed feed = 2;
+ google.ads.googleads.v13.resources.Feed feed = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/geo_target_constant_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/geo_target_constant_service.proto
similarity index 80%
rename from third_party/googleapis/google/ads/googleads/v10/services/geo_target_constant_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/geo_target_constant_service.proto
index 1c522e777..2ed19973e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/geo_target_constant_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/geo_target_constant_service.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/geo_target_constant.proto";
+import "google/ads/googleads/v13/resources/geo_target_constant.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "GeoTargetConstantServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Geo target constant service.
@@ -46,16 +46,17 @@ service GeoTargetConstantService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc SuggestGeoTargetConstants(SuggestGeoTargetConstantsRequest) returns (SuggestGeoTargetConstantsResponse) {
+ rpc SuggestGeoTargetConstants(SuggestGeoTargetConstantsRequest)
+ returns (SuggestGeoTargetConstantsResponse) {
option (google.api.http) = {
- post: "/v10/geoTargetConstants:suggest"
+ post: "/v13/geoTargetConstants:suggest"
body: "*"
};
}
}
// Request message for
-// [GeoTargetConstantService.SuggestGeoTargetConstants][google.ads.googleads.v10.services.GeoTargetConstantService.SuggestGeoTargetConstants].
+// [GeoTargetConstantService.SuggestGeoTargetConstants][google.ads.googleads.v13.services.GeoTargetConstantService.SuggestGeoTargetConstants].
message SuggestGeoTargetConstantsRequest {
// A list of location names.
message LocationNames {
@@ -87,7 +88,8 @@ message SuggestGeoTargetConstantsRequest {
}
}
-// Response message for [GeoTargetConstantService.SuggestGeoTargetConstants][google.ads.googleads.v10.services.GeoTargetConstantService.SuggestGeoTargetConstants].
+// Response message for
+// [GeoTargetConstantService.SuggestGeoTargetConstants][google.ads.googleads.v13.services.GeoTargetConstantService.SuggestGeoTargetConstants].
message SuggestGeoTargetConstantsResponse {
// Geo target constant suggestions.
repeated GeoTargetConstantSuggestion geo_target_constant_suggestions = 1;
@@ -110,8 +112,9 @@ message GeoTargetConstantSuggestion {
optional string search_term = 8;
// The GeoTargetConstant result.
- google.ads.googleads.v10.resources.GeoTargetConstant geo_target_constant = 4;
+ google.ads.googleads.v13.resources.GeoTargetConstant geo_target_constant = 4;
// The list of parents of the geo target constant.
- repeated google.ads.googleads.v10.resources.GeoTargetConstant geo_target_constant_parents = 5;
+ repeated google.ads.googleads.v13.resources.GeoTargetConstant
+ geo_target_constant_parents = 5;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/google_ads_field_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/google_ads_field_service.proto
similarity index 72%
rename from third_party/googleapis/google/ads/googleads/v10/services/google_ads_field_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/google_ads_field_service.proto
index e168eb376..6a889e95f 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/google_ads_field_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/google_ads_field_service.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/google_ads_field.proto";
+import "google/ads/googleads/v13/resources/google_ads_field.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "GoogleAdsFieldServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the GoogleAdsFieldService.
@@ -47,9 +47,10 @@ service GoogleAdsFieldService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc GetGoogleAdsField(GetGoogleAdsFieldRequest) returns (google.ads.googleads.v10.resources.GoogleAdsField) {
+ rpc GetGoogleAdsField(GetGoogleAdsFieldRequest)
+ returns (google.ads.googleads.v13.resources.GoogleAdsField) {
option (google.api.http) = {
- get: "/v10/{resource_name=googleAdsFields/*}"
+ get: "/v13/{resource_name=googleAdsFields/*}"
};
option (google.api.method_signature) = "resource_name";
}
@@ -64,16 +65,18 @@ service GoogleAdsFieldService {
// [QueryError]()
// [QuotaError]()
// [RequestError]()
- rpc SearchGoogleAdsFields(SearchGoogleAdsFieldsRequest) returns (SearchGoogleAdsFieldsResponse) {
+ rpc SearchGoogleAdsFields(SearchGoogleAdsFieldsRequest)
+ returns (SearchGoogleAdsFieldsResponse) {
option (google.api.http) = {
- post: "/v10/googleAdsFields:search"
+ post: "/v13/googleAdsFields:search"
body: "*"
};
option (google.api.method_signature) = "query";
}
}
-// Request message for [GoogleAdsFieldService.GetGoogleAdsField][google.ads.googleads.v10.services.GoogleAdsFieldService.GetGoogleAdsField].
+// Request message for
+// [GoogleAdsFieldService.GetGoogleAdsField][google.ads.googleads.v13.services.GoogleAdsFieldService.GetGoogleAdsField].
message GetGoogleAdsFieldRequest {
// Required. The resource name of the field to get.
string resource_name = 1 [
@@ -84,7 +87,8 @@ message GetGoogleAdsFieldRequest {
];
}
-// Request message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v10.services.GoogleAdsFieldService.SearchGoogleAdsFields].
+// Request message for
+// [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v13.services.GoogleAdsFieldService.SearchGoogleAdsFields].
message SearchGoogleAdsFieldsRequest {
// Required. The query string.
string query = 1 [(google.api.field_behavior) = REQUIRED];
@@ -100,10 +104,11 @@ message SearchGoogleAdsFieldsRequest {
int32 page_size = 3;
}
-// Response message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v10.services.GoogleAdsFieldService.SearchGoogleAdsFields].
+// Response message for
+// [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v13.services.GoogleAdsFieldService.SearchGoogleAdsFields].
message SearchGoogleAdsFieldsResponse {
// The list of fields that matched the query.
- repeated google.ads.googleads.v10.resources.GoogleAdsField results = 1;
+ repeated google.ads.googleads.v13.resources.GoogleAdsField results = 1;
// Pagination token used to retrieve the next page of results. Pass the
// content of this string as the `page_token` attribute of the next request.
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/google_ads_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/google_ads_service.proto
similarity index 54%
rename from third_party/googleapis/google/ads/googleads/v10/services/google_ads_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/google_ads_service.proto
index 533260622..51cd817e1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/google_ads_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/google_ads_service.proto
@@ -14,253 +14,259 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
-
-import "google/ads/googleads/v10/common/metrics.proto";
-import "google/ads/googleads/v10/common/segments.proto";
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/enums/summary_row_setting.proto";
-import "google/ads/googleads/v10/resources/accessible_bidding_strategy.proto";
-import "google/ads/googleads/v10/resources/account_budget.proto";
-import "google/ads/googleads/v10/resources/account_budget_proposal.proto";
-import "google/ads/googleads/v10/resources/account_link.proto";
-import "google/ads/googleads/v10/resources/ad_group.proto";
-import "google/ads/googleads/v10/resources/ad_group_ad.proto";
-import "google/ads/googleads/v10/resources/ad_group_ad_asset_combination_view.proto";
-import "google/ads/googleads/v10/resources/ad_group_ad_asset_view.proto";
-import "google/ads/googleads/v10/resources/ad_group_ad_label.proto";
-import "google/ads/googleads/v10/resources/ad_group_asset.proto";
-import "google/ads/googleads/v10/resources/ad_group_audience_view.proto";
-import "google/ads/googleads/v10/resources/ad_group_bid_modifier.proto";
-import "google/ads/googleads/v10/resources/ad_group_criterion.proto";
-import "google/ads/googleads/v10/resources/ad_group_criterion_customizer.proto";
-import "google/ads/googleads/v10/resources/ad_group_criterion_label.proto";
-import "google/ads/googleads/v10/resources/ad_group_criterion_simulation.proto";
-import "google/ads/googleads/v10/resources/ad_group_customizer.proto";
-import "google/ads/googleads/v10/resources/ad_group_extension_setting.proto";
-import "google/ads/googleads/v10/resources/ad_group_feed.proto";
-import "google/ads/googleads/v10/resources/ad_group_label.proto";
-import "google/ads/googleads/v10/resources/ad_group_simulation.proto";
-import "google/ads/googleads/v10/resources/ad_parameter.proto";
-import "google/ads/googleads/v10/resources/ad_schedule_view.proto";
-import "google/ads/googleads/v10/resources/age_range_view.proto";
-import "google/ads/googleads/v10/resources/asset.proto";
-import "google/ads/googleads/v10/resources/asset_field_type_view.proto";
-import "google/ads/googleads/v10/resources/asset_group.proto";
-import "google/ads/googleads/v10/resources/asset_group_asset.proto";
-import "google/ads/googleads/v10/resources/asset_group_listing_group_filter.proto";
-import "google/ads/googleads/v10/resources/asset_group_product_group_view.proto";
-import "google/ads/googleads/v10/resources/asset_group_signal.proto";
-import "google/ads/googleads/v10/resources/asset_set.proto";
-import "google/ads/googleads/v10/resources/asset_set_asset.proto";
-import "google/ads/googleads/v10/resources/audience.proto";
-import "google/ads/googleads/v10/resources/batch_job.proto";
-import "google/ads/googleads/v10/resources/bidding_data_exclusion.proto";
-import "google/ads/googleads/v10/resources/bidding_seasonality_adjustment.proto";
-import "google/ads/googleads/v10/resources/bidding_strategy.proto";
-import "google/ads/googleads/v10/resources/bidding_strategy_simulation.proto";
-import "google/ads/googleads/v10/resources/billing_setup.proto";
-import "google/ads/googleads/v10/resources/call_view.proto";
-import "google/ads/googleads/v10/resources/campaign.proto";
-import "google/ads/googleads/v10/resources/campaign_asset.proto";
-import "google/ads/googleads/v10/resources/campaign_asset_set.proto";
-import "google/ads/googleads/v10/resources/campaign_audience_view.proto";
-import "google/ads/googleads/v10/resources/campaign_bid_modifier.proto";
-import "google/ads/googleads/v10/resources/campaign_budget.proto";
-import "google/ads/googleads/v10/resources/campaign_conversion_goal.proto";
-import "google/ads/googleads/v10/resources/campaign_criterion.proto";
-import "google/ads/googleads/v10/resources/campaign_criterion_simulation.proto";
-import "google/ads/googleads/v10/resources/campaign_customizer.proto";
-import "google/ads/googleads/v10/resources/campaign_draft.proto";
-import "google/ads/googleads/v10/resources/campaign_experiment.proto";
-import "google/ads/googleads/v10/resources/campaign_extension_setting.proto";
-import "google/ads/googleads/v10/resources/campaign_feed.proto";
-import "google/ads/googleads/v10/resources/campaign_group.proto";
-import "google/ads/googleads/v10/resources/campaign_label.proto";
-import "google/ads/googleads/v10/resources/campaign_shared_set.proto";
-import "google/ads/googleads/v10/resources/campaign_simulation.proto";
-import "google/ads/googleads/v10/resources/carrier_constant.proto";
-import "google/ads/googleads/v10/resources/change_event.proto";
-import "google/ads/googleads/v10/resources/change_status.proto";
-import "google/ads/googleads/v10/resources/click_view.proto";
-import "google/ads/googleads/v10/resources/combined_audience.proto";
-import "google/ads/googleads/v10/resources/conversion_action.proto";
-import "google/ads/googleads/v10/resources/conversion_custom_variable.proto";
-import "google/ads/googleads/v10/resources/conversion_goal_campaign_config.proto";
-import "google/ads/googleads/v10/resources/conversion_value_rule.proto";
-import "google/ads/googleads/v10/resources/conversion_value_rule_set.proto";
-import "google/ads/googleads/v10/resources/currency_constant.proto";
-import "google/ads/googleads/v10/resources/custom_audience.proto";
-import "google/ads/googleads/v10/resources/custom_conversion_goal.proto";
-import "google/ads/googleads/v10/resources/custom_interest.proto";
-import "google/ads/googleads/v10/resources/customer.proto";
-import "google/ads/googleads/v10/resources/customer_asset.proto";
-import "google/ads/googleads/v10/resources/customer_client.proto";
-import "google/ads/googleads/v10/resources/customer_client_link.proto";
-import "google/ads/googleads/v10/resources/customer_conversion_goal.proto";
-import "google/ads/googleads/v10/resources/customer_customizer.proto";
-import "google/ads/googleads/v10/resources/customer_extension_setting.proto";
-import "google/ads/googleads/v10/resources/customer_feed.proto";
-import "google/ads/googleads/v10/resources/customer_label.proto";
-import "google/ads/googleads/v10/resources/customer_manager_link.proto";
-import "google/ads/googleads/v10/resources/customer_negative_criterion.proto";
-import "google/ads/googleads/v10/resources/customer_user_access.proto";
-import "google/ads/googleads/v10/resources/customer_user_access_invitation.proto";
-import "google/ads/googleads/v10/resources/customizer_attribute.proto";
-import "google/ads/googleads/v10/resources/detail_placement_view.proto";
-import "google/ads/googleads/v10/resources/detailed_demographic.proto";
-import "google/ads/googleads/v10/resources/display_keyword_view.proto";
-import "google/ads/googleads/v10/resources/distance_view.proto";
-import "google/ads/googleads/v10/resources/domain_category.proto";
-import "google/ads/googleads/v10/resources/dynamic_search_ads_search_term_view.proto";
-import "google/ads/googleads/v10/resources/expanded_landing_page_view.proto";
-import "google/ads/googleads/v10/resources/experiment.proto";
-import "google/ads/googleads/v10/resources/experiment_arm.proto";
-import "google/ads/googleads/v10/resources/extension_feed_item.proto";
-import "google/ads/googleads/v10/resources/feed.proto";
-import "google/ads/googleads/v10/resources/feed_item.proto";
-import "google/ads/googleads/v10/resources/feed_item_set.proto";
-import "google/ads/googleads/v10/resources/feed_item_set_link.proto";
-import "google/ads/googleads/v10/resources/feed_item_target.proto";
-import "google/ads/googleads/v10/resources/feed_mapping.proto";
-import "google/ads/googleads/v10/resources/feed_placeholder_view.proto";
-import "google/ads/googleads/v10/resources/gender_view.proto";
-import "google/ads/googleads/v10/resources/geo_target_constant.proto";
-import "google/ads/googleads/v10/resources/geographic_view.proto";
-import "google/ads/googleads/v10/resources/group_placement_view.proto";
-import "google/ads/googleads/v10/resources/hotel_group_view.proto";
-import "google/ads/googleads/v10/resources/hotel_performance_view.proto";
-import "google/ads/googleads/v10/resources/hotel_reconciliation.proto";
-import "google/ads/googleads/v10/resources/income_range_view.proto";
-import "google/ads/googleads/v10/resources/keyword_plan.proto";
-import "google/ads/googleads/v10/resources/keyword_plan_ad_group.proto";
-import "google/ads/googleads/v10/resources/keyword_plan_ad_group_keyword.proto";
-import "google/ads/googleads/v10/resources/keyword_plan_campaign.proto";
-import "google/ads/googleads/v10/resources/keyword_plan_campaign_keyword.proto";
-import "google/ads/googleads/v10/resources/keyword_theme_constant.proto";
-import "google/ads/googleads/v10/resources/keyword_view.proto";
-import "google/ads/googleads/v10/resources/label.proto";
-import "google/ads/googleads/v10/resources/landing_page_view.proto";
-import "google/ads/googleads/v10/resources/language_constant.proto";
-import "google/ads/googleads/v10/resources/lead_form_submission_data.proto";
-import "google/ads/googleads/v10/resources/life_event.proto";
-import "google/ads/googleads/v10/resources/location_view.proto";
-import "google/ads/googleads/v10/resources/managed_placement_view.proto";
-import "google/ads/googleads/v10/resources/media_file.proto";
-import "google/ads/googleads/v10/resources/mobile_app_category_constant.proto";
-import "google/ads/googleads/v10/resources/mobile_device_constant.proto";
-import "google/ads/googleads/v10/resources/offline_user_data_job.proto";
-import "google/ads/googleads/v10/resources/operating_system_version_constant.proto";
-import "google/ads/googleads/v10/resources/paid_organic_search_term_view.proto";
-import "google/ads/googleads/v10/resources/parental_status_view.proto";
-import "google/ads/googleads/v10/resources/product_bidding_category_constant.proto";
-import "google/ads/googleads/v10/resources/product_group_view.proto";
-import "google/ads/googleads/v10/resources/recommendation.proto";
-import "google/ads/googleads/v10/resources/remarketing_action.proto";
-import "google/ads/googleads/v10/resources/search_term_view.proto";
-import "google/ads/googleads/v10/resources/shared_criterion.proto";
-import "google/ads/googleads/v10/resources/shared_set.proto";
-import "google/ads/googleads/v10/resources/shopping_performance_view.proto";
-import "google/ads/googleads/v10/resources/smart_campaign_search_term_view.proto";
-import "google/ads/googleads/v10/resources/smart_campaign_setting.proto";
-import "google/ads/googleads/v10/resources/third_party_app_analytics_link.proto";
-import "google/ads/googleads/v10/resources/topic_constant.proto";
-import "google/ads/googleads/v10/resources/topic_view.proto";
-import "google/ads/googleads/v10/resources/user_interest.proto";
-import "google/ads/googleads/v10/resources/user_list.proto";
-import "google/ads/googleads/v10/resources/user_location_view.proto";
-import "google/ads/googleads/v10/resources/video.proto";
-import "google/ads/googleads/v10/resources/webpage_view.proto";
-import "google/ads/googleads/v10/services/ad_group_ad_label_service.proto";
-import "google/ads/googleads/v10/services/ad_group_ad_service.proto";
-import "google/ads/googleads/v10/services/ad_group_asset_service.proto";
-import "google/ads/googleads/v10/services/ad_group_bid_modifier_service.proto";
-import "google/ads/googleads/v10/services/ad_group_criterion_customizer_service.proto";
-import "google/ads/googleads/v10/services/ad_group_criterion_label_service.proto";
-import "google/ads/googleads/v10/services/ad_group_criterion_service.proto";
-import "google/ads/googleads/v10/services/ad_group_customizer_service.proto";
-import "google/ads/googleads/v10/services/ad_group_extension_setting_service.proto";
-import "google/ads/googleads/v10/services/ad_group_feed_service.proto";
-import "google/ads/googleads/v10/services/ad_group_label_service.proto";
-import "google/ads/googleads/v10/services/ad_group_service.proto";
-import "google/ads/googleads/v10/services/ad_parameter_service.proto";
-import "google/ads/googleads/v10/services/ad_service.proto";
-import "google/ads/googleads/v10/services/asset_group_asset_service.proto";
-import "google/ads/googleads/v10/services/asset_group_listing_group_filter_service.proto";
-import "google/ads/googleads/v10/services/asset_group_service.proto";
-import "google/ads/googleads/v10/services/asset_group_signal_service.proto";
-import "google/ads/googleads/v10/services/asset_service.proto";
-import "google/ads/googleads/v10/services/asset_set_asset_service.proto";
-import "google/ads/googleads/v10/services/asset_set_service.proto";
-import "google/ads/googleads/v10/services/audience_service.proto";
-import "google/ads/googleads/v10/services/bidding_data_exclusion_service.proto";
-import "google/ads/googleads/v10/services/bidding_seasonality_adjustment_service.proto";
-import "google/ads/googleads/v10/services/bidding_strategy_service.proto";
-import "google/ads/googleads/v10/services/campaign_asset_service.proto";
-import "google/ads/googleads/v10/services/campaign_asset_set_service.proto";
-import "google/ads/googleads/v10/services/campaign_bid_modifier_service.proto";
-import "google/ads/googleads/v10/services/campaign_budget_service.proto";
-import "google/ads/googleads/v10/services/campaign_conversion_goal_service.proto";
-import "google/ads/googleads/v10/services/campaign_criterion_service.proto";
-import "google/ads/googleads/v10/services/campaign_customizer_service.proto";
-import "google/ads/googleads/v10/services/campaign_draft_service.proto";
-import "google/ads/googleads/v10/services/campaign_experiment_service.proto";
-import "google/ads/googleads/v10/services/campaign_extension_setting_service.proto";
-import "google/ads/googleads/v10/services/campaign_feed_service.proto";
-import "google/ads/googleads/v10/services/campaign_group_service.proto";
-import "google/ads/googleads/v10/services/campaign_label_service.proto";
-import "google/ads/googleads/v10/services/campaign_service.proto";
-import "google/ads/googleads/v10/services/campaign_shared_set_service.proto";
-import "google/ads/googleads/v10/services/conversion_action_service.proto";
-import "google/ads/googleads/v10/services/conversion_custom_variable_service.proto";
-import "google/ads/googleads/v10/services/conversion_goal_campaign_config_service.proto";
-import "google/ads/googleads/v10/services/conversion_value_rule_service.proto";
-import "google/ads/googleads/v10/services/conversion_value_rule_set_service.proto";
-import "google/ads/googleads/v10/services/custom_conversion_goal_service.proto";
-import "google/ads/googleads/v10/services/customer_asset_service.proto";
-import "google/ads/googleads/v10/services/customer_conversion_goal_service.proto";
-import "google/ads/googleads/v10/services/customer_customizer_service.proto";
-import "google/ads/googleads/v10/services/customer_extension_setting_service.proto";
-import "google/ads/googleads/v10/services/customer_feed_service.proto";
-import "google/ads/googleads/v10/services/customer_label_service.proto";
-import "google/ads/googleads/v10/services/customer_negative_criterion_service.proto";
-import "google/ads/googleads/v10/services/customer_service.proto";
-import "google/ads/googleads/v10/services/customizer_attribute_service.proto";
-import "google/ads/googleads/v10/services/experiment_arm_service.proto";
-import "google/ads/googleads/v10/services/experiment_service.proto";
-import "google/ads/googleads/v10/services/extension_feed_item_service.proto";
-import "google/ads/googleads/v10/services/feed_item_service.proto";
-import "google/ads/googleads/v10/services/feed_item_set_link_service.proto";
-import "google/ads/googleads/v10/services/feed_item_set_service.proto";
-import "google/ads/googleads/v10/services/feed_item_target_service.proto";
-import "google/ads/googleads/v10/services/feed_mapping_service.proto";
-import "google/ads/googleads/v10/services/feed_service.proto";
-import "google/ads/googleads/v10/services/keyword_plan_ad_group_keyword_service.proto";
-import "google/ads/googleads/v10/services/keyword_plan_ad_group_service.proto";
-import "google/ads/googleads/v10/services/keyword_plan_campaign_keyword_service.proto";
-import "google/ads/googleads/v10/services/keyword_plan_campaign_service.proto";
-import "google/ads/googleads/v10/services/keyword_plan_service.proto";
-import "google/ads/googleads/v10/services/label_service.proto";
-import "google/ads/googleads/v10/services/media_file_service.proto";
-import "google/ads/googleads/v10/services/remarketing_action_service.proto";
-import "google/ads/googleads/v10/services/shared_criterion_service.proto";
-import "google/ads/googleads/v10/services/shared_set_service.proto";
-import "google/ads/googleads/v10/services/smart_campaign_setting_service.proto";
-import "google/ads/googleads/v10/services/user_list_service.proto";
+package google.ads.googleads.v13.services;
+
+import "google/ads/googleads/v13/common/metrics.proto";
+import "google/ads/googleads/v13/common/segments.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/enums/summary_row_setting.proto";
+import "google/ads/googleads/v13/resources/accessible_bidding_strategy.proto";
+import "google/ads/googleads/v13/resources/account_budget.proto";
+import "google/ads/googleads/v13/resources/account_budget_proposal.proto";
+import "google/ads/googleads/v13/resources/account_link.proto";
+import "google/ads/googleads/v13/resources/ad_group.proto";
+import "google/ads/googleads/v13/resources/ad_group_ad.proto";
+import "google/ads/googleads/v13/resources/ad_group_ad_asset_combination_view.proto";
+import "google/ads/googleads/v13/resources/ad_group_ad_asset_view.proto";
+import "google/ads/googleads/v13/resources/ad_group_ad_label.proto";
+import "google/ads/googleads/v13/resources/ad_group_asset.proto";
+import "google/ads/googleads/v13/resources/ad_group_asset_set.proto";
+import "google/ads/googleads/v13/resources/ad_group_audience_view.proto";
+import "google/ads/googleads/v13/resources/ad_group_bid_modifier.proto";
+import "google/ads/googleads/v13/resources/ad_group_criterion.proto";
+import "google/ads/googleads/v13/resources/ad_group_criterion_customizer.proto";
+import "google/ads/googleads/v13/resources/ad_group_criterion_label.proto";
+import "google/ads/googleads/v13/resources/ad_group_criterion_simulation.proto";
+import "google/ads/googleads/v13/resources/ad_group_customizer.proto";
+import "google/ads/googleads/v13/resources/ad_group_extension_setting.proto";
+import "google/ads/googleads/v13/resources/ad_group_feed.proto";
+import "google/ads/googleads/v13/resources/ad_group_label.proto";
+import "google/ads/googleads/v13/resources/ad_group_simulation.proto";
+import "google/ads/googleads/v13/resources/ad_parameter.proto";
+import "google/ads/googleads/v13/resources/ad_schedule_view.proto";
+import "google/ads/googleads/v13/resources/age_range_view.proto";
+import "google/ads/googleads/v13/resources/asset.proto";
+import "google/ads/googleads/v13/resources/asset_field_type_view.proto";
+import "google/ads/googleads/v13/resources/asset_group.proto";
+import "google/ads/googleads/v13/resources/asset_group_asset.proto";
+import "google/ads/googleads/v13/resources/asset_group_listing_group_filter.proto";
+import "google/ads/googleads/v13/resources/asset_group_product_group_view.proto";
+import "google/ads/googleads/v13/resources/asset_group_signal.proto";
+import "google/ads/googleads/v13/resources/asset_set.proto";
+import "google/ads/googleads/v13/resources/asset_set_asset.proto";
+import "google/ads/googleads/v13/resources/asset_set_type_view.proto";
+import "google/ads/googleads/v13/resources/audience.proto";
+import "google/ads/googleads/v13/resources/batch_job.proto";
+import "google/ads/googleads/v13/resources/bidding_data_exclusion.proto";
+import "google/ads/googleads/v13/resources/bidding_seasonality_adjustment.proto";
+import "google/ads/googleads/v13/resources/bidding_strategy.proto";
+import "google/ads/googleads/v13/resources/bidding_strategy_simulation.proto";
+import "google/ads/googleads/v13/resources/billing_setup.proto";
+import "google/ads/googleads/v13/resources/call_view.proto";
+import "google/ads/googleads/v13/resources/campaign.proto";
+import "google/ads/googleads/v13/resources/campaign_asset.proto";
+import "google/ads/googleads/v13/resources/campaign_asset_set.proto";
+import "google/ads/googleads/v13/resources/campaign_audience_view.proto";
+import "google/ads/googleads/v13/resources/campaign_bid_modifier.proto";
+import "google/ads/googleads/v13/resources/campaign_budget.proto";
+import "google/ads/googleads/v13/resources/campaign_conversion_goal.proto";
+import "google/ads/googleads/v13/resources/campaign_criterion.proto";
+import "google/ads/googleads/v13/resources/campaign_criterion_simulation.proto";
+import "google/ads/googleads/v13/resources/campaign_customizer.proto";
+import "google/ads/googleads/v13/resources/campaign_draft.proto";
+import "google/ads/googleads/v13/resources/campaign_extension_setting.proto";
+import "google/ads/googleads/v13/resources/campaign_feed.proto";
+import "google/ads/googleads/v13/resources/campaign_group.proto";
+import "google/ads/googleads/v13/resources/campaign_label.proto";
+import "google/ads/googleads/v13/resources/campaign_shared_set.proto";
+import "google/ads/googleads/v13/resources/campaign_simulation.proto";
+import "google/ads/googleads/v13/resources/carrier_constant.proto";
+import "google/ads/googleads/v13/resources/change_event.proto";
+import "google/ads/googleads/v13/resources/change_status.proto";
+import "google/ads/googleads/v13/resources/click_view.proto";
+import "google/ads/googleads/v13/resources/combined_audience.proto";
+import "google/ads/googleads/v13/resources/conversion_action.proto";
+import "google/ads/googleads/v13/resources/conversion_custom_variable.proto";
+import "google/ads/googleads/v13/resources/conversion_goal_campaign_config.proto";
+import "google/ads/googleads/v13/resources/conversion_value_rule.proto";
+import "google/ads/googleads/v13/resources/conversion_value_rule_set.proto";
+import "google/ads/googleads/v13/resources/currency_constant.proto";
+import "google/ads/googleads/v13/resources/custom_audience.proto";
+import "google/ads/googleads/v13/resources/custom_conversion_goal.proto";
+import "google/ads/googleads/v13/resources/custom_interest.proto";
+import "google/ads/googleads/v13/resources/customer.proto";
+import "google/ads/googleads/v13/resources/customer_asset.proto";
+import "google/ads/googleads/v13/resources/customer_asset_set.proto";
+import "google/ads/googleads/v13/resources/customer_client.proto";
+import "google/ads/googleads/v13/resources/customer_client_link.proto";
+import "google/ads/googleads/v13/resources/customer_conversion_goal.proto";
+import "google/ads/googleads/v13/resources/customer_customizer.proto";
+import "google/ads/googleads/v13/resources/customer_extension_setting.proto";
+import "google/ads/googleads/v13/resources/customer_feed.proto";
+import "google/ads/googleads/v13/resources/customer_label.proto";
+import "google/ads/googleads/v13/resources/customer_manager_link.proto";
+import "google/ads/googleads/v13/resources/customer_negative_criterion.proto";
+import "google/ads/googleads/v13/resources/customer_user_access.proto";
+import "google/ads/googleads/v13/resources/customer_user_access_invitation.proto";
+import "google/ads/googleads/v13/resources/customizer_attribute.proto";
+import "google/ads/googleads/v13/resources/detail_placement_view.proto";
+import "google/ads/googleads/v13/resources/detailed_demographic.proto";
+import "google/ads/googleads/v13/resources/display_keyword_view.proto";
+import "google/ads/googleads/v13/resources/distance_view.proto";
+import "google/ads/googleads/v13/resources/domain_category.proto";
+import "google/ads/googleads/v13/resources/dynamic_search_ads_search_term_view.proto";
+import "google/ads/googleads/v13/resources/expanded_landing_page_view.proto";
+import "google/ads/googleads/v13/resources/experiment.proto";
+import "google/ads/googleads/v13/resources/experiment_arm.proto";
+import "google/ads/googleads/v13/resources/extension_feed_item.proto";
+import "google/ads/googleads/v13/resources/feed.proto";
+import "google/ads/googleads/v13/resources/feed_item.proto";
+import "google/ads/googleads/v13/resources/feed_item_set.proto";
+import "google/ads/googleads/v13/resources/feed_item_set_link.proto";
+import "google/ads/googleads/v13/resources/feed_item_target.proto";
+import "google/ads/googleads/v13/resources/feed_mapping.proto";
+import "google/ads/googleads/v13/resources/feed_placeholder_view.proto";
+import "google/ads/googleads/v13/resources/gender_view.proto";
+import "google/ads/googleads/v13/resources/geo_target_constant.proto";
+import "google/ads/googleads/v13/resources/geographic_view.proto";
+import "google/ads/googleads/v13/resources/group_placement_view.proto";
+import "google/ads/googleads/v13/resources/hotel_group_view.proto";
+import "google/ads/googleads/v13/resources/hotel_performance_view.proto";
+import "google/ads/googleads/v13/resources/hotel_reconciliation.proto";
+import "google/ads/googleads/v13/resources/income_range_view.proto";
+import "google/ads/googleads/v13/resources/keyword_plan.proto";
+import "google/ads/googleads/v13/resources/keyword_plan_ad_group.proto";
+import "google/ads/googleads/v13/resources/keyword_plan_ad_group_keyword.proto";
+import "google/ads/googleads/v13/resources/keyword_plan_campaign.proto";
+import "google/ads/googleads/v13/resources/keyword_plan_campaign_keyword.proto";
+import "google/ads/googleads/v13/resources/keyword_theme_constant.proto";
+import "google/ads/googleads/v13/resources/keyword_view.proto";
+import "google/ads/googleads/v13/resources/label.proto";
+import "google/ads/googleads/v13/resources/landing_page_view.proto";
+import "google/ads/googleads/v13/resources/language_constant.proto";
+import "google/ads/googleads/v13/resources/lead_form_submission_data.proto";
+import "google/ads/googleads/v13/resources/life_event.proto";
+import "google/ads/googleads/v13/resources/location_view.proto";
+import "google/ads/googleads/v13/resources/managed_placement_view.proto";
+import "google/ads/googleads/v13/resources/media_file.proto";
+import "google/ads/googleads/v13/resources/mobile_app_category_constant.proto";
+import "google/ads/googleads/v13/resources/mobile_device_constant.proto";
+import "google/ads/googleads/v13/resources/offline_user_data_job.proto";
+import "google/ads/googleads/v13/resources/operating_system_version_constant.proto";
+import "google/ads/googleads/v13/resources/paid_organic_search_term_view.proto";
+import "google/ads/googleads/v13/resources/parental_status_view.proto";
+import "google/ads/googleads/v13/resources/per_store_view.proto";
+import "google/ads/googleads/v13/resources/product_bidding_category_constant.proto";
+import "google/ads/googleads/v13/resources/product_group_view.proto";
+import "google/ads/googleads/v13/resources/product_link.proto";
+import "google/ads/googleads/v13/resources/qualifying_question.proto";
+import "google/ads/googleads/v13/resources/recommendation.proto";
+import "google/ads/googleads/v13/resources/remarketing_action.proto";
+import "google/ads/googleads/v13/resources/search_term_view.proto";
+import "google/ads/googleads/v13/resources/shared_criterion.proto";
+import "google/ads/googleads/v13/resources/shared_set.proto";
+import "google/ads/googleads/v13/resources/shopping_performance_view.proto";
+import "google/ads/googleads/v13/resources/smart_campaign_search_term_view.proto";
+import "google/ads/googleads/v13/resources/smart_campaign_setting.proto";
+import "google/ads/googleads/v13/resources/third_party_app_analytics_link.proto";
+import "google/ads/googleads/v13/resources/topic_constant.proto";
+import "google/ads/googleads/v13/resources/topic_view.proto";
+import "google/ads/googleads/v13/resources/travel_activity_group_view.proto";
+import "google/ads/googleads/v13/resources/travel_activity_performance_view.proto";
+import "google/ads/googleads/v13/resources/user_interest.proto";
+import "google/ads/googleads/v13/resources/user_list.proto";
+import "google/ads/googleads/v13/resources/user_location_view.proto";
+import "google/ads/googleads/v13/resources/video.proto";
+import "google/ads/googleads/v13/resources/webpage_view.proto";
+import "google/ads/googleads/v13/services/ad_group_ad_label_service.proto";
+import "google/ads/googleads/v13/services/ad_group_ad_service.proto";
+import "google/ads/googleads/v13/services/ad_group_asset_service.proto";
+import "google/ads/googleads/v13/services/ad_group_bid_modifier_service.proto";
+import "google/ads/googleads/v13/services/ad_group_criterion_customizer_service.proto";
+import "google/ads/googleads/v13/services/ad_group_criterion_label_service.proto";
+import "google/ads/googleads/v13/services/ad_group_criterion_service.proto";
+import "google/ads/googleads/v13/services/ad_group_customizer_service.proto";
+import "google/ads/googleads/v13/services/ad_group_extension_setting_service.proto";
+import "google/ads/googleads/v13/services/ad_group_feed_service.proto";
+import "google/ads/googleads/v13/services/ad_group_label_service.proto";
+import "google/ads/googleads/v13/services/ad_group_service.proto";
+import "google/ads/googleads/v13/services/ad_parameter_service.proto";
+import "google/ads/googleads/v13/services/ad_service.proto";
+import "google/ads/googleads/v13/services/asset_group_asset_service.proto";
+import "google/ads/googleads/v13/services/asset_group_listing_group_filter_service.proto";
+import "google/ads/googleads/v13/services/asset_group_service.proto";
+import "google/ads/googleads/v13/services/asset_group_signal_service.proto";
+import "google/ads/googleads/v13/services/asset_service.proto";
+import "google/ads/googleads/v13/services/asset_set_asset_service.proto";
+import "google/ads/googleads/v13/services/asset_set_service.proto";
+import "google/ads/googleads/v13/services/audience_service.proto";
+import "google/ads/googleads/v13/services/bidding_data_exclusion_service.proto";
+import "google/ads/googleads/v13/services/bidding_seasonality_adjustment_service.proto";
+import "google/ads/googleads/v13/services/bidding_strategy_service.proto";
+import "google/ads/googleads/v13/services/campaign_asset_service.proto";
+import "google/ads/googleads/v13/services/campaign_asset_set_service.proto";
+import "google/ads/googleads/v13/services/campaign_bid_modifier_service.proto";
+import "google/ads/googleads/v13/services/campaign_budget_service.proto";
+import "google/ads/googleads/v13/services/campaign_conversion_goal_service.proto";
+import "google/ads/googleads/v13/services/campaign_criterion_service.proto";
+import "google/ads/googleads/v13/services/campaign_customizer_service.proto";
+import "google/ads/googleads/v13/services/campaign_draft_service.proto";
+import "google/ads/googleads/v13/services/campaign_extension_setting_service.proto";
+import "google/ads/googleads/v13/services/campaign_feed_service.proto";
+import "google/ads/googleads/v13/services/campaign_group_service.proto";
+import "google/ads/googleads/v13/services/campaign_label_service.proto";
+import "google/ads/googleads/v13/services/campaign_service.proto";
+import "google/ads/googleads/v13/services/campaign_shared_set_service.proto";
+import "google/ads/googleads/v13/services/conversion_action_service.proto";
+import "google/ads/googleads/v13/services/conversion_custom_variable_service.proto";
+import "google/ads/googleads/v13/services/conversion_goal_campaign_config_service.proto";
+import "google/ads/googleads/v13/services/conversion_value_rule_service.proto";
+import "google/ads/googleads/v13/services/conversion_value_rule_set_service.proto";
+import "google/ads/googleads/v13/services/custom_conversion_goal_service.proto";
+import "google/ads/googleads/v13/services/customer_asset_service.proto";
+import "google/ads/googleads/v13/services/customer_conversion_goal_service.proto";
+import "google/ads/googleads/v13/services/customer_customizer_service.proto";
+import "google/ads/googleads/v13/services/customer_extension_setting_service.proto";
+import "google/ads/googleads/v13/services/customer_feed_service.proto";
+import "google/ads/googleads/v13/services/customer_label_service.proto";
+import "google/ads/googleads/v13/services/customer_negative_criterion_service.proto";
+import "google/ads/googleads/v13/services/customer_service.proto";
+import "google/ads/googleads/v13/services/customizer_attribute_service.proto";
+import "google/ads/googleads/v13/services/experiment_arm_service.proto";
+import "google/ads/googleads/v13/services/experiment_service.proto";
+import "google/ads/googleads/v13/services/extension_feed_item_service.proto";
+import "google/ads/googleads/v13/services/feed_item_service.proto";
+import "google/ads/googleads/v13/services/feed_item_set_link_service.proto";
+import "google/ads/googleads/v13/services/feed_item_set_service.proto";
+import "google/ads/googleads/v13/services/feed_item_target_service.proto";
+import "google/ads/googleads/v13/services/feed_mapping_service.proto";
+import "google/ads/googleads/v13/services/feed_service.proto";
+import "google/ads/googleads/v13/services/keyword_plan_ad_group_keyword_service.proto";
+import "google/ads/googleads/v13/services/keyword_plan_ad_group_service.proto";
+import "google/ads/googleads/v13/services/keyword_plan_campaign_keyword_service.proto";
+import "google/ads/googleads/v13/services/keyword_plan_campaign_service.proto";
+import "google/ads/googleads/v13/services/keyword_plan_service.proto";
+import "google/ads/googleads/v13/services/label_service.proto";
+import "google/ads/googleads/v13/services/media_file_service.proto";
+import "google/ads/googleads/v13/services/remarketing_action_service.proto";
+import "google/ads/googleads/v13/services/shared_criterion_service.proto";
+import "google/ads/googleads/v13/services/shared_set_service.proto";
+import "google/ads/googleads/v13/services/smart_campaign_setting_service.proto";
+import "google/ads/googleads/v13/services/user_list_service.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "GoogleAdsServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the GoogleAdsService.
@@ -284,7 +290,7 @@ service GoogleAdsService {
// [RequestError]()
rpc Search(SearchGoogleAdsRequest) returns (SearchGoogleAdsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/googleAds:search"
+ post: "/v13/customers/{customer_id=*}/googleAds:search"
body: "*"
};
option (google.api.method_signature) = "customer_id,query";
@@ -303,9 +309,10 @@ service GoogleAdsService {
// [QueryError]()
// [QuotaError]()
// [RequestError]()
- rpc SearchStream(SearchGoogleAdsStreamRequest) returns (stream SearchGoogleAdsStreamResponse) {
+ rpc SearchStream(SearchGoogleAdsStreamRequest)
+ returns (stream SearchGoogleAdsStreamResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/googleAds:searchStream"
+ post: "/v13/customers/{customer_id=*}/googleAds:searchStream"
body: "*"
};
option (google.api.method_signature) = "customer_id,query";
@@ -330,7 +337,7 @@ service GoogleAdsService {
//
// Atomicity makes error handling much easier. If you're making a series of
// changes and one fails, it can leave your account in an inconsistent state.
- // With atomicity, you either reach the desired state directly, or the request
+ // With atomicity, you either reach the chosen state directly, or the request
// fails and you can retry.
//
// ## Temp Resource Names
@@ -425,14 +432,15 @@ service GoogleAdsService {
// [YoutubeVideoRegistrationError]()
rpc Mutate(MutateGoogleAdsRequest) returns (MutateGoogleAdsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/googleAds:mutate"
+ post: "/v13/customers/{customer_id=*}/googleAds:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,mutate_operations";
}
}
-// Request message for [GoogleAdsService.Search][google.ads.googleads.v10.services.GoogleAdsService.Search].
+// Request message for
+// [GoogleAdsService.Search][google.ads.googleads.v13.services.GoogleAdsService.Search].
message SearchGoogleAdsRequest {
// Required. The ID of the customer being queried.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
@@ -462,10 +470,12 @@ message SearchGoogleAdsRequest {
// Determines whether a summary row will be returned. By default, summary row
// is not returned. If requested, the summary row will be sent in a response
// by itself after all other query results are returned.
- google.ads.googleads.v10.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8;
+ google.ads.googleads.v13.enums.SummaryRowSettingEnum.SummaryRowSetting
+ summary_row_setting = 8;
}
-// Response message for [GoogleAdsService.Search][google.ads.googleads.v10.services.GoogleAdsService.Search].
+// Response message for
+// [GoogleAdsService.Search][google.ads.googleads.v13.services.GoogleAdsService.Search].
message SearchGoogleAdsResponse {
// The list of rows that matched the query.
repeated GoogleAdsRow results = 1;
@@ -489,7 +499,8 @@ message SearchGoogleAdsResponse {
GoogleAdsRow summary_row = 6;
}
-// Request message for [GoogleAdsService.SearchStream][google.ads.googleads.v10.services.GoogleAdsService.SearchStream].
+// Request message for
+// [GoogleAdsService.SearchStream][google.ads.googleads.v13.services.GoogleAdsService.SearchStream].
message SearchGoogleAdsStreamRequest {
// Required. The ID of the customer being queried.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
@@ -500,10 +511,12 @@ message SearchGoogleAdsStreamRequest {
// Determines whether a summary row will be returned. By default, summary row
// is not returned. If requested, the summary row will be sent in a response
// by itself after all other query results are returned.
- google.ads.googleads.v10.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3;
+ google.ads.googleads.v13.enums.SummaryRowSettingEnum.SummaryRowSetting
+ summary_row_setting = 3;
}
-// Response message for [GoogleAdsService.SearchStream][google.ads.googleads.v10.services.GoogleAdsService.SearchStream].
+// Response message for
+// [GoogleAdsService.SearchStream][google.ads.googleads.v13.services.GoogleAdsService.SearchStream].
message SearchGoogleAdsStreamResponse {
// The list of rows that matched the query.
repeated GoogleAdsRow results = 1;
@@ -523,472 +536,564 @@ message SearchGoogleAdsStreamResponse {
// A returned row from the query.
message GoogleAdsRow {
// The account budget in the query.
- google.ads.googleads.v10.resources.AccountBudget account_budget = 42;
+ google.ads.googleads.v13.resources.AccountBudget account_budget = 42;
// The account budget proposal referenced in the query.
- google.ads.googleads.v10.resources.AccountBudgetProposal account_budget_proposal = 43;
+ google.ads.googleads.v13.resources.AccountBudgetProposal
+ account_budget_proposal = 43;
// The AccountLink referenced in the query.
- google.ads.googleads.v10.resources.AccountLink account_link = 143;
+ google.ads.googleads.v13.resources.AccountLink account_link = 143;
// The ad group referenced in the query.
- google.ads.googleads.v10.resources.AdGroup ad_group = 3;
+ google.ads.googleads.v13.resources.AdGroup ad_group = 3;
// The ad referenced in the query.
- google.ads.googleads.v10.resources.AdGroupAd ad_group_ad = 16;
+ google.ads.googleads.v13.resources.AdGroupAd ad_group_ad = 16;
// The ad group ad asset combination view in the query.
- google.ads.googleads.v10.resources.AdGroupAdAssetCombinationView ad_group_ad_asset_combination_view = 193;
+ google.ads.googleads.v13.resources.AdGroupAdAssetCombinationView
+ ad_group_ad_asset_combination_view = 193;
// The ad group ad asset view in the query.
- google.ads.googleads.v10.resources.AdGroupAdAssetView ad_group_ad_asset_view = 131;
+ google.ads.googleads.v13.resources.AdGroupAdAssetView ad_group_ad_asset_view =
+ 131;
// The ad group ad label referenced in the query.
- google.ads.googleads.v10.resources.AdGroupAdLabel ad_group_ad_label = 120;
+ google.ads.googleads.v13.resources.AdGroupAdLabel ad_group_ad_label = 120;
// The ad group asset referenced in the query.
- google.ads.googleads.v10.resources.AdGroupAsset ad_group_asset = 154;
+ google.ads.googleads.v13.resources.AdGroupAsset ad_group_asset = 154;
+
+ // The ad group asset set referenced in the query.
+ google.ads.googleads.v13.resources.AdGroupAssetSet ad_group_asset_set = 196;
// The ad group audience view referenced in the query.
- google.ads.googleads.v10.resources.AdGroupAudienceView ad_group_audience_view = 57;
+ google.ads.googleads.v13.resources.AdGroupAudienceView
+ ad_group_audience_view = 57;
// The bid modifier referenced in the query.
- google.ads.googleads.v10.resources.AdGroupBidModifier ad_group_bid_modifier = 24;
+ google.ads.googleads.v13.resources.AdGroupBidModifier ad_group_bid_modifier =
+ 24;
// The criterion referenced in the query.
- google.ads.googleads.v10.resources.AdGroupCriterion ad_group_criterion = 17;
+ google.ads.googleads.v13.resources.AdGroupCriterion ad_group_criterion = 17;
// The ad group criterion customizer referenced in the query.
- google.ads.googleads.v10.resources.AdGroupCriterionCustomizer ad_group_criterion_customizer = 187;
+ google.ads.googleads.v13.resources.AdGroupCriterionCustomizer
+ ad_group_criterion_customizer = 187;
// The ad group criterion label referenced in the query.
- google.ads.googleads.v10.resources.AdGroupCriterionLabel ad_group_criterion_label = 121;
+ google.ads.googleads.v13.resources.AdGroupCriterionLabel
+ ad_group_criterion_label = 121;
// The ad group criterion simulation referenced in the query.
- google.ads.googleads.v10.resources.AdGroupCriterionSimulation ad_group_criterion_simulation = 110;
+ google.ads.googleads.v13.resources.AdGroupCriterionSimulation
+ ad_group_criterion_simulation = 110;
// The ad group customizer referenced in the query.
- google.ads.googleads.v10.resources.AdGroupCustomizer ad_group_customizer = 185;
+ google.ads.googleads.v13.resources.AdGroupCustomizer ad_group_customizer =
+ 185;
// The ad group extension setting referenced in the query.
- google.ads.googleads.v10.resources.AdGroupExtensionSetting ad_group_extension_setting = 112;
+ google.ads.googleads.v13.resources.AdGroupExtensionSetting
+ ad_group_extension_setting = 112;
// The ad group feed referenced in the query.
- google.ads.googleads.v10.resources.AdGroupFeed ad_group_feed = 67;
+ google.ads.googleads.v13.resources.AdGroupFeed ad_group_feed = 67;
// The ad group label referenced in the query.
- google.ads.googleads.v10.resources.AdGroupLabel ad_group_label = 115;
+ google.ads.googleads.v13.resources.AdGroupLabel ad_group_label = 115;
// The ad group simulation referenced in the query.
- google.ads.googleads.v10.resources.AdGroupSimulation ad_group_simulation = 107;
+ google.ads.googleads.v13.resources.AdGroupSimulation ad_group_simulation =
+ 107;
// The ad parameter referenced in the query.
- google.ads.googleads.v10.resources.AdParameter ad_parameter = 130;
+ google.ads.googleads.v13.resources.AdParameter ad_parameter = 130;
// The age range view referenced in the query.
- google.ads.googleads.v10.resources.AgeRangeView age_range_view = 48;
+ google.ads.googleads.v13.resources.AgeRangeView age_range_view = 48;
// The ad schedule view referenced in the query.
- google.ads.googleads.v10.resources.AdScheduleView ad_schedule_view = 89;
+ google.ads.googleads.v13.resources.AdScheduleView ad_schedule_view = 89;
// The domain category referenced in the query.
- google.ads.googleads.v10.resources.DomainCategory domain_category = 91;
+ google.ads.googleads.v13.resources.DomainCategory domain_category = 91;
// The asset referenced in the query.
- google.ads.googleads.v10.resources.Asset asset = 105;
+ google.ads.googleads.v13.resources.Asset asset = 105;
// The asset field type view referenced in the query.
- google.ads.googleads.v10.resources.AssetFieldTypeView asset_field_type_view = 168;
+ google.ads.googleads.v13.resources.AssetFieldTypeView asset_field_type_view =
+ 168;
// The asset group asset referenced in the query.
- google.ads.googleads.v10.resources.AssetGroupAsset asset_group_asset = 173;
+ google.ads.googleads.v13.resources.AssetGroupAsset asset_group_asset = 173;
// The asset group signal referenced in the query.
- google.ads.googleads.v10.resources.AssetGroupSignal asset_group_signal = 191;
+ google.ads.googleads.v13.resources.AssetGroupSignal asset_group_signal = 191;
// The asset group listing group filter referenced in the query.
- google.ads.googleads.v10.resources.AssetGroupListingGroupFilter asset_group_listing_group_filter = 182;
+ google.ads.googleads.v13.resources.AssetGroupListingGroupFilter
+ asset_group_listing_group_filter = 182;
// The asset group product group view referenced in the query.
- google.ads.googleads.v10.resources.AssetGroupProductGroupView asset_group_product_group_view = 189;
+ google.ads.googleads.v13.resources.AssetGroupProductGroupView
+ asset_group_product_group_view = 189;
// The asset group referenced in the query.
- google.ads.googleads.v10.resources.AssetGroup asset_group = 172;
+ google.ads.googleads.v13.resources.AssetGroup asset_group = 172;
// The asset set asset referenced in the query.
- google.ads.googleads.v10.resources.AssetSetAsset asset_set_asset = 180;
+ google.ads.googleads.v13.resources.AssetSetAsset asset_set_asset = 180;
// The asset set referenced in the query.
- google.ads.googleads.v10.resources.AssetSet asset_set = 179;
+ google.ads.googleads.v13.resources.AssetSet asset_set = 179;
+
+ // The asset set type view referenced in the query.
+ google.ads.googleads.v13.resources.AssetSetTypeView asset_set_type_view = 197;
// The batch job referenced in the query.
- google.ads.googleads.v10.resources.BatchJob batch_job = 139;
+ google.ads.googleads.v13.resources.BatchJob batch_job = 139;
// The bidding data exclusion referenced in the query.
- google.ads.googleads.v10.resources.BiddingDataExclusion bidding_data_exclusion = 159;
+ google.ads.googleads.v13.resources.BiddingDataExclusion
+ bidding_data_exclusion = 159;
// The bidding seasonality adjustment referenced in the query.
- google.ads.googleads.v10.resources.BiddingSeasonalityAdjustment bidding_seasonality_adjustment = 160;
+ google.ads.googleads.v13.resources.BiddingSeasonalityAdjustment
+ bidding_seasonality_adjustment = 160;
// The bidding strategy referenced in the query.
- google.ads.googleads.v10.resources.BiddingStrategy bidding_strategy = 18;
+ google.ads.googleads.v13.resources.BiddingStrategy bidding_strategy = 18;
// The bidding strategy simulation referenced in the query.
- google.ads.googleads.v10.resources.BiddingStrategySimulation bidding_strategy_simulation = 158;
+ google.ads.googleads.v13.resources.BiddingStrategySimulation
+ bidding_strategy_simulation = 158;
// The billing setup referenced in the query.
- google.ads.googleads.v10.resources.BillingSetup billing_setup = 41;
+ google.ads.googleads.v13.resources.BillingSetup billing_setup = 41;
// The call view referenced in the query.
- google.ads.googleads.v10.resources.CallView call_view = 152;
+ google.ads.googleads.v13.resources.CallView call_view = 152;
// The campaign budget referenced in the query.
- google.ads.googleads.v10.resources.CampaignBudget campaign_budget = 19;
+ google.ads.googleads.v13.resources.CampaignBudget campaign_budget = 19;
// The campaign referenced in the query.
- google.ads.googleads.v10.resources.Campaign campaign = 2;
+ google.ads.googleads.v13.resources.Campaign campaign = 2;
// The campaign asset referenced in the query.
- google.ads.googleads.v10.resources.CampaignAsset campaign_asset = 142;
+ google.ads.googleads.v13.resources.CampaignAsset campaign_asset = 142;
// The campaign asset set referenced in the query.
- google.ads.googleads.v10.resources.CampaignAssetSet campaign_asset_set = 181;
+ google.ads.googleads.v13.resources.CampaignAssetSet campaign_asset_set = 181;
// The campaign audience view referenced in the query.
- google.ads.googleads.v10.resources.CampaignAudienceView campaign_audience_view = 69;
+ google.ads.googleads.v13.resources.CampaignAudienceView
+ campaign_audience_view = 69;
// The campaign bid modifier referenced in the query.
- google.ads.googleads.v10.resources.CampaignBidModifier campaign_bid_modifier = 26;
+ google.ads.googleads.v13.resources.CampaignBidModifier campaign_bid_modifier =
+ 26;
// The CampaignConversionGoal referenced in the query.
- google.ads.googleads.v10.resources.CampaignConversionGoal campaign_conversion_goal = 175;
+ google.ads.googleads.v13.resources.CampaignConversionGoal
+ campaign_conversion_goal = 175;
// The campaign criterion referenced in the query.
- google.ads.googleads.v10.resources.CampaignCriterion campaign_criterion = 20;
+ google.ads.googleads.v13.resources.CampaignCriterion campaign_criterion = 20;
// The campaign criterion simulation referenced in the query.
- google.ads.googleads.v10.resources.CampaignCriterionSimulation campaign_criterion_simulation = 111;
+ google.ads.googleads.v13.resources.CampaignCriterionSimulation
+ campaign_criterion_simulation = 111;
// The campaign customizer referenced in the query.
- google.ads.googleads.v10.resources.CampaignCustomizer campaign_customizer = 186;
+ google.ads.googleads.v13.resources.CampaignCustomizer campaign_customizer =
+ 186;
// The campaign draft referenced in the query.
- google.ads.googleads.v10.resources.CampaignDraft campaign_draft = 49;
-
- // The campaign experiment referenced in the query.
- google.ads.googleads.v10.resources.CampaignExperiment campaign_experiment = 84;
+ google.ads.googleads.v13.resources.CampaignDraft campaign_draft = 49;
// The campaign extension setting referenced in the query.
- google.ads.googleads.v10.resources.CampaignExtensionSetting campaign_extension_setting = 113;
+ google.ads.googleads.v13.resources.CampaignExtensionSetting
+ campaign_extension_setting = 113;
// The campaign feed referenced in the query.
- google.ads.googleads.v10.resources.CampaignFeed campaign_feed = 63;
+ google.ads.googleads.v13.resources.CampaignFeed campaign_feed = 63;
// Campaign Group referenced in AWQL query.
- google.ads.googleads.v10.resources.CampaignGroup campaign_group = 25;
+ google.ads.googleads.v13.resources.CampaignGroup campaign_group = 25;
// The campaign label referenced in the query.
- google.ads.googleads.v10.resources.CampaignLabel campaign_label = 108;
+ google.ads.googleads.v13.resources.CampaignLabel campaign_label = 108;
// Campaign Shared Set referenced in AWQL query.
- google.ads.googleads.v10.resources.CampaignSharedSet campaign_shared_set = 30;
+ google.ads.googleads.v13.resources.CampaignSharedSet campaign_shared_set = 30;
// The campaign simulation referenced in the query.
- google.ads.googleads.v10.resources.CampaignSimulation campaign_simulation = 157;
+ google.ads.googleads.v13.resources.CampaignSimulation campaign_simulation =
+ 157;
// The carrier constant referenced in the query.
- google.ads.googleads.v10.resources.CarrierConstant carrier_constant = 66;
+ google.ads.googleads.v13.resources.CarrierConstant carrier_constant = 66;
// The ChangeEvent referenced in the query.
- google.ads.googleads.v10.resources.ChangeEvent change_event = 145;
+ google.ads.googleads.v13.resources.ChangeEvent change_event = 145;
// The ChangeStatus referenced in the query.
- google.ads.googleads.v10.resources.ChangeStatus change_status = 37;
+ google.ads.googleads.v13.resources.ChangeStatus change_status = 37;
// The CombinedAudience referenced in the query.
- google.ads.googleads.v10.resources.CombinedAudience combined_audience = 148;
+ google.ads.googleads.v13.resources.CombinedAudience combined_audience = 148;
// The Audience referenced in the query.
- google.ads.googleads.v10.resources.Audience audience = 190;
+ google.ads.googleads.v13.resources.Audience audience = 190;
// The conversion action referenced in the query.
- google.ads.googleads.v10.resources.ConversionAction conversion_action = 103;
+ google.ads.googleads.v13.resources.ConversionAction conversion_action = 103;
// The conversion custom variable referenced in the query.
- google.ads.googleads.v10.resources.ConversionCustomVariable conversion_custom_variable = 153;
+ google.ads.googleads.v13.resources.ConversionCustomVariable
+ conversion_custom_variable = 153;
// The ConversionGoalCampaignConfig referenced in the query.
- google.ads.googleads.v10.resources.ConversionGoalCampaignConfig conversion_goal_campaign_config = 177;
+ google.ads.googleads.v13.resources.ConversionGoalCampaignConfig
+ conversion_goal_campaign_config = 177;
// The conversion value rule referenced in the query.
- google.ads.googleads.v10.resources.ConversionValueRule conversion_value_rule = 164;
+ google.ads.googleads.v13.resources.ConversionValueRule conversion_value_rule =
+ 164;
// The conversion value rule set referenced in the query.
- google.ads.googleads.v10.resources.ConversionValueRuleSet conversion_value_rule_set = 165;
+ google.ads.googleads.v13.resources.ConversionValueRuleSet
+ conversion_value_rule_set = 165;
// The ClickView referenced in the query.
- google.ads.googleads.v10.resources.ClickView click_view = 122;
+ google.ads.googleads.v13.resources.ClickView click_view = 122;
// The currency constant referenced in the query.
- google.ads.googleads.v10.resources.CurrencyConstant currency_constant = 134;
+ google.ads.googleads.v13.resources.CurrencyConstant currency_constant = 134;
// The CustomAudience referenced in the query.
- google.ads.googleads.v10.resources.CustomAudience custom_audience = 147;
+ google.ads.googleads.v13.resources.CustomAudience custom_audience = 147;
// The CustomConversionGoal referenced in the query.
- google.ads.googleads.v10.resources.CustomConversionGoal custom_conversion_goal = 176;
+ google.ads.googleads.v13.resources.CustomConversionGoal
+ custom_conversion_goal = 176;
// The CustomInterest referenced in the query.
- google.ads.googleads.v10.resources.CustomInterest custom_interest = 104;
+ google.ads.googleads.v13.resources.CustomInterest custom_interest = 104;
// The customer referenced in the query.
- google.ads.googleads.v10.resources.Customer customer = 1;
+ google.ads.googleads.v13.resources.Customer customer = 1;
// The customer asset referenced in the query.
- google.ads.googleads.v10.resources.CustomerAsset customer_asset = 155;
+ google.ads.googleads.v13.resources.CustomerAsset customer_asset = 155;
+
+ // The customer asset set referenced in the query.
+ google.ads.googleads.v13.resources.CustomerAssetSet customer_asset_set = 195;
// The accessible bidding strategy referenced in the query.
- google.ads.googleads.v10.resources.AccessibleBiddingStrategy accessible_bidding_strategy = 169;
+ google.ads.googleads.v13.resources.AccessibleBiddingStrategy
+ accessible_bidding_strategy = 169;
// The customer customizer referenced in the query.
- google.ads.googleads.v10.resources.CustomerCustomizer customer_customizer = 184;
+ google.ads.googleads.v13.resources.CustomerCustomizer customer_customizer =
+ 184;
// The CustomerManagerLink referenced in the query.
- google.ads.googleads.v10.resources.CustomerManagerLink customer_manager_link = 61;
+ google.ads.googleads.v13.resources.CustomerManagerLink customer_manager_link =
+ 61;
// The CustomerClientLink referenced in the query.
- google.ads.googleads.v10.resources.CustomerClientLink customer_client_link = 62;
+ google.ads.googleads.v13.resources.CustomerClientLink customer_client_link =
+ 62;
// The CustomerClient referenced in the query.
- google.ads.googleads.v10.resources.CustomerClient customer_client = 70;
+ google.ads.googleads.v13.resources.CustomerClient customer_client = 70;
// The CustomerConversionGoal referenced in the query.
- google.ads.googleads.v10.resources.CustomerConversionGoal customer_conversion_goal = 174;
+ google.ads.googleads.v13.resources.CustomerConversionGoal
+ customer_conversion_goal = 174;
// The customer extension setting referenced in the query.
- google.ads.googleads.v10.resources.CustomerExtensionSetting customer_extension_setting = 114;
+ google.ads.googleads.v13.resources.CustomerExtensionSetting
+ customer_extension_setting = 114;
// The customer feed referenced in the query.
- google.ads.googleads.v10.resources.CustomerFeed customer_feed = 64;
+ google.ads.googleads.v13.resources.CustomerFeed customer_feed = 64;
// The customer label referenced in the query.
- google.ads.googleads.v10.resources.CustomerLabel customer_label = 124;
+ google.ads.googleads.v13.resources.CustomerLabel customer_label = 124;
// The customer negative criterion referenced in the query.
- google.ads.googleads.v10.resources.CustomerNegativeCriterion customer_negative_criterion = 88;
+ google.ads.googleads.v13.resources.CustomerNegativeCriterion
+ customer_negative_criterion = 88;
// The CustomerUserAccess referenced in the query.
- google.ads.googleads.v10.resources.CustomerUserAccess customer_user_access = 146;
+ google.ads.googleads.v13.resources.CustomerUserAccess customer_user_access =
+ 146;
// The CustomerUserAccessInvitation referenced in the query.
- google.ads.googleads.v10.resources.CustomerUserAccessInvitation customer_user_access_invitation = 150;
+ google.ads.googleads.v13.resources.CustomerUserAccessInvitation
+ customer_user_access_invitation = 150;
// The customizer attribute referenced in the query.
- google.ads.googleads.v10.resources.CustomizerAttribute customizer_attribute = 178;
+ google.ads.googleads.v13.resources.CustomizerAttribute customizer_attribute =
+ 178;
// The detail placement view referenced in the query.
- google.ads.googleads.v10.resources.DetailPlacementView detail_placement_view = 118;
+ google.ads.googleads.v13.resources.DetailPlacementView detail_placement_view =
+ 118;
// The detailed demographic referenced in the query.
- google.ads.googleads.v10.resources.DetailedDemographic detailed_demographic = 166;
+ google.ads.googleads.v13.resources.DetailedDemographic detailed_demographic =
+ 166;
// The display keyword view referenced in the query.
- google.ads.googleads.v10.resources.DisplayKeywordView display_keyword_view = 47;
+ google.ads.googleads.v13.resources.DisplayKeywordView display_keyword_view =
+ 47;
// The distance view referenced in the query.
- google.ads.googleads.v10.resources.DistanceView distance_view = 132;
+ google.ads.googleads.v13.resources.DistanceView distance_view = 132;
// The dynamic search ads search term view referenced in the query.
- google.ads.googleads.v10.resources.DynamicSearchAdsSearchTermView dynamic_search_ads_search_term_view = 106;
+ google.ads.googleads.v13.resources.DynamicSearchAdsSearchTermView
+ dynamic_search_ads_search_term_view = 106;
// The expanded landing page view referenced in the query.
- google.ads.googleads.v10.resources.ExpandedLandingPageView expanded_landing_page_view = 128;
+ google.ads.googleads.v13.resources.ExpandedLandingPageView
+ expanded_landing_page_view = 128;
// The extension feed item referenced in the query.
- google.ads.googleads.v10.resources.ExtensionFeedItem extension_feed_item = 85;
+ google.ads.googleads.v13.resources.ExtensionFeedItem extension_feed_item = 85;
// The feed referenced in the query.
- google.ads.googleads.v10.resources.Feed feed = 46;
+ google.ads.googleads.v13.resources.Feed feed = 46;
// The feed item referenced in the query.
- google.ads.googleads.v10.resources.FeedItem feed_item = 50;
+ google.ads.googleads.v13.resources.FeedItem feed_item = 50;
// The feed item set referenced in the query.
- google.ads.googleads.v10.resources.FeedItemSet feed_item_set = 149;
+ google.ads.googleads.v13.resources.FeedItemSet feed_item_set = 149;
// The feed item set link referenced in the query.
- google.ads.googleads.v10.resources.FeedItemSetLink feed_item_set_link = 151;
+ google.ads.googleads.v13.resources.FeedItemSetLink feed_item_set_link = 151;
// The feed item target referenced in the query.
- google.ads.googleads.v10.resources.FeedItemTarget feed_item_target = 116;
+ google.ads.googleads.v13.resources.FeedItemTarget feed_item_target = 116;
// The feed mapping referenced in the query.
- google.ads.googleads.v10.resources.FeedMapping feed_mapping = 58;
+ google.ads.googleads.v13.resources.FeedMapping feed_mapping = 58;
// The feed placeholder view referenced in the query.
- google.ads.googleads.v10.resources.FeedPlaceholderView feed_placeholder_view = 97;
+ google.ads.googleads.v13.resources.FeedPlaceholderView feed_placeholder_view =
+ 97;
// The gender view referenced in the query.
- google.ads.googleads.v10.resources.GenderView gender_view = 40;
+ google.ads.googleads.v13.resources.GenderView gender_view = 40;
// The geo target constant referenced in the query.
- google.ads.googleads.v10.resources.GeoTargetConstant geo_target_constant = 23;
+ google.ads.googleads.v13.resources.GeoTargetConstant geo_target_constant = 23;
// The geographic view referenced in the query.
- google.ads.googleads.v10.resources.GeographicView geographic_view = 125;
+ google.ads.googleads.v13.resources.GeographicView geographic_view = 125;
// The group placement view referenced in the query.
- google.ads.googleads.v10.resources.GroupPlacementView group_placement_view = 119;
+ google.ads.googleads.v13.resources.GroupPlacementView group_placement_view =
+ 119;
// The hotel group view referenced in the query.
- google.ads.googleads.v10.resources.HotelGroupView hotel_group_view = 51;
+ google.ads.googleads.v13.resources.HotelGroupView hotel_group_view = 51;
// The hotel performance view referenced in the query.
- google.ads.googleads.v10.resources.HotelPerformanceView hotel_performance_view = 71;
+ google.ads.googleads.v13.resources.HotelPerformanceView
+ hotel_performance_view = 71;
// The hotel reconciliation referenced in the query.
- google.ads.googleads.v10.resources.HotelReconciliation hotel_reconciliation = 188;
+ google.ads.googleads.v13.resources.HotelReconciliation hotel_reconciliation =
+ 188;
// The income range view referenced in the query.
- google.ads.googleads.v10.resources.IncomeRangeView income_range_view = 138;
+ google.ads.googleads.v13.resources.IncomeRangeView income_range_view = 138;
// The keyword view referenced in the query.
- google.ads.googleads.v10.resources.KeywordView keyword_view = 21;
+ google.ads.googleads.v13.resources.KeywordView keyword_view = 21;
// The keyword plan referenced in the query.
- google.ads.googleads.v10.resources.KeywordPlan keyword_plan = 32;
+ google.ads.googleads.v13.resources.KeywordPlan keyword_plan = 32;
// The keyword plan campaign referenced in the query.
- google.ads.googleads.v10.resources.KeywordPlanCampaign keyword_plan_campaign = 33;
+ google.ads.googleads.v13.resources.KeywordPlanCampaign keyword_plan_campaign =
+ 33;
// The keyword plan campaign keyword referenced in the query.
- google.ads.googleads.v10.resources.KeywordPlanCampaignKeyword keyword_plan_campaign_keyword = 140;
+ google.ads.googleads.v13.resources.KeywordPlanCampaignKeyword
+ keyword_plan_campaign_keyword = 140;
// The keyword plan ad group referenced in the query.
- google.ads.googleads.v10.resources.KeywordPlanAdGroup keyword_plan_ad_group = 35;
+ google.ads.googleads.v13.resources.KeywordPlanAdGroup keyword_plan_ad_group =
+ 35;
// The keyword plan ad group referenced in the query.
- google.ads.googleads.v10.resources.KeywordPlanAdGroupKeyword keyword_plan_ad_group_keyword = 141;
+ google.ads.googleads.v13.resources.KeywordPlanAdGroupKeyword
+ keyword_plan_ad_group_keyword = 141;
// The keyword theme constant referenced in the query.
- google.ads.googleads.v10.resources.KeywordThemeConstant keyword_theme_constant = 163;
+ google.ads.googleads.v13.resources.KeywordThemeConstant
+ keyword_theme_constant = 163;
// The label referenced in the query.
- google.ads.googleads.v10.resources.Label label = 52;
+ google.ads.googleads.v13.resources.Label label = 52;
// The landing page view referenced in the query.
- google.ads.googleads.v10.resources.LandingPageView landing_page_view = 126;
+ google.ads.googleads.v13.resources.LandingPageView landing_page_view = 126;
// The language constant referenced in the query.
- google.ads.googleads.v10.resources.LanguageConstant language_constant = 55;
+ google.ads.googleads.v13.resources.LanguageConstant language_constant = 55;
// The location view referenced in the query.
- google.ads.googleads.v10.resources.LocationView location_view = 123;
+ google.ads.googleads.v13.resources.LocationView location_view = 123;
// The managed placement view referenced in the query.
- google.ads.googleads.v10.resources.ManagedPlacementView managed_placement_view = 53;
+ google.ads.googleads.v13.resources.ManagedPlacementView
+ managed_placement_view = 53;
// The media file referenced in the query.
- google.ads.googleads.v10.resources.MediaFile media_file = 90;
+ google.ads.googleads.v13.resources.MediaFile media_file = 90;
// The mobile app category constant referenced in the query.
- google.ads.googleads.v10.resources.MobileAppCategoryConstant mobile_app_category_constant = 87;
+ google.ads.googleads.v13.resources.MobileAppCategoryConstant
+ mobile_app_category_constant = 87;
// The mobile device constant referenced in the query.
- google.ads.googleads.v10.resources.MobileDeviceConstant mobile_device_constant = 98;
+ google.ads.googleads.v13.resources.MobileDeviceConstant
+ mobile_device_constant = 98;
// The offline user data job referenced in the query.
- google.ads.googleads.v10.resources.OfflineUserDataJob offline_user_data_job = 137;
+ google.ads.googleads.v13.resources.OfflineUserDataJob offline_user_data_job =
+ 137;
// The operating system version constant referenced in the query.
- google.ads.googleads.v10.resources.OperatingSystemVersionConstant operating_system_version_constant = 86;
+ google.ads.googleads.v13.resources.OperatingSystemVersionConstant
+ operating_system_version_constant = 86;
// The paid organic search term view referenced in the query.
- google.ads.googleads.v10.resources.PaidOrganicSearchTermView paid_organic_search_term_view = 129;
+ google.ads.googleads.v13.resources.PaidOrganicSearchTermView
+ paid_organic_search_term_view = 129;
+
+ // The qualifying question referenced in the query.
+ google.ads.googleads.v13.resources.QualifyingQuestion qualifying_question =
+ 202;
// The parental status view referenced in the query.
- google.ads.googleads.v10.resources.ParentalStatusView parental_status_view = 45;
+ google.ads.googleads.v13.resources.ParentalStatusView parental_status_view =
+ 45;
+
+ // The per store view referenced in the query.
+ google.ads.googleads.v13.resources.PerStoreView per_store_view = 198;
// The Product Bidding Category referenced in the query.
- google.ads.googleads.v10.resources.ProductBiddingCategoryConstant product_bidding_category_constant = 109;
+ google.ads.googleads.v13.resources.ProductBiddingCategoryConstant
+ product_bidding_category_constant = 109;
// The product group view referenced in the query.
- google.ads.googleads.v10.resources.ProductGroupView product_group_view = 54;
+ google.ads.googleads.v13.resources.ProductGroupView product_group_view = 54;
+
+ // The product link referenced in the query.
+ google.ads.googleads.v13.resources.ProductLink product_link = 194;
// The recommendation referenced in the query.
- google.ads.googleads.v10.resources.Recommendation recommendation = 22;
+ google.ads.googleads.v13.resources.Recommendation recommendation = 22;
// The search term view referenced in the query.
- google.ads.googleads.v10.resources.SearchTermView search_term_view = 68;
+ google.ads.googleads.v13.resources.SearchTermView search_term_view = 68;
// The shared set referenced in the query.
- google.ads.googleads.v10.resources.SharedCriterion shared_criterion = 29;
+ google.ads.googleads.v13.resources.SharedCriterion shared_criterion = 29;
// The shared set referenced in the query.
- google.ads.googleads.v10.resources.SharedSet shared_set = 27;
+ google.ads.googleads.v13.resources.SharedSet shared_set = 27;
// The Smart campaign setting referenced in the query.
- google.ads.googleads.v10.resources.SmartCampaignSetting smart_campaign_setting = 167;
+ google.ads.googleads.v13.resources.SmartCampaignSetting
+ smart_campaign_setting = 167;
// The shopping performance view referenced in the query.
- google.ads.googleads.v10.resources.ShoppingPerformanceView shopping_performance_view = 117;
+ google.ads.googleads.v13.resources.ShoppingPerformanceView
+ shopping_performance_view = 117;
// The Smart campaign search term view referenced in the query.
- google.ads.googleads.v10.resources.SmartCampaignSearchTermView smart_campaign_search_term_view = 170;
+ google.ads.googleads.v13.resources.SmartCampaignSearchTermView
+ smart_campaign_search_term_view = 170;
// The AccountLink referenced in the query.
- google.ads.googleads.v10.resources.ThirdPartyAppAnalyticsLink third_party_app_analytics_link = 144;
+ google.ads.googleads.v13.resources.ThirdPartyAppAnalyticsLink
+ third_party_app_analytics_link = 144;
// The topic view referenced in the query.
- google.ads.googleads.v10.resources.TopicView topic_view = 44;
+ google.ads.googleads.v13.resources.TopicView topic_view = 44;
+
+ // The travel activity group view referenced in the query.
+ google.ads.googleads.v13.resources.TravelActivityGroupView
+ travel_activity_group_view = 201;
+
+ // The travel activity performance view referenced in the query.
+ google.ads.googleads.v13.resources.TravelActivityPerformanceView
+ travel_activity_performance_view = 200;
// The experiment referenced in the query.
- google.ads.googleads.v10.resources.Experiment experiment = 133;
+ google.ads.googleads.v13.resources.Experiment experiment = 133;
// The experiment arm referenced in the query.
- google.ads.googleads.v10.resources.ExperimentArm experiment_arm = 183;
+ google.ads.googleads.v13.resources.ExperimentArm experiment_arm = 183;
// The user interest referenced in the query.
- google.ads.googleads.v10.resources.UserInterest user_interest = 59;
+ google.ads.googleads.v13.resources.UserInterest user_interest = 59;
// The life event referenced in the query.
- google.ads.googleads.v10.resources.LifeEvent life_event = 161;
+ google.ads.googleads.v13.resources.LifeEvent life_event = 161;
// The user list referenced in the query.
- google.ads.googleads.v10.resources.UserList user_list = 38;
+ google.ads.googleads.v13.resources.UserList user_list = 38;
// The user location view referenced in the query.
- google.ads.googleads.v10.resources.UserLocationView user_location_view = 135;
+ google.ads.googleads.v13.resources.UserLocationView user_location_view = 135;
// The remarketing action referenced in the query.
- google.ads.googleads.v10.resources.RemarketingAction remarketing_action = 60;
+ google.ads.googleads.v13.resources.RemarketingAction remarketing_action = 60;
// The topic constant referenced in the query.
- google.ads.googleads.v10.resources.TopicConstant topic_constant = 31;
+ google.ads.googleads.v13.resources.TopicConstant topic_constant = 31;
// The video referenced in the query.
- google.ads.googleads.v10.resources.Video video = 39;
+ google.ads.googleads.v13.resources.Video video = 39;
// The webpage view referenced in the query.
- google.ads.googleads.v10.resources.WebpageView webpage_view = 162;
+ google.ads.googleads.v13.resources.WebpageView webpage_view = 162;
// The lead form user submission referenced in the query.
- google.ads.googleads.v10.resources.LeadFormSubmissionData lead_form_submission_data = 192;
+ google.ads.googleads.v13.resources.LeadFormSubmissionData
+ lead_form_submission_data = 192;
// The metrics.
- google.ads.googleads.v10.common.Metrics metrics = 4;
+ google.ads.googleads.v13.common.Metrics metrics = 4;
// The segments.
- google.ads.googleads.v10.common.Segments segments = 102;
+ google.ads.googleads.v13.common.Segments segments = 102;
}
-// Request message for [GoogleAdsService.Mutate][google.ads.googleads.v10.services.GoogleAdsService.Mutate].
+// Request message for
+// [GoogleAdsService.Mutate][google.ads.googleads.v13.services.GoogleAdsService.Mutate].
message MutateGoogleAdsRequest {
// Required. The ID of the customer whose resources are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual resources.
- repeated MutateOperation mutate_operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated MutateOperation mutate_operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -1003,16 +1108,18 @@ message MutateGoogleAdsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation. The mutable
// resource will only be returned if the resource has the appropriate response
- // field. E.g. MutateCampaignResult.campaign.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ // field. For example, MutateCampaignResult.campaign.
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
-// Response message for [GoogleAdsService.Mutate][google.ads.googleads.v10.services.GoogleAdsService.Mutate].
+// Response message for
+// [GoogleAdsService.Mutate][google.ads.googleads.v13.services.GoogleAdsService.Mutate].
message MutateGoogleAdsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g., auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All responses for the mutate.
@@ -1036,7 +1143,8 @@ message MutateOperation {
AdGroupBidModifierOperation ad_group_bid_modifier_operation = 2;
// An ad group criterion customizer mutate operation.
- AdGroupCriterionCustomizerOperation ad_group_criterion_customizer_operation = 77;
+ AdGroupCriterionCustomizerOperation
+ ad_group_criterion_customizer_operation = 77;
// An ad group criterion label mutate operation.
AdGroupCriterionLabelOperation ad_group_criterion_label_operation = 18;
@@ -1072,7 +1180,8 @@ message MutateOperation {
AssetGroupAssetOperation asset_group_asset_operation = 65;
// An asset group listing group filter mutate operation.
- AssetGroupListingGroupFilterOperation asset_group_listing_group_filter_operation = 78;
+ AssetGroupListingGroupFilterOperation
+ asset_group_listing_group_filter_operation = 78;
// An asset group signal mutate operation.
AssetGroupSignalOperation asset_group_signal_operation = 80;
@@ -1093,7 +1202,8 @@ message MutateOperation {
BiddingDataExclusionOperation bidding_data_exclusion_operation = 58;
// A bidding seasonality adjustment mutate operation.
- BiddingSeasonalityAdjustmentOperation bidding_seasonality_adjustment_operation = 59;
+ BiddingSeasonalityAdjustmentOperation
+ bidding_seasonality_adjustment_operation = 59;
// A bidding strategy mutate operation.
BiddingStrategyOperation bidding_strategy_operation = 6;
@@ -1116,15 +1226,12 @@ message MutateOperation {
// A campaign criterion mutate operation.
CampaignCriterionOperation campaign_criterion_operation = 13;
- // An campaign customizer mutate operation.
+ // A campaign customizer mutate operation.
CampaignCustomizerOperation campaign_customizer_operation = 76;
// A campaign draft mutate operation.
CampaignDraftOperation campaign_draft_operation = 24;
- // A campaign experiment mutate operation.
- CampaignExperimentOperation campaign_experiment_operation = 25;
-
// A campaign extension setting mutate operation.
CampaignExtensionSettingOperation campaign_extension_setting_operation = 26;
@@ -1150,7 +1257,8 @@ message MutateOperation {
ConversionCustomVariableOperation conversion_custom_variable_operation = 55;
// A conversion goal campaign config mutate operation.
- ConversionGoalCampaignConfigOperation conversion_goal_campaign_config_operation = 69;
+ ConversionGoalCampaignConfigOperation
+ conversion_goal_campaign_config_operation = 69;
// A conversion value rule mutate operation.
ConversionValueRuleOperation conversion_value_rule_operation = 63;
@@ -1167,7 +1275,7 @@ message MutateOperation {
// A customer conversion goal mutate operation.
CustomerConversionGoalOperation customer_conversion_goal_operation = 66;
- // An customer customizer mutate operation.
+ // A customer customizer mutate operation.
CustomerCustomizerOperation customer_customizer_operation = 79;
// A customer extension setting mutate operation.
@@ -1180,12 +1288,13 @@ message MutateOperation {
CustomerLabelOperation customer_label_operation = 32;
// A customer negative criterion mutate operation.
- CustomerNegativeCriterionOperation customer_negative_criterion_operation = 34;
+ CustomerNegativeCriterionOperation customer_negative_criterion_operation =
+ 34;
// A customer mutate operation.
CustomerOperation customer_operation = 35;
- // An customizer attribute mutate operation.
+ // A customizer attribute mutate operation.
CustomizerAttributeOperation customizer_attribute_operation = 70;
// An experiment mutate operation.
@@ -1219,10 +1328,12 @@ message MutateOperation {
KeywordPlanAdGroupOperation keyword_plan_ad_group_operation = 44;
// A keyword plan ad group keyword operation.
- KeywordPlanAdGroupKeywordOperation keyword_plan_ad_group_keyword_operation = 50;
+ KeywordPlanAdGroupKeywordOperation keyword_plan_ad_group_keyword_operation =
+ 50;
// A keyword plan campaign keyword operation.
- KeywordPlanCampaignKeywordOperation keyword_plan_campaign_keyword_operation = 51;
+ KeywordPlanCampaignKeywordOperation
+ keyword_plan_campaign_keyword_operation = 51;
// A keyword plan campaign operation.
KeywordPlanCampaignOperation keyword_plan_campaign_operation = 45;
@@ -1270,7 +1381,8 @@ message MutateOperationResponse {
MutateAdGroupBidModifierResult ad_group_bid_modifier_result = 2;
// The result for the ad group criterion customizer mutate.
- MutateAdGroupCriterionCustomizerResult ad_group_criterion_customizer_result = 77;
+ MutateAdGroupCriterionCustomizerResult
+ ad_group_criterion_customizer_result = 77;
// The result for the ad group criterion label mutate.
MutateAdGroupCriterionLabelResult ad_group_criterion_label_result = 18;
@@ -1306,7 +1418,8 @@ message MutateOperationResponse {
MutateAssetGroupAssetResult asset_group_asset_result = 65;
// The result for the asset group listing group filter mutate.
- MutateAssetGroupListingGroupFilterResult asset_group_listing_group_filter_result = 78;
+ MutateAssetGroupListingGroupFilterResult
+ asset_group_listing_group_filter_result = 78;
// The result for the asset group signal mutate.
MutateAssetGroupSignalResult asset_group_signal_result = 79;
@@ -1327,7 +1440,8 @@ message MutateOperationResponse {
MutateBiddingDataExclusionsResult bidding_data_exclusion_result = 58;
// The result for the bidding seasonality adjustment mutate.
- MutateBiddingSeasonalityAdjustmentsResult bidding_seasonality_adjustment_result = 59;
+ MutateBiddingSeasonalityAdjustmentsResult
+ bidding_seasonality_adjustment_result = 59;
// The result for the bidding strategy mutate.
MutateBiddingStrategyResult bidding_strategy_result = 6;
@@ -1356,9 +1470,6 @@ message MutateOperationResponse {
// The result for the campaign draft mutate.
MutateCampaignDraftResult campaign_draft_result = 24;
- // The result for the campaign experiment mutate.
- MutateCampaignExperimentResult campaign_experiment_result = 25;
-
// The result for the campaign extension setting mutate.
MutateCampaignExtensionSettingResult campaign_extension_setting_result = 26;
@@ -1384,7 +1495,8 @@ message MutateOperationResponse {
MutateConversionCustomVariableResult conversion_custom_variable_result = 55;
// The result for the conversion goal campaign config mutate.
- MutateConversionGoalCampaignConfigResult conversion_goal_campaign_config_result = 69;
+ MutateConversionGoalCampaignConfigResult
+ conversion_goal_campaign_config_result = 69;
// The result for the conversion value rule mutate.
MutateConversionValueRuleResult conversion_value_rule_result = 63;
@@ -1414,7 +1526,8 @@ message MutateOperationResponse {
MutateCustomerLabelResult customer_label_result = 32;
// The result for the customer negative criterion mutate.
- MutateCustomerNegativeCriteriaResult customer_negative_criterion_result = 34;
+ MutateCustomerNegativeCriteriaResult customer_negative_criterion_result =
+ 34;
// The result for the customer mutate.
MutateCustomerResult customer_result = 35;
@@ -1422,6 +1535,12 @@ message MutateOperationResponse {
// The result for the customizer attribute mutate.
MutateCustomizerAttributeResult customizer_attribute_result = 70;
+ // The result for the experiment mutate.
+ MutateExperimentResult experiment_result = 81;
+
+ // The result for the experiment arm mutate.
+ MutateExperimentArmResult experiment_arm_result = 82;
+
// The result for the extension feed item mutate.
MutateExtensionFeedItemResult extension_feed_item_result = 36;
@@ -1450,10 +1569,12 @@ message MutateOperationResponse {
MutateKeywordPlanCampaignResult keyword_plan_campaign_result = 45;
// The result for the keyword plan ad group keyword mutate.
- MutateKeywordPlanAdGroupKeywordResult keyword_plan_ad_group_keyword_result = 50;
+ MutateKeywordPlanAdGroupKeywordResult keyword_plan_ad_group_keyword_result =
+ 50;
// The result for the keyword plan campaign keyword mutate.
- MutateKeywordPlanCampaignKeywordResult keyword_plan_campaign_keyword_result = 51;
+ MutateKeywordPlanCampaignKeywordResult
+ keyword_plan_campaign_keyword_result = 51;
// The result for the keyword plan mutate.
MutateKeywordPlansResult keyword_plan_result = 48;
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/invoice_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/invoice_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/invoice_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/invoice_service.proto
index d1ad6dc8a..81ea2645e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/invoice_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/invoice_service.proto
@@ -14,22 +14,22 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/month_of_year.proto";
-import "google/ads/googleads/v10/resources/invoice.proto";
+import "google/ads/googleads/v13/enums/month_of_year.proto";
+import "google/ads/googleads/v13/resources/invoice.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "InvoiceServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Invoice service.
@@ -51,9 +51,10 @@ service InvoiceService {
// [RequestError]()
rpc ListInvoices(ListInvoicesRequest) returns (ListInvoicesResponse) {
option (google.api.http) = {
- get: "/v10/customers/{customer_id=*}/invoices"
+ get: "/v13/customers/{customer_id=*}/invoices"
};
- option (google.api.method_signature) = "customer_id,billing_setup,issue_year,issue_month";
+ option (google.api.method_signature) =
+ "customer_id,billing_setup,issue_year,issue_month";
}
}
@@ -73,11 +74,13 @@ message ListInvoicesRequest {
string issue_year = 3 [(google.api.field_behavior) = REQUIRED];
// Required. The issue month to retrieve invoices.
- google.ads.googleads.v10.enums.MonthOfYearEnum.MonthOfYear issue_month = 4 [(google.api.field_behavior) = REQUIRED];
+ google.ads.googleads.v13.enums.MonthOfYearEnum.MonthOfYear issue_month = 4
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [InvoiceService.ListInvoices][google.ads.googleads.v10.services.InvoiceService.ListInvoices].
+// Response message for
+// [InvoiceService.ListInvoices][google.ads.googleads.v13.services.InvoiceService.ListInvoices].
message ListInvoicesResponse {
// The list of invoices that match the billing setup and time period.
- repeated google.ads.googleads.v10.resources.Invoice invoices = 1;
+ repeated google.ads.googleads.v13.resources.Invoice invoices = 1;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_ad_group_keyword_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_ad_group_keyword_service.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_ad_group_keyword_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_ad_group_keyword_service.proto
index 149441c2f..9d9d73ff3 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_ad_group_keyword_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_ad_group_keyword_service.proto
@@ -14,9 +14,9 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/keyword_plan_ad_group_keyword.proto";
+import "google/ads/googleads/v13/resources/keyword_plan_ad_group_keyword.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -24,14 +24,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanAdGroupKeywordServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the keyword plan ad group keyword service.
@@ -60,9 +60,10 @@ service KeywordPlanAdGroupKeywordService {
// [QuotaError]()
// [RequestError]()
// [ResourceCountLimitExceededError]()
- rpc MutateKeywordPlanAdGroupKeywords(MutateKeywordPlanAdGroupKeywordsRequest) returns (MutateKeywordPlanAdGroupKeywordsResponse) {
+ rpc MutateKeywordPlanAdGroupKeywords(MutateKeywordPlanAdGroupKeywordsRequest)
+ returns (MutateKeywordPlanAdGroupKeywordsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate"
+ post: "/v13/customers/{customer_id=*}/keywordPlanAdGroupKeywords:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -70,15 +71,16 @@ service KeywordPlanAdGroupKeywordService {
}
// Request message for
-// [KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords][google.ads.googleads.v10.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords].
+// [KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords][google.ads.googleads.v13.services.KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords].
message MutateKeywordPlanAdGroupKeywordsRequest {
- // Required. The ID of the customer whose Keyword Plan ad group keywords are being
- // modified.
+ // Required. The ID of the customer whose Keyword Plan ad group keywords are
+ // being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual Keyword Plan ad group
- // keywords.
- repeated KeywordPlanAdGroupKeywordOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual Keyword Plan ad
+ // group keywords.
+ repeated KeywordPlanAdGroupKeywordOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -102,19 +104,19 @@ message KeywordPlanAdGroupKeywordOperation {
oneof operation {
// Create operation: No resource name is expected for the new Keyword Plan
// ad group keyword.
- google.ads.googleads.v10.resources.KeywordPlanAdGroupKeyword create = 1;
+ google.ads.googleads.v13.resources.KeywordPlanAdGroupKeyword create = 1;
// Update operation: The Keyword Plan ad group keyword is expected to have a
// valid resource name.
- google.ads.googleads.v10.resources.KeywordPlanAdGroupKeyword update = 2;
+ google.ads.googleads.v13.resources.KeywordPlanAdGroupKeyword update = 2;
// Remove operation: A resource name for the removed Keyword Plan ad group
// keyword is expected, in this format:
//
// `customers/{customer_id}/keywordPlanAdGroupKeywords/{kp_ad_group_keyword_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlanAdGroupKeyword"
- }];
+ type: "googleads.googleapis.com/KeywordPlanAdGroupKeyword"
+ }];
}
}
@@ -122,8 +124,8 @@ message KeywordPlanAdGroupKeywordOperation {
message MutateKeywordPlanAdGroupKeywordsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -134,6 +136,6 @@ message MutateKeywordPlanAdGroupKeywordsResponse {
message MutateKeywordPlanAdGroupKeywordResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlanAdGroupKeyword"
- }];
+ type: "googleads.googleapis.com/KeywordPlanAdGroupKeyword"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_ad_group_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_ad_group_service.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_ad_group_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_ad_group_service.proto
index 50169b29f..64b2289f8 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_ad_group_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_ad_group_service.proto
@@ -14,9 +14,9 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/keyword_plan_ad_group.proto";
+import "google/ads/googleads/v13/resources/keyword_plan_ad_group.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -24,14 +24,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanAdGroupServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the keyword plan ad group service.
@@ -58,22 +58,27 @@ service KeywordPlanAdGroupService {
// [QuotaError]()
// [RequestError]()
// [ResourceCountLimitExceededError]()
- rpc MutateKeywordPlanAdGroups(MutateKeywordPlanAdGroupsRequest) returns (MutateKeywordPlanAdGroupsResponse) {
+ rpc MutateKeywordPlanAdGroups(MutateKeywordPlanAdGroupsRequest)
+ returns (MutateKeywordPlanAdGroupsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/keywordPlanAdGroups:mutate"
+ post: "/v13/customers/{customer_id=*}/keywordPlanAdGroups:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [KeywordPlanAdGroupService.MutateKeywordPlanAdGroups][google.ads.googleads.v10.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups].
+// Request message for
+// [KeywordPlanAdGroupService.MutateKeywordPlanAdGroups][google.ads.googleads.v13.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups].
message MutateKeywordPlanAdGroupsRequest {
- // Required. The ID of the customer whose Keyword Plan ad groups are being modified.
+ // Required. The ID of the customer whose Keyword Plan ad groups are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual Keyword Plan ad groups.
- repeated KeywordPlanAdGroupOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual Keyword Plan ad
+ // groups.
+ repeated KeywordPlanAdGroupOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -96,19 +101,19 @@ message KeywordPlanAdGroupOperation {
oneof operation {
// Create operation: No resource name is expected for the new Keyword Plan
// ad group.
- google.ads.googleads.v10.resources.KeywordPlanAdGroup create = 1;
+ google.ads.googleads.v13.resources.KeywordPlanAdGroup create = 1;
// Update operation: The Keyword Plan ad group is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.KeywordPlanAdGroup update = 2;
+ google.ads.googleads.v13.resources.KeywordPlanAdGroup update = 2;
// Remove operation: A resource name for the removed Keyword Plan ad group
// is expected, in this format:
//
// `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlanAdGroup"
- }];
+ type: "googleads.googleapis.com/KeywordPlanAdGroup"
+ }];
}
}
@@ -116,8 +121,8 @@ message KeywordPlanAdGroupOperation {
message MutateKeywordPlanAdGroupsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate. The order of the results is determined by the
@@ -129,6 +134,6 @@ message MutateKeywordPlanAdGroupsResponse {
message MutateKeywordPlanAdGroupResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlanAdGroup"
- }];
+ type: "googleads.googleapis.com/KeywordPlanAdGroup"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_campaign_keyword_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_campaign_keyword_service.proto
similarity index 77%
rename from third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_campaign_keyword_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_campaign_keyword_service.proto
index 704d6d512..ea48f7f42 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_campaign_keyword_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_campaign_keyword_service.proto
@@ -14,9 +14,9 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/keyword_plan_campaign_keyword.proto";
+import "google/ads/googleads/v13/resources/keyword_plan_campaign_keyword.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -24,14 +24,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanCampaignKeywordServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the keyword plan campaign keyword service.
@@ -58,9 +58,11 @@ service KeywordPlanCampaignKeywordService {
// [QuotaError]()
// [RequestError]()
// [ResourceCountLimitExceededError]()
- rpc MutateKeywordPlanCampaignKeywords(MutateKeywordPlanCampaignKeywordsRequest) returns (MutateKeywordPlanCampaignKeywordsResponse) {
+ rpc MutateKeywordPlanCampaignKeywords(
+ MutateKeywordPlanCampaignKeywordsRequest)
+ returns (MutateKeywordPlanCampaignKeywordsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate"
+ post: "/v13/customers/{customer_id=*}/keywordPlanCampaignKeywords:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -68,14 +70,16 @@ service KeywordPlanCampaignKeywordService {
}
// Request message for
-// [KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords][google.ads.googleads.v10.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords].
+// [KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords][google.ads.googleads.v13.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords].
message MutateKeywordPlanCampaignKeywordsRequest {
- // Required. The ID of the customer whose campaign keywords are being modified.
+ // Required. The ID of the customer whose campaign keywords are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual Keyword Plan campaign
- // keywords.
- repeated KeywordPlanCampaignKeywordOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual Keyword Plan
+ // campaign keywords.
+ repeated KeywordPlanCampaignKeywordOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -99,19 +103,19 @@ message KeywordPlanCampaignKeywordOperation {
oneof operation {
// Create operation: No resource name is expected for the new Keyword Plan
// campaign keyword.
- google.ads.googleads.v10.resources.KeywordPlanCampaignKeyword create = 1;
+ google.ads.googleads.v13.resources.KeywordPlanCampaignKeyword create = 1;
// Update operation: The Keyword Plan campaign keyword expected to have a
// valid resource name.
- google.ads.googleads.v10.resources.KeywordPlanCampaignKeyword update = 2;
+ google.ads.googleads.v13.resources.KeywordPlanCampaignKeyword update = 2;
// Remove operation: A resource name for the removed Keyword Plan campaign
// keywords expected in this format:
//
// `customers/{customer_id}/keywordPlanCampaignKeywords/{kp_campaign_keyword_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlanCampaignKeyword"
- }];
+ type: "googleads.googleapis.com/KeywordPlanCampaignKeyword"
+ }];
}
}
@@ -119,8 +123,8 @@ message KeywordPlanCampaignKeywordOperation {
message MutateKeywordPlanCampaignKeywordsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -131,6 +135,6 @@ message MutateKeywordPlanCampaignKeywordsResponse {
message MutateKeywordPlanCampaignKeywordResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlanCampaignKeyword"
- }];
+ type: "googleads.googleapis.com/KeywordPlanCampaignKeyword"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_campaign_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_campaign_service.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_campaign_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_campaign_service.proto
index 1f9ac483f..1bcc7367e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_campaign_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_campaign_service.proto
@@ -14,9 +14,9 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/keyword_plan_campaign.proto";
+import "google/ads/googleads/v13/resources/keyword_plan_campaign.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -24,14 +24,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanCampaignServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the keyword plan campaign service.
@@ -59,9 +59,10 @@ service KeywordPlanCampaignService {
// [RangeError]()
// [RequestError]()
// [ResourceCountLimitExceededError]()
- rpc MutateKeywordPlanCampaigns(MutateKeywordPlanCampaignsRequest) returns (MutateKeywordPlanCampaignsResponse) {
+ rpc MutateKeywordPlanCampaigns(MutateKeywordPlanCampaignsRequest)
+ returns (MutateKeywordPlanCampaignsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/keywordPlanCampaigns:mutate"
+ post: "/v13/customers/{customer_id=*}/keywordPlanCampaigns:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -69,13 +70,16 @@ service KeywordPlanCampaignService {
}
// Request message for
-// [KeywordPlanCampaignService.MutateKeywordPlanCampaigns][google.ads.googleads.v10.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns].
+// [KeywordPlanCampaignService.MutateKeywordPlanCampaigns][google.ads.googleads.v13.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns].
message MutateKeywordPlanCampaignsRequest {
- // Required. The ID of the customer whose Keyword Plan campaigns are being modified.
+ // Required. The ID of the customer whose Keyword Plan campaigns are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual Keyword Plan campaigns.
- repeated KeywordPlanCampaignOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual Keyword Plan
+ // campaigns.
+ repeated KeywordPlanCampaignOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -98,19 +102,19 @@ message KeywordPlanCampaignOperation {
oneof operation {
// Create operation: No resource name is expected for the new Keyword Plan
// campaign.
- google.ads.googleads.v10.resources.KeywordPlanCampaign create = 1;
+ google.ads.googleads.v13.resources.KeywordPlanCampaign create = 1;
// Update operation: The Keyword Plan campaign is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.KeywordPlanCampaign update = 2;
+ google.ads.googleads.v13.resources.KeywordPlanCampaign update = 2;
// Remove operation: A resource name for the removed Keyword Plan campaign
// is expected, in this format:
//
// `customers/{customer_id}/keywordPlanCampaigns/{keywordPlan_campaign_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlanCampaign"
- }];
+ type: "googleads.googleapis.com/KeywordPlanCampaign"
+ }];
}
}
@@ -118,8 +122,8 @@ message KeywordPlanCampaignOperation {
message MutateKeywordPlanCampaignsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -130,6 +134,6 @@ message MutateKeywordPlanCampaignsResponse {
message MutateKeywordPlanCampaignResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlanCampaign"
- }];
+ type: "googleads.googleapis.com/KeywordPlanCampaign"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_idea_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_idea_service.proto
similarity index 50%
rename from third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_idea_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_idea_service.proto
index 2f4fd4cbb..e03bd1511 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_idea_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_idea_service.proto
@@ -14,22 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/common/keyword_plan_common.proto";
-import "google/ads/googleads/v10/enums/keyword_plan_keyword_annotation.proto";
-import "google/ads/googleads/v10/enums/keyword_plan_network.proto";
+import "google/ads/googleads/v13/common/keyword_plan_common.proto";
+import "google/ads/googleads/v13/enums/keyword_match_type.proto";
+import "google/ads/googleads/v13/enums/keyword_plan_keyword_annotation.proto";
+import "google/ads/googleads/v13/enums/keyword_plan_network.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
+import "google/api/field_behavior.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanIdeaServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the keyword plan idea service.
@@ -49,9 +51,10 @@ service KeywordPlanIdeaService {
// [KeywordPlanIdeaError]()
// [QuotaError]()
// [RequestError]()
- rpc GenerateKeywordIdeas(GenerateKeywordIdeasRequest) returns (GenerateKeywordIdeaResponse) {
+ rpc GenerateKeywordIdeas(GenerateKeywordIdeasRequest)
+ returns (GenerateKeywordIdeaResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:generateKeywordIdeas"
+ post: "/v13/customers/{customer_id=*}:generateKeywordIdeas"
body: "*"
};
}
@@ -66,25 +69,48 @@ service KeywordPlanIdeaService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc GenerateKeywordHistoricalMetrics(GenerateKeywordHistoricalMetricsRequest) returns (GenerateKeywordHistoricalMetricsResponse) {
+ rpc GenerateKeywordHistoricalMetrics(GenerateKeywordHistoricalMetricsRequest)
+ returns (GenerateKeywordHistoricalMetricsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:generateKeywordHistoricalMetrics"
+ post: "/v13/customers/{customer_id=*}:generateKeywordHistoricalMetrics"
+ body: "*"
+ };
+ }
+
+ // Returns a list of suggested AdGroups and suggested modifications
+ // (text, match type) for the given keywords.
+ //
+ // List of thrown errors:
+ // [AuthenticationError]()
+ // [AuthorizationError]()
+ // [CollectionSizeError]()
+ // [HeaderError]()
+ // [InternalError]()
+ // [QuotaError]()
+ // [RequestError]()
+ rpc GenerateAdGroupThemes(GenerateAdGroupThemesRequest)
+ returns (GenerateAdGroupThemesResponse) {
+ option (google.api.http) = {
+ post: "/v13/customers/{customer_id=*}:generateAdGroupThemes"
body: "*"
};
}
}
-// Request message for [KeywordPlanIdeaService.GenerateKeywordIdeas][google.ads.googleads.v10.services.KeywordPlanIdeaService.GenerateKeywordIdeas].
+// Request message for
+// [KeywordPlanIdeaService.GenerateKeywordIdeas][google.ads.googleads.v13.services.KeywordPlanIdeaService.GenerateKeywordIdeas].
message GenerateKeywordIdeasRequest {
// The ID of the customer with the recommendation.
string customer_id = 1;
// The resource name of the language to target.
- // Required
+ // Each keyword belongs to some set of languages; a keyword is included if
+ // language is one of its languages.
+ // If not set, all keywords will be included.
optional string language = 14;
- // The resource names of the location to target.
- // Max 10
+ // The resource names of the location to target. Maximum is 10.
+ // An empty list MAY be used to specify all targeting geos.
repeated string geo_target_constants = 15;
// If true, adult keywords will be included in response.
@@ -107,30 +133,35 @@ message GenerateKeywordIdeasRequest {
int32 page_size = 13;
// Targeting network.
- google.ads.googleads.v10.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 9;
+ // If not set, Google Search And Partners Network will be used.
+ google.ads.googleads.v13.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork
+ keyword_plan_network = 9;
// The keyword annotations to include in response.
- repeated google.ads.googleads.v10.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
+ repeated google.ads.googleads.v13.enums.KeywordPlanKeywordAnnotationEnum
+ .KeywordPlanKeywordAnnotation keyword_annotation = 17;
// The aggregate fields to include in response.
- google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;
+ google.ads.googleads.v13.common.KeywordPlanAggregateMetrics
+ aggregate_metrics = 16;
// The options for historical metrics data.
- google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 18;
+ google.ads.googleads.v13.common.HistoricalMetricsOptions
+ historical_metrics_options = 18;
// The type of seed to generate keyword ideas.
oneof seed {
// A Keyword and a specific Url to generate ideas from
- // e.g. cars, www.example.com/cars.
+ // for example, cars, www.example.com/cars.
KeywordAndUrlSeed keyword_and_url_seed = 2;
- // A Keyword or phrase to generate ideas from, e.g. cars.
+ // A Keyword or phrase to generate ideas from, for example, cars.
KeywordSeed keyword_seed = 3;
- // A specific url to generate ideas from, e.g. www.example.com/cars.
+ // A specific url to generate ideas from, for example, www.example.com/cars.
UrlSeed url_seed = 5;
- // The site to generate ideas from, e.g. www.example.com.
+ // The site to generate ideas from, for example, www.example.com.
SiteSeed site_seed = 11;
}
}
@@ -163,13 +194,15 @@ message UrlSeed {
optional string url = 2;
}
-// Response message for [KeywordPlanIdeaService.GenerateKeywordIdeas][google.ads.googleads.v10.services.KeywordPlanIdeaService.GenerateKeywordIdeas].
+// Response message for
+// [KeywordPlanIdeaService.GenerateKeywordIdeas][google.ads.googleads.v13.services.KeywordPlanIdeaService.GenerateKeywordIdeas].
message GenerateKeywordIdeaResponse {
// Results of generating keyword ideas.
repeated GenerateKeywordIdeaResult results = 1;
// The aggregate metrics for all keyword ideas.
- google.ads.googleads.v10.common.KeywordPlanAggregateMetricResults aggregate_metric_results = 4;
+ google.ads.googleads.v13.common.KeywordPlanAggregateMetricResults
+ aggregate_metric_results = 4;
// Pagination token used to retrieve the next page of results.
// Pass the content of this string as the `page_token` attribute of
@@ -190,11 +223,12 @@ message GenerateKeywordIdeaResult {
optional string text = 5;
// The historical metrics for the keyword.
- google.ads.googleads.v10.common.KeywordPlanHistoricalMetrics keyword_idea_metrics = 3;
+ google.ads.googleads.v13.common.KeywordPlanHistoricalMetrics
+ keyword_idea_metrics = 3;
// The annotations for the keyword.
// The annotation data is only provided if requested.
- google.ads.googleads.v10.common.KeywordAnnotations keyword_annotations = 6;
+ google.ads.googleads.v13.common.KeywordAnnotations keyword_annotations = 6;
// The list of close variants from the requested keywords that
// are combined into this GenerateKeywordIdeaResult. See
@@ -204,7 +238,7 @@ message GenerateKeywordIdeaResult {
}
// Request message for
-// [KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics][google.ads.googleads.v10.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics].
+// [KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics][google.ads.googleads.v13.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics].
message GenerateKeywordHistoricalMetricsRequest {
// The ID of the customer with the recommendation.
string customer_id = 1;
@@ -216,15 +250,43 @@ message GenerateKeywordHistoricalMetricsRequest {
// A maximum of 10,000 keywords can be used.
repeated string keywords = 2;
+ // The resource name of the language to target.
+ // Each keyword belongs to some set of languages; a keyword is included if
+ // language is one of its languages.
+ // If not set, all keywords will be included.
+ optional string language = 4;
+
+ // If true, adult keywords will be included in response.
+ // The default value is false.
+ bool include_adult_keywords = 5;
+
+ // The resource names of the location to target. Maximum is 10.
+ // An empty list MAY be used to specify all targeting geos.
+ repeated string geo_target_constants = 6;
+
+ // Targeting network.
+ // If not set, Google Search And Partners Network will be used.
+ google.ads.googleads.v13.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork
+ keyword_plan_network = 7;
+
+ // The aggregate fields to include in response.
+ google.ads.googleads.v13.common.KeywordPlanAggregateMetrics
+ aggregate_metrics = 8;
+
// The options for historical metrics data.
- google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 3;
+ google.ads.googleads.v13.common.HistoricalMetricsOptions
+ historical_metrics_options = 3;
}
// Response message for
-// [KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics][google.ads.googleads.v10.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics].
+// [KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics][google.ads.googleads.v13.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics].
message GenerateKeywordHistoricalMetricsResponse {
// List of keywords and their historical metrics.
repeated GenerateKeywordHistoricalMetricsResult results = 1;
+
+ // The aggregate metrics for all keywords.
+ google.ads.googleads.v13.common.KeywordPlanAggregateMetricResults
+ aggregate_metric_results = 2;
}
// The result of generating keyword historical metrics.
@@ -242,5 +304,67 @@ message GenerateKeywordHistoricalMetricsResult {
repeated string close_variants = 3;
// The historical metrics for text and its close variants
- google.ads.googleads.v10.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;
+ google.ads.googleads.v13.common.KeywordPlanHistoricalMetrics keyword_metrics =
+ 2;
+}
+
+// Request message for
+// [KeywordPlanIdeaService.GenerateAdGroupThemes][google.ads.googleads.v13.services.KeywordPlanIdeaService.GenerateAdGroupThemes].
+message GenerateAdGroupThemesRequest {
+ // Required. The ID of the customer.
+ string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. A list of keywords to group into the provided AdGroups.
+ repeated string keywords = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. A list of resource names of AdGroups to group keywords into.
+ // Resource name format: `customers/{customer_id}/adGroups/{ad_group_id}`
+ repeated string ad_groups = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response message for
+// [KeywordPlanIdeaService.GenerateAdGroupThemes][google.ads.googleads.v13.services.KeywordPlanIdeaService.GenerateAdGroupThemes].
+message GenerateAdGroupThemesResponse {
+ // A list of suggested AdGroup/keyword pairings.
+ repeated AdGroupKeywordSuggestion ad_group_keyword_suggestions = 1;
+
+ // A list of provided AdGroups that could not be used as suggestions.
+ repeated UnusableAdGroup unusable_ad_groups = 2;
+}
+
+// The suggested text and AdGroup/Campaign pairing for a given keyword.
+message AdGroupKeywordSuggestion {
+ // The original keyword text.
+ string keyword_text = 1;
+
+ // The normalized version of keyword_text for BROAD/EXACT/PHRASE suggestions.
+ string suggested_keyword_text = 2;
+
+ // The suggested keyword match type.
+ google.ads.googleads.v13.enums.KeywordMatchTypeEnum.KeywordMatchType
+ suggested_match_type = 3;
+
+ // The suggested AdGroup for the keyword.
+ // Resource name format: `customers/{customer_id}/adGroups/{ad_group_id}`
+ string suggested_ad_group = 4;
+
+ // The suggested Campaign for the keyword.
+ // Resource name format: `customers/{customer_id}/campaigns/{campaign_id}`
+ string suggested_campaign = 5;
+}
+
+// An AdGroup/Campaign pair that could not be used as a suggestion for keywords.
+//
+// AdGroups may not be usable if the AdGroup
+//
+// * belongs to a Campaign that is not ENABLED or PAUSED
+// * is itself not ENABLED
+message UnusableAdGroup {
+ // The AdGroup resource name.
+ // Resource name format: `customers/{customer_id}/adGroups/{ad_group_id}`
+ string ad_group = 1;
+
+ // The Campaign resource name.
+ // Resource name format: `customers/{customer_id}/campaigns/{campaign_id}`
+ string campaign = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_service.proto
similarity index 78%
rename from third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_service.proto
index b6d646672..05d4c02df 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/keyword_plan_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/keyword_plan_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/common/keyword_plan_common.proto";
-import "google/ads/googleads/v10/resources/keyword_plan.proto";
+import "google/ads/googleads/v13/common/keyword_plan_common.proto";
+import "google/ads/googleads/v13/resources/keyword_plan.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the keyword plan service.
@@ -58,9 +58,10 @@ service KeywordPlanService {
// [RequestError]()
// [ResourceCountLimitExceededError]()
// [StringLengthError]()
- rpc MutateKeywordPlans(MutateKeywordPlansRequest) returns (MutateKeywordPlansResponse) {
+ rpc MutateKeywordPlans(MutateKeywordPlansRequest)
+ returns (MutateKeywordPlansResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/keywordPlans:mutate"
+ post: "/v13/customers/{customer_id=*}/keywordPlans:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -81,9 +82,10 @@ service KeywordPlanService {
// [KeywordPlanError]()
// [QuotaError]()
// [RequestError]()
- rpc GenerateForecastCurve(GenerateForecastCurveRequest) returns (GenerateForecastCurveResponse) {
+ rpc GenerateForecastCurve(GenerateForecastCurveRequest)
+ returns (GenerateForecastCurveResponse) {
option (google.api.http) = {
- post: "/v10/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve"
+ post: "/v13/{keyword_plan=customers/*/keywordPlans/*}:generateForecastCurve"
body: "*"
};
option (google.api.method_signature) = "keyword_plan";
@@ -105,9 +107,10 @@ service KeywordPlanService {
// [KeywordPlanError]()
// [QuotaError]()
// [RequestError]()
- rpc GenerateForecastTimeSeries(GenerateForecastTimeSeriesRequest) returns (GenerateForecastTimeSeriesResponse) {
+ rpc GenerateForecastTimeSeries(GenerateForecastTimeSeriesRequest)
+ returns (GenerateForecastTimeSeriesResponse) {
option (google.api.http) = {
- post: "/v10/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries"
+ post: "/v13/{keyword_plan=customers/*/keywordPlans/*}:generateForecastTimeSeries"
body: "*"
};
option (google.api.method_signature) = "keyword_plan";
@@ -123,9 +126,10 @@ service KeywordPlanService {
// [KeywordPlanError]()
// [QuotaError]()
// [RequestError]()
- rpc GenerateForecastMetrics(GenerateForecastMetricsRequest) returns (GenerateForecastMetricsResponse) {
+ rpc GenerateForecastMetrics(GenerateForecastMetricsRequest)
+ returns (GenerateForecastMetricsResponse) {
option (google.api.http) = {
- post: "/v10/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics"
+ post: "/v13/{keyword_plan=customers/*/keywordPlans/*}:generateForecastMetrics"
body: "*"
};
option (google.api.method_signature) = "keyword_plan";
@@ -141,22 +145,25 @@ service KeywordPlanService {
// [KeywordPlanError]()
// [QuotaError]()
// [RequestError]()
- rpc GenerateHistoricalMetrics(GenerateHistoricalMetricsRequest) returns (GenerateHistoricalMetricsResponse) {
+ rpc GenerateHistoricalMetrics(GenerateHistoricalMetricsRequest)
+ returns (GenerateHistoricalMetricsResponse) {
option (google.api.http) = {
- post: "/v10/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics"
+ post: "/v13/{keyword_plan=customers/*/keywordPlans/*}:generateHistoricalMetrics"
body: "*"
};
option (google.api.method_signature) = "keyword_plan";
}
}
-// Request message for [KeywordPlanService.MutateKeywordPlans][google.ads.googleads.v10.services.KeywordPlanService.MutateKeywordPlans].
+// Request message for
+// [KeywordPlanService.MutateKeywordPlans][google.ads.googleads.v13.services.KeywordPlanService.MutateKeywordPlans].
message MutateKeywordPlansRequest {
// Required. The ID of the customer whose keyword plans are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual keyword plans.
- repeated KeywordPlanOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated KeywordPlanOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -178,19 +185,19 @@ message KeywordPlanOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new keyword plan.
- google.ads.googleads.v10.resources.KeywordPlan create = 1;
+ google.ads.googleads.v13.resources.KeywordPlan create = 1;
// Update operation: The keyword plan is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.KeywordPlan update = 2;
+ google.ads.googleads.v13.resources.KeywordPlan update = 2;
// Remove operation: A resource name for the removed keyword plan is
// expected in this format:
//
// `customers/{customer_id}/keywordPlans/{keyword_plan_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlan"
- }];
+ type: "googleads.googleapis.com/KeywordPlan"
+ }];
}
}
@@ -198,8 +205,8 @@ message KeywordPlanOperation {
message MutateKeywordPlansResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -210,11 +217,12 @@ message MutateKeywordPlansResponse {
message MutateKeywordPlansResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/KeywordPlan"
- }];
+ type: "googleads.googleapis.com/KeywordPlan"
+ }];
}
-// Request message for [KeywordPlanService.GenerateForecastCurve][google.ads.googleads.v10.services.KeywordPlanService.GenerateForecastCurve].
+// Request message for
+// [KeywordPlanService.GenerateForecastCurve][google.ads.googleads.v13.services.KeywordPlanService.GenerateForecastCurve].
message GenerateForecastCurveRequest {
// Required. The resource name of the keyword plan to be forecasted.
string keyword_plan = 1 [
@@ -225,14 +233,16 @@ message GenerateForecastCurveRequest {
];
}
-// Response message for [KeywordPlanService.GenerateForecastCurve][google.ads.googleads.v10.services.KeywordPlanService.GenerateForecastCurve].
+// Response message for
+// [KeywordPlanService.GenerateForecastCurve][google.ads.googleads.v13.services.KeywordPlanService.GenerateForecastCurve].
message GenerateForecastCurveResponse {
// List of forecast curves for the keyword plan campaign.
// One maximum.
repeated KeywordPlanCampaignForecastCurve campaign_forecast_curves = 1;
}
-// Request message for [KeywordPlanService.GenerateForecastTimeSeries][google.ads.googleads.v10.services.KeywordPlanService.GenerateForecastTimeSeries].
+// Request message for
+// [KeywordPlanService.GenerateForecastTimeSeries][google.ads.googleads.v13.services.KeywordPlanService.GenerateForecastTimeSeries].
message GenerateForecastTimeSeriesRequest {
// Required. The resource name of the keyword plan to be forecasted.
string keyword_plan = 1 [
@@ -243,14 +253,16 @@ message GenerateForecastTimeSeriesRequest {
];
}
-// Response message for [KeywordPlanService.GenerateForecastTimeSeries][google.ads.googleads.v10.services.KeywordPlanService.GenerateForecastTimeSeries].
+// Response message for
+// [KeywordPlanService.GenerateForecastTimeSeries][google.ads.googleads.v13.services.KeywordPlanService.GenerateForecastTimeSeries].
message GenerateForecastTimeSeriesResponse {
// List of weekly time series forecasts for the keyword plan campaign.
// One maximum.
repeated KeywordPlanWeeklyTimeSeriesForecast weekly_time_series_forecasts = 1;
}
-// Request message for [KeywordPlanService.GenerateForecastMetrics][google.ads.googleads.v10.services.KeywordPlanService.GenerateForecastMetrics].
+// Request message for
+// [KeywordPlanService.GenerateForecastMetrics][google.ads.googleads.v13.services.KeywordPlanService.GenerateForecastMetrics].
message GenerateForecastMetricsRequest {
// Required. The resource name of the keyword plan to be forecasted.
string keyword_plan = 1 [
@@ -261,7 +273,8 @@ message GenerateForecastMetricsRequest {
];
}
-// Response message for [KeywordPlanService.GenerateForecastMetrics][google.ads.googleads.v10.services.KeywordPlanService.GenerateForecastMetrics].
+// Response message for
+// [KeywordPlanService.GenerateForecastMetrics][google.ads.googleads.v13.services.KeywordPlanService.GenerateForecastMetrics].
message GenerateForecastMetricsResponse {
// List of campaign forecasts.
// One maximum.
@@ -371,10 +384,11 @@ message ForecastMetrics {
optional int64 cost_micros = 11;
}
-// Request message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v10.services.KeywordPlanService.GenerateHistoricalMetrics].
+// Request message for
+// [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v13.services.KeywordPlanService.GenerateHistoricalMetrics].
message GenerateHistoricalMetricsRequest {
- // Required. The resource name of the keyword plan of which historical metrics are
- // requested.
+ // Required. The resource name of the keyword plan of which historical metrics
+ // are requested.
string keyword_plan = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -383,19 +397,23 @@ message GenerateHistoricalMetricsRequest {
];
// The aggregate fields to include in response.
- google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 2;
+ google.ads.googleads.v13.common.KeywordPlanAggregateMetrics
+ aggregate_metrics = 2;
// The options for historical metrics data.
- google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 3;
+ google.ads.googleads.v13.common.HistoricalMetricsOptions
+ historical_metrics_options = 3;
}
-// Response message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v10.services.KeywordPlanService.GenerateHistoricalMetrics].
+// Response message for
+// [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v13.services.KeywordPlanService.GenerateHistoricalMetrics].
message GenerateHistoricalMetricsResponse {
// List of keyword historical metrics.
repeated KeywordPlanKeywordHistoricalMetrics metrics = 1;
// The aggregate metrics for all the keywords in the keyword planner plan.
- google.ads.googleads.v10.common.KeywordPlanAggregateMetricResults aggregate_metric_results = 2;
+ google.ads.googleads.v13.common.KeywordPlanAggregateMetricResults
+ aggregate_metric_results = 2;
}
// A keyword historical metrics.
@@ -417,5 +435,6 @@ message KeywordPlanKeywordHistoricalMetrics {
// The historical metrics for the query associated with one or more
// ad_group_keywords in the plan.
- google.ads.googleads.v10.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;
+ google.ads.googleads.v13.common.KeywordPlanHistoricalMetrics keyword_metrics =
+ 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/keyword_theme_constant_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/keyword_theme_constant_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/keyword_theme_constant_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/keyword_theme_constant_service.proto
index ca22a3169..aa1af5780 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/keyword_theme_constant_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/keyword_theme_constant_service.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/keyword_theme_constant.proto";
+import "google/ads/googleads/v13/resources/keyword_theme_constant.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "KeywordThemeConstantServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Smart Campaign keyword theme constant service.
@@ -45,19 +45,20 @@ service KeywordThemeConstantService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc SuggestKeywordThemeConstants(SuggestKeywordThemeConstantsRequest) returns (SuggestKeywordThemeConstantsResponse) {
+ rpc SuggestKeywordThemeConstants(SuggestKeywordThemeConstantsRequest)
+ returns (SuggestKeywordThemeConstantsResponse) {
option (google.api.http) = {
- post: "/v10/keywordThemeConstants:suggest"
+ post: "/v13/keywordThemeConstants:suggest"
body: "*"
};
}
}
// Request message for
-// [KeywordThemeConstantService.SuggestKeywordThemeConstants][google.ads.googleads.v10.services.KeywordThemeConstantService.SuggestKeywordThemeConstants].
+// [KeywordThemeConstantService.SuggestKeywordThemeConstants][google.ads.googleads.v13.services.KeywordThemeConstantService.SuggestKeywordThemeConstants].
message SuggestKeywordThemeConstantsRequest {
// The query text of a keyword theme that will be used to map to similar
- // keyword themes. E.g. "plumber" or "roofer".
+ // keyword themes. For example, "plumber" or "roofer".
string query_text = 1;
// Upper-case, two-letter country code as defined by ISO-3166. This for
@@ -70,8 +71,9 @@ message SuggestKeywordThemeConstantsRequest {
}
// Response message for
-// [KeywordThemeConstantService.SuggestKeywordThemeConstants][google.ads.googleads.v10.services.KeywordThemeConstantService.SuggestKeywordThemeConstants].
+// [KeywordThemeConstantService.SuggestKeywordThemeConstants][google.ads.googleads.v13.services.KeywordThemeConstantService.SuggestKeywordThemeConstants].
message SuggestKeywordThemeConstantsResponse {
// Smart Campaign keyword theme suggestions.
- repeated google.ads.googleads.v10.resources.KeywordThemeConstant keyword_theme_constants = 1;
+ repeated google.ads.googleads.v13.resources.KeywordThemeConstant
+ keyword_theme_constants = 1;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/label_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/label_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/label_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/label_service.proto
index c786fd817..9312d472a 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/label_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/label_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/label.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/label.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "LabelServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Service to manage labels.
service LabelService {
@@ -67,20 +67,22 @@ service LabelService {
// [StringLengthError]()
rpc MutateLabels(MutateLabelsRequest) returns (MutateLabelsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/labels:mutate"
+ post: "/v13/customers/{customer_id=*}/labels:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [LabelService.MutateLabels][google.ads.googleads.v10.services.LabelService.MutateLabels].
+// Request message for
+// [LabelService.MutateLabels][google.ads.googleads.v13.services.LabelService.MutateLabels].
message MutateLabelsRequest {
// Required. ID of the customer whose labels are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on labels.
- repeated LabelOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated LabelOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -94,7 +96,8 @@ message MutateLabelsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove, update) on a label.
@@ -105,18 +108,18 @@ message LabelOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new label.
- google.ads.googleads.v10.resources.Label create = 1;
+ google.ads.googleads.v13.resources.Label create = 1;
// Update operation: The label is expected to have a valid resource name.
- google.ads.googleads.v10.resources.Label update = 2;
+ google.ads.googleads.v13.resources.Label update = 2;
// Remove operation: A resource name for the label being removed, in
// this format:
//
// `customers/{customer_id}/labels/{label_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Label"
- }];
+ type: "googleads.googleapis.com/Label"
+ }];
}
}
@@ -124,8 +127,8 @@ message LabelOperation {
message MutateLabelsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -135,11 +138,11 @@ message MutateLabelsResponse {
// The result for a label mutate.
message MutateLabelResult {
// Returned for successful operations.
- string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Label"
- }];
+ string resource_name = 1 [
+ (google.api.resource_reference) = { type: "googleads.googleapis.com/Label" }
+ ];
// The mutated label with only mutable fields after mutate. The field will
// only be returned when response_content_type is set to "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.Label label = 2;
+ google.ads.googleads.v13.resources.Label label = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/media_file_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/media_file_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/media_file_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/media_file_service.proto
index 6f697a09f..8ead96cc1 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/media_file_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/media_file_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/media_file.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/media_file.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "MediaFileServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Media File service.
@@ -64,22 +64,25 @@ service MediaFileService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateMediaFiles(MutateMediaFilesRequest) returns (MutateMediaFilesResponse) {
+ rpc MutateMediaFiles(MutateMediaFilesRequest)
+ returns (MutateMediaFilesResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/mediaFiles:mutate"
+ post: "/v13/customers/{customer_id=*}/mediaFiles:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [MediaFileService.MutateMediaFiles][google.ads.googleads.v10.services.MediaFileService.MutateMediaFiles]
+// Request message for
+// [MediaFileService.MutateMediaFiles][google.ads.googleads.v13.services.MediaFileService.MutateMediaFiles]
message MutateMediaFilesRequest {
// Required. The ID of the customer whose media files are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual media file.
- repeated MediaFileOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated MediaFileOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -93,7 +96,8 @@ message MutateMediaFilesRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation to create media file.
@@ -101,7 +105,7 @@ message MediaFileOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new media file.
- google.ads.googleads.v10.resources.MediaFile create = 1;
+ google.ads.googleads.v13.resources.MediaFile create = 1;
}
}
@@ -109,8 +113,8 @@ message MediaFileOperation {
message MutateMediaFilesResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -121,11 +125,11 @@ message MutateMediaFilesResponse {
message MutateMediaFileResult {
// The resource name returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/MediaFile"
- }];
+ type: "googleads.googleapis.com/MediaFile"
+ }];
// The mutated media file with only mutable fields after mutate. The field
// will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.MediaFile media_file = 2;
+ google.ads.googleads.v13.resources.MediaFile media_file = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/merchant_center_link_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/merchant_center_link_service.proto
similarity index 67%
rename from third_party/googleapis/google/ads/googleads/v10/services/merchant_center_link_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/merchant_center_link_service.proto
index 76d59dfb7..aa39d0db5 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/merchant_center_link_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/merchant_center_link_service.proto
@@ -14,23 +14,23 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/merchant_center_link.proto";
+import "google/ads/googleads/v13/resources/merchant_center_link.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "MerchantCenterLinkServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the MerchantCenterLink service.
@@ -49,9 +49,10 @@ service MerchantCenterLinkService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc ListMerchantCenterLinks(ListMerchantCenterLinksRequest) returns (ListMerchantCenterLinksResponse) {
+ rpc ListMerchantCenterLinks(ListMerchantCenterLinksRequest)
+ returns (ListMerchantCenterLinksResponse) {
option (google.api.http) = {
- get: "/v10/customers/{customer_id=*}/merchantCenterLinks"
+ get: "/v13/customers/{customer_id=*}/merchantCenterLinks"
};
option (google.api.method_signature) = "customer_id";
}
@@ -65,9 +66,10 @@ service MerchantCenterLinkService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc GetMerchantCenterLink(GetMerchantCenterLinkRequest) returns (google.ads.googleads.v10.resources.MerchantCenterLink) {
+ rpc GetMerchantCenterLink(GetMerchantCenterLinkRequest)
+ returns (google.ads.googleads.v13.resources.MerchantCenterLink) {
option (google.api.http) = {
- get: "/v10/{resource_name=customers/*/merchantCenterLinks/*}"
+ get: "/v13/{resource_name=customers/*/merchantCenterLinks/*}"
};
option (google.api.method_signature) = "resource_name";
}
@@ -82,29 +84,34 @@ service MerchantCenterLinkService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateMerchantCenterLink(MutateMerchantCenterLinkRequest) returns (MutateMerchantCenterLinkResponse) {
+ rpc MutateMerchantCenterLink(MutateMerchantCenterLinkRequest)
+ returns (MutateMerchantCenterLinkResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/merchantCenterLinks:mutate"
+ post: "/v13/customers/{customer_id=*}/merchantCenterLinks:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operation";
}
}
-// Request message for [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v10.services.MerchantCenterLinkService.ListMerchantCenterLinks].
+// Request message for
+// [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v13.services.MerchantCenterLinkService.ListMerchantCenterLinks].
message ListMerchantCenterLinksRequest {
- // Required. The ID of the customer onto which to apply the Merchant Center link list
- // operation.
+ // Required. The ID of the customer onto which to apply the Merchant Center
+ // link list operation.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v10.services.MerchantCenterLinkService.ListMerchantCenterLinks].
+// Response message for
+// [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v13.services.MerchantCenterLinkService.ListMerchantCenterLinks].
message ListMerchantCenterLinksResponse {
// Merchant Center links available for the requested customer
- repeated google.ads.googleads.v10.resources.MerchantCenterLink merchant_center_links = 1;
+ repeated google.ads.googleads.v13.resources.MerchantCenterLink
+ merchant_center_links = 1;
}
-// Request message for [MerchantCenterLinkService.GetMerchantCenterLink][google.ads.googleads.v10.services.MerchantCenterLinkService.GetMerchantCenterLink].
+// Request message for
+// [MerchantCenterLinkService.GetMerchantCenterLink][google.ads.googleads.v13.services.MerchantCenterLinkService.GetMerchantCenterLink].
message GetMerchantCenterLinkRequest {
// Required. Resource name of the Merchant Center link.
string resource_name = 1 [
@@ -115,13 +122,15 @@ message GetMerchantCenterLinkRequest {
];
}
-// Request message for [MerchantCenterLinkService.MutateMerchantCenterLink][google.ads.googleads.v10.services.MerchantCenterLinkService.MutateMerchantCenterLink].
+// Request message for
+// [MerchantCenterLinkService.MutateMerchantCenterLink][google.ads.googleads.v13.services.MerchantCenterLinkService.MutateMerchantCenterLink].
message MutateMerchantCenterLinkRequest {
// Required. The ID of the customer being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The operation to perform on the link
- MerchantCenterLinkOperation operation = 2 [(google.api.field_behavior) = REQUIRED];
+ MerchantCenterLinkOperation operation = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -137,15 +146,15 @@ message MerchantCenterLinkOperation {
oneof operation {
// Update operation: The merchant center link is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.MerchantCenterLink update = 1;
+ google.ads.googleads.v13.resources.MerchantCenterLink update = 1;
// Remove operation: A resource name for the removed merchant center link is
// expected, in this format:
//
// `customers/{customer_id}/merchantCenterLinks/{merchant_center_id}`
string remove = 2 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/MerchantCenterLink"
- }];
+ type: "googleads.googleapis.com/MerchantCenterLink"
+ }];
}
}
@@ -159,6 +168,6 @@ message MutateMerchantCenterLinkResponse {
message MutateMerchantCenterLinkResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/MerchantCenterLink"
- }];
+ type: "googleads.googleapis.com/MerchantCenterLink"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/offline_user_data_job_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/offline_user_data_job_service.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/services/offline_user_data_job_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/offline_user_data_job_service.proto
index 703285740..c3e4750ac 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/offline_user_data_job_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/offline_user_data_job_service.proto
@@ -14,25 +14,26 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/common/offline_user_data.proto";
-import "google/ads/googleads/v10/resources/offline_user_data_job.proto";
+import "google/ads/googleads/v13/common/offline_user_data.proto";
+import "google/ads/googleads/v13/resources/offline_user_data_job.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "OfflineUserDataJobServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the OfflineUserDataJobService.
@@ -54,9 +55,10 @@ service OfflineUserDataJobService {
// [OfflineUserDataJobError]()
// [QuotaError]()
// [RequestError]()
- rpc CreateOfflineUserDataJob(CreateOfflineUserDataJobRequest) returns (CreateOfflineUserDataJobResponse) {
+ rpc CreateOfflineUserDataJob(CreateOfflineUserDataJobRequest)
+ returns (CreateOfflineUserDataJobResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/offlineUserDataJobs:create"
+ post: "/v13/customers/{customer_id=*}/offlineUserDataJobs:create"
body: "*"
};
option (google.api.method_signature) = "customer_id,job";
@@ -75,9 +77,10 @@ service OfflineUserDataJobService {
// [OfflineUserDataJobError]()
// [QuotaError]()
// [RequestError]()
- rpc AddOfflineUserDataJobOperations(AddOfflineUserDataJobOperationsRequest) returns (AddOfflineUserDataJobOperationsResponse) {
+ rpc AddOfflineUserDataJobOperations(AddOfflineUserDataJobOperationsRequest)
+ returns (AddOfflineUserDataJobOperationsResponse) {
option (google.api.http) = {
- post: "/v10/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations"
+ post: "/v13/{resource_name=customers/*/offlineUserDataJobs/*}:addOperations"
body: "*"
};
option (google.api.method_signature) = "resource_name,operations";
@@ -97,27 +100,30 @@ service OfflineUserDataJobService {
// [OfflineUserDataJobError]()
// [QuotaError]()
// [RequestError]()
- rpc RunOfflineUserDataJob(RunOfflineUserDataJobRequest) returns (google.longrunning.Operation) {
+ rpc RunOfflineUserDataJob(RunOfflineUserDataJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
- post: "/v10/{resource_name=customers/*/offlineUserDataJobs/*}:run"
+ post: "/v13/{resource_name=customers/*/offlineUserDataJobs/*}:run"
body: "*"
};
option (google.api.method_signature) = "resource_name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
- metadata_type: "google.ads.googleads.v10.resources.OfflineUserDataJobMetadata"
+ metadata_type: "google.ads.googleads.v13.resources.OfflineUserDataJobMetadata"
};
}
}
// Request message for
-// [OfflineUserDataJobService.CreateOfflineUserDataJob][google.ads.googleads.v10.services.OfflineUserDataJobService.CreateOfflineUserDataJob].
+// [OfflineUserDataJobService.CreateOfflineUserDataJob][google.ads.googleads.v13.services.OfflineUserDataJobService.CreateOfflineUserDataJob].
message CreateOfflineUserDataJobRequest {
- // Required. The ID of the customer for which to create an offline user data job.
+ // Required. The ID of the customer for which to create an offline user data
+ // job.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The offline user data job to be created.
- google.ads.googleads.v10.resources.OfflineUserDataJob job = 2 [(google.api.field_behavior) = REQUIRED];
+ google.ads.googleads.v13.resources.OfflineUserDataJob job = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -129,15 +135,16 @@ message CreateOfflineUserDataJobRequest {
}
// Response message for
-// [OfflineUserDataJobService.CreateOfflineUserDataJob][google.ads.googleads.v10.services.OfflineUserDataJobService.CreateOfflineUserDataJob].
+// [OfflineUserDataJobService.CreateOfflineUserDataJob][google.ads.googleads.v13.services.OfflineUserDataJobService.CreateOfflineUserDataJob].
message CreateOfflineUserDataJobResponse {
// The resource name of the OfflineUserDataJob.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/OfflineUserDataJob"
- }];
+ type: "googleads.googleapis.com/OfflineUserDataJob"
+ }];
}
-// Request message for [OfflineUserDataJobService.RunOfflineUserDataJob][google.ads.googleads.v10.services.OfflineUserDataJobService.RunOfflineUserDataJob].
+// Request message for
+// [OfflineUserDataJobService.RunOfflineUserDataJob][google.ads.googleads.v13.services.OfflineUserDataJobService.RunOfflineUserDataJob].
message RunOfflineUserDataJobRequest {
// Required. The resource name of the OfflineUserDataJob to run.
string resource_name = 1 [
@@ -153,7 +160,7 @@ message RunOfflineUserDataJobRequest {
}
// Request message for
-// [OfflineUserDataJobService.AddOfflineUserDataJobOperations][google.ads.googleads.v10.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations].
+// [OfflineUserDataJobService.AddOfflineUserDataJobOperations][google.ads.googleads.v13.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations].
message AddOfflineUserDataJobOperationsRequest {
// Required. The resource name of the OfflineUserDataJob.
string resource_name = 1 [
@@ -172,7 +179,8 @@ message AddOfflineUserDataJobOperationsRequest {
optional bool enable_warnings = 6;
// Required. The list of operations to be done.
- repeated OfflineUserDataJobOperation operations = 3 [(google.api.field_behavior) = REQUIRED];
+ repeated OfflineUserDataJobOperation operations = 3
+ [(google.api.field_behavior) = REQUIRED];
// If true, the request is validated but not executed. Only errors are
// returned, not results.
@@ -185,11 +193,11 @@ message OfflineUserDataJobOperation {
oneof operation {
// Add the provided data to the transaction. Data cannot be retrieved after
// being uploaded.
- google.ads.googleads.v10.common.UserData create = 1;
+ google.ads.googleads.v13.common.UserData create = 1;
// Remove the provided data from the transaction. Data cannot be retrieved
// after being uploaded.
- google.ads.googleads.v10.common.UserData remove = 2;
+ google.ads.googleads.v13.common.UserData remove = 2;
// Remove all previously provided data. This is only supported for Customer
// Match.
@@ -198,12 +206,12 @@ message OfflineUserDataJobOperation {
}
// Response message for
-// [OfflineUserDataJobService.AddOfflineUserDataJobOperations][google.ads.googleads.v10.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations].
+// [OfflineUserDataJobService.AddOfflineUserDataJobOperations][google.ads.googleads.v13.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations].
message AddOfflineUserDataJobOperationsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 1;
// Non blocking errors that pertain to operation failures in the warnings
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/payments_account_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/payments_account_service.proto
similarity index 71%
rename from third_party/googleapis/google/ads/googleads/v10/services/payments_account_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/payments_account_service.proto
index a7f13749b..1282c7eda 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/payments_account_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/payments_account_service.proto
@@ -14,21 +14,21 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/payments_account.proto";
+import "google/ads/googleads/v13/resources/payments_account.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "PaymentsAccountServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the payments account service.
@@ -50,9 +50,10 @@ service PaymentsAccountService {
// [PaymentsAccountError]()
// [QuotaError]()
// [RequestError]()
- rpc ListPaymentsAccounts(ListPaymentsAccountsRequest) returns (ListPaymentsAccountsResponse) {
+ rpc ListPaymentsAccounts(ListPaymentsAccountsRequest)
+ returns (ListPaymentsAccountsResponse) {
option (google.api.http) = {
- get: "/v10/customers/{customer_id=*}/paymentsAccounts"
+ get: "/v13/customers/{customer_id=*}/paymentsAccounts"
};
option (google.api.method_signature) = "customer_id";
}
@@ -60,12 +61,15 @@ service PaymentsAccountService {
// Request message for fetching all accessible payments accounts.
message ListPaymentsAccountsRequest {
- // Required. The ID of the customer to apply the PaymentsAccount list operation to.
+ // Required. The ID of the customer to apply the PaymentsAccount list
+ // operation to.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [PaymentsAccountService.ListPaymentsAccounts][google.ads.googleads.v10.services.PaymentsAccountService.ListPaymentsAccounts].
+// Response message for
+// [PaymentsAccountService.ListPaymentsAccounts][google.ads.googleads.v13.services.PaymentsAccountService.ListPaymentsAccounts].
message ListPaymentsAccountsResponse {
// The list of accessible payments accounts.
- repeated google.ads.googleads.v10.resources.PaymentsAccount payments_accounts = 1;
+ repeated google.ads.googleads.v13.resources.PaymentsAccount
+ payments_accounts = 1;
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/services/product_link_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/product_link_service.proto
new file mode 100644
index 000000000..60b7c9c49
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/services/product_link_service.proto
@@ -0,0 +1,130 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.services;
+
+import "google/ads/googleads/v13/resources/product_link.proto";
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
+option java_multiple_files = true;
+option java_outer_classname = "ProductLinkServiceProto";
+option java_package = "com.google.ads.googleads.v13.services";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
+
+// This service allows management of links between a Google
+// Ads customer and another product.
+service ProductLinkService {
+ option (google.api.default_host) = "googleads.googleapis.com";
+ option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";
+
+ // Creates a product link.
+ //
+ // List of thrown errors:
+ // [AuthenticationError]()
+ // [AuthorizationError]()
+ // [DatabaseError]()
+ // [FieldError]()
+ // [HeaderError]()
+ // [InternalError]()
+ // [MutateError]()
+ // [QuotaError]()
+ // [RequestError]()
+ rpc CreateProductLink(CreateProductLinkRequest)
+ returns (CreateProductLinkResponse) {
+ option (google.api.http) = {
+ post: "/v13/customers/{customer_id=*}/productLinks:create"
+ body: "*"
+ };
+ option (google.api.method_signature) = "customer_id,product_link";
+ }
+
+ // Removes a product link.
+ //
+ // List of thrown errors:
+ // [AuthenticationError]()
+ // [AuthorizationError]()
+ // [FieldMaskError]()
+ // [HeaderError]()
+ // [InternalError]()
+ // [MutateError]()
+ // [QuotaError]()
+ // [RequestError]()
+ rpc RemoveProductLink(RemoveProductLinkRequest)
+ returns (RemoveProductLinkResponse) {
+ option (google.api.http) = {
+ post: "/v13/customers/{customer_id=*}/productLinks:remove"
+ body: "*"
+ };
+ option (google.api.method_signature) = "customer_id,resource_name";
+ }
+}
+
+// Request message for
+// [ProductLinkService.CreateProductLink][google.ads.googleads.v13.services.ProductLinkService.CreateProductLink].
+message CreateProductLinkRequest {
+ // Required. The ID of the customer for which the product link is created.
+ string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The product link to be created.
+ google.ads.googleads.v13.resources.ProductLink product_link = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response message for
+// [ProductLinkService.CreateProductLink][google.ads.googleads.v13.services.ProductLinkService.CreateProductLink].
+message CreateProductLinkResponse {
+ // Returned for successful operations. Resource name of the product link.
+ string resource_name = 1 [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/ProductLink"
+ }];
+}
+
+// Request message for
+// [ProductLinkService.RemoveProductLink][google.ads.googleads.v13.services.ProductLinkService.RemoveProductLink].
+message RemoveProductLinkRequest {
+ // Required. The ID of the customer being modified.
+ string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Remove operation: A resource name for the product link to remove
+ // is expected, in this format:
+ //
+ // `customers/{customer_id}/productLinks/{product_link_id} `
+ string resource_name = 2 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/ProductLink"
+ }
+ ];
+
+ // If true, the request is validated but not executed. Only errors are
+ // returned, not results.
+ bool validate_only = 3;
+}
+
+// Response message for product link removal.
+message RemoveProductLinkResponse {
+ // Result for the remove request.
+ string resource_name = 1 [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/ProductLink"
+ }];
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/reach_plan_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/reach_plan_service.proto
similarity index 67%
rename from third_party/googleapis/google/ads/googleads/v10/services/reach_plan_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/reach_plan_service.proto
index da1ec03bf..621ecaaf6 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/reach_plan_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/reach_plan_service.proto
@@ -14,26 +14,25 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
-
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/common/dates.proto";
-import "google/ads/googleads/v10/enums/frequency_cap_time_unit.proto";
-import "google/ads/googleads/v10/enums/reach_plan_ad_length.proto";
-import "google/ads/googleads/v10/enums/reach_plan_age_range.proto";
-import "google/ads/googleads/v10/enums/reach_plan_network.proto";
+package google.ads.googleads.v13.services;
+
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/common/dates.proto";
+import "google/ads/googleads/v13/enums/frequency_cap_time_unit.proto";
+import "google/ads/googleads/v13/enums/reach_plan_age_range.proto";
+import "google/ads/googleads/v13/enums/reach_plan_network.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ReachPlanServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the reach plan service.
@@ -55,9 +54,10 @@ service ReachPlanService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc ListPlannableLocations(ListPlannableLocationsRequest) returns (ListPlannableLocationsResponse) {
+ rpc ListPlannableLocations(ListPlannableLocationsRequest)
+ returns (ListPlannableLocationsResponse) {
option (google.api.http) = {
- post: "/v10:listPlannableLocations"
+ post: "/v13:listPlannableLocations"
body: "*"
};
}
@@ -72,34 +72,15 @@ service ReachPlanService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc ListPlannableProducts(ListPlannableProductsRequest) returns (ListPlannableProductsResponse) {
+ rpc ListPlannableProducts(ListPlannableProductsRequest)
+ returns (ListPlannableProductsResponse) {
option (google.api.http) = {
- post: "/v10:listPlannableProducts"
+ post: "/v13:listPlannableProducts"
body: "*"
};
option (google.api.method_signature) = "plannable_location_id";
}
- // Generates a product mix ideas given a set of preferences. This method
- // helps the advertiser to obtain a good mix of ad formats and budget
- // allocations based on its preferences.
- //
- // List of thrown errors:
- // [AuthenticationError]()
- // [AuthorizationError]()
- // [HeaderError]()
- // [InternalError]()
- // [QuotaError]()
- // [ReachPlanError]()
- // [RequestError]()
- rpc GenerateProductMixIdeas(GenerateProductMixIdeasRequest) returns (GenerateProductMixIdeasResponse) {
- option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:generateProductMixIdeas"
- body: "*"
- };
- option (google.api.method_signature) = "customer_id,plannable_location_id,currency_code,budget_micros";
- }
-
// Generates a reach forecast for a given targeting / product mix.
//
// List of thrown errors:
@@ -112,19 +93,20 @@ service ReachPlanService {
// [RangeError]()
// [ReachPlanError]()
// [RequestError]()
- rpc GenerateReachForecast(GenerateReachForecastRequest) returns (GenerateReachForecastResponse) {
+ rpc GenerateReachForecast(GenerateReachForecastRequest)
+ returns (GenerateReachForecastResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:generateReachForecast"
+ post: "/v13/customers/{customer_id=*}:generateReachForecast"
body: "*"
};
- option (google.api.method_signature) = "customer_id,campaign_duration,planned_products";
+ option (google.api.method_signature) =
+ "customer_id,campaign_duration,planned_products";
}
}
-// Request message for [ReachPlanService.ListPlannableLocations][google.ads.googleads.v10.services.ReachPlanService.ListPlannableLocations].
-message ListPlannableLocationsRequest {
-
-}
+// Request message for
+// [ReachPlanService.ListPlannableLocations][google.ads.googleads.v13.services.ReachPlanService.ListPlannableLocations].
+message ListPlannableLocationsRequest {}
// The list of plannable locations.
message ListPlannableLocationsResponse {
@@ -146,8 +128,8 @@ message PlannableLocation {
// The parent country (not present if location is a country).
// If present, will always be a GeoTargetConstant ID. Additional information
// such as country name is provided by
- // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v10.services.ReachPlanService.ListPlannableLocations] or
- // [GoogleAdsService.Search/SearchStream][].
+ // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v13.services.ReachPlanService.ListPlannableLocations]
+ // or [GoogleAdsService.Search/SearchStream][].
optional int64 parent_country_id = 6;
// The ISO-3166-1 alpha-2 country code that is associated with the location.
@@ -160,8 +142,9 @@ message PlannableLocation {
// Request to list available products in a given location.
message ListPlannableProductsRequest {
- // Required. The ID of the selected location for planning. To list the available
- // plannable location IDs use [ReachPlanService.ListPlannableLocations][google.ads.googleads.v10.services.ReachPlanService.ListPlannableLocations].
+ // Required. The ID of the selected location for planning. To list the
+ // available plannable location IDs use
+ // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v13.services.ReachPlanService.ListPlannableLocations].
string plannable_location_id = 2 [(google.api.field_behavior) = REQUIRED];
}
@@ -176,7 +159,7 @@ message ProductMetadata {
// The code associated with the ad product (for example: BUMPER,
// TRUEVIEW_IN_STREAM).
// To list the available plannable product codes use
- // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v10.services.ReachPlanService.ListPlannableProducts].
+ // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v13.services.ReachPlanService.ListPlannableProducts].
optional string plannable_product_code = 4;
// The name associated with the ad product.
@@ -191,87 +174,29 @@ message PlannableTargeting {
// Allowed plannable age ranges for the product for which metrics will be
// reported. Actual targeting is computed by mapping this age range onto
// standard Google common.AgeRangeInfo values.
- repeated google.ads.googleads.v10.enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange age_ranges = 1;
+ repeated
+ google.ads.googleads.v13.enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange
+ age_ranges = 1;
// Targetable genders for the ad product.
- repeated google.ads.googleads.v10.common.GenderInfo genders = 2;
+ repeated google.ads.googleads.v13.common.GenderInfo genders = 2;
// Targetable devices for the ad product.
// TABLET device targeting is automatically applied to reported metrics
// when MOBILE targeting is selected for CPM_MASTHEAD,
// GOOGLE_PREFERRED_BUMPER, and GOOGLE_PREFERRED_SHORT products.
- repeated google.ads.googleads.v10.common.DeviceInfo devices = 3;
+ repeated google.ads.googleads.v13.common.DeviceInfo devices = 3;
// Targetable networks for the ad product.
- repeated google.ads.googleads.v10.enums.ReachPlanNetworkEnum.ReachPlanNetwork networks = 4;
-}
-
-// Request message for [ReachPlanService.GenerateProductMixIdeas][google.ads.googleads.v10.services.ReachPlanService.GenerateProductMixIdeas].
-message GenerateProductMixIdeasRequest {
- // Required. The ID of the customer.
- string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
-
- // Required. The ID of the location, this is one of the IDs returned by
- // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v10.services.ReachPlanService.ListPlannableLocations].
- string plannable_location_id = 6 [(google.api.field_behavior) = REQUIRED];
-
- // Required. Currency code.
- // Three-character ISO 4217 currency code.
- string currency_code = 7 [(google.api.field_behavior) = REQUIRED];
-
- // Required. Total budget.
- // Amount in micros. One million is equivalent to one unit.
- int64 budget_micros = 8 [(google.api.field_behavior) = REQUIRED];
-
- // The preferences of the suggested product mix.
- // An unset preference is interpreted as all possible values are allowed,
- // unless explicitly specified.
- Preferences preferences = 5;
-}
-
-// Set of preferences about the planned mix.
-message Preferences {
- // True if ad skippable.
- // If not set, default is any value.
- optional bool is_skippable = 6;
-
- // True if ad start with sound.
- // If not set, default is any value.
- optional bool starts_with_sound = 7;
-
- // The length of the ad.
- // If not set, default is any value.
- google.ads.googleads.v10.enums.ReachPlanAdLengthEnum.ReachPlanAdLength ad_length = 3;
-
- // True if ad will only show on the top content.
- // If not set, default is false.
- optional bool top_content_only = 8;
-
- // True if the price is guaranteed. The cost of serving the ad is agreed
- // upfront and not subject to an auction.
- // If not set, default is any value.
- optional bool has_guaranteed_price = 9;
-}
-
-// The suggested product mix.
-message GenerateProductMixIdeasResponse {
- // A list of products (ad formats) and the associated budget allocation idea.
- repeated ProductAllocation product_allocation = 1;
-}
-
-// An allocation of a part of the budget on a given product.
-message ProductAllocation {
- // Selected product for planning. The product codes returned are within the
- // set of the ones returned by ListPlannableProducts when using the same
- // location ID.
- optional string plannable_product_code = 3;
+ repeated google.ads.googleads.v13.enums.ReachPlanNetworkEnum.ReachPlanNetwork
+ networks = 4;
- // The value to be allocated for the suggested product in requested currency.
- // Amount in micros. One million is equivalent to one unit.
- optional int64 budget_micros = 4;
+ // Targetable YouTube Select Lineups for the ad product.
+ repeated YouTubeSelectLineUp youtube_select_lineups = 5;
}
-// Request message for [ReachPlanService.GenerateReachForecast][google.ads.googleads.v10.services.ReachPlanService.GenerateReachForecast].
+// Request message for
+// [ReachPlanService.GenerateReachForecast][google.ads.googleads.v13.services.ReachPlanService.GenerateReachForecast].
message GenerateReachForecastRequest {
// Required. The ID of the customer.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
@@ -281,19 +206,20 @@ message GenerateReachForecastRequest {
optional string currency_code = 9;
// Required. Campaign duration.
- CampaignDuration campaign_duration = 3 [(google.api.field_behavior) = REQUIRED];
+ CampaignDuration campaign_duration = 3
+ [(google.api.field_behavior) = REQUIRED];
- // Desired cookie frequency cap to be applied to each planned product.
+ // Chosen cookie frequency cap to be applied to each planned product.
// This is equivalent to the frequency cap exposed in Google Ads when creating
// a campaign, it represents the maximum number of times an ad can be shown to
// the same user.
// If not specified, no cap is applied.
//
// This field is deprecated in v4 and will eventually be removed.
- // Please use cookie_frequency_cap_setting instead.
+ // Use cookie_frequency_cap_setting instead.
optional int32 cookie_frequency_cap = 10;
- // Desired cookie frequency cap to be applied to each planned product.
+ // Chosen cookie frequency cap to be applied to each planned product.
// This is equivalent to the frequency cap exposed in Google Ads when creating
// a campaign, it represents the maximum number of times an ad can be shown to
// the same user during a specified time interval.
@@ -302,7 +228,7 @@ message GenerateReachForecastRequest {
// This field replaces the deprecated cookie_frequency_cap field.
FrequencyCap cookie_frequency_cap_setting = 8;
- // Desired minimum effective frequency (the number of times a person was
+ // Chosen minimum effective frequency (the number of times a person was
// exposed to the ad) for the reported reach metrics [1-10].
// This won't affect the targeting, but just the reporting.
// If not specified, a default of 1 is applied.
@@ -325,14 +251,22 @@ message GenerateReachForecastRequest {
// The targeting to be applied to all products selected in the product mix.
//
// This is planned targeting: execution details might vary based on the
- // advertising product, please consult an implementation specialist.
+ // advertising product, consult an implementation specialist.
//
// See specific metrics for details on how targeting affects them.
Targeting targeting = 6;
// Required. The products to be forecast.
// The max number of allowed planned products is 15.
- repeated PlannedProduct planned_products = 7 [(google.api.field_behavior) = REQUIRED];
+ repeated PlannedProduct planned_products = 7
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Controls the forecast metrics returned in the response.
+ ForecastMetricOptions forecast_metric_options = 13;
+
+ // The name of the customer being planned for. This is a user-defined value.
+ // Required if targeting.audience_targeting is set.
+ optional string customer_reach_group = 14;
}
// Effective frequency limit.
@@ -350,34 +284,58 @@ message FrequencyCap {
int32 impressions = 3 [(google.api.field_behavior) = REQUIRED];
// Required. The type of time unit.
- google.ads.googleads.v10.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2 [(google.api.field_behavior) = REQUIRED];
+ google.ads.googleads.v13.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit
+ time_unit = 2 [(google.api.field_behavior) = REQUIRED];
}
// The targeting for which traffic metrics will be reported.
message Targeting {
- // Required. The ID of the selected location. Plannable location IDs can be
- // obtained from [ReachPlanService.ListPlannableLocations][google.ads.googleads.v10.services.ReachPlanService.ListPlannableLocations].
+ // The ID of the selected location. Plannable location IDs can be
+ // obtained from
+ // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v13.services.ReachPlanService.ListPlannableLocations].
+ //
+ // Requests must set either this field or `plannable_location_ids`.
+ //
+ // This field is deprecated as of V12 and will be removed in a future release.
+ // Use `plannable_location_ids` instead.
optional string plannable_location_id = 6;
+ // The list of plannable location IDs to target with this forecast.
+ //
+ // If more than one ID is provided, all IDs must have the same
+ // `parent_country_id`. Planning for more than `parent_county` is not
+ // supported. Plannable location IDs and their `parent_country_id` can be
+ // obtained from
+ // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v13.services.ReachPlanService.ListPlannableLocations].
+ //
+ // Requests must set either this field or `plannable_location_id`.
+ repeated string plannable_location_ids = 8;
+
// Targeted age range.
// An unset value is equivalent to targeting all ages.
- google.ads.googleads.v10.enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange age_range = 2;
+ google.ads.googleads.v13.enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange
+ age_range = 2;
// Targeted genders.
// An unset value is equivalent to targeting MALE and FEMALE.
- repeated google.ads.googleads.v10.common.GenderInfo genders = 3;
+ repeated google.ads.googleads.v13.common.GenderInfo genders = 3;
// Targeted devices.
// If not specified, targets all applicable devices. Applicable devices vary
// by product and region and can be obtained from
- // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v10.services.ReachPlanService.ListPlannableProducts].
- repeated google.ads.googleads.v10.common.DeviceInfo devices = 4;
+ // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v13.services.ReachPlanService.ListPlannableProducts].
+ repeated google.ads.googleads.v13.common.DeviceInfo devices = 4;
// Targetable network for the ad product.
// If not specified, targets all applicable networks. Applicable networks vary
// by product and region and can be obtained from
- // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v10.services.ReachPlanService.ListPlannableProducts].
- google.ads.googleads.v10.enums.ReachPlanNetworkEnum.ReachPlanNetwork network = 5;
+ // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v13.services.ReachPlanService.ListPlannableProducts].
+ google.ads.googleads.v13.enums.ReachPlanNetworkEnum.ReachPlanNetwork network =
+ 5;
+
+ // Targeted audiences.
+ // If not specified, does not target any specific audience.
+ AudienceTargeting audience_targeting = 7;
}
// The duration of a planned campaign.
@@ -393,7 +351,7 @@ message CampaignDuration {
// date range must be <= 92 days long.
//
// This field cannot be combined with the duration_in_days field.
- google.ads.googleads.v10.common.DateRange date_range = 3;
+ google.ads.googleads.v13.common.DateRange date_range = 3;
}
// A product being planned for reach.
@@ -401,13 +359,18 @@ message PlannedProduct {
// Required. Selected product for planning.
// The code associated with the ad product (for example: Trueview, Bumper).
// To list the available plannable product codes use
- // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v10.services.ReachPlanService.ListPlannableProducts].
+ // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v13.services.ReachPlanService.ListPlannableProducts].
optional string plannable_product_code = 3;
// Required. Maximum budget allocation in micros for the selected product.
// The value is specified in the selected planning currency_code.
// For example: 1 000 000$ = 1 000 000 000 000 micros.
optional int64 budget_micros = 4;
+
+ // Targeting settings for the selected product.
+ // To list the available targeting for each product use
+ // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v13.services.ReachPlanService.ListPlannableProducts].
+ AdvancedProductTargeting advanced_product_targeting = 5;
}
// Response message containing the generated reach curve.
@@ -479,6 +442,23 @@ message Forecast {
// GenerateReachForecastRequest.effective_frequency_limit. If no
// effective_frequency_limit was set, this list will be empty.
repeated EffectiveFrequencyBreakdown effective_frequency_breakdowns = 10;
+
+ // Number of unique people reached that exactly matches the Targeting
+ // including co-viewers.
+ optional int64 on_target_coview_reach = 11;
+
+ // Number of unique people reached including co-viewers. This includes
+ // people that may fall outside the specified Targeting.
+ optional int64 total_coview_reach = 12;
+
+ // Number of ad impressions that exactly matches the Targeting including
+ // co-viewers.
+ optional int64 on_target_coview_impressions = 13;
+
+ // Total number of ad impressions including co-viewers. This includes
+ // impressions that may fall outside the specified Targeting, due to
+ // insufficient information on signed-in users.
+ optional int64 total_coview_impressions = 14;
}
// The forecasted allocation and traffic metrics for a specific product
@@ -528,6 +508,23 @@ message PlannedProductForecast {
// more information about what makes an ad viewable and how
// viewability is measured.
optional int64 viewable_impressions = 5;
+
+ // Number of unique people reached that exactly matches the Targeting
+ // including co-viewers.
+ optional int64 on_target_coview_reach = 6;
+
+ // Number of unique people reached including co-viewers. This includes
+ // people that may fall outside the specified Targeting.
+ optional int64 total_coview_reach = 7;
+
+ // Number of ad impressions that exactly matches the Targeting including
+ // co-viewers.
+ optional int64 on_target_coview_impressions = 8;
+
+ // Total number of ad impressions including co-viewers. This includes
+ // impressions that may fall outside the specified Targeting, due to
+ // insufficient information on signed-in users.
+ optional int64 total_coview_impressions = 9;
}
// Audience metrics for the planned products.
@@ -565,4 +562,48 @@ message EffectiveFrequencyBreakdown {
// data to be reported. If the minimum number is not met, the total_reach
// value will be rounded to 0.
int64 total_reach = 3;
+
+ // The number of users (including co-viewing users) reached for the associated
+ // effective_frequency value.
+ optional int64 effective_coview_reach = 4;
+
+ // The number of users (including co-viewing users) reached for the associated
+ // effective_frequency value within the specified plan demographic.
+ optional int64 on_target_effective_coview_reach = 5;
+}
+
+// Controls forecast metrics to return.
+message ForecastMetricOptions {
+ // Indicates whether to include co-view metrics in the response forecast.
+ bool include_coview = 1;
+}
+
+// Audience targeting for reach forecast.
+message AudienceTargeting {
+ // List of audiences based on user interests to be targeted.
+ repeated google.ads.googleads.v13.common.UserInterestInfo user_interest = 1;
+}
+
+// Advanced targeting settings for products.
+message AdvancedProductTargeting {
+ // Targeting options for this product.
+ oneof advanced_targeting {
+ // Settings for YouTube Select targeting.
+ YouTubeSelectSettings youtube_select_settings = 1;
+ }
+}
+
+// Request settings for YouTube Select Lineups
+message YouTubeSelectSettings {
+ // Lineup for YouTube Select Targeting.
+ int64 lineup_id = 1;
+}
+
+// A Plannable YouTube Select Lineup for product targeting.
+message YouTubeSelectLineUp {
+ // The ID of the YouTube Select Lineup.
+ int64 lineup_id = 1;
+
+ // The unique name of the YouTube Select Lineup.
+ string lineup_name = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/recommendation_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/recommendation_service.proto
similarity index 58%
rename from third_party/googleapis/google/ads/googleads/v10/services/recommendation_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/recommendation_service.proto
index f332a2239..d4a1e7406 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/recommendation_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/recommendation_service.proto
@@ -14,25 +14,26 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/common/extensions.proto";
-import "google/ads/googleads/v10/enums/keyword_match_type.proto";
-import "google/ads/googleads/v10/resources/ad.proto";
+import "google/ads/googleads/v13/common/extensions.proto";
+import "google/ads/googleads/v13/enums/keyword_match_type.proto";
+import "google/ads/googleads/v13/resources/ad.proto";
+import "google/ads/googleads/v13/resources/asset.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "RecommendationServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Recommendation service.
@@ -55,9 +56,10 @@ service RecommendationService {
// [RecommendationError]()
// [RequestError]()
// [UrlFieldError]()
- rpc ApplyRecommendation(ApplyRecommendationRequest) returns (ApplyRecommendationResponse) {
+ rpc ApplyRecommendation(ApplyRecommendationRequest)
+ returns (ApplyRecommendationResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/recommendations:apply"
+ post: "/v13/customers/{customer_id=*}/recommendations:apply"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
@@ -73,16 +75,18 @@ service RecommendationService {
// [QuotaError]()
// [RecommendationError]()
// [RequestError]()
- rpc DismissRecommendation(DismissRecommendationRequest) returns (DismissRecommendationResponse) {
+ rpc DismissRecommendation(DismissRecommendationRequest)
+ returns (DismissRecommendationResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/recommendations:dismiss"
+ post: "/v13/customers/{customer_id=*}/recommendations:dismiss"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [RecommendationService.ApplyRecommendation][google.ads.googleads.v10.services.RecommendationService.ApplyRecommendation].
+// Request message for
+// [RecommendationService.ApplyRecommendation][google.ads.googleads.v13.services.RecommendationService.ApplyRecommendation].
message ApplyRecommendationRequest {
// Required. The ID of the customer with the recommendation.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
@@ -90,7 +94,8 @@ message ApplyRecommendationRequest {
// Required. The list of operations to apply recommendations.
// If partial_failure=false all recommendations should be of the same type
// There is a limit of 100 operations per request.
- repeated ApplyRecommendationOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated ApplyRecommendationOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, operations will be carried
@@ -109,11 +114,23 @@ message ApplyRecommendationOperation {
optional int64 new_budget_amount_micros = 2;
}
+ // Parameters to use when applying a forecasting set target roas
+ // recommendation.
+ message ForecastingSetTargetRoasParameters {
+ // New target ROAS (revenue per unit of spend) to set for a campaign
+ // resource.
+ // The value is between 0.01 and 1000.0, inclusive.
+ optional double target_roas = 1;
+
+ // New campaign budget amount to set for a campaign resource.
+ optional int64 campaign_budget_amount_micros = 2;
+ }
+
// Parameters to use when applying a text ad recommendation.
message TextAdParameters {
// New ad to add to recommended ad group. All necessary fields need to be
// set in this message. This is a required field.
- google.ads.googleads.v10.resources.Ad ad = 1;
+ google.ads.googleads.v13.resources.Ad ad = 1;
}
// Parameters to use when applying keyword recommendation.
@@ -122,7 +139,8 @@ message ApplyRecommendationOperation {
optional string ad_group = 4;
// The match type of the keyword. This is a required field.
- google.ads.googleads.v10.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 2;
+ google.ads.googleads.v13.enums.KeywordMatchTypeEnum.KeywordMatchType
+ match_type = 2;
// Optional, CPC bid to set for the keyword. If not set, keyword will use
// bid based on bidding strategy used by target ad group.
@@ -153,19 +171,76 @@ message ApplyRecommendationOperation {
// Parameters to use when applying callout extension recommendation.
message CalloutExtensionParameters {
// Callout extensions to be added. This is a required field.
- repeated google.ads.googleads.v10.common.CalloutFeedItem callout_extensions = 1;
+ repeated google.ads.googleads.v13.common.CalloutFeedItem
+ callout_extensions = 1;
}
// Parameters to use when applying call extension recommendation.
message CallExtensionParameters {
// Call extensions to be added. This is a required field.
- repeated google.ads.googleads.v10.common.CallFeedItem call_extensions = 1;
+ repeated google.ads.googleads.v13.common.CallFeedItem call_extensions = 1;
}
// Parameters to use when applying sitelink extension recommendation.
message SitelinkExtensionParameters {
// Sitelink extensions to be added. This is a required field.
- repeated google.ads.googleads.v10.common.SitelinkFeedItem sitelink_extensions = 1;
+ repeated google.ads.googleads.v13.common.SitelinkFeedItem
+ sitelink_extensions = 1;
+ }
+
+ // Parameters to use when applying callout asset recommendations.
+ message CalloutAssetParameters {
+ // Required. Callout assets to be added. This is a required field.
+ AdAssetApplyParameters ad_asset_apply_parameters = 1
+ [(google.api.field_behavior) = REQUIRED];
+ }
+
+ // Parameters to use when applying call asset recommendations.
+ message CallAssetParameters {
+ // Required. Call assets to be added. This is a required field.
+ AdAssetApplyParameters ad_asset_apply_parameters = 1
+ [(google.api.field_behavior) = REQUIRED];
+ }
+
+ // Parameters to use when applying sitelink asset recommendations.
+ message SitelinkAssetParameters {
+ // Required. Sitelink assets to be added. This is a required field.
+ AdAssetApplyParameters ad_asset_apply_parameters = 1
+ [(google.api.field_behavior) = REQUIRED];
+ }
+
+ // Common parameters used when applying ad asset recommendations.
+ message AdAssetApplyParameters {
+ // Scope to apply the assets to.
+ // Next ID: 4
+ enum ApplyScope {
+ // The apply scope has not been specified.
+ UNSPECIFIED = 0;
+
+ // Unknown.
+ UNKNOWN = 1;
+
+ // Apply at the customer scope.
+ CUSTOMER = 2;
+
+ // Apply at the campaign scope.
+ CAMPAIGN = 3;
+ }
+
+ // The assets to create and attach to a scope. This may be combined with
+ // existing_assets in the same call.
+ repeated google.ads.googleads.v13.resources.Asset new_assets = 1;
+
+ // The resource names of existing assets to attach to a scope. This may be
+ // combined with new_assets in the same call.
+ repeated string existing_assets = 2;
+
+ // Required. The scope at which to apply the assets. Assets at the campaign
+ // scope level will be applied to the campaign associated with the
+ // recommendation. Assets at the customer scope will apply to the entire
+ // account. Assets at the campaign scope will override any attached at the
+ // customer scope.
+ ApplyScope scope = 3 [(google.api.field_behavior) = REQUIRED];
}
// Parameters to use when applying move unused budget recommendation.
@@ -179,13 +254,30 @@ message ApplyRecommendationOperation {
// recommendation.
message ResponsiveSearchAdAssetParameters {
// Updated ad. The current ad's content will be replaced.
- google.ads.googleads.v10.resources.Ad updated_ad = 1;
+ google.ads.googleads.v13.resources.Ad updated_ad = 1;
+ }
+
+ // Parameters to use when applying a responsive search ad improve ad strength
+ // recommendation.
+ message ResponsiveSearchAdImproveAdStrengthParameters {
+ // Updated ad. The current ad's content will be replaced.
+ google.ads.googleads.v13.resources.Ad updated_ad = 1;
}
// Parameters to use when applying a responsive search ad recommendation.
message ResponsiveSearchAdParameters {
// Required. New ad to add to recommended ad group.
- google.ads.googleads.v10.resources.Ad ad = 1 [(google.api.field_behavior) = REQUIRED];
+ google.ads.googleads.v13.resources.Ad ad = 1
+ [(google.api.field_behavior) = REQUIRED];
+ }
+
+ // Parameters to use when applying a raise target CPA bid too low
+ // recommendation. The apply is asynchronous and can take minutes depending on
+ // the number of ad groups there is in the related campaign..
+ message RaiseTargetCpaBidTooLowParameters {
+ // Required. A number greater than 1.0 indicating the factor by which to
+ // increase the target CPA. This is a required field.
+ double target_multiplier = 1 [(google.api.field_behavior) = REQUIRED];
}
// Parameters to use when applying a use broad match keyword recommendation.
@@ -196,8 +288,8 @@ message ApplyRecommendationOperation {
// The resource name of the recommendation to apply.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Recommendation"
- }];
+ type: "googleads.googleapis.com/Recommendation"
+ }];
// Parameters to use when applying the recommendation.
oneof apply_parameters {
@@ -237,20 +329,45 @@ message ApplyRecommendationOperation {
// Parameters to use when applying a use broad match keyword recommendation.
UseBroadMatchKeywordParameters use_broad_match_keyword = 12;
- // Parameters to use when applying a responsive search ad recommendation.
+ // Parameters to use when applying a responsive search ad asset
+ // recommendation.
ResponsiveSearchAdAssetParameters responsive_search_ad_asset = 13;
+
+ // Parameters to use when applying a responsive search ad improve ad
+ // strength recommendation.
+ ResponsiveSearchAdImproveAdStrengthParameters
+ responsive_search_ad_improve_ad_strength = 14;
+
+ // Parameters to use when applying a raise target CPA bid too low
+ // recommendation. The apply is asynchronous and can take minutes depending
+ // on the number of ad groups there is in the related campaign.
+ RaiseTargetCpaBidTooLowParameters raise_target_cpa_bid_too_low = 15;
+
+ // Parameters to use when applying a forecasting set target ROAS
+ // recommendation.
+ ForecastingSetTargetRoasParameters forecasting_set_target_roas = 16;
+
+ // Parameters to use when applying callout asset recommendation.
+ CalloutAssetParameters callout_asset = 17;
+
+ // Parameters to use when applying call asset recommendation.
+ CallAssetParameters call_asset = 18;
+
+ // Parameters to use when applying sitelink asset recommendation.
+ SitelinkAssetParameters sitelink_asset = 19;
}
}
-// Response message for [RecommendationService.ApplyRecommendation][google.ads.googleads.v10.services.RecommendationService.ApplyRecommendation].
+// Response message for
+// [RecommendationService.ApplyRecommendation][google.ads.googleads.v13.services.RecommendationService.ApplyRecommendation].
message ApplyRecommendationResponse {
// Results of operations to apply recommendations.
repeated ApplyRecommendationResult results = 1;
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors)
- // we return the RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors) we return the RPC level error.
google.rpc.Status partial_failure_error = 2;
}
@@ -258,11 +375,12 @@ message ApplyRecommendationResponse {
message ApplyRecommendationResult {
// Returned for successful applies.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/Recommendation"
- }];
+ type: "googleads.googleapis.com/Recommendation"
+ }];
}
-// Request message for [RecommendationService.DismissRecommendation][google.ads.googleads.v10.services.RecommendationService.DismissRecommendation].
+// Request message for
+// [RecommendationService.DismissRecommendation][google.ads.googleads.v13.services.RecommendationService.DismissRecommendation].
message DismissRecommendationRequest {
// Operation to dismiss a single recommendation identified by resource_name.
message DismissRecommendationOperation {
@@ -276,7 +394,8 @@ message DismissRecommendationRequest {
// Required. The list of operations to dismiss recommendations.
// If partial_failure=false all recommendations should be of the same type
// There is a limit of 100 operations per request.
- repeated DismissRecommendationOperation operations = 3 [(google.api.field_behavior) = REQUIRED];
+ repeated DismissRecommendationOperation operations = 3
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, operations will be carried in a
@@ -285,7 +404,8 @@ message DismissRecommendationRequest {
bool partial_failure = 2;
}
-// Response message for [RecommendationService.DismissRecommendation][google.ads.googleads.v10.services.RecommendationService.DismissRecommendation].
+// Response message for
+// [RecommendationService.DismissRecommendation][google.ads.googleads.v13.services.RecommendationService.DismissRecommendation].
message DismissRecommendationResponse {
// The result of dismissing a recommendation.
message DismissRecommendationResult {
@@ -298,7 +418,7 @@ message DismissRecommendationResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors)
- // we return the RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors) we return the RPC level error.
google.rpc.Status partial_failure_error = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/remarketing_action_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/remarketing_action_service.proto
similarity index 73%
rename from third_party/googleapis/google/ads/googleads/v10/services/remarketing_action_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/remarketing_action_service.proto
index a59548a34..7bd20ee46 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/remarketing_action_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/remarketing_action_service.proto
@@ -14,9 +14,9 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/remarketing_action.proto";
+import "google/ads/googleads/v13/resources/remarketing_action.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -24,14 +24,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "RemarketingActionServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Remarketing Action service.
@@ -50,22 +50,27 @@ service RemarketingActionService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc MutateRemarketingActions(MutateRemarketingActionsRequest) returns (MutateRemarketingActionsResponse) {
+ rpc MutateRemarketingActions(MutateRemarketingActionsRequest)
+ returns (MutateRemarketingActionsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/remarketingActions:mutate"
+ post: "/v13/customers/{customer_id=*}/remarketingActions:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [RemarketingActionService.MutateRemarketingActions][google.ads.googleads.v10.services.RemarketingActionService.MutateRemarketingActions].
+// Request message for
+// [RemarketingActionService.MutateRemarketingActions][google.ads.googleads.v13.services.RemarketingActionService.MutateRemarketingActions].
message MutateRemarketingActionsRequest {
- // Required. The ID of the customer whose remarketing actions are being modified.
+ // Required. The ID of the customer whose remarketing actions are being
+ // modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of operations to perform on individual remarketing actions.
- repeated RemarketingActionOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of operations to perform on individual remarketing
+ // actions.
+ repeated RemarketingActionOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -87,11 +92,11 @@ message RemarketingActionOperation {
oneof operation {
// Create operation: No resource name is expected for the new remarketing
// action.
- google.ads.googleads.v10.resources.RemarketingAction create = 1;
+ google.ads.googleads.v13.resources.RemarketingAction create = 1;
// Update operation: The remarketing action is expected to have a valid
// resource name.
- google.ads.googleads.v10.resources.RemarketingAction update = 2;
+ google.ads.googleads.v13.resources.RemarketingAction update = 2;
}
}
@@ -99,8 +104,8 @@ message RemarketingActionOperation {
message MutateRemarketingActionsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -111,6 +116,6 @@ message MutateRemarketingActionsResponse {
message MutateRemarketingActionResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/RemarketingAction"
- }];
+ type: "googleads.googleapis.com/RemarketingAction"
+ }];
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/shared_criterion_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/shared_criterion_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/shared_criterion_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/shared_criterion_service.proto
index 475c73d50..4eac96c58 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/shared_criterion_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/shared_criterion_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/shared_criterion.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/shared_criterion.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "SharedCriterionServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Shared Criterion service.
@@ -63,22 +63,25 @@ service SharedCriterionService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateSharedCriteria(MutateSharedCriteriaRequest) returns (MutateSharedCriteriaResponse) {
+ rpc MutateSharedCriteria(MutateSharedCriteriaRequest)
+ returns (MutateSharedCriteriaResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/sharedCriteria:mutate"
+ post: "/v13/customers/{customer_id=*}/sharedCriteria:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [SharedCriterionService.MutateSharedCriteria][google.ads.googleads.v10.services.SharedCriterionService.MutateSharedCriteria].
+// Request message for
+// [SharedCriterionService.MutateSharedCriteria][google.ads.googleads.v13.services.SharedCriterionService.MutateSharedCriteria].
message MutateSharedCriteriaRequest {
// Required. The ID of the customer whose shared criteria are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual shared criteria.
- repeated SharedCriterionOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated SharedCriterionOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -92,7 +95,8 @@ message MutateSharedCriteriaRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, remove) on an shared criterion.
@@ -101,15 +105,15 @@ message SharedCriterionOperation {
oneof operation {
// Create operation: No resource name is expected for the new shared
// criterion.
- google.ads.googleads.v10.resources.SharedCriterion create = 1;
+ google.ads.googleads.v13.resources.SharedCriterion create = 1;
// Remove operation: A resource name for the removed shared criterion is
// expected, in this format:
//
// `customers/{customer_id}/sharedCriteria/{shared_set_id}~{criterion_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/SharedCriterion"
- }];
+ type: "googleads.googleapis.com/SharedCriterion"
+ }];
}
}
@@ -117,8 +121,8 @@ message SharedCriterionOperation {
message MutateSharedCriteriaResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -129,11 +133,11 @@ message MutateSharedCriteriaResponse {
message MutateSharedCriterionResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/SharedCriterion"
- }];
+ type: "googleads.googleapis.com/SharedCriterion"
+ }];
// The mutated shared criterion with only mutable fields after mutate. The
// field will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.SharedCriterion shared_criterion = 2;
+ google.ads.googleads.v13.resources.SharedCriterion shared_criterion = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/shared_set_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/shared_set_service.proto
similarity index 75%
rename from third_party/googleapis/google/ads/googleads/v10/services/shared_set_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/shared_set_service.proto
index f6f866887..057cc1247 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/shared_set_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/shared_set_service.proto
@@ -14,10 +14,10 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/enums/response_content_type.proto";
-import "google/ads/googleads/v10/resources/shared_set.proto";
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/resources/shared_set.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -25,14 +25,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "SharedSetServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the Shared Set service.
@@ -67,22 +67,25 @@ service SharedSetService {
// [SizeLimitError]()
// [StringFormatError]()
// [StringLengthError]()
- rpc MutateSharedSets(MutateSharedSetsRequest) returns (MutateSharedSetsResponse) {
+ rpc MutateSharedSets(MutateSharedSetsRequest)
+ returns (MutateSharedSetsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/sharedSets:mutate"
+ post: "/v13/customers/{customer_id=*}/sharedSets:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [SharedSetService.MutateSharedSets][google.ads.googleads.v10.services.SharedSetService.MutateSharedSets].
+// Request message for
+// [SharedSetService.MutateSharedSets][google.ads.googleads.v13.services.SharedSetService.MutateSharedSets].
message MutateSharedSetsRequest {
// Required. The ID of the customer whose shared sets are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual shared sets.
- repeated SharedSetOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated SharedSetOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -96,7 +99,8 @@ message MutateSharedSetsRequest {
// The response content type setting. Determines whether the mutable resource
// or just the resource name should be returned post mutation.
- google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
}
// A single operation (create, update, remove) on an shared set.
@@ -107,19 +111,19 @@ message SharedSetOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new shared set.
- google.ads.googleads.v10.resources.SharedSet create = 1;
+ google.ads.googleads.v13.resources.SharedSet create = 1;
// Update operation: The shared set is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.SharedSet update = 2;
+ google.ads.googleads.v13.resources.SharedSet update = 2;
// Remove operation: A resource name for the removed shared set is expected,
// in this format:
//
// `customers/{customer_id}/sharedSets/{shared_set_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/SharedSet"
- }];
+ type: "googleads.googleapis.com/SharedSet"
+ }];
}
}
@@ -127,8 +131,8 @@ message SharedSetOperation {
message MutateSharedSetsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -139,11 +143,11 @@ message MutateSharedSetsResponse {
message MutateSharedSetResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/SharedSet"
- }];
+ type: "googleads.googleapis.com/SharedSet"
+ }];
// The mutated shared set with only mutable fields after mutate. The field
// will only be returned when response_content_type is set to
// "MUTABLE_RESOURCE".
- google.ads.googleads.v10.resources.SharedSet shared_set = 2;
+ google.ads.googleads.v13.resources.SharedSet shared_set = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v13/services/smart_campaign_setting_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/smart_campaign_setting_service.proto
new file mode 100644
index 000000000..435dba1cf
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/services/smart_campaign_setting_service.proto
@@ -0,0 +1,212 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.services;
+
+import "google/ads/googleads/v13/enums/response_content_type.proto";
+import "google/ads/googleads/v13/enums/smart_campaign_not_eligible_reason.proto";
+import "google/ads/googleads/v13/enums/smart_campaign_status.proto";
+import "google/ads/googleads/v13/resources/smart_campaign_setting.proto";
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/field_mask.proto";
+import "google/rpc/status.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
+option java_multiple_files = true;
+option java_outer_classname = "SmartCampaignSettingServiceProto";
+option java_package = "com.google.ads.googleads.v13.services";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
+
+// Proto file describing the Smart campaign setting service.
+
+// Service to manage Smart campaign settings.
+service SmartCampaignSettingService {
+ option (google.api.default_host) = "googleads.googleapis.com";
+ option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";
+
+ // Returns the status of the requested Smart campaign.
+ rpc GetSmartCampaignStatus(GetSmartCampaignStatusRequest)
+ returns (GetSmartCampaignStatusResponse) {
+ option (google.api.http) = {
+ get: "/v13/{resource_name=customers/*/smartCampaignSettings/*}:getSmartCampaignStatus"
+ };
+ option (google.api.method_signature) = "resource_name";
+ }
+
+ // Updates Smart campaign settings for campaigns.
+ rpc MutateSmartCampaignSettings(MutateSmartCampaignSettingsRequest)
+ returns (MutateSmartCampaignSettingsResponse) {
+ option (google.api.http) = {
+ post: "/v13/customers/{customer_id=*}/smartCampaignSettings:mutate"
+ body: "*"
+ };
+ option (google.api.method_signature) = "customer_id,operations";
+ }
+}
+
+// Request message for
+// [SmartCampaignSettingService.GetSmartCampaignStatus][google.ads.googleads.v13.services.SmartCampaignSettingService.GetSmartCampaignStatus].
+message GetSmartCampaignStatusRequest {
+ // Required. The resource name of the Smart campaign setting belonging to the
+ // Smart campaign to fetch the status of.
+ string resource_name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "googleads.googleapis.com/SmartCampaignSetting"
+ }
+ ];
+}
+
+// Details related to Smart campaigns that are not eligible to serve.
+message SmartCampaignNotEligibleDetails {
+ // The reason why the Smart campaign is not eligible to serve.
+ optional google.ads.googleads.v13.enums.SmartCampaignNotEligibleReasonEnum
+ .SmartCampaignNotEligibleReason not_eligible_reason = 1;
+}
+
+// Details related to Smart campaigns that are eligible to serve.
+message SmartCampaignEligibleDetails {
+ // The timestamp of the last impression observed in the last 8 hours for this
+ // campaign.
+ // The timestamp is in the customer’s timezone and in
+ // “yyyy-MM-dd HH:mm:ss” format.
+ optional string last_impression_date_time = 1;
+
+ // The timestamp of when the campaign will end, if applicable.
+ // The timestamp is in the customer’s timezone and in
+ // “yyyy-MM-dd HH:mm:ss” format.
+ optional string end_date_time = 2;
+}
+
+// Details related to paused Smart campaigns.
+message SmartCampaignPausedDetails {
+ // The timestamp of when the campaign was last paused.
+ // The timestamp is in the customer’s timezone and in
+ // “yyyy-MM-dd HH:mm:ss” format.
+ optional string paused_date_time = 1;
+}
+
+// Details related to removed Smart campaigns.
+message SmartCampaignRemovedDetails {
+ // The timestamp of when the campaign was removed.
+ // The timestamp is in the customer’s timezone and in
+ // “yyyy-MM-dd HH:mm:ss” format.
+ optional string removed_date_time = 1;
+}
+
+// Details related to Smart campaigns that have ended.
+message SmartCampaignEndedDetails {
+ // The timestamp of when the campaign ended.
+ // The timestamp is in the customer’s timezone and in
+ // “yyyy-MM-dd HH:mm:ss” format.
+ optional string end_date_time = 1;
+}
+
+// Response message for
+// [SmartCampaignSettingService.GetSmartCampaignStatus][google.ads.googleads.v13.services.SmartCampaignSettingService.GetSmartCampaignStatus].
+message GetSmartCampaignStatusResponse {
+ // The status of this Smart campaign.
+ google.ads.googleads.v13.enums.SmartCampaignStatusEnum.SmartCampaignStatus
+ smart_campaign_status = 1;
+
+ // Additional details accompanying the status of a Smart campaign.
+ oneof smart_campaign_status_details {
+ // Details related to Smart campaigns that are ineligible to serve.
+ SmartCampaignNotEligibleDetails not_eligible_details = 2;
+
+ // Details related to Smart campaigns that are eligible to serve.
+ SmartCampaignEligibleDetails eligible_details = 3;
+
+ // Details relaed to paused Smart campaigns.
+ SmartCampaignPausedDetails paused_details = 4;
+
+ // Details related to removed Smart campaigns.
+ SmartCampaignRemovedDetails removed_details = 5;
+
+ // Details related to Smart campaigns that have ended.
+ SmartCampaignEndedDetails ended_details = 6;
+ }
+}
+
+// Request message for
+// [SmartCampaignSettingService.MutateSmartCampaignSetting][].
+message MutateSmartCampaignSettingsRequest {
+ // Required. The ID of the customer whose Smart campaign settings are being
+ // modified.
+ string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The list of operations to perform on individual Smart campaign
+ // settings.
+ repeated SmartCampaignSettingOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
+
+ // If true, successful operations will be carried out and invalid
+ // operations will return errors. If false, all operations will be carried
+ // out in one transaction if and only if they are all valid.
+ // Default is false.
+ bool partial_failure = 3;
+
+ // If true, the request is validated but not executed. Only errors are
+ // returned, not results.
+ bool validate_only = 4;
+
+ // The response content type setting. Determines whether the mutable resource
+ // or just the resource name should be returned post mutation.
+ google.ads.googleads.v13.enums.ResponseContentTypeEnum.ResponseContentType
+ response_content_type = 5;
+}
+
+// A single operation to update Smart campaign settings for a campaign.
+message SmartCampaignSettingOperation {
+ // Update operation: The Smart campaign setting must specify a valid
+ // resource name.
+ google.ads.googleads.v13.resources.SmartCampaignSetting update = 1;
+
+ // FieldMask that determines which resource fields are modified in an update.
+ google.protobuf.FieldMask update_mask = 2;
+}
+
+// Response message for campaign mutate.
+message MutateSmartCampaignSettingsResponse {
+ // Errors that pertain to operation failures in the partial failure mode.
+ // Returned only when partial_failure = true and all errors occur inside the
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
+ google.rpc.Status partial_failure_error = 1;
+
+ // All results for the mutate.
+ repeated MutateSmartCampaignSettingResult results = 2;
+}
+
+// The result for the Smart campaign setting mutate.
+message MutateSmartCampaignSettingResult {
+ // Returned for successful operations.
+ string resource_name = 1 [(google.api.resource_reference) = {
+ type: "googleads.googleapis.com/SmartCampaignSetting"
+ }];
+
+ // The mutated Smart campaign setting with only mutable fields after mutate.
+ // The field will only be returned when response_content_type is set to
+ // "MUTABLE_RESOURCE".
+ google.ads.googleads.v13.resources.SmartCampaignSetting
+ smart_campaign_setting = 2;
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/smart_campaign_suggest_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/smart_campaign_suggest_service.proto
similarity index 65%
rename from third_party/googleapis/google/ads/googleads/v10/services/smart_campaign_suggest_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/smart_campaign_suggest_service.proto
index 8e1af77e0..7eff6e94e 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/smart_campaign_suggest_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/smart_campaign_suggest_service.proto
@@ -14,24 +14,24 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/common/ad_type_infos.proto";
-import "google/ads/googleads/v10/common/criteria.proto";
-import "google/ads/googleads/v10/resources/keyword_theme_constant.proto";
+import "google/ads/googleads/v13/common/ad_type_infos.proto";
+import "google/ads/googleads/v13/common/criteria.proto";
+import "google/ads/googleads/v13/resources/keyword_theme_constant.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "SmartCampaignSuggestServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Service to get suggestions for Smart Campaigns.
service SmartCampaignSuggestService {
@@ -39,26 +39,30 @@ service SmartCampaignSuggestService {
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";
// Returns BudgetOption suggestions.
- rpc SuggestSmartCampaignBudgetOptions(SuggestSmartCampaignBudgetOptionsRequest) returns (SuggestSmartCampaignBudgetOptionsResponse) {
+ rpc SuggestSmartCampaignBudgetOptions(
+ SuggestSmartCampaignBudgetOptionsRequest)
+ returns (SuggestSmartCampaignBudgetOptionsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions"
+ post: "/v13/customers/{customer_id=*}:suggestSmartCampaignBudgetOptions"
body: "*"
};
}
// Suggests a Smart campaign ad compatible with the Ad family of resources,
// based on data points such as targeting and the business to advertise.
- rpc SuggestSmartCampaignAd(SuggestSmartCampaignAdRequest) returns (SuggestSmartCampaignAdResponse) {
+ rpc SuggestSmartCampaignAd(SuggestSmartCampaignAdRequest)
+ returns (SuggestSmartCampaignAdResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:suggestSmartCampaignAd"
+ post: "/v13/customers/{customer_id=*}:suggestSmartCampaignAd"
body: "*"
};
}
// Suggests keyword themes to advertise on.
- rpc SuggestKeywordThemes(SuggestKeywordThemesRequest) returns (SuggestKeywordThemesResponse) {
+ rpc SuggestKeywordThemes(SuggestKeywordThemesRequest)
+ returns (SuggestKeywordThemesResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:suggestKeywordThemes"
+ post: "/v13/customers/{customer_id=*}:suggestKeywordThemes"
body: "*"
};
}
@@ -83,7 +87,8 @@ message SuggestSmartCampaignBudgetOptionsRequest {
];
// Required. Information needed to get budget options
- SmartCampaignSuggestionInfo suggestion_info = 3 [(google.api.field_behavior) = REQUIRED];
+ SmartCampaignSuggestionInfo suggestion_info = 3
+ [(google.api.field_behavior) = REQUIRED];
}
}
@@ -93,7 +98,8 @@ message SmartCampaignSuggestionInfo {
// A list of locations.
message LocationList {
// Required. Locations.
- repeated google.ads.googleads.v10.common.LocationInfo locations = 1 [(google.api.field_behavior) = REQUIRED];
+ repeated google.ads.googleads.v13.common.LocationInfo locations = 1
+ [(google.api.field_behavior) = REQUIRED];
}
// A context that describes a business.
@@ -110,26 +116,32 @@ message SmartCampaignSuggestionInfo {
string language_code = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The business ad schedule.
- repeated google.ads.googleads.v10.common.AdScheduleInfo ad_schedules = 6 [(google.api.field_behavior) = OPTIONAL];
+ repeated google.ads.googleads.v13.common.AdScheduleInfo ad_schedules = 6
+ [(google.api.field_behavior) = OPTIONAL];
- // Optional. Smart campaign keyword themes. This field may greatly improve suggestion
- // accuracy and we recommend always setting it if possible.
- repeated google.ads.googleads.v10.common.KeywordThemeInfo keyword_themes = 7 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. Smart campaign keyword themes. This field may greatly improve
+ // suggestion accuracy and we recommend always setting it if possible.
+ repeated google.ads.googleads.v13.common.KeywordThemeInfo keyword_themes = 7
+ [(google.api.field_behavior) = OPTIONAL];
// The business settings to consider when generating suggestions.
// Settings are automatically extracted from the business when provided.
// Otherwise, these settings must be specified explicitly.
oneof business_setting {
// Optional. Context describing the business to advertise.
- BusinessContext business_context = 8 [(google.api.field_behavior) = OPTIONAL];
-
- // Optional. The ID of the Business Profile location.
- // The location ID can be fetched by Business Profile API with its form:
- // accounts/{accountId}/locations/{locationId}. The last {locationId}
- // component from the Business Profile API represents the
- // business_location_id. See the [Business Profile API]
- // (https://developers.google.com/my-business/reference/rest/v4/accounts.locations)
- int64 business_location_id = 2 [(google.api.field_behavior) = OPTIONAL];
+ BusinessContext business_context = 8
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The resource name of a Business Profile location.
+ // Business Profile location resource names can be fetched through the
+ // Business Profile API and adhere to the following format:
+ // `locations/{locationId}`.
+ //
+ // See the [Business Profile API]
+ // (https://developers.google.com/my-business/reference/businessinformation/rest/v1/accounts.locations)
+ // for additional details.
+ string business_profile_location = 9
+ [(google.api.field_behavior) = OPTIONAL];
}
// The geo target of the campaign, either a list of locations or
@@ -139,7 +151,8 @@ message SmartCampaignSuggestionInfo {
LocationList location_list = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. The targeting geo location by proximity.
- google.ads.googleads.v10.common.ProximityInfo proximity = 5 [(google.api.field_behavior) = OPTIONAL];
+ google.ads.googleads.v13.common.ProximityInfo proximity = 5
+ [(google.api.field_behavior) = OPTIONAL];
}
}
@@ -173,14 +186,15 @@ message SuggestSmartCampaignBudgetOptionsResponse {
optional BudgetOption low = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The recommended budget option.
- optional BudgetOption recommended = 2 [(google.api.field_behavior) = OPTIONAL];
+ optional BudgetOption recommended = 2
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. The highest budget option.
optional BudgetOption high = 3 [(google.api.field_behavior) = OPTIONAL];
}
// Request message for
-// [SmartCampaignSuggestService.SuggestSmartCampaignAd][google.ads.googleads.v10.services.SmartCampaignSuggestService.SuggestSmartCampaignAd].
+// [SmartCampaignSuggestService.SuggestSmartCampaignAd][google.ads.googleads.v13.services.SmartCampaignSuggestService.SuggestSmartCampaignAd].
message SuggestSmartCampaignAdRequest {
// Required. The ID of the customer.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
@@ -189,36 +203,55 @@ message SuggestSmartCampaignAdRequest {
// Required fields: final_url, language_code, keyword_themes.
// Optional but recommended fields to improve the quality of the suggestion:
// business_setting and geo_target.
- SmartCampaignSuggestionInfo suggestion_info = 2 [(google.api.field_behavior) = REQUIRED];
+ SmartCampaignSuggestionInfo suggestion_info = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Response message for
-// [SmartCampaignSuggestService.SuggestSmartCampaignAd][google.ads.googleads.v10.services.SmartCampaignSuggestService.SuggestSmartCampaignAd].
+// [SmartCampaignSuggestService.SuggestSmartCampaignAd][google.ads.googleads.v13.services.SmartCampaignSuggestService.SuggestSmartCampaignAd].
message SuggestSmartCampaignAdResponse {
- // Optional. Ad info includes 3 creative headlines and 2 creative descriptions.
- google.ads.googleads.v10.common.SmartCampaignAdInfo ad_info = 1 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. Ad info includes 3 creative headlines and 2 creative
+ // descriptions.
+ google.ads.googleads.v13.common.SmartCampaignAdInfo ad_info = 1
+ [(google.api.field_behavior) = OPTIONAL];
}
// Request message for
-// [SmartCampaignSuggestService.SuggestKeywordThemes][google.ads.googleads.v10.services.SmartCampaignSuggestService.SuggestKeywordThemes].
+// [SmartCampaignSuggestService.SuggestKeywordThemes][google.ads.googleads.v13.services.SmartCampaignSuggestService.SuggestKeywordThemes].
message SuggestKeywordThemesRequest {
// Required. The ID of the customer.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. Information to get keyword theme suggestions.
// Required fields:
+ //
// * suggestion_info.final_url
// * suggestion_info.language_code
// * suggestion_info.geo_target
//
// Recommended fields:
+ //
// * suggestion_info.business_setting
- SmartCampaignSuggestionInfo suggestion_info = 2 [(google.api.field_behavior) = REQUIRED];
+ SmartCampaignSuggestionInfo suggestion_info = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Response message for
-// [SmartCampaignSuggestService.SuggestKeywordThemes][google.ads.googleads.v10.services.SmartCampaignSuggestService.SuggestKeywordThemes].
+// [SmartCampaignSuggestService.SuggestKeywordThemes][google.ads.googleads.v13.services.SmartCampaignSuggestService.SuggestKeywordThemes].
message SuggestKeywordThemesResponse {
+ // A Smart campaign keyword theme suggestion.
+ message KeywordTheme {
+ // A keyword theme.
+ oneof keyword_theme {
+ // A Smart campaign keyword theme constant.
+ google.ads.googleads.v13.resources.KeywordThemeConstant
+ keyword_theme_constant = 1;
+
+ // A free-form text keyword theme.
+ string free_form_keyword_theme = 2;
+ }
+ }
+
// Smart campaign keyword theme suggestions.
- repeated google.ads.googleads.v10.resources.KeywordThemeConstant keyword_themes = 1;
+ repeated KeywordTheme keyword_themes = 2;
}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/third_party_app_analytics_link_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/third_party_app_analytics_link_service.proto
similarity index 74%
rename from third_party/googleapis/google/ads/googleads/v10/services/third_party_app_analytics_link_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/third_party_app_analytics_link_service.proto
index ad8ab030f..5360808db 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/third_party_app_analytics_link_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/third_party_app_analytics_link_service.proto
@@ -14,20 +14,20 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/resource.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "ThirdPartyAppAnalyticsLinkServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// This service allows management of links between Google Ads and third party
// app analytics.
@@ -45,25 +45,24 @@ service ThirdPartyAppAnalyticsLinkService {
// [InternalError]()
// [QuotaError]()
// [RequestError]()
- rpc RegenerateShareableLinkId(RegenerateShareableLinkIdRequest) returns (RegenerateShareableLinkIdResponse) {
+ rpc RegenerateShareableLinkId(RegenerateShareableLinkIdRequest)
+ returns (RegenerateShareableLinkIdResponse) {
option (google.api.http) = {
- post: "/v10/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId"
+ post: "/v13/{resource_name=customers/*/thirdPartyAppAnalyticsLinks/*}:regenerateShareableLinkId"
body: "*"
};
}
}
// Request message for
-// [ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId][google.ads.googleads.v10.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId].
+// [ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId][google.ads.googleads.v13.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId].
message RegenerateShareableLinkIdRequest {
// Resource name of the third party app analytics link.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/ThirdPartyAppAnalyticsLink"
- }];
+ type: "googleads.googleapis.com/ThirdPartyAppAnalyticsLink"
+ }];
}
// Response message for
-// [ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId][google.ads.googleads.v10.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId].
-message RegenerateShareableLinkIdResponse {
-
-}
+// [ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId][google.ads.googleads.v13.services.ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId].
+message RegenerateShareableLinkIdResponse {}
diff --git a/third_party/googleapis/google/ads/googleads/v13/services/travel_asset_suggestion_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/travel_asset_suggestion_service.proto
new file mode 100644
index 000000000..f3e546828
--- /dev/null
+++ b/third_party/googleapis/google/ads/googleads/v13/services/travel_asset_suggestion_service.proto
@@ -0,0 +1,123 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.ads.googleads.v13.services;
+
+import "google/ads/googleads/v13/enums/asset_field_type.proto";
+import "google/ads/googleads/v13/enums/call_to_action_type.proto";
+import "google/ads/googleads/v13/enums/hotel_asset_suggestion_status.proto";
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
+option java_multiple_files = true;
+option java_outer_classname = "TravelAssetSuggestionServiceProto";
+option java_package = "com.google.ads.googleads.v13.services";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
+
+// Service to retrieve Travel asset suggestions.
+service TravelAssetSuggestionService {
+ option (google.api.default_host) = "googleads.googleapis.com";
+ option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";
+
+ // Returns Travel Asset suggestions. Asset
+ // suggestions are returned on a best-effort basis. There are no guarantees
+ // that all possible asset types will be returned for any given hotel
+ // property.
+ rpc SuggestTravelAssets(SuggestTravelAssetsRequest)
+ returns (SuggestTravelAssetsResponse) {
+ option (google.api.http) = {
+ post: "/v13/customers/{customer_id=*}:suggestTravelAssets"
+ body: "*"
+ };
+ option (google.api.method_signature) = "customer_id,language_option";
+ }
+}
+
+// Request message for
+// [TravelSuggestAssetsService.SuggestTravelAssets][].
+message SuggestTravelAssetsRequest {
+ // Required. The ID of the customer.
+ string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The language specifications in BCP 47 format (for example, en-US,
+ // zh-CN, etc.) for the asset suggestions. Text will be in this language.
+ // Usually matches one of the campaign target languages.
+ string language_option = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // The Google Maps Place IDs of hotels for which assets are requested. See
+ // https://developers.google.com/places/web-service/place-id for more
+ // information.
+ repeated string place_id = 3;
+}
+
+// Response message for
+// [TravelSuggestAssetsService.SuggestTravelAssets][].
+message SuggestTravelAssetsResponse {
+ // Asset suggestions for each place ID submitted in the request.
+ repeated HotelAssetSuggestion hotel_asset_suggestions = 1;
+}
+
+// Message containing the asset suggestions for a hotel.
+message HotelAssetSuggestion {
+ // Google Places ID of the hotel.
+ string place_id = 1;
+
+ // Suggested final URL for an AssetGroup.
+ string final_url = 2;
+
+ // Hotel name in requested language.
+ string hotel_name = 3;
+
+ // Call to action type.
+ google.ads.googleads.v13.enums.CallToActionTypeEnum.CallToActionType
+ call_to_action = 4;
+
+ // Text assets such as headline, description, etc.
+ repeated HotelTextAsset text_assets = 5;
+
+ // Image assets such as landscape/portrait/square, etc.
+ repeated HotelImageAsset image_assets = 6;
+
+ // The status of the hotel asset suggestion.
+ google.ads.googleads.v13.enums.HotelAssetSuggestionStatusEnum
+ .HotelAssetSuggestionStatus status = 7;
+}
+
+// A single text asset suggestion for a hotel.
+message HotelTextAsset {
+ // Asset text in requested language.
+ string text = 1;
+
+ // The text asset type. For example, HEADLINE, DESCRIPTION, etc.
+ google.ads.googleads.v13.enums.AssetFieldTypeEnum.AssetFieldType
+ asset_field_type = 2;
+}
+
+// A single image asset suggestion for a hotel.
+message HotelImageAsset {
+ // URI for the image.
+ string uri = 1;
+
+ // The Image asset type. For example, MARKETING_IMAGE,
+ // PORTRAIT_MARKETING_IMAGE, etc.
+ google.ads.googleads.v13.enums.AssetFieldTypeEnum.AssetFieldType
+ asset_field_type = 2;
+}
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/user_data_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/user_data_service.proto
similarity index 61%
rename from third_party/googleapis/google/ads/googleads/v10/services/user_data_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/user_data_service.proto
index 77116d763..20d68d86c 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/user_data_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/user_data_service.proto
@@ -14,25 +14,30 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/common/offline_user_data.proto";
+import "google/ads/googleads/v13/common/offline_user_data.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "UserDataServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the UserDataService.
// Service to manage user data uploads.
+// Any uploads made to a Customer Match list through this service will be
+// eligible for matching as per the customer matching process. See
+// https://support.google.com/google-ads/answer/7474263. However, the uploads
+// made through this service will not be visible under the 'Segment members'
+// section for the Customer Match List in the Google Ads UI.
service UserDataService {
option (google.api.default_host) = "googleads.googleapis.com";
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";
@@ -53,24 +58,27 @@ service UserDataService {
// [UserDataError]()
rpc UploadUserData(UploadUserDataRequest) returns (UploadUserDataResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}:uploadUserData"
+ post: "/v13/customers/{customer_id=*}:uploadUserData"
body: "*"
};
}
}
-// Request message for [UserDataService.UploadUserData][google.ads.googleads.v10.services.UserDataService.UploadUserData]
+// Request message for
+// [UserDataService.UploadUserData][google.ads.googleads.v13.services.UserDataService.UploadUserData]
message UploadUserDataRequest {
// Required. The ID of the customer for which to update the user data.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to be done.
- repeated UserDataOperation operations = 3 [(google.api.field_behavior) = REQUIRED];
+ repeated UserDataOperation operations = 3
+ [(google.api.field_behavior) = REQUIRED];
// Metadata of the request.
oneof metadata {
// Metadata for data updates to a Customer Match user list.
- google.ads.googleads.v10.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 2;
+ google.ads.googleads.v13.common.CustomerMatchUserListMetadata
+ customer_match_user_list_metadata = 2;
}
}
@@ -79,17 +87,20 @@ message UserDataOperation {
// Operation to be made for the UploadUserDataRequest.
oneof operation {
// The list of user data to be appended to the user list.
- google.ads.googleads.v10.common.UserData create = 1;
+ google.ads.googleads.v13.common.UserData create = 1;
// The list of user data to be removed from the user list.
- google.ads.googleads.v10.common.UserData remove = 2;
+ google.ads.googleads.v13.common.UserData remove = 2;
}
}
-// Response message for [UserDataService.UploadUserData][google.ads.googleads.v10.services.UserDataService.UploadUserData]
+// Response message for
+// [UserDataService.UploadUserData][google.ads.googleads.v13.services.UserDataService.UploadUserData]
+// Uploads made through this service will not be visible under the 'Segment
+// members' section for the Customer Match List in the Google Ads UI.
message UploadUserDataResponse {
// The date time at which the request was received by API, formatted as
- // "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
+ // "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
optional string upload_date_time = 3;
// Number of upload data operations received by API.
diff --git a/third_party/googleapis/google/ads/googleads/v10/services/user_list_service.proto b/third_party/googleapis/google/ads/googleads/v13/services/user_list_service.proto
similarity index 76%
rename from third_party/googleapis/google/ads/googleads/v10/services/user_list_service.proto
rename to third_party/googleapis/google/ads/googleads/v13/services/user_list_service.proto
index 765b40ff6..eee61d5e4 100644
--- a/third_party/googleapis/google/ads/googleads/v10/services/user_list_service.proto
+++ b/third_party/googleapis/google/ads/googleads/v13/services/user_list_service.proto
@@ -14,9 +14,9 @@
syntax = "proto3";
-package google.ads.googleads.v10.services;
+package google.ads.googleads.v13.services;
-import "google/ads/googleads/v10/resources/user_list.proto";
+import "google/ads/googleads/v13/resources/user_list.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
@@ -24,14 +24,14 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/status.proto";
-option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
+option csharp_namespace = "Google.Ads.GoogleAds.V13.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v13/services;services";
option java_multiple_files = true;
option java_outer_classname = "UserListServiceProto";
-option java_package = "com.google.ads.googleads.v10.services";
+option java_package = "com.google.ads.googleads.v13.services";
option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V10::Services";
+option php_namespace = "Google\\Ads\\GoogleAds\\V13\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V13::Services";
// Proto file describing the User List service.
@@ -63,22 +63,25 @@ service UserListService {
// [StringFormatError]()
// [StringLengthError]()
// [UserListError]()
- rpc MutateUserLists(MutateUserListsRequest) returns (MutateUserListsResponse) {
+ rpc MutateUserLists(MutateUserListsRequest)
+ returns (MutateUserListsResponse) {
option (google.api.http) = {
- post: "/v10/customers/{customer_id=*}/userLists:mutate"
+ post: "/v13/customers/{customer_id=*}/userLists:mutate"
body: "*"
};
option (google.api.method_signature) = "customer_id,operations";
}
}
-// Request message for [UserListService.MutateUserLists][google.ads.googleads.v10.services.UserListService.MutateUserLists].
+// Request message for
+// [UserListService.MutateUserLists][google.ads.googleads.v13.services.UserListService.MutateUserLists].
message MutateUserListsRequest {
// Required. The ID of the customer whose user lists are being modified.
string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of operations to perform on individual user lists.
- repeated UserListOperation operations = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated UserListOperation operations = 2
+ [(google.api.field_behavior) = REQUIRED];
// If true, successful operations will be carried out and invalid
// operations will return errors. If false, all operations will be carried
@@ -99,19 +102,19 @@ message UserListOperation {
// The mutate operation.
oneof operation {
// Create operation: No resource name is expected for the new user list.
- google.ads.googleads.v10.resources.UserList create = 1;
+ google.ads.googleads.v13.resources.UserList create = 1;
// Update operation: The user list is expected to have a valid resource
// name.
- google.ads.googleads.v10.resources.UserList update = 2;
+ google.ads.googleads.v13.resources.UserList update = 2;
// Remove operation: A resource name for the removed user list is expected,
// in this format:
//
// `customers/{customer_id}/userLists/{user_list_id}`
string remove = 3 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/UserList"
- }];
+ type: "googleads.googleapis.com/UserList"
+ }];
}
}
@@ -119,8 +122,8 @@ message UserListOperation {
message MutateUserListsResponse {
// Errors that pertain to operation failures in the partial failure mode.
// Returned only when partial_failure = true and all errors occur inside the
- // operations. If any errors occur outside the operations (e.g. auth errors),
- // we return an RPC level error.
+ // operations. If any errors occur outside the operations (for example, auth
+ // errors), we return an RPC level error.
google.rpc.Status partial_failure_error = 3;
// All results for the mutate.
@@ -131,6 +134,6 @@ message MutateUserListsResponse {
message MutateUserListResult {
// Returned for successful operations.
string resource_name = 1 [(google.api.resource_reference) = {
- type: "googleads.googleapis.com/UserList"
- }];
+ type: "googleads.googleapis.com/UserList"
+ }];
}
diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/BUILD.bazel b/third_party/googleapis/google/analytics/admin/v1alpha/BUILD.bazel
index c654fc9fb..10534808f 100644
--- a/third_party/googleapis/google/analytics/admin/v1alpha/BUILD.bazel
+++ b/third_party/googleapis/google/analytics/admin/v1alpha/BUILD.bazel
@@ -24,6 +24,7 @@ proto_library(
"access_report.proto",
"analytics_admin.proto",
"audience.proto",
+ "expanded_data_set.proto",
"resources.proto",
],
deps = [
@@ -136,6 +137,7 @@ go_gapic_library(
grpc_service_config = "admin_grpc_service_config.json",
importpath = "google.golang.org/google/analytics/admin/v1alpha;admin",
metadata = True,
+ release_level = "alpha",
rest_numeric_enums = True,
service_yaml = "analyticsadmin_v1alpha.yaml",
transport = "grpc+rest",
@@ -358,6 +360,7 @@ csharp_gapic_library(
grpc_service_config = "admin_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "analyticsadmin_v1alpha.yaml",
+ transport = "grpc+rest",
deps = [
":admin_csharp_grpc",
":admin_csharp_proto",
diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/access_report.proto b/third_party/googleapis/google/analytics/admin/v1alpha/access_report.proto
index ce6a8aa15..6800357d1 100644
--- a/third_party/googleapis/google/analytics/admin/v1alpha/access_report.proto
+++ b/third_party/googleapis/google/analytics/admin/v1alpha/access_report.proto
@@ -306,8 +306,8 @@ message AccessQuota {
AccessQuotaStatus tokens_per_day = 1;
// Properties can use 50,000 tokens per hour. An API request consumes a single
- // number of tokens, and that number is deducted from both the hourly and
- // daily quotas.
+ // number of tokens, and that number is deducted from all of the hourly,
+ // daily, and per project hourly quotas.
AccessQuotaStatus tokens_per_hour = 2;
// Properties can use up to 50 concurrent requests.
@@ -316,6 +316,12 @@ message AccessQuota {
// Properties and cloud project pairs can have up to 50 server errors per
// hour.
AccessQuotaStatus server_errors_per_project_per_hour = 4;
+
+ // Properties can use up to 25% of their tokens per project per hour. This
+ // amounts to Analytics 360 Properties can use 12,500 tokens per project per
+ // hour. An API request consumes a single number of tokens, and that number is
+ // deducted from all of the hourly, daily, and per project hourly quotas.
+ AccessQuotaStatus tokens_per_project_per_hour = 5;
}
// Current state for a particular quota group.
diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/admin_grpc_service_config.json b/third_party/googleapis/google/analytics/admin/v1alpha/admin_grpc_service_config.json
index 7b40cde7a..c504383e3 100644
--- a/third_party/googleapis/google/analytics/admin/v1alpha/admin_grpc_service_config.json
+++ b/third_party/googleapis/google/analytics/admin/v1alpha/admin_grpc_service_config.json
@@ -10,6 +10,149 @@
"backoffMultiplier": 1.3,
"retryableStatusCodes": ["UNAVAILABLE", "UNKNOWN"]
}
+ },
+ {
+ "name": [
+ {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "GetAccount"
+ },
+ {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "ListAccounts"
+ },
+ {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "DeleteAccount"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "UpdateAccount"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "ProvisionAccountTicket"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "GetProperty"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "ListProperties"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "DeleteProperty"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "CreateProperty"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "UpdateProperty"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "GetUserLink"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "BatchGetUserLinks"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "ListUserLinks"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "AuditUserLinks"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "CreateUserLink"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "BatchCreateUserLinks"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "UpdateUserLink"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "BatchUpdateUserLinks"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "DeleteUserLink"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "BatchDeleteUserLinks"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "GetWebDataStream"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "UpdateWebDataStream"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "CreateWebDataStream"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "ListWebDataStreams"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "GetIosAppDataStream"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "DeleteIosAppDataStream"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "UpdateIosAppDataStream"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "CreateIosAppDataStream"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "ListIosAppDataStreams"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "GetAndroidAppDataStream"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "DeleteAndroidAppDataStream"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "UpdateAndroidAppDataStream"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "CreateAndroidAppDataStream"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "ListAndroidAppDataStreams"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "GetEnhancedMeasurementSettings"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "UpdateEnhancedMeasurementSettings"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "CreateFirebaseLink"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "UpdateFirebaseLink"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "DeleteFirebaseLink"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "ListFirebaseLinks"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "GetGlobalSiteTag"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "CreateGoogleAdsLink"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "UpdateGoogleAdsLink"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "DeleteGoogleAdsLink"
+ }, {
+ "service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
+ "method": "ListGoogleAdsLinks"
+ }
+ ],
+ "timeout": "60s"
}
]
}
diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/analytics_admin.proto b/third_party/googleapis/google/analytics/admin/v1alpha/analytics_admin.proto
index 926f91bb3..0e9d7a961 100644
--- a/third_party/googleapis/google/analytics/admin/v1alpha/analytics_admin.proto
+++ b/third_party/googleapis/google/analytics/admin/v1alpha/analytics_admin.proto
@@ -18,6 +18,7 @@ package google.analytics.admin.v1alpha;
import "google/analytics/admin/v1alpha/access_report.proto";
import "google/analytics/admin/v1alpha/audience.proto";
+import "google/analytics/admin/v1alpha/expanded_data_set.proto";
import "google/analytics/admin/v1alpha/resources.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
@@ -88,7 +89,8 @@ service AnalyticsAdminService {
}
// Requests a ticket for creating an account.
- rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse) {
+ rpc ProvisionAccountTicket(ProvisionAccountTicketRequest)
+ returns (ProvisionAccountTicketResponse) {
option (google.api.http) = {
post: "/v1alpha/accounts:provisionAccountTicket"
body: "*"
@@ -96,7 +98,8 @@ service AnalyticsAdminService {
}
// Returns summaries of all accounts accessible by the caller.
- rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse) {
+ rpc ListAccountSummaries(ListAccountSummariesRequest)
+ returns (ListAccountSummariesResponse) {
option (google.api.http) = {
get: "/v1alpha/accountSummaries"
};
@@ -141,7 +144,7 @@ service AnalyticsAdminService {
// will be permanently purged.
// https://support.google.com/analytics/answer/6154772
//
- // Returns an error if the target is not found, or is not an GA4 Property.
+ // Returns an error if the target is not found, or is not a GA4 Property.
rpc DeleteProperty(DeletePropertyRequest) returns (Property) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*}"
@@ -162,15 +165,14 @@ service AnalyticsAdminService {
rpc GetUserLink(GetUserLinkRequest) returns (UserLink) {
option (google.api.http) = {
get: "/v1alpha/{name=accounts/*/userLinks/*}"
- additional_bindings {
- get: "/v1alpha/{name=properties/*/userLinks/*}"
- }
+ additional_bindings { get: "/v1alpha/{name=properties/*/userLinks/*}" }
};
option (google.api.method_signature) = "name";
}
// Gets information about multiple users' links to an account or property.
- rpc BatchGetUserLinks(BatchGetUserLinksRequest) returns (BatchGetUserLinksResponse) {
+ rpc BatchGetUserLinks(BatchGetUserLinksRequest)
+ returns (BatchGetUserLinksResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=accounts/*}/userLinks:batchGet"
additional_bindings {
@@ -183,9 +185,7 @@ service AnalyticsAdminService {
rpc ListUserLinks(ListUserLinksRequest) returns (ListUserLinksResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=accounts/*}/userLinks"
- additional_bindings {
- get: "/v1alpha/{parent=properties/*}/userLinks"
- }
+ additional_bindings { get: "/v1alpha/{parent=properties/*}/userLinks" }
};
option (google.api.method_signature) = "parent";
}
@@ -231,7 +231,8 @@ service AnalyticsAdminService {
//
// This method is transactional. If any UserLink cannot be created, none of
// the UserLinks will be created.
- rpc BatchCreateUserLinks(BatchCreateUserLinksRequest) returns (BatchCreateUserLinksResponse) {
+ rpc BatchCreateUserLinks(BatchCreateUserLinksRequest)
+ returns (BatchCreateUserLinksResponse) {
option (google.api.http) = {
post: "/v1alpha/{parent=accounts/*}/userLinks:batchCreate"
body: "*"
@@ -256,7 +257,8 @@ service AnalyticsAdminService {
}
// Updates information about multiple users' links to an account or property.
- rpc BatchUpdateUserLinks(BatchUpdateUserLinksRequest) returns (BatchUpdateUserLinksResponse) {
+ rpc BatchUpdateUserLinks(BatchUpdateUserLinksRequest)
+ returns (BatchUpdateUserLinksResponse) {
option (google.api.http) = {
post: "/v1alpha/{parent=accounts/*}/userLinks:batchUpdate"
body: "*"
@@ -271,15 +273,14 @@ service AnalyticsAdminService {
rpc DeleteUserLink(DeleteUserLinkRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=accounts/*/userLinks/*}"
- additional_bindings {
- delete: "/v1alpha/{name=properties/*/userLinks/*}"
- }
+ additional_bindings { delete: "/v1alpha/{name=properties/*/userLinks/*}" }
};
option (google.api.method_signature) = "name";
}
// Deletes information about multiple users' links to an account or property.
- rpc BatchDeleteUserLinks(BatchDeleteUserLinksRequest) returns (google.protobuf.Empty) {
+ rpc BatchDeleteUserLinks(BatchDeleteUserLinksRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1alpha/{parent=accounts/*}/userLinks:batchDelete"
body: "*"
@@ -302,7 +303,8 @@ service AnalyticsAdminService {
}
// Deletes a FirebaseLink on a property
- rpc DeleteFirebaseLink(DeleteFirebaseLinkRequest) returns (google.protobuf.Empty) {
+ rpc DeleteFirebaseLink(DeleteFirebaseLinkRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/firebaseLinks/*}"
};
@@ -311,7 +313,8 @@ service AnalyticsAdminService {
// Lists FirebaseLinks on a property.
// Properties can have at most one FirebaseLink.
- rpc ListFirebaseLinks(ListFirebaseLinksRequest) returns (ListFirebaseLinksResponse) {
+ rpc ListFirebaseLinks(ListFirebaseLinksRequest)
+ returns (ListFirebaseLinksResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/firebaseLinks"
};
@@ -346,7 +349,8 @@ service AnalyticsAdminService {
}
// Deletes a GoogleAdsLink on a property
- rpc DeleteGoogleAdsLink(DeleteGoogleAdsLinkRequest) returns (google.protobuf.Empty) {
+ rpc DeleteGoogleAdsLink(DeleteGoogleAdsLinkRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/googleAdsLinks/*}"
};
@@ -354,7 +358,8 @@ service AnalyticsAdminService {
}
// Lists GoogleAdsLinks on a property.
- rpc ListGoogleAdsLinks(ListGoogleAdsLinksRequest) returns (ListGoogleAdsLinksResponse) {
+ rpc ListGoogleAdsLinks(ListGoogleAdsLinksRequest)
+ returns (ListGoogleAdsLinksResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/googleAdsLinks"
};
@@ -363,7 +368,8 @@ service AnalyticsAdminService {
// Get data sharing settings on an account.
// Data sharing settings are singletons.
- rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings) {
+ rpc GetDataSharingSettings(GetDataSharingSettingsRequest)
+ returns (DataSharingSettings) {
option (google.api.http) = {
get: "/v1alpha/{name=accounts/*/dataSharingSettings}"
};
@@ -371,7 +377,8 @@ service AnalyticsAdminService {
}
// Lookup for a single "GA4" MeasurementProtocolSecret.
- rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) {
+ rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest)
+ returns (MeasurementProtocolSecret) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}"
};
@@ -380,7 +387,8 @@ service AnalyticsAdminService {
// Returns child MeasurementProtocolSecrets under the specified parent
// Property.
- rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse) {
+ rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest)
+ returns (ListMeasurementProtocolSecretsResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets"
};
@@ -388,7 +396,8 @@ service AnalyticsAdminService {
}
// Creates a measurement protocol secret.
- rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) {
+ rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest)
+ returns (MeasurementProtocolSecret) {
option (google.api.http) = {
post: "/v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets"
body: "measurement_protocol_secret"
@@ -397,7 +406,8 @@ service AnalyticsAdminService {
}
// Deletes target MeasurementProtocolSecret.
- rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (google.protobuf.Empty) {
+ rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}"
};
@@ -405,19 +415,23 @@ service AnalyticsAdminService {
}
// Updates a measurement protocol secret.
- rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) {
+ rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest)
+ returns (MeasurementProtocolSecret) {
option (google.api.http) = {
patch: "/v1alpha/{measurement_protocol_secret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}"
body: "measurement_protocol_secret"
};
- option (google.api.method_signature) = "measurement_protocol_secret,update_mask";
+ option (google.api.method_signature) =
+ "measurement_protocol_secret,update_mask";
}
// Acknowledges the terms of user data collection for the specified property.
//
// This acknowledgement must be completed (either in the Google Analytics UI
- // or via this API) before MeasurementProtocolSecret resources may be created.
- rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse) {
+ // or through this API) before MeasurementProtocolSecret resources may be
+ // created.
+ rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest)
+ returns (AcknowledgeUserDataCollectionResponse) {
option (google.api.http) = {
post: "/v1alpha/{property=properties/*}:acknowledgeUserDataCollection"
body: "*"
@@ -426,7 +440,8 @@ service AnalyticsAdminService {
// Searches through all changes to an account or its children given the
// specified set of filters.
- rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse) {
+ rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest)
+ returns (SearchChangeHistoryEventsResponse) {
option (google.api.http) = {
post: "/v1alpha/{account=accounts/*}:searchChangeHistoryEvents"
body: "*"
@@ -434,7 +449,8 @@ service AnalyticsAdminService {
}
// Lookup for Google Signals settings for a property.
- rpc GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings) {
+ rpc GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest)
+ returns (GoogleSignalsSettings) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/googleSignalsSettings}"
};
@@ -442,16 +458,19 @@ service AnalyticsAdminService {
}
// Updates Google Signals settings for a property.
- rpc UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings) {
+ rpc UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest)
+ returns (GoogleSignalsSettings) {
option (google.api.http) = {
patch: "/v1alpha/{google_signals_settings.name=properties/*/googleSignalsSettings}"
body: "google_signals_settings"
};
- option (google.api.method_signature) = "google_signals_settings,update_mask";
+ option (google.api.method_signature) =
+ "google_signals_settings,update_mask";
}
// Creates a conversion event with the specified attributes.
- rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent) {
+ rpc CreateConversionEvent(CreateConversionEventRequest)
+ returns (ConversionEvent) {
option (google.api.http) = {
post: "/v1alpha/{parent=properties/*}/conversionEvents"
body: "conversion_event"
@@ -468,7 +487,8 @@ service AnalyticsAdminService {
}
// Deletes a conversion event in a property.
- rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (google.protobuf.Empty) {
+ rpc DeleteConversionEvent(DeleteConversionEventRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/conversionEvents/*}"
};
@@ -478,7 +498,8 @@ service AnalyticsAdminService {
// Returns a list of conversion events in the specified parent property.
//
// Returns an empty list if no conversion events are found.
- rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse) {
+ rpc ListConversionEvents(ListConversionEventsRequest)
+ returns (ListConversionEventsResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/conversionEvents"
};
@@ -486,7 +507,8 @@ service AnalyticsAdminService {
}
// Look up a single DisplayVideo360AdvertiserLink
- rpc GetDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest) returns (DisplayVideo360AdvertiserLink) {
+ rpc GetDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest)
+ returns (DisplayVideo360AdvertiserLink) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinks/*}"
};
@@ -494,7 +516,9 @@ service AnalyticsAdminService {
}
// Lists all DisplayVideo360AdvertiserLinks on a property.
- rpc ListDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest) returns (ListDisplayVideo360AdvertiserLinksResponse) {
+ rpc ListDisplayVideo360AdvertiserLinks(
+ ListDisplayVideo360AdvertiserLinksRequest)
+ returns (ListDisplayVideo360AdvertiserLinksResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinks"
};
@@ -506,16 +530,21 @@ service AnalyticsAdminService {
// the Google Analytics property and on the Display & Video 360 advertiser.
// Users who do not have access to the Display & Video 360 advertiser should
// instead seek to create a DisplayVideo360LinkProposal.
- rpc CreateDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest) returns (DisplayVideo360AdvertiserLink) {
+ rpc CreateDisplayVideo360AdvertiserLink(
+ CreateDisplayVideo360AdvertiserLinkRequest)
+ returns (DisplayVideo360AdvertiserLink) {
option (google.api.http) = {
post: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinks"
body: "display_video_360_advertiser_link"
};
- option (google.api.method_signature) = "parent,display_video_360_advertiser_link";
+ option (google.api.method_signature) =
+ "parent,display_video_360_advertiser_link";
}
// Deletes a DisplayVideo360AdvertiserLink on a property.
- rpc DeleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest) returns (google.protobuf.Empty) {
+ rpc DeleteDisplayVideo360AdvertiserLink(
+ DeleteDisplayVideo360AdvertiserLinkRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinks/*}"
};
@@ -523,16 +552,21 @@ service AnalyticsAdminService {
}
// Updates a DisplayVideo360AdvertiserLink on a property.
- rpc UpdateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest) returns (DisplayVideo360AdvertiserLink) {
+ rpc UpdateDisplayVideo360AdvertiserLink(
+ UpdateDisplayVideo360AdvertiserLinkRequest)
+ returns (DisplayVideo360AdvertiserLink) {
option (google.api.http) = {
patch: "/v1alpha/{display_video_360_advertiser_link.name=properties/*/displayVideo360AdvertiserLinks/*}"
body: "display_video_360_advertiser_link"
};
- option (google.api.method_signature) = "display_video_360_advertiser_link,update_mask";
+ option (google.api.method_signature) =
+ "display_video_360_advertiser_link,update_mask";
}
// Lookup for a single DisplayVideo360AdvertiserLinkProposal.
- rpc GetDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal) {
+ rpc GetDisplayVideo360AdvertiserLinkProposal(
+ GetDisplayVideo360AdvertiserLinkProposalRequest)
+ returns (DisplayVideo360AdvertiserLinkProposal) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}"
};
@@ -540,7 +574,9 @@ service AnalyticsAdminService {
}
// Lists DisplayVideo360AdvertiserLinkProposals on a property.
- rpc ListDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest) returns (ListDisplayVideo360AdvertiserLinkProposalsResponse) {
+ rpc ListDisplayVideo360AdvertiserLinkProposals(
+ ListDisplayVideo360AdvertiserLinkProposalsRequest)
+ returns (ListDisplayVideo360AdvertiserLinkProposalsResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals"
};
@@ -548,17 +584,22 @@ service AnalyticsAdminService {
}
// Creates a DisplayVideo360AdvertiserLinkProposal.
- rpc CreateDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal) {
+ rpc CreateDisplayVideo360AdvertiserLinkProposal(
+ CreateDisplayVideo360AdvertiserLinkProposalRequest)
+ returns (DisplayVideo360AdvertiserLinkProposal) {
option (google.api.http) = {
post: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals"
body: "display_video_360_advertiser_link_proposal"
};
- option (google.api.method_signature) = "parent,display_video_360_advertiser_link_proposal";
+ option (google.api.method_signature) =
+ "parent,display_video_360_advertiser_link_proposal";
}
// Deletes a DisplayVideo360AdvertiserLinkProposal on a property.
// This can only be used on cancelled proposals.
- rpc DeleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest) returns (google.protobuf.Empty) {
+ rpc DeleteDisplayVideo360AdvertiserLinkProposal(
+ DeleteDisplayVideo360AdvertiserLinkProposalRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}"
};
@@ -568,7 +609,9 @@ service AnalyticsAdminService {
// Approves a DisplayVideo360AdvertiserLinkProposal.
// The DisplayVideo360AdvertiserLinkProposal will be deleted and a new
// DisplayVideo360AdvertiserLink will be created.
- rpc ApproveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest) returns (ApproveDisplayVideo360AdvertiserLinkProposalResponse) {
+ rpc ApproveDisplayVideo360AdvertiserLinkProposal(
+ ApproveDisplayVideo360AdvertiserLinkProposalRequest)
+ returns (ApproveDisplayVideo360AdvertiserLinkProposalResponse) {
option (google.api.http) = {
post: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:approve"
body: "*"
@@ -580,7 +623,9 @@ service AnalyticsAdminService {
// - Declining a proposal initiated from Display & Video 360
// - Withdrawing a proposal initiated from Google Analytics
// After being cancelled, a proposal will eventually be deleted automatically.
- rpc CancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal) {
+ rpc CancelDisplayVideo360AdvertiserLinkProposal(
+ CancelDisplayVideo360AdvertiserLinkProposalRequest)
+ returns (DisplayVideo360AdvertiserLinkProposal) {
option (google.api.http) = {
post: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:cancel"
body: "*"
@@ -588,7 +633,8 @@ service AnalyticsAdminService {
}
// Creates a CustomDimension.
- rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension) {
+ rpc CreateCustomDimension(CreateCustomDimensionRequest)
+ returns (CustomDimension) {
option (google.api.http) = {
post: "/v1alpha/{parent=properties/*}/customDimensions"
body: "custom_dimension"
@@ -597,7 +643,8 @@ service AnalyticsAdminService {
}
// Updates a CustomDimension on a property.
- rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension) {
+ rpc UpdateCustomDimension(UpdateCustomDimensionRequest)
+ returns (CustomDimension) {
option (google.api.http) = {
patch: "/v1alpha/{custom_dimension.name=properties/*/customDimensions/*}"
body: "custom_dimension"
@@ -606,7 +653,8 @@ service AnalyticsAdminService {
}
// Lists CustomDimensions on a property.
- rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse) {
+ rpc ListCustomDimensions(ListCustomDimensionsRequest)
+ returns (ListCustomDimensionsResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/customDimensions"
};
@@ -614,7 +662,8 @@ service AnalyticsAdminService {
}
// Archives a CustomDimension on a property.
- rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (google.protobuf.Empty) {
+ rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1alpha/{name=properties/*/customDimensions/*}:archive"
body: "*"
@@ -649,7 +698,8 @@ service AnalyticsAdminService {
}
// Lists CustomMetrics on a property.
- rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse) {
+ rpc ListCustomMetrics(ListCustomMetricsRequest)
+ returns (ListCustomMetricsResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/customMetrics"
};
@@ -657,7 +707,8 @@ service AnalyticsAdminService {
}
// Archives a CustomMetric on a property.
- rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (google.protobuf.Empty) {
+ rpc ArchiveCustomMetric(ArchiveCustomMetricRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1alpha/{name=properties/*/customMetrics/*}:archive"
body: "*"
@@ -674,7 +725,8 @@ service AnalyticsAdminService {
}
// Returns the singleton data retention settings for this property.
- rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings) {
+ rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest)
+ returns (DataRetentionSettings) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/dataRetentionSettings}"
};
@@ -682,12 +734,14 @@ service AnalyticsAdminService {
}
// Updates the singleton data retention settings for this property.
- rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings) {
+ rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest)
+ returns (DataRetentionSettings) {
option (google.api.http) = {
patch: "/v1alpha/{data_retention_settings.name=properties/*/dataRetentionSettings}"
body: "data_retention_settings"
};
- option (google.api.method_signature) = "data_retention_settings,update_mask";
+ option (google.api.method_signature) =
+ "data_retention_settings,update_mask";
}
// Creates a DataStream.
@@ -700,7 +754,8 @@ service AnalyticsAdminService {
}
// Deletes a DataStream on a property.
- rpc DeleteDataStream(DeleteDataStreamRequest) returns (google.protobuf.Empty) {
+ rpc DeleteDataStream(DeleteDataStreamRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/dataStreams/*}"
};
@@ -717,7 +772,8 @@ service AnalyticsAdminService {
}
// Lists DataStreams on a property.
- rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse) {
+ rpc ListDataStreams(ListDataStreamsRequest)
+ returns (ListDataStreamsResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/dataStreams"
};
@@ -734,6 +790,7 @@ service AnalyticsAdminService {
// Lookup for a single Audience.
// Audiences created before 2020 may not be supported.
+ // Default audiences will not show filter definitions.
rpc GetAudience(GetAudienceRequest) returns (Audience) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/audiences/*}"
@@ -743,6 +800,7 @@ service AnalyticsAdminService {
// Lists Audiences on a property.
// Audiences created before 2020 may not be supported.
+ // Default audiences will not show filter definitions.
rpc ListAudiences(ListAudiencesRequest) returns (ListAudiencesResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/audiences"
@@ -776,8 +834,56 @@ service AnalyticsAdminService {
};
}
+ // Look up a single SearchAds360Link
+ rpc GetSearchAds360Link(GetSearchAds360LinkRequest)
+ returns (SearchAds360Link) {
+ option (google.api.http) = {
+ get: "/v1alpha/{name=properties/*/searchAds360Links/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Lists all SearchAds360Links on a property.
+ rpc ListSearchAds360Links(ListSearchAds360LinksRequest)
+ returns (ListSearchAds360LinksResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha/{parent=properties/*}/searchAds360Links"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Creates a SearchAds360Link.
+ rpc CreateSearchAds360Link(CreateSearchAds360LinkRequest)
+ returns (SearchAds360Link) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=properties/*}/searchAds360Links"
+ body: "search_ads_360_link"
+ };
+ option (google.api.method_signature) = "parent,search_ads_360_link";
+ }
+
+ // Deletes a SearchAds360Link on a property.
+ rpc DeleteSearchAds360Link(DeleteSearchAds360LinkRequest)
+ returns (google.protobuf.Empty) {
+ option (google.api.http) = {
+ delete: "/v1alpha/{name=properties/*/searchAds360Links/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Updates a SearchAds360Link on a property.
+ rpc UpdateSearchAds360Link(UpdateSearchAds360LinkRequest)
+ returns (SearchAds360Link) {
+ option (google.api.http) = {
+ patch: "/v1alpha/{search_ads_360_link.name=properties/*/searchAds360Links/*}"
+ body: "search_ads_360_link"
+ };
+ option (google.api.method_signature) = "search_ads_360_link,update_mask";
+ }
+
// Lookup for a AttributionSettings singleton.
- rpc GetAttributionSettings(GetAttributionSettingsRequest) returns (AttributionSettings) {
+ rpc GetAttributionSettings(GetAttributionSettingsRequest)
+ returns (AttributionSettings) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/attributionSettings}"
};
@@ -785,7 +891,8 @@ service AnalyticsAdminService {
}
// Updates attribution settings on a property.
- rpc UpdateAttributionSettings(UpdateAttributionSettingsRequest) returns (AttributionSettings) {
+ rpc UpdateAttributionSettings(UpdateAttributionSettingsRequest)
+ returns (AttributionSettings) {
option (google.api.http) = {
patch: "/v1alpha/{attribution_settings.name=properties/*/attributionSettings}"
body: "attribution_settings"
@@ -806,12 +913,216 @@ service AnalyticsAdminService {
// property configuration changes like adding a stream or changing a
// property's time zone. For configuration change history, see
// [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
- rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse) {
+ rpc RunAccessReport(RunAccessReportRequest)
+ returns (RunAccessReportResponse) {
option (google.api.http) = {
post: "/v1alpha/{entity=properties/*}:runAccessReport"
body: "*"
};
}
+
+ // Creates an access binding on an account or property.
+ rpc CreateAccessBinding(CreateAccessBindingRequest) returns (AccessBinding) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=accounts/*}/accessBindings"
+ body: "access_binding"
+ additional_bindings {
+ post: "/v1alpha/{parent=properties/*}/accessBindings"
+ body: "access_binding"
+ }
+ };
+ option (google.api.method_signature) = "parent,access_binding";
+ }
+
+ // Gets information about an access binding.
+ rpc GetAccessBinding(GetAccessBindingRequest) returns (AccessBinding) {
+ option (google.api.http) = {
+ get: "/v1alpha/{name=accounts/*/accessBindings/*}"
+ additional_bindings {
+ get: "/v1alpha/{name=properties/*/accessBindings/*}"
+ }
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Updates an access binding on an account or property.
+ rpc UpdateAccessBinding(UpdateAccessBindingRequest) returns (AccessBinding) {
+ option (google.api.http) = {
+ patch: "/v1alpha/{access_binding.name=accounts/*/accessBindings/*}"
+ body: "access_binding"
+ additional_bindings {
+ patch: "/v1alpha/{access_binding.name=properties/*/accessBindings/*}"
+ body: "access_binding"
+ }
+ };
+ option (google.api.method_signature) = "access_binding";
+ }
+
+ // Deletes an access binding on an account or property.
+ rpc DeleteAccessBinding(DeleteAccessBindingRequest)
+ returns (google.protobuf.Empty) {
+ option (google.api.http) = {
+ delete: "/v1alpha/{name=accounts/*/accessBindings/*}"
+ additional_bindings {
+ delete: "/v1alpha/{name=properties/*/accessBindings/*}"
+ }
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Lists all access bindings on an account or property.
+ rpc ListAccessBindings(ListAccessBindingsRequest)
+ returns (ListAccessBindingsResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha/{parent=accounts/*}/accessBindings"
+ additional_bindings {
+ get: "/v1alpha/{parent=properties/*}/accessBindings"
+ }
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Creates information about multiple access bindings to an account or
+ // property.
+ //
+ // This method is transactional. If any AccessBinding cannot be created, none
+ // of the AccessBindings will be created.
+ rpc BatchCreateAccessBindings(BatchCreateAccessBindingsRequest)
+ returns (BatchCreateAccessBindingsResponse) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=accounts/*}/accessBindings:batchCreate"
+ body: "*"
+ additional_bindings {
+ post: "/v1alpha/{parent=properties/*}/accessBindings:batchCreate"
+ body: "*"
+ }
+ };
+ }
+
+ // Gets information about multiple access bindings to an account or property.
+ rpc BatchGetAccessBindings(BatchGetAccessBindingsRequest)
+ returns (BatchGetAccessBindingsResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha/{parent=accounts/*}/accessBindings:batchGet"
+ additional_bindings {
+ get: "/v1alpha/{parent=properties/*}/accessBindings:batchGet"
+ }
+ };
+ }
+
+ // Updates information about multiple access bindings to an account or
+ // property.
+ rpc BatchUpdateAccessBindings(BatchUpdateAccessBindingsRequest)
+ returns (BatchUpdateAccessBindingsResponse) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=accounts/*}/accessBindings:batchUpdate"
+ body: "*"
+ additional_bindings {
+ post: "/v1alpha/{parent=properties/*}/accessBindings:batchUpdate"
+ body: "*"
+ }
+ };
+ }
+
+ // Deletes information about multiple users' links to an account or property.
+ rpc BatchDeleteAccessBindings(BatchDeleteAccessBindingsRequest)
+ returns (google.protobuf.Empty) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=accounts/*}/accessBindings:batchDelete"
+ body: "*"
+ additional_bindings {
+ post: "/v1alpha/{parent=properties/*}/accessBindings:batchDelete"
+ body: "*"
+ }
+ };
+ }
+
+ // Lookup for a single ExpandedDataSet.
+ rpc GetExpandedDataSet(GetExpandedDataSetRequest) returns (ExpandedDataSet) {
+ option (google.api.http) = {
+ get: "/v1alpha/{name=properties/*/expandedDataSets/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Lists ExpandedDataSets on a property.
+ rpc ListExpandedDataSets(ListExpandedDataSetsRequest)
+ returns (ListExpandedDataSetsResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha/{parent=properties/*}/expandedDataSets"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Creates a ExpandedDataSet.
+ rpc CreateExpandedDataSet(CreateExpandedDataSetRequest)
+ returns (ExpandedDataSet) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=properties/*}/expandedDataSets"
+ body: "expanded_data_set"
+ };
+ option (google.api.method_signature) = "parent,expanded_data_set";
+ }
+
+ // Updates a ExpandedDataSet on a property.
+ rpc UpdateExpandedDataSet(UpdateExpandedDataSetRequest)
+ returns (ExpandedDataSet) {
+ option (google.api.http) = {
+ patch: "/v1alpha/{expanded_data_set.name=properties/*/expandedDataSets/*}"
+ body: "expanded_data_set"
+ };
+ option (google.api.method_signature) = "expanded_data_set,update_mask";
+ }
+
+ // Deletes a ExpandedDataSet on a property.
+ rpc DeleteExpandedDataSet(DeleteExpandedDataSetRequest)
+ returns (google.protobuf.Empty) {
+ option (google.api.http) = {
+ delete: "/v1alpha/{name=properties/*/expandedDataSets/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Sets the opt out status for the automated GA4 setup process for a UA
+ // property.
+ // Note: this has no effect on GA4 property.
+ rpc SetAutomatedGa4ConfigurationOptOut(
+ SetAutomatedGa4ConfigurationOptOutRequest)
+ returns (SetAutomatedGa4ConfigurationOptOutResponse) {
+ option (google.api.http) = {
+ post: "/v1alpha/properties:setAutomatedGa4ConfigurationOptOut"
+ body: "*"
+ };
+ }
+
+ // Fetches the opt out status for the automated GA4 setup process for a UA
+ // property.
+ // Note: this has no effect on GA4 property.
+ rpc FetchAutomatedGa4ConfigurationOptOut(
+ FetchAutomatedGa4ConfigurationOptOutRequest)
+ returns (FetchAutomatedGa4ConfigurationOptOutResponse) {
+ option (google.api.http) = {
+ post: "/v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut"
+ body: "*"
+ };
+ }
+
+ // Lookup for a single BigQuery Link.
+ rpc GetBigQueryLink(GetBigQueryLinkRequest) returns (BigQueryLink) {
+ option (google.api.http) = {
+ get: "/v1alpha/{name=properties/*/bigQueryLinks/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Lists BigQuery Links on a property.
+ rpc ListBigQueryLinks(ListBigQueryLinksRequest)
+ returns (ListBigQueryLinksResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha/{parent=properties/*}/bigQueryLinks"
+ };
+ option (google.api.method_signature) = "parent";
+ }
}
// The request for a Data Access Record Report.
@@ -836,7 +1147,7 @@ message RunAccessReportRequest {
// to 2 date ranges.
repeated AccessDateRange date_ranges = 4;
- // Dimension filters allow you to restrict report response to specific
+ // Dimension filters let you restrict report response to specific
// dimension values which match the filter. For example, filtering on access
// records of a single user. To learn more, see [Fundamentals of Dimension
// Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
@@ -979,10 +1290,12 @@ message UpdateAccountRequest {
// The account's `name` field is used to identify the account.
Account account = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of fields to be updated. Field names must be in snake case
- // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
- // the entire entity, use one path with the string "*" to match all fields.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of fields to be updated. Field names must be in snake
+ // case (for example, "field_to_update"). Omitted fields will not be updated.
+ // To replace the entire entity, use one path with the string "*" to match all
+ // fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for ProvisionAccountTicket RPC.
@@ -991,7 +1304,7 @@ message ProvisionAccountTicketRequest {
Account account = 1;
// Redirect URI where the user will be sent after accepting Terms of Service.
- // Must be configured in Developers Console as a Redirect URI
+ // Must be configured in Developers Console as a Redirect URI.
string redirect_uri = 2;
}
@@ -1069,10 +1382,12 @@ message UpdatePropertyRequest {
// updated.
Property property = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of fields to be updated. Field names must be in snake case
- // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
- // the entire entity, use one path with the string "*" to match all fields.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of fields to be updated. Field names must be in snake
+ // case (e.g., "field_to_update"). Omitted fields will not be updated. To
+ // replace the entire entity, use one path with the string "*" to match all
+ // fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for CreateProperty RPC.
@@ -1220,8 +1535,8 @@ message CreateUserLinkRequest {
}
];
- // Optional. If set, then email the new user notifying them that they've been granted
- // permissions to the resource.
+ // Optional. If set, then email the new user notifying them that they've been
+ // granted permissions to the resource.
bool notify_new_user = 2 [(google.api.field_behavior) = OPTIONAL];
// Required. The user link to create.
@@ -1230,8 +1545,8 @@ message CreateUserLinkRequest {
// Request message for BatchCreateUserLinks RPC.
message BatchCreateUserLinksRequest {
- // Required. The account or property that all user links in the request are for.
- // This field is required. The parent field in the CreateUserLinkRequest
+ // Required. The account or property that all user links in the request are
+ // for. This field is required. The parent field in the CreateUserLinkRequest
// messages must either be empty or match this field.
// Example format: accounts/1234
string parent = 1 [
@@ -1241,14 +1556,15 @@ message BatchCreateUserLinksRequest {
}
];
- // Optional. If set, then email the new users notifying them that they've been granted
- // permissions to the resource. Regardless of whether this is set or not,
- // notify_new_user field inside each individual request is ignored.
+ // Optional. If set, then email the new users notifying them that they've been
+ // granted permissions to the resource. Regardless of whether this is set or
+ // not, notify_new_user field inside each individual request is ignored.
bool notify_new_users = 2 [(google.api.field_behavior) = OPTIONAL];
// Required. The requests specifying the user links to create.
// A maximum of 1000 user links can be created in a batch.
- repeated CreateUserLinkRequest requests = 3 [(google.api.field_behavior) = REQUIRED];
+ repeated CreateUserLinkRequest requests = 3
+ [(google.api.field_behavior) = REQUIRED];
}
// Response message for BatchCreateUserLinks RPC.
@@ -1278,7 +1594,8 @@ message BatchUpdateUserLinksRequest {
// Required. The requests specifying the user links to update.
// A maximum of 1000 user links can be updated in a batch.
- repeated UpdateUserLinkRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated UpdateUserLinkRequest requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Response message for BatchUpdateUserLinks RPC.
@@ -1313,7 +1630,8 @@ message BatchDeleteUserLinksRequest {
// Required. The requests specifying the user links to update.
// A maximum of 1000 user links can be updated in a batch.
- repeated DeleteUserLinkRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated DeleteUserLinkRequest requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for CreateFirebaseLink RPC
@@ -1362,7 +1680,7 @@ message ListFirebaseLinksRequest {
// A page token, received from a previous `ListFirebaseLinks` call.
// Provide this to retrieve the subsequent page.
- // When paginating, all other parameters provided to `ListProperties` must
+ // When paginating, all other parameters provided to `ListFirebaseLinks` must
// match the call that provided the page token.
string page_token = 3;
}
@@ -1412,10 +1730,12 @@ message UpdateGoogleAdsLinkRequest {
// The GoogleAdsLink to update
GoogleAdsLink google_ads_link = 1;
- // Required. The list of fields to be updated. Field names must be in snake case
- // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
- // the entire entity, use one path with the string "*" to match all fields.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of fields to be updated. Field names must be in snake
+ // case (e.g., "field_to_update"). Omitted fields will not be updated. To
+ // replace the entire entity, use one path with the string "*" to match all
+ // fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for DeleteGoogleAdsLink RPC.
@@ -1510,8 +1830,8 @@ message AcknowledgeUserDataCollectionRequest {
}
];
- // Required. An acknowledgement that the caller of this method understands the terms
- // of user data collection.
+ // Required. An acknowledgement that the caller of this method understands the
+ // terms of user data collection.
//
// This field must contain the exact value:
// "I acknowledge that I have the necessary privacy disclosures and rights
@@ -1522,13 +1842,12 @@ message AcknowledgeUserDataCollectionRequest {
}
// Response message for AcknowledgeUserDataCollection RPC.
-message AcknowledgeUserDataCollectionResponse {
-
-}
+message AcknowledgeUserDataCollectionResponse {}
// Request message for SearchChangeHistoryEvents RPC.
message SearchChangeHistoryEventsRequest {
- // Required. The account resource for which to return change history resources.
+ // Required. The account resource for which to return change history
+ // resources.
string account = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -1545,22 +1864,26 @@ message SearchChangeHistoryEventsRequest {
}
];
- // Optional. If set, only return changes if they are for a resource that matches at
- // least one of these types.
- repeated ChangeHistoryResourceType resource_type = 3 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. If set, only return changes if they are for a resource that
+ // matches at least one of these types.
+ repeated ChangeHistoryResourceType resource_type = 3
+ [(google.api.field_behavior) = OPTIONAL];
- // Optional. If set, only return changes that match one or more of these types of
- // actions.
+ // Optional. If set, only return changes that match one or more of these types
+ // of actions.
repeated ActionType action = 4 [(google.api.field_behavior) = OPTIONAL];
- // Optional. If set, only return changes if they are made by a user in this list.
+ // Optional. If set, only return changes if they are made by a user in this
+ // list.
repeated string actor_email = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional. If set, only return changes made after this time (inclusive).
- google.protobuf.Timestamp earliest_change_time = 6 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.Timestamp earliest_change_time = 6
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. If set, only return changes made before this time (inclusive).
- google.protobuf.Timestamp latest_change_time = 7 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.Timestamp latest_change_time = 7
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. The maximum number of ChangeHistoryEvent items to return.
// The service may return fewer than this value, even if there are additional
@@ -1568,10 +1891,11 @@ message SearchChangeHistoryEventsRequest {
// The maximum value is 200 (higher values will be coerced to the maximum).
int32 page_size = 8 [(google.api.field_behavior) = OPTIONAL];
- // Optional. A page token, received from a previous `SearchChangeHistoryEvents` call.
- // Provide this to retrieve the subsequent page. When paginating, all other
- // parameters provided to `SearchChangeHistoryEvents` must match the call that
- // provided the page token.
+ // Optional. A page token, received from a previous
+ // `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent
+ // page. When paginating, all other parameters provided to
+ // `SearchChangeHistoryEvents` must match the call that provided the page
+ // token.
string page_token = 9 [(google.api.field_behavior) = OPTIONAL];
}
@@ -1610,7 +1934,8 @@ message CreateMeasurementProtocolSecretRequest {
];
// Required. The measurement protocol secret to create.
- MeasurementProtocolSecret measurement_protocol_secret = 2 [(google.api.field_behavior) = REQUIRED];
+ MeasurementProtocolSecret measurement_protocol_secret = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for DeleteMeasurementProtocolSecret RPC
@@ -1629,7 +1954,8 @@ message DeleteMeasurementProtocolSecretRequest {
// Request message for UpdateMeasurementProtocolSecret RPC
message UpdateMeasurementProtocolSecretRequest {
// Required. The measurement protocol secret to update.
- MeasurementProtocolSecret measurement_protocol_secret = 1 [(google.api.field_behavior) = REQUIRED];
+ MeasurementProtocolSecret measurement_protocol_secret = 1
+ [(google.api.field_behavior) = REQUIRED];
// The list of fields to be updated. Omitted fields will not be updated.
google.protobuf.FieldMask update_mask = 2;
@@ -1685,12 +2011,15 @@ message GetGoogleSignalsSettingsRequest {
message UpdateGoogleSignalsSettingsRequest {
// Required. The settings to update.
// The `name` field is used to identify the settings to be updated.
- GoogleSignalsSettings google_signals_settings = 1 [(google.api.field_behavior) = REQUIRED];
+ GoogleSignalsSettings google_signals_settings = 1
+ [(google.api.field_behavior) = REQUIRED];
- // Required. The list of fields to be updated. Field names must be in snake case
- // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
- // the entire entity, use one path with the string "*" to match all fields.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of fields to be updated. Field names must be in snake
+ // case (e.g., "field_to_update"). Omitted fields will not be updated. To
+ // replace the entire entity, use one path with the string "*" to match all
+ // fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for CreateConversionEvent RPC
@@ -1698,8 +2027,8 @@ message CreateConversionEventRequest {
// Required. The conversion event to create.
ConversionEvent conversion_event = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The resource name of the parent property where this conversion event will
- // be created. Format: properties/123
+ // Required. The resource name of the parent property where this conversion
+ // event will be created. Format: properties/123
string parent = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -1824,7 +2153,8 @@ message CreateDisplayVideo360AdvertiserLinkRequest {
];
// Required. The DisplayVideo360AdvertiserLink to create.
- DisplayVideo360AdvertiserLink display_video_360_advertiser_link = 2 [(google.api.field_behavior) = REQUIRED];
+ DisplayVideo360AdvertiserLink display_video_360_advertiser_link = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for DeleteDisplayVideo360AdvertiserLink RPC.
@@ -1844,10 +2174,11 @@ message UpdateDisplayVideo360AdvertiserLinkRequest {
// The DisplayVideo360AdvertiserLink to update
DisplayVideo360AdvertiserLink display_video_360_advertiser_link = 1;
- // Required. The list of fields to be updated. Omitted fields will not be updated.
- // To replace the entire entity, use one path with the string "*" to match
- // all fields.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of fields to be updated. Omitted fields will not be
+ // updated. To replace the entire entity, use one path with the string "*" to
+ // match all fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for GetDisplayVideo360AdvertiserLinkProposal RPC.
@@ -1890,7 +2221,8 @@ message ListDisplayVideo360AdvertiserLinkProposalsRequest {
// Response message for ListDisplayVideo360AdvertiserLinkProposals RPC.
message ListDisplayVideo360AdvertiserLinkProposalsResponse {
// List of DisplayVideo360AdvertiserLinkProposals.
- repeated DisplayVideo360AdvertiserLinkProposal display_video_360_advertiser_link_proposals = 1;
+ repeated DisplayVideo360AdvertiserLinkProposal
+ display_video_360_advertiser_link_proposals = 1;
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
@@ -1908,7 +2240,9 @@ message CreateDisplayVideo360AdvertiserLinkProposalRequest {
];
// Required. The DisplayVideo360AdvertiserLinkProposal to create.
- DisplayVideo360AdvertiserLinkProposal display_video_360_advertiser_link_proposal = 2 [(google.api.field_behavior) = REQUIRED];
+ DisplayVideo360AdvertiserLinkProposal
+ display_video_360_advertiser_link_proposal = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for DeleteDisplayVideo360AdvertiserLinkProposal RPC.
@@ -1954,6 +2288,91 @@ message CancelDisplayVideo360AdvertiserLinkProposalRequest {
];
}
+// Request message for GetSearchAds360Link RPC.
+message GetSearchAds360LinkRequest {
+ // Required. The name of the SearchAds360Link to get.
+ // Example format: properties/1234/SearchAds360Link/5678
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "analyticsadmin.googleapis.com/SearchAds360Link"
+ }
+ ];
+}
+
+// Request message for ListSearchAds360Links RPC.
+message ListSearchAds360LinksRequest {
+ // Required. Example format: properties/1234
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "analyticsadmin.googleapis.com/SearchAds360Link"
+ }
+ ];
+
+ // The maximum number of resources to return.
+ // If unspecified, at most 50 resources will be returned.
+ // The maximum value is 200 (higher values will be coerced to the maximum).
+ int32 page_size = 2;
+
+ // A page token, received from a previous `ListSearchAds360Links`
+ // call. Provide this to retrieve the subsequent page.
+ //
+ // When paginating, all other parameters provided to
+ // `ListSearchAds360Links` must match the call that provided the
+ // page token.
+ string page_token = 3;
+}
+
+// Response message for ListSearchAds360Links RPC.
+message ListSearchAds360LinksResponse {
+ // List of SearchAds360Links.
+ repeated SearchAds360Link search_ads_360_links = 1;
+
+ // A token, which can be sent as `page_token` to retrieve the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
+}
+
+// Request message for CreateSearchAds360Link RPC.
+message CreateSearchAds360LinkRequest {
+ // Required. Example format: properties/1234
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "analyticsadmin.googleapis.com/SearchAds360Link"
+ }
+ ];
+
+ // Required. The SearchAds360Link to create.
+ SearchAds360Link search_ads_360_link = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for DeleteSearchAds360Link RPC.
+message DeleteSearchAds360LinkRequest {
+ // Required. The name of the SearchAds360Link to delete.
+ // Example format: properties/1234/SearchAds360Links/5678
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "analyticsadmin.googleapis.com/SearchAds360Link"
+ }
+ ];
+}
+
+// Request message for UpdateSearchAds360Link RPC.
+message UpdateSearchAds360LinkRequest {
+ // The SearchAds360Link to update
+ SearchAds360Link search_ads_360_link = 1;
+
+ // Required. The list of fields to be updated. Omitted fields will not be
+ // updated. To replace the entire entity, use one path with the string "*" to
+ // match all fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
// Request message for CreateCustomDimension RPC.
message CreateCustomDimensionRequest {
// Required. Example format: properties/1234
@@ -1973,10 +2392,11 @@ message UpdateCustomDimensionRequest {
// The CustomDimension to update
CustomDimension custom_dimension = 1;
- // Required. The list of fields to be updated. Omitted fields will not be updated.
- // To replace the entire entity, use one path with the string "*" to match
- // all fields.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of fields to be updated. Omitted fields will not be
+ // updated. To replace the entire entity, use one path with the string "*" to
+ // match all fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for ListCustomDimensions RPC.
@@ -2055,10 +2475,11 @@ message UpdateCustomMetricRequest {
// The CustomMetric to update
CustomMetric custom_metric = 1;
- // Required. The list of fields to be updated. Omitted fields will not be updated.
- // To replace the entire entity, use one path with the string "*" to match
- // all fields.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of fields to be updated. Omitted fields will not be
+ // updated. To replace the entire entity, use one path with the string "*" to
+ // match all fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for ListCustomMetrics RPC.
@@ -2136,12 +2557,15 @@ message GetDataRetentionSettingsRequest {
message UpdateDataRetentionSettingsRequest {
// Required. The settings to update.
// The `name` field is used to identify the settings to be updated.
- DataRetentionSettings data_retention_settings = 1 [(google.api.field_behavior) = REQUIRED];
+ DataRetentionSettings data_retention_settings = 1
+ [(google.api.field_behavior) = REQUIRED];
- // Required. The list of fields to be updated. Field names must be in snake case
- // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
- // the entire entity, use one path with the string "*" to match all fields.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of fields to be updated. Field names must be in snake
+ // case (e.g., "field_to_update"). Omitted fields will not be updated. To
+ // replace the entire entity, use one path with the string "*" to match all
+ // fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for CreateDataStream RPC.
@@ -2175,10 +2599,11 @@ message UpdateDataStreamRequest {
// The DataStream to update
DataStream data_stream = 1;
- // Required. The list of fields to be updated. Omitted fields will not be updated.
- // To replace the entire entity, use one path with the string "*" to match
- // all fields.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of fields to be updated. Omitted fields will not be
+ // updated. To replace the entire entity, use one path with the string "*" to
+ // match all fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for ListDataStreams RPC.
@@ -2291,10 +2716,12 @@ message UpdateAudienceRequest {
// The audience's `name` field is used to identify the audience to be updated.
Audience audience = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The list of fields to be updated. Field names must be in snake case
- // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
- // the entire entity, use one path with the string "*" to match all fields.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of fields to be updated. Field names must be in snake
+ // case (e.g., "field_to_update"). Omitted fields will not be updated. To
+ // replace the entire entity, use one path with the string "*" to match all
+ // fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for ArchiveAudience RPC.
@@ -2324,10 +2751,371 @@ message GetAttributionSettingsRequest {
message UpdateAttributionSettingsRequest {
// Required. The attribution settings to update.
// The `name` field is used to identify the settings to be updated.
- AttributionSettings attribution_settings = 1 [(google.api.field_behavior) = REQUIRED];
+ AttributionSettings attribution_settings = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The list of fields to be updated. Field names must be in snake
+ // case (e.g., "field_to_update"). Omitted fields will not be updated. To
+ // replace the entire entity, use one path with the string "*" to match all
+ // fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for GetAccessBinding RPC.
+message GetAccessBindingRequest {
+ // Required. The name of the access binding to retrieve.
+ // Formats:
+ // - accounts/{account}/accessBindings/{accessBinding}
+ // - properties/{property}/accessBindings/{accessBinding}
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "analyticsadmin.googleapis.com/AccessBinding"
+ }
+ ];
+}
+
+// Request message for BatchGetAccessBindings RPC.
+message BatchGetAccessBindingsRequest {
+ // Required. The account or property that owns the access bindings. The parent
+ // of all provided values for the 'names' field must match this field.
+ // Formats:
+ // - accounts/{account}
+ // - properties/{property}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "analyticsadmin.googleapis.com/AccessBinding"
+ }
+ ];
+
+ // Required. The names of the access bindings to retrieve.
+ // A maximum of 1000 access bindings can be retrieved in a batch.
+ // Formats:
+ // - accounts/{account}/accessBindings/{accessBinding}
+ // - properties/{property}/accessBindings/{accessBinding}
+ repeated string names = 2 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "analyticsadmin.googleapis.com/AccessBinding"
+ }
+ ];
+}
+
+// Response message for BatchGetAccessBindings RPC.
+message BatchGetAccessBindingsResponse {
+ // The requested access bindings.
+ repeated AccessBinding access_bindings = 1;
+}
+
+// Request message for ListAccessBindings RPC.
+message ListAccessBindingsRequest {
+ // Required. Formats:
+ // - accounts/{account}
+ // - properties/{property}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "analyticsadmin.googleapis.com/AccessBinding"
+ }
+ ];
+
+ // The maximum number of access bindings to return.
+ // The service may return fewer than this value.
+ // If unspecified, at most 200 access bindings will be returned.
+ // The maximum value is 500; values above 500 will be coerced to 500.
+ int32 page_size = 2;
+
+ // A page token, received from a previous `ListAccessBindings` call.
+ // Provide this to retrieve the subsequent page.
+ // When paginating, all other parameters provided to `ListAccessBindings` must
+ // match the call that provided the page token.
+ string page_token = 3;
+}
+
+// Response message for ListAccessBindings RPC.
+message ListAccessBindingsResponse {
+ // List of AccessBindings. These will be ordered stably, but in an arbitrary
+ // order.
+ repeated AccessBinding access_bindings = 1;
+
+ // A token, which can be sent as `page_token` to retrieve the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
+}
+
+// Request message for CreateAccessBinding RPC.
+message CreateAccessBindingRequest {
+ // Required. Formats:
+ // - accounts/{account}
+ // - properties/{property}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "analyticsadmin.googleapis.com/AccessBinding"
+ }
+ ];
+
+ // Required. The access binding to create.
+ AccessBinding access_binding = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for BatchCreateAccessBindings RPC.
+message BatchCreateAccessBindingsRequest {
+ // Required. The account or property that owns the access bindings. The parent
+ // field in the CreateAccessBindingRequest messages must either be empty or
+ // match this field. Formats:
+ // - accounts/{account}
+ // - properties/{property}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "analyticsadmin.googleapis.com/AccessBinding"
+ }
+ ];
+
+ // Required. The requests specifying the access bindings to create.
+ // A maximum of 1000 access bindings can be created in a batch.
+ repeated CreateAccessBindingRequest requests = 3
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response message for BatchCreateAccessBindings RPC.
+message BatchCreateAccessBindingsResponse {
+ // The access bindings created.
+ repeated AccessBinding access_bindings = 1;
+}
+
+// Request message for UpdateAccessBinding RPC.
+message UpdateAccessBindingRequest {
+ // Required. The access binding to update.
+ AccessBinding access_binding = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for BatchUpdateAccessBindings RPC.
+message BatchUpdateAccessBindingsRequest {
+ // Required. The account or property that owns the access bindings. The parent
+ // field in the UpdateAccessBindingRequest messages must either be empty or
+ // match this field. Formats:
+ // - accounts/{account}
+ // - properties/{property}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "analyticsadmin.googleapis.com/AccessBinding"
+ }
+ ];
+
+ // Required. The requests specifying the access bindings to update.
+ // A maximum of 1000 access bindings can be updated in a batch.
+ repeated UpdateAccessBindingRequest requests = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response message for BatchUpdateAccessBindings RPC.
+message BatchUpdateAccessBindingsResponse {
+ // The access bindings updated.
+ repeated AccessBinding access_bindings = 1;
+}
+
+// Request message for DeleteAccessBinding RPC.
+message DeleteAccessBindingRequest {
+ // Required. Formats:
+ // - accounts/{account}/accessBindings/{accessBinding}
+ // - properties/{property}/accessBindings/{accessBinding}
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "analyticsadmin.googleapis.com/AccessBinding"
+ }
+ ];
+}
+
+// Request message for BatchDeleteAccessBindings RPC.
+message BatchDeleteAccessBindingsRequest {
+ // Required. The account or property that owns the access bindings. The parent
+ // field in the DeleteAccessBindingRequest messages must either be empty or
+ // match this field. Formats:
+ // - accounts/{account}
+ // - properties/{property}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "analyticsadmin.googleapis.com/AccessBinding"
+ }
+ ];
+
+ // Required. The requests specifying the access bindings to delete.
+ // A maximum of 1000 access bindings can be deleted in a batch.
+ repeated DeleteAccessBindingRequest requests = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for CreateExpandedDataSet RPC.
+message CreateExpandedDataSetRequest {
+ // Required. Example format: properties/1234
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "analyticsadmin.googleapis.com/ExpandedDataSet"
+ }
+ ];
+
+ // Required. The ExpandedDataSet to create.
+ ExpandedDataSet expanded_data_set = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for UpdateExpandedDataSet RPC.
+message UpdateExpandedDataSetRequest {
+ // Required. The ExpandedDataSet to update.
+ // The resource's `name` field is used to identify the ExpandedDataSet to be
+ // updated.
+ ExpandedDataSet expanded_data_set = 1
+ [(google.api.field_behavior) = REQUIRED];
- // Required. The list of fields to be updated. Field names must be in snake case
- // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
- // the entire entity, use one path with the string "*" to match all fields.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The list of fields to be updated. Field names must be in snake
+ // case (e.g., "field_to_update"). Omitted fields will not be updated. To
+ // replace the entire entity, use one path with the string "*" to match all
+ // fields.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for DeleteExpandedDataSet RPC.
+message DeleteExpandedDataSetRequest {
+ // Required. Example format: properties/1234/expandedDataSets/5678
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "analyticsadmin.googleapis.com/ExpandedDataSet"
+ }
+ ];
+}
+
+// Request message for GetExpandedDataSet RPC.
+message GetExpandedDataSetRequest {
+ // Required. The name of the Audience to get.
+ // Example format: properties/1234/expandedDataSets/5678
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "analyticsadmin.googleapis.com/ExpandedDataSet"
+ }
+ ];
+}
+
+// Request message for ListExpandedDataSets RPC.
+message ListExpandedDataSetsRequest {
+ // Required. Example format: properties/1234
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "analyticsadmin.googleapis.com/ExpandedDataSet"
+ }
+ ];
+
+ // The maximum number of resources to return.
+ // If unspecified, at most 50 resources will be returned.
+ // The maximum value is 200 (higher values will be coerced to the maximum).
+ int32 page_size = 2;
+
+ // A page token, received from a previous `ListExpandedDataSets` call. Provide
+ // this to retrieve the subsequent page.
+ //
+ // When paginating, all other parameters provided to `ListExpandedDataSet`
+ // must match the call that provided the page token.
+ string page_token = 3;
+}
+
+// Response message for ListExpandedDataSets RPC.
+message ListExpandedDataSetsResponse {
+ // List of ExpandedDataSet. These will be ordered stably, but in an arbitrary
+ // order.
+ repeated ExpandedDataSet expanded_data_sets = 1;
+
+ // A token, which can be sent as `page_token` to retrieve the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
+}
+
+// Request for setting the opt out status for the automated GA4 setup process.
+message SetAutomatedGa4ConfigurationOptOutRequest {
+ // Required. The UA property to set the opt out status. Note this request uses
+ // the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
+ // Format: properties/{internalWebPropertyId}
+ // Example: properties/1234
+ string property = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // The status to set.
+ bool opt_out = 2;
+}
+
+// Response message for setting the opt out status for the automated GA4 setup
+// process.
+message SetAutomatedGa4ConfigurationOptOutResponse {}
+
+// Request for fetching the opt out status for the automated GA4 setup process.
+message FetchAutomatedGa4ConfigurationOptOutRequest {
+ // Required. The UA property to get the opt out status. Note this request uses
+ // the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
+ // Format: properties/{internalWebPropertyId}
+ // Example: properties/1234
+ string property = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response message for fetching the opt out status for the automated GA4 setup
+// process.
+message FetchAutomatedGa4ConfigurationOptOutResponse {
+ // The opt out status for the UA property.
+ bool opt_out = 1;
+}
+
+// Request message for GetBigQueryLink RPC.
+message GetBigQueryLinkRequest {
+ // Required. The name of the BigQuery link to lookup.
+ // Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id}
+ // Example: properties/123/bigQueryLinks/456
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "analyticsadmin.googleapis.com/BigQueryLink"
+ }
+ ];
+}
+
+// Request message for ListBigQueryLinks RPC.
+message ListBigQueryLinksRequest {
+ // Required. The name of the property to list BigQuery links under.
+ // Format: properties/{property_id}
+ // Example: properties/1234
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "analyticsadmin.googleapis.com/BigQueryLink"
+ }
+ ];
+
+ // The maximum number of resources to return. The service may return
+ // fewer than this value, even if there are additional pages.
+ // If unspecified, at most 50 resources will be returned.
+ // The maximum value is 200; (higher values will be coerced to the maximum)
+ int32 page_size = 2;
+
+ // A page token, received from a previous `ListBigQueryLinks` call.
+ // Provide this to retrieve the subsequent page.
+ // When paginating, all other parameters provided to `ListBigQueryLinks` must
+ // match the call that provided the page token.
+ string page_token = 3;
+}
+
+// Response message for ListBigQueryLinks RPC
+message ListBigQueryLinksResponse {
+ // List of BigQueryLinks.
+ repeated BigQueryLink bigquery_links = 1;
+
+ // A token, which can be sent as `page_token` to retrieve the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
}
diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml b/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml
index e268411e9..1bebd3836 100644
--- a/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml
+++ b/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml
@@ -17,31 +17,66 @@ authentication:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.manage.users,
https://www.googleapis.com/auth/analytics.manage.users.readonly
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchCreateAccessBindings
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.manage.users
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchCreateUserLinks
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.manage.users
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchDeleteAccessBindings
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.manage.users
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchDeleteUserLinks
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.manage.users
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchGetAccessBindings
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.manage.users,
+ https://www.googleapis.com/auth/analytics.manage.users.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchGetUserLinks
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.manage.users,
https://www.googleapis.com/auth/analytics.manage.users.readonly
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchUpdateAccessBindings
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.manage.users
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchUpdateUserLinks
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.manage.users
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.CreateAccessBinding
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.manage.users
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.CreateUserLink
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.manage.users
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteAccessBinding
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.manage.users
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteUserLink
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.manage.users
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.FetchAutomatedGa4ConfigurationOptOut
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.edit,
+ https://www.googleapis.com/auth/analytics.readonly
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetAccessBinding
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.manage.users,
+ https://www.googleapis.com/auth/analytics.manage.users.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetAccount
oauth:
canonical_scopes: |-
@@ -57,6 +92,11 @@ authentication:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.edit,
https://www.googleapis.com/auth/analytics.readonly
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetBigQueryLink
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.edit,
+ https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetConversionEvent
oauth:
canonical_scopes: |-
@@ -97,6 +137,11 @@ authentication:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.edit,
https://www.googleapis.com/auth/analytics.readonly
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetExpandedDataSet
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.edit,
+ https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetGlobalSiteTag
oauth:
canonical_scopes: |-
@@ -117,11 +162,21 @@ authentication:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.edit,
https://www.googleapis.com/auth/analytics.readonly
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetSearchAds360Link
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.edit,
+ https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetUserLink
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.manage.users,
https://www.googleapis.com/auth/analytics.manage.users.readonly
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccessBindings
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.manage.users,
+ https://www.googleapis.com/auth/analytics.manage.users.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccountSummaries
oauth:
canonical_scopes: |-
@@ -137,6 +192,11 @@ authentication:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.edit,
https://www.googleapis.com/auth/analytics.readonly
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListBigQueryLinks
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.edit,
+ https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListConversionEvents
oauth:
canonical_scopes: |-
@@ -167,6 +227,11 @@ authentication:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.edit,
https://www.googleapis.com/auth/analytics.readonly
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListExpandedDataSets
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.edit,
+ https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListFirebaseLinks
oauth:
canonical_scopes: |-
@@ -187,6 +252,11 @@ authentication:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.edit,
https://www.googleapis.com/auth/analytics.readonly
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListSearchAds360Links
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.edit,
+ https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListUserLinks
oauth:
canonical_scopes: |-
@@ -197,7 +267,21 @@ authentication:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.edit,
https://www.googleapis.com/auth/analytics.readonly
+ - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateAccessBinding
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/analytics.manage.users
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateUserLink
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.manage.users
+
+publishing:
+ organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED
+ new_issue_uri: ''
+ documentation_uri: ''
+ api_short_name: ''
+ github_label: ''
+ doc_tag_prefix: ''
+ codeowner_github_teams:
+ library_settings:
diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/audience.proto b/third_party/googleapis/google/analytics/admin/v1alpha/audience.proto
index e12943e1c..cc3c73295 100644
--- a/third_party/googleapis/google/analytics/admin/v1alpha/audience.proto
+++ b/third_party/googleapis/google/analytics/admin/v1alpha/audience.proto
@@ -66,9 +66,6 @@ message AudienceDimensionOrMetricFilter {
// Full regular expression matches with the string value.
FULL_REGEXP = 5;
-
- // Partial regular expression matches with the string value.
- PARTIAL_REGEXP = 6;
}
// Required. The match type for the string filter.
@@ -84,7 +81,8 @@ message AudienceDimensionOrMetricFilter {
// A filter for a string dimension that matches a particular list of options.
message InListFilter {
- // Required. The list of possible string values to match against. Must be non-empty.
+ // Required. The list of possible string values to match against. Must be
+ // non-empty.
repeated string values = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. If true, the match is case-sensitive. If false, the match is
@@ -117,14 +115,8 @@ message AudienceDimensionOrMetricFilter {
// Less than.
LESS_THAN = 2;
- // Less than or equal.
- LESS_THAN_OR_EQUAL = 3;
-
// Greater than.
GREATER_THAN = 4;
-
- // Greater than or equal.
- GREATER_THAN_OR_EQUAL = 5;
}
// Required. The operation applied to a numeric filter.
@@ -167,8 +159,8 @@ message AudienceDimensionOrMetricFilter {
(google.api.field_behavior) = IMMUTABLE
];
- // Optional. Indicates whether this filter needs dynamic evaluation or not. If set to
- // true, users join the Audience if they ever met the condition (static
+ // Optional. Indicates whether this filter needs dynamic evaluation or not. If
+ // set to true, users join the Audience if they ever met the condition (static
// evaluation). If unset or set to false, user evaluation for an Audience is
// dynamic; users are added to an Audience when they meet the conditions and
// then removed when they no longer meet them.
@@ -176,9 +168,9 @@ message AudienceDimensionOrMetricFilter {
// This can only be set when Audience scope is ACROSS_ALL_SESSIONS.
bool at_any_point_in_time = 6 [(google.api.field_behavior) = OPTIONAL];
- // Optional. If set, specifies the time window for which to evaluate data in number of
- // days. If not set, then audience data is evaluated against lifetime data
- // (i.e., infinite time window).
+ // Optional. If set, specifies the time window for which to evaluate data in
+ // number of days. If not set, then audience data is evaluated against
+ // lifetime data (i.e., infinite time window).
//
// For example, if set to 1 day, only the current day's data is evaluated. The
// reference point is the current day when at_any_point_in_time is unset or
@@ -199,14 +191,15 @@ message AudienceEventFilter {
(google.api.field_behavior) = IMMUTABLE
];
- // Optional. If specified, this filter matches events that match both the single
- // event name and the parameter filter expressions. AudienceEventFilter
+ // Optional. If specified, this filter matches events that match both the
+ // single event name and the parameter filter expressions. AudienceEventFilter
// inside the parameter filter expression cannot be set (i.e., nested
// event filters are not supported). This should be a single and_group of
// dimension_or_metric_filter or not_expression; ANDs of ORs are not
// supported. Also, if it includes a filter for "eventCount", only that one
// will be considered; all the other filters will be ignored.
- AudienceFilterExpression event_parameter_filter_expression = 2 [(google.api.field_behavior) = OPTIONAL];
+ AudienceFilterExpression event_parameter_filter_expression = 2
+ [(google.api.field_behavior) = OPTIONAL];
}
// A logical expression of Audience dimension, metric, or event filters.
@@ -252,7 +245,8 @@ message AudienceSimpleFilter {
(google.api.field_behavior) = IMMUTABLE
];
- // Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
+ // Required. Immutable. A logical expression of Audience dimension, metric, or
+ // event filters.
AudienceFilterExpression filter_expression = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
@@ -271,21 +265,22 @@ message AudienceSequenceFilter {
(google.api.field_behavior) = IMMUTABLE
];
- // Optional. If true, the event satisfying this step must be the very next event
- // after the event satisfying the last step. If unset or false, this
+ // Optional. If true, the event satisfying this step must be the very next
+ // event after the event satisfying the last step. If unset or false, this
// step indirectly follows the prior step; for example, there may be
// events between the prior step and this step. It is ignored for the
// first step.
bool immediately_follows = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. When set, this step must be satisfied within the constraint_duration of
- // the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not
- // set, there is no duration requirement (the duration is effectively
- // unlimited). It is ignored for the first step.
- google.protobuf.Duration constraint_duration = 3 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. When set, this step must be satisfied within the
+ // constraint_duration of the previous step (i.e., t[i] - t[i-1] <=
+ // constraint_duration). If not set, there is no duration requirement (the
+ // duration is effectively unlimited). It is ignored for the first step.
+ google.protobuf.Duration constraint_duration = 3
+ [(google.api.field_behavior) = OPTIONAL];
- // Required. Immutable. A logical expression of Audience dimension, metric, or event filters in
- // each step.
+ // Required. Immutable. A logical expression of Audience dimension, metric,
+ // or event filters in each step.
AudienceFilterExpression filter_expression = 4 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
@@ -299,11 +294,13 @@ message AudienceSequenceFilter {
];
// Optional. Defines the time period in which the whole sequence must occur.
- google.protobuf.Duration sequence_maximum_duration = 2 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.Duration sequence_maximum_duration = 2
+ [(google.api.field_behavior) = OPTIONAL];
- // Required. An ordered sequence of steps. A user must complete each step in order to
- // join the sequence filter.
- repeated AudienceSequenceStep sequence_steps = 3 [(google.api.field_behavior) = REQUIRED];
+ // Required. An ordered sequence of steps. A user must complete each step in
+ // order to join the sequence filter.
+ repeated AudienceSequenceStep sequence_steps = 3
+ [(google.api.field_behavior) = REQUIRED];
}
// A clause for defining either a simple or sequence filter. A filter can be
@@ -389,28 +386,31 @@ message Audience {
// Required. The description of the Audience.
string description = 3 [(google.api.field_behavior) = REQUIRED];
- // Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more
- // than 540 days.
+ // Required. Immutable. The duration a user should stay in an Audience. It
+ // cannot be set to more than 540 days.
int32 membership_duration_days = 4 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
];
- // Output only. It is automatically set by GA to false if this is an NPA Audience and is
- // excluded from ads personalization.
- bool ads_personalization_enabled = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. It is automatically set by GA to false if this is an NPA
+ // Audience and is excluded from ads personalization.
+ bool ads_personalization_enabled = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. Specifies an event to log when a user joins the Audience. If not set, no
- // event is logged when a user joins the Audience.
- AudienceEventTrigger event_trigger = 6 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. Specifies an event to log when a user joins the Audience. If not
+ // set, no event is logged when a user joins the Audience.
+ AudienceEventTrigger event_trigger = 6
+ [(google.api.field_behavior) = OPTIONAL];
- // Immutable. Specifies how long an exclusion lasts for users that meet the exclusion
- // filter. It is applied to all EXCLUDE filter clauses and is ignored when
- // there is no EXCLUDE filter clause in the Audience.
- AudienceExclusionDurationMode exclusion_duration_mode = 7 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. Specifies how long an exclusion lasts for users that meet the
+ // exclusion filter. It is applied to all EXCLUDE filter clauses and is
+ // ignored when there is no EXCLUDE filter clause in the Audience.
+ AudienceExclusionDurationMode exclusion_duration_mode = 7
+ [(google.api.field_behavior) = IMMUTABLE];
- // Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND’ed
- // together.
+ // Required. Immutable. Unordered list. Filter clauses that define the
+ // Audience. All clauses will be AND’ed together.
repeated AudienceFilterClause filter_clauses = 8 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.field_behavior) = REQUIRED,
diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/expanded_data_set.proto b/third_party/googleapis/google/analytics/admin/v1alpha/expanded_data_set.proto
new file mode 100644
index 000000000..e9a0a3951
--- /dev/null
+++ b/third_party/googleapis/google/analytics/admin/v1alpha/expanded_data_set.proto
@@ -0,0 +1,151 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.analytics.admin.v1alpha;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin";
+option java_multiple_files = true;
+option java_outer_classname = "ExpandedDataSetProto";
+option java_package = "com.google.analytics.admin.v1alpha";
+
+// A specific filter for a single dimension
+message ExpandedDataSetFilter {
+ // A filter for a string-type dimension that matches a particular pattern.
+ message StringFilter {
+ // The match type for the string filter.
+ enum MatchType {
+ // Unspecified
+ MATCH_TYPE_UNSPECIFIED = 0;
+
+ // Exact match of the string value.
+ EXACT = 1;
+
+ // Contains the string value.
+ CONTAINS = 2;
+ }
+
+ // Required. The match type for the string filter.
+ MatchType match_type = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The string value to be matched against.
+ string value = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. If true, the match is case-sensitive. If false, the match is
+ // case-insensitive.
+ // Must be true when match_type is EXACT.
+ // Must be false when match_type is CONTAINS.
+ bool case_sensitive = 3 [(google.api.field_behavior) = OPTIONAL];
+ }
+
+ // A filter for a string dimension that matches a particular list of options.
+ message InListFilter {
+ // Required. The list of possible string values to match against. Must be
+ // non-empty.
+ repeated string values = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. If true, the match is case-sensitive. If false, the match is
+ // case-insensitive.
+ // Must be true.
+ bool case_sensitive = 2 [(google.api.field_behavior) = OPTIONAL];
+ }
+
+ // One of the above filters.
+ oneof one_filter {
+ // A filter for a string-type dimension that matches a particular pattern.
+ StringFilter string_filter = 2;
+
+ // A filter for a string dimension that matches a particular list of
+ // options.
+ InListFilter in_list_filter = 3;
+ }
+
+ // Required. The dimension name to filter.
+ string field_name = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+// A logical expression of EnhancedDataSet dimension filters.
+message ExpandedDataSetFilterExpression {
+ // The expression applied to a filter.
+ oneof expr {
+ // A list of expressions to be AND’ed together. It must contain a
+ // ExpandedDataSetFilterExpression with either not_expression or
+ // dimension_filter. This must be set for the top level
+ // ExpandedDataSetFilterExpression.
+ ExpandedDataSetFilterExpressionList and_group = 1;
+
+ // A filter expression to be NOT'ed (i.e., inverted, complemented). It
+ // must include a dimension_filter. This cannot be set on the
+ // top level ExpandedDataSetFilterExpression.
+ ExpandedDataSetFilterExpression not_expression = 2;
+
+ // A filter on a single dimension. This cannot be set on the top
+ // level ExpandedDataSetFilterExpression.
+ ExpandedDataSetFilter filter = 3;
+ }
+}
+
+// A list of ExpandedDataSet filter expressions.
+message ExpandedDataSetFilterExpressionList {
+ // A list of ExpandedDataSet filter expressions.
+ repeated ExpandedDataSetFilterExpression filter_expressions = 1;
+}
+
+// A resource message representing a GA4 ExpandedDataSet.
+message ExpandedDataSet {
+ option (google.api.resource) = {
+ type: "analyticsadmin.googleapis.com/ExpandedDataSet"
+ pattern: "properties/{property}/expandedDataSets/{expanded_data_set}"
+ };
+
+ // Output only. The resource name for this ExpandedDataSet resource.
+ // Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The display name of the ExpandedDataSet.
+ // Max 200 chars.
+ string display_name = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. The description of the ExpandedDataSet.
+ // Max 50 chars.
+ string description = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Immutable. The list of dimensions included in the ExpandedDataSet.
+ // See the [API
+ // Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
+ // for the list of dimension names.
+ repeated string dimension_names = 4 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. The list of metrics included in the ExpandedDataSet.
+ // See the [API
+ // Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
+ // for the list of dimension names.
+ repeated string metric_names = 5 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. A logical expression of ExpandedDataSet filters applied to
+ // dimension included in the ExpandedDataSet. This filter is used to reduce
+ // the number of rows and thus the change of encountering `other row`.
+ ExpandedDataSetFilterExpression dimension_filter_expression = 6
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Output only. Time when expanded data set began (or will begin) collecing
+ // data.
+ google.protobuf.Timestamp data_collection_start_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/resources.proto b/third_party/googleapis/google/analytics/admin/v1alpha/resources.proto
index 337c7fe65..a035611d9 100644
--- a/third_party/googleapis/google/analytics/admin/v1alpha/resources.proto
+++ b/third_party/googleapis/google/analytics/admin/v1alpha/resources.proto
@@ -16,6 +16,7 @@ syntax = "proto3";
package google.analytics.admin.v1alpha;
+import "google/analytics/admin/v1alpha/expanded_data_set.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
@@ -202,6 +203,12 @@ enum ChangeHistoryResourceType {
// AttributionSettings resource
ATTRIBUTION_SETTINGS = 20;
+
+ // ExpandedDataSet resource
+ EXPANDED_DATA_SET = 21;
+
+ // ChannelGroup resource
+ CHANNEL_GROUP = 22;
}
// Status of the Google Signals settings (i.e., whether this feature has been
@@ -306,10 +313,12 @@ message Account {
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this account was originally created.
- google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when account payload fields were last updated.
- google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Required. Human-readable display name for this account.
string display_name = 4 [(google.api.field_behavior) = REQUIRED];
@@ -334,17 +343,19 @@ message Property {
// Example: "properties/1000"
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. The property type for this Property resource. When creating a property, if
- // the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be
- // implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created
- // via Google Analytics Admin API.
+ // Immutable. The property type for this Property resource. When creating a
+ // property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then
+ // "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY"
+ // types cannot yet be created via Google Analytics Admin API.
PropertyType property_type = 14 [(google.api.field_behavior) = IMMUTABLE];
// Output only. Time when the entity was originally created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when entity payload fields were last updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. Resource name of this property's logical parent.
//
@@ -362,9 +373,9 @@ message Property {
// Example: AUTOMOTIVE, FOOD_AND_DRINK
IndustryCategory industry_category = 6;
- // Required. Reporting Time Zone, used as the day boundary for reports, regardless of
- // where the data originates. If the time zone honors DST, Analytics will
- // automatically adjust for the changes.
+ // Required. Reporting Time Zone, used as the day boundary for reports,
+ // regardless of where the data originates. If the time zone honors DST,
+ // Analytics will automatically adjust for the changes.
//
// NOTE: Changing the time zone only affects data going forward, and is not
// applied retroactively.
@@ -380,17 +391,20 @@ message Property {
// Examples: "USD", "EUR", "JPY"
string currency_code = 8;
- // Output only. The Google Analytics service level that applies to this property.
+ // Output only. The Google Analytics service level that applies to this
+ // property.
ServiceLevel service_level = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. If set, the time at which this property was trashed. If not set, then this
- // property is not currently in the trash can.
- google.protobuf.Timestamp delete_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. If set, the time at which this property was trashed. If not
+ // set, then this property is not currently in the trash can.
+ google.protobuf.Timestamp delete_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. If set, the time at which this trashed property will be permanently
- // deleted. If not set, then this property is not currently in the trash can
- // and is not slated to be deleted.
- google.protobuf.Timestamp expire_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. If set, the time at which this trashed property will be
+ // permanently deleted. If not set, then this property is not currently in the
+ // trash can and is not slated to be deleted.
+ google.protobuf.Timestamp expire_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. The resource name of the parent account
// Format: accounts/{account_id}
@@ -500,10 +514,12 @@ message DataStream {
string display_name = 3;
// Output only. Time when this stream was originally created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when stream payload fields were last updated.
- google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A resource message representing a user's permissions on an Account or
@@ -572,9 +588,9 @@ message FirebaseLink {
// Output only. Example format: properties/1234/firebaseLinks/5678
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. Firebase project resource name. When creating a FirebaseLink, you may
- // provide this resource name using either a project number or project ID.
- // Once this resource has been created, returned FirebaseLinks will always
+ // Immutable. Firebase project resource name. When creating a FirebaseLink,
+ // you may provide this resource name using either a project number or project
+ // ID. Once this resource has been created, returned FirebaseLinks will always
// have a project_name that contains a project number.
//
// Format: 'projects/{project number}'
@@ -582,7 +598,8 @@ message FirebaseLink {
string project = 2 [(google.api.field_behavior) = IMMUTABLE];
// Output only. Time when this FirebaseLink was originally created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Read-only resource with the tag for sending data from a website to a
@@ -598,8 +615,8 @@ message GlobalSiteTag {
// Example: "properties/123/dataStreams/456/globalSiteTag"
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. JavaScript code snippet to be pasted as the first item into the head tag of
- // every webpage to measure.
+ // Immutable. JavaScript code snippet to be pasted as the first item into the
+ // head tag of every webpage to measure.
string snippet = 2 [(google.api.field_behavior) = IMMUTABLE];
}
@@ -610,7 +627,8 @@ message GoogleAdsLink {
pattern: "properties/{property}/googleAdsLinks/{google_ads_link}"
};
- // Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}
+ // Output only. Format:
+ // properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}
//
// Note: googleAdsLinkId is not the Google Ads customer ID.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -628,10 +646,12 @@ message GoogleAdsLink {
google.protobuf.BoolValue ads_personalization_enabled = 5;
// Output only. Time when this link was originally created.
- google.protobuf.Timestamp create_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this link was last updated.
- google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Email address of the user that created the link.
// An empty string will be returned if the email address can't be retrieved.
@@ -688,8 +708,8 @@ message AccountSummary {
// Format: accounts/{account_id}
// Example: "accounts/1000"
string account = 2 [(google.api.resource_reference) = {
- type: "analyticsadmin.googleapis.com/Account"
- }];
+ type: "analyticsadmin.googleapis.com/Account"
+ }];
// Display name for the account referred to in this account summary.
string display_name = 3;
@@ -704,8 +724,8 @@ message PropertySummary {
// Format: properties/{property_id}
// Example: "properties/1000"
string property = 1 [(google.api.resource_reference) = {
- type: "analyticsadmin.googleapis.com/Property"
- }];
+ type: "analyticsadmin.googleapis.com/Property"
+ }];
// Display name for the property referred to in this property summary.
string display_name = 2;
@@ -728,17 +748,16 @@ message MeasurementProtocolSecret {
pattern: "properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret}"
};
- // Output only. Resource name of this secret. This secret may be a child of any type of
- // stream.
- // Format:
+ // Output only. Resource name of this secret. This secret may be a child of
+ // any type of stream. Format:
// properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Required. Human-readable display name for this secret.
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
- // Output only. The measurement protocol secret value. Pass this value to the api_secret
- // field of the Measurement Protocol API when sending hits to this
+ // Output only. The measurement protocol secret value. Pass this value to the
+ // api_secret field of the Measurement Protocol API when sending hits to this
// secret's parent property.
string secret_value = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -798,7 +817,8 @@ message ChangeHistoryChange {
// A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in
// change history.
- DisplayVideo360AdvertiserLinkProposal display_video_360_advertiser_link_proposal = 10;
+ DisplayVideo360AdvertiserLinkProposal
+ display_video_360_advertiser_link_proposal = 10;
// A snapshot of a ConversionEvent resource in change history.
ConversionEvent conversion_event = 11;
@@ -815,11 +835,20 @@ message ChangeHistoryChange {
// A snapshot of a data retention settings resource in change history.
DataRetentionSettings data_retention_settings = 15;
+ // A snapshot of a SearchAds360Link resource in change history.
+ SearchAds360Link search_ads_360_link = 16;
+
// A snapshot of a DataStream resource in change history.
DataStream data_stream = 18;
// A snapshot of AttributionSettings resource in change history.
AttributionSettings attribution_settings = 20;
+
+ // A snapshot of an ExpandedDataSet resource in change history.
+ ExpandedDataSet expanded_data_set = 21;
+
+ // A snapshot of a BigQuery link resource in change history.
+ BigQueryLink bigquery_link = 23;
}
}
@@ -845,8 +874,9 @@ message DisplayVideo360AdvertiserLink {
pattern: "properties/{property}/displayVideo360AdvertiserLinks/{display_video_360_advertiser_link}"
};
- // Output only. The resource name for this DisplayVideo360AdvertiserLink resource.
- // Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId}
+ // Output only. The resource name for this DisplayVideo360AdvertiserLink
+ // resource. Format:
+ // properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId}
//
// Note: linkId is not the Display & Video 360 Advertiser ID
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -855,24 +885,27 @@ message DisplayVideo360AdvertiserLink {
string advertiser_id = 2 [(google.api.field_behavior) = IMMUTABLE];
// Output only. The display name of the Display & Video 360 Advertiser.
- string advertiser_display_name = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ string advertiser_display_name = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Enables personalized advertising features with this integration.
// If this field is not set on create/update, it will be defaulted to true.
google.protobuf.BoolValue ads_personalization_enabled = 4;
- // Immutable. Enables the import of campaign data from Display & Video 360 into the GA4
- // property. After link creation, this can only be updated from the Display &
- // Video 360 product.
- // If this field is not set on create, it will be defaulted to true.
- google.protobuf.BoolValue campaign_data_sharing_enabled = 5 [(google.api.field_behavior) = IMMUTABLE];
-
- // Immutable. Enables the import of cost data from Display & Video 360 into the GA4
- // property. This can only be enabled if campaign_data_sharing_enabled is
- // enabled. After link creation, this can only be updated from the Display &
- // Video 360 product.
- // If this field is not set on create, it will be defaulted to true.
- google.protobuf.BoolValue cost_data_sharing_enabled = 6 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. Enables the import of campaign data from Display & Video 360
+ // into the GA4 property. After link creation, this can only be updated from
+ // the Display & Video 360 product. If this field is not set on create, it
+ // will be defaulted to true.
+ google.protobuf.BoolValue campaign_data_sharing_enabled = 5
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Enables the import of cost data from Display & Video 360 into
+ // the GA4 property. This can only be enabled if campaign_data_sharing_enabled
+ // is enabled. After link creation, this can only be updated from the Display
+ // & Video 360 product. If this field is not set on create, it will be
+ // defaulted to true.
+ google.protobuf.BoolValue cost_data_sharing_enabled = 6
+ [(google.api.field_behavior) = IMMUTABLE];
}
// A proposal for a link between a GA4 property and a Display & Video 360
@@ -887,8 +920,8 @@ message DisplayVideo360AdvertiserLinkProposal {
pattern: "properties/{property}/displayVideo360AdvertiserLinkProposals/{display_video_360_advertiser_link_proposal}"
};
- // Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource.
- // Format:
+ // Output only. The resource name for this
+ // DisplayVideo360AdvertiserLinkProposal resource. Format:
// properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}
//
// Note: proposalId is not the Display & Video 360 Advertiser ID
@@ -898,44 +931,97 @@ message DisplayVideo360AdvertiserLinkProposal {
string advertiser_id = 2 [(google.api.field_behavior) = IMMUTABLE];
// Output only. The status information for this link proposal.
- LinkProposalStatusDetails link_proposal_status_details = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ LinkProposalStatusDetails link_proposal_status_details = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The display name of the Display & Video Advertiser.
// Only populated for proposals that originated from Display & Video 360.
- string advertiser_display_name = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Input only. On a proposal being sent to Display & Video 360, this field must be set to
- // the email address of an admin on the target advertiser. This is used to
- // verify that the Google Analytics admin is aware of at least one admin on
- // the Display & Video 360 Advertiser. This does not restrict approval of the
- // proposal to a single user. Any admin on the Display & Video 360 Advertiser
- // may approve the proposal.
+ string advertiser_display_name = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Input only. On a proposal being sent to Display & Video 360, this field
+ // must be set to the email address of an admin on the target advertiser. This
+ // is used to verify that the Google Analytics admin is aware of at least one
+ // admin on the Display & Video 360 Advertiser. This does not restrict
+ // approval of the proposal to a single user. Any admin on the Display & Video
+ // 360 Advertiser may approve the proposal.
string validation_email = 5 [(google.api.field_behavior) = INPUT_ONLY];
// Immutable. Enables personalized advertising features with this integration.
// If this field is not set on create, it will be defaulted to true.
- google.protobuf.BoolValue ads_personalization_enabled = 6 [(google.api.field_behavior) = IMMUTABLE];
+ google.protobuf.BoolValue ads_personalization_enabled = 6
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Enables the import of campaign data from Display & Video 360.
// If this field is not set on create, it will be defaulted to true.
- google.protobuf.BoolValue campaign_data_sharing_enabled = 7 [(google.api.field_behavior) = IMMUTABLE];
+ google.protobuf.BoolValue campaign_data_sharing_enabled = 7
+ [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Enables the import of cost data from Display & Video 360.
// This can only be enabled if campaign_data_sharing_enabled is enabled.
// If this field is not set on create, it will be defaulted to true.
- google.protobuf.BoolValue cost_data_sharing_enabled = 8 [(google.api.field_behavior) = IMMUTABLE];
+ google.protobuf.BoolValue cost_data_sharing_enabled = 8
+ [(google.api.field_behavior) = IMMUTABLE];
+}
+
+// A link between a GA4 property and a Search Ads 360 entity.
+message SearchAds360Link {
+ option (google.api.resource) = {
+ type: "analyticsadmin.googleapis.com/SearchAds360Link"
+ pattern: "properties/{property}/searchAds360Links/{search_ads_360_link}"
+ };
+
+ // Output only. The resource name for this SearchAds360Link resource.
+ // Format: properties/{propertyId}/searchAds360Links/{linkId}
+ //
+ // Note: linkId is not the Search Ads 360 advertiser ID
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Immutable. This field represents the Advertiser ID of the Search Ads 360
+ // Advertiser. that has been linked.
+ string advertiser_id = 2 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Enables the import of campaign data from Search Ads 360 into the
+ // GA4 property. After link creation, this can only be updated from the Search
+ // Ads 360 product.
+ // If this field is not set on create, it will be defaulted to true.
+ google.protobuf.BoolValue campaign_data_sharing_enabled = 3
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Immutable. Enables the import of cost data from Search Ads 360 to the GA4
+ // property. This can only be enabled if campaign_data_sharing_enabled is
+ // enabled. After link creation, this can only be updated from
+ // the Search Ads 360 product.
+ // If this field is not set on create, it will be defaulted to true.
+ google.protobuf.BoolValue cost_data_sharing_enabled = 4
+ [(google.api.field_behavior) = IMMUTABLE];
+
+ // Output only. The display name of the Search Ads 360 Advertiser.
+ // Allows users to easily identify the linked resource.
+ string advertiser_display_name = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Enables personalized advertising features with this integration.
+ // If this field is not set on create, it will be defaulted to true.
+ google.protobuf.BoolValue ads_personalization_enabled = 6;
+
+ // Enables export of site stats with this integration.
+ // If this field is not set on create, it will be defaulted to true.
+ google.protobuf.BoolValue site_stats_sharing_enabled = 7;
}
// Status information for a link proposal.
message LinkProposalStatusDetails {
// Output only. The source of this proposal.
- LinkProposalInitiatingProduct link_proposal_initiating_product = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ LinkProposalInitiatingProduct link_proposal_initiating_product = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The email address of the user that proposed this linkage.
string requestor_email = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The state of this proposal.
- LinkProposalState link_proposal_state = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ LinkProposalState link_proposal_state = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A conversion event in a Google Analytics property.
@@ -954,16 +1040,18 @@ message ConversionEvent {
string event_name = 2 [(google.api.field_behavior) = IMMUTABLE];
// Output only. Time when this conversion event was created in the property.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. If set, this event can currently be deleted via DeleteConversionEvent.
+ // Output only. If set, this event can currently be deleted via
+ // DeleteConversionEvent.
bool deletable = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. If set to true, this conversion event refers to a custom event. If set to
- // false, this conversion event refers to a default event in GA. Default
- // events typically have special meaning in GA. Default events are usually
- // created for you by the GA system, but in some cases can be created by
- // property admins. Custom events count towards the maximum number of
+ // Output only. If set to true, this conversion event refers to a custom
+ // event. If set to false, this conversion event refers to a default event in
+ // GA. Default events typically have special meaning in GA. Default events are
+ // usually created for you by the GA system, but in some cases can be created
+ // by property admins. Custom events count towards the maximum number of
// custom conversion events that may be created per property.
bool custom = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -1024,14 +1112,15 @@ message CustomDimension {
(google.api.field_behavior) = IMMUTABLE
];
- // Required. Display name for this custom dimension as shown in the Analytics UI.
- // Max length of 82 characters, alphanumeric plus space and underscore
+ // Required. Display name for this custom dimension as shown in the Analytics
+ // UI. Max length of 82 characters, alphanumeric plus space and underscore
// starting with a letter. Legacy system-generated display names may contain
// square brackets, but updates to this field will never permit square
// brackets.
string display_name = 3 [(google.api.field_behavior) = REQUIRED];
- // Optional. Description for this custom dimension. Max length of 150 characters.
+ // Optional. Description for this custom dimension. Max length of 150
+ // characters.
string description = 4 [(google.api.field_behavior) = OPTIONAL];
// Required. Immutable. The scope of this dimension.
@@ -1040,11 +1129,12 @@ message CustomDimension {
(google.api.field_behavior) = IMMUTABLE
];
- // Optional. If set to true, sets this dimension as NPA and excludes it from ads
- // personalization.
+ // Optional. If set to true, sets this dimension as NPA and excludes it from
+ // ads personalization.
//
// This is currently only supported by user-scoped custom dimensions.
- bool disallow_ads_personalization = 6 [(google.api.field_behavior) = OPTIONAL];
+ bool disallow_ads_personalization = 6
+ [(google.api.field_behavior) = OPTIONAL];
}
// A definition for a custom metric.
@@ -1151,10 +1241,11 @@ message CustomMetric {
(google.api.field_behavior) = IMMUTABLE
];
- // 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.
- repeated RestrictedMetricType restricted_metric_type = 8 [(google.api.field_behavior) = OPTIONAL];
+ // 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.
+ repeated RestrictedMetricType restricted_metric_type = 8
+ [(google.api.field_behavior) = OPTIONAL];
}
// Settings values for data retention. This is a singleton resource.
@@ -1282,19 +1373,106 @@ message AttributionSettings {
// Example: "properties/1000/attributionSettings"
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. The lookback window configuration for acquisition conversion events.
- // The default window size is 30 days.
- AcquisitionConversionEventLookbackWindow acquisition_conversion_event_lookback_window = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The lookback window configuration for acquisition conversion
+ // events. The default window size is 30 days.
+ AcquisitionConversionEventLookbackWindow
+ acquisition_conversion_event_lookback_window = 2
+ [(google.api.field_behavior) = REQUIRED];
- // Required. The lookback window for all other, non-acquisition conversion events.
- // The default window size is 90 days.
- OtherConversionEventLookbackWindow other_conversion_event_lookback_window = 3 [(google.api.field_behavior) = REQUIRED];
+ // Required. The lookback window for all other, non-acquisition conversion
+ // events. The default window size is 90 days.
+ OtherConversionEventLookbackWindow other_conversion_event_lookback_window = 3
+ [(google.api.field_behavior) = REQUIRED];
- // Required. The reporting attribution model used to calculate conversion credit in this
- // property's reports.
+ // Required. The reporting attribution model used to calculate conversion
+ // credit in this property's reports.
//
// Changing the attribution model will apply to both historical and future
// data. These changes will be reflected in reports with conversion and
// revenue data. User and session data will be unaffected.
- ReportingAttributionModel reporting_attribution_model = 4 [(google.api.field_behavior) = REQUIRED];
+ ReportingAttributionModel reporting_attribution_model = 4
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// A binding of a user to a set of roles.
+message AccessBinding {
+ option (google.api.resource) = {
+ type: "analyticsadmin.googleapis.com/AccessBinding"
+ pattern: "accounts/{account}/accessBindings/{access_binding}"
+ pattern: "properties/{property}/accessBindings/{access_binding}"
+ };
+
+ // The target for which to set roles for.
+ oneof access_target {
+ // If set, the email address of the user to set roles for.
+ // Format: "someuser@gmail.com"
+ string user = 2;
+ }
+
+ // Output only. Resource name of this binding.
+ //
+ // Format: accounts/{account}/accessBindings/{access_binding} or
+ // properties/{property}/accessBindings/{access_binding}
+ //
+ // Example:
+ // "accounts/100/accessBindings/200"
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // A list of roles for to grant to the parent resource.
+ //
+ // Valid values:
+ // predefinedRoles/viewer
+ // predefinedRoles/analyst
+ // predefinedRoles/editor
+ // predefinedRoles/admin
+ // predefinedRoles/no-cost-data
+ // predefinedRoles/no-revenue-data
+ //
+ // For users, if an empty list of roles is set, this AccessBinding will be
+ // deleted.
+ repeated string roles = 3;
+}
+
+// A link between a GA4 Property and BigQuery project.
+message BigQueryLink {
+ option (google.api.resource) = {
+ type: "analyticsadmin.googleapis.com/BigQueryLink"
+ pattern: "properties/{property}/bigQueryLinks/{bigquery_link}"
+ };
+
+ // Output only. Resource name of this BigQuery link.
+ // Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}'
+ // Format: 'properties/1234/bigQueryLinks/abc567'
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Immutable. The linked Google Cloud project. When creating a BigQueryLink,
+ // you may provide this resource name using either a project number or project
+ // ID. Once this resource has been created, the returned project will always
+ // have a project that contains a project number.
+ // Format: 'projects/{project number}'
+ // Example: 'projects/1234'
+ string project = 2 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Output only. Time when the link was created.
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // If set true, enables daily data export to the linked Google Cloud project.
+ bool daily_export_enabled = 4;
+
+ // If set true, enables streaming export to the linked Google Cloud project.
+ bool streaming_export_enabled = 5;
+
+ // If set true, exported data will include advertising identifiers for mobile
+ // app streams.
+ bool include_advertising_id = 6;
+
+ // The list of streams under the parent property for which data will be
+ // exported.
+ // Format: properties/{property_id}/dataStreams/{stream_id}
+ // Example: ['properties/1000/dataStreams/2000']
+ repeated string export_streams = 7;
+
+ // The list of event names that will be excluded from exports.
+ repeated string excluded_events = 8;
}
diff --git a/third_party/googleapis/google/analytics/admin/v1beta/BUILD.bazel b/third_party/googleapis/google/analytics/admin/v1beta/BUILD.bazel
index cc5b7e46b..38b519b3e 100644
--- a/third_party/googleapis/google/analytics/admin/v1beta/BUILD.bazel
+++ b/third_party/googleapis/google/analytics/admin/v1beta/BUILD.bazel
@@ -347,6 +347,7 @@ csharp_gapic_library(
grpc_service_config = "admin_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "analyticsadmin.yaml",
+ transport = "grpc+rest",
deps = [
":admin_csharp_grpc",
":admin_csharp_proto",
diff --git a/third_party/googleapis/google/analytics/data/v1alpha/BUILD.bazel b/third_party/googleapis/google/analytics/data/v1alpha/BUILD.bazel
index e580f6420..c1b4ae2ca 100644
--- a/third_party/googleapis/google/analytics/data/v1alpha/BUILD.bazel
+++ b/third_party/googleapis/google/analytics/data/v1alpha/BUILD.bazel
@@ -264,6 +264,7 @@ ruby_cloud_gapic_library(
],
grpc_service_config = "analytics_data_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "analyticsdata_v1alpha.yaml",
deps = [
":data_ruby_grpc",
":data_ruby_proto",
@@ -298,6 +299,7 @@ csharp_gapic_library(
grpc_service_config = "analytics_data_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "analyticsdata_v1alpha.yaml",
+ transport = "grpc+rest",
deps = [
":data_csharp_grpc",
":data_csharp_proto",
diff --git a/third_party/googleapis/google/analytics/data/v1beta/BUILD.bazel b/third_party/googleapis/google/analytics/data/v1beta/BUILD.bazel
index b5719c8b5..b73174ff6 100644
--- a/third_party/googleapis/google/analytics/data/v1beta/BUILD.bazel
+++ b/third_party/googleapis/google/analytics/data/v1beta/BUILD.bazel
@@ -352,6 +352,7 @@ csharp_gapic_library(
grpc_service_config = "analytics_data_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "analyticsdata_v1beta.yaml",
+ transport = "grpc+rest",
deps = [
":data_csharp_grpc",
":data_csharp_proto",
diff --git a/third_party/googleapis/google/api/BUILD.bazel b/third_party/googleapis/google/api/BUILD.bazel
index 567b0ee4e..12e1a845f 100644
--- a/third_party/googleapis/google/api/BUILD.bazel
+++ b/third_party/googleapis/google/api/BUILD.bazel
@@ -582,12 +582,12 @@ cc_proto_library(
cc_proto_library(
name = "monitoring_cc_proto",
- deps = ["monitoring_proto"],
+ deps = [":monitoring_proto"],
)
cc_proto_library(
name = "quota_cc_proto",
- deps = ["quota_proto"],
+ deps = [":quota_proto"],
)
cc_proto_library(
diff --git a/third_party/googleapis/google/api/apikeys/v2/BUILD.bazel b/third_party/googleapis/google/api/apikeys/v2/BUILD.bazel
index 70d8e2a37..d29c10271 100644
--- a/third_party/googleapis/google/api/apikeys/v2/BUILD.bazel
+++ b/third_party/googleapis/google/api/apikeys/v2/BUILD.bazel
@@ -30,6 +30,7 @@ proto_library(
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
@@ -361,6 +362,7 @@ csharp_gapic_library(
grpc_service_config = "apikeys_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "apikeys_v2.yaml",
+ transport = "grpc+rest",
deps = [
":apikeys_csharp_grpc",
":apikeys_csharp_proto",
diff --git a/third_party/googleapis/google/api/expr/conformance/v1alpha1/conformance_service.proto b/third_party/googleapis/google/api/expr/conformance/v1alpha1/conformance_service.proto
index 916169843..c1ad7aaaf 100644
--- a/third_party/googleapis/google/api/expr/conformance/v1alpha1/conformance_service.proto
+++ b/third_party/googleapis/google/api/expr/conformance/v1alpha1/conformance_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -16,11 +16,11 @@ syntax = "proto3";
package google.api.expr.conformance.v1alpha1;
+import "google/api/client.proto";
import "google/api/expr/v1alpha1/checked.proto";
import "google/api/expr/v1alpha1/eval.proto";
import "google/api/expr/v1alpha1/syntax.proto";
import "google/rpc/status.proto";
-import "google/api/client.proto";
option cc_enable_arenas = true;
option go_package = "google.golang.org/genproto/googleapis/api/expr/conformance/v1alpha1;confpb";
@@ -135,6 +135,23 @@ message EvalResponse {
repeated google.rpc.Status issues = 2;
}
+// A specific position in source.
+message SourcePosition {
+ // The source location name (e.g. file name).
+ string location = 1;
+
+ // The UTF-8 code unit offset.
+ int32 offset = 2;
+
+ // The 1-based index of the starting line in the source text
+ // where the issue occurs, or 0 if unknown.
+ int32 line = 3;
+
+ // The 0-based index of the starting position within the line of source text
+ // where the issue occurs. Only meaningful if line is nonzero.
+ int32 column = 4;
+}
+
// Warnings or errors in service execution are represented by
// [google.rpc.Status][google.rpc.Status] messages, with the following message
// in the details field.
@@ -159,7 +176,7 @@ message IssueDetails {
Severity severity = 1;
// Position in the source, if known.
- google.api.expr.v1alpha1.SourcePosition position = 2;
+ SourcePosition position = 2;
// Expression ID from [Expr][], 0 if unknown.
int64 id = 3;
diff --git a/third_party/googleapis/google/api/servicecontrol/v1/BUILD.bazel b/third_party/googleapis/google/api/servicecontrol/v1/BUILD.bazel
index 65e16f71c..87b882ed9 100644
--- a/third_party/googleapis/google/api/servicecontrol/v1/BUILD.bazel
+++ b/third_party/googleapis/google/api/servicecontrol/v1/BUILD.bazel
@@ -187,7 +187,8 @@ py_gapic_library(
"warehouse-package-name=google-cloud-service-control",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "servicecontrol.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -290,6 +291,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "The Service Control API provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
ruby_cloud_title = "Service Control API V1",
+ service_yaml = "servicecontrol.yaml",
deps = [
":servicecontrol_ruby_grpc",
":servicecontrol_ruby_proto",
@@ -324,6 +326,7 @@ csharp_gapic_library(
grpc_service_config = "servicecontrol_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "servicecontrol.yaml",
+ transport = "grpc+rest",
deps = [
":servicecontrol_csharp_grpc",
":servicecontrol_csharp_proto",
diff --git a/third_party/googleapis/google/api/servicecontrol/v2/BUILD.bazel b/third_party/googleapis/google/api/servicecontrol/v2/BUILD.bazel
index f905d8c4b..14340ebea 100644
--- a/third_party/googleapis/google/api/servicecontrol/v2/BUILD.bazel
+++ b/third_party/googleapis/google/api/servicecontrol/v2/BUILD.bazel
@@ -175,7 +175,8 @@ py_gapic_library(
"warehouse-package-name=google-cloud-service-control",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "servicecontrol.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -276,6 +277,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "The Service Control API provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
ruby_cloud_title = "Service Control API V2",
+ service_yaml = "servicecontrol.yaml",
deps = [
":servicecontrol_ruby_grpc",
":servicecontrol_ruby_proto",
@@ -310,6 +312,7 @@ csharp_gapic_library(
grpc_service_config = "servicecontrol_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "servicecontrol.yaml",
+ transport = "grpc+rest",
deps = [
":servicecontrol_csharp_grpc",
":servicecontrol_csharp_proto",
diff --git a/third_party/googleapis/google/api/servicemanagement/v1/BUILD.bazel b/third_party/googleapis/google/api/servicemanagement/v1/BUILD.bazel
index 5a9137005..4c1122287 100644
--- a/third_party/googleapis/google/api/servicemanagement/v1/BUILD.bazel
+++ b/third_party/googleapis/google/api/servicemanagement/v1/BUILD.bazel
@@ -63,6 +63,7 @@ proto_library(
"//google/api:service_proto",
"//google/longrunning:operations_proto",
"@com_google_protobuf//:any_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:timestamp_proto",
],
)
@@ -185,7 +186,8 @@ py_gapic_library(
"warehouse-package-name=google-cloud-service-management",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "servicemanagement_v1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -286,6 +288,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.",
ruby_cloud_title = "Service Management V1",
+ service_yaml = "servicemanagement_v1.yaml",
deps = [
":servicemanagement_ruby_grpc",
":servicemanagement_ruby_proto",
@@ -320,6 +323,7 @@ csharp_gapic_library(
grpc_service_config = "servicemanagement_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "servicemanagement_v1.yaml",
+ transport = "grpc+rest",
deps = [
":servicemanagement_csharp_grpc",
":servicemanagement_csharp_proto",
diff --git a/third_party/googleapis/google/api/serviceusage/v1/BUILD.bazel b/third_party/googleapis/google/api/serviceusage/v1/BUILD.bazel
index 07c6885ab..5e4cafcde 100644
--- a/third_party/googleapis/google/api/serviceusage/v1/BUILD.bazel
+++ b/third_party/googleapis/google/api/serviceusage/v1/BUILD.bazel
@@ -193,7 +193,8 @@ py_gapic_library(
"python-gapic-name=service_usage",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "serviceusage_v1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -294,6 +295,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Service Usage is an infrastructure service of Google Cloud that lets you list and manage other APIs and services in your Cloud projects. You can list and manage Google Cloud services and their APIs, as well as services created using Cloud Endpoints.",
ruby_cloud_title = "Service Usage V1",
+ service_yaml = "serviceusage_v1.yaml",
deps = [
":serviceusage_ruby_grpc",
":serviceusage_ruby_proto",
@@ -327,7 +329,8 @@ csharp_gapic_library(
common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
grpc_service_config = "serviceusage_grpc_service_config.json",
rest_numeric_enums = True,
- # service_yaml = "serviceusage_v1.yaml",
+ service_yaml = "serviceusage_v1.yaml",
+ transport = "grpc+rest",
deps = [
":serviceusage_csharp_grpc",
":serviceusage_csharp_proto",
diff --git a/third_party/googleapis/google/api/serviceusage/v1beta1/BUILD.bazel b/third_party/googleapis/google/api/serviceusage/v1beta1/BUILD.bazel
index f604ae790..51ba70271 100644
--- a/third_party/googleapis/google/api/serviceusage/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/api/serviceusage/v1beta1/BUILD.bazel
@@ -65,6 +65,7 @@ proto_library(
"//google/api:usage_proto",
"//google/longrunning:operations_proto",
"@com_google_protobuf//:api_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
],
)
@@ -177,7 +178,8 @@ py_gapic_library(
srcs = [":serviceusage_proto"],
grpc_service_config = "serviceusage_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "serviceusage_v1beta1.yaml",
+ transport = "grpc+rest",
)
# Uncomment once https://github.com/googleapis/gapic-generator-python/issues/1376 is fixed
@@ -279,6 +281,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Service Usage is an infrastructure service of Google Cloud that lets you list and manage other APIs and services in your Cloud projects. You can list and manage Google Cloud services and their APIs, as well as services created using Cloud Endpoints.",
ruby_cloud_title = "Service Usage V1beta1",
+ service_yaml = "serviceusage_v1beta1.yaml",
deps = [
":serviceusage_ruby_grpc",
":serviceusage_ruby_proto",
@@ -313,6 +316,7 @@ csharp_gapic_library(
grpc_service_config = "serviceusage_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "serviceusage_v1beta1.yaml",
+ transport = "grpc+rest",
deps = [
":serviceusage_csharp_grpc",
":serviceusage_csharp_proto",
diff --git a/third_party/googleapis/google/appengine/v1/BUILD.bazel b/third_party/googleapis/google/appengine/v1/BUILD.bazel
index aac92a8a2..8b4851133 100644
--- a/third_party/googleapis/google/appengine/v1/BUILD.bazel
+++ b/third_party/googleapis/google/appengine/v1/BUILD.bazel
@@ -208,7 +208,8 @@ py_gapic_library(
"python-gapic-name=appengine_admin",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "appengine_v1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -308,6 +309,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "The App Engine Admin API provisions and manages your App Engine applications.",
ruby_cloud_title = "App Engine Admin V1",
+ service_yaml = "appengine_v1.yaml",
deps = [
":appengine_ruby_grpc",
":appengine_ruby_proto",
@@ -342,6 +344,7 @@ csharp_gapic_library(
grpc_service_config = "appengine_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "appengine_v1.yaml",
+ transport = "grpc+rest",
deps = [
":appengine_csharp_grpc",
":appengine_csharp_proto",
diff --git a/third_party/googleapis/google/apps/alertcenter/v1beta1/BUILD.bazel b/third_party/googleapis/google/apps/alertcenter/v1beta1/BUILD.bazel
index 7b2e6c27a..a098263d4 100644
--- a/third_party/googleapis/google/apps/alertcenter/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/apps/alertcenter/v1beta1/BUILD.bazel
@@ -166,7 +166,8 @@ py_gapic_library(
srcs = [":alertcenter_proto"],
grpc_service_config = "alertcenter_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "alertcenter.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -261,6 +262,7 @@ ruby_cloud_gapic_library(
],
grpc_service_config = "alertcenter_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "alertcenter.yaml",
deps = [
":alertcenter_ruby_grpc",
":alertcenter_ruby_proto",
@@ -295,6 +297,7 @@ csharp_gapic_library(
grpc_service_config = "alertcenter_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "alertcenter.yaml",
+ transport = "grpc+rest",
deps = [
":alertcenter_csharp_grpc",
":alertcenter_csharp_proto",
diff --git a/third_party/googleapis/google/apps/drive/activity/v2/BUILD.bazel b/third_party/googleapis/google/apps/drive/activity/v2/BUILD.bazel
index b2d1846b5..518d9dab4 100644
--- a/third_party/googleapis/google/apps/drive/activity/v2/BUILD.bazel
+++ b/third_party/googleapis/google/apps/drive/activity/v2/BUILD.bazel
@@ -175,7 +175,7 @@ py_gapic_library(
grpc_service_config = "driveactivity_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "driveactivity_v2.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
],
)
@@ -347,6 +347,7 @@ csharp_gapic_library(
grpc_service_config = "driveactivity_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "driveactivity_v2.yaml",
+ transport = "grpc+rest",
deps = [
":activity_csharp_grpc",
":activity_csharp_proto",
diff --git a/third_party/googleapis/google/apps/drive/activity/v2/action.proto b/third_party/googleapis/google/apps/drive/activity/v2/action.proto
index b1398c953..e7a00ae0b 100644
--- a/third_party/googleapis/google/apps/drive/activity/v2/action.proto
+++ b/third_party/googleapis/google/apps/drive/activity/v2/action.proto
@@ -97,14 +97,10 @@ message ActionDetail {
// An object was created.
message Create {
// An object was created from scratch.
- message New {
-
- }
+ message New {}
// An object was uploaded into Drive.
- message Upload {
-
- }
+ message Upload {}
// An object was created by copying an existing object.
message Copy {
@@ -129,9 +125,7 @@ message Create {
}
// An empty message indicating an object was edited.
-message Edit {
-
-}
+message Edit {}
// An object was moved.
message Move {
@@ -229,9 +223,7 @@ message Permission {
}
// Represents any user (including a logged out user).
- message Anyone {
-
- }
+ message Anyone {}
// Indicates the
// [Google Drive permissions
@@ -437,6 +429,9 @@ message SettingsChange {
// When restricted, this prevents use of Drive File Stream.
DRIVE_FILE_STREAM = 4;
+
+ // When restricted, this limits sharing of folders to managers only.
+ FILE_ORGANIZER_CAN_SHARE_FOLDERS = 5;
}
// The restriction applicable to a feature.
diff --git a/third_party/googleapis/google/apps/drive/activity/v2/actor.proto b/third_party/googleapis/google/apps/drive/activity/v2/actor.proto
index 5a65ed0e4..32447815d 100644
--- a/third_party/googleapis/google/apps/drive/activity/v2/actor.proto
+++ b/third_party/googleapis/google/apps/drive/activity/v2/actor.proto
@@ -59,14 +59,10 @@ message User {
}
// A user whose account has since been deleted.
- message DeletedUser {
-
- }
+ message DeletedUser {}
// A user about whom nothing is currently known.
- message UnknownUser {
-
- }
+ message UnknownUser {}
// The type of user, such as known, unknown, and deleted.
oneof type {
@@ -83,9 +79,7 @@ message User {
// Empty message representing an anonymous user or indicating the authenticated
// user should be anonymized.
-message AnonymousUser {
-
-}
+message AnonymousUser {}
// Information about an impersonation, where an admin acts on behalf of an end
// user. Information about the acting admin is not currently available.
@@ -113,6 +107,4 @@ message SystemEvent {
}
// Empty message representing an administrator.
-message Administrator {
-
-}
+message Administrator {}
diff --git a/third_party/googleapis/google/apps/drive/activity/v2/drive_activity_service.proto b/third_party/googleapis/google/apps/drive/activity/v2/drive_activity_service.proto
index f54760c55..dd7dfbd83 100644
--- a/third_party/googleapis/google/apps/drive/activity/v2/drive_activity_service.proto
+++ b/third_party/googleapis/google/apps/drive/activity/v2/drive_activity_service.proto
@@ -39,7 +39,8 @@ service DriveActivityService {
"https://www.googleapis.com/auth/drive.activity.readonly";
// Query past activity in Google Drive.
- rpc QueryDriveActivity(QueryDriveActivityRequest) returns (QueryDriveActivityResponse) {
+ rpc QueryDriveActivity(QueryDriveActivityRequest)
+ returns (QueryDriveActivityResponse) {
option (google.api.http) = {
post: "/v2/activity:query"
body: "*"
diff --git a/third_party/googleapis/google/apps/drive/activity/v2/query_drive_activity_request.proto b/third_party/googleapis/google/apps/drive/activity/v2/query_drive_activity_request.proto
index 59d8087d3..3f1a108a5 100644
--- a/third_party/googleapis/google/apps/drive/activity/v2/query_drive_activity_request.proto
+++ b/third_party/googleapis/google/apps/drive/activity/v2/query_drive_activity_request.proto
@@ -27,30 +27,30 @@ option php_namespace = "Google\\Apps\\Drive\\Activity\\V2";
// The request message for querying Drive activity.
message QueryDriveActivityRequest {
// The primary criteria in the query. The default is
- // ancestor_name = `items/root` if no key is specified.
+ // ancestorName = `items/root`, if no key is specified.
oneof key {
// Return activities for this Drive item. The format is
// `items/ITEM_ID`.
string item_name = 1;
- // Return activities for this Drive folder and all children and descendants.
- // The format is `items/ITEM_ID`.
+ // Return activities for this Drive folder, plus all children and
+ // descendants. The format is `items/ITEM_ID`.
string ancestor_name = 2;
}
// Details on how to consolidate related actions that make up the activity. If
- // not set, then related actions are not consolidated.
+ // not set, then related actions aren't consolidated.
ConsolidationStrategy consolidation_strategy = 5;
- // The miminum number of activities desired in the response; the server will
- // attempt to return at least this quanitity. The server may also return fewer
+ // The minimum number of activities desired in the response; the server
+ // attempts to return at least this quantity. The server may also return fewer
// activities if it has a partial response ready before the request times out.
// If not set, a default value is used.
int32 page_size = 6;
- // The token identifying which page of results to return. Set this to the
+ // The token identifies which page of results to return. Set this to the
// next_page_token value returned from a previous query to obtain the
- // following page of results. If not set, the first page of results will be
+ // following page of results. If not set, the first page of results is
// returned.
string page_token = 7;
@@ -61,41 +61,39 @@ message QueryDriveActivityRequest {
// Supported fields:
//
// - `time`: Uses numerical operators on date values either in
- // terms of milliseconds since Jan 1, 1970 or in RFC 3339 format.
- // Examples:
+ // terms of milliseconds since Jan 1, 1970 or in RFC
+ // 3339 format. Examples:
// - `time > 1452409200000 AND time <= 1492812924310`
// - `time >= "2016-01-10T01:02:03-05:00"`
//
// - `detail.action_detail_case`: Uses the "has" operator (:) and
// either a singular value or a list of allowed action types enclosed in
- // parentheses.
+ // parentheses, separated by a space. To exclude a result from the
+ // response, prepend a hyphen (`-`) to the beginning of the filter string.
// Examples:
- // - `detail.action_detail_case: RENAME`
- // - `detail.action_detail_case:(CREATE EDIT)`
+ // - `detail.action_detail_case:RENAME`
+ // - `detail.action_detail_case:(CREATE RESTORE)`
// - `-detail.action_detail_case:MOVE`
//
string filter = 8;
}
-// How the individual activities are consolidated. A set of activities may be
-// consolidated into one combined activity if they are related in some way, such
-// as one actor performing the same action on multiple targets, or multiple
-// actors performing the same action on a single target. The strategy defines
-// the rules for which activities are related.
+// How the individual activities are consolidated. If a set of activities is
+// related they can be consolidated into one combined activity, such as one
+// actor performing the same action on multiple targets, or multiple actors
+// performing the same action on a single target. The strategy defines the rules
+// for which activities are related.
message ConsolidationStrategy {
- // A strategy which does no consolidation of individual activities.
- message NoConsolidation {
-
- }
+ // A strategy that does no consolidation of individual activities.
+ message NoConsolidation {}
- // A strategy which consolidates activities using the grouping rules from the
+ // A strategy that consolidates activities using the grouping rules from the
// legacy V1 Activity API. Similar actions occurring within a window of time
// can be grouped across multiple targets (such as moving a set of files at
// once) or multiple actors (such as several users editing the same item).
// Grouping rules for this strategy are specific to each type of action.
- message Legacy {
-
- }
+ message Legacy {}
// How the individual activities are consolidated.
oneof strategy {
diff --git a/third_party/googleapis/google/apps/drive/activity/v2/target.proto b/third_party/googleapis/google/apps/drive/activity/v2/target.proto
index f6967fcee..06a6b7188 100644
--- a/third_party/googleapis/google/apps/drive/activity/v2/target.proto
+++ b/third_party/googleapis/google/apps/drive/activity/v2/target.proto
@@ -28,6 +28,10 @@ option objc_class_prefix = "GADA";
option php_namespace = "Google\\Apps\\Drive\\Activity\\V2";
// Information about the target of activity.
+//
+// For more information on how activity history is shared with users, see
+// [Activity history
+// visibility](https://developers.google.com/drive/activity/v2#activityhistory).
message Target {
// The type of target object.
oneof object {
@@ -86,8 +90,6 @@ message DriveItem {
// This item is deprecated; please see `DriveFile` instead.
message File {
option deprecated = true;
-
-
}
// This item is deprecated; please see `DriveFolder` instead.
@@ -116,9 +118,7 @@ message DriveItem {
}
// A Drive item which is a file.
- message DriveFile {
-
- }
+ message DriveFile {}
// A Drive item which is a folder.
message DriveFolder {
diff --git a/third_party/googleapis/google/apps/drive/labels/v2/BUILD.bazel b/third_party/googleapis/google/apps/drive/labels/v2/BUILD.bazel
index cddce245a..22deeac62 100644
--- a/third_party/googleapis/google/apps/drive/labels/v2/BUILD.bazel
+++ b/third_party/googleapis/google/apps/drive/labels/v2/BUILD.bazel
@@ -355,6 +355,7 @@ csharp_gapic_library(
grpc_service_config = "drivelabels_v2_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "drivelabels_v2.yaml",
+ transport = "grpc+rest",
deps = [
":labels_csharp_grpc",
":labels_csharp_proto",
diff --git a/third_party/googleapis/google/apps/drive/labels/v2beta/BUILD.bazel b/third_party/googleapis/google/apps/drive/labels/v2beta/BUILD.bazel
index f2bb1da18..829098b8b 100644
--- a/third_party/googleapis/google/apps/drive/labels/v2beta/BUILD.bazel
+++ b/third_party/googleapis/google/apps/drive/labels/v2beta/BUILD.bazel
@@ -360,6 +360,7 @@ csharp_gapic_library(
grpc_service_config = "drivelabels_v2beta_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "drivelabels_v2beta.yaml",
+ transport = "grpc+rest",
deps = [
":labels_csharp_grpc",
":labels_csharp_proto",
diff --git a/third_party/googleapis/google/apps/market/v2/BUILD.bazel b/third_party/googleapis/google/apps/market/v2/BUILD.bazel
index 639a28593..7d878f070 100644
--- a/third_party/googleapis/google/apps/market/v2/BUILD.bazel
+++ b/third_party/googleapis/google/apps/market/v2/BUILD.bazel
@@ -164,7 +164,8 @@ py_gapic_library(
srcs = [":marketplace_proto"],
grpc_service_config = "service_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "appsmarket_v2.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -201,6 +202,7 @@ php_gapic_library(
srcs = [":marketplace_proto_with_info"],
grpc_service_config = "service_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "appsmarket_v2.yaml",
transport = "grpc+rest",
deps = [
":marketplace_php_grpc",
@@ -258,6 +260,7 @@ ruby_cloud_gapic_library(
],
grpc_service_config = "service_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "appsmarket_v2.yaml",
deps = [
":marketplace_ruby_grpc",
":marketplace_ruby_proto",
@@ -292,6 +295,7 @@ csharp_gapic_library(
grpc_service_config = "service_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "appsmarket_v2.yaml",
+ transport = "grpc+rest",
deps = [
":marketplace_csharp_grpc",
":marketplace_csharp_proto",
diff --git a/third_party/googleapis/google/area120/tables/v1alpha1/BUILD.bazel b/third_party/googleapis/google/area120/tables/v1alpha1/BUILD.bazel
index 5538a550d..5b424024f 100644
--- a/third_party/googleapis/google/area120/tables/v1alpha1/BUILD.bazel
+++ b/third_party/googleapis/google/area120/tables/v1alpha1/BUILD.bazel
@@ -164,6 +164,7 @@ py_gapic_library(
srcs = [":tables_proto"],
grpc_service_config = "tables_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "area120tables_v1alpha1.yaml",
transport = "grpc+rest",
)
@@ -201,6 +202,7 @@ php_gapic_library(
srcs = [":tables_proto_with_info"],
grpc_service_config = "tables_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "area120tables_v1alpha1.yaml",
transport = "grpc+rest",
deps = [
":tables_php_grpc",
@@ -264,6 +266,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Using the Area 120 Tables API, you can query for tables, and update/create/delete rows within tables programmatically.",
ruby_cloud_title = "Area 120 Tables V1alpha1",
+ service_yaml = "area120tables_v1alpha1.yaml",
deps = [
":tables_ruby_grpc",
":tables_ruby_proto",
@@ -298,6 +301,7 @@ csharp_gapic_library(
grpc_service_config = "tables_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "area120tables_v1alpha1.yaml",
+ transport = "grpc+rest",
deps = [
":tables_csharp_grpc",
":tables_csharp_proto",
diff --git a/third_party/googleapis/google/bigtable/admin/v2/BUILD.bazel b/third_party/googleapis/google/bigtable/admin/v2/BUILD.bazel
index e4caac487..33e74530c 100644
--- a/third_party/googleapis/google/bigtable/admin/v2/BUILD.bazel
+++ b/third_party/googleapis/google/bigtable/admin/v2/BUILD.bazel
@@ -181,7 +181,8 @@ py_gapic_library(
"autogen-snippets=False",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "bigtableadmin_v2.yaml",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -249,7 +250,7 @@ nodejs_gapic_library(
package = "google.bigtable.admin.v2",
rest_numeric_enums = True,
service_yaml = "bigtableadmin_v2.yaml",
- transport = "grpc+rest",
+ transport = "grpc",
deps = [],
)
@@ -287,6 +288,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Cloud Bigtable is a fully managed, scalable NoSQL database service for large analytical and operational workloads.",
ruby_cloud_title = "Cloud Bigtable Admin V2",
+ service_yaml = "bigtableadmin_v2.yaml",
deps = [
":admin_ruby_grpc",
":admin_ruby_proto",
@@ -321,6 +323,7 @@ csharp_gapic_library(
grpc_service_config = "bigtableadmin_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "bigtableadmin_v2.yaml",
+ transport = "grpc",
deps = [
":admin_csharp_grpc",
":admin_csharp_proto",
diff --git a/third_party/googleapis/google/bigtable/v2/BUILD.bazel b/third_party/googleapis/google/bigtable/v2/BUILD.bazel
index d27e04bd0..e784969c5 100644
--- a/third_party/googleapis/google/bigtable/v2/BUILD.bazel
+++ b/third_party/googleapis/google/bigtable/v2/BUILD.bazel
@@ -56,6 +56,7 @@ proto_library(
"//google/api:routing_proto",
"//google/rpc:status_proto",
"@com_google_protobuf//:duration_proto",
+ "@com_google_protobuf//:timestamp_proto",
"@com_google_protobuf//:wrappers_proto",
],
)
@@ -165,7 +166,8 @@ py_gapic_library(
"autogen-snippets=False",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "bigtable_v2.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -229,7 +231,7 @@ nodejs_gapic_library(
package = "google.bigtable.v2",
rest_numeric_enums = True,
service_yaml = "bigtable_v2.yaml",
- transport = "grpc+rest",
+ transport = "grpc",
deps = [],
)
@@ -266,6 +268,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Cloud Bigtable is a fully managed, scalable NoSQL database service for large analytical and operational workloads.",
ruby_cloud_title = "Cloud Bigtable V2",
+ service_yaml = "bigtable_v2.yaml",
deps = [
":bigtable_ruby_grpc",
":bigtable_ruby_proto",
diff --git a/third_party/googleapis/google/bigtable/v2/bigtable.proto b/third_party/googleapis/google/bigtable/v2/bigtable.proto
index 955a05611..098d17e3e 100644
--- a/third_party/googleapis/google/bigtable/v2/bigtable.proto
+++ b/third_party/googleapis/google/bigtable/v2/bigtable.proto
@@ -23,6 +23,8 @@ import "google/api/resource.proto";
import "google/api/routing.proto";
import "google/bigtable/v2/data.proto";
import "google/bigtable/v2/request_stats.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
import "google/rpc/status.proto";
@@ -68,9 +70,7 @@ service Bigtable {
field: "table_name"
path_template: "{table_name=projects/*/instances/*/tables/*}"
}
- routing_parameters {
- field: "app_profile_id"
- }
+ routing_parameters { field: "app_profile_id" }
};
option (google.api.method_signature) = "table_name";
option (google.api.method_signature) = "table_name,app_profile_id";
@@ -80,7 +80,8 @@ service Bigtable {
// delimit contiguous sections of the table of approximately equal size,
// which can be used to break up the data for distributed tasks like
// mapreduces.
- rpc SampleRowKeys(SampleRowKeysRequest) returns (stream SampleRowKeysResponse) {
+ rpc SampleRowKeys(SampleRowKeysRequest)
+ returns (stream SampleRowKeysResponse) {
option (google.api.http) = {
get: "/v2/{table_name=projects/*/instances/*/tables/*}:sampleRowKeys"
};
@@ -89,9 +90,7 @@ service Bigtable {
field: "table_name"
path_template: "{table_name=projects/*/instances/*/tables/*}"
}
- routing_parameters {
- field: "app_profile_id"
- }
+ routing_parameters { field: "app_profile_id" }
};
option (google.api.method_signature) = "table_name";
option (google.api.method_signature) = "table_name,app_profile_id";
@@ -109,12 +108,11 @@ service Bigtable {
field: "table_name"
path_template: "{table_name=projects/*/instances/*/tables/*}"
}
- routing_parameters {
- field: "app_profile_id"
- }
+ routing_parameters { field: "app_profile_id" }
};
option (google.api.method_signature) = "table_name,row_key,mutations";
- option (google.api.method_signature) = "table_name,row_key,mutations,app_profile_id";
+ option (google.api.method_signature) =
+ "table_name,row_key,mutations,app_profile_id";
}
// Mutates multiple rows in a batch. Each individual row is mutated
@@ -130,16 +128,15 @@ service Bigtable {
field: "table_name"
path_template: "{table_name=projects/*/instances/*/tables/*}"
}
- routing_parameters {
- field: "app_profile_id"
- }
+ routing_parameters { field: "app_profile_id" }
};
option (google.api.method_signature) = "table_name,entries";
option (google.api.method_signature) = "table_name,entries,app_profile_id";
}
// Mutates a row atomically based on the output of a predicate Reader filter.
- rpc CheckAndMutateRow(CheckAndMutateRowRequest) returns (CheckAndMutateRowResponse) {
+ rpc CheckAndMutateRow(CheckAndMutateRowRequest)
+ returns (CheckAndMutateRowResponse) {
option (google.api.http) = {
post: "/v2/{table_name=projects/*/instances/*/tables/*}:checkAndMutateRow"
body: "*"
@@ -149,12 +146,12 @@ service Bigtable {
field: "table_name"
path_template: "{table_name=projects/*/instances/*/tables/*}"
}
- routing_parameters {
- field: "app_profile_id"
- }
+ routing_parameters { field: "app_profile_id" }
};
- option (google.api.method_signature) = "table_name,row_key,predicate_filter,true_mutations,false_mutations";
- option (google.api.method_signature) = "table_name,row_key,predicate_filter,true_mutations,false_mutations,app_profile_id";
+ option (google.api.method_signature) =
+ "table_name,row_key,predicate_filter,true_mutations,false_mutations";
+ option (google.api.method_signature) =
+ "table_name,row_key,predicate_filter,true_mutations,false_mutations,app_profile_id";
}
// Warm up associated instance metadata for this connection.
@@ -169,9 +166,7 @@ service Bigtable {
field: "name"
path_template: "{name=projects/*/instances/*}"
}
- routing_parameters {
- field: "app_profile_id"
- }
+ routing_parameters { field: "app_profile_id" }
};
option (google.api.method_signature) = "name";
option (google.api.method_signature) = "name,app_profile_id";
@@ -182,7 +177,8 @@ service Bigtable {
// entry based on pre-defined read/modify/write rules. The new value for the
// timestamp is the greater of the existing timestamp or the current server
// time. The method returns the new contents of all modified cells.
- rpc ReadModifyWriteRow(ReadModifyWriteRowRequest) returns (ReadModifyWriteRowResponse) {
+ rpc ReadModifyWriteRow(ReadModifyWriteRowRequest)
+ returns (ReadModifyWriteRowResponse) {
option (google.api.http) = {
post: "/v2/{table_name=projects/*/instances/*/tables/*}:readModifyWriteRow"
body: "*"
@@ -192,12 +188,40 @@ service Bigtable {
field: "table_name"
path_template: "{table_name=projects/*/instances/*/tables/*}"
}
- routing_parameters {
- field: "app_profile_id"
- }
+ routing_parameters { field: "app_profile_id" }
};
option (google.api.method_signature) = "table_name,row_key,rules";
- option (google.api.method_signature) = "table_name,row_key,rules,app_profile_id";
+ option (google.api.method_signature) =
+ "table_name,row_key,rules,app_profile_id";
+ }
+
+ // NOTE: This API is intended to be used by Apache Beam BigtableIO.
+ // Returns the current list of partitions that make up the table's
+ // change stream. The union of partitions will cover the entire keyspace.
+ // Partitions can be read with `ReadChangeStream`.
+ rpc GenerateInitialChangeStreamPartitions(
+ GenerateInitialChangeStreamPartitionsRequest)
+ returns (stream GenerateInitialChangeStreamPartitionsResponse) {
+ option (google.api.http) = {
+ post: "/v2/{table_name=projects/*/instances/*/tables/*}:generateInitialChangeStreamPartitions"
+ body: "*"
+ };
+ option (google.api.method_signature) = "table_name";
+ option (google.api.method_signature) = "table_name,app_profile_id";
+ }
+
+ // NOTE: This API is intended to be used by Apache Beam BigtableIO.
+ // Reads changes from a table's change stream. Changes will
+ // reflect both user-initiated mutations and mutations that are caused by
+ // garbage collection.
+ rpc ReadChangeStream(ReadChangeStreamRequest)
+ returns (stream ReadChangeStreamResponse) {
+ option (google.api.http) = {
+ post: "/v2/{table_name=projects/*/instances/*/tables/*}:readChangeStream"
+ body: "*"
+ };
+ option (google.api.method_signature) = "table_name";
+ option (google.api.method_signature) = "table_name,app_profile_id";
}
}
@@ -388,8 +412,8 @@ message SampleRowKeysResponse {
// Request message for Bigtable.MutateRow.
message MutateRowRequest {
- // Required. The unique name of the table to which the mutation should be applied.
- // Values are of the form
+ // Required. The unique name of the table to which the mutation should be
+ // applied. Values are of the form
// `projects//instances//tables/`.
string table_name = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -405,16 +429,14 @@ message MutateRowRequest {
// Required. The key of the row to which the mutation should be applied.
bytes row_key = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. Changes to be atomically applied to the specified row. Entries are applied
- // in order, meaning that earlier mutations can be masked by later ones.
- // Must contain at least one entry and at most 100000.
+ // Required. Changes to be atomically applied to the specified row. Entries
+ // are applied in order, meaning that earlier mutations can be masked by later
+ // ones. Must contain at least one entry and at most 100000.
repeated Mutation mutations = 3 [(google.api.field_behavior) = REQUIRED];
}
// Response message for Bigtable.MutateRow.
-message MutateRowResponse {
-
-}
+message MutateRowResponse {}
// Request message for BigtableService.MutateRows.
message MutateRowsRequest {
@@ -423,14 +445,14 @@ message MutateRowsRequest {
// The key of the row to which the `mutations` should be applied.
bytes row_key = 1;
- // Required. Changes to be atomically applied to the specified row. Mutations are
- // applied in order, meaning that earlier mutations can be masked by
- // later ones.
- // You must specify at least one mutation.
+ // Required. Changes to be atomically applied to the specified row.
+ // Mutations are applied in order, meaning that earlier mutations can be
+ // masked by later ones. You must specify at least one mutation.
repeated Mutation mutations = 2 [(google.api.field_behavior) = REQUIRED];
}
- // Required. The unique name of the table to which the mutations should be applied.
+ // Required. The unique name of the table to which the mutations should be
+ // applied.
string table_name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -471,9 +493,8 @@ message MutateRowsResponse {
// Request message for Bigtable.CheckAndMutateRow.
message CheckAndMutateRowRequest {
- // Required. The unique name of the table to which the conditional mutation should be
- // applied.
- // Values are of the form
+ // Required. The unique name of the table to which the conditional mutation
+ // should be applied. Values are of the form
// `projects//instances//tables/`.
string table_name = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -486,7 +507,8 @@ message CheckAndMutateRowRequest {
// "default" application profile will be used.
string app_profile_id = 7;
- // Required. The key of the row to which the conditional mutation should be applied.
+ // Required. The key of the row to which the conditional mutation should be
+ // applied.
bytes row_key = 2 [(google.api.field_behavior) = REQUIRED];
// The filter to be applied to the contents of the specified row. Depending
@@ -519,8 +541,9 @@ message CheckAndMutateRowResponse {
// Request message for client connection keep-alive and warming.
message PingAndWarmRequest {
- // Required. The unique name of the instance to check permissions for as well as
- // respond. Values are of the form `projects//instances/`.
+ // Required. The unique name of the instance to check permissions for as well
+ // as respond. Values are of the form
+ // `projects//instances/`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -538,9 +561,8 @@ message PingAndWarmResponse {}
// Request message for Bigtable.ReadModifyWriteRow.
message ReadModifyWriteRowRequest {
- // Required. The unique name of the table to which the read/modify/write rules should be
- // applied.
- // Values are of the form
+ // Required. The unique name of the table to which the read/modify/write rules
+ // should be applied. Values are of the form
// `projects//instances//tables/`.
string table_name = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -553,13 +575,15 @@ message ReadModifyWriteRowRequest {
// "default" application profile will be used.
string app_profile_id = 4;
- // Required. The key of the row to which the read/modify/write rules should be applied.
+ // Required. The key of the row to which the read/modify/write rules should be
+ // applied.
bytes row_key = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. Rules specifying how the specified row's contents are to be transformed
- // into writes. Entries are applied in order, meaning that earlier rules will
- // affect the results of later ones.
- repeated ReadModifyWriteRule rules = 3 [(google.api.field_behavior) = REQUIRED];
+ // Required. Rules specifying how the specified row's contents are to be
+ // transformed into writes. Entries are applied in order, meaning that earlier
+ // rules will affect the results of later ones.
+ repeated ReadModifyWriteRule rules = 3
+ [(google.api.field_behavior) = REQUIRED];
}
// Response message for Bigtable.ReadModifyWriteRow.
@@ -567,3 +591,245 @@ message ReadModifyWriteRowResponse {
// A Row containing the new contents of all cells modified by the request.
Row row = 1;
}
+
+// NOTE: This API is intended to be used by Apache Beam BigtableIO.
+// Request message for Bigtable.GenerateInitialChangeStreamPartitions.
+message GenerateInitialChangeStreamPartitionsRequest {
+ // Required. The unique name of the table from which to get change stream
+ // partitions. Values are of the form
+ // `projects//instances//tables/`.
+ // Change streaming must be enabled on the table.
+ string table_name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "bigtableadmin.googleapis.com/Table"
+ }
+ ];
+
+ // This value specifies routing for replication. If not specified, the
+ // "default" application profile will be used.
+ // Single cluster routing must be configured on the profile.
+ string app_profile_id = 2;
+}
+
+// NOTE: This API is intended to be used by Apache Beam BigtableIO.
+// Response message for Bigtable.GenerateInitialChangeStreamPartitions.
+message GenerateInitialChangeStreamPartitionsResponse {
+ // A partition of the change stream.
+ StreamPartition partition = 1;
+}
+
+// NOTE: This API is intended to be used by Apache Beam BigtableIO.
+// Request message for Bigtable.ReadChangeStream.
+message ReadChangeStreamRequest {
+ // Required. The unique name of the table from which to read a change stream.
+ // Values are of the form
+ // `projects//instances//tables/`.
+ // Change streaming must be enabled on the table.
+ string table_name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "bigtableadmin.googleapis.com/Table"
+ }
+ ];
+
+ // This value specifies routing for replication. If not specified, the
+ // "default" application profile will be used.
+ // Single cluster routing must be configured on the profile.
+ string app_profile_id = 2;
+
+ // The partition to read changes from.
+ StreamPartition partition = 3;
+
+ // Options for describing where we want to start reading from the stream.
+ oneof start_from {
+ // Start reading the stream at the specified timestamp. This timestamp must
+ // be within the change stream retention period, less than or equal to the
+ // current time, and after change stream creation, whichever is greater.
+ // This value is inclusive and will be truncated to microsecond granularity.
+ google.protobuf.Timestamp start_time = 4;
+
+ // Tokens that describe how to resume reading a stream where reading
+ // previously left off. If specified, changes will be read starting at the
+ // the position. Tokens are delivered on the stream as part of `Heartbeat`
+ // and `CloseStream` messages.
+ //
+ // If a single token is provided, the token’s partition must exactly match
+ // the request’s partition. If multiple tokens are provided, as in the case
+ // of a partition merge, the union of the token partitions must exactly
+ // cover the request’s partition. Otherwise, INVALID_ARGUMENT will be
+ // returned.
+ StreamContinuationTokens continuation_tokens = 6;
+ }
+
+ // If specified, OK will be returned when the stream advances beyond
+ // this time. Otherwise, changes will be continuously delivered on the stream.
+ // This value is inclusive and will be truncated to microsecond granularity.
+ google.protobuf.Timestamp end_time = 5;
+
+ // If specified, the duration between `Heartbeat` messages on the stream.
+ // Otherwise, defaults to 5 seconds.
+ google.protobuf.Duration heartbeat_duration = 7;
+}
+
+// NOTE: This API is intended to be used by Apache Beam BigtableIO.
+// Response message for Bigtable.ReadChangeStream.
+message ReadChangeStreamResponse {
+ // A partial or complete mutation.
+ message MutationChunk {
+ // Information about the chunking of this mutation.
+ // Only `SetCell` mutations can be chunked, and all chunks for a `SetCell`
+ // will be delivered contiguously with no other mutation types interleaved.
+ message ChunkInfo {
+ // The total value size of all the chunks that make up the `SetCell`.
+ int32 chunked_value_size = 1;
+
+ // The byte offset of this chunk into the total value size of the
+ // mutation.
+ int32 chunked_value_offset = 2;
+
+ // When true, this is the last chunk of a chunked `SetCell`.
+ bool last_chunk = 3;
+ }
+
+ // If set, then the mutation is a `SetCell` with a chunked value across
+ // multiple messages.
+ ChunkInfo chunk_info = 1;
+
+ // If this is a continuation of a chunked message (`chunked_value_offset` >
+ // 0), ignore all fields except the `SetCell`'s value and merge it with
+ // the previous message by concatenating the value fields.
+ Mutation mutation = 2;
+ }
+
+ // A message corresponding to one or more mutations to the partition
+ // being streamed. A single logical `DataChange` message may also be split
+ // across a sequence of multiple individual messages. Messages other than
+ // the first in a sequence will only have the `type` and `chunks` fields
+ // populated, with the final message in the sequence also containing `done`
+ // set to true.
+ message DataChange {
+ // The type of mutation.
+ enum Type {
+ // The type is unspecified.
+ TYPE_UNSPECIFIED = 0;
+
+ // A user-initiated mutation.
+ USER = 1;
+
+ // A system-initiated mutation as part of garbage collection.
+ // https://cloud.google.com/bigtable/docs/garbage-collection
+ GARBAGE_COLLECTION = 2;
+
+ // This is a continuation of a multi-message change.
+ CONTINUATION = 3;
+ }
+
+ // The type of the mutation.
+ Type type = 1;
+
+ // The cluster where the mutation was applied.
+ // Not set when `type` is `GARBAGE_COLLECTION`.
+ string source_cluster_id = 2;
+
+ // The row key for all mutations that are part of this `DataChange`.
+ // If the `DataChange` is chunked across multiple messages, then this field
+ // will only be set for the first message.
+ bytes row_key = 3;
+
+ // The timestamp at which the mutation was applied on the Bigtable server.
+ google.protobuf.Timestamp commit_timestamp = 4;
+
+ // A value that lets stream consumers reconstruct Bigtable's
+ // conflict resolution semantics.
+ // https://cloud.google.com/bigtable/docs/writes#conflict-resolution
+ // In the event that the same row key, column family, column qualifier,
+ // timestamp are modified on different clusters at the same
+ // `commit_timestamp`, the mutation with the larger `tiebreaker` will be the
+ // one chosen for the eventually consistent state of the system.
+ int32 tiebreaker = 5;
+
+ // The mutations associated with this change to the partition.
+ // May contain complete mutations or chunks of a multi-message chunked
+ // `DataChange` record.
+ repeated MutationChunk chunks = 6;
+
+ // When true, indicates that the entire `DataChange` has been read
+ // and the client can safely process the message.
+ bool done = 8;
+
+ // An encoded position for this stream's partition to restart reading from.
+ // This token is for the StreamPartition from the request.
+ string token = 9;
+
+ // An estimate of the commit timestamp that is usually lower than or equal
+ // to any timestamp for a record that will be delivered in the future on the
+ // stream. It is possible that, under particular circumstances that a future
+ // record has a timestamp is is lower than a previously seen timestamp. For
+ // an example usage see
+ // https://beam.apache.org/documentation/basics/#watermarks
+ google.protobuf.Timestamp estimated_low_watermark = 10;
+ }
+
+ // A periodic message with information that can be used to checkpoint
+ // the state of a stream.
+ message Heartbeat {
+ // A token that can be provided to a subsequent `ReadChangeStream` call
+ // to pick up reading at the current stream position.
+ StreamContinuationToken continuation_token = 1;
+
+ // An estimate of the commit timestamp that is usually lower than or equal
+ // to any timestamp for a record that will be delivered in the future on the
+ // stream. It is possible that, under particular circumstances that a future
+ // record has a timestamp is is lower than a previously seen timestamp. For
+ // an example usage see
+ // https://beam.apache.org/documentation/basics/#watermarks
+ google.protobuf.Timestamp estimated_low_watermark = 2;
+ }
+
+ // A message indicating that the client should stop reading from the stream.
+ // If status is OK and `continuation_tokens` & `new_partitions` are empty, the
+ // stream has finished (for example if there was an `end_time` specified).
+ // If `continuation_tokens` & `new_partitions` are present, then a change in
+ // partitioning requires the client to open a new stream for each token to
+ // resume reading. Example:
+ // [B, D) ends
+ // |
+ // v
+ // new_partitions: [A, C) [C, E)
+ // continuation_tokens.partitions: [B,C) [C,D)
+ // ^---^ ^---^
+ // ^ ^
+ // | |
+ // | StreamContinuationToken 2
+ // |
+ // StreamContinuationToken 1
+ // To read the new partition [A,C), supply the continuation tokens whose
+ // ranges cover the new partition, for example ContinuationToken[A,B) &
+ // ContinuationToken[B,C).
+ message CloseStream {
+ // The status of the stream.
+ google.rpc.Status status = 1;
+
+ // If non-empty, contains the information needed to resume reading their
+ // associated partitions.
+ repeated StreamContinuationToken continuation_tokens = 2;
+
+ // If non-empty, contains the new partitions to start reading from, which
+ // are related to but not necessarily identical to the partitions for the
+ // above `continuation_tokens`.
+ repeated StreamPartition new_partitions = 3;
+ }
+
+ // The data or control message on the stream.
+ oneof stream_record {
+ // A mutation to the partition.
+ DataChange data_change = 1;
+
+ // A periodic heartbeat message.
+ Heartbeat heartbeat = 2;
+
+ // An indication that the stream should be closed.
+ CloseStream close_stream = 3;
+ }
+}
diff --git a/third_party/googleapis/google/bigtable/v2/bigtable_grpc_service_config.json b/third_party/googleapis/google/bigtable/v2/bigtable_grpc_service_config.json
index 9ad691ecf..c8018c92f 100755
--- a/third_party/googleapis/google/bigtable/v2/bigtable_grpc_service_config.json
+++ b/third_party/googleapis/google/bigtable/v2/bigtable_grpc_service_config.json
@@ -58,6 +58,24 @@
"DEADLINE_EXCEEDED"
]
}
+ },
+ {
+ "name": [
+ {
+ "service": "google.bigtable.v2.Bigtable",
+ "method": "GenerateInitialChangeStreamPartitions"
+ }
+ ],
+ "timeout": "60s"
+ },
+ {
+ "name": [
+ {
+ "service": "google.bigtable.v2.Bigtable",
+ "method": "ReadChangeStream"
+ }
+ ],
+ "timeout": "43200s"
}
]
}
diff --git a/third_party/googleapis/google/bigtable/v2/data.proto b/third_party/googleapis/google/bigtable/v2/data.proto
index 9e5a05c2e..1e7d463c7 100644
--- a/third_party/googleapis/google/bigtable/v2/data.proto
+++ b/third_party/googleapis/google/bigtable/v2/data.proto
@@ -486,9 +486,7 @@ message Mutation {
}
// A Mutation which deletes all cells from the containing row.
- message DeleteFromRow {
-
- }
+ message DeleteFromRow {}
// Which of the possible Mutation types to apply.
oneof mutation {
@@ -533,3 +531,30 @@ message ReadModifyWriteRule {
int64 increment_amount = 4;
}
}
+
+// NOTE: This API is intended to be used by Apache Beam BigtableIO.
+// A partition of a change stream.
+message StreamPartition {
+ // The row range covered by this partition and is specified by
+ // [`start_key_closed`, `end_key_open`).
+ RowRange row_range = 1;
+}
+
+// NOTE: This API is intended to be used by Apache Beam BigtableIO.
+// The information required to continue reading the data from multiple
+// `StreamPartitions` from where a previous read left off.
+message StreamContinuationTokens {
+ // List of continuation tokens.
+ repeated StreamContinuationToken tokens = 1;
+}
+
+// NOTE: This API is intended to be used by Apache Beam BigtableIO.
+// The information required to continue reading the data from a
+// `StreamPartition` from where a previous read left off.
+message StreamContinuationToken {
+ // The partition that this token applies to.
+ StreamPartition partition = 1;
+
+ // An encoded position in the stream to restart reading from.
+ string token = 2;
+}
diff --git a/third_party/googleapis/google/chromeos/moblab/v1beta1/BUILD.bazel b/third_party/googleapis/google/chromeos/moblab/v1beta1/BUILD.bazel
index f3f4b2507..5c51db72d 100644
--- a/third_party/googleapis/google/chromeos/moblab/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/chromeos/moblab/v1beta1/BUILD.bazel
@@ -173,7 +173,8 @@ py_gapic_library(
srcs = [":moblab_proto"],
grpc_service_config = "moblab_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "chromeosmoblab_v1beta1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -266,6 +267,7 @@ ruby_cloud_gapic_library(
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-chromeos-moblab-v1beta1"],
grpc_service_config = "moblab_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "chromeosmoblab_v1beta1.yaml",
deps = [
":moblab_ruby_grpc",
":moblab_ruby_proto",
@@ -300,6 +302,7 @@ csharp_gapic_library(
grpc_service_config = "moblab_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "chromeosmoblab_v1beta1.yaml",
+ transport = "grpc+rest",
deps = [
":moblab_csharp_grpc",
":moblab_csharp_proto",
diff --git a/third_party/googleapis/google/chromeos/uidetection/v1/BUILD.bazel b/third_party/googleapis/google/chromeos/uidetection/v1/BUILD.bazel
index 1af86c343..221358d13 100644
--- a/third_party/googleapis/google/chromeos/uidetection/v1/BUILD.bazel
+++ b/third_party/googleapis/google/chromeos/uidetection/v1/BUILD.bazel
@@ -166,7 +166,8 @@ py_gapic_library(
srcs = [":uidetection_proto"],
grpc_service_config = "ui_detection_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "chromeosuidetection_v1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -261,6 +262,7 @@ ruby_cloud_gapic_library(
],
grpc_service_config = "ui_detection_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "chromeosuidetection_v1.yaml",
deps = [
":uidetection_ruby_grpc",
":uidetection_ruby_proto",
@@ -295,6 +297,7 @@ csharp_gapic_library(
grpc_service_config = "ui_detection_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "chromeosuidetection_v1.yaml",
+ transport = "grpc+rest",
deps = [
":uidetection_csharp_grpc",
":uidetection_csharp_proto",
diff --git a/third_party/googleapis/google/chromeos/uidetection/v1/ui_detection.proto b/third_party/googleapis/google/chromeos/uidetection/v1/ui_detection.proto
index e1f593f2c..86570bde0 100644
--- a/third_party/googleapis/google/chromeos/uidetection/v1/ui_detection.proto
+++ b/third_party/googleapis/google/chromeos/uidetection/v1/ui_detection.proto
@@ -44,6 +44,9 @@ message UiDetectionRequest {
// Required. Required field that indicates the detection type.
DetectionRequest request = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Indicates whether to resize the image when detecting.
+ optional bool resize_image = 3;
}
// Detection type specifies what to detect in the image.
@@ -90,6 +93,10 @@ message TextBlockDetectionRequest {
// Levenshtein distance threshold.
// Applicable only if regex_mode is False.
optional int32 max_edit_distance = 4;
+
+ // Indicating whether the detection result should only contain the specified
+ // words.
+ bool specified_words_only = 5;
}
// Detection type for custom icon detection.
diff --git a/third_party/googleapis/google/cloud/accessapproval/v1/BUILD.bazel b/third_party/googleapis/google/cloud/accessapproval/v1/BUILD.bazel
index ce86c6478..5f65da00e 100644
--- a/third_party/googleapis/google/cloud/accessapproval/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/accessapproval/v1/BUILD.bazel
@@ -116,7 +116,7 @@ load(
go_proto_library(
name = "accessapproval_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/accessapproval/v1",
+ importpath = "cloud.google.com/go/accessapproval/apiv1/accessapprovalpb",
protos = [":accessapproval_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -128,6 +128,8 @@ go_gapic_library(
srcs = [":accessapproval_proto_with_info"],
grpc_service_config = "accessapproval_grpc_service_config.json",
importpath = "cloud.google.com/go/accessapproval/apiv1;accessapproval",
+ metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "accessapproval_v1.yaml",
transport = "grpc+rest",
@@ -171,7 +173,8 @@ py_gapic_library(
"warehouse-package-name=google-cloud-access-approval",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "accessapproval_v1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -219,6 +222,7 @@ php_gapic_library(
srcs = [":accessapproval_proto_with_info"],
grpc_service_config = "accessapproval_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "accessapproval_v1.yaml",
transport = "grpc+rest",
deps = [
":accessapproval_php_grpc",
@@ -302,6 +306,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "An API for controlling access to data by Google personnel.",
ruby_cloud_title = "Access Approval V1",
+ service_yaml = "accessapproval_v1.yaml",
deps = [
":accessapproval_ruby_grpc",
":accessapproval_ruby_proto",
@@ -347,6 +352,7 @@ csharp_gapic_library(
grpc_service_config = "accessapproval_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "accessapproval_v1.yaml",
+ transport = "grpc+rest",
deps = [
":accessapproval_csharp_grpc",
":accessapproval_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/accessapproval/v1/accessapproval.proto b/third_party/googleapis/google/cloud/accessapproval/v1/accessapproval.proto
index adeccff45..fae4db7a3 100644
--- a/third_party/googleapis/google/cloud/accessapproval/v1/accessapproval.proto
+++ b/third_party/googleapis/google/cloud/accessapproval/v1/accessapproval.proto
@@ -25,7 +25,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AccessApproval.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/accessapproval/v1;accessapproval";
+option go_package = "cloud.google.com/go/accessapproval/apiv1/accessapprovalpb;accessapprovalpb";
option java_multiple_files = true;
option java_outer_classname = "AccessApprovalProto";
option java_package = "com.google.cloud.accessapproval.v1";
diff --git a/third_party/googleapis/google/cloud/advisorynotifications/BUILD.bazel b/third_party/googleapis/google/cloud/advisorynotifications/BUILD.bazel
new file mode 100644
index 000000000..b3206b378
--- /dev/null
+++ b/third_party/googleapis/google/cloud/advisorynotifications/BUILD.bazel
@@ -0,0 +1,36 @@
+# This build file includes a target for the Ruby wrapper library for
+# google-cloud-advisory_notifications.
+
+# This is an API workspace, having public visibility by default makes perfect sense.
+package(default_visibility = ["//visibility:public"])
+
+# Export yaml configs.
+exports_files(glob(["*.yaml"]))
+
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "ruby_cloud_gapic_library",
+ "ruby_gapic_assembly_pkg",
+)
+
+# Generates a Ruby wrapper client for advisorynotifications.
+# Ruby wrapper clients are versionless, but are generated from source protos
+# for a particular service version, v1 in this case.
+ruby_cloud_gapic_library(
+ name = "advisorynotifications_ruby_wrapper",
+ srcs = ["//google/cloud/advisorynotifications/v1:advisorynotifications_proto_with_info"],
+ extra_protoc_parameters = [
+ "ruby-cloud-gem-name=google-cloud-advisory_notifications",
+ "ruby-cloud-wrapper-of=v1:0.0",
+ ],
+ service_yaml = "//google/cloud/advisorynotifications/v1:advisorynotifications_v1.yaml",
+ transport = "grpc+rest",
+)
+
+# Open Source package.
+ruby_gapic_assembly_pkg(
+ name = "google-cloud-advisorynotifications-ruby",
+ deps = [
+ ":advisorynotifications_ruby_wrapper",
+ ],
+)
diff --git a/third_party/googleapis/google/cloud/advisorynotifications/v1/BUILD.bazel b/third_party/googleapis/google/cloud/advisorynotifications/v1/BUILD.bazel
new file mode 100644
index 000000000..caf248e0b
--- /dev/null
+++ b/third_party/googleapis/google/cloud/advisorynotifications/v1/BUILD.bazel
@@ -0,0 +1,384 @@
+# This file was automatically generated by BuildFileGenerator
+# https://github.com/googleapis/rules_gapic/tree/master/bazel
+
+# Most of the manual changes to this file will be overwritten.
+# It's **only** allowed to change the following rule attribute values:
+# - names of *_gapic_assembly_* rules
+# - certain parameters of *_gapic_library rules, including but not limited to:
+# * extra_protoc_parameters
+# * extra_protoc_file_parameters
+# The complete list of preserved parameters can be found in the source code.
+
+# This is an API workspace, having public visibility by default makes perfect sense.
+package(default_visibility = ["//visibility:public"])
+
+##############################################################################
+# Common
+##############################################################################
+load("@rules_proto//proto:defs.bzl", "proto_library")
+load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
+
+proto_library(
+ name = "advisorynotifications_proto",
+ srcs = [
+ "service.proto",
+ ],
+ deps = [
+ "//google/api:annotations_proto",
+ "//google/api:client_proto",
+ "//google/api:field_behavior_proto",
+ "//google/api:resource_proto",
+ "@com_google_protobuf//:timestamp_proto",
+ ],
+)
+
+proto_library_with_info(
+ name = "advisorynotifications_proto_with_info",
+ deps = [
+ ":advisorynotifications_proto",
+ "//google/cloud:common_resources_proto",
+ ],
+)
+
+##############################################################################
+# Java
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "java_gapic_assembly_gradle_pkg",
+ "java_gapic_library",
+ "java_gapic_test",
+ "java_grpc_library",
+ "java_proto_library",
+)
+
+java_proto_library(
+ name = "advisorynotifications_java_proto",
+ deps = [":advisorynotifications_proto"],
+)
+
+java_grpc_library(
+ name = "advisorynotifications_java_grpc",
+ srcs = [":advisorynotifications_proto"],
+ deps = [":advisorynotifications_java_proto"],
+)
+
+java_gapic_library(
+ name = "advisorynotifications_java_gapic",
+ srcs = [":advisorynotifications_proto_with_info"],
+ gapic_yaml = None,
+ grpc_service_config = "advisorynotifications_v1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "advisorynotifications_v1.yaml",
+ test_deps = [
+ ":advisorynotifications_java_grpc",
+ ],
+ transport = "grpc+rest",
+ deps = [
+ ":advisorynotifications_java_proto",
+ "//google/api:api_java_proto",
+ ],
+)
+
+java_gapic_test(
+ name = "advisorynotifications_java_gapic_test_suite",
+ test_classes = [
+ "com.google.cloud.advisorynotifications.v1.AdvisoryNotificationsServiceClientHttpJsonTest",
+ "com.google.cloud.advisorynotifications.v1.AdvisoryNotificationsServiceClientTest",
+ ],
+ runtime_deps = [":advisorynotifications_java_gapic_test"],
+)
+
+# Open Source Packages
+java_gapic_assembly_gradle_pkg(
+ name = "google-cloud-advisorynotifications-v1-java",
+ include_samples = True,
+ transport = "grpc+rest",
+ deps = [
+ ":advisorynotifications_java_gapic",
+ ":advisorynotifications_java_grpc",
+ ":advisorynotifications_java_proto",
+ ":advisorynotifications_proto",
+ ],
+)
+
+##############################################################################
+# Go
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "go_gapic_assembly_pkg",
+ "go_gapic_library",
+ "go_proto_library",
+ "go_test",
+)
+
+go_proto_library(
+ name = "advisorynotifications_go_proto",
+ compilers = ["@io_bazel_rules_go//proto:go_grpc"],
+ importpath = "cloud.google.com/go/advisorynotifications/apiv1/advisorynotificationspb",
+ protos = [":advisorynotifications_proto"],
+ deps = [
+ "//google/api:annotations_go_proto",
+ ],
+)
+
+go_gapic_library(
+ name = "advisorynotifications_go_gapic",
+ srcs = [":advisorynotifications_proto_with_info"],
+ grpc_service_config = "advisorynotifications_v1_grpc_service_config.json",
+ importpath = "cloud.google.com/go/advisorynotifications/apiv1;advisorynotifications",
+ metadata = True,
+ release_level = "beta",
+ rest_numeric_enums = True,
+ service_yaml = "advisorynotifications_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":advisorynotifications_go_proto",
+ ],
+)
+
+go_test(
+ name = "advisorynotifications_go_gapic_test",
+ srcs = [":advisorynotifications_go_gapic_srcjar_test"],
+ embed = [":advisorynotifications_go_gapic"],
+ importpath = "cloud.google.com/go/advisorynotifications/apiv1",
+)
+
+# Open Source Packages
+go_gapic_assembly_pkg(
+ name = "gapi-cloud-advisorynotifications-v1-go",
+ deps = [
+ ":advisorynotifications_go_gapic",
+ ":advisorynotifications_go_gapic_srcjar-metadata.srcjar",
+ ":advisorynotifications_go_gapic_srcjar-test.srcjar",
+ ":advisorynotifications_go_proto",
+ ],
+)
+
+##############################################################################
+# Python
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "py_gapic_assembly_pkg",
+ "py_gapic_library",
+ "py_test",
+)
+
+py_gapic_library(
+ name = "advisorynotifications_py_gapic",
+ srcs = [":advisorynotifications_proto"],
+ grpc_service_config = "advisorynotifications_v1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "advisorynotifications_v1.yaml",
+ transport = "grpc+rest",
+ deps = [],
+)
+
+py_test(
+ name = "advisorynotifications_py_gapic_test",
+ srcs = [
+ "advisorynotifications_py_gapic_pytest.py",
+ "advisorynotifications_py_gapic_test.py",
+ ],
+ legacy_create_init = False,
+ deps = [":advisorynotifications_py_gapic"],
+)
+
+# Open Source Packages
+py_gapic_assembly_pkg(
+ name = "advisorynotifications-v1-py",
+ deps = [
+ ":advisorynotifications_py_gapic",
+ ],
+)
+
+##############################################################################
+# PHP
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "php_gapic_assembly_pkg",
+ "php_gapic_library",
+ "php_grpc_library",
+ "php_proto_library",
+)
+
+php_proto_library(
+ name = "advisorynotifications_php_proto",
+ deps = [":advisorynotifications_proto"],
+)
+
+php_grpc_library(
+ name = "advisorynotifications_php_grpc",
+ srcs = [":advisorynotifications_proto"],
+ deps = [":advisorynotifications_php_proto"],
+)
+
+php_gapic_library(
+ name = "advisorynotifications_php_gapic",
+ srcs = [":advisorynotifications_proto_with_info"],
+ grpc_service_config = "advisorynotifications_v1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "advisorynotifications_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":advisorynotifications_php_grpc",
+ ":advisorynotifications_php_proto",
+ ],
+)
+
+# Open Source Packages
+php_gapic_assembly_pkg(
+ name = "google-cloud-advisorynotifications-v1-php",
+ deps = [
+ ":advisorynotifications_php_gapic",
+ ":advisorynotifications_php_grpc",
+ ":advisorynotifications_php_proto",
+ ],
+)
+
+##############################################################################
+# Node.js
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "nodejs_gapic_assembly_pkg",
+ "nodejs_gapic_library",
+)
+
+nodejs_gapic_library(
+ name = "advisorynotifications_nodejs_gapic",
+ package_name = "@google-cloud/advisorynotifications",
+ src = ":advisorynotifications_proto_with_info",
+ extra_protoc_parameters = ["metadata"],
+ grpc_service_config = "advisorynotifications_v1_grpc_service_config.json",
+ package = "google.cloud.advisorynotifications.v1",
+ rest_numeric_enums = True,
+ service_yaml = "advisorynotifications_v1.yaml",
+ transport = "grpc+rest",
+ deps = [],
+)
+
+nodejs_gapic_assembly_pkg(
+ name = "advisorynotifications-v1-nodejs",
+ deps = [
+ ":advisorynotifications_nodejs_gapic",
+ ":advisorynotifications_proto",
+ ],
+)
+
+##############################################################################
+# Ruby
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "ruby_cloud_gapic_library",
+ "ruby_gapic_assembly_pkg",
+ "ruby_grpc_library",
+ "ruby_proto_library",
+)
+
+ruby_proto_library(
+ name = "advisorynotifications_ruby_proto",
+ deps = [":advisorynotifications_proto"],
+)
+
+ruby_grpc_library(
+ name = "advisorynotifications_ruby_grpc",
+ srcs = [":advisorynotifications_proto"],
+ deps = [":advisorynotifications_ruby_proto"],
+)
+
+ruby_cloud_gapic_library(
+ name = "advisorynotifications_ruby_gapic",
+ srcs = [":advisorynotifications_proto_with_info"],
+ extra_protoc_parameters = [
+ "ruby-cloud-gem-name=google-cloud-advisory_notifications-v1",
+ ],
+ grpc_service_config = "advisorynotifications_v1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "advisorynotifications_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":advisorynotifications_ruby_grpc",
+ ":advisorynotifications_ruby_proto",
+ ],
+)
+
+# Open Source Packages
+ruby_gapic_assembly_pkg(
+ name = "google-cloud-advisorynotifications-v1-ruby",
+ deps = [
+ ":advisorynotifications_ruby_gapic",
+ ":advisorynotifications_ruby_grpc",
+ ":advisorynotifications_ruby_proto",
+ ],
+)
+
+##############################################################################
+# C#
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "csharp_gapic_assembly_pkg",
+ "csharp_gapic_library",
+ "csharp_grpc_library",
+ "csharp_proto_library",
+)
+
+csharp_proto_library(
+ name = "advisorynotifications_csharp_proto",
+ deps = [":advisorynotifications_proto"],
+)
+
+csharp_grpc_library(
+ name = "advisorynotifications_csharp_grpc",
+ srcs = [":advisorynotifications_proto"],
+ deps = [":advisorynotifications_csharp_proto"],
+)
+
+csharp_gapic_library(
+ name = "advisorynotifications_csharp_gapic",
+ srcs = [":advisorynotifications_proto_with_info"],
+ common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
+ grpc_service_config = "advisorynotifications_v1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "advisorynotifications_v1.yaml",
+ deps = [
+ ":advisorynotifications_csharp_grpc",
+ ":advisorynotifications_csharp_proto",
+ ],
+)
+
+# Open Source Packages
+csharp_gapic_assembly_pkg(
+ name = "google-cloud-advisorynotifications-v1-csharp",
+ deps = [
+ ":advisorynotifications_csharp_gapic",
+ ":advisorynotifications_csharp_grpc",
+ ":advisorynotifications_csharp_proto",
+ ],
+)
+
+##############################################################################
+# C++
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "cc_grpc_library",
+ "cc_proto_library",
+)
+
+cc_proto_library(
+ name = "advisorynotifications_cc_proto",
+ deps = [":advisorynotifications_proto"],
+)
+
+cc_grpc_library(
+ name = "advisorynotifications_cc_grpc",
+ srcs = [":advisorynotifications_proto"],
+ grpc_only = True,
+ deps = [":advisorynotifications_cc_proto"],
+)
diff --git a/third_party/googleapis/google/cloud/advisorynotifications/v1/advisorynotifications_v1.yaml b/third_party/googleapis/google/cloud/advisorynotifications/v1/advisorynotifications_v1.yaml
new file mode 100644
index 000000000..72d62442c
--- /dev/null
+++ b/third_party/googleapis/google/cloud/advisorynotifications/v1/advisorynotifications_v1.yaml
@@ -0,0 +1,68 @@
+type: google.api.Service
+config_version: 3
+name: advisorynotifications.googleapis.com
+title: Advisory Notifications API
+
+apis:
+- name: google.cloud.advisorynotifications.v1.AdvisoryNotificationsService
+
+documentation:
+ summary: An API for accessing Advisory Notifications in Google Cloud
+
+authentication:
+ rules:
+ - selector: google.cloud.advisorynotifications.v1.AdvisoryNotificationsService.GetNotification
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: google.cloud.advisorynotifications.v1.AdvisoryNotificationsService.ListNotifications
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+
+publishing:
+ organization: CLOUD
+ new_issue_uri: 'https://issuetracker.google.com/issues/new?component=1009495'
+ documentation_uri: 'https://cloud.google.com/advisory-notifications/docs/overview'
+ api_short_name: 'advisorynotifications'
+ github_label: 'api: advisorynotifications'
+ doc_tag_prefix: 'advisorynotifications'
+ codeowner_github_teams:
+ library_settings:
+ - version: 'google.cloud.advisorynotifications.v1'
+ launch_stage: GA
+ rest_numeric_enums: false
+ java_settings:
+ library_package: ''
+ service_class_names:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ cpp_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ php_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ python_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ node_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ dotnet_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ ruby_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ go_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
diff --git a/third_party/googleapis/google/cloud/advisorynotifications/v1/advisorynotifications_v1_grpc_service_config.json b/third_party/googleapis/google/cloud/advisorynotifications/v1/advisorynotifications_v1_grpc_service_config.json
new file mode 100644
index 000000000..b221a89a6
--- /dev/null
+++ b/third_party/googleapis/google/cloud/advisorynotifications/v1/advisorynotifications_v1_grpc_service_config.json
@@ -0,0 +1,16 @@
+{
+ "methodConfig": [{
+ "name": [
+ { "service": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService", "method": "ListNotifications" },
+ { "service": "google.cloud.advisorynotifications.v1.AdvisoryNotificationsService", "method": "GetNotification" }
+ ],
+ "timeout": "60s",
+ "retryPolicy": {
+ "maxAttempts": 5,
+ "initialBackoff": "1s",
+ "maxBackoff": "10s",
+ "backoffMultiplier": 1.3,
+ "retryableStatusCodes": ["UNAVAILABLE"]
+ }
+ }]
+}
\ No newline at end of file
diff --git a/third_party/googleapis/google/cloud/advisorynotifications/v1/service.proto b/third_party/googleapis/google/cloud/advisorynotifications/v1/service.proto
new file mode 100644
index 000000000..05b53b394
--- /dev/null
+++ b/third_party/googleapis/google/cloud/advisorynotifications/v1/service.proto
@@ -0,0 +1,253 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.advisorynotifications.v1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.AdvisoryNotifications.V1";
+option go_package = "cloud.google.com/go/advisorynotifications/apiv1/advisorynotificationspb;advisorynotificationspb";
+option php_namespace = "Google\\Cloud\\AdvisoryNotifications\\V1";
+option ruby_package = "Google::Cloud::AdvisoryNotifications::V1";
+option java_multiple_files = true;
+option java_outer_classname = "ServiceProto";
+option java_package = "com.google.cloud.advisorynotifications.v1";
+option (google.api.resource_definition) = {
+ type: "advisorynotifications.googleapis.com/Location"
+ pattern: "organizations/{organization}/locations/{location}"
+};
+
+// Service to manage Security and Privacy Notifications.
+service AdvisoryNotificationsService {
+ option (google.api.default_host) = "advisorynotifications.googleapis.com";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
+
+ // Lists notifications under a given parent.
+ rpc ListNotifications(ListNotificationsRequest)
+ returns (ListNotificationsResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=organizations/*/locations/*}/notifications"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Gets a notification.
+ rpc GetNotification(GetNotificationRequest) returns (Notification) {
+ option (google.api.http) = {
+ get: "/v1/{name=organizations/*/locations/*/notifications/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+}
+
+// Notification view.
+enum NotificationView {
+ // Not specified, equivalent to BASIC.
+ NOTIFICATION_VIEW_UNSPECIFIED = 0;
+
+ // Server responses only include title, creation time and Notification ID.
+ // Note: for internal use responses also include the last update time,
+ // the latest message text and whether notification has attachments.
+ BASIC = 1;
+
+ // Include everything.
+ FULL = 2;
+}
+
+// Status of localized text.
+enum LocalizationState {
+ // Not used.
+ LOCALIZATION_STATE_UNSPECIFIED = 0;
+
+ // Localization is not applicable for requested language. This can happen
+ // when:
+ // - The requested language was not supported by Advisory Notifications at the
+ // time of localization (including notifications created before the
+ // localization feature was launched).
+ // - The requested language is English, so only the English text is returned.
+ LOCALIZATION_STATE_NOT_APPLICABLE = 1;
+
+ // Localization for requested language is in progress, and not ready yet.
+ LOCALIZATION_STATE_PENDING = 2;
+
+ // Localization for requested language is completed.
+ LOCALIZATION_STATE_COMPLETED = 3;
+}
+
+// A notification object for notifying customers about security and privacy
+// issues.
+message Notification {
+ option (google.api.resource) = {
+ type: "advisorynotifications.googleapis.com/Notification"
+ pattern: "organizations/{organization}/locations/{location}/notifications/{notification}"
+ };
+
+ // The resource name of the notification.
+ // Format:
+ // organizations/{organization}/locations/{location}/notifications/{notification}.
+ string name = 1;
+
+ // The subject line of the notification.
+ Subject subject = 2;
+
+ // A list of messages in the notification.
+ repeated Message messages = 3;
+
+ // Output only. Time the notification was created.
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// A text object containing the English text and its localized copies.
+message Text {
+ // The English copy.
+ string en_text = 1;
+
+ // The requested localized copy (if applicable).
+ string localized_text = 2;
+
+ // Status of the localization.
+ LocalizationState localization_state = 3;
+}
+
+// A subject line of a notification.
+message Subject {
+ // The text content.
+ Text text = 1;
+}
+
+// A message which contains notification details.
+message Message {
+ // A message body containing text.
+ message Body {
+ // The text content of the message body.
+ Text text = 1;
+ }
+
+ // The message content.
+ Body body = 1;
+
+ // The attachments to download.
+ repeated Attachment attachments = 2;
+
+ // The Message creation timestamp.
+ google.protobuf.Timestamp create_time = 3;
+
+ // Time when Message was localized
+ google.protobuf.Timestamp localization_time = 4;
+}
+
+// Attachment with specific information about the issue.
+message Attachment {
+ // Data type of the attachment.
+ oneof data {
+ // A CSV file attachment. Max size is 10 MB.
+ Csv csv = 2;
+ }
+
+ // The title of the attachment.
+ string display_name = 1;
+}
+
+// A representation of a CSV file attachment, as a list of column headers and
+// a list of data rows.
+message Csv {
+ // A representation of a single data row in a CSV file.
+ message CsvRow {
+ // The data entries in a CSV file row, as a string array rather than a
+ // single comma-separated string.
+ repeated string entries = 1;
+ }
+
+ // The list of headers for data columns in a CSV file.
+ repeated string headers = 1;
+
+ // The list of data rows in a CSV file, as string arrays rather than as a
+ // single comma-separated string.
+ repeated CsvRow data_rows = 2;
+}
+
+// Request for fetching all notifications for a given parent.
+message ListNotificationsRequest {
+ // Required. The parent, which owns this collection of notifications.
+ // Must be of the form "organizations/{organization}/locations/{location}".
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "advisorynotifications.googleapis.com/Notification"
+ }
+ ];
+
+ // The maximum number of notifications to return. The service may return
+ // fewer than this value. If unspecified or equal to 0, at most 50
+ // notifications will be returned. The maximum value is 50; values above 50
+ // will be coerced to 50.
+ int32 page_size = 2;
+
+ // A page token returned from a previous request.
+ // When paginating, all other parameters provided in the request
+ // must match the call that returned the page token.
+ string page_token = 3;
+
+ // Specifies which parts of the notification resource should be returned
+ // in the response.
+ NotificationView view = 4;
+
+ // ISO code for requested localization language. If unset, will be
+ // interpereted as "en". If the requested language is valid, but not supported
+ // for this notification, English will be returned with an "Not applicable"
+ // LocalizationState. If the ISO code is invalid (i.e. not a real language),
+ // this RPC will throw an error.
+ string language_code = 5;
+}
+
+// Response of ListNotifications endpoint.
+message ListNotificationsResponse {
+ // List of notifications under a given parent.
+ repeated Notification notifications = 1;
+
+ // A token, which can be sent as `page_token` to retrieve the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
+
+ // Estimation of a total number of notifications.
+ int32 total_size = 3;
+}
+
+// Request for fetching a notification.
+message GetNotificationRequest {
+ // Required. A name of the notification to retrieve.
+ // Format:
+ // organizations/{organization}/locations/{location}/notifications/{notification}.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "advisorynotifications.googleapis.com/Notification"
+ }
+ ];
+
+ // ISO code for requested localization language. If unset, will be
+ // interpereted as "en". If the requested language is valid, but not supported
+ // for this notification, English will be returned with an "Not applicable"
+ // LocalizationState. If the ISO code is invalid (i.e. not a real language),
+ // this RPC will throw an error.
+ string language_code = 5;
+}
diff --git a/third_party/googleapis/google/cloud/aiplatform/logging/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/logging/BUILD.bazel
index a4e031b01..350160bd3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/logging/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/logging/BUILD.bazel
@@ -49,7 +49,7 @@ load(
go_proto_library(
name = "logging_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/logging",
+ importpath = "cloud.google.com/go/aiplatform/logging/loggingpb",
protos = [":logging_proto"],
deps = [
"//google/rpc:status_go_proto",
diff --git a/third_party/googleapis/google/cloud/aiplatform/logging/prediction.proto b/third_party/googleapis/google/cloud/aiplatform/logging/prediction.proto
index 037b51c87..6a15a1554 100644
--- a/third_party/googleapis/google/cloud/aiplatform/logging/prediction.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/logging/prediction.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.logging;
import "google/rpc/status.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/logging;logging";
+option go_package = "cloud.google.com/go/aiplatform/logging/loggingpb;loggingpb";
option java_multiple_files = true;
option java_outer_classname = "PredictionProto";
option java_package = "com.google.cloud.aiplatform.logging";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/v1/BUILD.bazel
index a2b2c4da6..bf6eabd2f 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/BUILD.bazel
@@ -47,6 +47,7 @@ proto_library(
"endpoint_service.proto",
"entity_type.proto",
"env_var.proto",
+ "evaluated_annotation.proto",
"event.proto",
"execution.proto",
"explanation.proto",
@@ -80,6 +81,7 @@ proto_library(
"model_evaluation_slice.proto",
"model_monitoring.proto",
"model_service.proto",
+ "nas_job.proto",
"operation.proto",
"pipeline_failure_policy.proto",
"pipeline_job.proto",
@@ -87,6 +89,7 @@ proto_library(
"pipeline_state.proto",
"prediction_service.proto",
"saved_query.proto",
+ "service_networking.proto",
"specialist_pool.proto",
"specialist_pool_service.proto",
"study.proto",
@@ -111,6 +114,7 @@ proto_library(
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"//google/rpc:status_proto",
+ "//google/type:interval_proto",
"//google/type:money_proto",
"@com_google_protobuf//:duration_proto",
"@com_google_protobuf//:empty_proto",
@@ -237,13 +241,14 @@ load(
go_proto_library(
name = "aiplatform_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1",
+ importpath = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb",
protos = [":aiplatform_proto"],
deps = [
"//google/api:annotations_go_proto",
"//google/api:httpbody_go_proto",
"//google/longrunning:longrunning_go_proto",
"//google/rpc:status_go_proto",
+ "//google/type:interval_go_proto",
"//google/type:money_go_proto",
],
)
@@ -254,6 +259,7 @@ go_gapic_library(
grpc_service_config = "aiplatform_grpc_service_config.json",
importpath = "cloud.google.com/go/aiplatform/apiv1;aiplatform",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = False,
service_yaml = "aiplatform_v1.yaml",
transport = "grpc",
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/accelerator_type.proto b/third_party/googleapis/google/cloud/aiplatform/v1/accelerator_type.proto
index 726ec203d..38682297e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/accelerator_type.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/accelerator_type.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "AcceleratorTypeProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -25,6 +25,7 @@ option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
option ruby_package = "Google::Cloud::AIPlatform::V1";
// Represents a hardware accelerator type.
+// NEXT ID: 11.
enum AcceleratorType {
// Unspecified accelerator type, which means no accelerator.
ACCELERATOR_TYPE_UNSPECIFIED = 0;
@@ -52,4 +53,7 @@ enum AcceleratorType {
// TPU v3.
TPU_V3 = 7;
+
+ // TPU v4.
+ TPU_V4_POD = 10;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/aiplatform_v1.yaml b/third_party/googleapis/google/cloud/aiplatform/v1/aiplatform_v1.yaml
index 049ab20b6..7677d9d0a 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/aiplatform_v1.yaml
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/aiplatform_v1.yaml
@@ -32,6 +32,8 @@ types:
- name: google.cloud.aiplatform.v1.BatchReadFeatureValuesResponse
- name: google.cloud.aiplatform.v1.CheckTrialEarlyStoppingStateMetatdata
- name: google.cloud.aiplatform.v1.CheckTrialEarlyStoppingStateResponse
+- name: google.cloud.aiplatform.v1.CopyModelOperationMetadata
+- name: google.cloud.aiplatform.v1.CopyModelResponse
- name: google.cloud.aiplatform.v1.CreateDatasetOperationMetadata
- name: google.cloud.aiplatform.v1.CreateEndpointOperationMetadata
- name: google.cloud.aiplatform.v1.CreateEntityTypeOperationMetadata
@@ -42,6 +44,8 @@ types:
- name: google.cloud.aiplatform.v1.CreateMetadataStoreOperationMetadata
- name: google.cloud.aiplatform.v1.CreateSpecialistPoolOperationMetadata
- name: google.cloud.aiplatform.v1.CreateTensorboardOperationMetadata
+- name: google.cloud.aiplatform.v1.DeleteFeatureValuesOperationMetadata
+- name: google.cloud.aiplatform.v1.DeleteFeatureValuesResponse
- name: google.cloud.aiplatform.v1.DeleteMetadataStoreOperationMetadata
- name: google.cloud.aiplatform.v1.DeleteOperationMetadata
- name: google.cloud.aiplatform.v1.DeployIndexOperationMetadata
@@ -181,18 +185,26 @@ http:
additional_bindings:
- get: '/v1/{name=projects/*}/locations'
- selector: google.iam.v1.IAMPolicy.GetIamPolicy
- post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy'
+ post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy'
additional_bindings:
+ - post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy'
+ - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy'
- post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy'
- selector: google.iam.v1.IAMPolicy.SetIamPolicy
- post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy'
+ post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy'
body: '*'
additional_bindings:
+ - post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy'
+ body: '*'
+ - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy'
+ body: '*'
- post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy'
body: '*'
- selector: google.iam.v1.IAMPolicy.TestIamPermissions
- post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions'
+ post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions'
additional_bindings:
+ - post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions'
+ - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions'
- post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions'
- selector: google.longrunning.Operations.CancelOperation
post: '/ui/{name=projects/*/locations/*/operations/*}:cancel'
@@ -221,6 +233,7 @@ http:
- post: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel'
+ - post: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}:cancel'
@@ -282,6 +295,7 @@ http:
- delete: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}'
+ - delete: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}'
@@ -344,6 +358,7 @@ http:
- get: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}'
+ - get: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}'
@@ -405,6 +420,7 @@ http:
- get: '/ui/{name=projects/*/locations/*/studies/*/trials/*}/operations'
- get: '/ui/{name=projects/*/locations/*/trainingPipelines/*}/operations'
- get: '/ui/{name=projects/*/locations/*/pipelineJobs/*}/operations'
+ - get: '/ui/{name=projects/*/locations/*/schedules/*}/operations'
- get: '/ui/{name=projects/*/locations/*/specialistPools/*}/operations'
- get: '/ui/{name=projects/*/locations/*/tensorboards/*}/operations'
- get: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*}/operations'
@@ -466,6 +482,7 @@ http:
- post: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait'
+ - post: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}:wait'
@@ -531,6 +548,11 @@ authentication:
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
+ - selector: google.cloud.aiplatform.v1.JobService.GetNasJob
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform,
+ https://www.googleapis.com/auth/cloud-platform.read-only
- selector: 'google.cloud.aiplatform.v1.MetadataService.*'
oauth:
canonical_scopes: |-
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/annotation.proto b/third_party/googleapis/google/cloud/aiplatform/v1/annotation.proto
index 3a1048090..98ac15345 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/annotation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/annotation.proto
@@ -23,7 +23,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "AnnotationProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -41,8 +41,9 @@ message Annotation {
// Output only. Resource name of the Annotation.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. Google Cloud Storage URI points to a YAML file describing [payload][google.cloud.aiplatform.v1.Annotation.payload]. The
- // schema is defined as an [OpenAPI 3.0.2 Schema
+ // Required. Google Cloud Storage URI points to a YAML file describing
+ // [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is
+ // defined as an [OpenAPI 3.0.2 Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
// The schema files that can be used here are found in
// gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the
@@ -55,19 +56,23 @@ message Annotation {
google.protobuf.Value payload = 3 [(google.api.field_behavior) = REQUIRED];
// Output only. Timestamp when this Annotation was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Annotation was last updated.
- google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. Used to perform consistent read-modify-write updates. If not set, a blind
- // "overwrite" update happens.
+ // Optional. Used to perform consistent read-modify-write updates. If not set,
+ // a blind "overwrite" update happens.
string etag = 8 [(google.api.field_behavior) = OPTIONAL];
// Output only. The source of the Annotation.
- UserActionReference annotation_source = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ UserActionReference annotation_source = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. The labels with user-defined metadata to organize your Annotations.
+ // Optional. The labels with user-defined metadata to organize your
+ // Annotations.
//
// Label keys and values can be no longer than 64 characters
// (Unicode codepoints), can only contain lowercase letters, numeric
@@ -84,7 +89,8 @@ message Annotation {
// If not set, the Annotation is not visible in the UI.
//
// * "aiplatform.googleapis.com/payload_schema":
- // output only, its value is the [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
+ // output only, its value is the
+ // [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
// title.
map labels = 6 [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/annotation_spec.proto b/third_party/googleapis/google/cloud/aiplatform/v1/annotation_spec.proto
index 582eb109b..0a715556c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/annotation_spec.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/annotation_spec.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "AnnotationSpecProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -44,12 +44,14 @@ message AnnotationSpec {
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
// Output only. Timestamp when this AnnotationSpec was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when AnnotationSpec was last updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. Used to perform consistent read-modify-write updates. If not set, a blind
- // "overwrite" update happens.
+ // Optional. Used to perform consistent read-modify-write updates. If not set,
+ // a blind "overwrite" update happens.
string etag = 5 [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/artifact.proto b/third_party/googleapis/google/cloud/aiplatform/v1/artifact.proto
index be52fcc63..bdadc2d75 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/artifact.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/artifact.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ArtifactProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -75,10 +75,12 @@ message Artifact {
map labels = 10;
// Output only. Timestamp when this Artifact was created.
- google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Artifact was last updated.
- google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The state of this Artifact. This is a property of the Artifact, and does
// not imply or capture any ongoing process. This property is managed by
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/batch_prediction_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1/batch_prediction_job.proto
index 4673b09fd..74fc97a4f 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/batch_prediction_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/batch_prediction_job.proto
@@ -31,15 +31,17 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "BatchPredictionJobProto";
option java_package = "com.google.cloud.aiplatform.v1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
option ruby_package = "Google::Cloud::AIPlatform::V1";
-// A job that uses a [Model][google.cloud.aiplatform.v1.BatchPredictionJob.model] to produce predictions
-// on multiple [input instances][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If
+// A job that uses a
+// [Model][google.cloud.aiplatform.v1.BatchPredictionJob.model] to produce
+// predictions on multiple [input
+// instances][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If
// predictions for significant portion of the instances fail, the job may finish
// without attempting predictions for all remaining instances.
message BatchPredictionJob {
@@ -48,9 +50,11 @@ message BatchPredictionJob {
pattern: "projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}"
};
- // Configures the input to [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
- // See [Model.supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] for Model's supported input
- // formats, and how instances should be expressed via any of them.
+ // Configures the input to
+ // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. See
+ // [Model.supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats]
+ // for Model's supported input formats, and how instances should be expressed
+ // via any of them.
message InputConfig {
// Required. The source of the input.
oneof source {
@@ -71,9 +75,109 @@ message BatchPredictionJob {
string instances_format = 1 [(google.api.field_behavior) = REQUIRED];
}
- // Configures the output of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
- // See [Model.supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats] for supported output
- // formats, and how predictions are expressed via any of them.
+ // Configuration defining how to transform batch prediction input instances to
+ // the instances that the Model accepts.
+ message InstanceConfig {
+ // The format of the instance that the Model accepts. Vertex AI will
+ // convert compatible
+ // [batch prediction input instance
+ // formats][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.instances_format]
+ // to the specified format.
+ //
+ // Supported values are:
+ //
+ // * `object`: Each input is converted to JSON object format.
+ // * For `bigquery`, each row is converted to an object.
+ // * For `jsonl`, each line of the JSONL input must be an object.
+ // * Does not apply to `csv`, `file-list`, `tf-record`, or
+ // `tf-record-gzip`.
+ //
+ // * `array`: Each input is converted to JSON array format.
+ // * For `bigquery`, each row is converted to an array. The order
+ // of columns is determined by the BigQuery column order, unless
+ // [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
+ // is populated.
+ // [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
+ // must be populated for specifying field orders.
+ // * For `jsonl`, if each line of the JSONL input is an object,
+ // [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
+ // must be populated for specifying field orders.
+ // * Does not apply to `csv`, `file-list`, `tf-record`, or
+ // `tf-record-gzip`.
+ //
+ // If not specified, Vertex AI converts the batch prediction input as
+ // follows:
+ //
+ // * For `bigquery` and `csv`, the behavior is the same as `array`. The
+ // order of columns is the same as defined in the file or table, unless
+ // [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
+ // is populated.
+ // * For `jsonl`, the prediction instance format is determined by
+ // each line of the input.
+ // * For `tf-record`/`tf-record-gzip`, each record will be converted to
+ // an object in the format of `{"b64": }`, where `` is
+ // the Base64-encoded string of the content of the record.
+ // * For `file-list`, each file in the list will be converted to an
+ // object in the format of `{"b64": }`, where `` is
+ // the Base64-encoded string of the content of the file.
+ string instance_type = 1;
+
+ // The name of the field that is considered as a key.
+ //
+ // The values identified by the key field is not included in the transformed
+ // instances that is sent to the Model. This is similar to
+ // specifying this name of the field in
+ // [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields].
+ // In addition, the batch prediction output will not include the instances.
+ // Instead the output will only include the value of the key field, in a
+ // field named `key` in the output:
+ //
+ // * For `jsonl` output format, the output will have a `key` field
+ // instead of the `instance` field.
+ // * For `csv`/`bigquery` output format, the output will have have a `key`
+ // column instead of the instance feature columns.
+ //
+ // The input must be JSONL with objects at each line, CSV, BigQuery
+ // or TfRecord.
+ string key_field = 2;
+
+ // Fields that will be included in the prediction instance that is
+ // sent to the Model.
+ //
+ // If
+ // [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type]
+ // is `array`, the order of field names in included_fields also determines
+ // the order of the values in the array.
+ //
+ // When included_fields is populated,
+ // [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields]
+ // must be empty.
+ //
+ // The input must be JSONL with objects at each line, CSV, BigQuery
+ // or TfRecord.
+ repeated string included_fields = 3;
+
+ // Fields that will be excluded in the prediction instance that is
+ // sent to the Model.
+ //
+ // Excluded will be attached to the batch prediction output if
+ // [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field]
+ // is not specified.
+ //
+ // When excluded_fields is populated,
+ // [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
+ // must be empty.
+ //
+ // The input must be JSONL with objects at each line, CSV, BigQuery
+ // or TfRecord.
+ repeated string excluded_fields = 4;
+ }
+
+ // Configures the output of
+ // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. See
+ // [Model.supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats]
+ // for supported output formats, and how predictions are expressed via any of
+ // them.
message OutputConfig {
// Required. The destination of the output.
oneof destination {
@@ -84,11 +188,13 @@ message BatchPredictionJob {
// Inside of it files `predictions_0001.`,
// `predictions_0002.`, ..., `predictions_N.`
// are created where `` depends on chosen
- // [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format], and N may equal 0001 and depends on the total
- // number of successfully predicted instances.
- // If the Model has both [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
- // and [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri] schemata
- // defined then each such file contains predictions as per the
+ // [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format],
+ // and N may equal 0001 and depends on the total number of successfully
+ // predicted instances. If the Model has both
+ // [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
+ // and
+ // [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
+ // schemata defined then each such file contains predictions as per the
// [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format].
// If prediction for any instance failed (partially or completely), then
// an additional `errors_0001.`, `errors_0002.`,...,
@@ -107,45 +213,51 @@ message BatchPredictionJob {
// become underscores), and timestamp is in
// YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset
// two tables will be created, `predictions`, and `errors`.
- // If the Model has both [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
- // and [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri] schemata
- // defined then the tables have columns as follows: The `predictions`
- // table contains instances for which the prediction succeeded, it
- // has columns as per a concatenation of the Model's instance and
- // prediction schemata. The `errors` table contains rows for which the
- // prediction has failed, it has instance columns, as per the
+ // If the Model has both
+ // [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
+ // and
+ // [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
+ // schemata defined then the tables have columns as follows: The
+ // `predictions` table contains instances for which the prediction
+ // succeeded, it has columns as per a concatenation of the Model's
+ // instance and prediction schemata. The `errors` table contains rows for
+ // which the prediction has failed, it has instance columns, as per the
// instance schema, followed by a single "errors" column, which as values
// has [google.rpc.Status][google.rpc.Status]
// represented as a STRUCT, and containing only `code` and `message`.
BigQueryDestination bigquery_destination = 3;
}
- // Required. The format in which Vertex AI gives the predictions, must be one of the
- // [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
+ // Required. The format in which Vertex AI gives the predictions, must be
+ // one of the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
// [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
string predictions_format = 1 [(google.api.field_behavior) = REQUIRED];
}
// Further describes this job's output.
- // Supplements [output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
+ // Supplements
+ // [output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
message OutputInfo {
// The output location into which prediction output is written.
oneof output_location {
- // Output only. The full path of the Cloud Storage directory created, into which
- // the prediction output is written.
- string gcs_output_directory = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The full path of the Cloud Storage directory created, into
+ // which the prediction output is written.
+ string gcs_output_directory = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The path of the BigQuery dataset created, in
// `bq://projectId.bqDatasetId`
// format, into which the prediction output is written.
- string bigquery_output_dataset = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ string bigquery_output_dataset = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. The name of the BigQuery table created, in
// `predictions_`
// format, into which the prediction output is written.
// Can be used by UI to generate the BigQuery output path, for example.
- string bigquery_output_table = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ string bigquery_output_table = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. Resource name of the BatchPredictionJob.
@@ -161,12 +273,17 @@ message BatchPredictionJob {
// Exactly one of model and unmanaged_container_model must be set.
//
// The model resource name may contain version id or version alias to specify
- // the version, if no version is specified, the default version will be used.
+ // the version.
+ // Example: `projects/{project}/locations/{location}/models/{model}@2`
+ // or
+ // `projects/{project}/locations/{location}/models/{model}@golden`
+ // if no version is specified, the default version will be deployed.
string model = 3 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Model"
- }];
+ type: "aiplatform.googleapis.com/Model"
+ }];
- // Output only. The version ID of the Model that produces the predictions via this job.
+ // Output only. The version ID of the Model that produces the predictions via
+ // this job.
string model_version_id = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
// Contains model information necessary to perform batch prediction without
@@ -174,15 +291,20 @@ message BatchPredictionJob {
// Exactly one of model and unmanaged_container_model must be set.
UnmanagedContainerModel unmanaged_container_model = 28;
- // Required. Input configuration of the instances on which predictions are performed.
- // The schema of any single instance may be specified via
- // the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
+ // Required. Input configuration of the instances on which predictions are
+ // performed. The schema of any single instance may be specified via the
+ // [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
InputConfig input_config = 4 [(google.api.field_behavior) = REQUIRED];
+ // Configuration for how to convert batch prediction input instances to the
+ // prediction instances that are sent to the Model.
+ InstanceConfig instance_config = 27;
+
// The parameters that govern the predictions. The schema of the parameters
- // may be specified via the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
+ // may be specified via the
+ // [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
// [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
google.protobuf.Value model_parameters = 5;
@@ -198,7 +320,8 @@ message BatchPredictionJob {
OutputConfig output_config = 6 [(google.api.field_behavior) = REQUIRED];
// The config of resources used by the Model during the batch prediction. If
- // the Model [supports][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types]
+ // the Model
+ // [supports][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types]
// DEDICATED_RESOURCES this config may be provided (and the job will use these
// resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config
// must be provided.
@@ -213,35 +336,50 @@ message BatchPredictionJob {
// permission on this service account.
string service_account = 29;
- // Immutable. Parameters configuring the batch behavior. Currently only applicable when
- // [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.dedicated_resources] are used (in other cases Vertex AI does
- // the tuning itself).
- ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. Parameters configuring the batch behavior. Currently only
+ // applicable when
+ // [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.dedicated_resources]
+ // are used (in other cases Vertex AI does the tuning itself).
+ ManualBatchTuningParameters manual_batch_tuning_parameters = 8
+ [(google.api.field_behavior) = IMMUTABLE];
// Generate explanation with the batch prediction results.
//
// When set to `true`, the batch prediction output changes based on the
// `predictions_format` field of the
- // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config] object:
+ // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]
+ // object:
//
// * `bigquery`: output includes a column named `explanation`. The value
- // is a struct that conforms to the [Explanation][google.cloud.aiplatform.v1.Explanation] object.
+ // is a struct that conforms to the
+ // [Explanation][google.cloud.aiplatform.v1.Explanation] object.
// * `jsonl`: The JSON objects on each line include an additional entry
// keyed `explanation`. The value of the entry is a JSON object that
- // conforms to the [Explanation][google.cloud.aiplatform.v1.Explanation] object.
+ // conforms to the [Explanation][google.cloud.aiplatform.v1.Explanation]
+ // object.
// * `csv`: Generating explanations for CSV format is not supported.
//
- // If this field is set to true, either the [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] or
- // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] must be populated.
+ // If this field is set to true, either the
+ // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
+ // or
+ // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
+ // must be populated.
bool generate_explanation = 23;
// Explanation configuration for this BatchPredictionJob. Can be
- // specified only if [generate_explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] is set to `true`.
+ // specified only if
+ // [generate_explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
+ // is set to `true`.
//
- // This value overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]. All fields of
- // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] are optional in the request. If a field of the
- // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] object is not populated, the corresponding field of
- // the [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] object is inherited.
+ // This value overrides the value of
+ // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
+ // All fields of
+ // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
+ // are optional in the request. If a field of the
+ // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
+ // object is not populated, the corresponding field of the
+ // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
+ // object is inherited.
ExplanationSpec explanation_spec = 25;
// Output only. Information further describing the output of this job.
@@ -258,32 +396,39 @@ message BatchPredictionJob {
// For example, single files that can't be read.
// This field never exceeds 20 entries.
// Status details fields contain standard Google Cloud error details.
- repeated google.rpc.Status partial_failures = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.rpc.Status partial_failures = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Information about resources that had been consumed by this job.
- // Provided in real time at best effort basis, as well as a final value
+ // Output only. Information about resources that had been consumed by this
+ // job. Provided in real time at best effort basis, as well as a final value
// once the job completes.
//
// Note: This field currently may be not populated for batch predictions that
// use AutoML Models.
- ResourcesConsumed resources_consumed = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ ResourcesConsumed resources_consumed = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Statistics on completed and failed prediction instances.
- CompletionStats completion_stats = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ CompletionStats completion_stats = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the BatchPredictionJob was created.
- google.protobuf.Timestamp create_time = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Time when the BatchPredictionJob for the first time entered the
- // `JOB_STATE_RUNNING` state.
- google.protobuf.Timestamp start_time = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Time when the BatchPredictionJob for the first time entered
+ // the `JOB_STATE_RUNNING` state.
+ google.protobuf.Timestamp start_time = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Time when the BatchPredictionJob entered any of the following states:
- // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
- google.protobuf.Timestamp end_time = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Time when the BatchPredictionJob entered any of the following
+ // states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
+ google.protobuf.Timestamp end_time = 17
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the BatchPredictionJob was most recently updated.
- google.protobuf.Timestamp update_time = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 18
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize BatchPredictionJobs.
//
@@ -298,4 +443,13 @@ message BatchPredictionJob {
// is set, then all resources created by the BatchPredictionJob will be
// encrypted with the provided encryption key.
EncryptionSpec encryption_spec = 24;
+
+ // For custom-trained Models and AutoML Tabular Models, the container of the
+ // DeployedModel instances will send `stderr` and `stdout` streams to
+ // Stackdriver Logging by default. Please note that the logs incur cost,
+ // which are subject to [Cloud Logging
+ // pricing](https://cloud.google.com/stackdriver/pricing).
+ //
+ // User can disable container logging by setting this flag to true.
+ bool disable_container_logging = 34;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/completion_stats.proto b/third_party/googleapis/google/cloud/aiplatform/v1/completion_stats.proto
index a1d7b3238..3cf5f834c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/completion_stats.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/completion_stats.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "CompletionStatsProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -35,14 +35,16 @@ message CompletionStats {
// Output only. The number of entities for which any error was encountered.
int64 failed_count = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. In cases when enough errors are encountered a job, pipeline, or operation
- // may be failed as a whole. Below is the number of entities for which the
- // processing had not been finished (either in successful or failed state).
- // Set to -1 if the number is unknown (for example, the operation failed
- // before the total entity number could be collected).
+ // Output only. In cases when enough errors are encountered a job, pipeline,
+ // or operation may be failed as a whole. Below is the number of entities for
+ // which the processing had not been finished (either in successful or failed
+ // state). Set to -1 if the number is unknown (for example, the operation
+ // failed before the total entity number could be collected).
int64 incomplete_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The number of the successful forecast points that are generated by the
- // forecasting model. This is ONLY used by the forecasting batch prediction.
- int64 successful_forecast_point_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The number of the successful forecast points that are
+ // generated by the forecasting model. This is ONLY used by the forecasting
+ // batch prediction.
+ int64 successful_forecast_point_count = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/context.proto b/third_party/googleapis/google/cloud/aiplatform/v1/context.proto
index 1055ea93d..4a5452105 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/context.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/context.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ContextProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -57,13 +57,15 @@ message Context {
map labels = 9;
// Output only. Timestamp when this Context was created.
- google.protobuf.Timestamp create_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Context was last updated.
- google.protobuf.Timestamp update_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A list of resource names of Contexts that are parents of this Context.
- // A Context may have at most 10 parent_contexts.
+ // Output only. A list of resource names of Contexts that are parents of this
+ // Context. A Context may have at most 10 parent_contexts.
repeated string parent_contexts = 12 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/custom_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1/custom_job.proto
index 31ed742fc..070153877 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/custom_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/custom_job.proto
@@ -28,7 +28,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "CustomJobProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -60,18 +60,22 @@ message CustomJob {
JobState state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the CustomJob was created.
- google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the CustomJob for the first time entered the
// `JOB_STATE_RUNNING` state.
- google.protobuf.Timestamp start_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the CustomJob entered any of the following states:
// `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
- google.protobuf.Timestamp end_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the CustomJob was most recently updated.
- google.protobuf.Timestamp update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Only populated when job's state is `JOB_STATE_FAILED` or
// `JOB_STATE_CANCELLED`.
@@ -94,7 +98,8 @@ message CustomJob {
// Output only. URIs for accessing [interactive
// shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
// (one URI for each training node). Only available if
- // [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] is `true`.
+ // [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
+ // is `true`.
//
// The keys are names of each node in the training job; for example,
// `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
@@ -102,15 +107,17 @@ message CustomJob {
// second worker pool.
//
// The values are the URIs for each node's interactive shell.
- map web_access_uris = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
+ map web_access_uris = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Represents the spec of a CustomJob.
message CustomJobSpec {
- // Required. The spec of the worker pools including machine type and Docker image.
- // All worker pools except the first one are optional and can be skipped by
- // providing an empty value.
- repeated WorkerPoolSpec worker_pool_specs = 1 [(google.api.field_behavior) = REQUIRED];
+ // Required. The spec of the worker pools including machine type and Docker
+ // image. All worker pools except the first one are optional and can be
+ // skipped by providing an empty value.
+ repeated WorkerPoolSpec worker_pool_specs = 1
+ [(google.api.field_behavior) = REQUIRED];
// Scheduling options for a CustomJob.
Scheduling scheduling = 3;
@@ -137,9 +144,7 @@ message CustomJobSpec {
// If this field is left unspecified, the job is not peered with any network.
string network = 5 [
(google.api.field_behavior) = OPTIONAL,
- (google.api.resource_reference) = {
- type: "compute.googleapis.com/Network"
- }
+ (google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
];
// Optional. A list of names for the reserved ip ranges under the VPC network
@@ -150,14 +155,15 @@ message CustomJobSpec {
// network.
//
// Example: ['vertex-ai-ip-range'].
- repeated string reserved_ip_ranges = 13 [(google.api.field_behavior) = OPTIONAL];
+ repeated string reserved_ip_ranges = 13
+ [(google.api.field_behavior) = OPTIONAL];
// The Cloud Storage location to store the output of this CustomJob or
// HyperparameterTuningJob. For HyperparameterTuningJob,
// the baseOutputDirectory of
// each child CustomJob backing a Trial is set to a subdirectory of name
- // [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's
- // baseOutputDirectory.
+ // [id][google.cloud.aiplatform.v1.Trial.id] under its parent
+ // HyperparameterTuningJob's baseOutputDirectory.
//
// The following Vertex AI environment variables will be passed to
// containers or python modules when this field is set:
@@ -175,9 +181,9 @@ message CustomJobSpec {
// * AIP_TENSORBOARD_LOG_DIR = `//logs/`
GcsDestination base_output_directory = 6;
- // Optional. The name of a Vertex AI [Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which this CustomJob
- // will upload Tensorboard logs.
- // Format:
+ // Optional. The name of a Vertex AI
+ // [Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which
+ // this CustomJob will upload Tensorboard logs. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string tensorboard = 7 [
(google.api.field_behavior) = OPTIONAL,
@@ -191,9 +197,25 @@ message CustomJobSpec {
// to training containers.
//
// If set to `true`, you can access interactive shells at the URIs given
- // by [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris] (within
+ // by
+ // [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris]
+ // or
+ // [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris]
+ // (within
// [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
bool enable_web_access = 10 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Whether you want Vertex AI to enable access to the customized
+ // dashboard in training chief container.
+ //
+ // If set to `true`, you can access the dashboard at the URIs given
+ // by
+ // [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris]
+ // or
+ // [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris]
+ // (within
+ // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]).
+ bool enable_dashboard_access = 16 [(google.api.field_behavior) = OPTIONAL];
}
// Represents the spec of a worker pool in a job.
@@ -225,8 +247,8 @@ message WorkerPoolSpec {
// The spec of a Container.
message ContainerSpec {
- // Required. The URI of a container image in the Container Registry that is to be run on
- // each worker replica.
+ // Required. The URI of a container image in the Container Registry that is to
+ // be run on each worker replica.
string image_uri = 1 [(google.api.field_behavior) = REQUIRED];
// The command to be invoked when the container is started.
@@ -243,17 +265,17 @@ message ContainerSpec {
// The spec of a Python packaged code.
message PythonPackageSpec {
- // Required. The URI of a container image in Artifact Registry that will run the
- // provided Python package. Vertex AI provides a wide range of executor
+ // Required. The URI of a container image in Artifact Registry that will run
+ // the provided Python package. Vertex AI provides a wide range of executor
// images with pre-installed packages to meet users' various use cases. See
// the list of [pre-built containers for
// training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
// You must use an image from this list.
string executor_image_uri = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The Google Cloud Storage location of the Python package files which are
- // the training program and its dependent packages.
- // The maximum number of package URIs is 100.
+ // Required. The Google Cloud Storage location of the Python package files
+ // which are the training program and its dependent packages. The maximum
+ // number of package URIs is 100.
repeated string package_uris = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The Python module name to run after installing the packages.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/data_item.proto b/third_party/googleapis/google/cloud/aiplatform/v1/data_item.proto
index 10431e743..4ab14e19e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/data_item.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/data_item.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DataItemProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -41,10 +41,12 @@ message DataItem {
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this DataItem was created.
- google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this DataItem was last updated.
- google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The labels with user-defined metadata to organize your DataItems.
//
@@ -59,12 +61,13 @@ message DataItem {
// and are immutable.
map labels = 3 [(google.api.field_behavior) = OPTIONAL];
- // Required. The data that the DataItem represents (for example, an image or a text
- // snippet). The schema of the payload is stored in the parent Dataset's
- // [metadata schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] dataItemSchemaUri field.
+ // Required. The data that the DataItem represents (for example, an image or a
+ // text snippet). The schema of the payload is stored in the parent Dataset's
+ // [metadata schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
+ // dataItemSchemaUri field.
google.protobuf.Value payload = 4 [(google.api.field_behavior) = REQUIRED];
- // Optional. Used to perform consistent read-modify-write updates. If not set, a blind
- // "overwrite" update happens.
+ // Optional. Used to perform consistent read-modify-write updates. If not set,
+ // a blind "overwrite" update happens.
string etag = 7 [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/data_labeling_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1/data_labeling_job.proto
index 45d176e9b..8bc07dbf2 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/data_labeling_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/data_labeling_job.proto
@@ -26,7 +26,7 @@ import "google/rpc/status.proto";
import "google/type/money.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DataLabelingJobProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -50,9 +50,8 @@ message DataLabelingJob {
// Display name of a DataLabelingJob.
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. Dataset resource names. Right now we only support labeling from a single
- // Dataset.
- // Format:
+ // Required. Dataset resource names. Right now we only support labeling from a
+ // single Dataset. Format:
// `projects/{project}/locations/{location}/datasets/{dataset}`
repeated string datasets = 3 [
(google.api.field_behavior) = REQUIRED,
@@ -74,14 +73,14 @@ message DataLabelingJob {
// Required. Number of labelers to work on each DataItem.
int32 labeler_count = 4 [(google.api.field_behavior) = REQUIRED];
- // Required. The Google Cloud Storage location of the instruction pdf. This pdf is
- // shared with labelers, and provides detailed description on how to label
- // DataItems in Datasets.
+ // Required. The Google Cloud Storage location of the instruction pdf. This
+ // pdf is shared with labelers, and provides detailed description on how to
+ // label DataItems in Datasets.
string instruction_uri = 5 [(google.api.field_behavior) = REQUIRED];
- // Required. Points to a YAML file stored on Google Cloud Storage describing the
- // config for a specific type of DataLabelingJob.
- // The schema files that can be used here are found in the
+ // Required. Points to a YAML file stored on Google Cloud Storage describing
+ // the config for a specific type of DataLabelingJob. The schema files that
+ // can be used here are found in the
// https://storage.googleapis.com/google-cloud-aiplatform bucket in the
// /schema/datalabelingjob/inputs/ folder.
string inputs_schema_uri = 6 [(google.api.field_behavior) = REQUIRED];
@@ -92,22 +91,25 @@ message DataLabelingJob {
// Output only. The detailed state of the job.
JobState state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Current labeling job progress percentage scaled in interval [0, 100],
- // indicating the percentage of DataItems that has been finished.
+ // Output only. Current labeling job progress percentage scaled in interval
+ // [0, 100], indicating the percentage of DataItems that has been finished.
int32 labeling_progress = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to
- // date.
- google.type.Money current_spend = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Estimated cost(in US dollars) that the DataLabelingJob has
+ // incurred to date.
+ google.type.Money current_spend = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this DataLabelingJob was created.
- google.protobuf.Timestamp create_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this DataLabelingJob was updated most recently.
- google.protobuf.Timestamp update_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. DataLabelingJob errors. It is only populated when job's state is
- // `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
+ // Output only. DataLabelingJob errors. It is only populated when job's state
+ // is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
google.rpc.Status error = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize your DataLabelingJobs.
@@ -121,7 +123,8 @@ message DataLabelingJob {
// and are immutable. Following system labels exist for each DataLabelingJob:
//
// * "aiplatform.googleapis.com/schema": output only, its value is the
- // [inputs_schema][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s title.
+ // [inputs_schema][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s
+ // title.
map labels = 11;
// The SpecialistPools' resource names associated with this job.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/dataset.proto b/third_party/googleapis/google/cloud/aiplatform/v1/dataset.proto
index ae14e7bf6..2020dafa1 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/dataset.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/dataset.proto
@@ -20,11 +20,12 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1/encryption_spec.proto";
import "google/cloud/aiplatform/v1/io.proto";
+import "google/cloud/aiplatform/v1/saved_query.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DatasetProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -49,21 +50,22 @@ message Dataset {
// The description of the Dataset.
string description = 16;
- // Required. Points to a YAML file stored on Google Cloud Storage describing additional
- // information about the Dataset.
- // The schema is defined as an OpenAPI 3.0.2 Schema Object.
- // The schema files that can be used here are found in
- // gs://google-cloud-aiplatform/schema/dataset/metadata/.
+ // Required. Points to a YAML file stored on Google Cloud Storage describing
+ // additional information about the Dataset. The schema is defined as an
+ // OpenAPI 3.0.2 Schema Object. The schema files that can be used here are
+ // found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
string metadata_schema_uri = 3 [(google.api.field_behavior) = REQUIRED];
// Required. Additional information about the Dataset.
google.protobuf.Value metadata = 8 [(google.api.field_behavior) = REQUIRED];
// Output only. Timestamp when this Dataset was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Dataset was last updated.
- google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Used to perform consistent read-modify-write updates. If not set, a blind
// "overwrite" update happens.
@@ -82,15 +84,27 @@ message Dataset {
// and are immutable. Following system labels exist for each Dataset:
//
// * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
- // value is the [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.
+ // value is the
+ // [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
+ // title.
map labels = 7;
+ // All SavedQueries belong to the Dataset will be returned in List/Get
+ // Dataset response. The [annotation_specs][SavedQuery.annotation_specs] field
+ // will not be populated except for UI cases which will only use
+ // [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count].
+ // In CreateDataset request, a SavedQuery is created together if
+ // this field is set, up to one SavedQuery can be set in CreateDatasetRequest.
+ // The SavedQuery should not contain any AnnotationSpec.
+ repeated SavedQuery saved_queries = 9;
+
// Customer-managed encryption key spec for a Dataset. If set, this Dataset
// and all sub-resources of this Dataset will be secured by this key.
EncryptionSpec encryption_spec = 11;
- // Output only. The resource name of the Artifact that was created in MetadataStore when
- // creating the Dataset. The Artifact resource name pattern is
+ // Output only. The resource name of the Artifact that was created in
+ // MetadataStore when creating the Dataset. The Artifact resource name pattern
+ // is
// `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
string metadata_artifact = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -114,21 +128,26 @@ message ImportDataConfig {
// considered identical if their content bytes are identical (e.g. image bytes
// or pdf bytes).
// These labels will be overridden by Annotation labels specified inside index
- // file referenced by [import_schema_uri][google.cloud.aiplatform.v1.ImportDataConfig.import_schema_uri], e.g. jsonl file.
+ // file referenced by
+ // [import_schema_uri][google.cloud.aiplatform.v1.ImportDataConfig.import_schema_uri],
+ // e.g. jsonl file.
map data_item_labels = 2;
// Labels that will be applied to newly imported Annotations. If two
// Annotations are identical, one of them will be deduped. Two Annotations are
- // considered identical if their [payload][google.cloud.aiplatform.v1.Annotation.payload],
- // [payload_schema_uri][google.cloud.aiplatform.v1.Annotation.payload_schema_uri] and all of their
- // [labels][google.cloud.aiplatform.v1.Annotation.labels] are the same.
- // These labels will be overridden by Annotation labels specified inside index
- // file referenced by [import_schema_uri][google.cloud.aiplatform.v1.ImportDataConfig.import_schema_uri], e.g. jsonl file.
+ // considered identical if their
+ // [payload][google.cloud.aiplatform.v1.Annotation.payload],
+ // [payload_schema_uri][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
+ // and all of their [labels][google.cloud.aiplatform.v1.Annotation.labels] are
+ // the same. These labels will be overridden by Annotation labels specified
+ // inside index file referenced by
+ // [import_schema_uri][google.cloud.aiplatform.v1.ImportDataConfig.import_schema_uri],
+ // e.g. jsonl file.
map annotation_labels = 3;
- // Required. Points to a YAML file stored on Google Cloud Storage describing the import
- // format. Validation will be done against the schema. The schema is defined
- // as an [OpenAPI 3.0.2 Schema
+ // Required. Points to a YAML file stored on Google Cloud Storage describing
+ // the import format. Validation will be done against the schema. The schema
+ // is defined as an [OpenAPI 3.0.2 Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
string import_schema_uri = 4 [(google.api.field_behavior) = REQUIRED];
}
@@ -150,9 +169,33 @@ message ExportDataConfig {
GcsDestination gcs_destination = 1;
}
+ // The instructions how the export data should be split between the
+ // training, validation and test sets.
+ oneof split {
+ // Split based on fractions defining the size of each set.
+ ExportFractionSplit fraction_split = 5;
+ }
+
// A filter on Annotations of the Dataset. Only Annotations on to-be-exported
// DataItems(specified by [data_items_filter][]) that match this filter will
// be exported. The filter syntax is the same as in
// [ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
string annotations_filter = 2;
}
+
+// Assigns the input data to training, validation, and test sets as per the
+// given fractions. Any of `training_fraction`, `validation_fraction` and
+// `test_fraction` may optionally be provided, they must sum to up to 1. If the
+// provided ones sum to less than 1, the remainder is assigned to sets as
+// decided by Vertex AI. If none of the fractions are set, by default roughly
+// 80% of data is used for training, 10% for validation, and 10% for test.
+message ExportFractionSplit {
+ // The fraction of the input data that is to be used to train the Model.
+ double training_fraction = 1;
+
+ // The fraction of the input data that is to be used to validate the Model.
+ double validation_fraction = 2;
+
+ // The fraction of the input data that is to be used to evaluate the Model.
+ double test_fraction = 3;
+}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/dataset_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/dataset_service.proto
index 4a59848d9..f575e6937 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/dataset_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/dataset_service.proto
@@ -27,10 +27,11 @@ import "google/cloud/aiplatform/v1/dataset.proto";
import "google/cloud/aiplatform/v1/operation.proto";
import "google/cloud/aiplatform/v1/saved_query.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DatasetServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -41,10 +42,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// resources.
service DatasetService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a Dataset.
- rpc CreateDataset(CreateDatasetRequest) returns (google.longrunning.Operation) {
+ rpc CreateDataset(CreateDatasetRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/datasets"
body: "dataset"
@@ -82,7 +85,8 @@ service DatasetService {
}
// Deletes a Dataset.
- rpc DeleteDataset(DeleteDatasetRequest) returns (google.longrunning.Operation) {
+ rpc DeleteDataset(DeleteDatasetRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/datasets/*}"
};
@@ -128,14 +132,16 @@ service DatasetService {
}
// Searches DataItems in a Dataset.
- rpc SearchDataItems(SearchDataItemsRequest) returns (SearchDataItemsResponse) {
+ rpc SearchDataItems(SearchDataItemsRequest)
+ returns (SearchDataItemsResponse) {
option (google.api.http) = {
get: "/v1/{dataset=projects/*/locations/*/datasets/*}:searchDataItems"
};
}
// Lists SavedQueries in a Dataset.
- rpc ListSavedQueries(ListSavedQueriesRequest) returns (ListSavedQueriesResponse) {
+ rpc ListSavedQueries(ListSavedQueriesRequest)
+ returns (ListSavedQueriesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/datasets/*}/savedQueries"
};
@@ -151,7 +157,8 @@ service DatasetService {
}
// Lists Annotations belongs to a dataitem
- rpc ListAnnotations(ListAnnotationsRequest) returns (ListAnnotationsResponse) {
+ rpc ListAnnotations(ListAnnotationsRequest)
+ returns (ListAnnotationsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/datasets/*/dataItems/*}/annotations"
};
@@ -159,7 +166,8 @@ service DatasetService {
}
}
-// Request message for [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset].
+// Request message for
+// [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset].
message CreateDatasetRequest {
// Required. The resource name of the Location to create the Dataset in.
// Format: `projects/{project}/locations/{location}`
@@ -174,13 +182,15 @@ message CreateDatasetRequest {
Dataset dataset = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Runtime operation information for [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset].
+// Runtime operation information for
+// [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset].
message CreateDatasetOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [DatasetService.GetDataset][google.cloud.aiplatform.v1.DatasetService.GetDataset].
+// Request message for
+// [DatasetService.GetDataset][google.cloud.aiplatform.v1.DatasetService.GetDataset].
message GetDatasetRequest {
// Required. The name of the Dataset resource.
string name = 1 [
@@ -194,22 +204,25 @@ message GetDatasetRequest {
google.protobuf.FieldMask read_mask = 2;
}
-// Request message for [DatasetService.UpdateDataset][google.cloud.aiplatform.v1.DatasetService.UpdateDataset].
+// Request message for
+// [DatasetService.UpdateDataset][google.cloud.aiplatform.v1.DatasetService.UpdateDataset].
message UpdateDatasetRequest {
// Required. The Dataset which replaces the resource on the server.
Dataset dataset = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource.
- // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask].
- // Updatable fields:
+ // For the `FieldMask` definition, see
+ // [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:
//
// * `display_name`
// * `description`
// * `labels`
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets].
+// Request message for
+// [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets].
message ListDatasetsRequest {
// Required. The name of the Dataset's parent resource.
// Format: `projects/{project}/locations/{location}`
@@ -255,7 +268,8 @@ message ListDatasetsRequest {
string order_by = 6;
}
-// Response message for [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets].
+// Response message for
+// [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets].
message ListDatasetsResponse {
// A list of Datasets that matches the specified filter in the request.
repeated Dataset datasets = 1;
@@ -264,7 +278,8 @@ message ListDatasetsResponse {
string next_page_token = 2;
}
-// Request message for [DatasetService.DeleteDataset][google.cloud.aiplatform.v1.DatasetService.DeleteDataset].
+// Request message for
+// [DatasetService.DeleteDataset][google.cloud.aiplatform.v1.DatasetService.DeleteDataset].
message DeleteDatasetRequest {
// Required. The resource name of the Dataset to delete.
// Format:
@@ -277,7 +292,8 @@ message DeleteDatasetRequest {
];
}
-// Request message for [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].
+// Request message for
+// [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].
message ImportDataRequest {
// Required. The name of the Dataset resource.
// Format:
@@ -289,23 +305,25 @@ message ImportDataRequest {
}
];
- // Required. The desired input locations. The contents of all input locations will be
- // imported in one batch.
- repeated ImportDataConfig import_configs = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The desired input locations. The contents of all input locations
+ // will be imported in one batch.
+ repeated ImportDataConfig import_configs = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].
-message ImportDataResponse {
+// Response message for
+// [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].
+message ImportDataResponse {}
-}
-
-// Runtime operation information for [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].
+// Runtime operation information for
+// [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData].
message ImportDataOperationMetadata {
// The common part of the operation metadata.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].
+// Request message for
+// [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].
message ExportDataRequest {
// Required. The name of the Dataset resource.
// Format:
@@ -321,13 +339,15 @@ message ExportDataRequest {
ExportDataConfig export_config = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].
+// Response message for
+// [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].
message ExportDataResponse {
// All of the files that are exported in this export operation.
repeated string exported_files = 1;
}
-// Runtime operation information for [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].
+// Runtime operation information for
+// [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData].
message ExportDataOperationMetadata {
// The common part of the operation metadata.
GenericOperationMetadata generic_metadata = 1;
@@ -337,7 +357,8 @@ message ExportDataOperationMetadata {
string gcs_output_directory = 2;
}
-// Request message for [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems].
+// Request message for
+// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems].
message ListDataItemsRequest {
// Required. The resource name of the Dataset to list DataItems from.
// Format:
@@ -366,7 +387,8 @@ message ListDataItemsRequest {
string order_by = 6;
}
-// Response message for [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems].
+// Response message for
+// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems].
message ListDataItemsResponse {
// A list of DataItems that matches the specified filter in the request.
repeated DataItem data_items = 1;
@@ -375,12 +397,13 @@ message ListDataItemsResponse {
string next_page_token = 2;
}
-// Request message for [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].
+// Request message for
+// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].
message SearchDataItemsRequest {
// Expression that allows ranking results based on annotation's property.
message OrderByAnnotation {
- // Required. Saved query of the Annotation. Only Annotations belong to this saved
- // query will be considered for ordering.
+ // Required. Saved query of the Annotation. Only Annotations belong to this
+ // saved query will be considered for ordering.
string saved_query = 1 [(google.api.field_behavior) = REQUIRED];
// A comma-separated list of annotation fields to order by, sorted in
@@ -452,7 +475,8 @@ message SearchDataItemsRequest {
// belong to.
repeated string annotation_filters = 11;
- // Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
+ // Mask specifying which fields of
+ // [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read.
google.protobuf.FieldMask field_mask = 6;
// If set, only up to this many of Annotations will be returned per
@@ -470,18 +494,23 @@ message SearchDataItemsRequest {
// A token identifying a page of results for the server to return
// Typically obtained via
- // [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token] of the previous
- // [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems] call.
+ // [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token]
+ // of the previous
+ // [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems]
+ // call.
string page_token = 10;
}
-// Response message for [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].
+// Response message for
+// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems].
message SearchDataItemsResponse {
// The DataItemViews read.
repeated DataItemView data_item_views = 1;
// A token to retrieve next page of results.
- // Pass to [SearchDataItemsRequest.page_token][google.cloud.aiplatform.v1.SearchDataItemsRequest.page_token] to obtain that page.
+ // Pass to
+ // [SearchDataItemsRequest.page_token][google.cloud.aiplatform.v1.SearchDataItemsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
@@ -504,7 +533,8 @@ message DataItemView {
bool has_truncated_annotations = 3;
}
-// Request message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries].
+// Request message for
+// [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries].
message ListSavedQueriesRequest {
// Required. The resource name of the Dataset to list SavedQueries from.
// Format:
@@ -533,7 +563,8 @@ message ListSavedQueriesRequest {
string order_by = 6;
}
-// Response message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries].
+// Response message for
+// [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries].
message ListSavedQueriesResponse {
// A list of SavedQueries that match the specified filter in the request.
repeated SavedQuery saved_queries = 1;
@@ -542,7 +573,8 @@ message ListSavedQueriesResponse {
string next_page_token = 2;
}
-// Request message for [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpec].
+// Request message for
+// [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpec].
message GetAnnotationSpecRequest {
// Required. The name of the AnnotationSpec resource.
// Format:
@@ -558,7 +590,8 @@ message GetAnnotationSpecRequest {
google.protobuf.FieldMask read_mask = 2;
}
-// Request message for [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
+// Request message for
+// [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
message ListAnnotationsRequest {
// Required. The resource name of the DataItem to list Annotations from.
// Format:
@@ -587,7 +620,8 @@ message ListAnnotationsRequest {
string order_by = 6;
}
-// Response message for [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
+// Response message for
+// [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
message ListAnnotationsResponse {
// A list of Annotations that matches the specified filter in the request.
repeated Annotation annotations = 1;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/deployed_index_ref.proto b/third_party/googleapis/google/cloud/aiplatform/v1/deployed_index_ref.proto
index 35c8b30c7..88263d5d3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/deployed_index_ref.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/deployed_index_ref.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DeployedIndexRefProto";
option java_package = "com.google.cloud.aiplatform.v1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/deployed_model_ref.proto b/third_party/googleapis/google/cloud/aiplatform/v1/deployed_model_ref.proto
index 8a7b1eb79..d37d0c064 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/deployed_model_ref.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/deployed_model_ref.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DeployedModelNameProto";
option java_package = "com.google.cloud.aiplatform.v1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/encryption_spec.proto b/third_party/googleapis/google/cloud/aiplatform/v1/encryption_spec.proto
index 15a799019..ce5ddad21 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/encryption_spec.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/encryption_spec.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EncryptionSpecProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -29,8 +29,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// Represents a customer-managed encryption key spec that can be applied to
// a top-level resource.
message EncryptionSpec {
- // Required. The Cloud KMS resource identifier of the customer managed encryption key
- // used to protect a resource. Has the form:
+ // Required. The Cloud KMS resource identifier of the customer managed
+ // encryption key used to protect a resource. Has the form:
// `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`.
// The key needs to be in the same region as where the compute resource is
// created.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/endpoint.proto b/third_party/googleapis/google/cloud/aiplatform/v1/endpoint.proto
index 39a3f5007..4dbfca05c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/endpoint.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/endpoint.proto
@@ -25,7 +25,7 @@ import "google/cloud/aiplatform/v1/machine_resources.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EndpointProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -52,9 +52,13 @@ message Endpoint {
string description = 3;
// Output only. The models deployed in this Endpoint.
- // To add or remove DeployedModels use [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel] and
- // [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel] respectively.
- repeated DeployedModel deployed_models = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // To add or remove DeployedModels use
+ // [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]
+ // and
+ // [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]
+ // respectively.
+ repeated DeployedModel deployed_models = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// A map from a DeployedModel's ID to the percentage of this Endpoint's
// traffic that should be forwarded to that DeployedModel.
@@ -80,24 +84,27 @@ message Endpoint {
map labels = 7;
// Output only. Timestamp when this Endpoint was created.
- google.protobuf.Timestamp create_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Endpoint was last updated.
- google.protobuf.Timestamp update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Customer-managed encryption key spec for an Endpoint. If set, this
// Endpoint and all sub-resources of this Endpoint will be secured by
// this key.
EncryptionSpec encryption_spec = 10;
- // The full name of the Google Compute Engine
+ // Optional. The full name of the Google Compute Engine
// [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
// to which the Endpoint should be peered.
//
// Private services access must already be configured for the network. If left
// unspecified, the Endpoint is not peered with any network.
//
- // Only one of the fields, [network][google.cloud.aiplatform.v1.Endpoint.network] or
+ // Only one of the fields,
+ // [network][google.cloud.aiplatform.v1.Endpoint.network] or
// [enable_private_service_connect][google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect],
// can be set.
//
@@ -105,20 +112,22 @@ message Endpoint {
// `projects/{project}/global/networks/{network}`.
// Where `{project}` is a project number, as in `12345`, and `{network}` is
// network name.
- string network = 13 [(google.api.resource_reference) = {
- type: "compute.googleapis.com/Network"
- }];
+ string network = 13 [
+ (google.api.field_behavior) = OPTIONAL,
+ (google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
+ ];
// Deprecated: If true, expose the Endpoint via private service connect.
//
- // Only one of the fields, [network][google.cloud.aiplatform.v1.Endpoint.network] or
+ // Only one of the fields,
+ // [network][google.cloud.aiplatform.v1.Endpoint.network] or
// [enable_private_service_connect][google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect],
// can be set.
bool enable_private_service_connect = 17 [deprecated = true];
- // Output only. Resource name of the Model Monitoring job associated with this Endpoint
- // if monitoring is enabled by [CreateModelDeploymentMonitoringJob][].
- // Format:
+ // Output only. Resource name of the Model Monitoring job associated with this
+ // Endpoint if monitoring is enabled by
+ // [CreateModelDeploymentMonitoringJob][]. Format:
// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
string model_deployment_monitoring_job = 14 [
(google.api.field_behavior) = OUTPUT_ONLY,
@@ -128,7 +137,8 @@ message Endpoint {
];
// Configures the request-response logging for online prediction.
- PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;
+ PredictRequestResponseLoggingConfig predict_request_response_logging_config =
+ 18;
}
// A deployment of a Model. Endpoints contain one or more DeployedModels.
@@ -148,17 +158,22 @@ message DeployedModel {
AutomaticResources automatic_resources = 8;
}
- // Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI
- // will generate a value for this ID.
+ // Immutable. The ID of the DeployedModel. If not provided upon deployment,
+ // Vertex AI will generate a value for this ID.
//
// This value should be 1-10 characters, and valid characters are /[0-9]/.
string id = 1 [(google.api.field_behavior) = IMMUTABLE];
- // Required. The resource name of the Model that this is the deployment of. Note that
- // the Model may be in a different location than the DeployedModel's Endpoint.
+ // Required. The resource name of the Model that this is the deployment of.
+ // Note that the Model may be in a different location than the DeployedModel's
+ // Endpoint.
//
// The resource name may contain version id or version alias to specify the
- // version, if no version is specified, the default version will be deployed.
+ // version.
+ // Example: `projects/{project}/locations/{location}/models/{model}@2`
+ // or
+ // `projects/{project}/locations/{location}/models/{model}@golden`
+ // if no version is specified, the default version will be deployed.
string model = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -174,17 +189,26 @@ message DeployedModel {
string display_name = 3;
// Output only. Timestamp when the DeployedModel was created.
- google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Explanation configuration for this DeployedModel.
//
- // When deploying a Model using [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel], this value
- // overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]. All fields of
- // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] are optional in the request. If a field of
- // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] is not populated, the value of the same field of
- // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] is inherited. If the corresponding
- // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] is not populated, all fields of the
- // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] will be used for the explanation configuration.
+ // When deploying a Model using
+ // [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel],
+ // this value overrides the value of
+ // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
+ // All fields of
+ // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
+ // are optional in the request. If a field of
+ // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
+ // is not populated, the value of the same field of
+ // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
+ // is inherited. If the corresponding
+ // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
+ // is not populated, all fields of the
+ // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
+ // will be used for the explanation configuration.
ExplanationSpec explanation_spec = 9;
// The service account that the DeployedModel's container runs as. Specify the
@@ -205,6 +229,8 @@ message DeployedModel {
// User can disable container logging by setting this flag to true.
bool disable_container_logging = 15;
+ // If true, online prediction access logs are sent to StackDriver
+ // Logging.
// These logs are like standard server access logs, containing
// information like timestamp and latency for each prediction request.
//
@@ -213,10 +239,12 @@ message DeployedModel {
// Estimate your costs before enabling this option.
bool enable_access_logging = 13;
- // Output only. Provide paths for users to send predict/explain/health requests directly to
- // the deployed model services running on Cloud via private services access.
- // This field is populated if [network][google.cloud.aiplatform.v1.Endpoint.network] is configured.
- PrivateEndpoints private_endpoints = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Provide paths for users to send predict/explain/health
+ // requests directly to the deployed model services running on Cloud via
+ // private services access. This field is populated if
+ // [network][google.cloud.aiplatform.v1.Endpoint.network] is configured.
+ PrivateEndpoints private_endpoints = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// PrivateEndpoints proto is used to provide paths for users to send
@@ -234,8 +262,8 @@ message PrivateEndpoints {
// Output only. Http(s) path to send health check requests.
string health_http_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The name of the service attachment resource. Populated if private service
- // connect is enabled.
+ // Output only. The name of the service attachment resource. Populated if
+ // private service connect is enabled.
string service_attachment = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/endpoint_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/endpoint_service.proto
index 0108728cc..00235dd73 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/endpoint_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/endpoint_service.proto
@@ -23,10 +23,11 @@ import "google/api/resource.proto";
import "google/cloud/aiplatform/v1/endpoint.proto";
import "google/cloud/aiplatform/v1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EndpointServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -36,10 +37,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// A service for managing Vertex AI's Endpoints.
service EndpointService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates an Endpoint.
- rpc CreateEndpoint(CreateEndpointRequest) returns (google.longrunning.Operation) {
+ rpc CreateEndpoint(CreateEndpointRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/endpoints"
body: "endpoint"
@@ -78,7 +81,8 @@ service EndpointService {
}
// Deletes an Endpoint.
- rpc DeleteEndpoint(DeleteEndpointRequest) returns (google.longrunning.Operation) {
+ rpc DeleteEndpoint(DeleteEndpointRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/endpoints/*}"
};
@@ -95,7 +99,8 @@ service EndpointService {
post: "/v1/{endpoint=projects/*/locations/*/endpoints/*}:deployModel"
body: "*"
};
- option (google.api.method_signature) = "endpoint,deployed_model,traffic_split";
+ option (google.api.method_signature) =
+ "endpoint,deployed_model,traffic_split";
option (google.longrunning.operation_info) = {
response_type: "DeployModelResponse"
metadata_type: "DeployModelOperationMetadata"
@@ -104,12 +109,14 @@ service EndpointService {
// Undeploys a Model from an Endpoint, removing a DeployedModel from it, and
// freeing all resources it's using.
- rpc UndeployModel(UndeployModelRequest) returns (google.longrunning.Operation) {
+ rpc UndeployModel(UndeployModelRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{endpoint=projects/*/locations/*/endpoints/*}:undeployModel"
body: "*"
};
- option (google.api.method_signature) = "endpoint,deployed_model_id,traffic_split";
+ option (google.api.method_signature) =
+ "endpoint,deployed_model_id,traffic_split";
option (google.longrunning.operation_info) = {
response_type: "UndeployModelResponse"
metadata_type: "UndeployModelOperationMetadata"
@@ -117,7 +124,8 @@ service EndpointService {
}
}
-// Request message for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint].
+// Request message for
+// [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint].
message CreateEndpointRequest {
// Required. The resource name of the Location to create the Endpoint in.
// Format: `projects/{project}/locations/{location}`
@@ -142,13 +150,15 @@ message CreateEndpointRequest {
string endpoint_id = 4 [(google.api.field_behavior) = IMMUTABLE];
}
-// Runtime operation information for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint].
+// Runtime operation information for
+// [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint].
message CreateEndpointOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [EndpointService.GetEndpoint][google.cloud.aiplatform.v1.EndpointService.GetEndpoint]
+// Request message for
+// [EndpointService.GetEndpoint][google.cloud.aiplatform.v1.EndpointService.GetEndpoint]
message GetEndpointRequest {
// Required. The name of the Endpoint resource.
// Format:
@@ -161,10 +171,11 @@ message GetEndpointRequest {
];
}
-// Request message for [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints].
+// Request message for
+// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints].
message ListEndpointsRequest {
- // Required. The resource name of the Location from which to list the Endpoints.
- // Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location from which to list the
+ // Endpoints. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -172,11 +183,12 @@ message ListEndpointsRequest {
}
];
- // Optional. An expression for filtering the results of the request. For field names
- // both snake_case and camelCase are supported.
+ // Optional. An expression for filtering the results of the request. For field
+ // names both snake_case and camelCase are supported.
//
// * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID,
- // i.e. the last segment of the Endpoint's [resource name][google.cloud.aiplatform.v1.Endpoint.name].
+ // i.e. the last segment of the Endpoint's [resource
+ // name][google.cloud.aiplatform.v1.Endpoint.name].
// * `display_name` supports = and, !=
// * `labels` supports general map functions that is:
// * `labels.key=value` - key:value equality
@@ -194,12 +206,15 @@ message ListEndpointsRequest {
// Optional. The standard list page token.
// Typically obtained via
- // [ListEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token] of the previous
- // [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints] call.
+ // [ListEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token]
+ // of the previous
+ // [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints]
+ // call.
string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. Mask specifying which fields to read.
- google.protobuf.FieldMask read_mask = 5 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.FieldMask read_mask = 5
+ [(google.api.field_behavior) = OPTIONAL];
// A comma-separated list of fields to order by, sorted in ascending order.
// Use "desc" after a field name for descending.
@@ -212,26 +227,33 @@ message ListEndpointsRequest {
string order_by = 6;
}
-// Response message for [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints].
+// Response message for
+// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints].
message ListEndpointsResponse {
// List of Endpoints in the requested page.
repeated Endpoint endpoints = 1;
// A token to retrieve the next page of results.
- // Pass to [ListEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListEndpointsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListEndpointsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].
+// Request message for
+// [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].
message UpdateEndpointRequest {
// Required. The Endpoint which replaces the resource on the server.
Endpoint endpoint = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The update mask applies to the resource. See
+ // [google.protobuf.FieldMask][google.protobuf.FieldMask].
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1.EndpointService.DeleteEndpoint].
+// Request message for
+// [EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1.EndpointService.DeleteEndpoint].
message DeleteEndpointRequest {
// Required. The name of the Endpoint resource to be deleted.
// Format:
@@ -244,7 +266,8 @@ message DeleteEndpointRequest {
];
}
-// Request message for [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
+// Request message for
+// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
message DeployModelRequest {
// Required. The name of the Endpoint resource into which to deploy a Model.
// Format:
@@ -257,8 +280,9 @@ message DeployModelRequest {
];
// Required. The DeployedModel to be created within the Endpoint. Note that
- // [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] must be updated for the DeployedModel to start
- // receiving traffic, either as part of this call, or via
+ // [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split]
+ // must be updated for the DeployedModel to start receiving traffic, either as
+ // part of this call, or via
// [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint].
DeployedModel deployed_model = 2 [(google.api.field_behavior) = REQUIRED];
@@ -266,29 +290,34 @@ message DeployModelRequest {
// traffic that should be forwarded to that DeployedModel.
//
// If this field is non-empty, then the Endpoint's
- // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be overwritten with it.
- // To refer to the ID of the just being deployed Model, a "0" should be used,
- // and the actual ID of the new DeployedModel will be filled in its place by
- // this method. The traffic percentage values must add up to 100.
+ // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be
+ // overwritten with it. To refer to the ID of the just being deployed Model, a
+ // "0" should be used, and the actual ID of the new DeployedModel will be
+ // filled in its place by this method. The traffic percentage values must add
+ // up to 100.
//
// If this field is empty, then the Endpoint's
- // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not updated.
+ // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not
+ // updated.
map traffic_split = 3;
}
-// Response message for [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
+// Response message for
+// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
message DeployModelResponse {
// The DeployedModel that had been deployed in the Endpoint.
DeployedModel deployed_model = 1;
}
-// Runtime operation information for [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
+// Runtime operation information for
+// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel].
message DeployModelOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].
+// Request message for
+// [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].
message UndeployModelRequest {
// Required. The name of the Endpoint resource from which to undeploy a Model.
// Format:
@@ -304,21 +333,21 @@ message UndeployModelRequest {
string deployed_model_id = 2 [(google.api.field_behavior) = REQUIRED];
// If this field is provided, then the Endpoint's
- // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be overwritten with it. If
- // last DeployedModel is being undeployed from the Endpoint, the
- // [Endpoint.traffic_split] will always end up empty when this call returns.
- // A DeployedModel will be successfully undeployed only if it doesn't have
- // any traffic assigned to it when this method executes, or if this field
- // unassigns any traffic to it.
+ // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be
+ // overwritten with it. If last DeployedModel is being undeployed from the
+ // Endpoint, the [Endpoint.traffic_split] will always end up empty when this
+ // call returns. A DeployedModel will be successfully undeployed only if it
+ // doesn't have any traffic assigned to it when this method executes, or if
+ // this field unassigns any traffic to it.
map traffic_split = 3;
}
-// Response message for [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].
-message UndeployModelResponse {
-
-}
+// Response message for
+// [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].
+message UndeployModelResponse {}
-// Runtime operation information for [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].
+// Runtime operation information for
+// [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel].
message UndeployModelOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/entity_type.proto b/third_party/googleapis/google/cloud/aiplatform/v1/entity_type.proto
index 073b53398..5ff273926 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/entity_type.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/entity_type.proto
@@ -22,7 +22,7 @@ import "google/cloud/aiplatform/v1/featurestore_monitoring.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EntityTypeProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -52,12 +52,15 @@ message EntityType {
string description = 2 [(google.api.field_behavior) = OPTIONAL];
// Output only. Timestamp when this EntityType was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this EntityType was most recently updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. The labels with user-defined metadata to organize your EntityTypes.
+ // Optional. The labels with user-defined metadata to organize your
+ // EntityTypes.
//
// Label keys and values can be no longer than 64 characters
// (Unicode codepoints), can only contain lowercase letters, numeric
@@ -70,17 +73,19 @@ message EntityType {
// and are immutable.
map labels = 6 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Used to perform a consistent read-modify-write updates. If not set, a blind
- // "overwrite" update happens.
+ // Optional. Used to perform a consistent read-modify-write updates. If not
+ // set, a blind "overwrite" update happens.
string etag = 7 [(google.api.field_behavior) = OPTIONAL];
- // Optional. The default monitoring configuration for all Features with value type
- // ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL, STRING, DOUBLE or INT64 under this
- // EntityType.
+ // Optional. The default monitoring configuration for all Features with value
+ // type
+ // ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL,
+ // STRING, DOUBLE or INT64 under this EntityType.
//
// If this is populated with
// [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot
// analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is
// disabled.
- FeaturestoreMonitoringConfig monitoring_config = 8 [(google.api.field_behavior) = OPTIONAL];
+ FeaturestoreMonitoringConfig monitoring_config = 8
+ [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/env_var.proto b/third_party/googleapis/google/cloud/aiplatform/v1/env_var.proto
index 34722e362..1bf422925 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/env_var.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/env_var.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EnvVarProto";
option java_package = "com.google.cloud.aiplatform.v1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/evaluated_annotation.proto b/third_party/googleapis/google/cloud/aiplatform/v1/evaluated_annotation.proto
new file mode 100644
index 000000000..35da29081
--- /dev/null
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/evaluated_annotation.proto
@@ -0,0 +1,185 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.aiplatform.v1;
+
+import "google/api/field_behavior.proto";
+import "google/cloud/aiplatform/v1/explanation.proto";
+import "google/protobuf/struct.proto";
+
+option csharp_namespace = "Google.Cloud.AIPlatform.V1";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
+option java_multiple_files = true;
+option java_outer_classname = "EvaluatedAnnotationProto";
+option java_package = "com.google.cloud.aiplatform.v1";
+option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
+option ruby_package = "Google::Cloud::AIPlatform::V1";
+
+// True positive, false positive, or false negative.
+//
+// EvaluatedAnnotation is only available under ModelEvaluationSlice with slice
+// of `annotationSpec` dimension.
+message EvaluatedAnnotation {
+ // Describes the type of the EvaluatedAnnotation. The type is determined
+ enum EvaluatedAnnotationType {
+ // Invalid value.
+ EVALUATED_ANNOTATION_TYPE_UNSPECIFIED = 0;
+
+ // The EvaluatedAnnotation is a true positive. It has a prediction created
+ // by the Model and a ground truth Annotation which the prediction matches.
+ TRUE_POSITIVE = 1;
+
+ // The EvaluatedAnnotation is false positive. It has a prediction created by
+ // the Model which does not match any ground truth annotation.
+ FALSE_POSITIVE = 2;
+
+ // The EvaluatedAnnotation is false negative. It has a ground truth
+ // annotation which is not matched by any of the model created predictions.
+ FALSE_NEGATIVE = 3;
+ }
+
+ // Output only. Type of the EvaluatedAnnotation.
+ EvaluatedAnnotationType type = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The model predicted annotations.
+ //
+ // For true positive, there is one and only one prediction, which matches the
+ // only one ground truth annotation in
+ // [ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
+ //
+ // For false positive, there is one and only one prediction, which doesn't
+ // match any ground truth annotation of the corresponding
+ // [data_item_view_id][EvaluatedAnnotation.data_item_view_id].
+ //
+ // For false negative, there are zero or more predictions which are similar to
+ // the only ground truth annotation in
+ // [ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths]
+ // but not enough for a match.
+ //
+ // The schema of the prediction is stored in
+ // [ModelEvaluation.annotation_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.annotation_schema_uri]
+ repeated google.protobuf.Value predictions = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The ground truth Annotations, i.e. the Annotations that exist
+ // in the test data the Model is evaluated on.
+ //
+ // For true positive, there is one and only one ground truth annotation, which
+ // matches the only prediction in
+ // [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions].
+ //
+ // For false positive, there are zero or more ground truth annotations that
+ // are similar to the only prediction in
+ // [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions],
+ // but not enough for a match.
+ //
+ // For false negative, there is one and only one ground truth annotation,
+ // which doesn't match any predictions created by the model.
+ //
+ // The schema of the ground truth is stored in
+ // [ModelEvaluation.annotation_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.annotation_schema_uri]
+ repeated google.protobuf.Value ground_truths = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The data item payload that the Model predicted this
+ // EvaluatedAnnotation on.
+ google.protobuf.Value data_item_payload = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. ID of the EvaluatedDataItemView under the same ancestor
+ // ModelEvaluation. The EvaluatedDataItemView consists of all ground truths
+ // and predictions on
+ // [data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
+ //
+ // Can be passed in
+ // [GetEvaluatedDataItemView's][ModelService.GetEvaluatedDataItemView][]
+ // [id][GetEvaluatedDataItemViewRequest.id].
+ string evaluated_data_item_view_id = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Explanations of
+ // [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions].
+ // Each element of the explanations indicates the explanation for one
+ // explanation Method.
+ //
+ // The attributions list in the
+ // [EvaluatedAnnotationExplanation.explanation][google.cloud.aiplatform.v1.EvaluatedAnnotationExplanation.explanation]
+ // object corresponds to the
+ // [predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions]
+ // list. For example, the second element in the attributions list explains the
+ // second element in the predictions list.
+ repeated EvaluatedAnnotationExplanation explanations = 8;
+
+ // Annotations of model error analysis results.
+ repeated ErrorAnalysisAnnotation error_analysis_annotations = 9;
+}
+
+// Explanation result of the prediction produced by the Model.
+message EvaluatedAnnotationExplanation {
+ // Explanation type.
+ //
+ // For AutoML Image Classification models, possible values are:
+ //
+ // * `image-integrated-gradients`
+ // * `image-xrai`
+ string explanation_type = 1;
+
+ // Explanation attribution response details.
+ Explanation explanation = 2;
+}
+
+// Model error analysis for each annotation.
+message ErrorAnalysisAnnotation {
+ // Attributed items for a given annotation, typically representing neighbors
+ // from the training sets constrained by the query type.
+ message AttributedItem {
+ // The unique ID for each annotation. Used by FE to allocate the annotation
+ // in DB.
+ string annotation_resource_name = 1;
+
+ // The distance of this item to the annotation.
+ double distance = 2;
+ }
+
+ // The query type used for finding the attributed items.
+ enum QueryType {
+ // Unspecified query type for model error analysis.
+ QUERY_TYPE_UNSPECIFIED = 0;
+
+ // Query similar samples across all classes in the dataset.
+ ALL_SIMILAR = 1;
+
+ // Query similar samples from the same class of the input sample.
+ SAME_CLASS_SIMILAR = 2;
+
+ // Query dissimilar samples from the same class of the input sample.
+ SAME_CLASS_DISSIMILAR = 3;
+ }
+
+ // Attributed items for a given annotation, typically representing neighbors
+ // from the training sets constrained by the query type.
+ repeated AttributedItem attributed_items = 1;
+
+ // The query type used for finding the attributed items.
+ QueryType query_type = 2;
+
+ // The outlier score of this annotated item. Usually defined as the min of all
+ // distances from attributed items.
+ double outlier_score = 3;
+
+ // The threshold used to determine if this annotation is an outlier or not.
+ double outlier_threshold = 4;
+}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/event.proto b/third_party/googleapis/google/cloud/aiplatform/v1/event.proto
index f9f925db5..851504405 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/event.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/event.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EventProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -60,7 +60,8 @@ message Event {
];
// Output only. Time the Event occurred.
- google.protobuf.Timestamp event_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp event_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Required. The type of the Event.
Type type = 4 [(google.api.field_behavior) = REQUIRED];
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/execution.proto b/third_party/googleapis/google/cloud/aiplatform/v1/execution.proto
index 0d9dcea5a..4ba955e3e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/execution.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/execution.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ExecutionProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -87,10 +87,12 @@ message Execution {
map labels = 10;
// Output only. Timestamp when this Execution was created.
- google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Execution was last updated.
- google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The title of the schema describing the metadata.
//
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/explanation.proto b/third_party/googleapis/google/cloud/aiplatform/v1/explanation.proto
index 0c00d8a22..b5a53187b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/explanation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/explanation.proto
@@ -21,15 +21,17 @@ import "google/cloud/aiplatform/v1/explanation_metadata.proto";
import "google/protobuf/struct.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ExplanationProto";
option java_package = "com.google.cloud.aiplatform.v1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
option ruby_package = "Google::Cloud::AIPlatform::V1";
-// Explanation of a prediction (provided in [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions])
-// produced by the Model on a given [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
+// Explanation of a prediction (provided in
+// [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions])
+// produced by the Model on a given
+// [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
message Explanation {
// Output only. Feature attributions grouped by predicted outputs.
//
@@ -37,15 +39,21 @@ message Explanation {
// predict only one score, there is only one attibution that explains the
// predicted output. For Models that predict multiple outputs, such as
// multiclass Models that predict multiple classes, each element explains one
- // specific item. [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] can be used to identify which
- // output this attribution is explaining.
+ // specific item.
+ // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
+ // can be used to identify which output this attribution is explaining.
//
- // If users set [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k], the attributions are sorted
- // by [instance_output_value][Attributions.instance_output_value] in
- // descending order. If [ExplanationParameters.output_indices][google.cloud.aiplatform.v1.ExplanationParameters.output_indices] is specified,
- // the attributions are stored by [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] in the same
- // order as they appear in the output_indices.
- repeated Attribution attributions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // If users set
+ // [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k],
+ // the attributions are sorted by
+ // [instance_output_value][Attributions.instance_output_value] in descending
+ // order. If
+ // [ExplanationParameters.output_indices][google.cloud.aiplatform.v1.ExplanationParameters.output_indices]
+ // is specified, the attributions are stored by
+ // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
+ // in the same order as they appear in the output_indices.
+ repeated Attribution attributions = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. List of the nearest neighbors for example-based explanations.
//
@@ -56,55 +64,67 @@ message Explanation {
// Aggregated explanation metrics for a Model over a set of instances.
message ModelExplanation {
- // Output only. Aggregated attributions explaining the Model's prediction outputs over the
- // set of instances. The attributions are grouped by outputs.
+ // Output only. Aggregated attributions explaining the Model's prediction
+ // outputs over the set of instances. The attributions are grouped by outputs.
//
// For Models that predict only one output, such as regression Models that
// predict only one score, there is only one attibution that explains the
// predicted output. For Models that predict multiple outputs, such as
// multiclass Models that predict multiple classes, each element explains one
- // specific item. [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] can be used to identify which
- // output this attribution is explaining.
+ // specific item.
+ // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
+ // can be used to identify which output this attribution is explaining.
//
- // The [baselineOutputValue][google.cloud.aiplatform.v1.Attribution.baseline_output_value],
- // [instanceOutputValue][google.cloud.aiplatform.v1.Attribution.instance_output_value] and
- // [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] fields are
- // averaged over the test data.
+ // The
+ // [baselineOutputValue][google.cloud.aiplatform.v1.Attribution.baseline_output_value],
+ // [instanceOutputValue][google.cloud.aiplatform.v1.Attribution.instance_output_value]
+ // and
+ // [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
+ // fields are averaged over the test data.
//
// NOTE: Currently AutoML tabular classification Models produce only one
// attribution, which averages attributions over all the classes it predicts.
- // [Attribution.approximation_error][google.cloud.aiplatform.v1.Attribution.approximation_error] is not populated.
- repeated Attribution mean_attributions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // [Attribution.approximation_error][google.cloud.aiplatform.v1.Attribution.approximation_error]
+ // is not populated.
+ repeated Attribution mean_attributions = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Attribution that explains a particular prediction output.
message Attribution {
- // Output only. Model predicted output if the input instance is constructed from the
- // baselines of all the features defined in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
+ // Output only. Model predicted output if the input instance is constructed
+ // from the baselines of all the features defined in
+ // [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
// The field name of the output is determined by the key in
// [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
//
// If the Model's predicted output has multiple dimensions (rank > 1), this is
- // the value in the output located by [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
+ // the value in the output located by
+ // [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
//
// If there are multiple baselines, their output values are averaged.
double baseline_output_value = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Model predicted output on the corresponding [explanation
// instance][ExplainRequest.instances]. The field name of the output is
- // determined by the key in [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
+ // determined by the key in
+ // [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
//
// If the Model predicted output has multiple dimensions, this is the value in
- // the output located by [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
+ // the output located by
+ // [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
double instance_output_value = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Attributions of each explained feature. Features are extracted from
- // the [prediction instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according to
- // [explanation metadata for inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
+ // Output only. Attributions of each explained feature. Features are extracted
+ // from the [prediction
+ // instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according
+ // to [explanation metadata for
+ // inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
//
// The value is a struct, whose keys are the name of the feature. The values
- // are how much the feature in the [instance][google.cloud.aiplatform.v1.ExplainRequest.instances]
- // contributed to the predicted result.
+ // are how much the feature in the
+ // [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed
+ // to the predicted result.
//
// The format of the value is determined by the feature's input format:
//
@@ -120,11 +140,15 @@ message Attribution {
// struct. The formats of the values in the attribution struct are
// determined by the formats of the values in the feature struct.
//
- // The [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri] field,
- // pointed to by the [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
- // [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] object, points to the schema file that
- // describes the features and their attribution values (if it is populated).
- google.protobuf.Value feature_attributions = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // The
+ // [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri]
+ // field, pointed to by the
+ // [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the
+ // [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
+ // object, points to the schema file that describes the features and their
+ // attribution values (if it is populated).
+ google.protobuf.Value feature_attributions = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The index that locates the explained prediction output.
//
@@ -135,8 +159,9 @@ message Attribution {
// of the output vector. Indices start from 0.
repeated int32 output_index = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The display name of the output identified by [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For example,
- // the predicted class name by a multi-classification Model.
+ // Output only. The display name of the output identified by
+ // [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For
+ // example, the predicted class name by a multi-classification Model.
//
// This field is only populated iff the Model predicts display names as a
// separate field along with the explained output. The predicted display name
@@ -144,20 +169,26 @@ message Attribution {
// output_index.
string output_display_name = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Error of [feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] caused by approximation used in the
- // explanation method. Lower value means more precise attributions.
+ // Output only. Error of
+ // [feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
+ // caused by approximation used in the explanation method. Lower value means
+ // more precise attributions.
//
// * For Sampled Shapley
// [attribution][google.cloud.aiplatform.v1.ExplanationParameters.sampled_shapley_attribution],
- // increasing [path_count][google.cloud.aiplatform.v1.SampledShapleyAttribution.path_count] might reduce
- // the error.
+ // increasing
+ // [path_count][google.cloud.aiplatform.v1.SampledShapleyAttribution.path_count]
+ // might reduce the error.
// * For Integrated Gradients
// [attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
- // increasing [step_count][google.cloud.aiplatform.v1.IntegratedGradientsAttribution.step_count] might
- // reduce the error.
- // * For [XRAI attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
// increasing
- // [step_count][google.cloud.aiplatform.v1.XraiAttribution.step_count] might reduce the error.
+ // [step_count][google.cloud.aiplatform.v1.IntegratedGradientsAttribution.step_count]
+ // might reduce the error.
+ // * For [XRAI
+ // attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
+ // increasing
+ // [step_count][google.cloud.aiplatform.v1.XraiAttribution.step_count] might
+ // reduce the error.
//
// See [this introduction](/vertex-ai/docs/explainable-ai/overview)
// for more information.
@@ -219,13 +250,14 @@ message ExplanationParameters {
int32 top_k = 4;
// If populated, only returns attributions that have
- // [output_index][google.cloud.aiplatform.v1.Attribution.output_index] contained in output_indices. It
- // must be an ndarray of integers, with the same shape of the output it's
- // explaining.
+ // [output_index][google.cloud.aiplatform.v1.Attribution.output_index]
+ // contained in output_indices. It must be an ndarray of integers, with the
+ // same shape of the output it's explaining.
//
- // If not populated, returns attributions for [top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k] indices of outputs.
- // If neither top_k nor output_indices is populated, returns the argmax
- // index of the outputs.
+ // If not populated, returns attributions for
+ // [top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k] indices of
+ // outputs. If neither top_k nor output_indices is populated, returns the
+ // argmax index of the outputs.
//
// Only applicable to Models that predict multiple outputs (e,g, multi-class
// Models that predict multiple classes).
@@ -236,8 +268,8 @@ message ExplanationParameters {
// contribute to the label being predicted. A sampling strategy is used to
// approximate the value rather than considering all subsets of features.
message SampledShapleyAttribution {
- // Required. The number of feature permutations to consider when approximating the
- // Shapley values.
+ // Required. The number of feature permutations to consider when approximating
+ // the Shapley values.
//
// Valid range of its value is [1, 50], inclusively.
int32 path_count = 1 [(google.api.field_behavior) = REQUIRED];
@@ -324,16 +356,18 @@ message SmoothGradConfig {
// paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1.
//
// If the distribution is different per feature, set
- // [feature_noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.feature_noise_sigma] instead
- // for each feature.
+ // [feature_noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.feature_noise_sigma]
+ // instead for each feature.
float noise_sigma = 1;
- // This is similar to [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma], but
- // provides additional flexibility. A separate noise sigma can be provided
- // for each feature, which is useful if their distributions are different.
- // No noise is added to features that are not set. If this field is unset,
- // [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma] will be used for all
- // features.
+ // This is similar to
+ // [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma],
+ // but provides additional flexibility. A separate noise sigma can be
+ // provided for each feature, which is useful if their distributions are
+ // different. No noise is added to features that are not set. If this field
+ // is unset,
+ // [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma]
+ // will be used for all features.
FeatureNoiseSigma feature_noise_sigma = 2;
}
@@ -352,13 +386,14 @@ message FeatureNoiseSigma {
message NoiseSigmaForFeature {
// The name of the input feature for which noise sigma is provided. The
// features are defined in
- // [explanation metadata inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
+ // [explanation metadata
+ // inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
string name = 1;
// This represents the standard deviation of the Gaussian kernel that will
// be used to add noise to the feature prior to computing gradients. Similar
- // to [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma] but represents the
- // noise added to the current feature. Defaults to 0.1.
+ // to [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma]
+ // but represents the noise added to the current feature. Defaults to 0.1.
float sigma = 2;
}
@@ -380,12 +415,13 @@ message BlurBaselineConfig {
float max_blur_sigma = 1;
}
-// The [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] entries that can be overridden at
-// [online explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
+// The [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] entries
+// that can be overridden at [online
+// explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
message ExplanationSpecOverride {
// The parameters to be overridden. Note that the
- // [method][google.cloud.aiplatform.v1.ExplanationParameters.method] cannot be changed. If not specified,
- // no parameter is overridden.
+ // [method][google.cloud.aiplatform.v1.ExplanationParameters.method] cannot be
+ // changed. If not specified, no parameter is overridden.
ExplanationParameters parameters = 1;
// The metadata to be overridden. If not specified, no metadata is overridden.
@@ -395,11 +431,13 @@ message ExplanationSpecOverride {
ExamplesOverride examples_override = 3;
}
-// The [ExplanationMetadata][google.cloud.aiplatform.v1.ExplanationMetadata] entries that can be overridden at
-// [online explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
+// The [ExplanationMetadata][google.cloud.aiplatform.v1.ExplanationMetadata]
+// entries that can be overridden at [online
+// explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.
message ExplanationMetadataOverride {
- // The [input metadata][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata] entries to be
- // overridden.
+ // The [input
+ // metadata][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata]
+ // entries to be overridden.
message InputMetadataOverride {
// Baseline inputs for this feature.
//
@@ -410,12 +448,14 @@ message ExplanationMetadataOverride {
repeated google.protobuf.Value input_baselines = 1;
}
- // Required. Overrides the [input metadata][google.cloud.aiplatform.v1.ExplanationMetadata.inputs] of the features.
- // The key is the name of the feature to be overridden. The keys specified
- // here must exist in the input metadata to be overridden. If a feature is
- // not specified here, the corresponding feature's input metadata is not
- // overridden.
- map inputs = 1 [(google.api.field_behavior) = REQUIRED];
+ // Required. Overrides the [input
+ // metadata][google.cloud.aiplatform.v1.ExplanationMetadata.inputs] of the
+ // features. The key is the name of the feature to be overridden. The keys
+ // specified here must exist in the input metadata to be overridden. If a
+ // feature is not specified here, the corresponding feature's input metadata
+ // is not overridden.
+ map inputs = 1
+ [(google.api.field_behavior) = REQUIRED];
}
// Overrides for example-based explanations.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/explanation_metadata.proto b/third_party/googleapis/google/cloud/aiplatform/v1/explanation_metadata.proto
index 5ee0c1ce3..50ba68996 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/explanation_metadata.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/explanation_metadata.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/protobuf/struct.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ExplanationMetadataProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -31,8 +31,10 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
message ExplanationMetadata {
// Metadata of the input of a feature.
//
- // Fields other than [InputMetadata.input_baselines][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.input_baselines] are applicable only
- // for Models that are using Vertex AI-provided images for Tensorflow.
+ // Fields other than
+ // [InputMetadata.input_baselines][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.input_baselines]
+ // are applicable only for Models that are using Vertex AI-provided images for
+ // Tensorflow.
message InputMetadata {
// Domain details of the input feature value. Provides numeric information
// about the feature, such as its range (min, max). If the feature has been
@@ -63,7 +65,8 @@ message ExplanationMetadata {
// Visualization configurations for image explanation.
message Visualization {
// Type of the image visualization. Only applicable to
- // [Integrated Gradients attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
+ // [Integrated Gradients
+ // attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
enum Type {
// Should not be used.
TYPE_UNSPECIFIED = 0;
@@ -141,7 +144,8 @@ message ExplanationMetadata {
}
// Type of the image visualization. Only applicable to
- // [Integrated Gradients attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
+ // [Integrated Gradients
+ // attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
// OUTLINES shows regions of attribution, while PIXELS shows per-pixel
// attribution. Defaults to OUTLINES.
Type type = 1;
@@ -153,12 +157,14 @@ message ExplanationMetadata {
// The color scheme used for the highlighted areas.
//
// Defaults to PINK_GREEN for
- // [Integrated Gradients attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
+ // [Integrated Gradients
+ // attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution],
// which shows positive attributions in green and negative in pink.
//
// Defaults to VIRIDIS for
- // [XRAI attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution], which
- // highlights the most influential regions in yellow and the least
+ // [XRAI
+ // attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
+ // which highlights the most influential regions in yellow and the least
// influential in blue.
ColorMap color_map = 3;
@@ -188,8 +194,9 @@ message ExplanationMetadata {
IDENTITY = 1;
// The tensor represents a bag of features where each index maps to
- // a feature. [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping] must be provided for
- // this encoding. For example:
+ // a feature.
+ // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping]
+ // must be provided for this encoding. For example:
// ```
// input = [27, 6.0, 150]
// index_feature_mapping = ["age", "height", "weight"]
@@ -198,8 +205,9 @@ message ExplanationMetadata {
// The tensor represents a bag of features where each index maps to a
// feature. Zero values in the tensor indicates feature being
- // non-existent. [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping] must be provided
- // for this encoding. For example:
+ // non-existent.
+ // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping]
+ // must be provided for this encoding. For example:
// ```
// input = [2, 0, 5, 0, 1]
// index_feature_mapping = ["a", "b", "c", "d", "e"]
@@ -207,7 +215,8 @@ message ExplanationMetadata {
BAG_OF_FEATURES_SPARSE = 3;
// The tensor is a list of binaries representing whether a feature exists
- // or not (1 indicates existence). [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping]
+ // or not (1 indicates existence).
+ // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping]
// must be provided for this encoding. For example:
// ```
// input = [1, 0, 1, 0, 1]
@@ -216,8 +225,9 @@ message ExplanationMetadata {
INDICATOR = 4;
// The tensor is encoded into a 1-dimensional array represented by an
- // encoded tensor. [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name] must be provided
- // for this encoding. For example:
+ // encoded tensor.
+ // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name]
+ // must be provided for this encoding. For example:
// ```
// input = ["This", "is", "a", "test", "."]
// encoded = [0.1, 0.2, 0.3, 0.4, 0.5]
@@ -226,9 +236,9 @@ message ExplanationMetadata {
// Select this encoding when the input tensor is encoded into a
// 2-dimensional array represented by an encoded tensor.
- // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name] must be provided for this
- // encoding. The first dimension of the encoded tensor's shape is the same
- // as the input tensor's shape. For example:
+ // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name]
+ // must be provided for this encoding. The first dimension of the encoded
+ // tensor's shape is the same as the input tensor's shape. For example:
// ```
// input = ["This", "is", "a", "test", "."]
// encoded = [[0.1, 0.2, 0.3, 0.4, 0.5],
@@ -244,7 +254,8 @@ message ExplanationMetadata {
//
// If no baseline is specified, Vertex AI chooses the baseline for this
// feature. If multiple baselines are specified, Vertex AI returns the
- // average attributions across them in [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
+ // average attributions across them in
+ // [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
//
// For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape
// of each baseline must match the shape of the input tensor. If a scalar is
@@ -252,9 +263,9 @@ message ExplanationMetadata {
//
// For custom images, the element of the baselines must be in the same
// format as the feature's input in the
- // [instance][google.cloud.aiplatform.v1.ExplainRequest.instances][]. The schema of any single instance
- // may be specified via Endpoint's DeployedModels'
- // [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
+ // [instance][google.cloud.aiplatform.v1.ExplainRequest.instances][]. The
+ // schema of any single instance may be specified via Endpoint's
+ // DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
repeated google.protobuf.Value input_baselines = 1;
@@ -287,15 +298,18 @@ message ExplanationMetadata {
string dense_shape_tensor_name = 7;
// A list of feature names for each index in the input tensor.
- // Required when the input [InputMetadata.encoding][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoding] is BAG_OF_FEATURES,
- // BAG_OF_FEATURES_SPARSE, INDICATOR.
+ // Required when the input
+ // [InputMetadata.encoding][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoding]
+ // is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
repeated string index_feature_mapping = 8;
// Encoded tensor is a transformation of the input tensor. Must be provided
// if choosing
- // [Integrated Gradients attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution]
- // or [XRAI attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution] and the
- // input tensor is not differentiable.
+ // [Integrated Gradients
+ // attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution]
+ // or [XRAI
+ // attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution]
+ // and the input tensor is not differentiable.
//
// An encoded tensor is generated if the input tensor is encoded by a lookup
// table.
@@ -315,17 +329,21 @@ message ExplanationMetadata {
// name will be treated as one feature when computing attributions. Features
// grouped together can have different shapes in value. If provided, there
// will be one single attribution generated in
- // [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions], keyed by the group name.
+ // [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions],
+ // keyed by the group name.
string group_name = 12;
}
// Metadata of the prediction output to be explained.
message OutputMetadata {
- // Defines how to map [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] to
+ // Defines how to map
+ // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
+ // to
// [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name].
//
// If neither of the fields are specified,
- // [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name] will not be populated.
+ // [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name]
+ // will not be populated.
oneof display_name_mapping {
// Static mapping between the index and display name.
//
@@ -337,8 +355,10 @@ message ExplanationMetadata {
//
// The shape of the value must be an n-dimensional array of strings. The
// number of dimensions must match that of the outputs to be explained.
- // The [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name] is populated by locating in the
- // mapping with [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index].
+ // The
+ // [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name]
+ // is populated by locating in the mapping with
+ // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index].
google.protobuf.Value index_display_name_mapping = 1;
// Specify a field name in the prediction to look for the display name.
@@ -346,8 +366,9 @@ message ExplanationMetadata {
// Use this if the prediction contains the display names for the outputs.
//
// The display names in the prediction must have the same shape of the
- // outputs, so that it can be located by [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] for
- // a specific output.
+ // outputs, so that it can be located by
+ // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
+ // for a specific output.
string display_name_mapping_key = 2;
}
@@ -356,21 +377,23 @@ message ExplanationMetadata {
string output_tensor_name = 3;
}
- // Required. Map from feature names to feature input metadata. Keys are the name of the
- // features. Values are the specification of the feature.
+ // Required. Map from feature names to feature input metadata. Keys are the
+ // name of the features. Values are the specification of the feature.
//
// An empty InputMetadata is valid. It describes a text feature which has the
- // name specified as the key in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. The baseline
- // of the empty feature is chosen by Vertex AI.
+ // name specified as the key in
+ // [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs].
+ // The baseline of the empty feature is chosen by Vertex AI.
//
// For Vertex AI-provided Tensorflow images, the key can be any friendly
// name of the feature. Once specified,
- // [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] are keyed by
- // this key (if not grouped with another feature).
+ // [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
+ // are keyed by this key (if not grouped with another feature).
//
// For custom images, the key must match with the key in
// [instance][google.cloud.aiplatform.v1.ExplainRequest.instances].
- map inputs = 1 [(google.api.field_behavior) = REQUIRED];
+ map inputs = 1
+ [(google.api.field_behavior) = REQUIRED];
// Required. Map from output names to output metadata.
//
@@ -381,10 +404,12 @@ message ExplanationMetadata {
// to be explained.
//
// Currently only one key is allowed.
- map outputs = 2 [(google.api.field_behavior) = REQUIRED];
+ map outputs = 2
+ [(google.api.field_behavior) = REQUIRED];
// Points to a YAML file stored on Google Cloud Storage describing the format
- // of the [feature attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
+ // of the [feature
+ // attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions].
// The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
// AutoML tabular Models always have this field populated by Vertex AI.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/feature.proto b/third_party/googleapis/google/cloud/aiplatform/v1/feature.proto
index 690bb3641..b242d9ba9 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/feature.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/feature.proto
@@ -22,7 +22,7 @@ import "google/cloud/aiplatform/v1/feature_monitoring_stats.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeatureProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -41,7 +41,9 @@ message Feature {
// A list of historical [Snapshot
// Analysis][FeaturestoreMonitoringConfig.SnapshotAnalysis] or [Import Feature
// Analysis] [FeaturestoreMonitoringConfig.ImportFeatureAnalysis] stats
- // requested by user, sorted by [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1.FeatureStatsAnomaly.start_time] descending.
+ // requested by user, sorted by
+ // [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1.FeatureStatsAnomaly.start_time]
+ // descending.
message MonitoringStatsAnomaly {
// If the objective in the request is both
// Import Feature Analysis and Snapshot Analysis, this objective could be
@@ -62,7 +64,8 @@ message Feature {
Objective objective = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The stats and anomalies generated at specific timestamp.
- FeatureStatsAnomaly feature_stats_anomaly = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ FeatureStatsAnomaly feature_stats_anomaly = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// An enum representing the value type of a feature.
@@ -118,10 +121,12 @@ message Feature {
];
// Output only. Timestamp when this EntityType was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this EntityType was most recently updated.
- google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The labels with user-defined metadata to organize your Features.
//
@@ -140,15 +145,17 @@ message Feature {
// "overwrite" update happens.
string etag = 7;
- // Optional. If not set, use the monitoring_config defined for the EntityType this
- // Feature belongs to.
- // Only Features with type ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL, STRING, DOUBLE or
- // INT64 can enable monitoring.
+ // Optional. If not set, use the monitoring_config defined for the EntityType
+ // this Feature belongs to. Only Features with type
+ // ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL,
+ // STRING, DOUBLE or INT64 can enable monitoring.
//
// If set to true, all types of data monitoring are disabled despite the
// config on EntityType.
bool disable_monitoring = 12 [(google.api.field_behavior) = OPTIONAL];
- // Output only. The list of historical stats and anomalies with specified objectives.
- repeated MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The list of historical stats and anomalies with specified
+ // objectives.
+ repeated MonitoringStatsAnomaly monitoring_stats_anomalies = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/feature_monitoring_stats.proto b/third_party/googleapis/google/cloud/aiplatform/v1/feature_monitoring_stats.proto
index 1138ec8c3..0f778d429 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/feature_monitoring_stats.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/feature_monitoring_stats.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1;
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeatureMonitoringStatsProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -39,7 +39,8 @@ message FeatureStatsAnomaly {
// Feature importance score, only populated when cross-feature monitoring is
// enabled. For now only used to represent feature attribution score within
// range [0, 1] for
- // [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW] and
+ // [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW]
+ // and
// [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT].
double score = 1;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/feature_selector.proto b/third_party/googleapis/google/cloud/aiplatform/v1/feature_selector.proto
index 7a4a8e664..b653f8ec2 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/feature_selector.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/feature_selector.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeatureSelectorProto";
option java_package = "com.google.cloud.aiplatform.v1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/featurestore.proto b/third_party/googleapis/google/cloud/aiplatform/v1/featurestore.proto
index 46b19f60e..62bfd22df 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/featurestore.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/featurestore.proto
@@ -22,7 +22,7 @@ import "google/cloud/aiplatform/v1/encryption_spec.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -45,13 +45,22 @@ message Featurestore {
// max_node_count are set to the same value, the cluster will be configured
// with the fixed number of node (no auto-scaling).
message Scaling {
- // Required. The minimum number of nodes to scale down to. Must be greater than or
- // equal to 1.
+ // Required. The minimum number of nodes to scale down to. Must be greater
+ // than or equal to 1.
int32 min_node_count = 1 [(google.api.field_behavior) = REQUIRED];
// The maximum number of nodes to scale up to. Must be greater than
// min_node_count, and less than or equal to 10 times of 'min_node_count'.
int32 max_node_count = 2;
+
+ // Optional. The cpu utilization that the Autoscaler should be trying to
+ // achieve. This number is on a scale from 0 (no utilization) to 100
+ // (total utilization), and is limited between 10 and 80. When a cluster's
+ // CPU utilization exceeds the target that you have set, Bigtable
+ // immediately adds nodes to the cluster. When CPU utilization is
+ // substantially lower than the target, Bigtable removes nodes. If not set
+ // or set to 0, default to 50.
+ int32 cpu_utilization_target = 3 [(google.api.field_behavior) = OPTIONAL];
}
// The number of nodes for the online store. The number of nodes doesn't
@@ -94,16 +103,19 @@ message Featurestore {
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Featurestore was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Featurestore was last updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. Used to perform consistent read-modify-write updates. If not set, a blind
- // "overwrite" update happens.
+ // Optional. Used to perform consistent read-modify-write updates. If not set,
+ // a blind "overwrite" update happens.
string etag = 5 [(google.api.field_behavior) = OPTIONAL];
- // Optional. The labels with user-defined metadata to organize your Featurestore.
+ // Optional. The labels with user-defined metadata to organize your
+ // Featurestore.
//
// Label keys and values can be no longer than 64 characters
// (Unicode codepoints), can only contain lowercase letters, numeric
@@ -116,16 +128,17 @@ message Featurestore {
// and are immutable.
map labels = 6 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Config for online storage resources. The field should not co-exist with the
- // field of `OnlineStoreReplicationConfig`. If both of it and
- // OnlineStoreReplicationConfig are unset, the feature store will not have an
- // online store and cannot be used for online serving.
- OnlineServingConfig online_serving_config = 7 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. Config for online storage resources. The field should not
+ // co-exist with the field of `OnlineStoreReplicationConfig`. If both of it
+ // and OnlineStoreReplicationConfig are unset, the feature store will not have
+ // an online store and cannot be used for online serving.
+ OnlineServingConfig online_serving_config = 7
+ [(google.api.field_behavior) = OPTIONAL];
// Output only. State of the featurestore.
State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. Customer-managed encryption key spec for data storage. If set, both of the
- // online and offline data storage will be secured by this key.
+ // Optional. Customer-managed encryption key spec for data storage. If set,
+ // both of the online and offline data storage will be secured by this key.
EncryptionSpec encryption_spec = 10 [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_monitoring.proto b/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_monitoring.proto
index 7233658b0..99e66b13f 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_monitoring.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_monitoring.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreMonitoringProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -46,12 +46,6 @@ message FeaturestoreMonitoringConfig {
// Configuration of the snapshot analysis based monitoring pipeline
// running interval. The value indicates number of days.
- // If both
- // [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days][google.cloud.aiplatform.v1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days]
- // and [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval][]
- // are set when creating/updating EntityTypes/Features,
- // [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days][google.cloud.aiplatform.v1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days]
- // will be used.
int32 monitoring_interval_days = 3;
// Customized export features time window for snapshot analysis. Unit is one
@@ -62,7 +56,9 @@ message FeaturestoreMonitoringConfig {
// Configuration of the Featurestore's ImportFeature Analysis Based
// Monitoring. This type of analysis generates statistics for values of each
- // Feature imported by every [ImportFeatureValues][] operation.
+ // Feature imported by every
+ // [ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues]
+ // operation.
message ImportFeaturesAnalysis {
// The state defines whether to enable ImportFeature analysis.
enum State {
@@ -89,7 +85,9 @@ message FeaturestoreMonitoringConfig {
}
// Defines the baseline to do anomaly detection for feature values imported
- // by each [ImportFeatureValues][] operation.
+ // by each
+ // [ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues]
+ // operation.
enum Baseline {
// Should not be used.
BASELINE_UNSPECIFIED = 0;
@@ -139,11 +137,15 @@ message FeaturestoreMonitoringConfig {
// Threshold for numerical features of anomaly detection.
// This is shared by all objectives of Featurestore Monitoring for numerical
- // features (i.e. Features with type ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) DOUBLE or INT64).
+ // features (i.e. Features with type
+ // ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) DOUBLE
+ // or INT64).
ThresholdConfig numerical_threshold_config = 3;
// Threshold for categorical features of anomaly detection.
// This is shared by all types of Featurestore Monitoring for categorical
- // features (i.e. Features with type ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL or STRING).
+ // features (i.e. Features with type
+ // ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL or
+ // STRING).
ThresholdConfig categorical_threshold_config = 4;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_online_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_online_service.proto
index bf9fa7190..262a7bb43 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_online_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_online_service.proto
@@ -25,7 +25,7 @@ import "google/cloud/aiplatform/v1/types.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreOnlineServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -35,12 +35,14 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// A service for serving online feature values.
service FeaturestoreOnlineServingService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Reads Feature values of a specific entity of an EntityType. For reading
// feature values of multiple entities of an EntityType, please use
// StreamingReadFeatureValues.
- rpc ReadFeatureValues(ReadFeatureValuesRequest) returns (ReadFeatureValuesResponse) {
+ rpc ReadFeatureValues(ReadFeatureValuesRequest)
+ returns (ReadFeatureValuesResponse) {
option (google.api.http) = {
post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:readFeatureValues"
body: "*"
@@ -51,7 +53,8 @@ service FeaturestoreOnlineServingService {
// Reads Feature values for multiple entities. Depending on their size, data
// for different entities may be broken
// up across multiple responses.
- rpc StreamingReadFeatureValues(StreamingReadFeatureValuesRequest) returns (stream ReadFeatureValuesResponse) {
+ rpc StreamingReadFeatureValues(StreamingReadFeatureValuesRequest)
+ returns (stream ReadFeatureValuesResponse) {
option (google.api.http) = {
post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:streamingReadFeatureValues"
body: "*"
@@ -64,7 +67,8 @@ service FeaturestoreOnlineServingService {
// The Feature values are merged into existing entities if any. The Feature
// values to be written must have timestamp within the online storage
// retention.
- rpc WriteFeatureValues(WriteFeatureValuesRequest) returns (WriteFeatureValuesResponse) {
+ rpc WriteFeatureValues(WriteFeatureValuesRequest)
+ returns (WriteFeatureValuesResponse) {
option (google.api.http) = {
post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:writeFeatureValues"
body: "*"
@@ -73,10 +77,12 @@ service FeaturestoreOnlineServingService {
}
}
-// Request message for [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues].
+// Request message for
+// [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues].
message WriteFeatureValuesRequest {
- // Required. The resource name of the EntityType for the entities being written.
- // Value format: `projects/{project}/locations/{location}/featurestores/
+ // Required. The resource name of the EntityType for the entities being
+ // written. Value format:
+ // `projects/{project}/locations/{location}/featurestores/
// {featurestore}/entityTypes/{entityType}`. For example,
// for a machine learning model predicting user clicks on a website, an
// EntityType ID could be `user`.
@@ -87,9 +93,10 @@ message WriteFeatureValuesRequest {
}
];
- // Required. The entities to be written. Up to 100,000 feature values can be written
- // across all `payloads`.
- repeated WriteFeatureValuesPayload payloads = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The entities to be written. Up to 100,000 feature values can be
+ // written across all `payloads`.
+ repeated WriteFeatureValuesPayload payloads = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Contains Feature values to be written for a specific entity.
@@ -97,19 +104,20 @@ message WriteFeatureValuesPayload {
// Required. The ID of the entity.
string entity_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. Feature values to be written, mapping from Feature ID to value. Up to
- // 100,000 `feature_values` entries may be written across all payloads. The
- // feature generation time, aligned by days, must be no older than five
+ // Required. Feature values to be written, mapping from Feature ID to value.
+ // Up to 100,000 `feature_values` entries may be written across all payloads.
+ // The feature generation time, aligned by days, must be no older than five
// years (1825 days) and no later than one year (366 days) in the future.
- map feature_values = 2 [(google.api.field_behavior) = REQUIRED];
+ map feature_values = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues].
-message WriteFeatureValuesResponse {
-
-}
+// Response message for
+// [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues].
+message WriteFeatureValuesResponse {}
-// Request message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues].
+// Request message for
+// [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues].
message ReadFeatureValuesRequest {
// Required. The resource name of the EntityType for the entity being read.
// Value format:
@@ -132,7 +140,8 @@ message ReadFeatureValuesRequest {
FeatureSelector feature_selector = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues].
+// Response message for
+// [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues].
message ReadFeatureValuesResponse {
// Metadata for requested Features.
message FeatureDescriptor {
@@ -141,14 +150,16 @@ message ReadFeatureValuesResponse {
}
// Response header with metadata for the requested
- // [ReadFeatureValuesRequest.entity_type][google.cloud.aiplatform.v1.ReadFeatureValuesRequest.entity_type] and Features.
+ // [ReadFeatureValuesRequest.entity_type][google.cloud.aiplatform.v1.ReadFeatureValuesRequest.entity_type]
+ // and Features.
message Header {
// The resource name of the EntityType from the
- // [ReadFeatureValuesRequest][google.cloud.aiplatform.v1.ReadFeatureValuesRequest]. Value format:
+ // [ReadFeatureValuesRequest][google.cloud.aiplatform.v1.ReadFeatureValuesRequest].
+ // Value format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
string entity_type = 1 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/EntityType"
- }];
+ type: "aiplatform.googleapis.com/EntityType"
+ }];
// List of Feature metadata corresponding to each piece of
// [ReadFeatureValuesResponse.data][].
@@ -179,7 +190,8 @@ message ReadFeatureValuesResponse {
// requested values for one requested Feature. If no values
// for the requested Feature exist, the corresponding cell will be empty.
// This has the same size and is in the same order as the features from the
- // header [ReadFeatureValuesResponse.header][google.cloud.aiplatform.v1.ReadFeatureValuesResponse.header].
+ // header
+ // [ReadFeatureValuesResponse.header][google.cloud.aiplatform.v1.ReadFeatureValuesResponse.header].
repeated Data data = 2;
}
@@ -209,13 +221,13 @@ message StreamingReadFeatureValuesRequest {
}
];
- // Required. IDs of entities to read Feature values of. The maximum number of IDs is
- // 100. For example, for a machine learning model predicting user clicks on a
- // website, an entity ID could be `user_123`.
+ // Required. IDs of entities to read Feature values of. The maximum number of
+ // IDs is 100. For example, for a machine learning model predicting user
+ // clicks on a website, an entity ID could be `user_123`.
repeated string entity_ids = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. Selector choosing Features of the target EntityType. Feature IDs will be
- // deduplicated.
+ // Required. Selector choosing Features of the target EntityType. Feature IDs
+ // will be deduplicated.
FeatureSelector feature_selector = 3 [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_service.proto
index 930d45c19..0ea8d4ff2 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/featurestore_service.proto
@@ -27,11 +27,13 @@ import "google/cloud/aiplatform/v1/featurestore.proto";
import "google/cloud/aiplatform/v1/io.proto";
import "google/cloud/aiplatform/v1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
+import "google/type/interval.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -41,16 +43,19 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// The service that handles CRUD and List for resources for Featurestore.
service FeaturestoreService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a new Featurestore in a given project and location.
- rpc CreateFeaturestore(CreateFeaturestoreRequest) returns (google.longrunning.Operation) {
+ rpc CreateFeaturestore(CreateFeaturestoreRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/featurestores"
body: "featurestore"
};
option (google.api.method_signature) = "parent,featurestore";
- option (google.api.method_signature) = "parent,featurestore,featurestore_id";
+ option (google.api.method_signature) =
+ "parent,featurestore,featurestore_id";
option (google.longrunning.operation_info) = {
response_type: "Featurestore"
metadata_type: "CreateFeaturestoreOperationMetadata"
@@ -66,7 +71,8 @@ service FeaturestoreService {
}
// Lists Featurestores in a given project and location.
- rpc ListFeaturestores(ListFeaturestoresRequest) returns (ListFeaturestoresResponse) {
+ rpc ListFeaturestores(ListFeaturestoresRequest)
+ returns (ListFeaturestoresResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/featurestores"
};
@@ -74,7 +80,8 @@ service FeaturestoreService {
}
// Updates the parameters of a single Featurestore.
- rpc UpdateFeaturestore(UpdateFeaturestoreRequest) returns (google.longrunning.Operation) {
+ rpc UpdateFeaturestore(UpdateFeaturestoreRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{featurestore.name=projects/*/locations/*/featurestores/*}"
body: "featurestore"
@@ -88,7 +95,8 @@ service FeaturestoreService {
// Deletes a single Featurestore. The Featurestore must not contain any
// EntityTypes or `force` must be set to true for the request to succeed.
- rpc DeleteFeaturestore(DeleteFeaturestoreRequest) returns (google.longrunning.Operation) {
+ rpc DeleteFeaturestore(DeleteFeaturestoreRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/featurestores/*}"
};
@@ -101,7 +109,8 @@ service FeaturestoreService {
}
// Creates a new EntityType in a given Featurestore.
- rpc CreateEntityType(CreateEntityTypeRequest) returns (google.longrunning.Operation) {
+ rpc CreateEntityType(CreateEntityTypeRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/featurestores/*}/entityTypes"
body: "entity_type"
@@ -123,7 +132,8 @@ service FeaturestoreService {
}
// Lists EntityTypes in a given Featurestore.
- rpc ListEntityTypes(ListEntityTypesRequest) returns (ListEntityTypesResponse) {
+ rpc ListEntityTypes(ListEntityTypesRequest)
+ returns (ListEntityTypesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/featurestores/*}/entityTypes"
};
@@ -141,7 +151,8 @@ service FeaturestoreService {
// Deletes a single EntityType. The EntityType must not have any Features
// or `force` must be set to true for the request to succeed.
- rpc DeleteEntityType(DeleteEntityTypeRequest) returns (google.longrunning.Operation) {
+ rpc DeleteEntityType(DeleteEntityTypeRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*}"
};
@@ -154,7 +165,8 @@ service FeaturestoreService {
}
// Creates a new Feature in a given EntityType.
- rpc CreateFeature(CreateFeatureRequest) returns (google.longrunning.Operation) {
+ rpc CreateFeature(CreateFeatureRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/featurestores/*/entityTypes/*}/features"
body: "feature"
@@ -168,7 +180,8 @@ service FeaturestoreService {
}
// Creates a batch of Features in a given EntityType.
- rpc BatchCreateFeatures(BatchCreateFeaturesRequest) returns (google.longrunning.Operation) {
+ rpc BatchCreateFeatures(BatchCreateFeaturesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/featurestores/*/entityTypes/*}/features:batchCreate"
body: "*"
@@ -206,7 +219,8 @@ service FeaturestoreService {
}
// Deletes a single Feature.
- rpc DeleteFeature(DeleteFeatureRequest) returns (google.longrunning.Operation) {
+ rpc DeleteFeature(DeleteFeatureRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*}"
};
@@ -237,7 +251,8 @@ service FeaturestoreService {
// include but are not limited to changing storage location, storage class,
// or retention policy.
// - Online serving cluster is under-provisioned.
- rpc ImportFeatureValues(ImportFeatureValuesRequest) returns (google.longrunning.Operation) {
+ rpc ImportFeatureValues(ImportFeatureValuesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:importFeatureValues"
body: "*"
@@ -255,7 +270,8 @@ service FeaturestoreService {
// instance in the batch may read Feature values of entities from one or
// more EntityTypes. Point-in-time correctness is guaranteed for Feature
// values of each read instance as of each instance's read timestamp.
- rpc BatchReadFeatureValues(BatchReadFeatureValuesRequest) returns (google.longrunning.Operation) {
+ rpc BatchReadFeatureValues(BatchReadFeatureValuesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{featurestore=projects/*/locations/*/featurestores/*}:batchReadFeatureValues"
body: "*"
@@ -268,7 +284,8 @@ service FeaturestoreService {
}
// Exports Feature values from all the entities of a target EntityType.
- rpc ExportFeatureValues(ExportFeatureValuesRequest) returns (google.longrunning.Operation) {
+ rpc ExportFeatureValues(ExportFeatureValuesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:exportFeatureValues"
body: "*"
@@ -280,6 +297,29 @@ service FeaturestoreService {
};
}
+ // Delete Feature values from Featurestore.
+ //
+ // The progress of the deletion is tracked by the returned operation. The
+ // deleted feature values are guaranteed to be invisible to subsequent read
+ // operations after the operation is marked as successfully done.
+ //
+ // If a delete feature values operation fails, the feature values
+ // returned from reads and exports may be inconsistent. If consistency is
+ // required, the caller must retry the same delete request again and wait till
+ // the new operation returned is marked as successfully done.
+ rpc DeleteFeatureValues(DeleteFeatureValuesRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:deleteFeatureValues"
+ body: "*"
+ };
+ option (google.api.method_signature) = "entity_type";
+ option (google.longrunning.operation_info) = {
+ response_type: "DeleteFeatureValuesResponse"
+ metadata_type: "DeleteFeatureValuesOperationMetadata"
+ };
+ }
+
// Searches Features matching a query in a given project.
rpc SearchFeatures(SearchFeaturesRequest) returns (SearchFeaturesResponse) {
option (google.api.http) = {
@@ -290,7 +330,8 @@ service FeaturestoreService {
}
}
-// Request message for [FeaturestoreService.CreateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeaturestore].
+// Request message for
+// [FeaturestoreService.CreateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeaturestore].
message CreateFeaturestoreRequest {
// Required. The resource name of the Location to create Featurestores.
// Format:
@@ -305,8 +346,8 @@ message CreateFeaturestoreRequest {
// Required. The Featurestore to create.
Featurestore featurestore = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. The ID to use for this Featurestore, which will become the final component
- // of the Featurestore's resource name.
+ // Required. The ID to use for this Featurestore, which will become the final
+ // component of the Featurestore's resource name.
//
// This value may be up to 60 characters, and valid characters are
// `[a-z0-9_]`. The first character cannot be a number.
@@ -315,7 +356,8 @@ message CreateFeaturestoreRequest {
string featurestore_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [FeaturestoreService.GetFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.GetFeaturestore].
+// Request message for
+// [FeaturestoreService.GetFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.GetFeaturestore].
message GetFeaturestoreRequest {
// Required. The name of the Featurestore resource.
string name = 1 [
@@ -326,7 +368,8 @@ message GetFeaturestoreRequest {
];
}
-// Request message for [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores].
+// Request message for
+// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores].
message ListFeaturestoresRequest {
// Required. The resource name of the Location to list Featurestores.
// Format:
@@ -366,12 +409,12 @@ message ListFeaturestoresRequest {
int32 page_size = 3;
// A page token, received from a previous
- // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores] call.
- // Provide this to retrieve the subsequent page.
+ // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores] must
- // match the call that provided the page token.
+ // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]
+ // must match the call that provided the page token.
string page_token = 4;
// A comma-separated list of fields to order by, sorted in ascending order.
@@ -387,22 +430,24 @@ message ListFeaturestoresRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores].
+// Response message for
+// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores].
message ListFeaturestoresResponse {
// The Featurestores matching the request.
repeated Featurestore featurestores = 1;
- // A token, which can be sent as [ListFeaturestoresRequest.page_token][google.cloud.aiplatform.v1.ListFeaturestoresRequest.page_token] to
- // retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // A token, which can be sent as
+ // [ListFeaturestoresRequest.page_token][google.cloud.aiplatform.v1.ListFeaturestoresRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [FeaturestoreService.UpdateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeaturestore].
+// Request message for
+// [FeaturestoreService.UpdateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeaturestore].
message UpdateFeaturestoreRequest {
- // Required. The Featurestore's `name` field is used to identify the Featurestore to be
- // updated.
- // Format:
+ // Required. The Featurestore's `name` field is used to identify the
+ // Featurestore to be updated. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}`
Featurestore featurestore = 1 [(google.api.field_behavior) = REQUIRED];
@@ -419,10 +464,12 @@ message UpdateFeaturestoreRequest {
// * `labels`
// * `online_serving_config.fixed_node_count`
// * `online_serving_config.scaling`
+ // * `online_storage_ttl_days` (available in Preview)
google.protobuf.FieldMask update_mask = 2;
}
-// Request message for [FeaturestoreService.DeleteFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore].
+// Request message for
+// [FeaturestoreService.DeleteFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore].
message DeleteFeaturestoreRequest {
// Required. The name of the Featurestore to be deleted.
// Format:
@@ -440,12 +487,13 @@ message DeleteFeaturestoreRequest {
bool force = 2;
}
-// Request message for [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues].
+// Request message for
+// [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues].
message ImportFeatureValuesRequest {
// Defines the Feature value(s) to import.
message FeatureSpec {
- // Required. ID of the Feature to import values of. This Feature must exist in the
- // target EntityType, or the request will fail.
+ // Required. ID of the Feature to import values of. This Feature must exist
+ // in the target EntityType, or the request will fail.
string id = 1 [(google.api.field_behavior) = REQUIRED];
// Source column to get the Feature values from. If not set, uses the column
@@ -475,8 +523,8 @@ message ImportFeatureValuesRequest {
google.protobuf.Timestamp feature_time = 7;
}
- // Required. The resource name of the EntityType grouping the Features for which values
- // are being imported. Format:
+ // Required. The resource name of the EntityType grouping the Features for
+ // which values are being imported. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
string entity_type = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -489,10 +537,11 @@ message ImportFeatureValuesRequest {
// extracted from the column named `entity_id`.
string entity_id_field = 5;
- // Required. Specifications defining which Feature values to import from the entity. The
- // request fails if no feature_specs are provided, and having multiple
- // feature_specs for one Feature is not allowed.
- repeated FeatureSpec feature_specs = 8 [(google.api.field_behavior) = REQUIRED];
+ // Required. Specifications defining which Feature values to import from the
+ // entity. The request fails if no feature_specs are provided, and having
+ // multiple feature_specs for one Feature is not allowed.
+ repeated FeatureSpec feature_specs = 8
+ [(google.api.field_behavior) = REQUIRED];
// If set, data will not be imported for online serving. This
// is typically used for backfilling, where Feature generation timestamps are
@@ -511,7 +560,8 @@ message ImportFeatureValuesRequest {
bool disable_ingestion_analysis = 12;
}
-// Response message for [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues].
+// Response message for
+// [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues].
message ImportFeatureValuesResponse {
// Number of entities that have been imported by the operation.
int64 imported_entity_count = 1;
@@ -531,25 +581,30 @@ message ImportFeatureValuesResponse {
int64 timestamp_outside_retention_rows_count = 4;
}
-// Request message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].
+// Request message for
+// [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].
message BatchReadFeatureValuesRequest {
// Describe pass-through fields in read_instance source.
message PassThroughField {
- // Required. The name of the field in the CSV header or the name of the column in
- // BigQuery table. The naming restriction is the same as [Feature.name][google.cloud.aiplatform.v1.Feature.name].
+ // Required. The name of the field in the CSV header or the name of the
+ // column in BigQuery table. The naming restriction is the same as
+ // [Feature.name][google.cloud.aiplatform.v1.Feature.name].
string field_name = 1 [(google.api.field_behavior) = REQUIRED];
}
// Selects Features of an EntityType to read values of and specifies read
// settings.
message EntityTypeSpec {
- // Required. ID of the EntityType to select Features. The EntityType id is the
- // [entity_type_id][google.cloud.aiplatform.v1.CreateEntityTypeRequest.entity_type_id] specified
- // during EntityType creation.
+ // Required. ID of the EntityType to select Features. The EntityType id is
+ // the
+ // [entity_type_id][google.cloud.aiplatform.v1.CreateEntityTypeRequest.entity_type_id]
+ // specified during EntityType creation.
string entity_type_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. Selectors choosing which Feature values to read from the EntityType.
- FeatureSelector feature_selector = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. Selectors choosing which Feature values to read from the
+ // EntityType.
+ FeatureSelector feature_selector = 2
+ [(google.api.field_behavior) = REQUIRED];
// Per-Feature settings for the batch read.
repeated DestinationFeatureSetting settings = 3;
@@ -586,8 +641,8 @@ message BatchReadFeatureValuesRequest {
BigQuerySource bigquery_read_instances = 5;
}
- // Required. The resource name of the Featurestore from which to query Feature values.
- // Format:
+ // Required. The resource name of the Featurestore from which to query Feature
+ // values. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}`
string featurestore = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -597,7 +652,8 @@ message BatchReadFeatureValuesRequest {
];
// Required. Specifies output location and format.
- FeatureValueDestination destination = 4 [(google.api.field_behavior) = REQUIRED];
+ FeatureValueDestination destination = 4
+ [(google.api.field_behavior) = REQUIRED];
// When not empty, the specified fields in the *_read_instances source will be
// joined as-is in the output, in addition to those fields from the
@@ -608,20 +664,23 @@ message BatchReadFeatureValuesRequest {
// passed as opaque bytes.
repeated PassThroughField pass_through_fields = 8;
- // Required. Specifies EntityType grouping Features to read values of and settings.
- // Each EntityType referenced in
+ // Required. Specifies EntityType grouping Features to read values of and
+ // settings. Each EntityType referenced in
// [BatchReadFeatureValuesRequest.entity_type_specs] must have a column
// specifying entity IDs in the EntityType in
// [BatchReadFeatureValuesRequest.request][] .
- repeated EntityTypeSpec entity_type_specs = 7 [(google.api.field_behavior) = REQUIRED];
+ repeated EntityTypeSpec entity_type_specs = 7
+ [(google.api.field_behavior) = REQUIRED];
- // Optional. Excludes Feature values with feature generation timestamp before this
- // timestamp. If not set, retrieve oldest values kept in Feature Store.
+ // Optional. Excludes Feature values with feature generation timestamp before
+ // this timestamp. If not set, retrieve oldest values kept in Feature Store.
// Timestamp, if present, must not have higher than millisecond precision.
- google.protobuf.Timestamp start_time = 11 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.Timestamp start_time = 11
+ [(google.api.field_behavior) = OPTIONAL];
}
-// Request message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues].
+// Request message for
+// [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues].
message ExportFeatureValuesRequest {
// Describes exporting the latest Feature values of all entities of the
// EntityType between [start_time, snapshot_time].
@@ -662,8 +721,8 @@ message ExportFeatureValuesRequest {
FullExport full_export = 7;
}
- // Required. The resource name of the EntityType from which to export Feature values.
- // Format:
+ // Required. The resource name of the EntityType from which to export Feature
+ // values. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
string entity_type = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -673,7 +732,8 @@ message ExportFeatureValuesRequest {
];
// Required. Specifies destination location and format.
- FeatureValueDestination destination = 4 [(google.api.field_behavior) = REQUIRED];
+ FeatureValueDestination destination = 4
+ [(google.api.field_behavior) = REQUIRED];
// Required. Selects Features to export values of.
FeatureSelector feature_selector = 5 [(google.api.field_behavior) = REQUIRED];
@@ -695,8 +755,10 @@ message DestinationFeatureSetting {
message FeatureValueDestination {
oneof destination {
// Output in BigQuery format.
- // [BigQueryDestination.output_uri][google.cloud.aiplatform.v1.BigQueryDestination.output_uri] in
- // [FeatureValueDestination.bigquery_destination][google.cloud.aiplatform.v1.FeatureValueDestination.bigquery_destination] must refer to a table.
+ // [BigQueryDestination.output_uri][google.cloud.aiplatform.v1.BigQueryDestination.output_uri]
+ // in
+ // [FeatureValueDestination.bigquery_destination][google.cloud.aiplatform.v1.FeatureValueDestination.bigquery_destination]
+ // must refer to a table.
BigQueryDestination bigquery_destination = 1;
// Output in TFRecord format.
@@ -718,17 +780,16 @@ message FeatureValueDestination {
}
}
-// Response message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues].
-message ExportFeatureValuesResponse {
-
-}
-
-// Response message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].
-message BatchReadFeatureValuesResponse {
+// Response message for
+// [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues].
+message ExportFeatureValuesResponse {}
-}
+// Response message for
+// [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].
+message BatchReadFeatureValuesResponse {}
-// Request message for [FeaturestoreService.CreateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.CreateEntityType].
+// Request message for
+// [FeaturestoreService.CreateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.CreateEntityType].
message CreateEntityTypeRequest {
// Required. The resource name of the Featurestore to create EntityTypes.
// Format:
@@ -743,8 +804,8 @@ message CreateEntityTypeRequest {
// The EntityType to create.
EntityType entity_type = 2;
- // Required. The ID to use for the EntityType, which will become the final component of
- // the EntityType's resource name.
+ // Required. The ID to use for the EntityType, which will become the final
+ // component of the EntityType's resource name.
//
// This value may be up to 60 characters, and valid characters are
// `[a-z0-9_]`. The first character cannot be a number.
@@ -753,7 +814,8 @@ message CreateEntityTypeRequest {
string entity_type_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [FeaturestoreService.GetEntityType][google.cloud.aiplatform.v1.FeaturestoreService.GetEntityType].
+// Request message for
+// [FeaturestoreService.GetEntityType][google.cloud.aiplatform.v1.FeaturestoreService.GetEntityType].
message GetEntityTypeRequest {
// Required. The name of the EntityType resource.
// Format:
@@ -766,7 +828,8 @@ message GetEntityTypeRequest {
];
}
-// Request message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes].
+// Request message for
+// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes].
message ListEntityTypesRequest {
// Required. The resource name of the Featurestore to list EntityTypes.
// Format:
@@ -805,12 +868,12 @@ message ListEntityTypesRequest {
int32 page_size = 3;
// A page token, received from a previous
- // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes] call.
- // Provide this to retrieve the subsequent page.
+ // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes] must
- // match the call that provided the page token.
+ // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes]
+ // must match the call that provided the page token.
string page_token = 4;
// A comma-separated list of fields to order by, sorted in ascending order.
@@ -827,22 +890,24 @@ message ListEntityTypesRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes].
+// Response message for
+// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes].
message ListEntityTypesResponse {
// The EntityTypes matching the request.
repeated EntityType entity_types = 1;
- // A token, which can be sent as [ListEntityTypesRequest.page_token][google.cloud.aiplatform.v1.ListEntityTypesRequest.page_token] to
- // retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // A token, which can be sent as
+ // [ListEntityTypesRequest.page_token][google.cloud.aiplatform.v1.ListEntityTypesRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [FeaturestoreService.UpdateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.UpdateEntityType].
+// Request message for
+// [FeaturestoreService.UpdateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.UpdateEntityType].
message UpdateEntityTypeRequest {
- // Required. The EntityType's `name` field is used to identify the EntityType to be
- // updated.
- // Format:
+ // Required. The EntityType's `name` field is used to identify the EntityType
+ // to be updated. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
EntityType entity_type = 1 [(google.api.field_behavior) = REQUIRED];
@@ -865,6 +930,7 @@ message UpdateEntityTypeRequest {
// * `monitoring_config.import_features_analysis.anomaly_detection_baseline`
// * `monitoring_config.numerical_threshold_config.value`
// * `monitoring_config.categorical_threshold_config.value`
+ // * `offline_storage_ttl_days` (available in Preview)
google.protobuf.FieldMask update_mask = 2;
}
@@ -885,7 +951,8 @@ message DeleteEntityTypeRequest {
bool force = 2;
}
-// Request message for [FeaturestoreService.CreateFeature][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeature].
+// Request message for
+// [FeaturestoreService.CreateFeature][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeature].
message CreateFeatureRequest {
// Required. The resource name of the EntityType to create a Feature.
// Format:
@@ -900,8 +967,8 @@ message CreateFeatureRequest {
// Required. The Feature to create.
Feature feature = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. The ID to use for the Feature, which will become the final component of
- // the Feature's resource name.
+ // Required. The ID to use for the Feature, which will become the final
+ // component of the Feature's resource name.
//
// This value may be up to 128 characters, and valid characters are
// `[a-z0-9_]`. The first character cannot be a number.
@@ -910,10 +977,11 @@ message CreateFeatureRequest {
string feature_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures].
+// Request message for
+// [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures].
message BatchCreateFeaturesRequest {
- // Required. The resource name of the EntityType to create the batch of Features under.
- // Format:
+ // Required. The resource name of the EntityType to create the batch of
+ // Features under. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -922,20 +990,24 @@ message BatchCreateFeaturesRequest {
}
];
- // Required. The request message specifying the Features to create. All Features must be
- // created under the same parent EntityType. The `parent` field in each child
- // request message can be omitted. If `parent` is set in a child request, then
- // the value must match the `parent` value in this request message.
- repeated CreateFeatureRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The request message specifying the Features to create. All
+ // Features must be created under the same parent EntityType. The `parent`
+ // field in each child request message can be omitted. If `parent` is set in a
+ // child request, then the value must match the `parent` value in this request
+ // message.
+ repeated CreateFeatureRequest requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures].
+// Response message for
+// [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures].
message BatchCreateFeaturesResponse {
// The Features created.
repeated Feature features = 1;
}
-// Request message for [FeaturestoreService.GetFeature][google.cloud.aiplatform.v1.FeaturestoreService.GetFeature].
+// Request message for
+// [FeaturestoreService.GetFeature][google.cloud.aiplatform.v1.FeaturestoreService.GetFeature].
message GetFeatureRequest {
// Required. The name of the Feature resource.
// Format:
@@ -948,7 +1020,8 @@ message GetFeatureRequest {
];
}
-// Request message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures].
+// Request message for
+// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures].
message ListFeaturesRequest {
// Required. The resource name of the Location to list Features.
// Format:
@@ -989,12 +1062,12 @@ message ListFeaturesRequest {
int32 page_size = 3;
// A page token, received from a previous
- // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures] call.
- // Provide this to retrieve the subsequent page.
+ // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures] must
- // match the call that provided the page token.
+ // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
+ // must match the call that provided the page token.
string page_token = 4;
// A comma-separated list of fields to order by, sorted in ascending order.
@@ -1010,25 +1083,30 @@ message ListFeaturesRequest {
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 6;
- // If set, return the most recent [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count]
+ // If set, return the most recent
+ // [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count]
// of stats for each Feature in response. Valid value is [0, 10]. If number of
- // stats exists < [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count], return all
- // existing stats.
+ // stats exists <
+ // [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count],
+ // return all existing stats.
int32 latest_stats_count = 7;
}
-// Response message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures].
+// Response message for
+// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures].
message ListFeaturesResponse {
// The Features matching the request.
repeated Feature features = 1;
- // A token, which can be sent as [ListFeaturesRequest.page_token][google.cloud.aiplatform.v1.ListFeaturesRequest.page_token] to
- // retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // A token, which can be sent as
+ // [ListFeaturesRequest.page_token][google.cloud.aiplatform.v1.ListFeaturesRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures].
+// Request message for
+// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures].
message SearchFeaturesRequest {
// Required. The resource name of the Location to search Features.
// Format:
@@ -1108,16 +1186,17 @@ message SearchFeaturesRequest {
int32 page_size = 4;
// A page token, received from a previous
- // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures] call.
- // Provide this to retrieve the subsequent page.
+ // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures], except `page_size`, must
- // match the call that provided the page token.
+ // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures],
+ // except `page_size`, must match the call that provided the page token.
string page_token = 5;
}
-// Response message for [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures].
+// Response message for
+// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures].
message SearchFeaturesResponse {
// The Features matching the request.
//
@@ -1130,13 +1209,15 @@ message SearchFeaturesResponse {
// * `update_time`
repeated Feature features = 1;
- // A token, which can be sent as [SearchFeaturesRequest.page_token][google.cloud.aiplatform.v1.SearchFeaturesRequest.page_token] to
- // retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // A token, which can be sent as
+ // [SearchFeaturesRequest.page_token][google.cloud.aiplatform.v1.SearchFeaturesRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [FeaturestoreService.UpdateFeature][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeature].
+// Request message for
+// [FeaturestoreService.UpdateFeature][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeature].
message UpdateFeatureRequest {
// Required. The Feature's `name` field is used to identify the Feature to be
// updated.
@@ -1160,7 +1241,8 @@ message UpdateFeatureRequest {
google.protobuf.FieldMask update_mask = 2;
}
-// Request message for [FeaturestoreService.DeleteFeature][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeature].
+// Request message for
+// [FeaturestoreService.DeleteFeature][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeature].
message DeleteFeatureRequest {
// Required. The name of the Features to be deleted.
// Format:
@@ -1223,6 +1305,12 @@ message BatchReadFeatureValuesOperationMetadata {
GenericOperationMetadata generic_metadata = 1;
}
+// Details of operations that delete Feature values.
+message DeleteFeatureValuesOperationMetadata {
+ // Operation metadata for Featurestore delete Features values.
+ GenericOperationMetadata generic_metadata = 1;
+}
+
// Details of operations that perform create EntityType.
message CreateEntityTypeOperationMetadata {
// Operation metadata for EntityType.
@@ -1240,3 +1328,120 @@ message BatchCreateFeaturesOperationMetadata {
// Operation metadata for Feature.
GenericOperationMetadata generic_metadata = 1;
}
+
+// Request message for
+// [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeatureValues].
+message DeleteFeatureValuesRequest {
+ // Message to select entity.
+ // If an entity id is selected, all the feature values corresponding to the
+ // entity id will be deleted, including the entityId.
+ message SelectEntity {
+ // Required. Selectors choosing feature values of which entity id to be
+ // deleted from the EntityType.
+ EntityIdSelector entity_id_selector = 1
+ [(google.api.field_behavior) = REQUIRED];
+ }
+
+ // Message to select time range and feature.
+ // Values of the selected feature generated within an inclusive time range
+ // will be deleted. Using this option permanently deletes the feature values
+ // from the specified feature IDs within the specified time range.
+ // This might include data from the online storage. If you want to retain
+ // any deleted historical data in the online storage, you must re-ingest it.
+ message SelectTimeRangeAndFeature {
+ // Required. Select feature generated within a half-inclusive time range.
+ // The time range is lower inclusive and upper exclusive.
+ google.type.Interval time_range = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Selectors choosing which feature values to be deleted from the
+ // EntityType.
+ FeatureSelector feature_selector = 2
+ [(google.api.field_behavior) = REQUIRED];
+
+ // If set, data will not be deleted from online storage.
+ // When time range is older than the data in online storage, setting this to
+ // be true will make the deletion have no impact on online serving.
+ bool skip_online_storage_delete = 3;
+ }
+
+ // Defines options to select feature values to be deleted.
+ oneof DeleteOption {
+ // Select feature values to be deleted by specifying entities.
+ SelectEntity select_entity = 2;
+
+ // Select feature values to be deleted by specifying time range and
+ // features.
+ SelectTimeRangeAndFeature select_time_range_and_feature = 3;
+ }
+
+ // Required. The resource name of the EntityType grouping the Features for
+ // which values are being deleted from. Format:
+ // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
+ string entity_type = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/EntityType"
+ }
+ ];
+}
+
+// Response message for
+// [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeatureValues].
+message DeleteFeatureValuesResponse {
+ // Response message if the request uses the SelectEntity option.
+ message SelectEntity {
+ // The count of deleted entity rows in the offline storage.
+ // Each row corresponds to the combination of an entity ID and a timestamp.
+ // One entity ID can have multiple rows in the offline storage.
+ int64 offline_storage_deleted_entity_row_count = 1;
+
+ // The count of deleted entities in the online storage.
+ // Each entity ID corresponds to one entity.
+ int64 online_storage_deleted_entity_count = 2;
+ }
+
+ // Response message if the request uses the SelectTimeRangeAndFeature option.
+ message SelectTimeRangeAndFeature {
+ // The count of the features or columns impacted.
+ // This is the same as the feature count in the request.
+ int64 impacted_feature_count = 1;
+
+ // The count of modified entity rows in the offline storage.
+ // Each row corresponds to the combination of an entity ID and a timestamp.
+ // One entity ID can have multiple rows in the offline storage.
+ // Within each row, only the features specified in the request are
+ // deleted.
+ int64 offline_storage_modified_entity_row_count = 2;
+
+ // The count of modified entities in the online storage.
+ // Each entity ID corresponds to one entity.
+ // Within each entity, only the features specified in the request are
+ // deleted.
+ int64 online_storage_modified_entity_count = 3;
+ }
+
+ // Response based on which delete option is specified in the
+ // request
+ oneof response {
+ // Response for request specifying the entities to delete
+ SelectEntity select_entity = 1;
+
+ // Response for request specifying time range and feature
+ SelectTimeRangeAndFeature select_time_range_and_feature = 2;
+ }
+}
+
+// Selector for entityId. Getting ids from the given source.
+message EntityIdSelector {
+ // Details about the source data, including the location of the storage and
+ // the format.
+ oneof EntityIdsSource {
+ // Source of Csv
+ CsvSource csv_source = 3;
+ }
+
+ // Source column that holds entity IDs. If not provided, entity IDs are
+ // extracted from the column named `entity_id`.
+ string entity_id_field = 5;
+}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto
index 77dc1ec53..5f80864e3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto
@@ -26,7 +26,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "HyperparameterTuningJobProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -66,8 +66,8 @@ message HyperparameterTuningJob {
// before the whole job fails.
int32 max_failed_trial_count = 7;
- // Required. The spec of a trial job. The same spec applies to the CustomJobs created
- // in all the trials.
+ // Required. The spec of a trial job. The same spec applies to the CustomJobs
+ // created in all the trials.
CustomJobSpec trial_job_spec = 8 [(google.api.field_behavior) = REQUIRED];
// Output only. Trials of the HyperparameterTuningJob.
@@ -77,18 +77,24 @@ message HyperparameterTuningJob {
JobState state = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the HyperparameterTuningJob was created.
- google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Time when the HyperparameterTuningJob for the first time entered the
- // `JOB_STATE_RUNNING` state.
- google.protobuf.Timestamp start_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Time when the HyperparameterTuningJob entered any of the following states:
- // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
- google.protobuf.Timestamp end_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Time when the HyperparameterTuningJob was most recently updated.
- google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the HyperparameterTuningJob for the first time
+ // entered the `JOB_STATE_RUNNING` state.
+ google.protobuf.Timestamp start_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the HyperparameterTuningJob entered any of the
+ // following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
+ // `JOB_STATE_CANCELLED`.
+ google.protobuf.Timestamp end_time = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the HyperparameterTuningJob was most recently
+ // updated.
+ google.protobuf.Timestamp update_time = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Only populated when job's state is JOB_STATE_FAILED or
// JOB_STATE_CANCELLED.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/index.proto b/third_party/googleapis/google/cloud/aiplatform/v1/index.proto
index 28022afce..559f3485a 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/index.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/index.proto
@@ -23,7 +23,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "IndexProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -64,10 +64,10 @@ message Index {
// The description of the Index.
string description = 3;
- // Immutable. Points to a YAML file stored on Google Cloud Storage describing additional
- // information about the Index, that is specific to it. Unset if the Index
- // does not have any additional information.
- // The schema is defined as an OpenAPI 3.0.2 [Schema
+ // Immutable. Points to a YAML file stored on Google Cloud Storage describing
+ // additional information about the Index, that is specific to it. Unset if
+ // the Index does not have any additional information. The schema is defined
+ // as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
// Note: The URI given on output will be immutable and probably different,
// including the URI scheme, than the one given on input. The output URI will
@@ -75,13 +75,15 @@ message Index {
string metadata_schema_uri = 4 [(google.api.field_behavior) = IMMUTABLE];
// An additional information about the Index; the schema of the metadata can
- // be found in [metadata_schema][google.cloud.aiplatform.v1.Index.metadata_schema_uri].
+ // be found in
+ // [metadata_schema][google.cloud.aiplatform.v1.Index.metadata_schema_uri].
google.protobuf.Value metadata = 6;
// Output only. The pointers to DeployedIndexes created from this Index.
// An Index can be only deleted if all its DeployedIndexes had been undeployed
// first.
- repeated DeployedIndexRef deployed_indexes = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated DeployedIndexRef deployed_indexes = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Used to perform consistent read-modify-write updates. If not set, a blind
// "overwrite" update happens.
@@ -97,24 +99,27 @@ message Index {
map labels = 9;
// Output only. Timestamp when this Index was created.
- google.protobuf.Timestamp create_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Index was most recently updated.
// This also includes any update to the contents of the Index.
// Note that Operations working on this Index may have their
// [Operations.metadata.generic_metadata.update_time]
- // [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little after the value of this
- // timestamp, yet that does not mean their results are not already reflected
- // in the Index. Result of any successfully completed Operation on the Index
- // is reflected in it.
- google.protobuf.Timestamp update_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little
+ // after the value of this timestamp, yet that does not mean their results are
+ // not already reflected in the Index. Result of any successfully completed
+ // Operation on the Index is reflected in it.
+ google.protobuf.Timestamp update_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Stats of the index resource.
IndexStats index_stats = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be
- // used by default.
- IndexUpdateMethod index_update_method = 16 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. The update method to use with this Index. If not set,
+ // BATCH_UPDATE will be used by default.
+ IndexUpdateMethod index_update_method = 16
+ [(google.api.field_behavior) = IMMUTABLE];
}
// A datapoint of Index.
@@ -151,14 +156,14 @@ message IndexDatapoint {
// [NearestNeighborSearchConfig.dimensions].
repeated float feature_vector = 2 [(google.api.field_behavior) = REQUIRED];
- // Optional. List of Restrict of the datapoint, used to perform "restricted searches"
- // where boolean rule are used to filter the subset of the database eligible
- // for matching.
- // See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
+ // Optional. List of Restrict of the datapoint, used to perform "restricted
+ // searches" where boolean rule are used to filter the subset of the database
+ // eligible for matching. See:
+ // https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
repeated Restriction restricts = 4 [(google.api.field_behavior) = OPTIONAL];
- // Optional. CrowdingTag of the datapoint, the number of neighbors to return in each
- // crowding can be configured during query.
+ // Optional. CrowdingTag of the datapoint, the number of neighbors to return
+ // in each crowding can be configured during query.
CrowdingTag crowding_tag = 5 [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/index_endpoint.proto b/third_party/googleapis/google/cloud/aiplatform/v1/index_endpoint.proto
index a5e36557e..6fbbb8817 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/index_endpoint.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/index_endpoint.proto
@@ -19,10 +19,11 @@ package google.cloud.aiplatform.v1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1/machine_resources.proto";
+import "google/cloud/aiplatform/v1/service_networking.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "IndexEndpointProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -49,7 +50,8 @@ message IndexEndpoint {
string description = 3;
// Output only. The indexes deployed in this endpoint.
- repeated DeployedIndex deployed_indexes = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated DeployedIndex deployed_indexes = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Used to perform consistent read-modify-write updates. If not set, a blind
// "overwrite" update happens.
@@ -65,13 +67,15 @@ message IndexEndpoint {
map labels = 6;
// Output only. Timestamp when this IndexEndpoint was created.
- google.protobuf.Timestamp create_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this IndexEndpoint was last updated.
// This timestamp is not updated when the endpoint's DeployedIndexes are
// updated, e.g. due to updates of the original Indexes they are the
// deployments of.
- google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The full name of the Google Compute Engine
// [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
@@ -90,15 +94,23 @@ message IndexEndpoint {
// network name.
string network = 9 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Deprecated: If true, expose the IndexEndpoint via private service connect.
+ // Optional. Deprecated: If true, expose the IndexEndpoint via private service
+ // connect.
//
- // Only one of the fields, [network][google.cloud.aiplatform.v1.IndexEndpoint.network] or
+ // Only one of the fields,
+ // [network][google.cloud.aiplatform.v1.IndexEndpoint.network] or
// [enable_private_service_connect][google.cloud.aiplatform.v1.IndexEndpoint.enable_private_service_connect],
// can be set.
- bool enable_private_service_connect = 10 [
- deprecated = true,
- (google.api.field_behavior) = OPTIONAL
- ];
+ bool enable_private_service_connect = 10
+ [deprecated = true, (google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Configuration for private service connect.
+ //
+ // [network][google.cloud.aiplatform.v1.IndexEndpoint.network] and
+ // [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config]
+ // are mutually exclusive.
+ PrivateServiceConnectConfig private_service_connect_config = 12
+ [(google.api.field_behavior) = OPTIONAL];
}
// A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.
@@ -123,18 +135,22 @@ message DeployedIndex {
string display_name = 3;
// Output only. Timestamp when the DeployedIndex was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Provides paths for users to send requests directly to the deployed index
- // services running on Cloud via private services access. This field is
- // populated if [network][google.cloud.aiplatform.v1.IndexEndpoint.network] is configured.
- IndexPrivateEndpoints private_endpoints = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The DeployedIndex may depend on various data on its original Index.
- // Additionally when certain changes to the original Index are being done
- // (e.g. when what the Index contains is being changed) the DeployedIndex may
- // be asynchronously updated in the background to reflect this changes.
- // If this timestamp's value is at least the [Index.update_time][google.cloud.aiplatform.v1.Index.update_time] of the
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Provides paths for users to send requests directly to the
+ // deployed index services running on Cloud via private services access. This
+ // field is populated if
+ // [network][google.cloud.aiplatform.v1.IndexEndpoint.network] is configured.
+ IndexPrivateEndpoints private_endpoints = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The DeployedIndex may depend on various data on its original
+ // Index. Additionally when certain changes to the original Index are being
+ // done (e.g. when what the Index contains is being changed) the DeployedIndex
+ // may be asynchronously updated in the background to reflect this changes. If
+ // this timestamp's value is at least the
+ // [Index.update_time][google.cloud.aiplatform.v1.Index.update_time] of the
// original Index, it means that this DeployedIndex and the original Index are
// in sync. If this timestamp is older, then to see which updates this
// DeployedIndex already contains (and which not), one must
@@ -144,30 +160,41 @@ message DeployedIndex {
// [Operations.metadata.generic_metadata.update_time]
// [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time]
// equal or before this sync time are contained in this DeployedIndex.
- google.protobuf.Timestamp index_sync_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp index_sync_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. A description of resources that the DeployedIndex uses, which to large
- // degree are decided by Vertex AI, and optionally allows only a modest
+ // Optional. A description of resources that the DeployedIndex uses, which to
+ // large degree are decided by Vertex AI, and optionally allows only a modest
// additional configuration.
// If min_replica_count is not set, the default value is 2 (we don't provide
// SLA when min_replica_count=1). If max_replica_count is not set, the
// default value is min_replica_count. The max allowed replica count is
// 1000.
- AutomaticResources automatic_resources = 7 [(google.api.field_behavior) = OPTIONAL];
-
- // Optional. A description of resources that are dedicated to the DeployedIndex, and
- // that need a higher degree of manual configuration.
- // If min_replica_count is not set, the default value is 2 (we don't provide
- // SLA when min_replica_count=1). If max_replica_count is not set, the
- // default value is min_replica_count. The max allowed replica count is
- // 1000.
+ AutomaticResources automatic_resources = 7
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. A description of resources that are dedicated to the
+ // DeployedIndex, and that need a higher degree of manual configuration. If
+ // min_replica_count is not set, the default value is 2 (we don't provide SLA
+ // when min_replica_count=1). If max_replica_count is not set, the default
+ // value is min_replica_count. The max allowed replica count is 1000.
+ //
+ // Available machine types for SMALL shard:
+ // e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
+ //
+ // Available machine types for MEDIUM shard:
+ // e2-standard-16 and all machine types available for LARGE shard.
+ //
+ // Available machine types for LARGE shard:
+ // e2-highmem-16, n2d-standard-32.
//
- // Available machine types:
- // n1-standard-16
- // n1-standard-32
- DedicatedResources dedicated_resources = 16 [(google.api.field_behavior) = OPTIONAL];
+ // n1-standard-16 and n1-standard-32 are still available, but we recommend
+ // e2-standard-16 and e2-highmem-16 for cost efficiency.
+ DedicatedResources dedicated_resources = 16
+ [(google.api.field_behavior) = OPTIONAL];
- // Optional. If true, private endpoint's access logs are sent to StackDriver Logging.
+ // Optional. If true, private endpoint's access logs are sent to StackDriver
+ // Logging.
//
// These logs are like standard server access logs, containing
// information like timestamp and latency for each MatchRequest.
@@ -178,7 +205,8 @@ message DeployedIndex {
bool enable_access_logging = 8 [(google.api.field_behavior) = OPTIONAL];
// Optional. If set, the authentication is enabled for the private endpoint.
- DeployedIndexAuthConfig deployed_index_auth_config = 9 [(google.api.field_behavior) = OPTIONAL];
+ DeployedIndexAuthConfig deployed_index_auth_config = 9
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. A list of reserved ip ranges under the VPC network that can be
// used for this DeployedIndex.
@@ -190,7 +218,8 @@ message DeployedIndex {
// The value sohuld be the name of the address
// (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
// Example: 'vertex-ai-ip-range'.
- repeated string reserved_ip_ranges = 10 [(google.api.field_behavior) = OPTIONAL];
+ repeated string reserved_ip_ranges = 10
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. The deployment group can be no longer than 64 characters (eg:
// 'test', 'prod'). If not set, we will use the 'default' deployment group.
@@ -239,7 +268,7 @@ message IndexPrivateEndpoints {
// Output only. The ip address used to send match gRPC requests.
string match_grpc_address = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The name of the service attachment resource. Populated if private service
- // connect is enabled.
+ // Output only. The name of the service attachment resource. Populated if
+ // private service connect is enabled.
string service_attachment = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/index_endpoint_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/index_endpoint_service.proto
index 8acdb5bc6..f1be91add 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/index_endpoint_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/index_endpoint_service.proto
@@ -23,10 +23,11 @@ import "google/api/resource.proto";
import "google/cloud/aiplatform/v1/index_endpoint.proto";
import "google/cloud/aiplatform/v1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "IndexEndpointServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -36,10 +37,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// A service for managing Vertex AI's IndexEndpoints.
service IndexEndpointService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates an IndexEndpoint.
- rpc CreateIndexEndpoint(CreateIndexEndpointRequest) returns (google.longrunning.Operation) {
+ rpc CreateIndexEndpoint(CreateIndexEndpointRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/indexEndpoints"
body: "index_endpoint"
@@ -60,7 +63,8 @@ service IndexEndpointService {
}
// Lists IndexEndpoints in a Location.
- rpc ListIndexEndpoints(ListIndexEndpointsRequest) returns (ListIndexEndpointsResponse) {
+ rpc ListIndexEndpoints(ListIndexEndpointsRequest)
+ returns (ListIndexEndpointsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/indexEndpoints"
};
@@ -77,7 +81,8 @@ service IndexEndpointService {
}
// Deletes an IndexEndpoint.
- rpc DeleteIndexEndpoint(DeleteIndexEndpointRequest) returns (google.longrunning.Operation) {
+ rpc DeleteIndexEndpoint(DeleteIndexEndpointRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/indexEndpoints/*}"
};
@@ -105,7 +110,8 @@ service IndexEndpointService {
// Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it,
// and freeing all resources it's using.
- rpc UndeployIndex(UndeployIndexRequest) returns (google.longrunning.Operation) {
+ rpc UndeployIndex(UndeployIndexRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:undeployIndex"
body: "*"
@@ -118,7 +124,8 @@ service IndexEndpointService {
}
// Update an existing DeployedIndex under an IndexEndpoint.
- rpc MutateDeployedIndex(MutateDeployedIndexRequest) returns (google.longrunning.Operation) {
+ rpc MutateDeployedIndex(MutateDeployedIndexRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:mutateDeployedIndex"
body: "deployed_index"
@@ -131,7 +138,8 @@ service IndexEndpointService {
}
}
-// Request message for [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint].
+// Request message for
+// [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint].
message CreateIndexEndpointRequest {
// Required. The resource name of the Location to create the IndexEndpoint in.
// Format: `projects/{project}/locations/{location}`
@@ -153,7 +161,8 @@ message CreateIndexEndpointOperationMetadata {
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpoint]
+// Request message for
+// [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpoint]
message GetIndexEndpointRequest {
// Required. The name of the IndexEndpoint resource.
// Format:
@@ -166,10 +175,11 @@ message GetIndexEndpointRequest {
];
}
-// Request message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].
+// Request message for
+// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].
message ListIndexEndpointsRequest {
- // Required. The resource name of the Location from which to list the IndexEndpoints.
- // Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location from which to list the
+ // IndexEndpoints. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -177,8 +187,8 @@ message ListIndexEndpointsRequest {
}
];
- // Optional. An expression for filtering the results of the request. For field names
- // both snake_case and camelCase are supported.
+ // Optional. An expression for filtering the results of the request. For field
+ // names both snake_case and camelCase are supported.
//
// * `index_endpoint` supports = and !=. `index_endpoint` represents the
// IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
@@ -202,34 +212,44 @@ message ListIndexEndpointsRequest {
// Optional. The standard list page token.
// Typically obtained via
- // [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token] of the previous
- // [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints] call.
+ // [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token]
+ // of the previous
+ // [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints]
+ // call.
string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. Mask specifying which fields to read.
- google.protobuf.FieldMask read_mask = 5 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.FieldMask read_mask = 5
+ [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].
+// Response message for
+// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].
message ListIndexEndpointsResponse {
// List of IndexEndpoints in the requested page.
repeated IndexEndpoint index_endpoints = 1;
// A token to retrieve next page of results.
- // Pass to [ListIndexEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListIndexEndpointsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListIndexEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListIndexEndpointsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint].
+// Request message for
+// [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint].
message UpdateIndexEndpointRequest {
// Required. The IndexEndpoint which replaces the resource on the server.
IndexEndpoint index_endpoint = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The update mask applies to the resource. See
+ // [google.protobuf.FieldMask][google.protobuf.FieldMask].
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpoint].
+// Request message for
+// [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpoint].
message DeleteIndexEndpointRequest {
// Required. The name of the IndexEndpoint resource to be deleted.
// Format:
@@ -242,10 +262,11 @@ message DeleteIndexEndpointRequest {
];
}
-// Request message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].
+// Request message for
+// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].
message DeployIndexRequest {
- // Required. The name of the IndexEndpoint resource into which to deploy an Index.
- // Format:
+ // Required. The name of the IndexEndpoint resource into which to deploy an
+ // Index. Format:
// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
string index_endpoint = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -258,13 +279,15 @@ message DeployIndexRequest {
DeployedIndex deployed_index = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].
+// Response message for
+// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].
message DeployIndexResponse {
// The DeployedIndex that had been deployed in the IndexEndpoint.
DeployedIndex deployed_index = 1;
}
-// Runtime operation information for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].
+// Runtime operation information for
+// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].
message DeployIndexOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
@@ -273,10 +296,11 @@ message DeployIndexOperationMetadata {
string deployed_index_id = 2;
}
-// Request message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].
+// Request message for
+// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].
message UndeployIndexRequest {
- // Required. The name of the IndexEndpoint resource from which to undeploy an Index.
- // Format:
+ // Required. The name of the IndexEndpoint resource from which to undeploy an
+ // Index. Format:
// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
string index_endpoint = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -285,25 +309,27 @@ message UndeployIndexRequest {
}
];
- // Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
+ // Required. The ID of the DeployedIndex to be undeployed from the
+ // IndexEndpoint.
string deployed_index_id = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].
-message UndeployIndexResponse {
+// Response message for
+// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].
+message UndeployIndexResponse {}
-}
-
-// Runtime operation information for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].
+// Runtime operation information for
+// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].
message UndeployIndexOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].
+// Request message for
+// [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].
message MutateDeployedIndexRequest {
- // Required. The name of the IndexEndpoint resource into which to deploy an Index.
- // Format:
+ // Required. The name of the IndexEndpoint resource into which to deploy an
+ // Index. Format:
// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
string index_endpoint = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -318,7 +344,8 @@ message MutateDeployedIndexRequest {
DeployedIndex deployed_index = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].
+// Response message for
+// [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].
message MutateDeployedIndexResponse {
// The DeployedIndex that had been updated in the IndexEndpoint.
DeployedIndex deployed_index = 1;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/index_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/index_service.proto
index 0f6c63256..2fc0a1970 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/index_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/index_service.proto
@@ -23,10 +23,11 @@ import "google/api/resource.proto";
import "google/cloud/aiplatform/v1/index.proto";
import "google/cloud/aiplatform/v1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "IndexServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -36,7 +37,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// A service for creating and managing Vertex AI's Index resources.
service IndexService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates an Index.
rpc CreateIndex(CreateIndexRequest) returns (google.longrunning.Operation) {
@@ -82,7 +84,8 @@ service IndexService {
// Deletes an Index.
// An Index can only be deleted when all its
- // [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had been undeployed.
+ // [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had
+ // been undeployed.
rpc DeleteIndex(DeleteIndexRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/indexes/*}"
@@ -95,7 +98,8 @@ service IndexService {
}
// Add/update Datapoints into an Index.
- rpc UpsertDatapoints(UpsertDatapointsRequest) returns (UpsertDatapointsResponse) {
+ rpc UpsertDatapoints(UpsertDatapointsRequest)
+ returns (UpsertDatapointsResponse) {
option (google.api.http) = {
post: "/v1/{index=projects/*/locations/*/indexes/*}:upsertDatapoints"
body: "*"
@@ -103,7 +107,8 @@ service IndexService {
}
// Remove Datapoints from an Index.
- rpc RemoveDatapoints(RemoveDatapointsRequest) returns (RemoveDatapointsResponse) {
+ rpc RemoveDatapoints(RemoveDatapointsRequest)
+ returns (RemoveDatapointsResponse) {
option (google.api.http) = {
post: "/v1/{index=projects/*/locations/*/indexes/*}:removeDatapoints"
body: "*"
@@ -111,7 +116,8 @@ service IndexService {
}
}
-// Request message for [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex].
+// Request message for
+// [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex].
message CreateIndexRequest {
// Required. The resource name of the Location to create the Index in.
// Format: `projects/{project}/locations/{location}`
@@ -126,16 +132,19 @@ message CreateIndexRequest {
Index index = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Runtime operation information for [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex].
+// Runtime operation information for
+// [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex].
message CreateIndexOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
// The operation metadata with regard to Matching Engine Index operation.
- NearestNeighborSearchOperationMetadata nearest_neighbor_search_operation_metadata = 2;
+ NearestNeighborSearchOperationMetadata
+ nearest_neighbor_search_operation_metadata = 2;
}
-// Request message for [IndexService.GetIndex][google.cloud.aiplatform.v1.IndexService.GetIndex]
+// Request message for
+// [IndexService.GetIndex][google.cloud.aiplatform.v1.IndexService.GetIndex]
message GetIndexRequest {
// Required. The name of the Index resource.
// Format:
@@ -148,7 +157,8 @@ message GetIndexRequest {
];
}
-// Request message for [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes].
+// Request message for
+// [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes].
message ListIndexesRequest {
// Required. The resource name of the Location from which to list the Indexes.
// Format: `projects/{project}/locations/{location}`
@@ -167,44 +177,54 @@ message ListIndexesRequest {
// The standard list page token.
// Typically obtained via
- // [ListIndexesResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token] of the previous
- // [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes] call.
+ // [ListIndexesResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token]
+ // of the previous
+ // [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes].
+// Response message for
+// [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes].
message ListIndexesResponse {
// List of indexes in the requested page.
repeated Index indexes = 1;
// A token to retrieve next page of results.
- // Pass to [ListIndexesRequest.page_token][google.cloud.aiplatform.v1.ListIndexesRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListIndexesRequest.page_token][google.cloud.aiplatform.v1.ListIndexesRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex].
+// Request message for
+// [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex].
message UpdateIndexRequest {
// Required. The Index which updates the resource on the server.
Index index = 1 [(google.api.field_behavior) = REQUIRED];
// The update mask applies to the resource.
- // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask].
+ // For the `FieldMask` definition, see
+ // [google.protobuf.FieldMask][google.protobuf.FieldMask].
google.protobuf.FieldMask update_mask = 2;
}
-// Runtime operation information for [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex].
+// Runtime operation information for
+// [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex].
message UpdateIndexOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
// The operation metadata with regard to Matching Engine Index operation.
- NearestNeighborSearchOperationMetadata nearest_neighbor_search_operation_metadata = 2;
+ NearestNeighborSearchOperationMetadata
+ nearest_neighbor_search_operation_metadata = 2;
}
-// Request message for [IndexService.DeleteIndex][google.cloud.aiplatform.v1.IndexService.DeleteIndex].
+// Request message for
+// [IndexService.DeleteIndex][google.cloud.aiplatform.v1.IndexService.DeleteIndex].
message DeleteIndexRequest {
// Required. The name of the Index resource to be deleted.
// Format:
@@ -217,7 +237,8 @@ message DeleteIndexRequest {
];
}
-// Request message for [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints]
+// Request message for
+// [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints]
message UpsertDatapointsRequest {
// Required. The name of the Index resource to be updated.
// Format:
@@ -233,12 +254,12 @@ message UpsertDatapointsRequest {
repeated IndexDatapoint datapoints = 2;
}
-// Response message for [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints]
-message UpsertDatapointsResponse {
+// Response message for
+// [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints]
+message UpsertDatapointsResponse {}
-}
-
-// Request message for [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints]
+// Request message for
+// [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints]
message RemoveDatapointsRequest {
// Required. The name of the Index resource to be updated.
// Format:
@@ -254,10 +275,9 @@ message RemoveDatapointsRequest {
repeated string datapoint_ids = 2;
}
-// Response message for [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints]
-message RemoveDatapointsResponse {
-
-}
+// Response message for
+// [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints]
+message RemoveDatapointsResponse {}
// Runtime operation metadata with regard to Matching Engine Index.
message NearestNeighborSearchOperationMetadata {
@@ -325,7 +345,8 @@ message NearestNeighborSearchOperationMetadata {
// The validation stats of the content (per file) to be inserted or
// updated on the Matching Engine Index resource. Populated if
- // contentsDeltaUri is provided as part of [Index.metadata][google.cloud.aiplatform.v1.Index.metadata]. Please note
+ // contentsDeltaUri is provided as part of
+ // [Index.metadata][google.cloud.aiplatform.v1.Index.metadata]. Please note
// that, currently for those files that are broken or has unsupported file
// format, we will not have the stats for those files.
repeated ContentValidationStats content_validation_stats = 1;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/io.proto b/third_party/googleapis/google/cloud/aiplatform/v1/io.proto
index 43d5fdc63..13294bb1e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/io.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/io.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "IoProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -48,7 +48,8 @@ message GcsSource {
// The Google Cloud Storage location where the output is to be written to.
message GcsDestination {
- // Required. Google Cloud Storage URI to output directory. If the uri doesn't end with
+ // Required. Google Cloud Storage URI to output directory. If the uri doesn't
+ // end with
// '/', a '/' will be automatically appended. The directory is created if it
// doesn't exist.
string output_uri_prefix = 1 [(google.api.field_behavior) = REQUIRED];
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/job_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/job_service.proto
index cf9e9abd2..ce8d664a3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/job_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/job_service.proto
@@ -25,6 +25,7 @@ import "google/cloud/aiplatform/v1/custom_job.proto";
import "google/cloud/aiplatform/v1/data_labeling_job.proto";
import "google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto";
import "google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto";
+import "google/cloud/aiplatform/v1/nas_job.proto";
import "google/cloud/aiplatform/v1/operation.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
@@ -32,7 +33,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "JobServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -42,7 +43,9 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// A service for creating and managing Vertex AI's jobs.
service JobService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform,"
+ "https://www.googleapis.com/auth/cloud-platform.read-only";
// Creates a CustomJob. A created CustomJob right away
// will be attempted to be run.
@@ -71,7 +74,8 @@ service JobService {
}
// Deletes a CustomJob.
- rpc DeleteCustomJob(DeleteCustomJobRequest) returns (google.longrunning.Operation) {
+ rpc DeleteCustomJob(DeleteCustomJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/customJobs/*}"
};
@@ -85,12 +89,15 @@ service JobService {
// Cancels a CustomJob.
// Starts asynchronous cancellation on the CustomJob. The server
// makes a best effort to cancel the job, but success is not
- // guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob] or
- // other methods to check whether the cancellation succeeded or whether the
+ // guaranteed. Clients can use
+ // [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob]
+ // or other methods to check whether the cancellation succeeded or whether the
// job completed despite cancellation. On successful cancellation,
// the CustomJob is not deleted; instead it becomes a job with
- // a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
- // corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to
+ // a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with
+ // a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
+ // `Code.CANCELLED`, and
+ // [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to
// `CANCELLED`.
rpc CancelCustomJob(CancelCustomJobRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
@@ -101,7 +108,8 @@ service JobService {
}
// Creates a DataLabelingJob.
- rpc CreateDataLabelingJob(CreateDataLabelingJobRequest) returns (DataLabelingJob) {
+ rpc CreateDataLabelingJob(CreateDataLabelingJobRequest)
+ returns (DataLabelingJob) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/dataLabelingJobs"
body: "data_labeling_job"
@@ -118,7 +126,8 @@ service JobService {
}
// Lists DataLabelingJobs in a Location.
- rpc ListDataLabelingJobs(ListDataLabelingJobsRequest) returns (ListDataLabelingJobsResponse) {
+ rpc ListDataLabelingJobs(ListDataLabelingJobsRequest)
+ returns (ListDataLabelingJobsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/dataLabelingJobs"
};
@@ -126,7 +135,8 @@ service JobService {
}
// Deletes a DataLabelingJob.
- rpc DeleteDataLabelingJob(DeleteDataLabelingJobRequest) returns (google.longrunning.Operation) {
+ rpc DeleteDataLabelingJob(DeleteDataLabelingJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/dataLabelingJobs/*}"
};
@@ -138,7 +148,8 @@ service JobService {
}
// Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
- rpc CancelDataLabelingJob(CancelDataLabelingJobRequest) returns (google.protobuf.Empty) {
+ rpc CancelDataLabelingJob(CancelDataLabelingJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/dataLabelingJobs/*}:cancel"
body: "*"
@@ -147,7 +158,8 @@ service JobService {
}
// Creates a HyperparameterTuningJob
- rpc CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest) returns (HyperparameterTuningJob) {
+ rpc CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest)
+ returns (HyperparameterTuningJob) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/hyperparameterTuningJobs"
body: "hyperparameter_tuning_job"
@@ -156,7 +168,8 @@ service JobService {
}
// Gets a HyperparameterTuningJob
- rpc GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest) returns (HyperparameterTuningJob) {
+ rpc GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest)
+ returns (HyperparameterTuningJob) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}"
};
@@ -164,7 +177,8 @@ service JobService {
}
// Lists HyperparameterTuningJobs in a Location.
- rpc ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest) returns (ListHyperparameterTuningJobsResponse) {
+ rpc ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest)
+ returns (ListHyperparameterTuningJobsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/hyperparameterTuningJobs"
};
@@ -172,7 +186,8 @@ service JobService {
}
// Deletes a HyperparameterTuningJob.
- rpc DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest) returns (google.longrunning.Operation) {
+ rpc DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}"
};
@@ -186,14 +201,19 @@ service JobService {
// Cancels a HyperparameterTuningJob.
// Starts asynchronous cancellation on the HyperparameterTuningJob. The server
// makes a best effort to cancel the job, but success is not
- // guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob] or
- // other methods to check whether the cancellation succeeded or whether the
+ // guaranteed. Clients can use
+ // [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob]
+ // or other methods to check whether the cancellation succeeded or whether the
// job completed despite cancellation. On successful cancellation,
// the HyperparameterTuningJob is not deleted; instead it becomes a job with
- // a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code]
- // of 1, corresponding to `Code.CANCELLED`, and
- // [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state] is set to `CANCELLED`.
- rpc CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest) returns (google.protobuf.Empty) {
+ // a
+ // [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error]
+ // value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
+ // corresponding to `Code.CANCELLED`, and
+ // [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state]
+ // is set to `CANCELLED`.
+ rpc CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}:cancel"
body: "*"
@@ -201,9 +221,85 @@ service JobService {
option (google.api.method_signature) = "name";
}
+ // Creates a NasJob
+ rpc CreateNasJob(CreateNasJobRequest) returns (NasJob) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*}/nasJobs"
+ body: "nas_job"
+ };
+ option (google.api.method_signature) = "parent,nas_job";
+ }
+
+ // Gets a NasJob
+ rpc GetNasJob(GetNasJobRequest) returns (NasJob) {
+ option (google.api.http) = {
+ get: "/v1/{name=projects/*/locations/*/nasJobs/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Lists NasJobs in a Location.
+ rpc ListNasJobs(ListNasJobsRequest) returns (ListNasJobsResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=projects/*/locations/*}/nasJobs"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Deletes a NasJob.
+ rpc DeleteNasJob(DeleteNasJobRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1/{name=projects/*/locations/*/nasJobs/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "DeleteOperationMetadata"
+ };
+ }
+
+ // Cancels a NasJob.
+ // Starts asynchronous cancellation on the NasJob. The server
+ // makes a best effort to cancel the job, but success is not
+ // guaranteed. Clients can use
+ // [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or
+ // other methods to check whether the cancellation succeeded or whether the
+ // job completed despite cancellation. On successful cancellation,
+ // the NasJob is not deleted; instead it becomes a job with
+ // a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a
+ // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
+ // `Code.CANCELLED`, and
+ // [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to
+ // `CANCELLED`.
+ rpc CancelNasJob(CancelNasJobRequest) returns (google.protobuf.Empty) {
+ option (google.api.http) = {
+ post: "/v1/{name=projects/*/locations/*/nasJobs/*}:cancel"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Gets a NasTrialDetail.
+ rpc GetNasTrialDetail(GetNasTrialDetailRequest) returns (NasTrialDetail) {
+ option (google.api.http) = {
+ get: "/v1/{name=projects/*/locations/*/nasJobs/*/nasTrialDetails/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // List top NasTrialDetails of a NasJob.
+ rpc ListNasTrialDetails(ListNasTrialDetailsRequest)
+ returns (ListNasTrialDetailsResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=projects/*/locations/*/nasJobs/*}/nasTrialDetails"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
// Creates a BatchPredictionJob. A BatchPredictionJob once created will
// right away be attempted to start.
- rpc CreateBatchPredictionJob(CreateBatchPredictionJobRequest) returns (BatchPredictionJob) {
+ rpc CreateBatchPredictionJob(CreateBatchPredictionJobRequest)
+ returns (BatchPredictionJob) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/batchPredictionJobs"
body: "batch_prediction_job"
@@ -212,7 +308,8 @@ service JobService {
}
// Gets a BatchPredictionJob
- rpc GetBatchPredictionJob(GetBatchPredictionJobRequest) returns (BatchPredictionJob) {
+ rpc GetBatchPredictionJob(GetBatchPredictionJobRequest)
+ returns (BatchPredictionJob) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/batchPredictionJobs/*}"
};
@@ -220,7 +317,8 @@ service JobService {
}
// Lists BatchPredictionJobs in a Location.
- rpc ListBatchPredictionJobs(ListBatchPredictionJobsRequest) returns (ListBatchPredictionJobsResponse) {
+ rpc ListBatchPredictionJobs(ListBatchPredictionJobsRequest)
+ returns (ListBatchPredictionJobsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/batchPredictionJobs"
};
@@ -229,7 +327,8 @@ service JobService {
// Deletes a BatchPredictionJob. Can only be called on jobs that already
// finished.
- rpc DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest) returns (google.longrunning.Operation) {
+ rpc DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/batchPredictionJobs/*}"
};
@@ -244,13 +343,16 @@ service JobService {
//
// Starts asynchronous cancellation on the BatchPredictionJob. The server
// makes the best effort to cancel the job, but success is not
- // guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob] or
- // other methods to check whether the cancellation succeeded or whether the
+ // guaranteed. Clients can use
+ // [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob]
+ // or other methods to check whether the cancellation succeeded or whether the
// job completed despite cancellation. On a successful cancellation,
// the BatchPredictionJob is not deleted;instead its
- // [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already
- // outputted by the job are not deleted.
- rpc CancelBatchPredictionJob(CancelBatchPredictionJobRequest) returns (google.protobuf.Empty) {
+ // [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state]
+ // is set to `CANCELLED`. Any files already outputted by the job are not
+ // deleted.
+ rpc CancelBatchPredictionJob(CancelBatchPredictionJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/batchPredictionJobs/*}:cancel"
body: "*"
@@ -260,25 +362,32 @@ service JobService {
// Creates a ModelDeploymentMonitoringJob. It will run periodically on a
// configured interval.
- rpc CreateModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest) returns (ModelDeploymentMonitoringJob) {
+ rpc CreateModelDeploymentMonitoringJob(
+ CreateModelDeploymentMonitoringJobRequest)
+ returns (ModelDeploymentMonitoringJob) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/modelDeploymentMonitoringJobs"
body: "model_deployment_monitoring_job"
};
- option (google.api.method_signature) = "parent,model_deployment_monitoring_job";
+ option (google.api.method_signature) =
+ "parent,model_deployment_monitoring_job";
}
// Searches Model Monitoring Statistics generated within a given time window.
- rpc SearchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest) returns (SearchModelDeploymentMonitoringStatsAnomaliesResponse) {
+ rpc SearchModelDeploymentMonitoringStatsAnomalies(
+ SearchModelDeploymentMonitoringStatsAnomaliesRequest)
+ returns (SearchModelDeploymentMonitoringStatsAnomaliesResponse) {
option (google.api.http) = {
post: "/v1/{model_deployment_monitoring_job=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:searchModelDeploymentMonitoringStatsAnomalies"
body: "*"
};
- option (google.api.method_signature) = "model_deployment_monitoring_job,deployed_model_id";
+ option (google.api.method_signature) =
+ "model_deployment_monitoring_job,deployed_model_id";
}
// Gets a ModelDeploymentMonitoringJob.
- rpc GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest) returns (ModelDeploymentMonitoringJob) {
+ rpc GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest)
+ returns (ModelDeploymentMonitoringJob) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}"
};
@@ -286,7 +395,9 @@ service JobService {
}
// Lists ModelDeploymentMonitoringJobs in a Location.
- rpc ListModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest) returns (ListModelDeploymentMonitoringJobsResponse) {
+ rpc ListModelDeploymentMonitoringJobs(
+ ListModelDeploymentMonitoringJobsRequest)
+ returns (ListModelDeploymentMonitoringJobsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/modelDeploymentMonitoringJobs"
};
@@ -294,12 +405,15 @@ service JobService {
}
// Updates a ModelDeploymentMonitoringJob.
- rpc UpdateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest) returns (google.longrunning.Operation) {
+ rpc UpdateModelDeploymentMonitoringJob(
+ UpdateModelDeploymentMonitoringJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{model_deployment_monitoring_job.name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}"
body: "model_deployment_monitoring_job"
};
- option (google.api.method_signature) = "model_deployment_monitoring_job,update_mask";
+ option (google.api.method_signature) =
+ "model_deployment_monitoring_job,update_mask";
option (google.longrunning.operation_info) = {
response_type: "ModelDeploymentMonitoringJob"
metadata_type: "UpdateModelDeploymentMonitoringJobOperationMetadata"
@@ -307,7 +421,9 @@ service JobService {
}
// Deletes a ModelDeploymentMonitoringJob.
- rpc DeleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest) returns (google.longrunning.Operation) {
+ rpc DeleteModelDeploymentMonitoringJob(
+ DeleteModelDeploymentMonitoringJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}"
};
@@ -320,8 +436,11 @@ service JobService {
// Pauses a ModelDeploymentMonitoringJob. If the job is running, the server
// makes a best effort to cancel the job. Will mark
- // [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.
- rpc PauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest) returns (google.protobuf.Empty) {
+ // [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state]
+ // to 'PAUSED'.
+ rpc PauseModelDeploymentMonitoringJob(
+ PauseModelDeploymentMonitoringJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:pause"
body: "*"
@@ -332,7 +451,9 @@ service JobService {
// Resumes a paused ModelDeploymentMonitoringJob. It will start to run from
// next scheduled time. A deleted ModelDeploymentMonitoringJob can't be
// resumed.
- rpc ResumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest) returns (google.protobuf.Empty) {
+ rpc ResumeModelDeploymentMonitoringJob(
+ ResumeModelDeploymentMonitoringJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:resume"
body: "*"
@@ -341,7 +462,8 @@ service JobService {
}
}
-// Request message for [JobService.CreateCustomJob][google.cloud.aiplatform.v1.JobService.CreateCustomJob].
+// Request message for
+// [JobService.CreateCustomJob][google.cloud.aiplatform.v1.JobService.CreateCustomJob].
message CreateCustomJobRequest {
// Required. The resource name of the Location to create the CustomJob in.
// Format: `projects/{project}/locations/{location}`
@@ -356,7 +478,8 @@ message CreateCustomJobRequest {
CustomJob custom_job = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob].
+// Request message for
+// [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob].
message GetCustomJobRequest {
// Required. The name of the CustomJob resource.
// Format:
@@ -369,7 +492,8 @@ message GetCustomJobRequest {
];
}
-// Request message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs].
+// Request message for
+// [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs].
message ListCustomJobsRequest {
// Required. The resource name of the Location to list the CustomJobs from.
// Format: `projects/{project}/locations/{location}`
@@ -407,25 +531,31 @@ message ListCustomJobsRequest {
// The standard list page token.
// Typically obtained via
- // [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token] of the previous
- // [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs] call.
+ // [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token]
+ // of the previous
+ // [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]
+// Response message for
+// [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]
message ListCustomJobsResponse {
// List of CustomJobs in the requested page.
repeated CustomJob custom_jobs = 1;
// A token to retrieve the next page of results.
- // Pass to [ListCustomJobsRequest.page_token][google.cloud.aiplatform.v1.ListCustomJobsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListCustomJobsRequest.page_token][google.cloud.aiplatform.v1.ListCustomJobsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [JobService.DeleteCustomJob][google.cloud.aiplatform.v1.JobService.DeleteCustomJob].
+// Request message for
+// [JobService.DeleteCustomJob][google.cloud.aiplatform.v1.JobService.DeleteCustomJob].
message DeleteCustomJobRequest {
// Required. The name of the CustomJob resource to be deleted.
// Format:
@@ -438,7 +568,8 @@ message DeleteCustomJobRequest {
];
}
-// Request message for [JobService.CancelCustomJob][google.cloud.aiplatform.v1.JobService.CancelCustomJob].
+// Request message for
+// [JobService.CancelCustomJob][google.cloud.aiplatform.v1.JobService.CancelCustomJob].
message CancelCustomJobRequest {
// Required. The name of the CustomJob to cancel.
// Format:
@@ -451,7 +582,8 @@ message CancelCustomJobRequest {
];
}
-// Request message for [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob].
+// Request message for
+// [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob].
message CreateDataLabelingJobRequest {
// Required. The parent of the DataLabelingJob.
// Format: `projects/{project}/locations/{location}`
@@ -463,10 +595,12 @@ message CreateDataLabelingJobRequest {
];
// Required. The DataLabelingJob to create.
- DataLabelingJob data_labeling_job = 2 [(google.api.field_behavior) = REQUIRED];
+ DataLabelingJob data_labeling_job = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1.JobService.GetDataLabelingJob].
+// Request message for
+// [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1.JobService.GetDataLabelingJob].
message GetDataLabelingJobRequest {
// Required. The name of the DataLabelingJob.
// Format:
@@ -479,7 +613,8 @@ message GetDataLabelingJobRequest {
];
}
-// Request message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs].
+// Request message for
+// [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs].
message ListDataLabelingJobsRequest {
// Required. The parent of the DataLabelingJob.
// Format: `projects/{project}/locations/{location}`
@@ -530,7 +665,8 @@ message ListDataLabelingJobsRequest {
string order_by = 6;
}
-// Response message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs].
+// Response message for
+// [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs].
message ListDataLabelingJobsResponse {
// A list of DataLabelingJobs that matches the specified filter in the
// request.
@@ -540,7 +676,8 @@ message ListDataLabelingJobsResponse {
string next_page_token = 2;
}
-// Request message for [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJob].
+// Request message for
+// [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJob].
message DeleteDataLabelingJobRequest {
// Required. The name of the DataLabelingJob to be deleted.
// Format:
@@ -553,7 +690,8 @@ message DeleteDataLabelingJobRequest {
];
}
-// Request message for [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob].
+// Request message for
+// [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob].
message CancelDataLabelingJobRequest {
// Required. The name of the DataLabelingJob.
// Format:
@@ -566,10 +704,12 @@ message CancelDataLabelingJobRequest {
];
}
-// Request message for [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJob].
+// Request message for
+// [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJob].
message CreateHyperparameterTuningJobRequest {
- // Required. The resource name of the Location to create the HyperparameterTuningJob in.
- // Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location to create the
+ // HyperparameterTuningJob in. Format:
+ // `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -578,10 +718,12 @@ message CreateHyperparameterTuningJobRequest {
];
// Required. The HyperparameterTuningJob to create.
- HyperparameterTuningJob hyperparameter_tuning_job = 2 [(google.api.field_behavior) = REQUIRED];
+ HyperparameterTuningJob hyperparameter_tuning_job = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob].
+// Request message for
+// [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob].
message GetHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob resource.
// Format:
@@ -594,10 +736,12 @@ message GetHyperparameterTuningJobRequest {
];
}
-// Request message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs].
+// Request message for
+// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs].
message ListHyperparameterTuningJobsRequest {
- // Required. The resource name of the Location to list the HyperparameterTuningJobs
- // from. Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location to list the
+ // HyperparameterTuningJobs from. Format:
+ // `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -632,27 +776,33 @@ message ListHyperparameterTuningJobsRequest {
// The standard list page token.
// Typically obtained via
- // [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token] of the previous
- // [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs] call.
+ // [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
+ // of the previous
+ // [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
+// Response message for
+// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
message ListHyperparameterTuningJobsResponse {
// List of HyperparameterTuningJobs in the requested page.
- // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials] of the jobs will be not be returned.
+ // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]
+ // of the jobs will be not be returned.
repeated HyperparameterTuningJob hyperparameter_tuning_jobs = 1;
// A token to retrieve the next page of results.
- // Pass to [ListHyperparameterTuningJobsRequest.page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsRequest.page_token] to obtain that
- // page.
+ // Pass to
+ // [ListHyperparameterTuningJobsRequest.page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [JobService.DeleteHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJob].
+// Request message for
+// [JobService.DeleteHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJob].
message DeleteHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob resource to be deleted.
// Format:
@@ -665,7 +815,8 @@ message DeleteHyperparameterTuningJobRequest {
];
}
-// Request message for [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJob].
+// Request message for
+// [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJob].
message CancelHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob to cancel.
// Format:
@@ -678,9 +829,10 @@ message CancelHyperparameterTuningJobRequest {
];
}
-// Request message for [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob].
-message CreateBatchPredictionJobRequest {
- // Required. The resource name of the Location to create the BatchPredictionJob in.
+// Request message for
+// [JobService.CreateNasJob][google.cloud.aiplatform.v1.JobService.CreateNasJob].
+message CreateNasJobRequest {
+ // Required. The resource name of the Location to create the NasJob in.
// Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -689,11 +841,187 @@ message CreateBatchPredictionJobRequest {
}
];
+ // Required. The NasJob to create.
+ NasJob nas_job = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for
+// [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob].
+message GetNasJobRequest {
+ // Required. The name of the NasJob resource.
+ // Format:
+ // `projects/{project}/locations/{location}/nasJobs/{nas_job}`
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/NasJob"
+ }
+ ];
+}
+
+// Request message for
+// [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs].
+message ListNasJobsRequest {
+ // Required. The resource name of the Location to list the NasJobs
+ // from. Format: `projects/{project}/locations/{location}`
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "locations.googleapis.com/Location"
+ }
+ ];
+
+ // The standard list filter.
+ //
+ // Supported fields:
+ //
+ // * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
+ // * `state` supports `=`, `!=` comparisons.
+ // * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
+ // `create_time` must be in RFC 3339 format.
+ // * `labels` supports general map functions that is:
+ // `labels.key=value` - key:value equality
+ // `labels.key:* - key existence
+ //
+ // Some examples of using the filter are:
+ //
+ // * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
+ // * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
+ // * `NOT display_name="my_job"`
+ // * `create_time>"2021-05-18T00:00:00Z"`
+ // * `labels.keyA=valueA`
+ // * `labels.keyB:*`
+ string filter = 2;
+
+ // The standard list page size.
+ int32 page_size = 3;
+
+ // The standard list page token.
+ // Typically obtained via
+ // [ListNasJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token]
+ // of the previous
+ // [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs]
+ // call.
+ string page_token = 4;
+
+ // Mask specifying which fields to read.
+ google.protobuf.FieldMask read_mask = 5;
+}
+
+// Response message for
+// [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs]
+message ListNasJobsResponse {
+ // List of NasJobs in the requested page.
+ // [NasJob.nas_job_output][google.cloud.aiplatform.v1.NasJob.nas_job_output]
+ // of the jobs will not be returned.
+ repeated NasJob nas_jobs = 1;
+
+ // A token to retrieve the next page of results.
+ // Pass to
+ // [ListNasJobsRequest.page_token][google.cloud.aiplatform.v1.ListNasJobsRequest.page_token]
+ // to obtain that page.
+ string next_page_token = 2;
+}
+
+// Request message for
+// [JobService.DeleteNasJob][google.cloud.aiplatform.v1.JobService.DeleteNasJob].
+message DeleteNasJobRequest {
+ // Required. The name of the NasJob resource to be deleted.
+ // Format:
+ // `projects/{project}/locations/{location}/nasJobs/{nas_job}`
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/NasJob"
+ }
+ ];
+}
+
+// Request message for
+// [JobService.CancelNasJob][google.cloud.aiplatform.v1.JobService.CancelNasJob].
+message CancelNasJobRequest {
+ // Required. The name of the NasJob to cancel.
+ // Format:
+ // `projects/{project}/locations/{location}/nasJobs/{nas_job}`
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/NasJob"
+ }
+ ];
+}
+
+// Request message for
+// [JobService.GetNasTrialDetail][google.cloud.aiplatform.v1.JobService.GetNasTrialDetail].
+message GetNasTrialDetailRequest {
+ // Required. The name of the NasTrialDetail resource.
+ // Format:
+ // `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/NasTrialDetail"
+ }
+ ];
+}
+
+// Request message for
+// [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails].
+message ListNasTrialDetailsRequest {
+ // Required. The name of the NasJob resource.
+ // Format:
+ // `projects/{project}/locations/{location}/nasJobs/{nas_job}`
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/NasJob"
+ }
+ ];
+
+ // The standard list page size.
+ int32 page_size = 2;
+
+ // The standard list page token.
+ // Typically obtained via
+ // [ListNasTrialDetailsResponse.next_page_token][google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token]
+ // of the previous
+ // [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails]
+ // call.
+ string page_token = 3;
+}
+
+// Response message for
+// [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails]
+message ListNasTrialDetailsResponse {
+ // List of top NasTrials in the requested page.
+ repeated NasTrialDetail nas_trial_details = 1;
+
+ // A token to retrieve the next page of results.
+ // Pass to
+ // [ListNasTrialDetailsRequest.page_token][google.cloud.aiplatform.v1.ListNasTrialDetailsRequest.page_token]
+ // to obtain that page.
+ string next_page_token = 2;
+}
+
+// Request message for
+// [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob].
+message CreateBatchPredictionJobRequest {
+ // Required. The resource name of the Location to create the
+ // BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "locations.googleapis.com/Location"
+ }
+ ];
+
// Required. The BatchPredictionJob to create.
- BatchPredictionJob batch_prediction_job = 2 [(google.api.field_behavior) = REQUIRED];
+ BatchPredictionJob batch_prediction_job = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob].
+// Request message for
+// [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob].
message GetBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob resource.
// Format:
@@ -706,7 +1034,8 @@ message GetBatchPredictionJobRequest {
];
}
-// Request message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs].
+// Request message for
+// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs].
message ListBatchPredictionJobsRequest {
// Required. The resource name of the Location to list the BatchPredictionJobs
// from. Format: `projects/{project}/locations/{location}`
@@ -745,26 +1074,31 @@ message ListBatchPredictionJobsRequest {
// The standard list page token.
// Typically obtained via
- // [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token] of the previous
- // [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs] call.
+ // [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token]
+ // of the previous
+ // [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs]
+// Response message for
+// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs]
message ListBatchPredictionJobsResponse {
// List of BatchPredictionJobs in the requested page.
repeated BatchPredictionJob batch_prediction_jobs = 1;
// A token to retrieve the next page of results.
- // Pass to [ListBatchPredictionJobsRequest.page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsRequest.page_token] to obtain that
- // page.
+ // Pass to
+ // [ListBatchPredictionJobsRequest.page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob].
+// Request message for
+// [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob].
message DeleteBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob resource to be deleted.
// Format:
@@ -777,7 +1111,8 @@ message DeleteBatchPredictionJobRequest {
];
}
-// Request message for [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJob].
+// Request message for
+// [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJob].
message CancelBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob to cancel.
// Format:
@@ -803,7 +1138,8 @@ message CreateModelDeploymentMonitoringJobRequest {
];
// Required. The ModelDeploymentMonitoringJob to create
- ModelDeploymentMonitoringJob model_deployment_monitoring_job = 2 [(google.api.field_behavior) = REQUIRED];
+ ModelDeploymentMonitoringJob model_deployment_monitoring_job = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for
@@ -814,11 +1150,12 @@ message SearchModelDeploymentMonitoringStatsAnomaliesRequest {
ModelDeploymentMonitoringObjectiveType type = 1;
// If set, all attribution scores between
- // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time] and
- // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time] are
- // fetched, and page token doesn't take effect in this case.
- // Only used to retrieve attribution score for the top Features which has
- // the highest attribution score in the latest monitoring run.
+ // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time]
+ // and
+ // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time]
+ // are fetched, and page token doesn't take effect in this case. Only used
+ // to retrieve attribution score for the top Features which has the highest
+ // attribution score in the latest monitoring run.
int32 top_feature_count = 4;
}
@@ -843,7 +1180,8 @@ message SearchModelDeploymentMonitoringStatsAnomaliesRequest {
string feature_display_name = 3;
// Required. Objectives of the stats to retrieve.
- repeated StatsAnomaliesObjective objectives = 4 [(google.api.field_behavior) = REQUIRED];
+ repeated StatsAnomaliesObjective objectives = 4
+ [(google.api.field_behavior) = REQUIRED];
// The standard list page size.
int32 page_size = 5;
@@ -949,18 +1287,18 @@ message ListModelDeploymentMonitoringJobsResponse {
// Request message for
// [JobService.UpdateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.UpdateModelDeploymentMonitoringJob].
message UpdateModelDeploymentMonitoringJobRequest {
- // Required. The model monitoring configuration which replaces the resource on the
- // server.
- ModelDeploymentMonitoringJob model_deployment_monitoring_job = 1 [(google.api.field_behavior) = REQUIRED];
-
- // Required. The update mask is used to specify the fields to be overwritten in the
- // ModelDeploymentMonitoringJob resource by the update.
- // The fields specified in the update_mask are relative to the resource, not
- // the full request. A field will be overwritten if it is in the mask. If the
- // user does not provide a mask then only the non-empty fields present in the
- // request will be overwritten. Set the update_mask to `*` to override all
- // fields.
- // For the objective config, the user can either provide the update mask for
+ // Required. The model monitoring configuration which replaces the resource on
+ // the server.
+ ModelDeploymentMonitoringJob model_deployment_monitoring_job = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The update mask is used to specify the fields to be overwritten
+ // in the ModelDeploymentMonitoringJob resource by the update. The fields
+ // specified in the update_mask are relative to the resource, not the full
+ // request. A field will be overwritten if it is in the mask. If the user does
+ // not provide a mask then only the non-empty fields present in the request
+ // will be overwritten. Set the update_mask to `*` to override all fields. For
+ // the objective config, the user can either provide the update mask for
// model_deployment_monitoring_objective_configs or any combination of its
// nested fields, such as:
// model_deployment_monitoring_objective_configs.objective_config.training_dataset.
@@ -980,7 +1318,8 @@ message UpdateModelDeploymentMonitoringJobRequest {
// * `model_deployment_monitoring_objective_configs.objective_config.training_dataset`
// * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config`
// * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/job_state.proto b/third_party/googleapis/google/cloud/aiplatform/v1/job_state.proto
index 45b101c01..0bd30c510 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/job_state.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/job_state.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "JobStateProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -57,10 +57,7 @@ enum JobState {
// The job has expired.
JOB_STATE_EXPIRED = 9;
- // The job is being updated. The job is only able to be updated at RUNNING
- // state; if the update operation succeeds, job goes back to RUNNING state; if
- // the update operation fails, the job goes back to RUNNING state with error
- // messages written to [ModelDeploymentMonitoringJob.partial_errors][] field
- // if it is a ModelDeploymentMonitoringJob.
+ // The job is being updated. Only jobs in the `RUNNING` state can be updated.
+ // After updating, the job goes back to the `RUNNING` state.
JOB_STATE_UPDATING = 10;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/lineage_subgraph.proto b/third_party/googleapis/google/cloud/aiplatform/v1/lineage_subgraph.proto
index 7ad020b61..428ec3145 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/lineage_subgraph.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/lineage_subgraph.proto
@@ -21,7 +21,7 @@ import "google/cloud/aiplatform/v1/event.proto";
import "google/cloud/aiplatform/v1/execution.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "LineageSubgraphProto";
option java_package = "com.google.cloud.aiplatform.v1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/machine_resources.proto b/third_party/googleapis/google/cloud/aiplatform/v1/machine_resources.proto
index 9bcf37c16..60dea057b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/machine_resources.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/machine_resources.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/cloud/aiplatform/v1/accelerator_type.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MachineResourcesProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -37,14 +37,18 @@ message MachineSpec {
// See the [list of machine types supported for custom
// training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types).
//
- // For [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] this field is optional, and the default
- // value is `n1-standard-2`. For [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] or as part of
- // [WorkerPoolSpec][google.cloud.aiplatform.v1.WorkerPoolSpec] this field is required.
+ // For [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] this field is
+ // optional, and the default value is `n1-standard-2`. For
+ // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] or as
+ // part of [WorkerPoolSpec][google.cloud.aiplatform.v1.WorkerPoolSpec] this
+ // field is required.
string machine_type = 1 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The type of accelerator(s) that may be attached to the machine as per
+ // Immutable. The type of accelerator(s) that may be attached to the machine
+ // as per
// [accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count].
- AcceleratorType accelerator_type = 2 [(google.api.field_behavior) = IMMUTABLE];
+ AcceleratorType accelerator_type = 2
+ [(google.api.field_behavior) = IMMUTABLE];
// The number of accelerators to attach to the machine.
int32 accelerator_count = 3;
@@ -53,14 +57,16 @@ message MachineSpec {
// A description of resources that are dedicated to a DeployedModel, and
// that need a higher degree of manual configuration.
message DedicatedResources {
- // Required. Immutable. The specification of a single machine used by the prediction.
+ // Required. Immutable. The specification of a single machine used by the
+ // prediction.
MachineSpec machine_spec = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
];
- // Required. Immutable. The minimum number of machine replicas this DeployedModel will be always
- // deployed on. This value must be greater than or equal to 1.
+ // Required. Immutable. The minimum number of machine replicas this
+ // DeployedModel will be always deployed on. This value must be greater than
+ // or equal to 1.
//
// If traffic against the DeployedModel increases, it may dynamically be
// deployed onto more replicas, and as traffic decreases, some of these extra
@@ -70,14 +76,15 @@ message DedicatedResources {
(google.api.field_behavior) = IMMUTABLE
];
- // Immutable. The maximum number of replicas this DeployedModel may be deployed on when
- // the traffic against it increases. If the requested value is too large,
- // the deployment will error, but if deployment succeeds then the ability
- // to scale the model to that many replicas is guaranteed (barring service
- // outages). If traffic against the DeployedModel increases beyond what its
- // replicas at maximum may handle, a portion of the traffic will be dropped.
- // If this value is not provided, will use [min_replica_count][google.cloud.aiplatform.v1.DedicatedResources.min_replica_count] as the
- // default value.
+ // Immutable. The maximum number of replicas this DeployedModel may be
+ // deployed on when the traffic against it increases. If the requested value
+ // is too large, the deployment will error, but if deployment succeeds then
+ // the ability to scale the model to that many replicas is guaranteed (barring
+ // service outages). If traffic against the DeployedModel increases beyond
+ // what its replicas at maximum may handle, a portion of the traffic will be
+ // dropped. If this value is not provided, will use
+ // [min_replica_count][google.cloud.aiplatform.v1.DedicatedResources.min_replica_count]
+ // as the default value.
//
// The value of this field impacts the charge against Vertex CPU and GPU
// quotas. Specifically, you will be charged for (max_replica_count *
@@ -90,44 +97,49 @@ message DedicatedResources {
// target value (default to 60 if not set). At most one entry is allowed per
// metric.
//
- // If [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count] is
- // above 0, the autoscaling will be based on both CPU utilization and
+ // If
+ // [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count]
+ // is above 0, the autoscaling will be based on both CPU utilization and
// accelerator's duty cycle metrics and scale up when either metrics exceeds
// its target value while scale down if both metrics are under their target
// value. The default target value is 60 for both metrics.
//
- // If [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count] is
- // 0, the autoscaling will be based on CPU utilization metric only with
+ // If
+ // [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count]
+ // is 0, the autoscaling will be based on CPU utilization metric only with
// default target value 60 if not explicitly set.
//
// For example, in the case of Online Prediction, if you want to override
// target CPU utilization to 80, you should set
// [autoscaling_metric_specs.metric_name][google.cloud.aiplatform.v1.AutoscalingMetricSpec.metric_name]
// to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and
- // [autoscaling_metric_specs.target][google.cloud.aiplatform.v1.AutoscalingMetricSpec.target] to `80`.
- repeated AutoscalingMetricSpec autoscaling_metric_specs = 4 [(google.api.field_behavior) = IMMUTABLE];
+ // [autoscaling_metric_specs.target][google.cloud.aiplatform.v1.AutoscalingMetricSpec.target]
+ // to `80`.
+ repeated AutoscalingMetricSpec autoscaling_metric_specs = 4
+ [(google.api.field_behavior) = IMMUTABLE];
}
// A description of resources that to large degree are decided by Vertex AI,
// and require only a modest additional configuration.
// Each Model supporting these resources documents its specific guidelines.
message AutomaticResources {
- // Immutable. The minimum number of replicas this DeployedModel will be always deployed
- // on. If traffic against it increases, it may dynamically be deployed onto
- // more replicas up to [max_replica_count][google.cloud.aiplatform.v1.AutomaticResources.max_replica_count], and as traffic decreases, some
- // of these extra replicas may be freed.
- // If the requested value is too large, the deployment will error.
+ // Immutable. The minimum number of replicas this DeployedModel will be always
+ // deployed on. If traffic against it increases, it may dynamically be
+ // deployed onto more replicas up to
+ // [max_replica_count][google.cloud.aiplatform.v1.AutomaticResources.max_replica_count],
+ // and as traffic decreases, some of these extra replicas may be freed. If the
+ // requested value is too large, the deployment will error.
int32 min_replica_count = 1 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The maximum number of replicas this DeployedModel may be deployed on when
- // the traffic against it increases. If the requested value is too large,
- // the deployment will error, but if deployment succeeds then the ability
- // to scale the model to that many replicas is guaranteed (barring service
- // outages). If traffic against the DeployedModel increases beyond what its
- // replicas at maximum may handle, a portion of the traffic will be dropped.
- // If this value is not provided, a no upper bound for scaling under heavy
- // traffic will be assume, though Vertex AI may be unable to scale beyond
- // certain replica number.
+ // Immutable. The maximum number of replicas this DeployedModel may be
+ // deployed on when the traffic against it increases. If the requested value
+ // is too large, the deployment will error, but if deployment succeeds then
+ // the ability to scale the model to that many replicas is guaranteed (barring
+ // service outages). If traffic against the DeployedModel increases beyond
+ // what its replicas at maximum may handle, a portion of the traffic will be
+ // dropped. If this value is not provided, a no upper bound for scaling under
+ // heavy traffic will be assume, though Vertex AI may be unable to scale
+ // beyond certain replica number.
int32 max_replica_count = 2 [(google.api.field_behavior) = IMMUTABLE];
}
@@ -140,21 +152,21 @@ message BatchDedicatedResources {
(google.api.field_behavior) = IMMUTABLE
];
- // Immutable. The number of machine replicas used at the start of the batch operation.
- // If not set, Vertex AI decides starting number, not greater than
+ // Immutable. The number of machine replicas used at the start of the batch
+ // operation. If not set, Vertex AI decides starting number, not greater than
// [max_replica_count][google.cloud.aiplatform.v1.BatchDedicatedResources.max_replica_count]
int32 starting_replica_count = 2 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The maximum number of machine replicas the batch operation may be scaled
- // to. The default value is 10.
+ // Immutable. The maximum number of machine replicas the batch operation may
+ // be scaled to. The default value is 10.
int32 max_replica_count = 3 [(google.api.field_behavior) = IMMUTABLE];
}
// Statistics information about resource consumption.
message ResourcesConsumed {
- // Output only. The number of replica hours used. Note that many replicas may run in
- // parallel, and additionally any given work may be queued for some time.
- // Therefore this value is not strictly related to wall time.
+ // Output only. The number of replica hours used. Note that many replicas may
+ // run in parallel, and additionally any given work may be queued for some
+ // time. Therefore this value is not strictly related to wall time.
double replica_hours = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -179,8 +191,8 @@ message NfsMount {
// the source mount path in the form of `server:path`
string path = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. Destination mount path. The NFS will be mounted for the user under
- // /mnt/nfs/
+ // Required. Destination mount path. The NFS will be mounted for the user
+ // under /mnt/nfs/
string mount_point = 3 [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto b/third_party/googleapis/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto
index e469d45eb..68ea0a035 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ManualBatchTuningParametersProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -28,11 +28,11 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// Manual batch tuning parameters.
message ManualBatchTuningParameters {
- // Immutable. The number of the records (e.g. instances) of the operation given in
- // each batch to a machine replica. Machine type, and size of a single
- // record should be considered when setting this parameter, higher value
- // speeds up the batch operation's execution, but too high value will result
- // in a whole batch not fitting in a machine's memory, and the whole
+ // Immutable. The number of the records (e.g. instances) of the operation
+ // given in each batch to a machine replica. Machine type, and size of a
+ // single record should be considered when setting this parameter, higher
+ // value speeds up the batch operation's execution, but too high value will
+ // result in a whole batch not fitting in a machine's memory, and the whole
// operation will fail.
// The default value is 64.
int32 batch_size = 1 [(google.api.field_behavior) = IMMUTABLE];
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/metadata_schema.proto b/third_party/googleapis/google/cloud/aiplatform/v1/metadata_schema.proto
index b00a15529..26a5257df 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/metadata_schema.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/metadata_schema.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MetadataSchemaProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -58,9 +58,9 @@ message MetadataSchema {
// allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
string schema_version = 2;
- // Required. The raw YAML string representation of the MetadataSchema. The combination
- // of [MetadataSchema.version] and the schema name given by `title` in
- // [MetadataSchema.schema] must be unique within a MetadataStore.
+ // Required. The raw YAML string representation of the MetadataSchema. The
+ // combination of [MetadataSchema.version] and the schema name given by
+ // `title` in [MetadataSchema.schema] must be unique within a MetadataStore.
//
// The schema is defined as an OpenAPI 3.0.2
// [MetadataSchema
@@ -72,7 +72,8 @@ message MetadataSchema {
MetadataSchemaType schema_type = 4;
// Output only. Timestamp when this MetadataSchema was created.
- google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Description of the Metadata Schema
string description = 6;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/metadata_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/metadata_service.proto
index 683f8ebd9..774323923 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/metadata_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/metadata_service.proto
@@ -29,10 +29,11 @@ import "google/cloud/aiplatform/v1/metadata_schema.proto";
import "google/cloud/aiplatform/v1/metadata_store.proto";
import "google/cloud/aiplatform/v1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MetadataServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -42,15 +43,18 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// Service for reading and writing metadata entries.
service MetadataService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Initializes a MetadataStore, including allocation of resources.
- rpc CreateMetadataStore(CreateMetadataStoreRequest) returns (google.longrunning.Operation) {
+ rpc CreateMetadataStore(CreateMetadataStoreRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/metadataStores"
body: "metadata_store"
};
- option (google.api.method_signature) = "parent,metadata_store,metadata_store_id";
+ option (google.api.method_signature) =
+ "parent,metadata_store,metadata_store_id";
option (google.longrunning.operation_info) = {
response_type: "MetadataStore"
metadata_type: "CreateMetadataStoreOperationMetadata"
@@ -66,7 +70,8 @@ service MetadataService {
}
// Lists MetadataStores for a Location.
- rpc ListMetadataStores(ListMetadataStoresRequest) returns (ListMetadataStoresResponse) {
+ rpc ListMetadataStores(ListMetadataStoresRequest)
+ returns (ListMetadataStoresResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/metadataStores"
};
@@ -75,7 +80,8 @@ service MetadataService {
// Deletes a single MetadataStore and all its child resources (Artifacts,
// Executions, and Contexts).
- rpc DeleteMetadataStore(DeleteMetadataStoreRequest) returns (google.longrunning.Operation) {
+ rpc DeleteMetadataStore(DeleteMetadataStoreRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/metadataStores/*}"
};
@@ -121,7 +127,8 @@ service MetadataService {
}
// Deletes an Artifact.
- rpc DeleteArtifact(DeleteArtifactRequest) returns (google.longrunning.Operation) {
+ rpc DeleteArtifact(DeleteArtifactRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/metadataStores/*/artifacts/*}"
};
@@ -133,7 +140,8 @@ service MetadataService {
}
// Purges Artifacts.
- rpc PurgeArtifacts(PurgeArtifactsRequest) returns (google.longrunning.Operation) {
+ rpc PurgeArtifacts(PurgeArtifactsRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/metadataStores/*}/artifacts:purge"
body: "*"
@@ -180,7 +188,8 @@ service MetadataService {
}
// Deletes a stored Context.
- rpc DeleteContext(DeleteContextRequest) returns (google.longrunning.Operation) {
+ rpc DeleteContext(DeleteContextRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/metadataStores/*/contexts/*}"
};
@@ -192,7 +201,8 @@ service MetadataService {
}
// Purges Contexts.
- rpc PurgeContexts(PurgeContextsRequest) returns (google.longrunning.Operation) {
+ rpc PurgeContexts(PurgeContextsRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/metadataStores/*}/contexts:purge"
body: "*"
@@ -207,7 +217,8 @@ service MetadataService {
// Adds a set of Artifacts and Executions to a Context. If any of the
// Artifacts or Executions have already been added to a Context, they are
// simply skipped.
- rpc AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest) returns (AddContextArtifactsAndExecutionsResponse) {
+ rpc AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest)
+ returns (AddContextArtifactsAndExecutionsResponse) {
option (google.api.http) = {
post: "/v1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:addContextArtifactsAndExecutions"
body: "*"
@@ -220,7 +231,8 @@ service MetadataService {
// simply skipped. If this call would create a cycle or cause any Context to
// have more than 10 parents, the request will fail with an INVALID_ARGUMENT
// error.
- rpc AddContextChildren(AddContextChildrenRequest) returns (AddContextChildrenResponse) {
+ rpc AddContextChildren(AddContextChildrenRequest)
+ returns (AddContextChildrenResponse) {
option (google.api.http) = {
post: "/v1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:addContextChildren"
body: "*"
@@ -231,7 +243,8 @@ service MetadataService {
// Remove a set of children contexts from a parent Context. If any of the
// child Contexts were NOT added to the parent Context, they are
// simply skipped.
- rpc RemoveContextChildren(RemoveContextChildrenRequest) returns (RemoveContextChildrenResponse) {
+ rpc RemoveContextChildren(RemoveContextChildrenRequest)
+ returns (RemoveContextChildrenResponse) {
option (google.api.http) = {
post: "/v1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:removeContextChildren"
body: "*"
@@ -241,7 +254,8 @@ service MetadataService {
// Retrieves Artifacts and Executions within the specified Context, connected
// by Event edges and returned as a LineageSubgraph.
- rpc QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest) returns (LineageSubgraph) {
+ rpc QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest)
+ returns (LineageSubgraph) {
option (google.api.http) = {
get: "/v1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:queryContextLineageSubgraph"
};
@@ -283,7 +297,8 @@ service MetadataService {
}
// Deletes an Execution.
- rpc DeleteExecution(DeleteExecutionRequest) returns (google.longrunning.Operation) {
+ rpc DeleteExecution(DeleteExecutionRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/metadataStores/*/executions/*}"
};
@@ -295,7 +310,8 @@ service MetadataService {
}
// Purges Executions.
- rpc PurgeExecutions(PurgeExecutionsRequest) returns (google.longrunning.Operation) {
+ rpc PurgeExecutions(PurgeExecutionsRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/metadataStores/*}/executions:purge"
body: "*"
@@ -311,7 +327,8 @@ service MetadataService {
// Artifact was used as an input or output for an Execution. If an Event
// already exists between the Execution and the Artifact, the Event is
// skipped.
- rpc AddExecutionEvents(AddExecutionEventsRequest) returns (AddExecutionEventsResponse) {
+ rpc AddExecutionEvents(AddExecutionEventsRequest)
+ returns (AddExecutionEventsResponse) {
option (google.api.http) = {
post: "/v1/{execution=projects/*/locations/*/metadataStores/*/executions/*}:addExecutionEvents"
body: "*"
@@ -322,7 +339,8 @@ service MetadataService {
// Obtains the set of input and output Artifacts for this Execution, in the
// form of LineageSubgraph that also contains the Execution and connecting
// Events.
- rpc QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest) returns (LineageSubgraph) {
+ rpc QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest)
+ returns (LineageSubgraph) {
option (google.api.http) = {
get: "/v1/{execution=projects/*/locations/*/metadataStores/*/executions/*}:queryExecutionInputsAndOutputs"
};
@@ -330,12 +348,14 @@ service MetadataService {
}
// Creates a MetadataSchema.
- rpc CreateMetadataSchema(CreateMetadataSchemaRequest) returns (MetadataSchema) {
+ rpc CreateMetadataSchema(CreateMetadataSchemaRequest)
+ returns (MetadataSchema) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/metadataStores/*}/metadataSchemas"
body: "metadata_schema"
};
- option (google.api.method_signature) = "parent,metadata_schema,metadata_schema_id";
+ option (google.api.method_signature) =
+ "parent,metadata_schema,metadata_schema_id";
}
// Retrieves a specific MetadataSchema.
@@ -347,7 +367,8 @@ service MetadataService {
}
// Lists MetadataSchemas.
- rpc ListMetadataSchemas(ListMetadataSchemasRequest) returns (ListMetadataSchemasResponse) {
+ rpc ListMetadataSchemas(ListMetadataSchemasRequest)
+ returns (ListMetadataSchemasResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/metadataStores/*}/metadataSchemas"
};
@@ -356,7 +377,8 @@ service MetadataService {
// Retrieves lineage of an Artifact represented through Artifacts and
// Executions connected by Event edges and returned as a LineageSubgraph.
- rpc QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest) returns (LineageSubgraph) {
+ rpc QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest)
+ returns (LineageSubgraph) {
option (google.api.http) = {
get: "/v1/{artifact=projects/*/locations/*/metadataStores/*/artifacts/*}:queryArtifactLineageSubgraph"
};
@@ -364,7 +386,8 @@ service MetadataService {
}
}
-// Request message for [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore].
+// Request message for
+// [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore].
message CreateMetadataStoreRequest {
// Required. The resource name of the Location where the MetadataStore should
// be created.
@@ -390,13 +413,15 @@ message CreateMetadataStoreRequest {
string metadata_store_id = 3;
}
-// Details of operations that perform [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore].
+// Details of operations that perform
+// [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore].
message CreateMetadataStoreOperationMetadata {
// Operation metadata for creating a MetadataStore.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [MetadataService.GetMetadataStore][google.cloud.aiplatform.v1.MetadataService.GetMetadataStore].
+// Request message for
+// [MetadataService.GetMetadataStore][google.cloud.aiplatform.v1.MetadataService.GetMetadataStore].
message GetMetadataStoreRequest {
// Required. The resource name of the MetadataStore to retrieve.
// Format:
@@ -409,7 +434,8 @@ message GetMetadataStoreRequest {
];
}
-// Request message for [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores].
+// Request message for
+// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores].
message ListMetadataStoresRequest {
// Required. The Location whose MetadataStores should be listed.
// Format:
@@ -427,8 +453,8 @@ message ListMetadataStoresRequest {
int32 page_size = 2;
// A page token, received from a previous
- // [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores] call. Provide this to retrieve the
- // subsequent page.
+ // [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other provided parameters must match the call that
// provided the page token. (Otherwise the request will fail with
@@ -436,18 +462,21 @@ message ListMetadataStoresRequest {
string page_token = 3;
}
-// Response message for [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores].
+// Response message for
+// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores].
message ListMetadataStoresResponse {
// The MetadataStores found for the Location.
repeated MetadataStore metadata_stores = 1;
// A token, which can be sent as
- // [ListMetadataStoresRequest.page_token][google.cloud.aiplatform.v1.ListMetadataStoresRequest.page_token] to retrieve the next
- // page. If this field is not populated, there are no subsequent pages.
+ // [ListMetadataStoresRequest.page_token][google.cloud.aiplatform.v1.ListMetadataStoresRequest.page_token]
+ // to retrieve the next page. If this field is not populated, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore].
+// Request message for
+// [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore].
message DeleteMetadataStoreRequest {
// Required. The resource name of the MetadataStore to delete.
// Format:
@@ -463,13 +492,15 @@ message DeleteMetadataStoreRequest {
bool force = 2 [deprecated = true];
}
-// Details of operations that perform [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore].
+// Details of operations that perform
+// [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore].
message DeleteMetadataStoreOperationMetadata {
// Operation metadata for deleting a MetadataStore.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [MetadataService.CreateArtifact][google.cloud.aiplatform.v1.MetadataService.CreateArtifact].
+// Request message for
+// [MetadataService.CreateArtifact][google.cloud.aiplatform.v1.MetadataService.CreateArtifact].
message CreateArtifactRequest {
// Required. The resource name of the MetadataStore where the Artifact should
// be created.
@@ -495,7 +526,8 @@ message CreateArtifactRequest {
string artifact_id = 3;
}
-// Request message for [MetadataService.GetArtifact][google.cloud.aiplatform.v1.MetadataService.GetArtifact].
+// Request message for
+// [MetadataService.GetArtifact][google.cloud.aiplatform.v1.MetadataService.GetArtifact].
message GetArtifactRequest {
// Required. The resource name of the Artifact to retrieve.
// Format:
@@ -508,7 +540,8 @@ message GetArtifactRequest {
];
}
-// Request message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts].
+// Request message for
+// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts].
message ListArtifactsRequest {
// Required. The MetadataStore whose Artifacts should be listed.
// Format:
@@ -524,7 +557,8 @@ message ListArtifactsRequest {
// Must be in range 1-1000, inclusive. Defaults to 100.
int32 page_size = 2;
- // A page token, received from a previous [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]
+ // A page token, received from a previous
+ // [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other provided parameters must match the call that
@@ -571,36 +605,41 @@ message ListArtifactsRequest {
string order_by = 5;
}
-// Response message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts].
+// Response message for
+// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts].
message ListArtifactsResponse {
// The Artifacts retrieved from the MetadataStore.
repeated Artifact artifacts = 1;
- // A token, which can be sent as [ListArtifactsRequest.page_token][google.cloud.aiplatform.v1.ListArtifactsRequest.page_token]
+ // A token, which can be sent as
+ // [ListArtifactsRequest.page_token][google.cloud.aiplatform.v1.ListArtifactsRequest.page_token]
// to retrieve the next page.
// If this field is not populated, there are no subsequent pages.
string next_page_token = 2;
}
-// Request message for [MetadataService.UpdateArtifact][google.cloud.aiplatform.v1.MetadataService.UpdateArtifact].
+// Request message for
+// [MetadataService.UpdateArtifact][google.cloud.aiplatform.v1.MetadataService.UpdateArtifact].
message UpdateArtifactRequest {
// Required. The Artifact containing updates.
- // The Artifact's [Artifact.name][google.cloud.aiplatform.v1.Artifact.name] field is used to identify the Artifact to
- // be updated.
- // Format:
+ // The Artifact's [Artifact.name][google.cloud.aiplatform.v1.Artifact.name]
+ // field is used to identify the Artifact to be updated. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
Artifact artifact = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. A FieldMask indicating which fields should be updated.
// Functionality of this field is not yet supported.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = OPTIONAL];
- // If set to true, and the [Artifact][google.cloud.aiplatform.v1.Artifact] is not found, a new [Artifact][google.cloud.aiplatform.v1.Artifact] is
+ // If set to true, and the [Artifact][google.cloud.aiplatform.v1.Artifact] is
+ // not found, a new [Artifact][google.cloud.aiplatform.v1.Artifact] is
// created.
bool allow_missing = 3;
}
-// Request message for [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1.MetadataService.DeleteArtifact].
+// Request message for
+// [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1.MetadataService.DeleteArtifact].
message DeleteArtifactRequest {
// Required. The resource name of the Artifact to delete.
// Format:
@@ -618,7 +657,8 @@ message DeleteArtifactRequest {
string etag = 2 [(google.api.field_behavior) = OPTIONAL];
}
-// Request message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].
+// Request message for
+// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].
message PurgeArtifactsRequest {
// Required. The metadata store to purge Artifacts from.
// Format:
@@ -640,7 +680,8 @@ message PurgeArtifactsRequest {
bool force = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].
+// Response message for
+// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].
message PurgeArtifactsResponse {
// The number of Artifacts that this request deleted (or, if `force` is false,
// the number of Artifacts that will be deleted). This can be an estimate.
@@ -650,21 +691,22 @@ message PurgeArtifactsResponse {
// Only populated if `force` is set to false. The maximum number of samples is
// 100 (it is possible to return fewer).
repeated string purge_sample = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Artifact"
- }];
+ type: "aiplatform.googleapis.com/Artifact"
+ }];
}
-// Details of operations that perform [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].
+// Details of operations that perform
+// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts].
message PurgeArtifactsMetadata {
// Operation metadata for purging Artifacts.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [MetadataService.CreateContext][google.cloud.aiplatform.v1.MetadataService.CreateContext].
+// Request message for
+// [MetadataService.CreateContext][google.cloud.aiplatform.v1.MetadataService.CreateContext].
message CreateContextRequest {
- // Required. The resource name of the MetadataStore where the Context should be
- // created.
- // Format:
+ // Required. The resource name of the MetadataStore where the Context should
+ // be created. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -686,7 +728,8 @@ message CreateContextRequest {
string context_id = 3;
}
-// Request message for [MetadataService.GetContext][google.cloud.aiplatform.v1.MetadataService.GetContext].
+// Request message for
+// [MetadataService.GetContext][google.cloud.aiplatform.v1.MetadataService.GetContext].
message GetContextRequest {
// Required. The resource name of the Context to retrieve.
// Format:
@@ -699,7 +742,8 @@ message GetContextRequest {
];
}
-// Request message for [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]
+// Request message for
+// [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]
message ListContextsRequest {
// Required. The MetadataStore whose Contexts should be listed.
// Format:
@@ -715,7 +759,8 @@ message ListContextsRequest {
// Must be in range 1-1000, inclusive. Defaults to 100.
int32 page_size = 2;
- // A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]
+ // A page token, received from a previous
+ // [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other provided parameters must match the call that
@@ -766,36 +811,40 @@ message ListContextsRequest {
string order_by = 5;
}
-// Response message for [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts].
+// Response message for
+// [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts].
message ListContextsResponse {
// The Contexts retrieved from the MetadataStore.
repeated Context contexts = 1;
- // A token, which can be sent as [ListContextsRequest.page_token][google.cloud.aiplatform.v1.ListContextsRequest.page_token]
+ // A token, which can be sent as
+ // [ListContextsRequest.page_token][google.cloud.aiplatform.v1.ListContextsRequest.page_token]
// to retrieve the next page.
// If this field is not populated, there are no subsequent pages.
string next_page_token = 2;
}
-// Request message for [MetadataService.UpdateContext][google.cloud.aiplatform.v1.MetadataService.UpdateContext].
+// Request message for
+// [MetadataService.UpdateContext][google.cloud.aiplatform.v1.MetadataService.UpdateContext].
message UpdateContextRequest {
// Required. The Context containing updates.
- // The Context's [Context.name][google.cloud.aiplatform.v1.Context.name] field is used to identify the Context to be
- // updated.
- // Format:
+ // The Context's [Context.name][google.cloud.aiplatform.v1.Context.name] field
+ // is used to identify the Context to be updated. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Context context = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. A FieldMask indicating which fields should be updated.
// Functionality of this field is not yet supported.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = OPTIONAL];
- // If set to true, and the [Context][google.cloud.aiplatform.v1.Context] is not found, a new [Context][google.cloud.aiplatform.v1.Context] is
- // created.
+ // If set to true, and the [Context][google.cloud.aiplatform.v1.Context] is
+ // not found, a new [Context][google.cloud.aiplatform.v1.Context] is created.
bool allow_missing = 3;
}
-// Request message for [MetadataService.DeleteContext][google.cloud.aiplatform.v1.MetadataService.DeleteContext].
+// Request message for
+// [MetadataService.DeleteContext][google.cloud.aiplatform.v1.MetadataService.DeleteContext].
message DeleteContextRequest {
// Required. The resource name of the Context to delete.
// Format:
@@ -817,7 +866,8 @@ message DeleteContextRequest {
string etag = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Request message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].
+// Request message for
+// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].
message PurgeContextsRequest {
// Required. The metadata store to purge Contexts from.
// Format:
@@ -839,7 +889,8 @@ message PurgeContextsRequest {
bool force = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].
+// Response message for
+// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].
message PurgeContextsResponse {
// The number of Contexts that this request deleted (or, if `force` is false,
// the number of Contexts that will be deleted). This can be an estimate.
@@ -849,21 +900,22 @@ message PurgeContextsResponse {
// Only populated if `force` is set to false. The maximum number of samples is
// 100 (it is possible to return fewer).
repeated string purge_sample = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Context"
- }];
+ type: "aiplatform.googleapis.com/Context"
+ }];
}
-// Details of operations that perform [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].
+// Details of operations that perform
+// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts].
message PurgeContextsMetadata {
// Operation metadata for purging Contexts.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions].
+// Request message for
+// [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions].
message AddContextArtifactsAndExecutionsRequest {
- // Required. The resource name of the Context that the Artifacts and Executions
- // belong to.
- // Format:
+ // Required. The resource name of the Context that the Artifacts and
+ // Executions belong to. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
string context = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -877,8 +929,8 @@ message AddContextArtifactsAndExecutionsRequest {
// Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
repeated string artifacts = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Artifact"
- }];
+ type: "aiplatform.googleapis.com/Artifact"
+ }];
// The resource names of the Executions to associate with the
// Context.
@@ -886,16 +938,16 @@ message AddContextArtifactsAndExecutionsRequest {
// Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
repeated string executions = 3 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Execution"
- }];
+ type: "aiplatform.googleapis.com/Execution"
+ }];
}
-// Response message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions].
-message AddContextArtifactsAndExecutionsResponse {
-
-}
+// Response message for
+// [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions].
+message AddContextArtifactsAndExecutionsResponse {}
-// Request message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren].
+// Request message for
+// [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren].
message AddContextChildrenRequest {
// Required. The resource name of the parent Context.
//
@@ -910,14 +962,13 @@ message AddContextChildrenRequest {
// The resource names of the child Contexts.
repeated string child_contexts = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Context"
- }];
+ type: "aiplatform.googleapis.com/Context"
+ }];
}
-// Response message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren].
-message AddContextChildrenResponse {
-
-}
+// Response message for
+// [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren].
+message AddContextChildrenResponse {}
// Request message for
// [MetadataService.DeleteContextChildrenRequest][].
@@ -935,16 +986,16 @@ message RemoveContextChildrenRequest {
// The resource names of the child Contexts.
repeated string child_contexts = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Context"
- }];
+ type: "aiplatform.googleapis.com/Context"
+ }];
}
-// Response message for [MetadataService.RemoveContextChildren][google.cloud.aiplatform.v1.MetadataService.RemoveContextChildren].
-message RemoveContextChildrenResponse {
+// Response message for
+// [MetadataService.RemoveContextChildren][google.cloud.aiplatform.v1.MetadataService.RemoveContextChildren].
+message RemoveContextChildrenResponse {}
-}
-
-// Request message for [MetadataService.QueryContextLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryContextLineageSubgraph].
+// Request message for
+// [MetadataService.QueryContextLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryContextLineageSubgraph].
message QueryContextLineageSubgraphRequest {
// Required. The resource name of the Context whose Artifacts and Executions
// should be retrieved as a LineageSubgraph.
@@ -962,7 +1013,8 @@ message QueryContextLineageSubgraphRequest {
];
}
-// Request message for [MetadataService.CreateExecution][google.cloud.aiplatform.v1.MetadataService.CreateExecution].
+// Request message for
+// [MetadataService.CreateExecution][google.cloud.aiplatform.v1.MetadataService.CreateExecution].
message CreateExecutionRequest {
// Required. The resource name of the MetadataStore where the Execution should
// be created.
@@ -989,7 +1041,8 @@ message CreateExecutionRequest {
string execution_id = 3;
}
-// Request message for [MetadataService.GetExecution][google.cloud.aiplatform.v1.MetadataService.GetExecution].
+// Request message for
+// [MetadataService.GetExecution][google.cloud.aiplatform.v1.MetadataService.GetExecution].
message GetExecutionRequest {
// Required. The resource name of the Execution to retrieve.
// Format:
@@ -1002,7 +1055,8 @@ message GetExecutionRequest {
];
}
-// Request message for [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions].
+// Request message for
+// [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions].
message ListExecutionsRequest {
// Required. The MetadataStore whose Executions should be listed.
// Format:
@@ -1018,7 +1072,8 @@ message ListExecutionsRequest {
// Must be in range 1-1000, inclusive. Defaults to 100.
int32 page_size = 2;
- // A page token, received from a previous [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions]
+ // A page token, received from a previous
+ // [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other provided parameters must match the call that
@@ -1065,36 +1120,41 @@ message ListExecutionsRequest {
string order_by = 5;
}
-// Response message for [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions].
+// Response message for
+// [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions].
message ListExecutionsResponse {
// The Executions retrieved from the MetadataStore.
repeated Execution executions = 1;
- // A token, which can be sent as [ListExecutionsRequest.page_token][google.cloud.aiplatform.v1.ListExecutionsRequest.page_token]
+ // A token, which can be sent as
+ // [ListExecutionsRequest.page_token][google.cloud.aiplatform.v1.ListExecutionsRequest.page_token]
// to retrieve the next page.
// If this field is not populated, there are no subsequent pages.
string next_page_token = 2;
}
-// Request message for [MetadataService.UpdateExecution][google.cloud.aiplatform.v1.MetadataService.UpdateExecution].
+// Request message for
+// [MetadataService.UpdateExecution][google.cloud.aiplatform.v1.MetadataService.UpdateExecution].
message UpdateExecutionRequest {
// Required. The Execution containing updates.
- // The Execution's [Execution.name][google.cloud.aiplatform.v1.Execution.name] field is used to identify the Execution
- // to be updated.
- // Format:
+ // The Execution's [Execution.name][google.cloud.aiplatform.v1.Execution.name]
+ // field is used to identify the Execution to be updated. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
Execution execution = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. A FieldMask indicating which fields should be updated.
// Functionality of this field is not yet supported.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = OPTIONAL];
- // If set to true, and the [Execution][google.cloud.aiplatform.v1.Execution] is not found, a new [Execution][google.cloud.aiplatform.v1.Execution]
- // is created.
+ // If set to true, and the [Execution][google.cloud.aiplatform.v1.Execution]
+ // is not found, a new [Execution][google.cloud.aiplatform.v1.Execution] is
+ // created.
bool allow_missing = 3;
}
-// Request message for [MetadataService.DeleteExecution][google.cloud.aiplatform.v1.MetadataService.DeleteExecution].
+// Request message for
+// [MetadataService.DeleteExecution][google.cloud.aiplatform.v1.MetadataService.DeleteExecution].
message DeleteExecutionRequest {
// Required. The resource name of the Execution to delete.
// Format:
@@ -1112,7 +1172,8 @@ message DeleteExecutionRequest {
string etag = 2 [(google.api.field_behavior) = OPTIONAL];
}
-// Request message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].
+// Request message for
+// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].
message PurgeExecutionsRequest {
// Required. The metadata store to purge Executions from.
// Format:
@@ -1134,7 +1195,8 @@ message PurgeExecutionsRequest {
bool force = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].
+// Response message for
+// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].
message PurgeExecutionsResponse {
// The number of Executions that this request deleted (or, if `force` is
// false, the number of Executions that will be deleted). This can be an
@@ -1145,17 +1207,19 @@ message PurgeExecutionsResponse {
// Only populated if `force` is set to false. The maximum number of samples is
// 100 (it is possible to return fewer).
repeated string purge_sample = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Execution"
- }];
+ type: "aiplatform.googleapis.com/Execution"
+ }];
}
-// Details of operations that perform [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].
+// Details of operations that perform
+// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions].
message PurgeExecutionsMetadata {
// Operation metadata for purging Executions.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents].
+// Request message for
+// [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents].
message AddExecutionEventsRequest {
// Required. The resource name of the Execution that the Events connect
// Artifacts with.
@@ -1172,16 +1236,15 @@ message AddExecutionEventsRequest {
repeated Event events = 2;
}
-// Response message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents].
-message AddExecutionEventsResponse {
+// Response message for
+// [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents].
+message AddExecutionEventsResponse {}
-}
-
-// Request message for [MetadataService.QueryExecutionInputsAndOutputs][google.cloud.aiplatform.v1.MetadataService.QueryExecutionInputsAndOutputs].
+// Request message for
+// [MetadataService.QueryExecutionInputsAndOutputs][google.cloud.aiplatform.v1.MetadataService.QueryExecutionInputsAndOutputs].
message QueryExecutionInputsAndOutputsRequest {
- // Required. The resource name of the Execution whose input and output Artifacts should
- // be retrieved as a LineageSubgraph.
- // Format:
+ // Required. The resource name of the Execution whose input and output
+ // Artifacts should be retrieved as a LineageSubgraph. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
string execution = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -1191,11 +1254,11 @@ message QueryExecutionInputsAndOutputsRequest {
];
}
-// Request message for [MetadataService.CreateMetadataSchema][google.cloud.aiplatform.v1.MetadataService.CreateMetadataSchema].
+// Request message for
+// [MetadataService.CreateMetadataSchema][google.cloud.aiplatform.v1.MetadataService.CreateMetadataSchema].
message CreateMetadataSchemaRequest {
- // Required. The resource name of the MetadataStore where the MetadataSchema should
- // be created.
- // Format:
+ // Required. The resource name of the MetadataStore where the MetadataSchema
+ // should be created. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -1218,7 +1281,8 @@ message CreateMetadataSchemaRequest {
string metadata_schema_id = 3;
}
-// Request message for [MetadataService.GetMetadataSchema][google.cloud.aiplatform.v1.MetadataService.GetMetadataSchema].
+// Request message for
+// [MetadataService.GetMetadataSchema][google.cloud.aiplatform.v1.MetadataService.GetMetadataSchema].
message GetMetadataSchemaRequest {
// Required. The resource name of the MetadataSchema to retrieve.
// Format:
@@ -1231,7 +1295,8 @@ message GetMetadataSchemaRequest {
];
}
-// Request message for [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas].
+// Request message for
+// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas].
message ListMetadataSchemasRequest {
// Required. The MetadataStore whose MetadataSchemas should be listed.
// Format:
@@ -1249,8 +1314,8 @@ message ListMetadataSchemasRequest {
int32 page_size = 2;
// A page token, received from a previous
- // [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas] call. Provide this to retrieve the
- // next page.
+ // [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas]
+ // call. Provide this to retrieve the next page.
//
// When paginating, all other provided parameters must match the call that
// provided the page token. (Otherwise the request will fail with
@@ -1261,22 +1326,24 @@ message ListMetadataSchemasRequest {
string filter = 4;
}
-// Response message for [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas].
+// Response message for
+// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas].
message ListMetadataSchemasResponse {
// The MetadataSchemas found for the MetadataStore.
repeated MetadataSchema metadata_schemas = 1;
// A token, which can be sent as
- // [ListMetadataSchemasRequest.page_token][google.cloud.aiplatform.v1.ListMetadataSchemasRequest.page_token] to retrieve the next
- // page. If this field is not populated, there are no subsequent pages.
+ // [ListMetadataSchemasRequest.page_token][google.cloud.aiplatform.v1.ListMetadataSchemasRequest.page_token]
+ // to retrieve the next page. If this field is not populated, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph].
+// Request message for
+// [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph].
message QueryArtifactLineageSubgraphRequest {
- // Required. The resource name of the Artifact whose Lineage needs to be retrieved as a
- // LineageSubgraph.
- // Format:
+ // Required. The resource name of the Artifact whose Lineage needs to be
+ // retrieved as a LineageSubgraph. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
//
// The request may error with FAILED_PRECONDITION if the number of Artifacts,
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/metadata_store.proto b/third_party/googleapis/google/cloud/aiplatform/v1/metadata_store.proto
index 31e7fd2c9..c8583ae2b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/metadata_store.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/metadata_store.proto
@@ -22,7 +22,7 @@ import "google/cloud/aiplatform/v1/encryption_spec.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MetadataProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -47,10 +47,12 @@ message MetadataStore {
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this MetadataStore was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this MetadataStore was last updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Customer-managed encryption key spec for a Metadata Store. If set, this
// Metadata Store and all sub-resources of this Metadata Store are secured
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/migratable_resource.proto b/third_party/googleapis/google/cloud/aiplatform/v1/migratable_resource.proto
index 3306029af..cf8322c68 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/migratable_resource.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/migratable_resource.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MigratableResourceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -65,9 +65,9 @@ message MigratableResource {
// Full resource name of ml engine model Version.
// Format: `projects/{project}/models/{model}/versions/{version}`.
- string version = 2 [(google.api.resource_reference) = {
- type: "ml.googleapis.com/Version"
- }];
+ string version = 2 [
+ (google.api.resource_reference) = { type: "ml.googleapis.com/Version" }
+ ];
}
// Represents one Model in automl.googleapis.com.
@@ -75,9 +75,9 @@ message MigratableResource {
// Full resource name of automl Model.
// Format:
// `projects/{project}/locations/{location}/models/{model}`.
- string model = 1 [(google.api.resource_reference) = {
- type: "automl.googleapis.com/Model"
- }];
+ string model = 1 [
+ (google.api.resource_reference) = { type: "automl.googleapis.com/Model" }
+ ];
// The Model's display name in automl.googleapis.com.
string model_display_name = 3;
@@ -89,8 +89,8 @@ message MigratableResource {
// Format:
// `projects/{project}/locations/{location}/datasets/{dataset}`.
string dataset = 1 [(google.api.resource_reference) = {
- type: "automl.googleapis.com/Dataset"
- }];
+ type: "automl.googleapis.com/Dataset"
+ }];
// The Dataset's display name in automl.googleapis.com.
string dataset_display_name = 4;
@@ -104,8 +104,8 @@ message MigratableResource {
// Format:
// `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.
string annotated_dataset = 1 [(google.api.resource_reference) = {
- type: "datalabeling.googleapis.com/AnnotatedDataset"
- }];
+ type: "datalabeling.googleapis.com/AnnotatedDataset"
+ }];
// The AnnotatedDataset's display name in datalabeling.googleapis.com.
string annotated_dataset_display_name = 3;
@@ -115,8 +115,8 @@ message MigratableResource {
// Format:
// `projects/{project}/datasets/{dataset}`.
string dataset = 1 [(google.api.resource_reference) = {
- type: "datalabeling.googleapis.com/Dataset"
- }];
+ type: "datalabeling.googleapis.com/Dataset"
+ }];
// The Dataset's display name in datalabeling.googleapis.com.
string dataset_display_name = 4;
@@ -128,23 +128,28 @@ message MigratableResource {
oneof resource {
// Output only. Represents one Version in ml.googleapis.com.
- MlEngineModelVersion ml_engine_model_version = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ MlEngineModelVersion ml_engine_model_version = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Represents one Model in automl.googleapis.com.
AutomlModel automl_model = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Represents one Dataset in automl.googleapis.com.
- AutomlDataset automl_dataset = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ AutomlDataset automl_dataset = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Represents one Dataset in datalabeling.googleapis.com.
- DataLabelingDataset data_labeling_dataset = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ DataLabelingDataset data_labeling_dataset = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
- // Output only. Timestamp when the last migration attempt on this MigratableResource
- // started. Will not be set if there's no migration attempt on this
- // MigratableResource.
- google.protobuf.Timestamp last_migrate_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Timestamp when the last migration attempt on this
+ // MigratableResource started. Will not be set if there's no migration attempt
+ // on this MigratableResource.
+ google.protobuf.Timestamp last_migrate_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this MigratableResource was last updated.
- google.protobuf.Timestamp last_update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp last_update_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/migration_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/migration_service.proto
index bcacf30a4..ac1b7f0ea 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/migration_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/migration_service.proto
@@ -26,7 +26,7 @@ import "google/longrunning/operations.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MigrationServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -37,12 +37,14 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
service MigrationService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Searches all of the resources in automl.googleapis.com,
// datalabeling.googleapis.com and ml.googleapis.com that can be migrated to
// Vertex AI's given location.
- rpc SearchMigratableResources(SearchMigratableResourcesRequest) returns (SearchMigratableResourcesResponse) {
+ rpc SearchMigratableResources(SearchMigratableResourcesRequest)
+ returns (SearchMigratableResourcesResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/migratableResources:search"
body: "*"
@@ -52,7 +54,8 @@ service MigrationService {
// Batch migrates resources from ml.googleapis.com, automl.googleapis.com,
// and datalabeling.googleapis.com to Vertex AI.
- rpc BatchMigrateResources(BatchMigrateResourcesRequest) returns (google.longrunning.Operation) {
+ rpc BatchMigrateResources(BatchMigrateResourcesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/migratableResources:batchMigrate"
body: "*"
@@ -65,12 +68,12 @@ service MigrationService {
}
}
-// Request message for [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources].
+// Request message for
+// [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources].
message SearchMigratableResourcesRequest {
- // Required. The location that the migratable resources should be searched from.
- // It's the Vertex AI location that the resources can be migrated to, not
- // the resources' original location.
- // Format:
+ // Required. The location that the migratable resources should be searched
+ // from. It's the Vertex AI location that the resources can be migrated to,
+ // not the resources' original location. Format:
// `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -101,7 +104,8 @@ message SearchMigratableResourcesRequest {
string filter = 4;
}
-// Response message for [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources].
+// Response message for
+// [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources].
message SearchMigratableResourcesResponse {
// All migratable resources that can be migrated to the
// location specified in the request.
@@ -113,7 +117,8 @@ message SearchMigratableResourcesResponse {
string next_page_token = 2;
}
-// Request message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].
+// Request message for
+// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].
message BatchMigrateResourcesRequest {
// Required. The location of the migrated resource will live in.
// Format: `projects/{project}/locations/{location}`
@@ -127,7 +132,8 @@ message BatchMigrateResourcesRequest {
// Required. The request messages specifying the resources to migrate.
// They must be in the same location as the destination.
// Up to 50 resources can be migrated in one batch.
- repeated MigrateResourceRequest migrate_resource_requests = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated MigrateResourceRequest migrate_resource_requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Config of migrating one resource from automl.googleapis.com,
@@ -135,9 +141,8 @@ message BatchMigrateResourcesRequest {
message MigrateResourceRequest {
// Config for migrating version in ml.googleapis.com to Vertex AI's Model.
message MigrateMlEngineModelVersionConfig {
- // Required. The ml.googleapis.com endpoint that this model version should be migrated
- // from.
- // Example values:
+ // Required. The ml.googleapis.com endpoint that this model version should
+ // be migrated from. Example values:
//
// * ml.googleapis.com
//
@@ -152,9 +157,7 @@ message MigrateResourceRequest {
// Format: `projects/{project}/models/{model}/versions/{version}`.
string model_version = 2 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "ml.googleapis.com/Version"
- }
+ (google.api.resource_reference) = { type: "ml.googleapis.com/Version" }
];
// Required. Display name of the model in Vertex AI.
@@ -169,9 +172,7 @@ message MigrateResourceRequest {
// `projects/{project}/locations/{location}/models/{model}`.
string model = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "automl.googleapis.com/Model"
- }
+ (google.api.resource_reference) = { type: "automl.googleapis.com/Model" }
];
// Optional. Display name of the model in Vertex AI.
@@ -228,15 +229,18 @@ message MigrateResourceRequest {
// System will pick a display name if unspecified.
string dataset_display_name = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Configs for migrating AnnotatedDataset in datalabeling.googleapis.com to
- // Vertex AI's SavedQuery. The specified AnnotatedDatasets have to belong
- // to the datalabeling Dataset.
- repeated MigrateDataLabelingAnnotatedDatasetConfig migrate_data_labeling_annotated_dataset_configs = 3 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. Configs for migrating AnnotatedDataset in
+ // datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified
+ // AnnotatedDatasets have to belong to the datalabeling Dataset.
+ repeated MigrateDataLabelingAnnotatedDatasetConfig
+ migrate_data_labeling_annotated_dataset_configs = 3
+ [(google.api.field_behavior) = OPTIONAL];
}
oneof request {
// Config for migrating Version in ml.googleapis.com to Vertex AI's Model.
- MigrateMlEngineModelVersionConfig migrate_ml_engine_model_version_config = 1;
+ MigrateMlEngineModelVersionConfig migrate_ml_engine_model_version_config =
+ 1;
// Config for migrating Model in automl.googleapis.com to Vertex AI's
// Model.
@@ -252,7 +256,8 @@ message MigrateResourceRequest {
}
}
-// Response message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].
+// Response message for
+// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].
message BatchMigrateResourcesResponse {
// Successfully migrated resources.
repeated MigrateResourceResponse migrate_resource_responses = 1;
@@ -264,13 +269,13 @@ message MigrateResourceResponse {
oneof migrated_resource {
// Migrated Dataset's resource name.
string dataset = 1 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Dataset"
- }];
+ type: "aiplatform.googleapis.com/Dataset"
+ }];
// Migrated Model's resource name.
string model = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Model"
- }];
+ type: "aiplatform.googleapis.com/Model"
+ }];
}
// Before migration, the identifier in ml.googleapis.com,
@@ -278,7 +283,8 @@ message MigrateResourceResponse {
MigratableResource migratable_resource = 3;
}
-// Runtime operation information for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].
+// Runtime operation information for
+// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources].
message BatchMigrateResourcesOperationMetadata {
// Represents a partial result in batch migration operation for one
// [MigrateResourceRequest][google.cloud.aiplatform.v1.MigrateResourceRequest].
@@ -292,13 +298,13 @@ message BatchMigrateResourcesOperationMetadata {
// Migrated model resource name.
string model = 3 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Model"
- }];
+ type: "aiplatform.googleapis.com/Model"
+ }];
// Migrated dataset resource name.
string dataset = 4 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Dataset"
- }];
+ type: "aiplatform.googleapis.com/Dataset"
+ }];
}
// It's the same as the value in
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/model.proto b/third_party/googleapis/google/cloud/aiplatform/v1/model.proto
index 767570187..6f04eb348 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/model.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/model.proto
@@ -26,7 +26,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -50,12 +50,15 @@ message Model {
// Model artifact and any of its supported files. Will be exported to the
// location specified by the `artifactDestination` field of the
- // [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config] object.
+ // [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config]
+ // object.
ARTIFACT = 1;
// The container image that is to be used when deploying this Model. Will
// be exported to the location specified by the `imageDestination` field
- // of the [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config] object.
+ // of the
+ // [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config]
+ // object.
IMAGE = 2;
}
@@ -83,7 +86,21 @@ message Model {
string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The content of this Model that may be exported.
- repeated ExportableContent exportable_contents = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated ExportableContent exportable_contents = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Contains information about the original Model if this Model is a copy.
+ message OriginalModelInfo {
+ // Output only. The resource name of the Model this Model is a copy of,
+ // including the revision. Format:
+ // `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
+ string model = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/Model"
+ }
+ ];
}
// Identifies a type of Model's prediction resources.
@@ -91,16 +108,18 @@ message Model {
// Should not be used.
DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0;
- // Resources that are dedicated to the [DeployedModel][google.cloud.aiplatform.v1.DeployedModel], and that need a
- // higher degree of manual configuration.
+ // Resources that are dedicated to the
+ // [DeployedModel][google.cloud.aiplatform.v1.DeployedModel], and that need
+ // a higher degree of manual configuration.
DEDICATED_RESOURCES = 1;
// Resources that to large degree are decided by Vertex AI, and require
// only a modest additional configuration.
AUTOMATIC_RESOURCES = 2;
- // Resources that can be shared by multiple [DeployedModels][google.cloud.aiplatform.v1.DeployedModel].
- // A pre-configured [DeploymentResourcePool][] is required.
+ // Resources that can be shared by multiple
+ // [DeployedModels][google.cloud.aiplatform.v1.DeployedModel]. A
+ // pre-configured [DeploymentResourcePool][] is required.
SHARED_RESOURCES = 3;
}
@@ -128,10 +147,12 @@ message Model {
repeated string version_aliases = 29;
// Output only. Timestamp when this version was created.
- google.protobuf.Timestamp version_create_time = 31 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp version_create_time = 31
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this version was most recently updated.
- google.protobuf.Timestamp version_update_time = 32 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp version_update_time = 32
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Required. The display name of the Model.
// The name can be up to 128 characters long and can consist of any UTF-8
@@ -146,13 +167,15 @@ message Model {
// The schemata that describe formats of the Model's predictions and
// explanations as given and returned via
- // [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
+ // [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
+ // and
+ // [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
PredictSchemata predict_schemata = 4;
- // Immutable. Points to a YAML file stored on Google Cloud Storage describing additional
- // information about the Model, that is specific to it. Unset if the Model
- // does not have any additional information.
- // The schema is defined as an OpenAPI 3.0.2 [Schema
+ // Immutable. Points to a YAML file stored on Google Cloud Storage describing
+ // additional information about the Model, that is specific to it. Unset if
+ // the Model does not have any additional information. The schema is defined
+ // as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
// AutoML Models always have this field populated by Vertex AI, if no
// additional metadata is needed, this field is set to an empty string.
@@ -161,17 +184,19 @@ message Model {
// point to a location where the user only has a read access.
string metadata_schema_uri = 5 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. An additional information about the Model; the schema of the metadata can
- // be found in [metadata_schema][google.cloud.aiplatform.v1.Model.metadata_schema_uri].
+ // Immutable. An additional information about the Model; the schema of the
+ // metadata can be found in
+ // [metadata_schema][google.cloud.aiplatform.v1.Model.metadata_schema_uri].
// Unset if the Model does not have any additional information.
google.protobuf.Value metadata = 6 [(google.api.field_behavior) = IMMUTABLE];
- // Output only. The formats in which this Model may be exported. If empty, this Model is
- // not available for export.
- repeated ExportFormat supported_export_formats = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The formats in which this Model may be exported. If empty,
+ // this Model is not available for export.
+ repeated ExportFormat supported_export_formats = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The resource name of the TrainingPipeline that uploaded this Model, if
- // any.
+ // Output only. The resource name of the TrainingPipeline that uploaded this
+ // Model, if any.
string training_pipeline = 7 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -179,35 +204,43 @@ message Model {
}
];
- // Input only. The specification of the container that is to be used when deploying
- // this Model. The specification is ingested upon
- // [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel], and all binaries it contains are copied
- // and stored internally by Vertex AI.
- // Not present for AutoML Models.
- ModelContainerSpec container_spec = 9 [(google.api.field_behavior) = INPUT_ONLY];
+ // Input only. The specification of the container that is to be used when
+ // deploying this Model. The specification is ingested upon
+ // [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel],
+ // and all binaries it contains are copied and stored internally by Vertex AI.
+ // Not present for AutoML Models or Large Models.
+ ModelContainerSpec container_spec = 9
+ [(google.api.field_behavior) = INPUT_ONLY];
- // Immutable. The path to the directory containing the Model artifact and any of its
- // supporting files.
- // Not present for AutoML Models.
+ // Immutable. The path to the directory containing the Model artifact and any
+ // of its supporting files. Not present for AutoML Models or Large Models.
string artifact_uri = 26 [(google.api.field_behavior) = IMMUTABLE];
- // Output only. When this Model is deployed, its prediction resources are described by the
- // `prediction_resources` field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] object.
- // Because not all Models support all resource configuration types, the
- // configuration types this Model supports are listed here. If no
+ // Output only. When this Model is deployed, its prediction resources are
+ // described by the `prediction_resources` field of the
+ // [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
+ // object. Because not all Models support all resource configuration types,
+ // the configuration types this Model supports are listed here. If no
// configuration types are listed, the Model cannot be deployed to an
// [Endpoint][google.cloud.aiplatform.v1.Endpoint] and does not support
- // online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or
- // [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). Such a Model can serve predictions by
- // using a [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it has at least one entry each in
- // [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] and
+ // online predictions
+ // ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
+ // or
+ // [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]).
+ // Such a Model can serve predictions by using a
+ // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it
+ // has at least one entry each in
+ // [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats]
+ // and
// [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
- repeated DeploymentResourcesType supported_deployment_resources_types = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated DeploymentResourcesType supported_deployment_resources_types = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The formats this Model supports in
- // [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If
- // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] exists, the instances
- // should be given as per that schema.
+ // [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
+ // If
+ // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
+ // exists, the instances should be given as per that schema.
//
// The possible formats are:
//
@@ -218,11 +251,13 @@ message Model {
// * `csv`
// The CSV format, where each instance is a single comma-separated line.
// The first line in the file is the header, containing comma-separated field
- // names. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
+ // names. Uses
+ // [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
//
// * `tf-record`
// The TFRecord format, where each instance is a single record in tfrecord
- // syntax. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
+ // syntax. Uses
+ // [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source].
//
// * `tf-record-gzip`
// Similar to `tf-record`, but the file is gzipped. Uses
@@ -235,23 +270,31 @@ message Model {
// * `file-list`
// Each line of the file is the location of an instance to process, uses
// `gcs_source` field of the
- // [InputConfig][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig] object.
+ // [InputConfig][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig]
+ // object.
//
//
// If this Model doesn't support any of these formats it means it cannot be
- // used with a [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. However, if it has
- // [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online
- // predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or
+ // used with a
+ // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
+ // However, if it has
+ // [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types],
+ // it could serve online predictions by using
+ // [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
+ // or
// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
- repeated string supported_input_storage_formats = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated string supported_input_storage_formats = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The formats this Model supports in
- // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. If both
- // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] and
- // [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri] exist, the predictions
- // are returned together with their instances. In other words, the
- // prediction has the original instance data first, followed
- // by the actual prediction content (as per the schema).
+ // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
+ // If both
+ // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
+ // and
+ // [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri]
+ // exist, the predictions are returned together with their instances. In other
+ // words, the prediction has the original instance data first, followed by the
+ // actual prediction content (as per the schema).
//
// The possible formats are:
//
@@ -272,44 +315,61 @@ message Model {
//
//
// If this Model doesn't support any of these formats it means it cannot be
- // used with a [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. However, if it has
- // [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online
- // predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or
+ // used with a
+ // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
+ // However, if it has
+ // [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types],
+ // it could serve online predictions by using
+ // [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]
+ // or
// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
- repeated string supported_output_storage_formats = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated string supported_output_storage_formats = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Model was uploaded into Vertex AI.
- google.protobuf.Timestamp create_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Model was most recently updated.
- google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The pointers to DeployedModels created from this Model. Note that
- // Model could have been deployed to Endpoints in different Locations.
- repeated DeployedModelRef deployed_models = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The pointers to DeployedModels created from this Model. Note
+ // that Model could have been deployed to Endpoints in different Locations.
+ repeated DeployedModelRef deployed_models = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The default explanation specification for this Model.
//
- // The Model can be used for [requesting
- // explanation][PredictionService.Explain] after being
- // [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if it is populated.
- // The Model can be used for [batch
- // explanation][BatchPredictionJob.generate_explanation] if it is populated.
+ // The Model can be used for
+ // [requesting
+ // explanation][google.cloud.aiplatform.v1.PredictionService.Explain] after
+ // being [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if
+ // it is populated. The Model can be used for [batch
+ // explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
+ // if it is populated.
//
// All fields of the explanation_spec can be overridden by
- // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of
- // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model], or
- // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] of
- // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
+ // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
+ // of
+ // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model],
+ // or
+ // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
+ // of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
//
// If the default explanation specification is not set for this Model, this
- // Model can still be used for [requesting
- // explanation][PredictionService.Explain] by setting
- // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of
- // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model] and for [batch
- // explanation][BatchPredictionJob.generate_explanation] by setting
- // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] of
- // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
+ // Model can still be used for
+ // [requesting
+ // explanation][google.cloud.aiplatform.v1.PredictionService.Explain] by
+ // setting
+ // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
+ // of
+ // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model]
+ // and for [batch
+ // explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
+ // by setting
+ // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
+ // of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
ExplanationSpec explanation_spec = 23;
// Used to perform consistent read-modify-write updates. If not set, a blind
@@ -329,23 +389,33 @@ message Model {
// Model and all sub-resources of this Model will be secured by this key.
EncryptionSpec encryption_spec = 24;
- // Output only. Source of a model. It can either be automl training pipeline, custom
- // training pipeline, BigQuery ML, or existing Vertex AI Model.
- ModelSourceInfo model_source_info = 38 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Source of a model. It can either be automl training pipeline,
+ // custom training pipeline, BigQuery ML, or existing Vertex AI Model.
+ ModelSourceInfo model_source_info = 38
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. If this Model is a copy of another Model, this contains info
+ // about the original.
+ OriginalModelInfo original_model_info = 34
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The resource name of the Artifact that was created in MetadataStore when
- // creating the Model. The Artifact resource name pattern is
+ // Output only. The resource name of the Artifact that was created in
+ // MetadataStore when creating the Model. The Artifact resource name pattern
+ // is
// `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
string metadata_artifact = 44 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Contains the schemata used in Model's predictions and explanations via
-// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict], [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain] and
-// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
+// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict],
+// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]
+// and [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
message PredictSchemata {
- // Immutable. Points to a YAML file stored on Google Cloud Storage describing the format
- // of a single instance, which are used in [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
- // [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances] and
+ // Immutable. Points to a YAML file stored on Google Cloud Storage describing
+ // the format of a single instance, which are used in
+ // [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
+ // [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances]
+ // and
// [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
// The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
@@ -355,9 +425,11 @@ message PredictSchemata {
// point to a location where the user only has a read access.
string instance_schema_uri = 1 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. Points to a YAML file stored on Google Cloud Storage describing the
- // parameters of prediction and explanation via
- // [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters], [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters] and
+ // Immutable. Points to a YAML file stored on Google Cloud Storage describing
+ // the parameters of prediction and explanation via
+ // [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters],
+ // [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters]
+ // and
// [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters].
// The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
@@ -368,9 +440,12 @@ message PredictSchemata {
// point to a location where the user only has a read access.
string parameters_schema_uri = 2 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. Points to a YAML file stored on Google Cloud Storage describing the format
- // of a single prediction produced by this Model, which are returned via
- // [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions], [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations], and
+ // Immutable. Points to a YAML file stored on Google Cloud Storage describing
+ // the format of a single prediction produced by this Model, which are
+ // returned via
+ // [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions],
+ // [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations],
+ // and
// [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
// The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
@@ -385,14 +460,16 @@ message PredictSchemata {
// message correspond to fields in the [Kubernetes Container v1 core
// specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
message ModelContainerSpec {
- // Required. Immutable. URI of the Docker image to be used as the custom container for serving
- // predictions. This URI must identify an image in Artifact Registry or
- // Container Registry. Learn more about the [container publishing
+ // Required. Immutable. URI of the Docker image to be used as the custom
+ // container for serving predictions. This URI must identify an image in
+ // Artifact Registry or Container Registry. Learn more about the [container
+ // publishing
// requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing),
// including permissions requirements for the Vertex AI Service Agent.
//
- // The container image is ingested upon [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel], stored
- // internally, and this original path is afterwards not used.
+ // The container image is ingested upon
+ // [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel],
+ // stored internally, and this original path is afterwards not used.
//
// To learn about the requirements for the Docker image itself, see
// [Custom container
@@ -406,14 +483,15 @@ message ModelContainerSpec {
(google.api.field_behavior) = IMMUTABLE
];
- // Immutable. Specifies the command that runs when the container starts. This overrides
- // the container's
+ // Immutable. Specifies the command that runs when the container starts. This
+ // overrides the container's
// [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint).
// Specify this field as an array of executable and arguments, similar to a
// Docker `ENTRYPOINT`'s "exec" form, not its "shell" form.
//
// If you do not specify this field, then the container's `ENTRYPOINT` runs,
- // in conjunction with the [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] field or the
+ // in conjunction with the
+ // [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] field or the
// container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd),
// if either exists. If this field is not specified and the container does not
// have an `ENTRYPOINT`, then refer to the Docker documentation about [how
@@ -429,32 +507,30 @@ message ModelContainerSpec {
//
// In this field, you can reference [environment variables set by Vertex
// AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables)
- // and environment variables set in the [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field.
- // You cannot reference environment variables set in the Docker image. In
- // order for environment variables to be expanded, reference them by using the
- // following syntax:
- // $(VARIABLE_NAME)
- // Note that this differs from Bash variable expansion, which does not use
- // parentheses. If a variable cannot be resolved, the reference in the input
- // string is used unchanged. To avoid variable expansion, you can escape this
- // syntax with `$$`; for example:
- // $$(VARIABLE_NAME)
- // This field corresponds to the `command` field of the Kubernetes Containers
- // [v1 core
+ // and environment variables set in the
+ // [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. You cannot
+ // reference environment variables set in the Docker image. In order for
+ // environment variables to be expanded, reference them by using the following
+ // syntax: $(VARIABLE_NAME) Note that this differs
+ // from Bash variable expansion, which does not use parentheses. If a variable
+ // cannot be resolved, the reference in the input string is used unchanged. To
+ // avoid variable expansion, you can escape this syntax with `$$`; for
+ // example: $$(VARIABLE_NAME) This field corresponds
+ // to the `command` field of the Kubernetes Containers [v1 core
// API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
repeated string command = 2 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. Specifies arguments for the command that runs when the container starts.
- // This overrides the container's
+ // Immutable. Specifies arguments for the command that runs when the container
+ // starts. This overrides the container's
// [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify
// this field as an array of executable and arguments, similar to a Docker
// `CMD`'s "default parameters" form.
//
// If you don't specify this field but do specify the
- // [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] field, then the command from the
- // `command` field runs without any additional arguments. See the
- // [Kubernetes documentation about how the
- // `command` and `args` fields interact with a container's `ENTRYPOINT` and
+ // [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] field,
+ // then the command from the `command` field runs without any additional
+ // arguments. See the [Kubernetes documentation about how the `command` and
+ // `args` fields interact with a container's `ENTRYPOINT` and
// `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes).
//
// If you don't specify this field and don't specify the `command` field,
@@ -467,29 +543,29 @@ message ModelContainerSpec {
// In this field, you can reference [environment variables
// set by Vertex
// AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables)
- // and environment variables set in the [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field.
- // You cannot reference environment variables set in the Docker image. In
- // order for environment variables to be expanded, reference them by using the
- // following syntax:
- // $(VARIABLE_NAME)
- // Note that this differs from Bash variable expansion, which does not use
- // parentheses. If a variable cannot be resolved, the reference in the input
- // string is used unchanged. To avoid variable expansion, you can escape this
- // syntax with `$$`; for example:
- // $$(VARIABLE_NAME)
- // This field corresponds to the `args` field of the Kubernetes Containers
- // [v1 core
+ // and environment variables set in the
+ // [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. You cannot
+ // reference environment variables set in the Docker image. In order for
+ // environment variables to be expanded, reference them by using the following
+ // syntax: $(VARIABLE_NAME) Note that this differs
+ // from Bash variable expansion, which does not use parentheses. If a variable
+ // cannot be resolved, the reference in the input string is used unchanged. To
+ // avoid variable expansion, you can escape this syntax with `$$`; for
+ // example: $$(VARIABLE_NAME) This field corresponds
+ // to the `args` field of the Kubernetes Containers [v1 core
// API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
repeated string args = 3 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. List of environment variables to set in the container. After the container
- // starts running, code running in the container can read these environment
- // variables.
+ // Immutable. List of environment variables to set in the container. After the
+ // container starts running, code running in the container can read these
+ // environment variables.
//
- // Additionally, the [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] and
- // [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] fields can reference these variables. Later
- // entries in this list can also reference earlier entries. For example, the
- // following example sets the variable `VAR_2` to have the value `foo bar`:
+ // Additionally, the
+ // [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] and
+ // [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] fields can
+ // reference these variables. Later entries in this list can also reference
+ // earlier entries. For example, the following example sets the variable
+ // `VAR_2` to have the value `foo bar`:
//
// ```json
// [
@@ -535,11 +611,11 @@ message ModelContainerSpec {
// API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
repeated Port ports = 5 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. HTTP path on the container to send prediction requests to. Vertex AI
- // forwards requests sent using
- // [projects.locations.endpoints.predict][google.cloud.aiplatform.v1.PredictionService.Predict] to this
- // path on the container's IP address and port. Vertex AI then returns the
- // container's response in the API response.
+ // Immutable. HTTP path on the container to send prediction requests to.
+ // Vertex AI forwards requests sent using
+ // [projects.locations.endpoints.predict][google.cloud.aiplatform.v1.PredictionService.Predict]
+ // to this path on the container's IP address and port. Vertex AI then returns
+ // the container's response in the API response.
//
// For example, if you set this field to `/foo`, then when Vertex AI
// receives a prediction request, it forwards the request body in a POST
@@ -548,7 +624,8 @@ message ModelContainerSpec {
// [ports][google.cloud.aiplatform.v1.ModelContainerSpec.ports] field.
//
// If you don't specify this field, it defaults to the following value when
- // you [deploy this Model to an Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]:
+ // you [deploy this Model to an
+ // Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]:
// /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict
// The placeholders in this value are replaced as follows:
//
@@ -558,7 +635,9 @@ message ModelContainerSpec {
// as the [`AIP_ENDPOINT_ID` environment
// variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
//
- // * DEPLOYED_MODEL: [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the `DeployedModel`.
+ // * DEPLOYED_MODEL:
+ // [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the
+ // `DeployedModel`.
// (Vertex AI makes this value available to your container code
// as the [`AIP_DEPLOYED_MODEL_ID` environment
// variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
@@ -576,7 +655,8 @@ message ModelContainerSpec {
// [ports][google.cloud.aiplatform.v1.ModelContainerSpec.ports] field.
//
// If you don't specify this field, it defaults to the following value when
- // you [deploy this Model to an Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]:
+ // you [deploy this Model to an
+ // Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]:
// /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict
// The placeholders in this value are replaced as follows:
//
@@ -586,7 +666,9 @@ message ModelContainerSpec {
// as the [`AIP_ENDPOINT_ID` environment
// variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
//
- // * DEPLOYED_MODEL: [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the `DeployedModel`.
+ // * DEPLOYED_MODEL:
+ // [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the
+ // `DeployedModel`.
// (Vertex AI makes this value available to your container code as the
// [`AIP_DEPLOYED_MODEL_ID` environment
// variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto
index 25983312e..3f03831c0 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto
@@ -29,7 +29,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelDeploymentMonitoringJobProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -118,20 +118,27 @@ message ModelDeploymentMonitoringJob {
JobState state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Schedule state when the monitoring job is in Running state.
- MonitoringScheduleState schedule_state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ MonitoringScheduleState schedule_state = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Latest triggered monitoring pipeline metadata.
- LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
+ LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. The config for monitoring objectives. This is a per DeployedModel config.
- // Each DeployedModel needs to be configured separately.
- repeated ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(google.api.field_behavior) = REQUIRED];
+ // Required. The config for monitoring objectives. This is a per DeployedModel
+ // config. Each DeployedModel needs to be configured separately.
+ repeated ModelDeploymentMonitoringObjectiveConfig
+ model_deployment_monitoring_objective_configs = 6
+ [(google.api.field_behavior) = REQUIRED];
// Required. Schedule config for running the monitoring job.
- ModelDeploymentMonitoringScheduleConfig model_deployment_monitoring_schedule_config = 7 [(google.api.field_behavior) = REQUIRED];
+ ModelDeploymentMonitoringScheduleConfig
+ model_deployment_monitoring_schedule_config = 7
+ [(google.api.field_behavior) = REQUIRED];
// Required. Sample Strategy for logging.
- SamplingStrategy logging_sampling_strategy = 8 [(google.api.field_behavior) = REQUIRED];
+ SamplingStrategy logging_sampling_strategy = 8
+ [(google.api.field_behavior) = REQUIRED];
// Alert config for model monitoring.
ModelMonitoringAlertConfig model_monitoring_alert_config = 15;
@@ -142,10 +149,12 @@ message ModelDeploymentMonitoringJob {
// requests.
string predict_instance_schema_uri = 9;
- // Sample Predict instance, same format as [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
+ // Sample Predict instance, same format as
+ // [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
// this can be set as a replacement of
- // [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri]. If not set,
- // we will generate predict schema from collected predict requests.
+ // [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri].
+ // If not set, we will generate predict schema from collected predict
+ // requests.
google.protobuf.Value sample_predict_instance = 19;
// YAML schema file uri describing the format of a single instance that you
@@ -161,12 +170,13 @@ message ModelDeploymentMonitoringJob {
// fields in predict instance formatted as string.
string analysis_instance_schema_uri = 16;
- // Output only. The created bigquery tables for the job under customer project. Customer
- // could do their own query & analysis. There could be 4 log tables in
- // maximum:
+ // Output only. The created bigquery tables for the job under customer
+ // project. Customer could do their own query & analysis. There could be 4 log
+ // tables in maximum:
// 1. Training data logging predict request/response
// 2. Serving data logging predict request/response
- repeated ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The TTL of BigQuery tables in user projects which stores logs.
// A day is the basic unit of the TTL and we take the ceil of TTL/86400(a
@@ -184,14 +194,18 @@ message ModelDeploymentMonitoringJob {
map labels = 11;
// Output only. Timestamp when this ModelDeploymentMonitoringJob was created.
- google.protobuf.Timestamp create_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.
- google.protobuf.Timestamp update_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Timestamp when this ModelDeploymentMonitoringJob was updated
+ // most recently.
+ google.protobuf.Timestamp update_time = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Timestamp when this monitoring pipeline will be scheduled to run for the
- // next round.
- google.protobuf.Timestamp next_schedule_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Timestamp when this monitoring pipeline will be scheduled to
+ // run for the next round.
+ google.protobuf.Timestamp next_schedule_time = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Stats anomalies base folder path.
GcsDestination stats_anomalies_base_directory = 20;
@@ -263,17 +277,19 @@ message ModelDeploymentMonitoringObjectiveConfig {
// The config for scheduling monitoring job.
message ModelDeploymentMonitoringScheduleConfig {
- // Required. The model monitoring job scheduling interval. It will be rounded up to next
- // full hour. This defines how often the monitoring jobs are triggered.
- google.protobuf.Duration monitor_interval = 1 [(google.api.field_behavior) = REQUIRED];
+ // Required. The model monitoring job scheduling interval. It will be rounded
+ // up to next full hour. This defines how often the monitoring jobs are
+ // triggered.
+ google.protobuf.Duration monitor_interval = 1
+ [(google.api.field_behavior) = REQUIRED];
// The time window of the prediction data being included in each prediction
// dataset. This window specifies how long the data should be collected from
// historical model results for each run. If not set,
- // [ModelDeploymentMonitoringScheduleConfig.monitor_interval][google.cloud.aiplatform.v1.ModelDeploymentMonitoringScheduleConfig.monitor_interval] will be used.
- // e.g. If currently the cutoff time is 2022-01-08 14:30:00 and the
- // monitor_window is set to be 3600, then data from 2022-01-08 13:30:00
- // to 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the
+ // [ModelDeploymentMonitoringScheduleConfig.monitor_interval][google.cloud.aiplatform.v1.ModelDeploymentMonitoringScheduleConfig.monitor_interval]
+ // will be used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and
+ // the monitor_window is set to be 3600, then data from 2022-01-08 13:30:00 to
+ // 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the
// monitoring statistics.
google.protobuf.Duration monitor_window = 2;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/model_evaluation.proto b/third_party/googleapis/google/cloud/aiplatform/v1/model_evaluation.proto
index 5fc333e66..6b9499d1a 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/model_evaluation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/model_evaluation.proto
@@ -23,7 +23,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelEvaluationProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -58,8 +58,8 @@ message ModelEvaluation {
string display_name = 10;
// Points to a YAML file stored on Google Cloud Storage describing the
- // [metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this ModelEvaluation. The schema is
- // defined as an OpenAPI 3.0.2 [Schema
+ // [metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this
+ // ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
string metrics_schema_uri = 2;
@@ -68,18 +68,19 @@ message ModelEvaluation {
google.protobuf.Value metrics = 3;
// Output only. Timestamp when this ModelEvaluation was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// All possible [dimensions][ModelEvaluationSlice.slice.dimension] of
// ModelEvaluationSlices. The dimensions can be used as the filter of the
- // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices] request, in the form of
- // `slice.dimension = `.
+ // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
+ // request, in the form of `slice.dimension = `.
repeated string slice_dimensions = 5;
// Points to a YAML file stored on Google Cloud Storage describing
// [EvaluatedDataItemView.data_item_payload][] and
- // [EvaluatedAnnotation.data_item_payload][]. The schema is defined as an
- // OpenAPI 3.0.2 [Schema
+ // [EvaluatedAnnotation.data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
+ // The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
//
// This field is not populated if there are neither EvaluatedDataItemViews nor
@@ -89,9 +90,10 @@ message ModelEvaluation {
// Points to a YAML file stored on Google Cloud Storage describing
// [EvaluatedDataItemView.predictions][],
// [EvaluatedDataItemView.ground_truths][],
- // [EvaluatedAnnotation.predictions][], and
- // [EvaluatedAnnotation.ground_truths][]. The schema is defined as an
- // OpenAPI 3.0.2 [Schema
+ // [EvaluatedAnnotation.predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions],
+ // and
+ // [EvaluatedAnnotation.ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
+ // The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
//
// This field is not populated if there are neither EvaluatedDataItemViews nor
@@ -104,8 +106,9 @@ message ModelEvaluation {
//
ModelExplanation model_explanation = 8;
- // Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used for explaining
- // the predicted values on the evaluated data.
+ // Describes the values of
+ // [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used
+ // for explaining the predicted values on the evaluated data.
repeated ModelEvaluationExplanationSpec explanation_specs = 9;
// The metadata of the ModelEvaluation.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/model_evaluation_slice.proto b/third_party/googleapis/google/cloud/aiplatform/v1/model_evaluation_slice.proto
index f28b01354..d870eb7b8 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/model_evaluation_slice.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/model_evaluation_slice.proto
@@ -18,11 +18,13 @@ package google.cloud.aiplatform.v1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
+import "google/cloud/aiplatform/v1/explanation.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelEvaluationSliceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -39,15 +41,125 @@ message ModelEvaluationSlice {
// Definition of a slice.
message Slice {
+ // Specification for how the data should be sliced.
+ message SliceSpec {
+ // Specification message containing the config for this SliceSpec.
+ // When `kind` is selected as `value` and/or `range`, only a single slice
+ // will be computed.
+ // When `all_values` is present, a separate slice will be computed for
+ // each possible label/value for the corresponding key in `config`.
+ // Examples, with feature zip_code with values 12345, 23334, 88888 and
+ // feature country with values "US", "Canada", "Mexico" in the dataset:
+ //
+ // Example 1:
+ //
+ // {
+ // "zip_code": { "value": { "float_value": 12345.0 } }
+ // }
+ //
+ // A single slice for any data with zip_code 12345 in the dataset.
+ //
+ // Example 2:
+ //
+ // {
+ // "zip_code": { "range": { "low": 12345, "high": 20000 } }
+ // }
+ //
+ // A single slice containing data where the zip_codes between 12345 and
+ // 20000 For this example, data with the zip_code of 12345 will be in this
+ // slice.
+ //
+ // Example 3:
+ //
+ // {
+ // "zip_code": { "range": { "low": 10000, "high": 20000 } },
+ // "country": { "value": { "string_value": "US" } }
+ // }
+ //
+ // A single slice containing data where the zip_codes between 10000 and
+ // 20000 has the country "US". For this example, data with the zip_code of
+ // 12345 and country "US" will be in this slice.
+ //
+ // Example 4:
+ //
+ // { "country": {"all_values": { "value": true } } }
+ //
+ // Three slices are computed, one for each unique country in the dataset.
+ //
+ // Example 5:
+ //
+ // {
+ // "country": { "all_values": { "value": true } },
+ // "zip_code": { "value": { "float_value": 12345.0 } }
+ // }
+ //
+ // Three slices are computed, one for each unique country in the dataset
+ // where the zip_code is also 12345. For this example, data with zip_code
+ // 12345 and country "US" will be in one slice, zip_code 12345 and country
+ // "Canada" in another slice, and zip_code 12345 and country "Mexico" in
+ // another slice, totaling 3 slices.
+ message SliceConfig {
+ oneof kind {
+ // A unique specific value for a given feature.
+ // Example: `{ "value": { "string_value": "12345" } }`
+ Value value = 1;
+
+ // A range of values for a numerical feature.
+ // Example: `{"range":{"low":10000.0,"high":50000.0}}`
+ // will capture 12345 and 23334 in the slice.
+ Range range = 2;
+
+ // If all_values is set to true, then all possible labels of the keyed
+ // feature will have another slice computed.
+ // Example: `{"all_values":{"value":true}}`
+ google.protobuf.BoolValue all_values = 3;
+ }
+ }
+
+ // A range of values for slice(s).
+ // `low` is inclusive, `high` is exclusive.
+ message Range {
+ // Inclusive low value for the range.
+ float low = 1;
+
+ // Exclusive high value for the range.
+ float high = 2;
+ }
+
+ // Single value that supports strings and floats.
+ message Value {
+ oneof kind {
+ // String type.
+ string string_value = 1;
+
+ // Float type.
+ float float_value = 2;
+ }
+ }
+
+ // Mapping configuration for this SliceSpec.
+ // The key is the name of the feature.
+ // By default, the key will be prefixed by "instance" as a dictionary
+ // prefix for Vertex Batch Predictions output format.
+ map configs = 1;
+ }
+
// Output only. The dimension of the slice.
// Well-known dimensions are:
// * `annotationSpec`: This slice is on the test data that has either
- // ground truth or prediction with [AnnotationSpec.display_name][google.cloud.aiplatform.v1.AnnotationSpec.display_name]
- // equals to [value][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.value].
+ // ground truth or prediction with
+ // [AnnotationSpec.display_name][google.cloud.aiplatform.v1.AnnotationSpec.display_name]
+ // equals to
+ // [value][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.value].
+ // * `slice`: This slice is a user customized slice defined by its
+ // SliceSpec.
string dimension = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The value of the dimension in this slice.
string value = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Specification for how the data was sliced.
+ SliceSpec slice_spec = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. The resource name of the ModelEvaluationSlice.
@@ -56,16 +168,26 @@ message ModelEvaluationSlice {
// Output only. The slice of the test data that is used to evaluate the Model.
Slice slice = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Points to a YAML file stored on Google Cloud Storage describing the
- // [metrics][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics] of this ModelEvaluationSlice. The
- // schema is defined as an OpenAPI 3.0.2 [Schema
+ // Output only. Points to a YAML file stored on Google Cloud Storage
+ // describing the
+ // [metrics][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics] of this
+ // ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
string metrics_schema_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored
- // in [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics_schema_uri]
+ // Output only. Sliced evaluation metrics of the Model. The schema of the
+ // metrics is stored in
+ // [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics_schema_uri]
google.protobuf.Value metrics = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this ModelEvaluationSlice was created.
- google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Aggregated explanation metrics for the Model's prediction
+ // output over the data this ModelEvaluation uses. This field is populated
+ // only if the Model is evaluated with explanations, and only for tabular
+ // Models.
+ ModelExplanation model_explanation = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/model_monitoring.proto b/third_party/googleapis/google/cloud/aiplatform/v1/model_monitoring.proto
index 039161dde..73c5e0b2b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/model_monitoring.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/model_monitoring.proto
@@ -20,7 +20,7 @@ import "google/api/resource.proto";
import "google/cloud/aiplatform/v1/io.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelMonitoringProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -35,8 +35,8 @@ message ModelMonitoringObjectiveConfig {
oneof data_source {
// The resource name of the Dataset used to train this Model.
string dataset = 3 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Dataset"
- }];
+ type: "aiplatform.googleapis.com/Dataset"
+ }];
// The Google Cloud Storage uri of the unmanaged Dataset used to train
// this Model.
@@ -111,8 +111,10 @@ message ModelMonitoringObjectiveConfig {
// The config for integrating with Vertex Explainable AI. Only applicable if
// the Model has explanation_spec populated.
message ExplanationConfig {
- // Output from [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] for Model Monitoring baseline dataset,
- // which can be used to generate baseline attribution scores.
+ // Output from
+ // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] for
+ // Model Monitoring baseline dataset, which can be used to generate baseline
+ // attribution scores.
message ExplanationBaseline {
// The storage format of the predictions generated BatchPrediction job.
enum PredictionFormat {
@@ -154,7 +156,8 @@ message ModelMonitoringObjectiveConfig {
TrainingDataset training_dataset = 1;
// The config for skew between training data and prediction data.
- TrainingPredictionSkewDetectionConfig training_prediction_skew_detection_config = 2;
+ TrainingPredictionSkewDetectionConfig
+ training_prediction_skew_detection_config = 2;
// The config for drift of prediction data.
PredictionDriftDetectionConfig prediction_drift_detection_config = 3;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/model_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/model_service.proto
index b20d32d31..dc1fe7bdf 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/model_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/model_service.proto
@@ -20,16 +20,19 @@ import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
+import "google/cloud/aiplatform/v1/encryption_spec.proto";
+import "google/cloud/aiplatform/v1/evaluated_annotation.proto";
import "google/cloud/aiplatform/v1/io.proto";
import "google/cloud/aiplatform/v1/model.proto";
import "google/cloud/aiplatform/v1/model_evaluation.proto";
import "google/cloud/aiplatform/v1/model_evaluation_slice.proto";
import "google/cloud/aiplatform/v1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -39,7 +42,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// A service for managing Vertex AI's machine learning Models.
service ModelService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Uploads a Model artifact into Vertex AI.
rpc UploadModel(UploadModelRequest) returns (google.longrunning.Operation) {
@@ -71,7 +75,8 @@ service ModelService {
}
// Lists versions of the specified model.
- rpc ListModelVersions(ListModelVersionsRequest) returns (ListModelVersionsResponse) {
+ rpc ListModelVersions(ListModelVersionsRequest)
+ returns (ListModelVersionsResponse) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/models/*}:listVersions"
};
@@ -89,9 +94,12 @@ service ModelService {
// Deletes a Model.
//
- // A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a
- // [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its
- // [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.
+ // A model cannot be deleted if any
+ // [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a
+ // [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the
+ // model in its
+ // [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models]
+ // field.
rpc DeleteModel(DeleteModelRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/models/*}"
@@ -105,10 +113,13 @@ service ModelService {
// Deletes a Model version.
//
- // Model version can only be deleted if there are no [DeployedModels][]
- // created from it. Deleting the only version in the Model is not allowed. Use
- // [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.
- rpc DeleteModelVersion(DeleteModelVersionRequest) returns (google.longrunning.Operation) {
+ // Model version can only be deleted if there are no
+ // [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it.
+ // Deleting the only version in the Model is not allowed. Use
+ // [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for
+ // deleting the Model instead.
+ rpc DeleteModelVersion(DeleteModelVersionRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/models/*}:deleteVersion"
};
@@ -130,7 +141,8 @@ service ModelService {
// Exports a trained, exportable Model to a location specified by the
// user. A Model is considered to be exportable if it has at least one
- // [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].
+ // [supported export
+ // format][google.cloud.aiplatform.v1.Model.supported_export_formats].
rpc ExportModel(ExportModelRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/models/*}:export"
@@ -143,8 +155,27 @@ service ModelService {
};
}
+ // Copies an already existing Vertex AI Model into the specified Location.
+ // The source Model must exist in the same Project.
+ // When copying custom Models, the users themselves are responsible for
+ // [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be
+ // region-agnostic, as well as making sure that any resources (e.g. files) it
+ // depends on remain accessible.
+ rpc CopyModel(CopyModelRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*}/models:copy"
+ body: "*"
+ };
+ option (google.api.method_signature) = "parent,source_model";
+ option (google.longrunning.operation_info) = {
+ response_type: "CopyModelResponse"
+ metadata_type: "CopyModelOperationMetadata"
+ };
+ }
+
// Imports an externally generated ModelEvaluation.
- rpc ImportModelEvaluation(ImportModelEvaluationRequest) returns (ModelEvaluation) {
+ rpc ImportModelEvaluation(ImportModelEvaluationRequest)
+ returns (ModelEvaluation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/models/*}/evaluations:import"
body: "*"
@@ -153,7 +184,8 @@ service ModelService {
}
// Imports a list of externally generated ModelEvaluationSlice.
- rpc BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest) returns (BatchImportModelEvaluationSlicesResponse) {
+ rpc BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest)
+ returns (BatchImportModelEvaluationSlicesResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/models/*/evaluations/*}/slices:batchImport"
body: "*"
@@ -161,6 +193,16 @@ service ModelService {
option (google.api.method_signature) = "parent,model_evaluation_slices";
}
+ // Imports a list of externally generated EvaluatedAnnotations.
+ rpc BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest)
+ returns (BatchImportEvaluatedAnnotationsResponse) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*/models/*/evaluations/*/slices/*}:batchImport"
+ body: "*"
+ };
+ option (google.api.method_signature) = "parent,evaluated_annotations";
+ }
+
// Gets a ModelEvaluation.
rpc GetModelEvaluation(GetModelEvaluationRequest) returns (ModelEvaluation) {
option (google.api.http) = {
@@ -170,7 +212,8 @@ service ModelService {
}
// Lists ModelEvaluations in a Model.
- rpc ListModelEvaluations(ListModelEvaluationsRequest) returns (ListModelEvaluationsResponse) {
+ rpc ListModelEvaluations(ListModelEvaluationsRequest)
+ returns (ListModelEvaluationsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/models/*}/evaluations"
};
@@ -178,7 +221,8 @@ service ModelService {
}
// Gets a ModelEvaluationSlice.
- rpc GetModelEvaluationSlice(GetModelEvaluationSliceRequest) returns (ModelEvaluationSlice) {
+ rpc GetModelEvaluationSlice(GetModelEvaluationSliceRequest)
+ returns (ModelEvaluationSlice) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/models/*/evaluations/*/slices/*}"
};
@@ -186,7 +230,8 @@ service ModelService {
}
// Lists ModelEvaluationSlices in a ModelEvaluation.
- rpc ListModelEvaluationSlices(ListModelEvaluationSlicesRequest) returns (ListModelEvaluationSlicesResponse) {
+ rpc ListModelEvaluationSlices(ListModelEvaluationSlicesRequest)
+ returns (ListModelEvaluationSlicesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/models/*/evaluations/*}/slices"
};
@@ -194,7 +239,8 @@ service ModelService {
}
}
-// Request message for [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel].
+// Request message for
+// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel].
message UploadModelRequest {
// Required. The resource name of the Location into which to upload the Model.
// Format: `projects/{project}/locations/{location}`
@@ -205,8 +251,8 @@ message UploadModelRequest {
}
];
- // Optional. The resource name of the model into which to upload the version. Only
- // specify this field when uploading a new version.
+ // Optional. The resource name of the model into which to upload the version.
+ // Only specify this field when uploading a new version.
string parent_model = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. The ID to use for the uploaded Model, which will become the final
@@ -229,25 +275,30 @@ message UploadModelRequest {
string service_account = 6 [(google.api.field_behavior) = OPTIONAL];
}
-// Details of [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel] operation.
+// Details of
+// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]
+// operation.
message UploadModelOperationMetadata {
// The common part of the operation metadata.
GenericOperationMetadata generic_metadata = 1;
}
-// Response message of [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel] operation.
+// Response message of
+// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]
+// operation.
message UploadModelResponse {
// The name of the uploaded Model resource.
// Format: `projects/{project}/locations/{location}/models/{model}`
string model = 1 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Model"
- }];
+ type: "aiplatform.googleapis.com/Model"
+ }];
// Output only. The version ID of the model that is uploaded.
string model_version_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Request message for [ModelService.GetModel][google.cloud.aiplatform.v1.ModelService.GetModel].
+// Request message for
+// [ModelService.GetModel][google.cloud.aiplatform.v1.ModelService.GetModel].
message GetModelRequest {
// Required. The name of the Model resource.
// Format: `projects/{project}/locations/{location}/models/{model}`
@@ -269,7 +320,8 @@ message GetModelRequest {
];
}
-// Request message for [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels].
+// Request message for
+// [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels].
message ListModelsRequest {
// Required. The resource name of the Location to list the Models from.
// Format: `projects/{project}/locations/{location}`
@@ -284,7 +336,8 @@ message ListModelsRequest {
// both snake_case and camelCase are supported.
//
// * `model` supports = and !=. `model` represents the Model ID,
- // i.e. the last segment of the Model's [resource name][google.cloud.aiplatform.v1.Model.name].
+ // i.e. the last segment of the Model's [resource
+ // name][google.cloud.aiplatform.v1.Model.name].
// * `display_name` supports = and !=
// * `labels` supports general map functions that is:
// * `labels.key=value` - key:value equality
@@ -303,8 +356,10 @@ message ListModelsRequest {
// The standard list page token.
// Typically obtained via
- // [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token] of the previous
- // [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels] call.
+ // [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token]
+ // of the previous
+ // [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
@@ -322,17 +377,21 @@ message ListModelsRequest {
string order_by = 6;
}
-// Response message for [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]
+// Response message for
+// [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]
message ListModelsResponse {
// List of Models in the requested page.
repeated Model models = 1;
// A token to retrieve next page of results.
- // Pass to [ListModelsRequest.page_token][google.cloud.aiplatform.v1.ListModelsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListModelsRequest.page_token][google.cloud.aiplatform.v1.ListModelsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions].
+// Request message for
+// [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions].
message ListModelVersionsRequest {
// Required. The name of the model to list versions for.
string name = 1 [
@@ -347,8 +406,8 @@ message ListModelVersionsRequest {
// The standard list page token.
// Typically obtained via
- // [ListModelVersionsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token] of the previous
- // [ModelService.ListModelversions][] call.
+ // [ListModelVersionsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token]
+ // of the previous [ModelService.ListModelversions][] call.
string page_token = 3;
// An expression for filtering the results of the request. For field names
@@ -366,9 +425,20 @@ message ListModelVersionsRequest {
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
+
+ // A comma-separated list of fields to order by, sorted in ascending order.
+ // Use "desc" after a field name for descending.
+ // Supported fields:
+ //
+ // * `create_time`
+ // * `update_time`
+ //
+ // Example: `update_time asc, create_time desc`.
+ string order_by = 6;
}
-// Response message for [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions]
+// Response message for
+// [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions]
message ListModelVersionsResponse {
// List of Model versions in the requested page.
// In the returned Model name field, version ID instead of regvision tag will
@@ -376,11 +446,14 @@ message ListModelVersionsResponse {
repeated Model models = 1;
// A token to retrieve the next page of results.
- // Pass to [ListModelVersionsRequest.page_token][google.cloud.aiplatform.v1.ListModelVersionsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListModelVersionsRequest.page_token][google.cloud.aiplatform.v1.ListModelVersionsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [ModelService.UpdateModel][google.cloud.aiplatform.v1.ModelService.UpdateModel].
+// Request message for
+// [ModelService.UpdateModel][google.cloud.aiplatform.v1.ModelService.UpdateModel].
message UpdateModelRequest {
// Required. The Model which replaces the resource on the server.
// When Model Versioning is enabled, the model.name will be used to determine
@@ -403,11 +476,14 @@ message UpdateModelRequest {
Model model = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource.
- // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask].
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // For the `FieldMask` definition, see
+ // [google.protobuf.FieldMask][google.protobuf.FieldMask].
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [ModelService.DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel].
+// Request message for
+// [ModelService.DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel].
message DeleteModelRequest {
// Required. The name of the Model resource to be deleted.
// Format: `projects/{project}/locations/{location}/models/{model}`
@@ -419,10 +495,11 @@ message DeleteModelRequest {
];
}
-// Request message for [ModelService.DeleteModelVersion][google.cloud.aiplatform.v1.ModelService.DeleteModelVersion].
+// Request message for
+// [ModelService.DeleteModelVersion][google.cloud.aiplatform.v1.ModelService.DeleteModelVersion].
message DeleteModelVersionRequest {
- // Required. The name of the model version to be deleted, with a version ID explicitly
- // included.
+ // Required. The name of the model version to be deleted, with a version ID
+ // explicitly included.
//
// Example: `projects/{project}/locations/{location}/models/{model}@1234`
string name = 1 [
@@ -433,7 +510,8 @@ message DeleteModelVersionRequest {
];
}
-// Request message for [ModelService.MergeVersionAliases][google.cloud.aiplatform.v1.ModelService.MergeVersionAliases].
+// Request message for
+// [ModelService.MergeVersionAliases][google.cloud.aiplatform.v1.ModelService.MergeVersionAliases].
message MergeVersionAliasesRequest {
// Required. The name of the model version to merge aliases, with a version ID
// explicitly included.
@@ -461,13 +539,15 @@ message MergeVersionAliasesRequest {
repeated string version_aliases = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel].
+// Request message for
+// [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel].
message ExportModelRequest {
// Output configuration for the Model export.
message OutputConfig {
// The ID of the format in which the Model must be exported. Each Model
- // lists the [export formats it supports][google.cloud.aiplatform.v1.Model.supported_export_formats].
- // If no value is provided here, then the first from the list of the Model's
+ // lists the [export formats it
+ // supports][google.cloud.aiplatform.v1.Model.supported_export_formats]. If
+ // no value is provided here, then the first from the list of the Model's
// supported formats is used by default.
string export_format_id = 1;
@@ -502,34 +582,107 @@ message ExportModelRequest {
OutputConfig output_config = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Details of [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel] operation.
+// Details of
+// [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel]
+// operation.
message ExportModelOperationMetadata {
// Further describes the output of the ExportModel. Supplements
// [ExportModelRequest.OutputConfig][google.cloud.aiplatform.v1.ExportModelRequest.OutputConfig].
message OutputInfo {
- // Output only. If the Model artifact is being exported to Google Cloud Storage this is
- // the full path of the directory created, into which the Model files are
- // being written to.
+ // Output only. If the Model artifact is being exported to Google Cloud
+ // Storage this is the full path of the directory created, into which the
+ // Model files are being written to.
string artifact_output_uri = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. If the Model image is being exported to Google Container Registry or
- // Artifact Registry this is the full path of the image created.
+ // Output only. If the Model image is being exported to Google Container
+ // Registry or Artifact Registry this is the full path of the image created.
string image_output_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The common part of the operation metadata.
GenericOperationMetadata generic_metadata = 1;
- // Output only. Information further describing the output of this Model export.
+ // Output only. Information further describing the output of this Model
+ // export.
OutputInfo output_info = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Response message of [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel] operation.
-message ExportModelResponse {
+// Response message of
+// [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel]
+// operation.
+message ExportModelResponse {}
+
+// Request message for
+// [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel].
+message CopyModelRequest {
+ // If both fields are unset, a new Model will be created with a generated ID.
+ oneof destination_model {
+ // Optional. Copy source_model into a new Model with this ID. The ID will
+ // become the final component of the model resource name.
+ //
+ // This value may be up to 63 characters, and valid characters are
+ // `[a-z0-9_-]`. The first character cannot be a number or hyphen.
+ string model_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Specify this field to copy source_model into this existing
+ // Model as a new version. Format:
+ // `projects/{project}/locations/{location}/models/{model}`
+ string parent_model = 5 [
+ (google.api.field_behavior) = OPTIONAL,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/Model"
+ }
+ ];
+ }
+
+ // Required. The resource name of the Location into which to copy the Model.
+ // Format: `projects/{project}/locations/{location}`
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "locations.googleapis.com/Location"
+ }
+ ];
+
+ // Required. The resource name of the Model to copy. That Model must be in the
+ // same Project. Format:
+ // `projects/{project}/locations/{location}/models/{model}`
+ string source_model = 2 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/Model"
+ }
+ ];
+
+ // Customer-managed encryption key options. If this is set,
+ // then the Model copy will be encrypted with the provided encryption key.
+ EncryptionSpec encryption_spec = 3;
+}
+
+// Details of
+// [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel]
+// operation.
+message CopyModelOperationMetadata {
+ // The common part of the operation metadata.
+ GenericOperationMetadata generic_metadata = 1;
+}
+
+// Response message of
+// [ModelService.CopyModel][google.cloud.aiplatform.v1.ModelService.CopyModel]
+// operation.
+message CopyModelResponse {
+ // The name of the copied Model resource.
+ // Format: `projects/{project}/locations/{location}/models/{model}`
+ string model = 1 [(google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/Model"
+ }];
+ // Output only. The version ID of the model that is copied.
+ string model_version_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Request message for [ModelService.ImportModelEvaluation][google.cloud.aiplatform.v1.ModelService.ImportModelEvaluation]
+// Request message for
+// [ModelService.ImportModelEvaluation][google.cloud.aiplatform.v1.ModelService.ImportModelEvaluation]
message ImportModelEvaluationRequest {
// Required. The name of the parent model resource.
// Format: `projects/{project}/locations/{location}/models/{model}`
@@ -544,7 +697,8 @@ message ImportModelEvaluationRequest {
ModelEvaluation model_evaluation = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices]
+// Request message for
+// [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices]
message BatchImportModelEvaluationSlicesRequest {
// Required. The name of the parent ModelEvaluation resource.
// Format:
@@ -557,16 +711,47 @@ message BatchImportModelEvaluationSlicesRequest {
];
// Required. Model evaluation slice resource to be imported.
- repeated ModelEvaluationSlice model_evaluation_slices = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated ModelEvaluationSlice model_evaluation_slices = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices]
+// Response message for
+// [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices]
message BatchImportModelEvaluationSlicesResponse {
- // Output only. List of imported [ModelEvaluationSlice.name][google.cloud.aiplatform.v1.ModelEvaluationSlice.name].
- repeated string imported_model_evaluation_slices = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. List of imported
+ // [ModelEvaluationSlice.name][google.cloud.aiplatform.v1.ModelEvaluationSlice.name].
+ repeated string imported_model_evaluation_slices = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Request message for
+// [ModelService.BatchImportEvaluatedAnnotations][google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotations]
+message BatchImportEvaluatedAnnotationsRequest {
+ // Required. The name of the parent ModelEvaluationSlice resource.
+ // Format:
+ // `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/ModelEvaluationSlice"
+ }
+ ];
+
+ // Required. Evaluated annotations resource to be imported.
+ repeated EvaluatedAnnotation evaluated_annotations = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response message for
+// [ModelService.BatchImportEvaluatedAnnotations][google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotations]
+message BatchImportEvaluatedAnnotationsResponse {
+ // Output only. Number of EvaluatedAnnotations imported.
+ int32 imported_evaluated_annotations_count = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Request message for [ModelService.GetModelEvaluation][google.cloud.aiplatform.v1.ModelService.GetModelEvaluation].
+// Request message for
+// [ModelService.GetModelEvaluation][google.cloud.aiplatform.v1.ModelService.GetModelEvaluation].
message GetModelEvaluationRequest {
// Required. The name of the ModelEvaluation resource.
// Format:
@@ -579,7 +764,8 @@ message GetModelEvaluationRequest {
];
}
-// Request message for [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations].
+// Request message for
+// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations].
message ListModelEvaluationsRequest {
// Required. The resource name of the Model to list the ModelEvaluations from.
// Format: `projects/{project}/locations/{location}/models/{model}`
@@ -598,25 +784,31 @@ message ListModelEvaluationsRequest {
// The standard list page token.
// Typically obtained via
- // [ListModelEvaluationsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token] of the previous
- // [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations] call.
+ // [ListModelEvaluationsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token]
+ // of the previous
+ // [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations].
+// Response message for
+// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations].
message ListModelEvaluationsResponse {
// List of ModelEvaluations in the requested page.
repeated ModelEvaluation model_evaluations = 1;
// A token to retrieve next page of results.
- // Pass to [ListModelEvaluationsRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListModelEvaluationsRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [ModelService.GetModelEvaluationSlice][google.cloud.aiplatform.v1.ModelService.GetModelEvaluationSlice].
+// Request message for
+// [ModelService.GetModelEvaluationSlice][google.cloud.aiplatform.v1.ModelService.GetModelEvaluationSlice].
message GetModelEvaluationSliceRequest {
// Required. The name of the ModelEvaluationSlice resource.
// Format:
@@ -629,10 +821,11 @@ message GetModelEvaluationSliceRequest {
];
}
-// Request message for [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices].
+// Request message for
+// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices].
message ListModelEvaluationSlicesRequest {
- // Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices
- // from. Format:
+ // Required. The resource name of the ModelEvaluation to list the
+ // ModelEvaluationSlices from. Format:
// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -651,21 +844,25 @@ message ListModelEvaluationSlicesRequest {
// The standard list page token.
// Typically obtained via
- // [ListModelEvaluationSlicesResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token] of the previous
- // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices] call.
+ // [ListModelEvaluationSlicesResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token]
+ // of the previous
+ // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices].
+// Response message for
+// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices].
message ListModelEvaluationSlicesResponse {
// List of ModelEvaluations in the requested page.
repeated ModelEvaluationSlice model_evaluation_slices = 1;
// A token to retrieve next page of results.
- // Pass to [ListModelEvaluationSlicesRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesRequest.page_token] to obtain that
- // page.
+ // Pass to
+ // [ListModelEvaluationSlicesRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/nas_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1/nas_job.proto
new file mode 100644
index 000000000..1d670eeca
--- /dev/null
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/nas_job.proto
@@ -0,0 +1,306 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.aiplatform.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/aiplatform/v1/custom_job.proto";
+import "google/cloud/aiplatform/v1/encryption_spec.proto";
+import "google/cloud/aiplatform/v1/job_state.proto";
+import "google/cloud/aiplatform/v1/study.proto";
+import "google/protobuf/timestamp.proto";
+import "google/rpc/status.proto";
+
+option csharp_namespace = "Google.Cloud.AIPlatform.V1";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
+option java_multiple_files = true;
+option java_outer_classname = "NasJobProto";
+option java_package = "com.google.cloud.aiplatform.v1";
+option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
+option ruby_package = "Google::Cloud::AIPlatform::V1";
+
+// Represents a Neural Architecture Search (NAS) job.
+message NasJob {
+ option (google.api.resource) = {
+ type: "aiplatform.googleapis.com/NasJob"
+ pattern: "projects/{project}/locations/{location}/nasJobs/{nas_job}"
+ };
+
+ // Output only. Resource name of the NasJob.
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The display name of the NasJob.
+ // The name can be up to 128 characters long and can consist of any UTF-8
+ // characters.
+ string display_name = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The specification of a NasJob.
+ NasJobSpec nas_job_spec = 4 [(google.api.field_behavior) = REQUIRED];
+
+ // Output only. Output of the NasJob.
+ NasJobOutput nas_job_output = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The detailed state of the job.
+ JobState state = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasJob was created.
+ google.protobuf.Timestamp create_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasJob for the first time entered the
+ // `JOB_STATE_RUNNING` state.
+ google.protobuf.Timestamp start_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasJob entered any of the following states:
+ // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
+ google.protobuf.Timestamp end_time = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasJob was most recently updated.
+ google.protobuf.Timestamp update_time = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Only populated when job's state is JOB_STATE_FAILED or
+ // JOB_STATE_CANCELLED.
+ google.rpc.Status error = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The labels with user-defined metadata to organize NasJobs.
+ //
+ // Label keys and values can be no longer than 64 characters
+ // (Unicode codepoints), can only contain lowercase letters, numeric
+ // characters, underscores and dashes. International characters are allowed.
+ //
+ // See https://goo.gl/xmQnxf for more information and examples of labels.
+ map labels = 12;
+
+ // Customer-managed encryption key options for a NasJob.
+ // If this is set, then all resources created by the NasJob
+ // will be encrypted with the provided encryption key.
+ EncryptionSpec encryption_spec = 13;
+
+ // Optional. Enable a separation of Custom model training
+ // and restricted image training for tenant project.
+ bool enable_restricted_image_training = 14
+ [deprecated = true, (google.api.field_behavior) = OPTIONAL];
+}
+
+// Represents a NasTrial details along with it's parameters. If there is a
+// corresponding train NasTrial, the train NasTrial is also returned.
+message NasTrialDetail {
+ option (google.api.resource) = {
+ type: "aiplatform.googleapis.com/NasTrialDetail"
+ pattern: "projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}"
+ };
+
+ // Output only. Resource name of the NasTrialDetail.
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The parameters for the NasJob NasTrial.
+ string parameters = 2;
+
+ // The requested search NasTrial.
+ NasTrial search_trial = 3;
+
+ // The train NasTrial corresponding to
+ // [search_trial][google.cloud.aiplatform.v1.NasTrialDetail.search_trial].
+ // Only populated if
+ // [search_trial][google.cloud.aiplatform.v1.NasTrialDetail.search_trial] is
+ // used for training.
+ NasTrial train_trial = 4;
+}
+
+// Represents the spec of a NasJob.
+message NasJobSpec {
+ // The spec of multi-trial Neural Architecture Search (NAS).
+ message MultiTrialAlgorithmSpec {
+ // Represents a metric to optimize.
+ message MetricSpec {
+ // The available types of optimization goals.
+ enum GoalType {
+ // Goal Type will default to maximize.
+ GOAL_TYPE_UNSPECIFIED = 0;
+
+ // Maximize the goal metric.
+ MAXIMIZE = 1;
+
+ // Minimize the goal metric.
+ MINIMIZE = 2;
+ }
+
+ // Required. The ID of the metric. Must not contain whitespaces.
+ string metric_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The optimization goal of the metric.
+ GoalType goal = 2 [(google.api.field_behavior) = REQUIRED];
+ }
+
+ // Represent spec for search trials.
+ message SearchTrialSpec {
+ // Required. The spec of a search trial job. The same spec applies to
+ // all search trials.
+ CustomJobSpec search_trial_job_spec = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The maximum number of Neural Architecture Search (NAS) trials
+ // to run.
+ int32 max_trial_count = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The maximum number of trials to run in parallel.
+ int32 max_parallel_trial_count = 3
+ [(google.api.field_behavior) = REQUIRED];
+
+ // The number of failed trials that need to be seen before failing
+ // the NasJob.
+ //
+ // If set to 0, Vertex AI decides how many trials must fail
+ // before the whole job fails.
+ int32 max_failed_trial_count = 4;
+ }
+
+ // Represent spec for train trials.
+ message TrainTrialSpec {
+ // Required. The spec of a train trial job. The same spec applies to
+ // all train trials.
+ CustomJobSpec train_trial_job_spec = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The maximum number of trials to run in parallel.
+ int32 max_parallel_trial_count = 2
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Frequency of search trials to start train stage. Top N
+ // [TrainTrialSpec.max_parallel_trial_count]
+ // search trials will be trained for every M
+ // [TrainTrialSpec.frequency] trials searched.
+ int32 frequency = 3 [(google.api.field_behavior) = REQUIRED];
+ }
+
+ // The available types of multi-trial algorithms.
+ enum MultiTrialAlgorithm {
+ // Defaults to `REINFORCEMENT_LEARNING`.
+ MULTI_TRIAL_ALGORITHM_UNSPECIFIED = 0;
+
+ // The Reinforcement Learning Algorithm for Multi-trial Neural
+ // Architecture Search (NAS).
+ REINFORCEMENT_LEARNING = 1;
+
+ // The Grid Search Algorithm for Multi-trial Neural
+ // Architecture Search (NAS).
+ GRID_SEARCH = 2;
+ }
+
+ // The multi-trial Neural Architecture Search (NAS) algorithm
+ // type. Defaults to `REINFORCEMENT_LEARNING`.
+ MultiTrialAlgorithm multi_trial_algorithm = 1;
+
+ // Metric specs for the NAS job.
+ // Validation for this field is done at `multi_trial_algorithm_spec` field.
+ MetricSpec metric = 2;
+
+ // Required. Spec for search trials.
+ SearchTrialSpec search_trial_spec = 3
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Spec for train trials. Top N [TrainTrialSpec.max_parallel_trial_count]
+ // search trials will be trained for every M
+ // [TrainTrialSpec.frequency] trials searched.
+ TrainTrialSpec train_trial_spec = 4;
+ }
+
+ // The Neural Architecture Search (NAS) algorithm specification.
+ oneof nas_algorithm_spec {
+ // The spec of multi-trial algorithms.
+ MultiTrialAlgorithmSpec multi_trial_algorithm_spec = 2;
+ }
+
+ // The ID of the existing NasJob in the same Project and Location
+ // which will be used to resume search. search_space_spec and
+ // nas_algorithm_spec are obtained from previous NasJob hence should not
+ // provide them again for this NasJob.
+ string resume_nas_job_id = 3;
+
+ // It defines the search space for Neural Architecture Search (NAS).
+ string search_space_spec = 1;
+}
+
+// Represents a uCAIP NasJob output.
+message NasJobOutput {
+ // The output of a multi-trial Neural Architecture Search (NAS) jobs.
+ message MultiTrialJobOutput {
+ // Output only. List of NasTrials that were started as part of search stage.
+ repeated NasTrial search_trials = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. List of NasTrials that were started as part of train stage.
+ repeated NasTrial train_trials = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The output of this Neural Architecture Search (NAS) job.
+ oneof output {
+ // Output only. The output of this multi-trial Neural Architecture Search
+ // (NAS) job.
+ MultiTrialJobOutput multi_trial_job_output = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+}
+
+// Represents a uCAIP NasJob trial.
+message NasTrial {
+ // Describes a NasTrial state.
+ enum State {
+ // The NasTrial state is unspecified.
+ STATE_UNSPECIFIED = 0;
+
+ // Indicates that a specific NasTrial has been requested, but it has not yet
+ // been suggested by the service.
+ REQUESTED = 1;
+
+ // Indicates that the NasTrial has been suggested.
+ ACTIVE = 2;
+
+ // Indicates that the NasTrial should stop according to the service.
+ STOPPING = 3;
+
+ // Indicates that the NasTrial is completed successfully.
+ SUCCEEDED = 4;
+
+ // Indicates that the NasTrial should not be attempted again.
+ // The service will set a NasTrial to INFEASIBLE when it's done but missing
+ // the final_measurement.
+ INFEASIBLE = 5;
+ }
+
+ // Output only. The identifier of the NasTrial assigned by the service.
+ string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The detailed state of the NasTrial.
+ State state = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The final measurement containing the objective value.
+ Measurement final_measurement = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasTrial was started.
+ google.protobuf.Timestamp start_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasTrial's status changed to `SUCCEEDED` or
+ // `INFEASIBLE`.
+ google.protobuf.Timestamp end_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/operation.proto b/third_party/googleapis/google/cloud/aiplatform/v1/operation.proto
index cd27fcc56..05d994ffe 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/operation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/operation.proto
@@ -21,7 +21,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "OperationProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -34,15 +34,18 @@ message GenericOperationMetadata {
// E.g. single files that couldn't be read.
// This field should never exceed 20 entries.
// Status details field will contain standard Google Cloud error details.
- repeated google.rpc.Status partial_failures = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.rpc.Status partial_failures = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the operation was created.
- google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the operation was updated for the last time.
// If the operation has finished (successfully or not), this is the finish
// time.
- google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Details of operations that perform deletes of any entities.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_failure_policy.proto b/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_failure_policy.proto
index 5ff3b78be..35b0401ef 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_failure_policy.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_failure_policy.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "PipelineFailurePolicyProto";
option java_package = "com.google.cloud.aiplatform.v1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_job.proto
index d424f09ed..f0f6d2bb6 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_job.proto
@@ -30,7 +30,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "Pipeline";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -62,16 +62,18 @@ message PipelineJob {
}
}
- // Deprecated. Use [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values] instead. The runtime
- // parameters of the PipelineJob. The parameters will be passed into
- // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec] to replace the placeholders at runtime.
- // This field is used by pipelines built using
- // `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as
- // pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
+ // Deprecated. Use
+ // [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values]
+ // instead. The runtime parameters of the PipelineJob. The parameters will
+ // be passed into
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
+ // to replace the placeholders at runtime. This field is used by pipelines
+ // built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
+ // such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
map parameters = 1 [deprecated = true];
- // Required. A path in a Cloud Storage bucket, which will be treated as the root
- // output directory of the pipeline. It is used by the system to
+ // Required. A path in a Cloud Storage bucket, which will be treated as the
+ // root output directory of the pipeline. It is used by the system to
// generate the paths of output artifacts. The artifact paths are generated
// with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
// specified output directory. The service account specified in this
@@ -80,10 +82,12 @@ message PipelineJob {
string gcs_output_directory = 2 [(google.api.field_behavior) = REQUIRED];
// The runtime parameters of the PipelineJob. The parameters will be
- // passed into [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec] to replace the placeholders
- // at runtime. This field is used by pipelines built using
- // `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built
- // using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
+ // passed into
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
+ // to replace the placeholders at runtime. This field is used by pipelines
+ // built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
+ // pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
+ // DSL.
map parameter_values = 3;
// Represents the failure policy of a pipeline. Currently, the default of a
@@ -108,16 +112,20 @@ message PipelineJob {
string display_name = 2;
// Output only. Pipeline creation time.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Pipeline start time.
- google.protobuf.Timestamp start_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Pipeline end time.
- google.protobuf.Timestamp end_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this PipelineJob was most recently updated.
- google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The spec of the pipeline.
google.protobuf.Struct pipeline_spec = 7;
@@ -172,27 +180,32 @@ message PipelineJob {
// resources being launched, if applied, such as Vertex AI
// Training or Dataflow job. If left unspecified, the workload is not peered
// with any network.
- string network = 18 [(google.api.resource_reference) = {
- type: "compute.googleapis.com/Network"
- }];
+ string network = 18 [
+ (google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
+ ];
- // A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec], if empty, will
- // be downloaded.
+ // A template uri from where the
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec],
+ // if empty, will be downloaded.
string template_uri = 19;
// Output only. Pipeline template metadata. Will fill up fields if
- // [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] is from supported template registry.
- PipelineTemplateMetadata template_metadata = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri]
+ // is from supported template registry.
+ PipelineTemplateMetadata template_metadata = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Pipeline template metadata if [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] is from supported
-// template registry. Currently, the only supported registry is Artifact
-// Registry.
+// Pipeline template metadata if
+// [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri]
+// is from supported template registry. Currently, the only supported registry
+// is Artifact Registry.
message PipelineTemplateMetadata {
// The version_name in artifact registry.
//
- // Will always be presented in output if the [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] is
- // from supported template registry.
+ // Will always be presented in output if the
+ // [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri]
+ // is from supported template registry.
//
// Format is "sha256:abcdef123456...".
string version = 3;
@@ -207,7 +220,8 @@ message PipelineJobDetail {
Context pipeline_run_context = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The runtime details of the tasks under the pipeline.
- repeated PipelineTaskDetail task_details = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated PipelineTaskDetail task_details = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The runtime detail of a task execution.
@@ -215,17 +229,17 @@ message PipelineTaskDetail {
// A single record of the task status.
message PipelineTaskStatus {
// Output only. Update time of this status.
- google.protobuf.Timestamp update_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The state of the task.
State state = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The error that occurred during the state. May be set when the state is
- // any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state.
- // If the state is FAILED, the error here is final and not going to be
- // retried.
- // If the state is a non-final state, the error indicates a system-error
- // being retried.
+ // Output only. The error that occurred during the state. May be set when
+ // the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or
+ // FAILED state. If the state is FAILED, the error here is final and not
+ // going to be retried. If the state is a non-final state, the error
+ // indicates a system-error being retried.
google.rpc.Status error = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -266,15 +280,16 @@ message PipelineTaskDetail {
// Specifies that the task was not triggered because the task's trigger
// policy is not satisfied. The trigger policy is specified in the
- // `condition` field of [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec].
+ // `condition` field of
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec].
NOT_TRIGGERED = 9;
}
// Output only. The system generated ID of the task.
int64 task_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The id of the parent task if the task is within a component scope.
- // Empty if the task is at the root level.
+ // Output only. The id of the parent task if the task is within a component
+ // scope. Empty if the task is at the root level.
int64 parent_task_id = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The user specified name of the task that is defined in
@@ -282,16 +297,20 @@ message PipelineTaskDetail {
string task_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Task create time.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Task start time.
- google.protobuf.Timestamp start_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Task end time.
- google.protobuf.Timestamp end_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The detailed execution info.
- PipelineTaskExecutorDetail executor_detail = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ PipelineTaskExecutorDetail executor_detail = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. State of the task.
State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -303,15 +322,18 @@ message PipelineTaskDetail {
// Only populated when the task's state is FAILED or CANCELLED.
google.rpc.Status error = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A list of task status. This field keeps a record of task status evolving
- // over time.
- repeated PipelineTaskStatus pipeline_task_status = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. A list of task status. This field keeps a record of task
+ // status evolving over time.
+ repeated PipelineTaskStatus pipeline_task_status = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The runtime input artifacts of the task.
- map inputs = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ map inputs = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The runtime output artifacts of the task.
- map outputs = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ map outputs = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The runtime detail of a pipeline executor.
@@ -319,7 +341,9 @@ message PipelineTaskExecutorDetail {
// The detail of a container execution. It contains the job names of the
// lifecycle of a container execution.
message ContainerDetail {
- // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the main container execution.
+ // Output only. The name of the
+ // [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the main container
+ // execution.
string main_job = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -327,10 +351,11 @@ message PipelineTaskExecutorDetail {
}
];
- // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the pre-caching-check container
- // execution. This job will be available if the
- // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec] specifies the `pre_caching_check` hook in
- // the lifecycle events.
+ // Output only. The name of the
+ // [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the
+ // pre-caching-check container execution. This job will be available if the
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
+ // specifies the `pre_caching_check` hook in the lifecycle events.
string pre_caching_check_job = 2 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -338,39 +363,46 @@ message PipelineTaskExecutorDetail {
}
];
- // Output only. The names of the previously failed [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the main container
+ // Output only. The names of the previously failed
+ // [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the main container
// executions. The list includes the all attempts in chronological order.
- repeated string failed_main_jobs = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated string failed_main_jobs = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The names of the previously failed [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the
+ // Output only. The names of the previously failed
+ // [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the
// pre-caching-check container executions. This job will be available if the
- // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec] specifies the `pre_caching_check` hook in
- // the lifecycle events.
- // The list includes the all attempts in chronological order.
- repeated string failed_pre_caching_check_jobs = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
+ // specifies the `pre_caching_check` hook in the lifecycle events. The list
+ // includes the all attempts in chronological order.
+ repeated string failed_pre_caching_check_jobs = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The detailed info for a custom job executor.
message CustomJobDetail {
- option deprecated = true;
-
- // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1.CustomJob].
+ // Output only. The name of the
+ // [CustomJob][google.cloud.aiplatform.v1.CustomJob].
string job = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/CustomJob"
}
];
+
+ // Output only. The names of the previously failed
+ // [CustomJob][google.cloud.aiplatform.v1.CustomJob]. The list includes the
+ // all attempts in chronological order.
+ repeated string failed_jobs = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
oneof details {
// Output only. The detailed info for a container executor.
- ContainerDetail container_detail = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ ContainerDetail container_detail = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The detailed info for a custom job executor.
- CustomJobDetail custom_job_detail = 2 [
- deprecated = true,
- (google.api.field_behavior) = OUTPUT_ONLY
- ];
+ CustomJobDetail custom_job_detail = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_service.proto
index 0cd46b329..63899ce24 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_service.proto
@@ -20,6 +20,7 @@ import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
+import "google/cloud/aiplatform/v1/operation.proto";
import "google/cloud/aiplatform/v1/pipeline_job.proto";
import "google/cloud/aiplatform/v1/training_pipeline.proto";
import "google/longrunning/operations.proto";
@@ -27,7 +28,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "PipelineServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -39,11 +40,13 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// `PipelineJob` resources (used for Vertex AI Pipelines).
service PipelineService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a TrainingPipeline. A created TrainingPipeline right away will be
// attempted to be run.
- rpc CreateTrainingPipeline(CreateTrainingPipelineRequest) returns (TrainingPipeline) {
+ rpc CreateTrainingPipeline(CreateTrainingPipelineRequest)
+ returns (TrainingPipeline) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/trainingPipelines"
body: "training_pipeline"
@@ -52,7 +55,8 @@ service PipelineService {
}
// Gets a TrainingPipeline.
- rpc GetTrainingPipeline(GetTrainingPipelineRequest) returns (TrainingPipeline) {
+ rpc GetTrainingPipeline(GetTrainingPipelineRequest)
+ returns (TrainingPipeline) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/trainingPipelines/*}"
};
@@ -60,7 +64,8 @@ service PipelineService {
}
// Lists TrainingPipelines in a Location.
- rpc ListTrainingPipelines(ListTrainingPipelinesRequest) returns (ListTrainingPipelinesResponse) {
+ rpc ListTrainingPipelines(ListTrainingPipelinesRequest)
+ returns (ListTrainingPipelinesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/trainingPipelines"
};
@@ -68,7 +73,8 @@ service PipelineService {
}
// Deletes a TrainingPipeline.
- rpc DeleteTrainingPipeline(DeleteTrainingPipelineRequest) returns (google.longrunning.Operation) {
+ rpc DeleteTrainingPipeline(DeleteTrainingPipelineRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/trainingPipelines/*}"
};
@@ -82,14 +88,19 @@ service PipelineService {
// Cancels a TrainingPipeline.
// Starts asynchronous cancellation on the TrainingPipeline. The server
// makes a best effort to cancel the pipeline, but success is not
- // guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline] or
- // other methods to check whether the cancellation succeeded or whether the
+ // guaranteed. Clients can use
+ // [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
+ // or other methods to check whether the cancellation succeeded or whether the
// pipeline completed despite cancellation. On successful cancellation,
// the TrainingPipeline is not deleted; instead it becomes a pipeline with
- // a [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
- // corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to
- // `CANCELLED`.
- rpc CancelTrainingPipeline(CancelTrainingPipelineRequest) returns (google.protobuf.Empty) {
+ // a
+ // [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error]
+ // value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
+ // corresponding to `Code.CANCELLED`, and
+ // [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state]
+ // is set to `CANCELLED`.
+ rpc CancelTrainingPipeline(CancelTrainingPipelineRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/trainingPipelines/*}:cancel"
body: "*"
@@ -103,7 +114,8 @@ service PipelineService {
post: "/v1/{parent=projects/*/locations/*}/pipelineJobs"
body: "pipeline_job"
};
- option (google.api.method_signature) = "parent,pipeline_job,pipeline_job_id";
+ option (google.api.method_signature) =
+ "parent,pipeline_job,pipeline_job_id";
}
// Gets a PipelineJob.
@@ -115,7 +127,8 @@ service PipelineService {
}
// Lists PipelineJobs in a Location.
- rpc ListPipelineJobs(ListPipelineJobsRequest) returns (ListPipelineJobsResponse) {
+ rpc ListPipelineJobs(ListPipelineJobsRequest)
+ returns (ListPipelineJobsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/pipelineJobs"
};
@@ -123,7 +136,8 @@ service PipelineService {
}
// Deletes a PipelineJob.
- rpc DeletePipelineJob(DeletePipelineJobRequest) returns (google.longrunning.Operation) {
+ rpc DeletePipelineJob(DeletePipelineJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/pipelineJobs/*}"
};
@@ -137,14 +151,18 @@ service PipelineService {
// Cancels a PipelineJob.
// Starts asynchronous cancellation on the PipelineJob. The server
// makes a best effort to cancel the pipeline, but success is not
- // guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob] or
- // other methods to check whether the cancellation succeeded or whether the
+ // guaranteed. Clients can use
+ // [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob]
+ // or other methods to check whether the cancellation succeeded or whether the
// pipeline completed despite cancellation. On successful cancellation,
// the PipelineJob is not deleted; instead it becomes a pipeline with
- // a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
- // corresponding to `Code.CANCELLED`, and [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to
+ // a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value
+ // with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding
+ // to `Code.CANCELLED`, and
+ // [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to
// `CANCELLED`.
- rpc CancelPipelineJob(CancelPipelineJobRequest) returns (google.protobuf.Empty) {
+ rpc CancelPipelineJob(CancelPipelineJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/pipelineJobs/*}:cancel"
body: "*"
@@ -153,10 +171,11 @@ service PipelineService {
}
}
-// Request message for [PipelineService.CreateTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CreateTrainingPipeline].
+// Request message for
+// [PipelineService.CreateTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CreateTrainingPipeline].
message CreateTrainingPipelineRequest {
- // Required. The resource name of the Location to create the TrainingPipeline in.
- // Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location to create the TrainingPipeline
+ // in. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -165,10 +184,12 @@ message CreateTrainingPipelineRequest {
];
// Required. The TrainingPipeline to create.
- TrainingPipeline training_pipeline = 2 [(google.api.field_behavior) = REQUIRED];
+ TrainingPipeline training_pipeline = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline].
+// Request message for
+// [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline].
message GetTrainingPipelineRequest {
// Required. The name of the TrainingPipeline resource.
// Format:
@@ -181,10 +202,11 @@ message GetTrainingPipelineRequest {
];
}
-// Request message for [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines].
+// Request message for
+// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines].
message ListTrainingPipelinesRequest {
- // Required. The resource name of the Location to list the TrainingPipelines from.
- // Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location to list the TrainingPipelines
+ // from. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -219,25 +241,31 @@ message ListTrainingPipelinesRequest {
// The standard list page token.
// Typically obtained via
- // [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token] of the previous
- // [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines] call.
+ // [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token]
+ // of the previous
+ // [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines]
+// Response message for
+// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines]
message ListTrainingPipelinesResponse {
// List of TrainingPipelines in the requested page.
repeated TrainingPipeline training_pipelines = 1;
// A token to retrieve the next page of results.
- // Pass to [ListTrainingPipelinesRequest.page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListTrainingPipelinesRequest.page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [PipelineService.DeleteTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.DeleteTrainingPipeline].
+// Request message for
+// [PipelineService.DeleteTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.DeleteTrainingPipeline].
message DeleteTrainingPipelineRequest {
// Required. The name of the TrainingPipeline resource to be deleted.
// Format:
@@ -250,7 +278,8 @@ message DeleteTrainingPipelineRequest {
];
}
-// Request message for [PipelineService.CancelTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CancelTrainingPipeline].
+// Request message for
+// [PipelineService.CancelTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CancelTrainingPipeline].
message CancelTrainingPipelineRequest {
// Required. The name of the TrainingPipeline to cancel.
// Format:
@@ -263,7 +292,8 @@ message CancelTrainingPipelineRequest {
];
}
-// Request message for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].
+// Request message for
+// [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].
message CreatePipelineJobRequest {
// Required. The resource name of the Location to create the PipelineJob in.
// Format: `projects/{project}/locations/{location}`
@@ -286,7 +316,8 @@ message CreatePipelineJobRequest {
string pipeline_job_id = 3;
}
-// Request message for [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob].
+// Request message for
+// [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob].
message GetPipelineJobRequest {
// Required. The name of the PipelineJob resource.
// Format:
@@ -299,7 +330,8 @@ message GetPipelineJobRequest {
];
}
-// Request message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs].
+// Request message for
+// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs].
message ListPipelineJobsRequest {
// Required. The resource name of the Location to list the PipelineJobs from.
// Format: `projects/{project}/locations/{location}`
@@ -351,8 +383,10 @@ message ListPipelineJobsRequest {
// The standard list page token.
// Typically obtained via
- // [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token] of the previous
- // [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs] call.
+ // [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token]
+ // of the previous
+ // [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs]
+ // call.
string page_token = 4;
// A comma-separated list of fields to order by. The default sort order is in
@@ -374,17 +408,21 @@ message ListPipelineJobsRequest {
google.protobuf.FieldMask read_mask = 7;
}
-// Response message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs]
+// Response message for
+// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs]
message ListPipelineJobsResponse {
// List of PipelineJobs in the requested page.
repeated PipelineJob pipeline_jobs = 1;
// A token to retrieve the next page of results.
- // Pass to [ListPipelineJobsRequest.page_token][google.cloud.aiplatform.v1.ListPipelineJobsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListPipelineJobsRequest.page_token][google.cloud.aiplatform.v1.ListPipelineJobsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [PipelineService.DeletePipelineJob][google.cloud.aiplatform.v1.PipelineService.DeletePipelineJob].
+// Request message for
+// [PipelineService.DeletePipelineJob][google.cloud.aiplatform.v1.PipelineService.DeletePipelineJob].
message DeletePipelineJobRequest {
// Required. The name of the PipelineJob resource to be deleted.
// Format:
@@ -397,7 +435,8 @@ message DeletePipelineJobRequest {
];
}
-// Request message for [PipelineService.CancelPipelineJob][google.cloud.aiplatform.v1.PipelineService.CancelPipelineJob].
+// Request message for
+// [PipelineService.CancelPipelineJob][google.cloud.aiplatform.v1.PipelineService.CancelPipelineJob].
message CancelPipelineJobRequest {
// Required. The name of the PipelineJob to cancel.
// Format:
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_state.proto b/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_state.proto
index a06ae8abe..28baee3b3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_state.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/pipeline_state.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "PipelineStateProto";
option java_package = "com.google.cloud.aiplatform.v1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/prediction_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/prediction_service.proto
index 36096fd9e..e02e5704c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/prediction_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/prediction_service.proto
@@ -25,7 +25,7 @@ import "google/cloud/aiplatform/v1/explanation.proto";
import "google/protobuf/struct.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "PredictionServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -35,7 +35,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// A service for online predictions and explanations.
service PredictionService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Perform an online prediction.
rpc Predict(PredictRequest) returns (PredictResponse) {
@@ -50,11 +51,13 @@ service PredictionService {
//
// The response includes the following HTTP headers:
//
- // * `X-Vertex-AI-Endpoint-Id`: ID of the [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this
+ // * `X-Vertex-AI-Endpoint-Id`: ID of the
+ // [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this
// prediction.
//
- // * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1.DeployedModel]
- // that served this prediction.
+ // * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's
+ // [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this
+ // prediction.
rpc RawPredict(RawPredictRequest) returns (google.api.HttpBody) {
option (google.api.http) = {
post: "/v1/{endpoint=projects/*/locations/*/endpoints/*}:rawPredict"
@@ -65,10 +68,12 @@ service PredictionService {
// Perform an online explanation.
//
- // If [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id] is specified,
- // the corresponding DeployModel must have
+ // If
+ // [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
+ // is specified, the corresponding DeployModel must have
// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
- // populated. If [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
+ // populated. If
+ // [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id]
// is not specified, all DeployedModels must have
// [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
// populated. Only deployed AutoML tabular Models have
@@ -78,11 +83,13 @@ service PredictionService {
post: "/v1/{endpoint=projects/*/locations/*/endpoints/*}:explain"
body: "*"
};
- option (google.api.method_signature) = "endpoint,instances,parameters,deployed_model_id";
+ option (google.api.method_signature) =
+ "endpoint,instances,parameters,deployed_model_id";
}
}
-// Request message for [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].
+// Request message for
+// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].
message PredictRequest {
// Required. The name of the Endpoint requested to serve the prediction.
// Format:
@@ -103,16 +110,19 @@ message PredictRequest {
// DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
- repeated google.protobuf.Value instances = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated google.protobuf.Value instances = 2
+ [(google.api.field_behavior) = REQUIRED];
// The parameters that govern the prediction. The schema of the parameters may
- // be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
+ // be specified via Endpoint's DeployedModels' [Model's
+ // ][google.cloud.aiplatform.v1.DeployedModel.model]
// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
// [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
google.protobuf.Value parameters = 3;
}
-// Response message for [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].
+// Response message for
+// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].
message PredictResponse {
// The predictions that are the output of the predictions call.
// The schema of any single prediction may be specified via Endpoint's
@@ -124,8 +134,8 @@ message PredictResponse {
// ID of the Endpoint's DeployedModel that served this prediction.
string deployed_model_id = 2;
- // Output only. The resource name of the Model which is deployed as the DeployedModel that
- // this prediction hits.
+ // Output only. The resource name of the Model which is deployed as the
+ // DeployedModel that this prediction hits.
string model = 3 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -133,16 +143,18 @@ message PredictResponse {
}
];
- // Output only. The version ID of the Model which is deployed as the DeployedModel that
- // this prediction hits.
+ // Output only. The version ID of the Model which is deployed as the
+ // DeployedModel that this prediction hits.
string model_version_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The [display name][google.cloud.aiplatform.v1.Model.display_name] of the Model which is deployed as
- // the DeployedModel that this prediction hits.
+ // Output only. The [display
+ // name][google.cloud.aiplatform.v1.Model.display_name] of the Model which is
+ // deployed as the DeployedModel that this prediction hits.
string model_display_name = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Request message for [PredictionService.RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict].
+// Request message for
+// [PredictionService.RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict].
message RawPredictRequest {
// Required. The name of the Endpoint requested to serve the prediction.
// Format:
@@ -156,21 +168,24 @@ message RawPredictRequest {
// The prediction input. Supports HTTP headers and arbitrary data payload.
//
- // A [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] may have an upper limit on the number of instances it
- // supports per request. When this limit it is exceeded for an AutoML model,
- // the [RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict] method returns an error.
- // When this limit is exceeded for a custom-trained model, the behavior varies
- // depending on the model.
+ // A [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] may have an
+ // upper limit on the number of instances it supports per request. When this
+ // limit it is exceeded for an AutoML model, the
+ // [RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict]
+ // method returns an error. When this limit is exceeded for a custom-trained
+ // model, the behavior varies depending on the model.
//
// You can specify the schema for each instance in the
// [predict_schemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
- // field when you create a [Model][google.cloud.aiplatform.v1.Model]. This schema applies when you deploy the
- // `Model` as a `DeployedModel` to an [Endpoint][google.cloud.aiplatform.v1.Endpoint] and use the `RawPredict`
+ // field when you create a [Model][google.cloud.aiplatform.v1.Model]. This
+ // schema applies when you deploy the `Model` as a `DeployedModel` to an
+ // [Endpoint][google.cloud.aiplatform.v1.Endpoint] and use the `RawPredict`
// method.
google.api.HttpBody http_body = 2;
}
-// Request message for [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
+// Request message for
+// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
message ExplainRequest {
// Required. The name of the Endpoint requested to serve the explanation.
// Format:
@@ -191,18 +206,20 @@ message ExplainRequest {
// DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
// [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
- repeated google.protobuf.Value instances = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated google.protobuf.Value instances = 2
+ [(google.api.field_behavior) = REQUIRED];
// The parameters that govern the prediction. The schema of the parameters may
- // be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
+ // be specified via Endpoint's DeployedModels' [Model's
+ // ][google.cloud.aiplatform.v1.DeployedModel.model]
// [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
// [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
google.protobuf.Value parameters = 4;
// If specified, overrides the
- // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel.
- // Can be used for explaining prediction results with different
- // configurations, such as:
+ // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
+ // of the DeployedModel. Can be used for explaining prediction results with
+ // different configurations, such as:
// - Explaining top-5 predictions results as opposed to top-1;
// - Increasing path count or step count of the attribution methods to reduce
// approximate errors;
@@ -210,22 +227,27 @@ message ExplainRequest {
ExplanationSpecOverride explanation_spec_override = 5;
// If specified, this ExplainRequest will be served by the chosen
- // DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
+ // DeployedModel, overriding
+ // [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
string deployed_model_id = 3;
}
-// Response message for [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
+// Response message for
+// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
message ExplainResponse {
- // The explanations of the Model's [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
+ // The explanations of the Model's
+ // [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
//
- // It has the same number of elements as [instances][google.cloud.aiplatform.v1.ExplainRequest.instances]
- // to be explained.
+ // It has the same number of elements as
+ // [instances][google.cloud.aiplatform.v1.ExplainRequest.instances] to be
+ // explained.
repeated Explanation explanations = 1;
// ID of the Endpoint's DeployedModel that served this explanation.
string deployed_model_id = 2;
// The predictions that are the output of the predictions call.
- // Same as [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
+ // Same as
+ // [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
repeated google.protobuf.Value predictions = 3;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/saved_query.proto b/third_party/googleapis/google/cloud/aiplatform/v1/saved_query.proto
index 5332222d2..cdf1f8d11 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/saved_query.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/saved_query.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "SavedQueryProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -49,10 +49,12 @@ message SavedQuery {
google.protobuf.Value metadata = 12;
// Output only. Timestamp when this SavedQuery was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when SavedQuery was last updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Filters on the Annotations in the dataset.
string annotation_filter = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -79,7 +81,7 @@ message SavedQuery {
// "overwrite" update happens.
string etag = 8;
- // Output only. If the Annotations belonging to the SavedQuery can be used for AutoML
- // training.
+ // Output only. If the Annotations belonging to the SavedQuery can be used for
+ // AutoML training.
bool support_automl_training = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/BUILD.bazel
index 9aaf07fb7..02806a616 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/BUILD.bazel
@@ -57,7 +57,7 @@ load(
go_proto_library(
name = "instance_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/instance",
+ importpath = "cloud.google.com/go/aiplatform/apiv1/schema/predict/instance/instancepb",
protos = [":instance_proto"],
deps = [
"//google/api:annotations_go_proto",
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto
index 7ebb77ab8..e7f14c262 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "ImageClassificationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto
index 96aa4b14e..cf6995dd6 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "ImageObjectDetectionPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto
index 95dbf98cf..0916ae560 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "ImageSegmentationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_classification.proto
index 7d977a2f3..acf3ad888 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "TextClassificationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_extraction.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_extraction.proto
index b0b60c0fc..492d907d5 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_extraction.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_extraction.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "TextExtractionPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_sentiment.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_sentiment.proto
index 15ded40b9..cb3b732a4 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_sentiment.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/text_sentiment.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "TextSentimentPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_action_recognition.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_action_recognition.proto
index a43507dd6..0cc58f06d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_action_recognition.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_action_recognition.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "VideoActionRecognitionPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_classification.proto
index 70318a602..d849d0476 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "VideoClassificationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_object_tracking.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_object_tracking.proto
index 26b34930b..4418c4926 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_object_tracking.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/instance/video_object_tracking.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "VideoObjectTrackingPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/BUILD.bazel
index 7ce198545..7a17728e4 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/BUILD.bazel
@@ -54,7 +54,7 @@ load(
go_proto_library(
name = "params_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/params",
+ importpath = "cloud.google.com/go/aiplatform/apiv1/schema/predict/params/paramspb",
protos = [":params_proto"],
deps = [
"//google/api:annotations_go_proto",
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_classification.proto
index 6aab8b468..68b6d402c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "ImageClassificationPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_object_detection.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_object_detection.proto
index e957e2af2..6def9cb3d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_object_detection.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_object_detection.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "ImageObjectDetectionPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_segmentation.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_segmentation.proto
index 5469108a3..83e12562c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_segmentation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/image_segmentation.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "ImageSegmentationPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_action_recognition.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_action_recognition.proto
index ba6ec5403..d7778531d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_action_recognition.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_action_recognition.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "VideoActionRecognitionPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_classification.proto
index f4325f8a1..acf7ce0d9 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "VideoClassificationPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_object_tracking.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_object_tracking.proto
index 82449062d..721a08056 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_object_tracking.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/params/video_object_tracking.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "VideoObjectTrackingPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/BUILD.bazel
index 64ffb8ef2..ebd751126 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/BUILD.bazel
@@ -61,7 +61,7 @@ load(
go_proto_library(
name = "prediction_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction",
+ importpath = "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb",
protos = [":prediction_proto"],
deps = [
"//google/api:annotations_go_proto",
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/classification.proto
index be54f2c8d..a727b42bd 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "ClassificationPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/image_object_detection.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/image_object_detection.proto
index b0bb842e6..8a449d2b6 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/image_object_detection.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/image_object_detection.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1.schema.predict.prediction;
import "google/protobuf/struct.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "ImageObjectDetectionPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/image_segmentation.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/image_segmentation.proto
index 20ff4f6d2..5510a6c42 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/image_segmentation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/image_segmentation.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "ImageSegmentationPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_classification.proto
index 979461bd3..cd49449de 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "TabularClassificationPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_regression.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_regression.proto
index ba6bc6a7d..d3ebc73e0 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_regression.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_regression.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "TabularRegressionPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/text_extraction.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/text_extraction.proto
index f74a82bfd..a16ce5c21 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/text_extraction.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/text_extraction.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "TextExtractionPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/text_sentiment.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/text_sentiment.proto
index 4e8d5ec2c..e5352b60d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/text_sentiment.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/text_sentiment.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "TextSentimentPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_action_recognition.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_action_recognition.proto
index 35aecb6c5..ea44f1e1d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_action_recognition.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_action_recognition.proto
@@ -20,7 +20,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "VideoActionRecognitionPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_classification.proto
index fee01c7e7..d06450871 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_classification.proto
@@ -20,7 +20,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "VideoClassificationPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_object_tracking.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_object_tracking.proto
index d445c0cc4..415c03d77 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_object_tracking.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/predict/prediction/video_object_tracking.proto
@@ -20,7 +20,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "VideoObjectTrackingPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/BUILD.bazel
index eb5fa85bf..36272eff8 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/BUILD.bazel
@@ -60,7 +60,7 @@ load(
go_proto_library(
name = "definition_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition",
+ importpath = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb",
protos = [":definition_proto"],
deps = [
"//google/api:annotations_go_proto",
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_classification.proto
index 0f2c1ea4e..697a9b61d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLImageClassificationProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_object_detection.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_object_detection.proto
index 1459a85a7..a930bf140 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_object_detection.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_object_detection.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLImageObjectDetectionProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_segmentation.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_segmentation.proto
index 8303ef692..69e7e893c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_segmentation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_segmentation.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLImageSegmentationProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_tables.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_tables.proto
index 5b43fc7be..b0fcfbf43 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_tables.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_tables.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1.schema.trainingjob.definition;
import "google/cloud/aiplatform/v1/schema/trainingjob/definition/export_evaluated_data_items_config.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLTablesProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_classification.proto
index 1713e6a6c..ad75ea174 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLTextClassificationProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_extraction.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_extraction.proto
index 01f56c31f..e12c49409 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_extraction.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_extraction.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLTextExtractionProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_sentiment.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_sentiment.proto
index cb3f0ac5f..642e9d50e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_sentiment.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_sentiment.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLTextSentimentProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_action_recognition.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_action_recognition.proto
index 331033bdc..870066f76 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_action_recognition.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_action_recognition.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLVideoActionRecognitionProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_classification.proto
index 194ea3c66..672601224 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLVideoClassificationProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_object_tracking.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_object_tracking.proto
index d97e356f3..c941b5c8c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_object_tracking.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_object_tracking.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLVideoObjectTrackingProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/export_evaluated_data_items_config.proto b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/export_evaluated_data_items_config.proto
index eaa3298a2..f5eaa303a 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/export_evaluated_data_items_config.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/schema/trainingjob/definition/export_evaluated_data_items_config.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "ExportEvaluatedDataItemsConfigProto";
option java_package = "com.google.cloud.aiplatform.v1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/service_networking.proto b/third_party/googleapis/google/cloud/aiplatform/v1/service_networking.proto
new file mode 100644
index 000000000..e8ae11b7a
--- /dev/null
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/service_networking.proto
@@ -0,0 +1,38 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.aiplatform.v1;
+
+import "google/api/field_behavior.proto";
+
+option csharp_namespace = "Google.Cloud.AIPlatform.V1";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
+option java_multiple_files = true;
+option java_outer_classname = "ServiceNetworkingProto";
+option java_package = "com.google.cloud.aiplatform.v1";
+option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
+option ruby_package = "Google::Cloud::AIPlatform::V1";
+
+// Represents configuration for private service connect.
+message PrivateServiceConnectConfig {
+ // Required. If true, expose the IndexEndpoint via private service connect.
+ bool enable_private_service_connect = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // A list of Projects from which the forwarding rule will target the service
+ // attachment.
+ repeated string project_allowlist = 2;
+}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/specialist_pool.proto b/third_party/googleapis/google/cloud/aiplatform/v1/specialist_pool.proto
index 442874716..3fc47f97b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/specialist_pool.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/specialist_pool.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "SpecialistPoolProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -49,13 +49,15 @@ message SpecialistPool {
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
// Output only. The number of managers in this SpecialistPool.
- int32 specialist_managers_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ int32 specialist_managers_count = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The email addresses of the managers in the SpecialistPool.
repeated string specialist_manager_emails = 4;
// Output only. The resource name of the pending data labeling jobs.
- repeated string pending_data_labeling_jobs = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated string pending_data_labeling_jobs = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The email addresses of workers in the SpecialistPool.
repeated string specialist_worker_emails = 7;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/specialist_pool_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/specialist_pool_service.proto
index c45cc767b..c0d368081 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/specialist_pool_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/specialist_pool_service.proto
@@ -23,10 +23,11 @@ import "google/api/resource.proto";
import "google/cloud/aiplatform/v1/operation.proto";
import "google/cloud/aiplatform/v1/specialist_pool.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "SpecialistPoolServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -41,10 +42,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// CrowdCompute console.
service SpecialistPoolService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a SpecialistPool.
- rpc CreateSpecialistPool(CreateSpecialistPoolRequest) returns (google.longrunning.Operation) {
+ rpc CreateSpecialistPool(CreateSpecialistPoolRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/specialistPools"
body: "specialist_pool"
@@ -65,7 +68,8 @@ service SpecialistPoolService {
}
// Lists SpecialistPools in a Location.
- rpc ListSpecialistPools(ListSpecialistPoolsRequest) returns (ListSpecialistPoolsResponse) {
+ rpc ListSpecialistPools(ListSpecialistPoolsRequest)
+ returns (ListSpecialistPoolsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/specialistPools"
};
@@ -73,7 +77,8 @@ service SpecialistPoolService {
}
// Deletes a SpecialistPool as well as all Specialists in the pool.
- rpc DeleteSpecialistPool(DeleteSpecialistPoolRequest) returns (google.longrunning.Operation) {
+ rpc DeleteSpecialistPool(DeleteSpecialistPoolRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/specialistPools/*}"
};
@@ -85,7 +90,8 @@ service SpecialistPoolService {
}
// Updates a SpecialistPool.
- rpc UpdateSpecialistPool(UpdateSpecialistPoolRequest) returns (google.longrunning.Operation) {
+ rpc UpdateSpecialistPool(UpdateSpecialistPoolRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{specialist_pool.name=projects/*/locations/*/specialistPools/*}"
body: "specialist_pool"
@@ -98,7 +104,8 @@ service SpecialistPoolService {
}
}
-// Request message for [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool].
+// Request message for
+// [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool].
message CreateSpecialistPoolRequest {
// Required. The parent Project name for the new SpecialistPool.
// The form is `projects/{project}/locations/{location}`.
@@ -120,7 +127,8 @@ message CreateSpecialistPoolOperationMetadata {
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [SpecialistPoolService.GetSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.GetSpecialistPool].
+// Request message for
+// [SpecialistPoolService.GetSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.GetSpecialistPool].
message GetSpecialistPoolRequest {
// Required. The name of the SpecialistPool resource.
// The form is
@@ -133,7 +141,8 @@ message GetSpecialistPoolRequest {
];
}
-// Request message for [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools].
+// Request message for
+// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools].
message ListSpecialistPoolsRequest {
// Required. The name of the SpecialistPool's parent resource.
// Format: `projects/{project}/locations/{location}`
@@ -148,16 +157,19 @@ message ListSpecialistPoolsRequest {
int32 page_size = 2;
// The standard list page token.
- // Typically obtained by [ListSpecialistPoolsResponse.next_page_token][google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token] of
- // the previous [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools] call. Return
- // first page if empty.
+ // Typically obtained by
+ // [ListSpecialistPoolsResponse.next_page_token][google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token]
+ // of the previous
+ // [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools]
+ // call. Return first page if empty.
string page_token = 3;
// Mask specifying which fields to read. FieldMask represents a set of
google.protobuf.FieldMask read_mask = 4;
}
-// Response message for [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools].
+// Response message for
+// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools].
message ListSpecialistPoolsResponse {
// A list of SpecialistPools that matches the specified filter in the request.
repeated SpecialistPool specialist_pools = 1;
@@ -166,7 +178,8 @@ message ListSpecialistPoolsResponse {
string next_page_token = 2;
}
-// Request message for [SpecialistPoolService.DeleteSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.DeleteSpecialistPool].
+// Request message for
+// [SpecialistPoolService.DeleteSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.DeleteSpecialistPool].
message DeleteSpecialistPoolRequest {
// Required. The resource name of the SpecialistPool to delete. Format:
// `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`
@@ -183,20 +196,22 @@ message DeleteSpecialistPoolRequest {
bool force = 2;
}
-// Request message for [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool].
+// Request message for
+// [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool].
message UpdateSpecialistPoolRequest {
// Required. The SpecialistPool which replaces the resource on the server.
SpecialistPool specialist_pool = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Runtime operation metadata for
// [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool].
message UpdateSpecialistPoolOperationMetadata {
- // Output only. The name of the SpecialistPool to which the specialists are being added.
- // Format:
+ // Output only. The name of the SpecialistPool to which the specialists are
+ // being added. Format:
// `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}`
string specialist_pool = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/study.proto b/third_party/googleapis/google/cloud/aiplatform/v1/study.proto
index c61a4a3fe..4ef70dbeb 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/study.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/study.proto
@@ -23,7 +23,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "StudyProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -67,7 +67,8 @@ message Study {
State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time at which the study was created.
- google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. A human readable reason why the Study is inactive.
// This should be empty if a study is ACTIVE or COMPLETED.
@@ -86,7 +87,8 @@ message Trial {
// A message representing a parameter to be tuned.
message Parameter {
// Output only. The ID of the parameter. The parameter should be defined in
- // [StudySpec's Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
+ // [StudySpec's
+ // Parameters][google.cloud.aiplatform.v1.StudySpec.parameters].
string parameter_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The value of the parameter.
@@ -139,17 +141,21 @@ message Trial {
// Output only. A list of measurements that are strictly lexicographically
// ordered by their induced tuples (steps, elapsed_duration).
// These are used for early stopping computations.
- repeated Measurement measurements = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated Measurement measurements = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the Trial was started.
- google.protobuf.Timestamp start_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`.
- google.protobuf.Timestamp end_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Time when the Trial's status changed to `SUCCEEDED` or
+ // `INFEASIBLE`.
+ google.protobuf.Timestamp end_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The identifier of the client that originally requested this Trial.
- // Each client is identified by a unique client_id. When a client
- // asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client
+ // Output only. The identifier of the client that originally requested this
+ // Trial. Each client is identified by a unique client_id. When a client asks
+ // for a suggestion, Vertex AI Vizier will assign it a Trial. The client
// should evaluate the Trial, complete it, and report back to Vertex AI
// Vizier. If suggestion is asked again by same client_id before the Trial is
// completed, the same Trial will be returned. Multiple clients with
@@ -173,9 +179,11 @@ message Trial {
// Output only. URIs for accessing [interactive
// shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
// (one URI for each training node). Only available if this trial is part of
- // a [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob] and the job's
- // [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] field
- // is `true`.
+ // a
+ // [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob]
+ // and the job's
+ // [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
+ // field is `true`.
//
// The keys are names of each node used for the trial; for example,
// `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
@@ -183,13 +191,29 @@ message Trial {
// second worker pool.
//
// The values are the URIs for each node's interactive shell.
- map web_access_uris = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ map web_access_uris = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Represents specification of a Study.
message StudySpec {
// Represents a metric to optimize.
message MetricSpec {
+ // Used in safe optimization to specify threshold levels and risk tolerance.
+ message SafetyMetricConfig {
+ // Safety threshold (boundary value between safe and unsafe). NOTE that if
+ // you leave SafetyMetricConfig unset, a default value of 0 will be used.
+ double safety_threshold = 1;
+
+ // Desired minimum fraction of safe trials (over total number of trials)
+ // that should be targeted by the algorithm at any time during the
+ // study (best effort). This should be between 0.0 and 1.0 and a value of
+ // 0.0 means that there is no minimum and an algorithm proceeds without
+ // targeting any specific fraction. A value of 1.0 means that the
+ // algorithm attempts to only Suggest safe Trials.
+ optional double desired_min_safe_trials_fraction = 2;
+ }
+
// The available types of optimization goals.
enum GoalType {
// Goal Type will default to maximize.
@@ -202,12 +226,16 @@ message StudySpec {
MINIMIZE = 2;
}
- // Required. The ID of the metric. Must not contain whitespaces and must be unique
- // amongst all MetricSpecs.
+ // Required. The ID of the metric. Must not contain whitespaces and must be
+ // unique amongst all MetricSpecs.
string metric_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The optimization goal of the metric.
GoalType goal = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Used for safe search. In the case, the metric will be a safety
+ // metric. You must provide a separate metric for objective metric.
+ optional SafetyMetricConfig safety_config = 3;
}
// Represents a single parameter to optimize.
@@ -298,8 +326,8 @@ message StudySpec {
// Represents the spec to match categorical values from parent parameter.
message CategoricalValueCondition {
- // Required. Matches values of the parent parameter of 'CATEGORICAL' type.
- // All values must exist in `categorical_value_spec` of parent
+ // Required. Matches values of the parent parameter of 'CATEGORICAL'
+ // type. All values must exist in `categorical_value_spec` of parent
// parameter.
repeated string values = 1 [(google.api.field_behavior) = REQUIRED];
}
@@ -357,8 +385,8 @@ message StudySpec {
DiscreteValueSpec discrete_value_spec = 5;
}
- // Required. The ID of the parameter. Must not contain whitespaces and must be unique
- // amongst all ParameterSpecs.
+ // Required. The ID of the parameter. Must not contain whitespaces and must
+ // be unique amongst all ParameterSpecs.
string parameter_id = 1 [(google.api.field_behavior) = REQUIRED];
// How the parameter should be scaled.
@@ -379,9 +407,11 @@ message StudySpec {
// Trial. Early stopping is requested for the current Trial if there is very
// low probability to exceed the optimal value found so far.
message DecayCurveAutomatedStoppingSpec {
- // True if [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration] is used as the x-axis of each
- // Trials Decay Curve. Otherwise, [Measurement.step_count][google.cloud.aiplatform.v1.Measurement.step_count] will be used
- // as the x-axis.
+ // True if
+ // [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration]
+ // is used as the x-axis of each Trials Decay Curve. Otherwise,
+ // [Measurement.step_count][google.cloud.aiplatform.v1.Measurement.step_count]
+ // will be used as the x-axis.
bool use_elapsed_duration = 1;
}
@@ -392,9 +422,10 @@ message StudySpec {
// values reported by the Trial in each measurement.
message MedianAutomatedStoppingSpec {
// True if median automated stopping rule applies on
- // [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration]. It means that elapsed_duration
- // field of latest measurement of current Trial is used to compute median
- // objective value for each completed Trials.
+ // [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration].
+ // It means that elapsed_duration field of latest measurement of current
+ // Trial is used to compute median objective value for each completed
+ // Trials.
bool use_elapsed_duration = 1;
}
@@ -444,6 +475,15 @@ message StudySpec {
// min_num_steps are overloaded to contain max_elapsed_seconds and
// min_elapsed_seconds.
bool use_elapsed_duration = 5;
+
+ // ConvexAutomatedStoppingSpec by default only updates the trials that needs
+ // to be early stopped using a newly trained auto-regressive model. When
+ // this flag is set to True, all stopped trials from the beginning are
+ // potentially updated in terms of their `final_measurement`. Also, note
+ // that the training logic of autoregressive models is different in this
+ // case. Enabling this option has shown better results and this may be the
+ // default option in the future.
+ optional bool update_all_stopped_trials = 6;
}
// The available search algorithms for the Study.
@@ -518,7 +558,8 @@ message StudySpec {
repeated MetricSpec metrics = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The set of parameters to tune.
- repeated ParameterSpec parameters = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated ParameterSpec parameters = 2
+ [(google.api.field_behavior) = REQUIRED];
// The search algorithm specified for the Study.
Algorithm algorithm = 3;
@@ -546,14 +587,16 @@ message Measurement {
double value = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
- // Output only. Time that the Trial has been running at the point of this Measurement.
- google.protobuf.Duration elapsed_duration = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Time that the Trial has been running at the point of this
+ // Measurement.
+ google.protobuf.Duration elapsed_duration = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The number of steps the machine learning model has been trained for.
- // Must be non-negative.
+ // Output only. The number of steps the machine learning model has been
+ // trained for. Must be non-negative.
int64 step_count = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A list of metrics got by evaluating the objective functions using suggested
- // Parameter values.
+ // Output only. A list of metrics got by evaluating the objective functions
+ // using suggested Parameter values.
repeated Metric metrics = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard.proto b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard.proto
index 8a19066ac..541cbfe4c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard.proto
@@ -22,7 +22,7 @@ import "google/cloud/aiplatform/v1/encryption_spec.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -54,18 +54,21 @@ message Tensorboard {
// this key.
EncryptionSpec encryption_spec = 11;
- // Output only. Consumer project Cloud Storage path prefix used to store blob data, which
- // can either be a bucket or directory. Does not end with a '/'.
- string blob_storage_path_prefix = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Consumer project Cloud Storage path prefix used to store blob
+ // data, which can either be a bucket or directory. Does not end with a '/'.
+ string blob_storage_path_prefix = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The number of Runs stored in this Tensorboard.
int32 run_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Tensorboard was created.
- google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Tensorboard was last updated.
- google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize your Tensorboards.
//
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_data.proto b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_data.proto
index c65db6945..282a01be3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_data.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_data.proto
@@ -21,7 +21,7 @@ import "google/cloud/aiplatform/v1/tensorboard_time_series.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardDataProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -30,19 +30,21 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// All the data stored in a TensorboardTimeSeries.
message TimeSeriesData {
- // Required. The ID of the TensorboardTimeSeries, which will become the final component
- // of the TensorboardTimeSeries' resource name
- string tensorboard_time_series_id = 1 [(google.api.field_behavior) = REQUIRED];
+ // Required. The ID of the TensorboardTimeSeries, which will become the final
+ // component of the TensorboardTimeSeries' resource name
+ string tensorboard_time_series_id = 1
+ [(google.api.field_behavior) = REQUIRED];
- // Required. Immutable. The value type of this time series. All the values in this time series data
- // must match this value type.
+ // Required. Immutable. The value type of this time series. All the values in
+ // this time series data must match this value type.
TensorboardTimeSeries.ValueType value_type = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
];
// Required. Data points in this time series.
- repeated TimeSeriesDataPoint values = 3 [(google.api.field_behavior) = REQUIRED];
+ repeated TimeSeriesDataPoint values = 3
+ [(google.api.field_behavior) = REQUIRED];
}
// A TensorboardTimeSeries data point.
@@ -78,7 +80,8 @@ message TensorboardTensor {
// https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto
bytes value = 1 [(google.api.field_behavior) = REQUIRED];
- // Optional. Version number of TensorProto used to serialize [value][google.cloud.aiplatform.v1.TensorboardTensor.value].
+ // Optional. Version number of TensorProto used to serialize
+ // [value][google.cloud.aiplatform.v1.TensorboardTensor.value].
int32 version_number = 2 [(google.api.field_behavior) = OPTIONAL];
}
@@ -91,8 +94,8 @@ message TensorboardBlobSequence {
// One blob (e.g, image, graph) viewable on a blob metric plot.
message TensorboardBlob {
- // Output only. A URI safe key uniquely identifying a blob. Can be used to locate the blob
- // stored in the Cloud Storage bucket of the consumer project.
+ // Output only. A URI safe key uniquely identifying a blob. Can be used to
+ // locate the blob stored in the Cloud Storage bucket of the consumer project.
string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The bytes of the blob is not present unless it's returned by the
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_experiment.proto b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_experiment.proto
index 9d7fe1204..db57d584a 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_experiment.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_experiment.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardExperimentProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -48,10 +48,12 @@ message TensorboardExperiment {
string description = 3;
// Output only. Timestamp when this TensorboardExperiment was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this TensorboardExperiment was last updated.
- google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize your Datasets.
//
@@ -73,6 +75,7 @@ message TensorboardExperiment {
// "overwrite" update happens.
string etag = 7;
- // Immutable. Source of the TensorboardExperiment. Example: a custom training job.
+ // Immutable. Source of the TensorboardExperiment. Example: a custom training
+ // job.
string source = 8 [(google.api.field_behavior) = IMMUTABLE];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_run.proto b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_run.proto
index 0f7b5eff6..bc109db9d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_run.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_run.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardRunProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -50,10 +50,12 @@ message TensorboardRun {
string description = 3;
// Output only. Timestamp when this TensorboardRun was created.
- google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this TensorboardRun was last updated.
- google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize your TensorboardRuns.
//
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_service.proto
index ec59778bd..63834044a 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_service.proto
@@ -27,10 +27,11 @@ import "google/cloud/aiplatform/v1/tensorboard_experiment.proto";
import "google/cloud/aiplatform/v1/tensorboard_run.proto";
import "google/cloud/aiplatform/v1/tensorboard_time_series.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -45,7 +46,8 @@ service TensorboardService {
"https://www.googleapis.com/auth/cloud-platform.read-only";
// Creates a Tensorboard.
- rpc CreateTensorboard(CreateTensorboardRequest) returns (google.longrunning.Operation) {
+ rpc CreateTensorboard(CreateTensorboardRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/tensorboards"
body: "tensorboard"
@@ -65,8 +67,18 @@ service TensorboardService {
option (google.api.method_signature) = "name";
}
+ // Returns a list of monthly active users for a given TensorBoard instance.
+ rpc ReadTensorboardUsage(ReadTensorboardUsageRequest)
+ returns (ReadTensorboardUsageResponse) {
+ option (google.api.http) = {
+ get: "/v1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage"
+ };
+ option (google.api.method_signature) = "tensorboard";
+ }
+
// Updates a Tensorboard.
- rpc UpdateTensorboard(UpdateTensorboardRequest) returns (google.longrunning.Operation) {
+ rpc UpdateTensorboard(UpdateTensorboardRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{tensorboard.name=projects/*/locations/*/tensorboards/*}"
body: "tensorboard"
@@ -79,7 +91,8 @@ service TensorboardService {
}
// Lists Tensorboards in a Location.
- rpc ListTensorboards(ListTensorboardsRequest) returns (ListTensorboardsResponse) {
+ rpc ListTensorboards(ListTensorboardsRequest)
+ returns (ListTensorboardsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/tensorboards"
};
@@ -87,7 +100,8 @@ service TensorboardService {
}
// Deletes a Tensorboard.
- rpc DeleteTensorboard(DeleteTensorboardRequest) returns (google.longrunning.Operation) {
+ rpc DeleteTensorboard(DeleteTensorboardRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/tensorboards/*}"
};
@@ -99,16 +113,19 @@ service TensorboardService {
}
// Creates a TensorboardExperiment.
- rpc CreateTensorboardExperiment(CreateTensorboardExperimentRequest) returns (TensorboardExperiment) {
+ rpc CreateTensorboardExperiment(CreateTensorboardExperimentRequest)
+ returns (TensorboardExperiment) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/tensorboards/*}/experiments"
body: "tensorboard_experiment"
};
- option (google.api.method_signature) = "parent,tensorboard_experiment,tensorboard_experiment_id";
+ option (google.api.method_signature) =
+ "parent,tensorboard_experiment,tensorboard_experiment_id";
}
// Gets a TensorboardExperiment.
- rpc GetTensorboardExperiment(GetTensorboardExperimentRequest) returns (TensorboardExperiment) {
+ rpc GetTensorboardExperiment(GetTensorboardExperimentRequest)
+ returns (TensorboardExperiment) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*}"
};
@@ -116,7 +133,8 @@ service TensorboardService {
}
// Updates a TensorboardExperiment.
- rpc UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest) returns (TensorboardExperiment) {
+ rpc UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest)
+ returns (TensorboardExperiment) {
option (google.api.http) = {
patch: "/v1/{tensorboard_experiment.name=projects/*/locations/*/tensorboards/*/experiments/*}"
body: "tensorboard_experiment"
@@ -125,7 +143,8 @@ service TensorboardService {
}
// Lists TensorboardExperiments in a Location.
- rpc ListTensorboardExperiments(ListTensorboardExperimentsRequest) returns (ListTensorboardExperimentsResponse) {
+ rpc ListTensorboardExperiments(ListTensorboardExperimentsRequest)
+ returns (ListTensorboardExperimentsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/tensorboards/*}/experiments"
};
@@ -133,7 +152,8 @@ service TensorboardService {
}
// Deletes a TensorboardExperiment.
- rpc DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest) returns (google.longrunning.Operation) {
+ rpc DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*}"
};
@@ -145,16 +165,19 @@ service TensorboardService {
}
// Creates a TensorboardRun.
- rpc CreateTensorboardRun(CreateTensorboardRunRequest) returns (TensorboardRun) {
+ rpc CreateTensorboardRun(CreateTensorboardRunRequest)
+ returns (TensorboardRun) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs"
body: "tensorboard_run"
};
- option (google.api.method_signature) = "parent,tensorboard_run,tensorboard_run_id";
+ option (google.api.method_signature) =
+ "parent,tensorboard_run,tensorboard_run_id";
}
// Batch create TensorboardRuns.
- rpc BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest) returns (BatchCreateTensorboardRunsResponse) {
+ rpc BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest)
+ returns (BatchCreateTensorboardRunsResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs:batchCreate"
body: "*"
@@ -171,7 +194,8 @@ service TensorboardService {
}
// Updates a TensorboardRun.
- rpc UpdateTensorboardRun(UpdateTensorboardRunRequest) returns (TensorboardRun) {
+ rpc UpdateTensorboardRun(UpdateTensorboardRunRequest)
+ returns (TensorboardRun) {
option (google.api.http) = {
patch: "/v1/{tensorboard_run.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}"
body: "tensorboard_run"
@@ -180,7 +204,8 @@ service TensorboardService {
}
// Lists TensorboardRuns in a Location.
- rpc ListTensorboardRuns(ListTensorboardRunsRequest) returns (ListTensorboardRunsResponse) {
+ rpc ListTensorboardRuns(ListTensorboardRunsRequest)
+ returns (ListTensorboardRunsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs"
};
@@ -188,7 +213,8 @@ service TensorboardService {
}
// Deletes a TensorboardRun.
- rpc DeleteTensorboardRun(DeleteTensorboardRunRequest) returns (google.longrunning.Operation) {
+ rpc DeleteTensorboardRun(DeleteTensorboardRunRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}"
};
@@ -200,7 +226,8 @@ service TensorboardService {
}
// Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
- rpc BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest) returns (BatchCreateTensorboardTimeSeriesResponse) {
+ rpc BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest)
+ returns (BatchCreateTensorboardTimeSeriesResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs/*/timeSeries:batchCreate"
body: "*"
@@ -209,7 +236,8 @@ service TensorboardService {
}
// Creates a TensorboardTimeSeries.
- rpc CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) {
+ rpc CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest)
+ returns (TensorboardTimeSeries) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries"
body: "tensorboard_time_series"
@@ -218,7 +246,8 @@ service TensorboardService {
}
// Gets a TensorboardTimeSeries.
- rpc GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) {
+ rpc GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest)
+ returns (TensorboardTimeSeries) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
};
@@ -226,16 +255,19 @@ service TensorboardService {
}
// Updates a TensorboardTimeSeries.
- rpc UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) {
+ rpc UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest)
+ returns (TensorboardTimeSeries) {
option (google.api.http) = {
patch: "/v1/{tensorboard_time_series.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
body: "tensorboard_time_series"
};
- option (google.api.method_signature) = "tensorboard_time_series,update_mask";
+ option (google.api.method_signature) =
+ "tensorboard_time_series,update_mask";
}
// Lists TensorboardTimeSeries in a Location.
- rpc ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest) returns (ListTensorboardTimeSeriesResponse) {
+ rpc ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest)
+ returns (ListTensorboardTimeSeriesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries"
};
@@ -243,7 +275,8 @@ service TensorboardService {
}
// Deletes a TensorboardTimeSeries.
- rpc DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest) returns (google.longrunning.Operation) {
+ rpc DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
};
@@ -256,10 +289,12 @@ service TensorboardService {
// Reads multiple TensorboardTimeSeries' data. The data point number limit is
// 1000 for scalars, 100 for tensors and blob references. If the number of
- // data points stored is less than the limit, all data will be returned.
- // Otherwise, that limit number of data points will be randomly selected from
+ // data points stored is less than the limit, all data is returned.
+ // Otherwise, the number limit of data points is randomly selected from
// this time series and returned.
- rpc BatchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest) returns (BatchReadTensorboardTimeSeriesDataResponse) {
+ rpc BatchReadTensorboardTimeSeriesData(
+ BatchReadTensorboardTimeSeriesDataRequest)
+ returns (BatchReadTensorboardTimeSeriesDataResponse) {
option (google.api.http) = {
get: "/v1/{tensorboard=projects/*/locations/*/tensorboards/*}/experiments/*/runs/*/timeSeries:batchRead"
};
@@ -267,11 +302,12 @@ service TensorboardService {
}
// Reads a TensorboardTimeSeries' data. By default, if the number of data
- // points stored is less than 1000, all data will be returned. Otherwise, 1000
- // data points will be randomly selected from this time series and returned.
+ // points stored is less than 1000, all data is returned. Otherwise, 1000
+ // data points is randomly selected from this time series and returned.
// This value can be changed by changing max_data_points, which can't be
// greater than 10k.
- rpc ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest) returns (ReadTensorboardTimeSeriesDataResponse) {
+ rpc ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest)
+ returns (ReadTensorboardTimeSeriesDataResponse) {
option (google.api.http) = {
get: "/v1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:read"
};
@@ -282,7 +318,8 @@ service TensorboardService {
// This is to allow reading blob data stored in consumer project's Cloud
// Storage bucket without users having to obtain Cloud Storage access
// permission.
- rpc ReadTensorboardBlobData(ReadTensorboardBlobDataRequest) returns (stream ReadTensorboardBlobDataResponse) {
+ rpc ReadTensorboardBlobData(ReadTensorboardBlobDataRequest)
+ returns (stream ReadTensorboardBlobDataResponse) {
option (google.api.http) = {
get: "/v1/{time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:readBlobData"
};
@@ -290,20 +327,21 @@ service TensorboardService {
}
// Write time series data points of multiple TensorboardTimeSeries in multiple
- // TensorboardRun's. If any data fail to be ingested, an error will be
- // returned.
- rpc WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest) returns (WriteTensorboardExperimentDataResponse) {
+ // TensorboardRun's. If any data fail to be ingested, an error is returned.
+ rpc WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest)
+ returns (WriteTensorboardExperimentDataResponse) {
option (google.api.http) = {
post: "/v1/{tensorboard_experiment=projects/*/locations/*/tensorboards/*/experiments/*}:write"
body: "*"
};
- option (google.api.method_signature) = "tensorboard_experiment,write_run_data_requests";
+ option (google.api.method_signature) =
+ "tensorboard_experiment,write_run_data_requests";
}
// Write time series data points into multiple TensorboardTimeSeries under
- // a TensorboardRun. If any data fail to be ingested, an error will be
- // returned.
- rpc WriteTensorboardRunData(WriteTensorboardRunDataRequest) returns (WriteTensorboardRunDataResponse) {
+ // a TensorboardRun. If any data fail to be ingested, an error is returned.
+ rpc WriteTensorboardRunData(WriteTensorboardRunDataRequest)
+ returns (WriteTensorboardRunDataResponse) {
option (google.api.http) = {
post: "/v1/{tensorboard_run=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}:write"
body: "*"
@@ -313,7 +351,8 @@ service TensorboardService {
// Exports a TensorboardTimeSeries' data. Data is returned in paginated
// responses.
- rpc ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest) returns (ExportTensorboardTimeSeriesDataResponse) {
+ rpc ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest)
+ returns (ExportTensorboardTimeSeriesDataResponse) {
option (google.api.http) = {
post: "/v1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:exportTensorboardTimeSeries"
body: "*"
@@ -322,7 +361,8 @@ service TensorboardService {
}
}
-// Request message for [TensorboardService.CreateTensorboard][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboard].
+// Request message for
+// [TensorboardService.CreateTensorboard][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboard].
message CreateTensorboardRequest {
// Required. The resource name of the Location to create the Tensorboard in.
// Format: `projects/{project}/locations/{location}`
@@ -337,7 +377,8 @@ message CreateTensorboardRequest {
Tensorboard tensorboard = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.GetTensorboard][google.cloud.aiplatform.v1.TensorboardService.GetTensorboard].
+// Request message for
+// [TensorboardService.GetTensorboard][google.cloud.aiplatform.v1.TensorboardService.GetTensorboard].
message GetTensorboardRequest {
// Required. The name of the Tensorboard resource.
// Format:
@@ -350,7 +391,43 @@ message GetTensorboardRequest {
];
}
-// Request message for [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards].
+// Request message for [TensorboardService.GetTensorboardUsage][].
+message ReadTensorboardUsageRequest {
+ // Required. The name of the Tensorboard resource.
+ // Format:
+ // `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
+ string tensorboard = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/Tensorboard"
+ }
+ ];
+}
+
+// Response message for
+// [TensorboardService.ReadTensorboardUsage][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage].
+message ReadTensorboardUsageResponse {
+ // Per user usage data.
+ message PerUserUsageData {
+ // User's username
+ string username = 1;
+
+ // Number of times the user has read data within the Tensorboard.
+ int64 view_count = 2;
+ }
+
+ // Per month usage data
+ message PerMonthUsageData {
+ // Usage data for each user in the given month.
+ repeated PerUserUsageData user_usage_data = 1;
+ }
+
+ // Maps year-month (YYYYMM) string to per month usage data.
+ map monthly_usage_data = 1;
+}
+
+// Request message for
+// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards].
message ListTensorboardsRequest {
// Required. The resource name of the Location to list Tensorboards.
// Format:
@@ -366,18 +443,18 @@ message ListTensorboardsRequest {
string filter = 2;
// The maximum number of Tensorboards to return. The service may return
- // fewer than this value. If unspecified, at most 100 Tensorboards will be
- // returned. The maximum value is 100; values above 100 will be coerced to
+ // fewer than this value. If unspecified, at most 100 Tensorboards are
+ // returned. The maximum value is 100; values above 100 are coerced to
// 100.
int32 page_size = 3;
// A page token, received from a previous
- // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards] call.
- // Provide this to retrieve the subsequent page.
+ // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards] must
- // match the call that provided the page token.
+ // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards]
+ // must match the call that provided the page token.
string page_token = 4;
// Field to use to sort the list.
@@ -387,26 +464,30 @@ message ListTensorboardsRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards].
+// Response message for
+// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards].
message ListTensorboardsResponse {
// The Tensorboards mathching the request.
repeated Tensorboard tensorboards = 1;
- // A token, which can be sent as [ListTensorboardsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardsRequest.page_token]
+ // A token, which can be sent as
+ // [ListTensorboardsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardsRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
string next_page_token = 2;
}
-// Request message for [TensorboardService.UpdateTensorboard][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboard].
+// Request message for
+// [TensorboardService.UpdateTensorboard][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboard].
message UpdateTensorboardRequest {
// Required. Field mask is used to specify the fields to be overwritten in the
// Tensorboard resource by the update.
// The fields specified in the update_mask are relative to the resource, not
- // the full request. A field will be overwritten if it is in the mask. If the
- // user does not provide a mask then all fields will be overwritten if new
+ // the full request. A field is overwritten if it's in the mask. If the
+ // user does not provide a mask then all fields are overwritten if new
// values are specified.
- google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = REQUIRED];
// Required. The Tensorboard's `name` field is used to identify the
// Tensorboard to be updated. Format:
@@ -414,7 +495,8 @@ message UpdateTensorboardRequest {
Tensorboard tensorboard = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.DeleteTensorboard][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboard].
+// Request message for
+// [TensorboardService.DeleteTensorboard][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboard].
message DeleteTensorboardRequest {
// Required. The name of the Tensorboard to be deleted.
// Format:
@@ -427,10 +509,11 @@ message DeleteTensorboardRequest {
];
}
-// Request message for [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment].
+// Request message for
+// [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment].
message CreateTensorboardExperimentRequest {
- // Required. The resource name of the Tensorboard to create the TensorboardExperiment
- // in. Format:
+ // Required. The resource name of the Tensorboard to create the
+ // TensorboardExperiment in. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -442,15 +525,16 @@ message CreateTensorboardExperimentRequest {
// The TensorboardExperiment to create.
TensorboardExperiment tensorboard_experiment = 2;
- // Required. The ID to use for the Tensorboard experiment, which will become the final
- // component of the Tensorboard experiment's resource name.
+ // Required. The ID to use for the Tensorboard experiment, which becomes the
+ // final component of the Tensorboard experiment's resource name.
//
// This value should be 1-128 characters, and valid characters
// are /[a-z][0-9]-/.
string tensorboard_experiment_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.GetTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardExperiment].
+// Request message for
+// [TensorboardService.GetTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardExperiment].
message GetTensorboardExperimentRequest {
// Required. The name of the TensorboardExperiment resource.
// Format:
@@ -463,10 +547,11 @@ message GetTensorboardExperimentRequest {
];
}
-// Request message for [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments].
+// Request message for
+// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments].
message ListTensorboardExperimentsRequest {
- // Required. The resource name of the Tensorboard to list TensorboardExperiments.
- // Format:
+ // Required. The resource name of the Tensorboard to list
+ // TensorboardExperiments. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -480,17 +565,17 @@ message ListTensorboardExperimentsRequest {
// The maximum number of TensorboardExperiments to return. The service may
// return fewer than this value. If unspecified, at most 50
- // TensorboardExperiments will be returned. The maximum value is 1000; values
- // above 1000 will be coerced to 1000.
+ // TensorboardExperiments are returned. The maximum value is 1000; values
+ // above 1000 are coerced to 1000.
int32 page_size = 3;
// A page token, received from a previous
- // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments] call.
- // Provide this to retrieve the subsequent page.
+ // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments] must
- // match the call that provided the page token.
+ // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
+ // must match the call that provided the page token.
string page_token = 4;
// Field to use to sort the list.
@@ -500,34 +585,40 @@ message ListTensorboardExperimentsRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments].
+// Response message for
+// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments].
message ListTensorboardExperimentsResponse {
// The TensorboardExperiments mathching the request.
repeated TensorboardExperiment tensorboard_experiments = 1;
// A token, which can be sent as
- // [ListTensorboardExperimentsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardExperimentsRequest.page_token] to retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // [ListTensorboardExperimentsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardExperimentsRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [TensorboardService.UpdateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardExperiment].
+// Request message for
+// [TensorboardService.UpdateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardExperiment].
message UpdateTensorboardExperimentRequest {
// Required. Field mask is used to specify the fields to be overwritten in the
// TensorboardExperiment resource by the update.
// The fields specified in the update_mask are relative to the resource, not
- // the full request. A field will be overwritten if it is in the mask. If the
- // user does not provide a mask then all fields will be overwritten if new
+ // the full request. A field is overwritten if it's in the mask. If the
+ // user does not provide a mask then all fields are overwritten if new
// values are specified.
- google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = REQUIRED];
// Required. The TensorboardExperiment's `name` field is used to identify the
// TensorboardExperiment to be updated. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
- TensorboardExperiment tensorboard_experiment = 2 [(google.api.field_behavior) = REQUIRED];
+ TensorboardExperiment tensorboard_experiment = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.DeleteTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardExperiment].
+// Request message for
+// [TensorboardService.DeleteTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardExperiment].
message DeleteTensorboardExperimentRequest {
// Required. The name of the TensorboardExperiment to be deleted.
// Format:
@@ -540,7 +631,8 @@ message DeleteTensorboardExperimentRequest {
];
}
-// Request message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns].
+// Request message for
+// [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns].
message BatchCreateTensorboardRunsRequest {
// Required. The resource name of the TensorboardExperiment to create the
// TensorboardRuns in. Format:
@@ -556,19 +648,22 @@ message BatchCreateTensorboardRunsRequest {
// Required. The request message specifying the TensorboardRuns to create.
// A maximum of 1000 TensorboardRuns can be created in a batch.
- repeated CreateTensorboardRunRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CreateTensorboardRunRequest requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns].
+// Response message for
+// [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns].
message BatchCreateTensorboardRunsResponse {
// The created TensorboardRuns.
repeated TensorboardRun tensorboard_runs = 1;
}
-// Request message for [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardRun].
+// Request message for
+// [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardRun].
message CreateTensorboardRunRequest {
- // Required. The resource name of the TensorboardExperiment to create the TensorboardRun
- // in. Format:
+ // Required. The resource name of the TensorboardExperiment to create the
+ // TensorboardRun in. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -580,7 +675,7 @@ message CreateTensorboardRunRequest {
// Required. The TensorboardRun to create.
TensorboardRun tensorboard_run = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. The ID to use for the Tensorboard run, which will become the final
+ // Required. The ID to use for the Tensorboard run, which becomes the final
// component of the Tensorboard run's resource name.
//
// This value should be 1-128 characters, and valid characters
@@ -588,7 +683,8 @@ message CreateTensorboardRunRequest {
string tensorboard_run_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.GetTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardRun].
+// Request message for
+// [TensorboardService.GetTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardRun].
message GetTensorboardRunRequest {
// Required. The name of the TensorboardRun resource.
// Format:
@@ -601,7 +697,8 @@ message GetTensorboardRunRequest {
];
}
-// Request message for [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData].
+// Request message for
+// [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData].
message ReadTensorboardBlobDataRequest {
// Required. The resource name of the TensorboardTimeSeries to list Blobs.
// Format:
@@ -617,16 +714,18 @@ message ReadTensorboardBlobDataRequest {
repeated string blob_ids = 2;
}
-// Response message for [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData].
+// Response message for
+// [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData].
message ReadTensorboardBlobDataResponse {
// Blob messages containing blob bytes.
repeated TensorboardBlob blobs = 1;
}
-// Request message for [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns].
+// Request message for
+// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns].
message ListTensorboardRunsRequest {
- // Required. The resource name of the TensorboardExperiment to list TensorboardRuns.
- // Format:
+ // Required. The resource name of the TensorboardExperiment to list
+ // TensorboardRuns. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -639,18 +738,18 @@ message ListTensorboardRunsRequest {
string filter = 2;
// The maximum number of TensorboardRuns to return. The service may return
- // fewer than this value. If unspecified, at most 50 TensorboardRuns will be
- // returned. The maximum value is 1000; values above 1000 will be coerced to
+ // fewer than this value. If unspecified, at most 50 TensorboardRuns are
+ // returned. The maximum value is 1000; values above 1000 are coerced to
// 1000.
int32 page_size = 3;
// A page token, received from a previous
- // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call.
- // Provide this to retrieve the subsequent page.
+ // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] must
- // match the call that provided the page token.
+ // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
+ // must match the call that provided the page token.
string page_token = 4;
// Field to use to sort the list.
@@ -660,34 +759,39 @@ message ListTensorboardRunsRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns].
+// Response message for
+// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns].
message ListTensorboardRunsResponse {
// The TensorboardRuns mathching the request.
repeated TensorboardRun tensorboard_runs = 1;
- // A token, which can be sent as [ListTensorboardRunsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardRunsRequest.page_token] to
- // retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // A token, which can be sent as
+ // [ListTensorboardRunsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardRunsRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [TensorboardService.UpdateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardRun].
+// Request message for
+// [TensorboardService.UpdateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardRun].
message UpdateTensorboardRunRequest {
// Required. Field mask is used to specify the fields to be overwritten in the
// TensorboardRun resource by the update.
// The fields specified in the update_mask are relative to the resource, not
- // the full request. A field will be overwritten if it is in the mask. If the
- // user does not provide a mask then all fields will be overwritten if new
+ // the full request. A field is overwritten if it's in the mask. If the
+ // user does not provide a mask then all fields are overwritten if new
// values are specified.
- google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = REQUIRED];
- // Required. The TensorboardRun's `name` field is used to identify the TensorboardRun to
- // be updated. Format:
+ // Required. The TensorboardRun's `name` field is used to identify the
+ // TensorboardRun to be updated. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
TensorboardRun tensorboard_run = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.DeleteTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardRun].
+// Request message for
+// [TensorboardService.DeleteTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardRun].
message DeleteTensorboardRunRequest {
// Required. The name of the TensorboardRun to be deleted.
// Format:
@@ -700,7 +804,8 @@ message DeleteTensorboardRunRequest {
];
}
-// Request message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries].
message BatchCreateTensorboardTimeSeriesRequest {
// Required. The resource name of the TensorboardExperiment to create the
// TensorboardTimeSeries in.
@@ -716,18 +821,21 @@ message BatchCreateTensorboardTimeSeriesRequest {
}
];
- // Required. The request message specifying the TensorboardTimeSeries to create.
- // A maximum of 1000 TensorboardTimeSeries can be created in a batch.
- repeated CreateTensorboardTimeSeriesRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The request message specifying the TensorboardTimeSeries to
+ // create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.
+ repeated CreateTensorboardTimeSeriesRequest requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries].
+// Response message for
+// [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries].
message BatchCreateTensorboardTimeSeriesResponse {
// The created TensorboardTimeSeries.
repeated TensorboardTimeSeries tensorboard_time_series = 1;
}
-// Request message for [TensorboardService.CreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.CreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardTimeSeries].
message CreateTensorboardTimeSeriesRequest {
// Required. The resource name of the TensorboardRun to create the
// TensorboardTimeSeries in.
@@ -740,17 +848,20 @@ message CreateTensorboardTimeSeriesRequest {
}
];
- // Optional. The user specified unique ID to use for the TensorboardTimeSeries, which
- // will become the final component of the TensorboardTimeSeries's resource
- // name.
- // This value should match "[a-z0-9][a-z0-9-]{0, 127}"
- string tensorboard_time_series_id = 3 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. The user specified unique ID to use for the
+ // TensorboardTimeSeries, which becomes the final component of the
+ // TensorboardTimeSeries's resource name. This value should match
+ // "[a-z0-9][a-z0-9-]{0, 127}"
+ string tensorboard_time_series_id = 3
+ [(google.api.field_behavior) = OPTIONAL];
// Required. The TensorboardTimeSeries to create.
- TensorboardTimeSeries tensorboard_time_series = 2 [(google.api.field_behavior) = REQUIRED];
+ TensorboardTimeSeries tensorboard_time_series = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.GetTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.GetTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardTimeSeries].
message GetTensorboardTimeSeriesRequest {
// Required. The name of the TensorboardTimeSeries resource.
// Format:
@@ -763,10 +874,11 @@ message GetTensorboardTimeSeriesRequest {
];
}
-// Request message for [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries].
message ListTensorboardTimeSeriesRequest {
- // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries.
- // Format:
+ // Required. The resource name of the TensorboardRun to list
+ // TensorboardTimeSeries. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -780,17 +892,17 @@ message ListTensorboardTimeSeriesRequest {
// The maximum number of TensorboardTimeSeries to return. The service may
// return fewer than this value. If unspecified, at most 50
- // TensorboardTimeSeries will be returned. The maximum value is 1000; values
- // above 1000 will be coerced to 1000.
+ // TensorboardTimeSeries are returned. The maximum value is 1000; values
+ // above 1000 are coerced to 1000.
int32 page_size = 3;
// A page token, received from a previous
- // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries] call.
- // Provide this to retrieve the subsequent page.
+ // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries] must
- // match the call that provided the page token.
+ // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries]
+ // must match the call that provided the page token.
string page_token = 4;
// Field to use to sort the list.
@@ -800,35 +912,41 @@ message ListTensorboardTimeSeriesRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries].
+// Response message for
+// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries].
message ListTensorboardTimeSeriesResponse {
// The TensorboardTimeSeries mathching the request.
repeated TensorboardTimeSeries tensorboard_time_series = 1;
// A token, which can be sent as
- // [ListTensorboardTimeSeriesRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardTimeSeriesRequest.page_token] to retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // [ListTensorboardTimeSeriesRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardTimeSeriesRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [TensorboardService.UpdateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.UpdateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardTimeSeries].
message UpdateTensorboardTimeSeriesRequest {
// Required. Field mask is used to specify the fields to be overwritten in the
// TensorboardTimeSeries resource by the update.
// The fields specified in the update_mask are relative to the resource, not
- // the full request. A field will be overwritten if it is in the mask. If the
- // user does not provide a mask then all fields will be overwritten if new
+ // the full request. A field is overwritten if it's in the mask. If the
+ // user does not provide a mask then all fields are overwritten if new
// values are specified.
- google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = REQUIRED];
// Required. The TensorboardTimeSeries' `name` field is used to identify the
// TensorboardTimeSeries to be updated.
// Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
- TensorboardTimeSeries tensorboard_time_series = 2 [(google.api.field_behavior) = REQUIRED];
+ TensorboardTimeSeries tensorboard_time_series = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.DeleteTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.DeleteTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardTimeSeries].
message DeleteTensorboardTimeSeriesRequest {
// Required. The name of the TensorboardTimeSeries to be deleted.
// Format:
@@ -844,11 +962,12 @@ message DeleteTensorboardTimeSeriesRequest {
// Request message for
// [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData].
message BatchReadTensorboardTimeSeriesDataRequest {
- // Required. The resource name of the Tensorboard containing TensorboardTimeSeries to
- // read data from. Format:
+ // Required. The resource name of the Tensorboard containing
+ // TensorboardTimeSeries to read data from. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`.
- // The TensorboardTimeSeries referenced by [time_series][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series] must be sub
- // resources of this Tensorboard.
+ // The TensorboardTimeSeries referenced by
+ // [time_series][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series]
+ // must be sub resources of this Tensorboard.
string tensorboard = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -856,7 +975,8 @@ message BatchReadTensorboardTimeSeriesDataRequest {
}
];
- // Required. The resource names of the TensorboardTimeSeries to read data from. Format:
+ // Required. The resource names of the TensorboardTimeSeries to read data
+ // from. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
repeated string time_series = 2 [
(google.api.field_behavior) = REQUIRED,
@@ -873,7 +993,8 @@ message BatchReadTensorboardTimeSeriesDataResponse {
repeated TimeSeriesData time_series_data = 1;
}
-// Request message for [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData].
+// Request message for
+// [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData].
message ReadTensorboardTimeSeriesDataRequest {
// Required. The resource name of the TensorboardTimeSeries to read data from.
// Format:
@@ -895,13 +1016,15 @@ message ReadTensorboardTimeSeriesDataRequest {
string filter = 3;
}
-// Response message for [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData].
+// Response message for
+// [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData].
message ReadTensorboardTimeSeriesDataResponse {
// The returned time series data.
TimeSeriesData time_series_data = 1;
}
-// Request message for [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData].
+// Request message for
+// [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData].
message WriteTensorboardExperimentDataRequest {
// Required. The resource name of the TensorboardExperiment to write data to.
// Format:
@@ -914,15 +1037,16 @@ message WriteTensorboardExperimentDataRequest {
];
// Required. Requests containing per-run TensorboardTimeSeries data to write.
- repeated WriteTensorboardRunDataRequest write_run_data_requests = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated WriteTensorboardRunDataRequest write_run_data_requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData].
-message WriteTensorboardExperimentDataResponse {
-
-}
+// Response message for
+// [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData].
+message WriteTensorboardExperimentDataResponse {}
-// Request message for [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData].
+// Request message for
+// [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData].
message WriteTensorboardRunDataRequest {
// Required. The resource name of the TensorboardRun to write data to.
// Format:
@@ -939,18 +1063,19 @@ message WriteTensorboardRunDataRequest {
// Repeated writes to the same step will overwrite the existing value for that
// step.
// The upper limit of data points per write request is 5000.
- repeated TimeSeriesData time_series_data = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated TimeSeriesData time_series_data = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData].
-message WriteTensorboardRunDataResponse {
-
-}
+// Response message for
+// [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData].
+message WriteTensorboardRunDataResponse {}
-// Request message for [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData].
+// Request message for
+// [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData].
message ExportTensorboardTimeSeriesDataRequest {
- // Required. The resource name of the TensorboardTimeSeries to export data from.
- // Format:
+ // Required. The resource name of the TensorboardTimeSeries to export data
+ // from. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
string tensorboard_time_series = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -963,8 +1088,8 @@ message ExportTensorboardTimeSeriesDataRequest {
string filter = 2;
// The maximum number of data points to return per page.
- // The default page_size will be 1000. Values must be between 1 and 10000.
- // Values above 10000 will be coerced to 10000.
+ // The default page_size is 1000. Values must be between 1 and 10000.
+ // Values above 10000 are coerced to 10000.
int32 page_size = 3;
// A page token, received from a previous
@@ -977,12 +1102,13 @@ message ExportTensorboardTimeSeriesDataRequest {
string page_token = 4;
// Field to use to sort the TensorboardTimeSeries' data.
- // By default, TensorboardTimeSeries' data will be returned in a pseudo random
+ // By default, TensorboardTimeSeries' data is returned in a pseudo random
// order.
string order_by = 5;
}
-// Response message for [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData].
+// Response message for
+// [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData].
message ExportTensorboardTimeSeriesDataResponse {
// The returned time series data points.
repeated TimeSeriesDataPoint time_series_data_points = 1;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_time_series.proto b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_time_series.proto
index eff288e5d..e09648af3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_time_series.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/tensorboard_time_series.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardTimeSeriesProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -37,16 +37,19 @@ message TensorboardTimeSeries {
// Describes metadata for a TensorboardTimeSeries.
message Metadata {
- // Output only. Max step index of all data points within a TensorboardTimeSeries.
+ // Output only. Max step index of all data points within a
+ // TensorboardTimeSeries.
int64 max_step = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Max wall clock timestamp of all data points within a
// TensorboardTimeSeries.
- google.protobuf.Timestamp max_wall_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp max_wall_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The largest blob sequence length (number of blobs) of all data points in
- // this time series, if its ValueType is BLOB_SEQUENCE.
- int64 max_blob_sequence_length = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The largest blob sequence length (number of blobs) of all
+ // data points in this time series, if its ValueType is BLOB_SEQUENCE.
+ int64 max_blob_sequence_length = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// An enum representing the value type of a TensorboardTimeSeries.
@@ -85,22 +88,25 @@ message TensorboardTimeSeries {
];
// Output only. Timestamp when this TensorboardTimeSeries was created.
- google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this TensorboardTimeSeries was last updated.
- google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Used to perform a consistent read-modify-write updates. If not set, a blind
// "overwrite" update happens.
string etag = 7;
- // Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor,
- // Blob
+ // Immutable. Name of the plugin this time series pertain to. Such as Scalar,
+ // Tensor, Blob
string plugin_name = 8 [(google.api.field_behavior) = IMMUTABLE];
// Data of the current plugin, with the size limited to 65KB.
bytes plugin_data = 9;
- // Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
+ // Output only. Scalar, Tensor, or Blob metadata for this
+ // TensorboardTimeSeries.
Metadata metadata = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/training_pipeline.proto b/third_party/googleapis/google/cloud/aiplatform/v1/training_pipeline.proto
index ef5f35398..10d96e557 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/training_pipeline.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/training_pipeline.proto
@@ -27,7 +27,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TrainingPipelineProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -37,8 +37,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// The TrainingPipeline orchestrates tasks associated with training a Model. It
// always executes the training task, and optionally may also
// export data from Vertex AI's Dataset which becomes the training input,
-// [upload][google.cloud.aiplatform.v1.ModelService.UploadModel] the Model to Vertex AI, and evaluate the
-// Model.
+// [upload][google.cloud.aiplatform.v1.ModelService.UploadModel] the Model to
+// Vertex AI, and evaluate the Model.
message TrainingPipeline {
option (google.api.resource) = {
type: "aiplatform.googleapis.com/TrainingPipeline"
@@ -52,17 +52,20 @@ message TrainingPipeline {
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
// Specifies Vertex AI owned input data that may be used for training the
- // Model. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition] should make
- // clear whether this config is used and if there are any special requirements
- // on how it should be filled. If nothing about this config is mentioned in
- // the [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition], then it should be assumed that the
- // TrainingPipeline does not depend on this configuration.
+ // Model. The TrainingPipeline's
+ // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]
+ // should make clear whether this config is used and if there are any special
+ // requirements on how it should be filled. If nothing about this config is
+ // mentioned in the
+ // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition],
+ // then it should be assumed that the TrainingPipeline does not depend on this
+ // configuration.
InputDataConfig input_data_config = 3;
- // Required. A Google Cloud Storage path to the YAML file that defines the training task
- // which is responsible for producing the model artifact, and may also include
- // additional auxiliary work.
- // The definition files that can be used here are found in
+ // Required. A Google Cloud Storage path to the YAML file that defines the
+ // training task which is responsible for producing the model artifact, and
+ // may also include additional auxiliary work. The definition files that can
+ // be used here are found in
// gs://google-cloud-aiplatform/schema/trainingjob/definition/.
// Note: The URI given on output will be immutable and probably different,
// including the URI scheme, than the one given on input. The output URI will
@@ -70,30 +73,38 @@ message TrainingPipeline {
string training_task_definition = 4 [(google.api.field_behavior) = REQUIRED];
// Required. The training task's parameter(s), as specified in the
- // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s `inputs`.
- google.protobuf.Value training_task_inputs = 5 [(google.api.field_behavior) = REQUIRED];
+ // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s
+ // `inputs`.
+ google.protobuf.Value training_task_inputs = 5
+ [(google.api.field_behavior) = REQUIRED];
- // Output only. The metadata information as specified in the [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s
+ // Output only. The metadata information as specified in the
+ // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s
// `metadata`. This metadata is an auxiliary runtime and final information
// about the training task. While the pipeline is running this information is
// populated only at a best effort basis. Only present if the
- // pipeline's [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition] contains `metadata` object.
- google.protobuf.Value training_task_metadata = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel])
+ // pipeline's
+ // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]
+ // contains `metadata` object.
+ google.protobuf.Value training_task_metadata = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Describes the Model that may be uploaded (via
+ // [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel])
// by this TrainingPipeline. The TrainingPipeline's
- // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition] should make clear whether this Model
- // description should be populated, and if there are any special requirements
- // regarding how it should be filled. If nothing is mentioned in the
- // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition], then it should be assumed that this field
- // should not be filled and the training task either uploads the Model without
- // a need of this information, or that training task does not support
- // uploading a Model as part of the pipeline.
- // When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and
+ // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]
+ // should make clear whether this Model description should be populated, and
+ // if there are any special requirements regarding how it should be filled. If
+ // nothing is mentioned in the
+ // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition],
+ // then it should be assumed that this field should not be filled and the
+ // training task either uploads the Model without a need of this information,
+ // or that training task does not support uploading a Model as part of the
+ // pipeline. When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and
// the trained Model had been uploaded into Vertex AI, then the
- // model_to_upload's resource [name][google.cloud.aiplatform.v1.Model.name] is populated. The Model
- // is always uploaded into the Project and Location in which this pipeline
- // is.
+ // model_to_upload's resource [name][google.cloud.aiplatform.v1.Model.name] is
+ // populated. The Model is always uploaded into the Project and Location in
+ // which this pipeline is.
Model model_to_upload = 7;
// Optional. The ID to use for the uploaded Model, which will become the final
@@ -103,31 +114,36 @@ message TrainingPipeline {
// `[a-z0-9_-]`. The first character cannot be a number or hyphen.
string model_id = 22 [(google.api.field_behavior) = OPTIONAL];
- // Optional. When specify this field, the `model_to_upload` will not be uploaded as a
- // new model, instead, it will become a new version of this `parent_model`.
+ // Optional. When specify this field, the `model_to_upload` will not be
+ // uploaded as a new model, instead, it will become a new version of this
+ // `parent_model`.
string parent_model = 21 [(google.api.field_behavior) = OPTIONAL];
// Output only. The detailed state of the pipeline.
PipelineState state = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Only populated when the pipeline's state is `PIPELINE_STATE_FAILED` or
- // `PIPELINE_STATE_CANCELLED`.
+ // Output only. Only populated when the pipeline's state is
+ // `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
google.rpc.Status error = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the TrainingPipeline was created.
- google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the TrainingPipeline for the first time entered the
// `PIPELINE_STATE_RUNNING` state.
- google.protobuf.Timestamp start_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Time when the TrainingPipeline entered any of the following states:
- // `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`,
+ // Output only. Time when the TrainingPipeline entered any of the following
+ // states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`,
// `PIPELINE_STATE_CANCELLED`.
- google.protobuf.Timestamp end_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the TrainingPipeline was most recently updated.
- google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize TrainingPipelines.
//
@@ -142,7 +158,8 @@ message TrainingPipeline {
// TrainingPipeline will be secured by this key.
//
// Note: Model trained by this TrainingPipeline is also secured by this key if
- // [model_to_upload][google.cloud.aiplatform.v1.TrainingPipeline.encryption_spec] is not set separately.
+ // [model_to_upload][google.cloud.aiplatform.v1.TrainingPipeline.encryption_spec]
+ // is not set separately.
EncryptionSpec encryption_spec = 18;
}
@@ -151,7 +168,9 @@ message TrainingPipeline {
message InputDataConfig {
// The instructions how the input data should be split between the
// training, validation and test sets.
- // If no split type is provided, the [fraction_split][google.cloud.aiplatform.v1.InputDataConfig.fraction_split] is used by default.
+ // If no split type is provided, the
+ // [fraction_split][google.cloud.aiplatform.v1.InputDataConfig.fraction_split]
+ // is used by default.
oneof split {
// Split based on fractions defining the size of each set.
FractionSplit fraction_split = 2;
@@ -235,9 +254,9 @@ message InputDataConfig {
BigQueryDestination bigquery_destination = 10;
}
- // Required. The ID of the Dataset in the same Project and Location which data will be
- // used to train the Model. The Dataset must use schema compatible with
- // Model being trained, and what is compatible should be described in the
+ // Required. The ID of the Dataset in the same Project and Location which data
+ // will be used to train the Model. The Dataset must use schema compatible
+ // with Model being trained, and what is compatible should be described in the
// used TrainingPipeline's [training_task_definition]
// [google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition].
// For tabular Datasets, all their data is exported to training, to pick
@@ -251,9 +270,9 @@ message InputDataConfig {
// are used in respectively training, validation or test role, depending on
// the role of the DataItem they are on (for the auto-assigned that role is
// decided by Vertex AI). A filter with same syntax as the one used in
- // [ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations] may be used, but note
- // here it filters across all Annotations of the Dataset, and not just within
- // a single DataItem.
+ // [ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations]
+ // may be used, but note here it filters across all Annotations of the
+ // Dataset, and not just within a single DataItem.
string annotations_filter = 6;
// Applicable only to custom training with Datasets that have DataItems and
@@ -265,30 +284,41 @@ message InputDataConfig {
// The schema files that can be used here are found in
// gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the
// chosen schema must be consistent with
- // [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the Dataset specified by
+ // [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the
+ // Dataset specified by
// [dataset_id][google.cloud.aiplatform.v1.InputDataConfig.dataset_id].
//
// Only Annotations that both match this schema and belong to DataItems not
// ignored by the split method are used in respectively training, validation
// or test role, depending on the role of the DataItem they are on.
//
- // When used in conjunction with [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter], the Annotations used
- // for training are filtered by both [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter] and
+ // When used in conjunction with
+ // [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter],
+ // the Annotations used for training are filtered by both
+ // [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter]
+ // and
// [annotation_schema_uri][google.cloud.aiplatform.v1.InputDataConfig.annotation_schema_uri].
string annotation_schema_uri = 9;
// Only applicable to Datasets that have SavedQueries.
//
// The ID of a SavedQuery (annotation set) under the Dataset specified by
- // [dataset_id][google.cloud.aiplatform.v1.InputDataConfig.dataset_id] used for filtering Annotations for training.
+ // [dataset_id][google.cloud.aiplatform.v1.InputDataConfig.dataset_id] used
+ // for filtering Annotations for training.
//
// Only Annotations that are associated with this SavedQuery are used in
// respectively training. When used in conjunction with
- // [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter], the Annotations used for training are filtered by
- // both [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id] and [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter].
+ // [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter],
+ // the Annotations used for training are filtered by both
+ // [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id]
+ // and
+ // [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter].
//
- // Only one of [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id] and [annotation_schema_uri][google.cloud.aiplatform.v1.InputDataConfig.annotation_schema_uri] should be
- // specified as both of them represent the same thing: problem type.
+ // Only one of
+ // [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id]
+ // and
+ // [annotation_schema_uri][google.cloud.aiplatform.v1.InputDataConfig.annotation_schema_uri]
+ // should be specified as both of them represent the same thing: problem type.
string saved_query_id = 7;
// Whether to persist the ML use assignment to data item system labels.
@@ -323,26 +353,29 @@ message FractionSplit {
message FilterSplit {
// Required. A filter on DataItems of the Dataset. DataItems that match
// this filter are used to train the Model. A filter with same syntax
- // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems] may be used. If a
- // single DataItem is matched by more than one of the FilterSplit filters,
- // then it is assigned to the first set that applies to it in the
- // training, validation, test order.
+ // as the one used in
+ // [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
+ // may be used. If a single DataItem is matched by more than one of the
+ // FilterSplit filters, then it is assigned to the first set that applies to
+ // it in the training, validation, test order.
string training_filter = 1 [(google.api.field_behavior) = REQUIRED];
// Required. A filter on DataItems of the Dataset. DataItems that match
// this filter are used to validate the Model. A filter with same syntax
- // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems] may be used. If a
- // single DataItem is matched by more than one of the FilterSplit filters,
- // then it is assigned to the first set that applies to it in the
- // training, validation, test order.
+ // as the one used in
+ // [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
+ // may be used. If a single DataItem is matched by more than one of the
+ // FilterSplit filters, then it is assigned to the first set that applies to
+ // it in the training, validation, test order.
string validation_filter = 2 [(google.api.field_behavior) = REQUIRED];
// Required. A filter on DataItems of the Dataset. DataItems that match
// this filter are used to test the Model. A filter with same syntax
- // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems] may be used. If a
- // single DataItem is matched by more than one of the FilterSplit filters,
- // then it is assigned to the first set that applies to it in the
- // training, validation, test order.
+ // as the one used in
+ // [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]
+ // may be used. If a single DataItem is matched by more than one of the
+ // FilterSplit filters, then it is assigned to the first set that applies to
+ // it in the training, validation, test order.
string test_filter = 3 [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/types.proto b/third_party/googleapis/google/cloud/aiplatform/v1/types.proto
index 095b73c11..c724b8ec2 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/types.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/types.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TypesProto";
option java_package = "com.google.cloud.aiplatform.v1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/unmanaged_container_model.proto b/third_party/googleapis/google/cloud/aiplatform/v1/unmanaged_container_model.proto
index 62e3e459c..de9b6ccf7 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/unmanaged_container_model.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/unmanaged_container_model.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/cloud/aiplatform/v1/model.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "UnmanagedContainerModelProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -37,7 +37,8 @@ message UnmanagedContainerModel {
// Contains the schemata used in Model's predictions and explanations
PredictSchemata predict_schemata = 2;
- // Input only. The specification of the container that is to be used when deploying
- // this Model.
- ModelContainerSpec container_spec = 3 [(google.api.field_behavior) = INPUT_ONLY];
+ // Input only. The specification of the container that is to be used when
+ // deploying this Model.
+ ModelContainerSpec container_spec = 3
+ [(google.api.field_behavior) = INPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/user_action_reference.proto b/third_party/googleapis/google/cloud/aiplatform/v1/user_action_reference.proto
index 102dac6d4..25c503977 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/user_action_reference.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/user_action_reference.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "UserActionReferenceProto";
option java_package = "com.google.cloud.aiplatform.v1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/value.proto b/third_party/googleapis/google/cloud/aiplatform/v1/value.proto
index e8ab58538..8b52968d8 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/value.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/value.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ValueProto";
option java_package = "com.google.cloud.aiplatform.v1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1/vizier_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1/vizier_service.proto
index 70cc7a7a2..e3b467f18 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1/vizier_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1/vizier_service.proto
@@ -27,7 +27,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "VizierServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
@@ -41,7 +41,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
// learning architectures.
service VizierService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a Study. A resource name will be generated after creation of the
// Study.
@@ -92,7 +93,8 @@ service VizierService {
// operation associated with the generation of Trial suggestions.
// When this long-running operation succeeds, it will contain
// a [SuggestTrialsResponse][google.cloud.ml.v1.SuggestTrialsResponse].
- rpc SuggestTrials(SuggestTrialsRequest) returns (google.longrunning.Operation) {
+ rpc SuggestTrials(SuggestTrialsRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/studies/*}/trials:suggest"
body: "*"
@@ -156,8 +158,9 @@ service VizierService {
// Checks whether a Trial should stop or not. Returns a
// long-running operation. When the operation is successful,
// it will contain a
- // [CheckTrialEarlyStoppingStateResponse][google.cloud.ml.v1.CheckTrialEarlyStoppingStateResponse].
- rpc CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest) returns (google.longrunning.Operation) {
+ // [CheckTrialEarlyStoppingStateResponse][google.cloud.aiplatform.v1.CheckTrialEarlyStoppingStateResponse].
+ rpc CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{trial_name=projects/*/locations/*/studies/*/trials/*}:checkTrialEarlyStoppingState"
body: "*"
@@ -180,7 +183,8 @@ service VizierService {
// optimal Trials for single-objective Study. The definition of
// pareto-optimal can be checked in wiki page.
// https://en.wikipedia.org/wiki/Pareto_efficiency
- rpc ListOptimalTrials(ListOptimalTrialsRequest) returns (ListOptimalTrialsResponse) {
+ rpc ListOptimalTrials(ListOptimalTrialsRequest)
+ returns (ListOptimalTrialsResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/studies/*}/trials:listOptimalTrials"
body: "*"
@@ -189,7 +193,8 @@ service VizierService {
}
}
-// Request message for [VizierService.GetStudy][google.cloud.aiplatform.v1.VizierService.GetStudy].
+// Request message for
+// [VizierService.GetStudy][google.cloud.aiplatform.v1.VizierService.GetStudy].
message GetStudyRequest {
// Required. The name of the Study resource.
// Format: `projects/{project}/locations/{location}/studies/{study}`
@@ -201,7 +206,8 @@ message GetStudyRequest {
];
}
-// Request message for [VizierService.CreateStudy][google.cloud.aiplatform.v1.VizierService.CreateStudy].
+// Request message for
+// [VizierService.CreateStudy][google.cloud.aiplatform.v1.VizierService.CreateStudy].
message CreateStudyRequest {
// Required. The resource name of the Location to create the CustomJob in.
// Format: `projects/{project}/locations/{location}`
@@ -216,7 +222,8 @@ message CreateStudyRequest {
Study study = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies].
+// Request message for
+// [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies].
message ListStudiesRequest {
// Required. The resource name of the Location to list the Study from.
// Format: `projects/{project}/locations/{location}`
@@ -236,7 +243,8 @@ message ListStudiesRequest {
int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies].
+// Response message for
+// [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies].
message ListStudiesResponse {
// The studies associated with the project.
repeated Study studies = 1;
@@ -247,7 +255,8 @@ message ListStudiesResponse {
string next_page_token = 2;
}
-// Request message for [VizierService.DeleteStudy][google.cloud.aiplatform.v1.VizierService.DeleteStudy].
+// Request message for
+// [VizierService.DeleteStudy][google.cloud.aiplatform.v1.VizierService.DeleteStudy].
message DeleteStudyRequest {
// Required. The name of the Study resource to be deleted.
// Format: `projects/{project}/locations/{location}/studies/{study}`
@@ -259,7 +268,8 @@ message DeleteStudyRequest {
];
}
-// Request message for [VizierService.LookupStudy][google.cloud.aiplatform.v1.VizierService.LookupStudy].
+// Request message for
+// [VizierService.LookupStudy][google.cloud.aiplatform.v1.VizierService.LookupStudy].
message LookupStudyRequest {
// Required. The resource name of the Location to get the Study from.
// Format: `projects/{project}/locations/{location}`
@@ -274,7 +284,8 @@ message LookupStudyRequest {
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials].
+// Request message for
+// [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials].
message SuggestTrialsRequest {
// Required. The project and location that the Study belongs to.
// Format: `projects/{project}/locations/{location}/studies/{study}`
@@ -296,7 +307,8 @@ message SuggestTrialsRequest {
string client_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials].
+// Response message for
+// [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials].
message SuggestTrialsResponse {
// A list of Trials.
repeated Trial trials = 1;
@@ -324,7 +336,8 @@ message SuggestTrialsMetadata {
string client_id = 2;
}
-// Request message for [VizierService.CreateTrial][google.cloud.aiplatform.v1.VizierService.CreateTrial].
+// Request message for
+// [VizierService.CreateTrial][google.cloud.aiplatform.v1.VizierService.CreateTrial].
message CreateTrialRequest {
// Required. The resource name of the Study to create the Trial in.
// Format: `projects/{project}/locations/{location}/studies/{study}`
@@ -339,7 +352,8 @@ message CreateTrialRequest {
Trial trial = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [VizierService.GetTrial][google.cloud.aiplatform.v1.VizierService.GetTrial].
+// Request message for
+// [VizierService.GetTrial][google.cloud.aiplatform.v1.VizierService.GetTrial].
message GetTrialRequest {
// Required. The name of the Trial resource.
// Format:
@@ -352,7 +366,8 @@ message GetTrialRequest {
];
}
-// Request message for [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials].
+// Request message for
+// [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials].
message ListTrialsRequest {
// Required. The resource name of the Study to list the Trial from.
// Format: `projects/{project}/locations/{location}/studies/{study}`
@@ -372,7 +387,8 @@ message ListTrialsRequest {
int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials].
+// Response message for
+// [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials].
message ListTrialsResponse {
// The Trials associated with the Study.
repeated Trial trials = 1;
@@ -383,7 +399,8 @@ message ListTrialsResponse {
string next_page_token = 2;
}
-// Request message for [VizierService.AddTrialMeasurement][google.cloud.aiplatform.v1.VizierService.AddTrialMeasurement].
+// Request message for
+// [VizierService.AddTrialMeasurement][google.cloud.aiplatform.v1.VizierService.AddTrialMeasurement].
message AddTrialMeasurementRequest {
// Required. The name of the trial to add measurement.
// Format:
@@ -399,7 +416,8 @@ message AddTrialMeasurementRequest {
Measurement measurement = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [VizierService.CompleteTrial][google.cloud.aiplatform.v1.VizierService.CompleteTrial].
+// Request message for
+// [VizierService.CompleteTrial][google.cloud.aiplatform.v1.VizierService.CompleteTrial].
message CompleteTrialRequest {
// Required. The Trial's name.
// Format:
@@ -425,7 +443,8 @@ message CompleteTrialRequest {
string infeasible_reason = 4 [(google.api.field_behavior) = OPTIONAL];
}
-// Request message for [VizierService.DeleteTrial][google.cloud.aiplatform.v1.VizierService.DeleteTrial].
+// Request message for
+// [VizierService.DeleteTrial][google.cloud.aiplatform.v1.VizierService.DeleteTrial].
message DeleteTrialRequest {
// Required. The Trial's name.
// Format:
@@ -438,7 +457,8 @@ message DeleteTrialRequest {
];
}
-// Request message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState].
+// Request message for
+// [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState].
message CheckTrialEarlyStoppingStateRequest {
// Required. The Trial's name.
// Format:
@@ -451,7 +471,8 @@ message CheckTrialEarlyStoppingStateRequest {
];
}
-// Response message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState].
+// Response message for
+// [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState].
message CheckTrialEarlyStoppingStateResponse {
// True if the Trial should stop.
bool should_stop = 1;
@@ -471,7 +492,8 @@ message CheckTrialEarlyStoppingStateMetatdata {
string trial = 3;
}
-// Request message for [VizierService.StopTrial][google.cloud.aiplatform.v1.VizierService.StopTrial].
+// Request message for
+// [VizierService.StopTrial][google.cloud.aiplatform.v1.VizierService.StopTrial].
message StopTrialRequest {
// Required. The Trial's name.
// Format:
@@ -484,7 +506,8 @@ message StopTrialRequest {
];
}
-// Request message for [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials].
+// Request message for
+// [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials].
message ListOptimalTrialsRequest {
// Required. The name of the Study that the optimal Trial belongs to.
string parent = 1 [
@@ -495,7 +518,8 @@ message ListOptimalTrialsRequest {
];
}
-// Response message for [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials].
+// Response message for
+// [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials].
message ListOptimalTrialsResponse {
// The pareto-optimal Trials for multiple objective Study or the
// optimal trial for single objective Study. The definition of
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/v1beta1/BUILD.bazel
index 53fa404f9..75f22c6ee 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/BUILD.bazel
@@ -42,6 +42,7 @@ proto_library(
"endpoint_service.proto",
"entity_type.proto",
"env_var.proto",
+ "evaluated_annotation.proto",
"event.proto",
"execution.proto",
"explanation.proto",
@@ -64,6 +65,7 @@ proto_library(
"lineage_subgraph.proto",
"machine_resources.proto",
"manual_batch_tuning_parameters.proto",
+ "match_service.proto",
"metadata_schema.proto",
"metadata_service.proto",
"metadata_store.proto",
@@ -75,6 +77,7 @@ proto_library(
"model_evaluation_slice.proto",
"model_monitoring.proto",
"model_service.proto",
+ "nas_job.proto",
"operation.proto",
"pipeline_failure_policy.proto",
"pipeline_job.proto",
@@ -82,6 +85,7 @@ proto_library(
"pipeline_state.proto",
"prediction_service.proto",
"saved_query.proto",
+ "service_networking.proto",
"specialist_pool.proto",
"specialist_pool_service.proto",
"study.proto",
@@ -233,7 +237,7 @@ load(
go_proto_library(
name = "aiplatform_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1",
+ importpath = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb",
protos = [":aiplatform_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -251,6 +255,7 @@ go_gapic_library(
grpc_service_config = "aiplatform_grpc_service_config.json",
importpath = "cloud.google.com/go/aiplatform/apiv1beta1;aiplatform",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = False,
service_yaml = "aiplatform_v1beta1.yaml",
transport = "grpc+rest",
@@ -395,7 +400,7 @@ nodejs_gapic_library(
package = "google.cloud.aiplatform.v1beta1",
rest_numeric_enums = False,
service_yaml = "aiplatform_v1beta1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
@@ -435,6 +440,7 @@ ruby_cloud_gapic_library(
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-aiplatform-v1beta1"],
grpc_service_config = "aiplatform_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "aiplatform_v1beta1.yaml",
deps = [
":aiplatform_ruby_grpc",
":aiplatform_ruby_proto",
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/accelerator_type.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/accelerator_type.proto
index 4d4c3b8f0..5587dc99f 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/accelerator_type.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/accelerator_type.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1beta1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "AcceleratorTypeProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -25,6 +25,7 @@ option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Represents a hardware accelerator type.
+// NEXT ID: 11.
enum AcceleratorType {
// Unspecified accelerator type, which means no accelerator.
ACCELERATOR_TYPE_UNSPECIFIED = 0;
@@ -55,4 +56,7 @@ enum AcceleratorType {
// TPU v3.
TPU_V3 = 7;
+
+ // TPU v4.
+ TPU_V4_POD = 10;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml b/third_party/googleapis/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml
index 41fce9d80..08cd8bcfb 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml
@@ -12,6 +12,7 @@ apis:
- name: google.cloud.aiplatform.v1beta1.IndexEndpointService
- name: google.cloud.aiplatform.v1beta1.IndexService
- name: google.cloud.aiplatform.v1beta1.JobService
+- name: google.cloud.aiplatform.v1beta1.MatchService
- name: google.cloud.aiplatform.v1beta1.MetadataService
- name: google.cloud.aiplatform.v1beta1.MigrationService
- name: google.cloud.aiplatform.v1beta1.ModelService
@@ -33,6 +34,8 @@ types:
- name: google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesResponse
- name: google.cloud.aiplatform.v1beta1.CheckTrialEarlyStoppingStateMetatdata
- name: google.cloud.aiplatform.v1beta1.CheckTrialEarlyStoppingStateResponse
+- name: google.cloud.aiplatform.v1beta1.CopyModelOperationMetadata
+- name: google.cloud.aiplatform.v1beta1.CopyModelResponse
- name: google.cloud.aiplatform.v1beta1.CreateDatasetOperationMetadata
- name: google.cloud.aiplatform.v1beta1.CreateDeploymentResourcePoolOperationMetadata
- name: google.cloud.aiplatform.v1beta1.CreateEndpointOperationMetadata
@@ -143,6 +146,10 @@ backend:
deadline: 60.0
- selector: 'google.cloud.aiplatform.v1beta1.JobService.*'
deadline: 60.0
+ - selector: google.cloud.aiplatform.v1beta1.MatchService.FindNeighbors
+ deadline: 30.0
+ - selector: google.cloud.aiplatform.v1beta1.MatchService.ReadIndexDatapoints
+ deadline: 30.0
- selector: 'google.cloud.aiplatform.v1beta1.MetadataService.*'
deadline: 60.0
- selector: google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources
@@ -231,6 +238,7 @@ http:
- post: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel'
+ - post: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}:cancel'
- post: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}:cancel'
@@ -295,6 +303,7 @@ http:
- delete: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}'
+ - delete: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}'
- delete: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}'
@@ -360,6 +369,7 @@ http:
- get: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}'
+ - get: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}'
- get: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}'
@@ -424,6 +434,7 @@ http:
- get: '/ui/{name=projects/*/locations/*/studies/*/trials/*}/operations'
- get: '/ui/{name=projects/*/locations/*/trainingPipelines/*}/operations'
- get: '/ui/{name=projects/*/locations/*/pipelineJobs/*}/operations'
+ - get: '/ui/{name=projects/*/locations/*/schedules/*}/operations'
- get: '/ui/{name=projects/*/locations/*/specialistPools/*}/operations'
- get: '/ui/{name=projects/*/locations/*/tensorboards/*}/operations'
- get: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*}/operations'
@@ -488,6 +499,7 @@ http:
- post: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait'
+ - post: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}:wait'
- post: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}:wait'
@@ -560,6 +572,19 @@ authentication:
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
+ - selector: google.cloud.aiplatform.v1beta1.JobService.GetNasJob
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform,
+ https://www.googleapis.com/auth/cloud-platform.read-only
+ - selector: google.cloud.aiplatform.v1beta1.MatchService.FindNeighbors
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: google.cloud.aiplatform.v1beta1.MatchService.ReadIndexDatapoints
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
- selector: 'google.cloud.aiplatform.v1beta1.MetadataService.*'
oauth:
canonical_scopes: |-
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/annotation.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/annotation.proto
index e57ab445a..4723c8a34 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/annotation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/annotation.proto
@@ -23,7 +23,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "AnnotationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -41,8 +41,9 @@ message Annotation {
// Output only. Resource name of the Annotation.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. Google Cloud Storage URI points to a YAML file describing [payload][google.cloud.aiplatform.v1beta1.Annotation.payload]. The
- // schema is defined as an [OpenAPI 3.0.2 Schema
+ // Required. Google Cloud Storage URI points to a YAML file describing
+ // [payload][google.cloud.aiplatform.v1beta1.Annotation.payload]. The schema
+ // is defined as an [OpenAPI 3.0.2 Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
// The schema files that can be used here are found in
// gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the
@@ -55,19 +56,23 @@ message Annotation {
google.protobuf.Value payload = 3 [(google.api.field_behavior) = REQUIRED];
// Output only. Timestamp when this Annotation was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Annotation was last updated.
- google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. Used to perform consistent read-modify-write updates. If not set, a blind
- // "overwrite" update happens.
+ // Optional. Used to perform consistent read-modify-write updates. If not set,
+ // a blind "overwrite" update happens.
string etag = 8 [(google.api.field_behavior) = OPTIONAL];
// Output only. The source of the Annotation.
- UserActionReference annotation_source = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ UserActionReference annotation_source = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. The labels with user-defined metadata to organize your Annotations.
+ // Optional. The labels with user-defined metadata to organize your
+ // Annotations.
//
// Label keys and values can be no longer than 64 characters
// (Unicode codepoints), can only contain lowercase letters, numeric
@@ -84,7 +89,8 @@ message Annotation {
// If not set, the Annotation is not visible in the UI.
//
// * "aiplatform.googleapis.com/payload_schema":
- // output only, its value is the [payload_schema's][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri]
+ // output only, its value is the
+ // [payload_schema's][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri]
// title.
map labels = 6 [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/annotation_spec.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/annotation_spec.proto
index bb5738ebc..56b937507 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/annotation_spec.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/annotation_spec.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "AnnotationSpecProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -44,12 +44,14 @@ message AnnotationSpec {
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
// Output only. Timestamp when this AnnotationSpec was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when AnnotationSpec was last updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. Used to perform consistent read-modify-write updates. If not set, a blind
- // "overwrite" update happens.
+ // Optional. Used to perform consistent read-modify-write updates. If not set,
+ // a blind "overwrite" update happens.
string etag = 5 [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/artifact.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/artifact.proto
index daab79bb3..135a42de7 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/artifact.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/artifact.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ArtifactProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -75,10 +75,12 @@ message Artifact {
map labels = 10;
// Output only. Timestamp when this Artifact was created.
- google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Artifact was last updated.
- google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The state of this Artifact. This is a property of the Artifact, and does
// not imply or capture any ongoing process. This property is managed by
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto
index 39b2af831..72599c8fc 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto
@@ -33,26 +33,31 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "BatchPredictionJobProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
-// A job that uses a [Model][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] to produce predictions
-// on multiple [input instances][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. If
-// predictions for significant portion of the instances fail, the job may finish
-// without attempting predictions for all remaining instances.
+// A job that uses a
+// [Model][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] to produce
+// predictions on multiple [input
+// instances][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config].
+// If predictions for significant portion of the instances fail, the job may
+// finish without attempting predictions for all remaining instances.
message BatchPredictionJob {
option (google.api.resource) = {
type: "aiplatform.googleapis.com/BatchPredictionJob"
pattern: "projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}"
};
- // Configures the input to [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
- // See [Model.supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats] for Model's supported input
- // formats, and how instances should be expressed via any of them.
+ // Configures the input to
+ // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
+ // See
+ // [Model.supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats]
+ // for Model's supported input formats, and how instances should be expressed
+ // via any of them.
message InputConfig {
// Required. The source of the input.
oneof source {
@@ -78,7 +83,8 @@ message BatchPredictionJob {
message InstanceConfig {
// The format of the instance that the Model accepts. Vertex AI will
// convert compatible
- // [batch prediction input instance formats][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.instances_format]
+ // [batch prediction input instance
+ // formats][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.instances_format]
// to the specified format.
//
// Supported values are:
@@ -92,10 +98,13 @@ message BatchPredictionJob {
// * `array`: Each input is converted to JSON array format.
// * For `bigquery`, each row is converted to an array. The order
// of columns is determined by the BigQuery column order, unless
- // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields] is populated.
- // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields] must be populated for specifying field orders.
+ // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields]
+ // is populated.
+ // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields]
+ // must be populated for specifying field orders.
// * For `jsonl`, if each line of the JSONL input is an object,
- // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields] must be populated for specifying field orders.
+ // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields]
+ // must be populated for specifying field orders.
// * Does not apply to `csv`, `file-list`, `tf-record`, or
// `tf-record-gzip`.
//
@@ -104,7 +113,8 @@ message BatchPredictionJob {
//
// * For `bigquery` and `csv`, the behavior is the same as `array`. The
// order of columns is the same as defined in the file or table, unless
- // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields] is populated.
+ // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields]
+ // is populated.
// * For `jsonl`, the prediction instance format is determined by
// each line of the input.
// * For `tf-record`/`tf-record-gzip`, each record will be converted to
@@ -119,10 +129,11 @@ message BatchPredictionJob {
//
// The values identified by the key field is not included in the transformed
// instances that is sent to the Model. This is similar to
- // specifying this name of the field in [excluded_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.excluded_fields]. In addition,
- // the batch prediction output will not include the instances. Instead the
- // output will only include the value of the key field, in a field named
- // `key` in the output:
+ // specifying this name of the field in
+ // [excluded_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.excluded_fields].
+ // In addition, the batch prediction output will not include the instances.
+ // Instead the output will only include the value of the key field, in a
+ // field named `key` in the output:
//
// * For `jsonl` output format, the output will have a `key` field
// instead of the `instance` field.
@@ -136,10 +147,14 @@ message BatchPredictionJob {
// Fields that will be included in the prediction instance that is
// sent to the Model.
//
- // If [instance_type][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.instance_type] is `array`, the order of field names in
- // included_fields also determines the order of the values in the array.
+ // If
+ // [instance_type][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.instance_type]
+ // is `array`, the order of field names in included_fields also determines
+ // the order of the values in the array.
//
- // When included_fields is populated, [excluded_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.excluded_fields] must be empty.
+ // When included_fields is populated,
+ // [excluded_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.excluded_fields]
+ // must be empty.
//
// The input must be JSONL with objects at each line, CSV, BigQuery
// or TfRecord.
@@ -148,19 +163,25 @@ message BatchPredictionJob {
// Fields that will be excluded in the prediction instance that is
// sent to the Model.
//
- // Excluded will be attached to the batch prediction output if [key_field][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.key_field]
+ // Excluded will be attached to the batch prediction output if
+ // [key_field][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.key_field]
// is not specified.
//
- // When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields] must be empty.
+ // When excluded_fields is populated,
+ // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields]
+ // must be empty.
//
// The input must be JSONL with objects at each line, CSV, BigQuery
// or TfRecord.
repeated string excluded_fields = 4;
}
- // Configures the output of [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
- // See [Model.supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats] for supported output
- // formats, and how predictions are expressed via any of them.
+ // Configures the output of
+ // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
+ // See
+ // [Model.supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats]
+ // for supported output formats, and how predictions are expressed via any of
+ // them.
message OutputConfig {
// Required. The destination of the output.
oneof destination {
@@ -171,11 +192,13 @@ message BatchPredictionJob {
// Inside of it files `predictions_0001.`,
// `predictions_0002.`, ..., `predictions_N.`
// are created where `` depends on chosen
- // [predictions_format][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.predictions_format], and N may equal 0001 and depends on the total
- // number of successfully predicted instances.
- // If the Model has both [instance][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
- // and [prediction][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri] schemata
- // defined then each such file contains predictions as per the
+ // [predictions_format][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.predictions_format],
+ // and N may equal 0001 and depends on the total number of successfully
+ // predicted instances. If the Model has both
+ // [instance][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
+ // and
+ // [prediction][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri]
+ // schemata defined then each such file contains predictions as per the
// [predictions_format][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.predictions_format].
// If prediction for any instance failed (partially or completely), then
// an additional `errors_0001.`, `errors_0002.`,...,
@@ -194,45 +217,52 @@ message BatchPredictionJob {
// become underscores), and timestamp is in
// YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset
// two tables will be created, `predictions`, and `errors`.
- // If the Model has both [instance][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
- // and [prediction][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri] schemata
- // defined then the tables have columns as follows: The `predictions`
- // table contains instances for which the prediction succeeded, it
- // has columns as per a concatenation of the Model's instance and
- // prediction schemata. The `errors` table contains rows for which the
- // prediction has failed, it has instance columns, as per the
+ // If the Model has both
+ // [instance][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
+ // and
+ // [prediction][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri]
+ // schemata defined then the tables have columns as follows: The
+ // `predictions` table contains instances for which the prediction
+ // succeeded, it has columns as per a concatenation of the Model's
+ // instance and prediction schemata. The `errors` table contains rows for
+ // which the prediction has failed, it has instance columns, as per the
// instance schema, followed by a single "errors" column, which as values
// has [google.rpc.Status][google.rpc.Status]
// represented as a STRUCT, and containing only `code` and `message`.
BigQueryDestination bigquery_destination = 3;
}
- // Required. The format in which Vertex AI gives the predictions, must be one of the
+ // Required. The format in which Vertex AI gives the predictions, must be
+ // one of the
// [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
// [supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats].
string predictions_format = 1 [(google.api.field_behavior) = REQUIRED];
}
// Further describes this job's output.
- // Supplements [output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config].
+ // Supplements
+ // [output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config].
message OutputInfo {
// The output location into which prediction output is written.
oneof output_location {
- // Output only. The full path of the Cloud Storage directory created, into which
- // the prediction output is written.
- string gcs_output_directory = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The full path of the Cloud Storage directory created, into
+ // which the prediction output is written.
+ string gcs_output_directory = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The path of the BigQuery dataset created, in
// `bq://projectId.bqDatasetId`
// format, into which the prediction output is written.
- string bigquery_output_dataset = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ string bigquery_output_dataset = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. The name of the BigQuery table created, in
// `predictions_`
// format, into which the prediction output is written.
// Can be used by UI to generate the BigQuery output path, for example.
- string bigquery_output_table = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ string bigquery_output_table = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. Resource name of the BatchPredictionJob.
@@ -248,12 +278,17 @@ message BatchPredictionJob {
// Exactly one of model and unmanaged_container_model must be set.
//
// The model resource name may contain version id or version alias to specify
- // the version, if no version is specified, the default version will be used.
+ // the version.
+ // Example: `projects/{project}/locations/{location}/models/{model}@2`
+ // or
+ // `projects/{project}/locations/{location}/models/{model}@golden`
+ // if no version is specified, the default version will be deployed.
string model = 3 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Model"
- }];
+ type: "aiplatform.googleapis.com/Model"
+ }];
- // Output only. The version ID of the Model that produces the predictions via this job.
+ // Output only. The version ID of the Model that produces the predictions via
+ // this job.
string model_version_id = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
// Contains model information necessary to perform batch prediction without
@@ -261,9 +296,9 @@ message BatchPredictionJob {
// Exactly one of model and unmanaged_container_model must be set.
UnmanagedContainerModel unmanaged_container_model = 28;
- // Required. Input configuration of the instances on which predictions are performed.
- // The schema of any single instance may be specified via
- // the [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
+ // Required. Input configuration of the instances on which predictions are
+ // performed. The schema of any single instance may be specified via the
+ // [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
// [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
InputConfig input_config = 4 [(google.api.field_behavior) = REQUIRED];
@@ -273,7 +308,8 @@ message BatchPredictionJob {
InstanceConfig instance_config = 27;
// The parameters that govern the predictions. The schema of the parameters
- // may be specified via the [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
+ // may be specified via the
+ // [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
// [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
google.protobuf.Value model_parameters = 5;
@@ -289,7 +325,8 @@ message BatchPredictionJob {
OutputConfig output_config = 6 [(google.api.field_behavior) = REQUIRED];
// The config of resources used by the Model during the batch prediction. If
- // the Model [supports][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types]
+ // the Model
+ // [supports][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types]
// DEDICATED_RESOURCES this config may be provided (and the job will use these
// resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config
// must be provided.
@@ -304,35 +341,50 @@ message BatchPredictionJob {
// permission on this service account.
string service_account = 29;
- // Immutable. Parameters configuring the batch behavior. Currently only applicable when
- // [dedicated_resources][google.cloud.aiplatform.v1beta1.BatchPredictionJob.dedicated_resources] are used (in other cases Vertex AI does
- // the tuning itself).
- ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. Parameters configuring the batch behavior. Currently only
+ // applicable when
+ // [dedicated_resources][google.cloud.aiplatform.v1beta1.BatchPredictionJob.dedicated_resources]
+ // are used (in other cases Vertex AI does the tuning itself).
+ ManualBatchTuningParameters manual_batch_tuning_parameters = 8
+ [(google.api.field_behavior) = IMMUTABLE];
// Generate explanation with the batch prediction results.
//
// When set to `true`, the batch prediction output changes based on the
// `predictions_format` field of the
- // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config] object:
+ // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]
+ // object:
//
// * `bigquery`: output includes a column named `explanation`. The value
- // is a struct that conforms to the [Explanation][google.cloud.aiplatform.v1beta1.Explanation] object.
+ // is a struct that conforms to the
+ // [Explanation][google.cloud.aiplatform.v1beta1.Explanation] object.
// * `jsonl`: The JSON objects on each line include an additional entry
// keyed `explanation`. The value of the entry is a JSON object that
- // conforms to the [Explanation][google.cloud.aiplatform.v1beta1.Explanation] object.
+ // conforms to the
+ // [Explanation][google.cloud.aiplatform.v1beta1.Explanation] object.
// * `csv`: Generating explanations for CSV format is not supported.
//
- // If this field is set to true, either the [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] or
- // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] must be populated.
+ // If this field is set to true, either the
+ // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]
+ // or
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
+ // must be populated.
bool generate_explanation = 23;
// Explanation configuration for this BatchPredictionJob. Can be
- // specified only if [generate_explanation][google.cloud.aiplatform.v1beta1.BatchPredictionJob.generate_explanation] is set to `true`.
+ // specified only if
+ // [generate_explanation][google.cloud.aiplatform.v1beta1.BatchPredictionJob.generate_explanation]
+ // is set to `true`.
//
- // This value overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]. All fields of
- // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] are optional in the request. If a field of the
- // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] object is not populated, the corresponding field of
- // the [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] object is inherited.
+ // This value overrides the value of
+ // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec].
+ // All fields of
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
+ // are optional in the request. If a field of the
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
+ // object is not populated, the corresponding field of the
+ // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]
+ // object is inherited.
ExplanationSpec explanation_spec = 25;
// Output only. Information further describing the output of this job.
@@ -349,32 +401,39 @@ message BatchPredictionJob {
// For example, single files that can't be read.
// This field never exceeds 20 entries.
// Status details fields contain standard Google Cloud error details.
- repeated google.rpc.Status partial_failures = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.rpc.Status partial_failures = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Information about resources that had been consumed by this job.
- // Provided in real time at best effort basis, as well as a final value
+ // Output only. Information about resources that had been consumed by this
+ // job. Provided in real time at best effort basis, as well as a final value
// once the job completes.
//
// Note: This field currently may be not populated for batch predictions that
// use AutoML Models.
- ResourcesConsumed resources_consumed = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ ResourcesConsumed resources_consumed = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Statistics on completed and failed prediction instances.
- CompletionStats completion_stats = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ CompletionStats completion_stats = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the BatchPredictionJob was created.
- google.protobuf.Timestamp create_time = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Time when the BatchPredictionJob for the first time entered the
- // `JOB_STATE_RUNNING` state.
- google.protobuf.Timestamp start_time = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Time when the BatchPredictionJob for the first time entered
+ // the `JOB_STATE_RUNNING` state.
+ google.protobuf.Timestamp start_time = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Time when the BatchPredictionJob entered any of the following states:
- // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
- google.protobuf.Timestamp end_time = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Time when the BatchPredictionJob entered any of the following
+ // states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
+ google.protobuf.Timestamp end_time = 17
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the BatchPredictionJob was most recently updated.
- google.protobuf.Timestamp update_time = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 18
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize BatchPredictionJobs.
//
@@ -399,5 +458,15 @@ message BatchPredictionJob {
repeated ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;
// Output only. The running status of the model monitoring pipeline.
- google.rpc.Status model_monitoring_status = 32 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.rpc.Status model_monitoring_status = 32
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // For custom-trained Models and AutoML Tabular Models, the container of the
+ // DeployedModel instances will send `stderr` and `stdout` streams to
+ // Stackdriver Logging by default. Please note that the logs incur cost,
+ // which are subject to [Cloud Logging
+ // pricing](https://cloud.google.com/stackdriver/pricing).
+ //
+ // User can disable container logging by setting this flag to true.
+ bool disable_container_logging = 34;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/completion_stats.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/completion_stats.proto
index f784eda4e..ef9bf10df 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/completion_stats.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/completion_stats.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "CompletionStatsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -35,14 +35,16 @@ message CompletionStats {
// Output only. The number of entities for which any error was encountered.
int64 failed_count = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. In cases when enough errors are encountered a job, pipeline, or operation
- // may be failed as a whole. Below is the number of entities for which the
- // processing had not been finished (either in successful or failed state).
- // Set to -1 if the number is unknown (for example, the operation failed
- // before the total entity number could be collected).
+ // Output only. In cases when enough errors are encountered a job, pipeline,
+ // or operation may be failed as a whole. Below is the number of entities for
+ // which the processing had not been finished (either in successful or failed
+ // state). Set to -1 if the number is unknown (for example, the operation
+ // failed before the total entity number could be collected).
int64 incomplete_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The number of the successful forecast points that are generated by the
- // forecasting model. This is ONLY used by the forecasting batch prediction.
- int64 successful_forecast_point_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The number of the successful forecast points that are
+ // generated by the forecasting model. This is ONLY used by the forecasting
+ // batch prediction.
+ int64 successful_forecast_point_count = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/context.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/context.proto
index 9f4c90c6e..3f50fbd7b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/context.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/context.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ContextProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -57,13 +57,15 @@ message Context {
map labels = 9;
// Output only. Timestamp when this Context was created.
- google.protobuf.Timestamp create_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Context was last updated.
- google.protobuf.Timestamp update_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A list of resource names of Contexts that are parents of this Context.
- // A Context may have at most 10 parent_contexts.
+ // Output only. A list of resource names of Contexts that are parents of this
+ // Context. A Context may have at most 10 parent_contexts.
repeated string parent_contexts = 12 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/custom_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/custom_job.proto
index d6cd91f71..9c16cf95c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/custom_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/custom_job.proto
@@ -28,7 +28,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "CustomJobProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -60,18 +60,22 @@ message CustomJob {
JobState state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the CustomJob was created.
- google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the CustomJob for the first time entered the
// `JOB_STATE_RUNNING` state.
- google.protobuf.Timestamp start_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the CustomJob entered any of the following states:
// `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
- google.protobuf.Timestamp end_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the CustomJob was most recently updated.
- google.protobuf.Timestamp update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Only populated when job's state is `JOB_STATE_FAILED` or
// `JOB_STATE_CANCELLED`.
@@ -94,7 +98,8 @@ message CustomJob {
// Output only. URIs for accessing [interactive
// shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
// (one URI for each training node). Only available if
- // [job_spec.enable_web_access][google.cloud.aiplatform.v1beta1.CustomJobSpec.enable_web_access] is `true`.
+ // [job_spec.enable_web_access][google.cloud.aiplatform.v1beta1.CustomJobSpec.enable_web_access]
+ // is `true`.
//
// The keys are names of each node in the training job; for example,
// `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
@@ -102,15 +107,17 @@ message CustomJob {
// second worker pool.
//
// The values are the URIs for each node's interactive shell.
- map web_access_uris = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
+ map web_access_uris = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Represents the spec of a CustomJob.
message CustomJobSpec {
- // Required. The spec of the worker pools including machine type and Docker image.
- // All worker pools except the first one are optional and can be skipped by
- // providing an empty value.
- repeated WorkerPoolSpec worker_pool_specs = 1 [(google.api.field_behavior) = REQUIRED];
+ // Required. The spec of the worker pools including machine type and Docker
+ // image. All worker pools except the first one are optional and can be
+ // skipped by providing an empty value.
+ repeated WorkerPoolSpec worker_pool_specs = 1
+ [(google.api.field_behavior) = REQUIRED];
// Scheduling options for a CustomJob.
Scheduling scheduling = 3;
@@ -137,9 +144,7 @@ message CustomJobSpec {
// If this field is left unspecified, the job is not peered with any network.
string network = 5 [
(google.api.field_behavior) = OPTIONAL,
- (google.api.resource_reference) = {
- type: "compute.googleapis.com/Network"
- }
+ (google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
];
// Optional. A list of names for the reserved ip ranges under the VPC network
@@ -150,14 +155,15 @@ message CustomJobSpec {
// network.
//
// Example: ['vertex-ai-ip-range'].
- repeated string reserved_ip_ranges = 13 [(google.api.field_behavior) = OPTIONAL];
+ repeated string reserved_ip_ranges = 13
+ [(google.api.field_behavior) = OPTIONAL];
// The Cloud Storage location to store the output of this CustomJob or
// HyperparameterTuningJob. For HyperparameterTuningJob,
// the baseOutputDirectory of
// each child CustomJob backing a Trial is set to a subdirectory of name
- // [id][google.cloud.aiplatform.v1beta1.Trial.id] under its parent HyperparameterTuningJob's
- // baseOutputDirectory.
+ // [id][google.cloud.aiplatform.v1beta1.Trial.id] under its parent
+ // HyperparameterTuningJob's baseOutputDirectory.
//
// The following Vertex AI environment variables will be passed to
// containers or python modules when this field is set:
@@ -175,9 +181,9 @@ message CustomJobSpec {
// * AIP_TENSORBOARD_LOG_DIR = `//logs/`
GcsDestination base_output_directory = 6;
- // Optional. The name of a Vertex AI [Tensorboard][google.cloud.aiplatform.v1beta1.Tensorboard] resource to which this CustomJob
- // will upload Tensorboard logs.
- // Format:
+ // Optional. The name of a Vertex AI
+ // [Tensorboard][google.cloud.aiplatform.v1beta1.Tensorboard] resource to
+ // which this CustomJob will upload Tensorboard logs. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string tensorboard = 7 [
(google.api.field_behavior) = OPTIONAL,
@@ -191,9 +197,25 @@ message CustomJobSpec {
// to training containers.
//
// If set to `true`, you can access interactive shells at the URIs given
- // by [CustomJob.web_access_uris][google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] (within
+ // by
+ // [CustomJob.web_access_uris][google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris]
+ // or
+ // [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris]
+ // (within
// [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]).
bool enable_web_access = 10 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Whether you want Vertex AI to enable access to the customized
+ // dashboard in training chief container.
+ //
+ // If set to `true`, you can access the dashboard at the URIs given
+ // by
+ // [CustomJob.web_access_uris][google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris]
+ // or
+ // [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris]
+ // (within
+ // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]).
+ bool enable_dashboard_access = 16 [(google.api.field_behavior) = OPTIONAL];
}
// Represents the spec of a worker pool in a job.
@@ -225,8 +247,8 @@ message WorkerPoolSpec {
// The spec of a Container.
message ContainerSpec {
- // Required. The URI of a container image in the Container Registry that is to be run on
- // each worker replica.
+ // Required. The URI of a container image in the Container Registry that is to
+ // be run on each worker replica.
string image_uri = 1 [(google.api.field_behavior) = REQUIRED];
// The command to be invoked when the container is started.
@@ -243,17 +265,17 @@ message ContainerSpec {
// The spec of a Python packaged code.
message PythonPackageSpec {
- // Required. The URI of a container image in Artifact Registry that will run the
- // provided Python package. Vertex AI provides a wide range of executor
+ // Required. The URI of a container image in Artifact Registry that will run
+ // the provided Python package. Vertex AI provides a wide range of executor
// images with pre-installed packages to meet users' various use cases. See
// the list of [pre-built containers for
// training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
// You must use an image from this list.
string executor_image_uri = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The Google Cloud Storage location of the Python package files which are
- // the training program and its dependent packages.
- // The maximum number of package URIs is 100.
+ // Required. The Google Cloud Storage location of the Python package files
+ // which are the training program and its dependent packages. The maximum
+ // number of package URIs is 100.
repeated string package_uris = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The Python module name to run after installing the packages.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/data_item.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/data_item.proto
index 5c3e443bf..1249a6962 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/data_item.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/data_item.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DataItemProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -41,10 +41,12 @@ message DataItem {
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this DataItem was created.
- google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this DataItem was last updated.
- google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The labels with user-defined metadata to organize your DataItems.
//
@@ -59,12 +61,14 @@ message DataItem {
// and are immutable.
map labels = 3 [(google.api.field_behavior) = OPTIONAL];
- // Required. The data that the DataItem represents (for example, an image or a text
- // snippet). The schema of the payload is stored in the parent Dataset's
- // [metadata schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri] dataItemSchemaUri field.
+ // Required. The data that the DataItem represents (for example, an image or a
+ // text snippet). The schema of the payload is stored in the parent Dataset's
+ // [metadata
+ // schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri]
+ // dataItemSchemaUri field.
google.protobuf.Value payload = 4 [(google.api.field_behavior) = REQUIRED];
- // Optional. Used to perform consistent read-modify-write updates. If not set, a blind
- // "overwrite" update happens.
+ // Optional. Used to perform consistent read-modify-write updates. If not set,
+ // a blind "overwrite" update happens.
string etag = 7 [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/data_labeling_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/data_labeling_job.proto
index 0e65f1993..c1582fb9c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/data_labeling_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/data_labeling_job.proto
@@ -26,7 +26,7 @@ import "google/rpc/status.proto";
import "google/type/money.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DataLabelingJobProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -50,9 +50,8 @@ message DataLabelingJob {
// Display name of a DataLabelingJob.
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. Dataset resource names. Right now we only support labeling from a single
- // Dataset.
- // Format:
+ // Required. Dataset resource names. Right now we only support labeling from a
+ // single Dataset. Format:
// `projects/{project}/locations/{location}/datasets/{dataset}`
repeated string datasets = 3 [
(google.api.field_behavior) = REQUIRED,
@@ -74,14 +73,14 @@ message DataLabelingJob {
// Required. Number of labelers to work on each DataItem.
int32 labeler_count = 4 [(google.api.field_behavior) = REQUIRED];
- // Required. The Google Cloud Storage location of the instruction pdf. This pdf is
- // shared with labelers, and provides detailed description on how to label
- // DataItems in Datasets.
+ // Required. The Google Cloud Storage location of the instruction pdf. This
+ // pdf is shared with labelers, and provides detailed description on how to
+ // label DataItems in Datasets.
string instruction_uri = 5 [(google.api.field_behavior) = REQUIRED];
- // Required. Points to a YAML file stored on Google Cloud Storage describing the
- // config for a specific type of DataLabelingJob.
- // The schema files that can be used here are found in the
+ // Required. Points to a YAML file stored on Google Cloud Storage describing
+ // the config for a specific type of DataLabelingJob. The schema files that
+ // can be used here are found in the
// https://storage.googleapis.com/google-cloud-aiplatform bucket in the
// /schema/datalabelingjob/inputs/ folder.
string inputs_schema_uri = 6 [(google.api.field_behavior) = REQUIRED];
@@ -92,22 +91,25 @@ message DataLabelingJob {
// Output only. The detailed state of the job.
JobState state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Current labeling job progress percentage scaled in interval [0, 100],
- // indicating the percentage of DataItems that has been finished.
+ // Output only. Current labeling job progress percentage scaled in interval
+ // [0, 100], indicating the percentage of DataItems that has been finished.
int32 labeling_progress = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to
- // date.
- google.type.Money current_spend = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Estimated cost(in US dollars) that the DataLabelingJob has
+ // incurred to date.
+ google.type.Money current_spend = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this DataLabelingJob was created.
- google.protobuf.Timestamp create_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this DataLabelingJob was updated most recently.
- google.protobuf.Timestamp update_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. DataLabelingJob errors. It is only populated when job's state is
- // `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
+ // Output only. DataLabelingJob errors. It is only populated when job's state
+ // is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
google.rpc.Status error = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize your DataLabelingJobs.
@@ -121,7 +123,8 @@ message DataLabelingJob {
// and are immutable. Following system labels exist for each DataLabelingJob:
//
// * "aiplatform.googleapis.com/schema": output only, its value is the
- // [inputs_schema][google.cloud.aiplatform.v1beta1.DataLabelingJob.inputs_schema_uri]'s title.
+ // [inputs_schema][google.cloud.aiplatform.v1beta1.DataLabelingJob.inputs_schema_uri]'s
+ // title.
map labels = 11;
// The SpecialistPools' resource names associated with this job.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/dataset.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/dataset.proto
index 04b3a67b7..0ea636da7 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/dataset.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/dataset.proto
@@ -20,11 +20,12 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
import "google/cloud/aiplatform/v1beta1/io.proto";
+import "google/cloud/aiplatform/v1beta1/saved_query.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DatasetProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -49,21 +50,22 @@ message Dataset {
// The description of the Dataset.
string description = 16;
- // Required. Points to a YAML file stored on Google Cloud Storage describing additional
- // information about the Dataset.
- // The schema is defined as an OpenAPI 3.0.2 Schema Object.
- // The schema files that can be used here are found in
- // gs://google-cloud-aiplatform/schema/dataset/metadata/.
+ // Required. Points to a YAML file stored on Google Cloud Storage describing
+ // additional information about the Dataset. The schema is defined as an
+ // OpenAPI 3.0.2 Schema Object. The schema files that can be used here are
+ // found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
string metadata_schema_uri = 3 [(google.api.field_behavior) = REQUIRED];
// Required. Additional information about the Dataset.
google.protobuf.Value metadata = 8 [(google.api.field_behavior) = REQUIRED];
// Output only. Timestamp when this Dataset was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Dataset was last updated.
- google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Used to perform consistent read-modify-write updates. If not set, a blind
// "overwrite" update happens.
@@ -82,15 +84,27 @@ message Dataset {
// and are immutable. Following system labels exist for each Dataset:
//
// * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
- // value is the [metadata_schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri] title.
+ // value is the
+ // [metadata_schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri]
+ // title.
map labels = 7;
+ // All SavedQueries belong to the Dataset will be returned in List/Get
+ // Dataset response. The [annotation_specs][SavedQuery.annotation_specs] field
+ // will not be populated except for UI cases which will only use
+ // [annotation_spec_count][google.cloud.aiplatform.v1beta1.SavedQuery.annotation_spec_count].
+ // In CreateDataset request, a SavedQuery is created together if
+ // this field is set, up to one SavedQuery can be set in CreateDatasetRequest.
+ // The SavedQuery should not contain any AnnotationSpec.
+ repeated SavedQuery saved_queries = 9;
+
// Customer-managed encryption key spec for a Dataset. If set, this Dataset
// and all sub-resources of this Dataset will be secured by this key.
EncryptionSpec encryption_spec = 11;
- // Output only. The resource name of the Artifact that was created in MetadataStore when
- // creating the Dataset. The Artifact resource name pattern is
+ // Output only. The resource name of the Artifact that was created in
+ // MetadataStore when creating the Dataset. The Artifact resource name pattern
+ // is
// `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
string metadata_artifact = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -114,21 +128,27 @@ message ImportDataConfig {
// considered identical if their content bytes are identical (e.g. image bytes
// or pdf bytes).
// These labels will be overridden by Annotation labels specified inside index
- // file referenced by [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri], e.g. jsonl file.
+ // file referenced by
+ // [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
+ // e.g. jsonl file.
map data_item_labels = 2;
// Labels that will be applied to newly imported Annotations. If two
// Annotations are identical, one of them will be deduped. Two Annotations are
- // considered identical if their [payload][google.cloud.aiplatform.v1beta1.Annotation.payload],
- // [payload_schema_uri][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri] and all of their
+ // considered identical if their
+ // [payload][google.cloud.aiplatform.v1beta1.Annotation.payload],
+ // [payload_schema_uri][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri]
+ // and all of their
// [labels][google.cloud.aiplatform.v1beta1.Annotation.labels] are the same.
// These labels will be overridden by Annotation labels specified inside index
- // file referenced by [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri], e.g. jsonl file.
+ // file referenced by
+ // [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
+ // e.g. jsonl file.
map annotation_labels = 3;
- // Required. Points to a YAML file stored on Google Cloud Storage describing the import
- // format. Validation will be done against the schema. The schema is defined
- // as an [OpenAPI 3.0.2 Schema
+ // Required. Points to a YAML file stored on Google Cloud Storage describing
+ // the import format. Validation will be done against the schema. The schema
+ // is defined as an [OpenAPI 3.0.2 Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
string import_schema_uri = 4 [(google.api.field_behavior) = REQUIRED];
}
@@ -150,9 +170,33 @@ message ExportDataConfig {
GcsDestination gcs_destination = 1;
}
+ // The instructions how the export data should be split between the
+ // training, validation and test sets.
+ oneof split {
+ // Split based on fractions defining the size of each set.
+ ExportFractionSplit fraction_split = 5;
+ }
+
// A filter on Annotations of the Dataset. Only Annotations on to-be-exported
// DataItems(specified by [data_items_filter][]) that match this filter will
// be exported. The filter syntax is the same as in
// [ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations].
string annotations_filter = 2;
}
+
+// Assigns the input data to training, validation, and test sets as per the
+// given fractions. Any of `training_fraction`, `validation_fraction` and
+// `test_fraction` may optionally be provided, they must sum to up to 1. If the
+// provided ones sum to less than 1, the remainder is assigned to sets as
+// decided by Vertex AI. If none of the fractions are set, by default roughly
+// 80% of data is used for training, 10% for validation, and 10% for test.
+message ExportFractionSplit {
+ // The fraction of the input data that is to be used to train the Model.
+ double training_fraction = 1;
+
+ // The fraction of the input data that is to be used to validate the Model.
+ double validation_fraction = 2;
+
+ // The fraction of the input data that is to be used to evaluate the Model.
+ double test_fraction = 3;
+}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/dataset_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/dataset_service.proto
index a93ca3905..a2cae6d5f 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/dataset_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/dataset_service.proto
@@ -27,10 +27,11 @@ import "google/cloud/aiplatform/v1beta1/dataset.proto";
import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/cloud/aiplatform/v1beta1/saved_query.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DatasetServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -41,10 +42,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// resources.
service DatasetService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a Dataset.
- rpc CreateDataset(CreateDatasetRequest) returns (google.longrunning.Operation) {
+ rpc CreateDataset(CreateDatasetRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/datasets"
body: "dataset"
@@ -82,7 +85,8 @@ service DatasetService {
}
// Deletes a Dataset.
- rpc DeleteDataset(DeleteDatasetRequest) returns (google.longrunning.Operation) {
+ rpc DeleteDataset(DeleteDatasetRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/datasets/*}"
};
@@ -128,14 +132,16 @@ service DatasetService {
}
// Searches DataItems in a Dataset.
- rpc SearchDataItems(SearchDataItemsRequest) returns (SearchDataItemsResponse) {
+ rpc SearchDataItems(SearchDataItemsRequest)
+ returns (SearchDataItemsResponse) {
option (google.api.http) = {
get: "/v1beta1/{dataset=projects/*/locations/*/datasets/*}:searchDataItems"
};
}
// Lists SavedQueries in a Dataset.
- rpc ListSavedQueries(ListSavedQueriesRequest) returns (ListSavedQueriesResponse) {
+ rpc ListSavedQueries(ListSavedQueriesRequest)
+ returns (ListSavedQueriesResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/datasets/*}/savedQueries"
};
@@ -151,7 +157,8 @@ service DatasetService {
}
// Lists Annotations belongs to a dataitem
- rpc ListAnnotations(ListAnnotationsRequest) returns (ListAnnotationsResponse) {
+ rpc ListAnnotations(ListAnnotationsRequest)
+ returns (ListAnnotationsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/datasets/*/dataItems/*}/annotations"
};
@@ -159,7 +166,8 @@ service DatasetService {
}
}
-// Request message for [DatasetService.CreateDataset][google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset].
+// Request message for
+// [DatasetService.CreateDataset][google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset].
message CreateDatasetRequest {
// Required. The resource name of the Location to create the Dataset in.
// Format: `projects/{project}/locations/{location}`
@@ -174,13 +182,15 @@ message CreateDatasetRequest {
Dataset dataset = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Runtime operation information for [DatasetService.CreateDataset][google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset].
+// Runtime operation information for
+// [DatasetService.CreateDataset][google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset].
message CreateDatasetOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [DatasetService.GetDataset][google.cloud.aiplatform.v1beta1.DatasetService.GetDataset].
+// Request message for
+// [DatasetService.GetDataset][google.cloud.aiplatform.v1beta1.DatasetService.GetDataset].
message GetDatasetRequest {
// Required. The name of the Dataset resource.
string name = 1 [
@@ -194,22 +204,25 @@ message GetDatasetRequest {
google.protobuf.FieldMask read_mask = 2;
}
-// Request message for [DatasetService.UpdateDataset][google.cloud.aiplatform.v1beta1.DatasetService.UpdateDataset].
+// Request message for
+// [DatasetService.UpdateDataset][google.cloud.aiplatform.v1beta1.DatasetService.UpdateDataset].
message UpdateDatasetRequest {
// Required. The Dataset which replaces the resource on the server.
Dataset dataset = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource.
- // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask].
- // Updatable fields:
+ // For the `FieldMask` definition, see
+ // [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:
//
// * `display_name`
// * `description`
// * `labels`
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [DatasetService.ListDatasets][google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets].
+// Request message for
+// [DatasetService.ListDatasets][google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets].
message ListDatasetsRequest {
// Required. The name of the Dataset's parent resource.
// Format: `projects/{project}/locations/{location}`
@@ -255,7 +268,8 @@ message ListDatasetsRequest {
string order_by = 6;
}
-// Response message for [DatasetService.ListDatasets][google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets].
+// Response message for
+// [DatasetService.ListDatasets][google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets].
message ListDatasetsResponse {
// A list of Datasets that matches the specified filter in the request.
repeated Dataset datasets = 1;
@@ -264,7 +278,8 @@ message ListDatasetsResponse {
string next_page_token = 2;
}
-// Request message for [DatasetService.DeleteDataset][google.cloud.aiplatform.v1beta1.DatasetService.DeleteDataset].
+// Request message for
+// [DatasetService.DeleteDataset][google.cloud.aiplatform.v1beta1.DatasetService.DeleteDataset].
message DeleteDatasetRequest {
// Required. The resource name of the Dataset to delete.
// Format:
@@ -277,7 +292,8 @@ message DeleteDatasetRequest {
];
}
-// Request message for [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData].
+// Request message for
+// [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData].
message ImportDataRequest {
// Required. The name of the Dataset resource.
// Format:
@@ -289,23 +305,25 @@ message ImportDataRequest {
}
];
- // Required. The desired input locations. The contents of all input locations will be
- // imported in one batch.
- repeated ImportDataConfig import_configs = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The desired input locations. The contents of all input locations
+ // will be imported in one batch.
+ repeated ImportDataConfig import_configs = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData].
-message ImportDataResponse {
+// Response message for
+// [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData].
+message ImportDataResponse {}
-}
-
-// Runtime operation information for [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData].
+// Runtime operation information for
+// [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData].
message ImportDataOperationMetadata {
// The common part of the operation metadata.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData].
+// Request message for
+// [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData].
message ExportDataRequest {
// Required. The name of the Dataset resource.
// Format:
@@ -321,13 +339,15 @@ message ExportDataRequest {
ExportDataConfig export_config = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData].
+// Response message for
+// [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData].
message ExportDataResponse {
// All of the files that are exported in this export operation.
repeated string exported_files = 1;
}
-// Runtime operation information for [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData].
+// Runtime operation information for
+// [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData].
message ExportDataOperationMetadata {
// The common part of the operation metadata.
GenericOperationMetadata generic_metadata = 1;
@@ -337,7 +357,8 @@ message ExportDataOperationMetadata {
string gcs_output_directory = 2;
}
-// Request message for [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems].
+// Request message for
+// [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems].
message ListDataItemsRequest {
// Required. The resource name of the Dataset to list DataItems from.
// Format:
@@ -366,7 +387,8 @@ message ListDataItemsRequest {
string order_by = 6;
}
-// Response message for [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems].
+// Response message for
+// [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems].
message ListDataItemsResponse {
// A list of DataItems that matches the specified filter in the request.
repeated DataItem data_items = 1;
@@ -375,12 +397,13 @@ message ListDataItemsResponse {
string next_page_token = 2;
}
-// Request message for [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems].
+// Request message for
+// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems].
message SearchDataItemsRequest {
// Expression that allows ranking results based on annotation's property.
message OrderByAnnotation {
- // Required. Saved query of the Annotation. Only Annotations belong to this saved
- // query will be considered for ordering.
+ // Required. Saved query of the Annotation. Only Annotations belong to this
+ // saved query will be considered for ordering.
string saved_query = 1 [(google.api.field_behavior) = REQUIRED];
// A comma-separated list of annotation fields to order by, sorted in
@@ -452,7 +475,8 @@ message SearchDataItemsRequest {
// belong to.
repeated string annotation_filters = 11;
- // Mask specifying which fields of [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
+ // Mask specifying which fields of
+ // [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read.
google.protobuf.FieldMask field_mask = 6;
// If set, only up to this many of Annotations will be returned per
@@ -470,18 +494,23 @@ message SearchDataItemsRequest {
// A token identifying a page of results for the server to return
// Typically obtained via
- // [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token] of the previous
- // [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems] call.
+ // [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token]
+ // of the previous
+ // [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems]
+ // call.
string page_token = 10;
}
-// Response message for [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems].
+// Response message for
+// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems].
message SearchDataItemsResponse {
// The DataItemViews read.
repeated DataItemView data_item_views = 1;
// A token to retrieve next page of results.
- // Pass to [SearchDataItemsRequest.page_token][google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.page_token] to obtain that page.
+ // Pass to
+ // [SearchDataItemsRequest.page_token][google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
@@ -504,7 +533,8 @@ message DataItemView {
bool has_truncated_annotations = 3;
}
-// Request message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries].
+// Request message for
+// [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries].
message ListSavedQueriesRequest {
// Required. The resource name of the Dataset to list SavedQueries from.
// Format:
@@ -533,7 +563,8 @@ message ListSavedQueriesRequest {
string order_by = 6;
}
-// Response message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries].
+// Response message for
+// [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries].
message ListSavedQueriesResponse {
// A list of SavedQueries that match the specified filter in the request.
repeated SavedQuery saved_queries = 1;
@@ -542,7 +573,8 @@ message ListSavedQueriesResponse {
string next_page_token = 2;
}
-// Request message for [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1beta1.DatasetService.GetAnnotationSpec].
+// Request message for
+// [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1beta1.DatasetService.GetAnnotationSpec].
message GetAnnotationSpecRequest {
// Required. The name of the AnnotationSpec resource.
// Format:
@@ -558,7 +590,8 @@ message GetAnnotationSpecRequest {
google.protobuf.FieldMask read_mask = 2;
}
-// Request message for [DatasetService.ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations].
+// Request message for
+// [DatasetService.ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations].
message ListAnnotationsRequest {
// Required. The resource name of the DataItem to list Annotations from.
// Format:
@@ -587,7 +620,8 @@ message ListAnnotationsRequest {
string order_by = 6;
}
-// Response message for [DatasetService.ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations].
+// Response message for
+// [DatasetService.ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations].
message ListAnnotationsResponse {
// A list of Annotations that matches the specified filter in the request.
repeated Annotation annotations = 1;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployed_index_ref.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployed_index_ref.proto
index fd20f4d63..01e970b44 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployed_index_ref.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployed_index_ref.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DeployedIndexRefProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployed_model_ref.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployed_model_ref.proto
index 337ba55e8..2f3e75551 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployed_model_ref.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployed_model_ref.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DeployedModelNameProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto
index e273a1552..3237bb905 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto
@@ -22,7 +22,7 @@ import "google/cloud/aiplatform/v1beta1/machine_resources.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DeploymentResourcePoolProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -42,9 +42,12 @@ message DeploymentResourcePool {
// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. The underlying DedicatedResources that the DeploymentResourcePool uses.
- DedicatedResources dedicated_resources = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The underlying DedicatedResources that the DeploymentResourcePool
+ // uses.
+ DedicatedResources dedicated_resources = 2
+ [(google.api.field_behavior) = REQUIRED];
// Output only. Timestamp when this DeploymentResourcePool was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto
index 1c02d761d..0f11428f4 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto
@@ -25,9 +25,10 @@ import "google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto";
import "google/cloud/aiplatform/v1beta1/endpoint.proto";
import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "DeploymentResourcePoolServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -37,15 +38,18 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service that manages the DeploymentResourcePool resource.
service DeploymentResourcePoolService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Create a DeploymentResourcePool.
- rpc CreateDeploymentResourcePool(CreateDeploymentResourcePoolRequest) returns (google.longrunning.Operation) {
+ rpc CreateDeploymentResourcePool(CreateDeploymentResourcePoolRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/deploymentResourcePools"
body: "*"
};
- option (google.api.method_signature) = "parent,deployment_resource_pool,deployment_resource_pool_id";
+ option (google.api.method_signature) =
+ "parent,deployment_resource_pool,deployment_resource_pool_id";
option (google.longrunning.operation_info) = {
response_type: "DeploymentResourcePool"
metadata_type: "CreateDeploymentResourcePoolOperationMetadata"
@@ -53,7 +57,8 @@ service DeploymentResourcePoolService {
}
// Get a DeploymentResourcePool.
- rpc GetDeploymentResourcePool(GetDeploymentResourcePoolRequest) returns (DeploymentResourcePool) {
+ rpc GetDeploymentResourcePool(GetDeploymentResourcePoolRequest)
+ returns (DeploymentResourcePool) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/deploymentResourcePools/*}"
};
@@ -61,7 +66,8 @@ service DeploymentResourcePoolService {
}
// List DeploymentResourcePools in a location.
- rpc ListDeploymentResourcePools(ListDeploymentResourcePoolsRequest) returns (ListDeploymentResourcePoolsResponse) {
+ rpc ListDeploymentResourcePools(ListDeploymentResourcePoolsRequest)
+ returns (ListDeploymentResourcePoolsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/deploymentResourcePools"
};
@@ -69,7 +75,8 @@ service DeploymentResourcePoolService {
}
// Delete a DeploymentResourcePool.
- rpc DeleteDeploymentResourcePool(DeleteDeploymentResourcePoolRequest) returns (google.longrunning.Operation) {
+ rpc DeleteDeploymentResourcePool(DeleteDeploymentResourcePoolRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/deploymentResourcePools/*}"
};
@@ -81,7 +88,8 @@ service DeploymentResourcePoolService {
}
// List DeployedModels that have been deployed on this DeploymentResourcePool.
- rpc QueryDeployedModels(QueryDeployedModelsRequest) returns (QueryDeployedModelsResponse) {
+ rpc QueryDeployedModels(QueryDeployedModelsRequest)
+ returns (QueryDeployedModelsResponse) {
option (google.api.http) = {
get: "/v1beta1/{deployment_resource_pool=projects/*/locations/*/deploymentResourcePools/*}:queryDeployedModels"
};
@@ -91,8 +99,8 @@ service DeploymentResourcePoolService {
// Request message for CreateDeploymentResourcePool method.
message CreateDeploymentResourcePoolRequest {
- // Required. The parent location resource where this DeploymentResourcePool will be
- // created. Format: `projects/{project}/locations/{location}`
+ // Required. The parent location resource where this DeploymentResourcePool
+ // will be created. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -101,7 +109,8 @@ message CreateDeploymentResourcePoolRequest {
];
// Required. The DeploymentResourcePool to create.
- DeploymentResourcePool deployment_resource_pool = 2 [(google.api.field_behavior) = REQUIRED];
+ DeploymentResourcePool deployment_resource_pool = 2
+ [(google.api.field_behavior) = REQUIRED];
// Required. The ID to use for the DeploymentResourcePool, which
// will become the final component of the DeploymentResourcePool's resource
@@ -109,7 +118,8 @@ message CreateDeploymentResourcePoolRequest {
//
// The maximum length is 63 characters, and valid characters
// are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
- string deployment_resource_pool_id = 3 [(google.api.field_behavior) = REQUIRED];
+ string deployment_resource_pool_id = 3
+ [(google.api.field_behavior) = REQUIRED];
}
// Runtime operation information for CreateDeploymentResourcePool method.
@@ -133,8 +143,8 @@ message GetDeploymentResourcePoolRequest {
// Request message for ListDeploymentResourcePools method.
message ListDeploymentResourcePoolsRequest {
- // Required. The parent Location which owns this collection of DeploymentResourcePools.
- // Format: `projects/{project}/locations/{location}`
+ // Required. The parent Location which owns this collection of
+ // DeploymentResourcePools. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/encryption_spec.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/encryption_spec.proto
index 27e2bade0..89cc8b9a6 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/encryption_spec.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/encryption_spec.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EncryptionSpecProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -29,8 +29,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Represents a customer-managed encryption key spec that can be applied to
// a top-level resource.
message EncryptionSpec {
- // Required. The Cloud KMS resource identifier of the customer managed encryption key
- // used to protect a resource. Has the form:
+ // Required. The Cloud KMS resource identifier of the customer managed
+ // encryption key used to protect a resource. Has the form:
// `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`.
// The key needs to be in the same region as where the compute resource is
// created.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/endpoint.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/endpoint.proto
index 4ff0ebb81..7486b872e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/endpoint.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/endpoint.proto
@@ -25,7 +25,7 @@ import "google/cloud/aiplatform/v1beta1/machine_resources.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EndpointProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -52,9 +52,13 @@ message Endpoint {
string description = 3;
// Output only. The models deployed in this Endpoint.
- // To add or remove DeployedModels use [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel] and
- // [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel] respectively.
- repeated DeployedModel deployed_models = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // To add or remove DeployedModels use
+ // [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]
+ // and
+ // [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel]
+ // respectively.
+ repeated DeployedModel deployed_models = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// A map from a DeployedModel's ID to the percentage of this Endpoint's
// traffic that should be forwarded to that DeployedModel.
@@ -80,24 +84,27 @@ message Endpoint {
map labels = 7;
// Output only. Timestamp when this Endpoint was created.
- google.protobuf.Timestamp create_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Endpoint was last updated.
- google.protobuf.Timestamp update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Customer-managed encryption key spec for an Endpoint. If set, this
// Endpoint and all sub-resources of this Endpoint will be secured by
// this key.
EncryptionSpec encryption_spec = 10;
- // The full name of the Google Compute Engine
+ // Optional. The full name of the Google Compute Engine
// [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
// to which the Endpoint should be peered.
//
// Private services access must already be configured for the network. If left
// unspecified, the Endpoint is not peered with any network.
//
- // Only one of the fields, [network][google.cloud.aiplatform.v1beta1.Endpoint.network] or
+ // Only one of the fields,
+ // [network][google.cloud.aiplatform.v1beta1.Endpoint.network] or
// [enable_private_service_connect][google.cloud.aiplatform.v1beta1.Endpoint.enable_private_service_connect],
// can be set.
//
@@ -105,20 +112,22 @@ message Endpoint {
// `projects/{project}/global/networks/{network}`.
// Where `{project}` is a project number, as in `12345`, and `{network}` is
// network name.
- string network = 13 [(google.api.resource_reference) = {
- type: "compute.googleapis.com/Network"
- }];
+ string network = 13 [
+ (google.api.field_behavior) = OPTIONAL,
+ (google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
+ ];
// Deprecated: If true, expose the Endpoint via private service connect.
//
- // Only one of the fields, [network][google.cloud.aiplatform.v1beta1.Endpoint.network] or
+ // Only one of the fields,
+ // [network][google.cloud.aiplatform.v1beta1.Endpoint.network] or
// [enable_private_service_connect][google.cloud.aiplatform.v1beta1.Endpoint.enable_private_service_connect],
// can be set.
bool enable_private_service_connect = 17 [deprecated = true];
- // Output only. Resource name of the Model Monitoring job associated with this Endpoint
- // if monitoring is enabled by [CreateModelDeploymentMonitoringJob][].
- // Format:
+ // Output only. Resource name of the Model Monitoring job associated with this
+ // Endpoint if monitoring is enabled by
+ // [CreateModelDeploymentMonitoringJob][]. Format:
// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
string model_deployment_monitoring_job = 14 [
(google.api.field_behavior) = OUTPUT_ONLY,
@@ -128,7 +137,8 @@ message Endpoint {
];
// Configures the request-response logging for online prediction.
- PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18;
+ PredictRequestResponseLoggingConfig predict_request_response_logging_config =
+ 18;
}
// A deployment of a Model. Endpoints contain one or more DeployedModels.
@@ -151,21 +161,26 @@ message DeployedModel {
// Format:
// `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
string shared_resources = 17 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/DeploymentResourcePool"
- }];
+ type: "aiplatform.googleapis.com/DeploymentResourcePool"
+ }];
}
- // Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI
- // will generate a value for this ID.
+ // Immutable. The ID of the DeployedModel. If not provided upon deployment,
+ // Vertex AI will generate a value for this ID.
//
// This value should be 1-10 characters, and valid characters are /[0-9]/.
string id = 1 [(google.api.field_behavior) = IMMUTABLE];
- // Required. The resource name of the Model that this is the deployment of. Note that
- // the Model may be in a different location than the DeployedModel's Endpoint.
+ // Required. The resource name of the Model that this is the deployment of.
+ // Note that the Model may be in a different location than the DeployedModel's
+ // Endpoint.
//
// The resource name may contain version id or version alias to specify the
- // version, if no version is specified, the default version will be deployed.
+ // version.
+ // Example: `projects/{project}/locations/{location}/models/{model}@2`
+ // or
+ // `projects/{project}/locations/{location}/models/{model}@golden`
+ // if no version is specified, the default version will be deployed.
string model = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -181,19 +196,35 @@ message DeployedModel {
string display_name = 3;
// Output only. Timestamp when the DeployedModel was created.
- google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Explanation configuration for this DeployedModel.
//
- // When deploying a Model using [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel], this value
- // overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]. All fields of
- // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] are optional in the request. If a field of
- // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] is not populated, the value of the same field of
- // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] is inherited. If the corresponding
- // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] is not populated, all fields of the
- // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] will be used for the explanation configuration.
+ // When deploying a Model using
+ // [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel],
+ // this value overrides the value of
+ // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec].
+ // All fields of
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
+ // are optional in the request. If a field of
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
+ // is not populated, the value of the same field of
+ // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]
+ // is inherited. If the corresponding
+ // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]
+ // is not populated, all fields of the
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
+ // will be used for the explanation configuration.
ExplanationSpec explanation_spec = 9;
+ // If true, deploy the model without explainable feature, regardless the
+ // existence of
+ // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]
+ // or
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec].
+ bool disable_explanations = 19;
+
// The service account that the DeployedModel's container runs as. Specify the
// email address of the service account. If this service account is not
// specified, the container runs as a service account that doesn't have access
@@ -209,6 +240,8 @@ message DeployedModel {
// Only supported for custom-trained Models and AutoML Tabular Models.
bool enable_container_logging = 12;
+ // If true, online prediction access logs are sent to StackDriver
+ // Logging.
// These logs are like standard server access logs, containing
// information like timestamp and latency for each prediction request.
//
@@ -217,10 +250,12 @@ message DeployedModel {
// Estimate your costs before enabling this option.
bool enable_access_logging = 13;
- // Output only. Provide paths for users to send predict/explain/health requests directly to
- // the deployed model services running on Cloud via private services access.
- // This field is populated if [network][google.cloud.aiplatform.v1beta1.Endpoint.network] is configured.
- PrivateEndpoints private_endpoints = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Provide paths for users to send predict/explain/health
+ // requests directly to the deployed model services running on Cloud via
+ // private services access. This field is populated if
+ // [network][google.cloud.aiplatform.v1beta1.Endpoint.network] is configured.
+ PrivateEndpoints private_endpoints = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// PrivateEndpoints proto is used to provide paths for users to send
@@ -238,8 +273,8 @@ message PrivateEndpoints {
// Output only. Http(s) path to send health check requests.
string health_http_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The name of the service attachment resource. Populated if private service
- // connect is enabled.
+ // Output only. The name of the service attachment resource. Populated if
+ // private service connect is enabled.
string service_attachment = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/endpoint_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/endpoint_service.proto
index e30077dcd..76b61d905 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/endpoint_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/endpoint_service.proto
@@ -23,10 +23,11 @@ import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/endpoint.proto";
import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EndpointServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -36,10 +37,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for managing Vertex AI's Endpoints.
service EndpointService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates an Endpoint.
- rpc CreateEndpoint(CreateEndpointRequest) returns (google.longrunning.Operation) {
+ rpc CreateEndpoint(CreateEndpointRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/endpoints"
body: "endpoint"
@@ -78,7 +81,8 @@ service EndpointService {
}
// Deletes an Endpoint.
- rpc DeleteEndpoint(DeleteEndpointRequest) returns (google.longrunning.Operation) {
+ rpc DeleteEndpoint(DeleteEndpointRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/endpoints/*}"
};
@@ -95,7 +99,8 @@ service EndpointService {
post: "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:deployModel"
body: "*"
};
- option (google.api.method_signature) = "endpoint,deployed_model,traffic_split";
+ option (google.api.method_signature) =
+ "endpoint,deployed_model,traffic_split";
option (google.longrunning.operation_info) = {
response_type: "DeployModelResponse"
metadata_type: "DeployModelOperationMetadata"
@@ -104,12 +109,14 @@ service EndpointService {
// Undeploys a Model from an Endpoint, removing a DeployedModel from it, and
// freeing all resources it's using.
- rpc UndeployModel(UndeployModelRequest) returns (google.longrunning.Operation) {
+ rpc UndeployModel(UndeployModelRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:undeployModel"
body: "*"
};
- option (google.api.method_signature) = "endpoint,deployed_model_id,traffic_split";
+ option (google.api.method_signature) =
+ "endpoint,deployed_model_id,traffic_split";
option (google.longrunning.operation_info) = {
response_type: "UndeployModelResponse"
metadata_type: "UndeployModelOperationMetadata"
@@ -117,7 +124,8 @@ service EndpointService {
}
}
-// Request message for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint].
+// Request message for
+// [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint].
message CreateEndpointRequest {
// Required. The resource name of the Location to create the Endpoint in.
// Format: `projects/{project}/locations/{location}`
@@ -142,13 +150,15 @@ message CreateEndpointRequest {
string endpoint_id = 4 [(google.api.field_behavior) = IMMUTABLE];
}
-// Runtime operation information for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint].
+// Runtime operation information for
+// [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint].
message CreateEndpointOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [EndpointService.GetEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.GetEndpoint]
+// Request message for
+// [EndpointService.GetEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.GetEndpoint]
message GetEndpointRequest {
// Required. The name of the Endpoint resource.
// Format:
@@ -161,10 +171,11 @@ message GetEndpointRequest {
];
}
-// Request message for [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints].
+// Request message for
+// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints].
message ListEndpointsRequest {
- // Required. The resource name of the Location from which to list the Endpoints.
- // Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location from which to list the
+ // Endpoints. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -172,11 +183,12 @@ message ListEndpointsRequest {
}
];
- // Optional. An expression for filtering the results of the request. For field names
- // both snake_case and camelCase are supported.
+ // Optional. An expression for filtering the results of the request. For field
+ // names both snake_case and camelCase are supported.
//
// * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID,
- // i.e. the last segment of the Endpoint's [resource name][google.cloud.aiplatform.v1beta1.Endpoint.name].
+ // i.e. the last segment of the Endpoint's [resource
+ // name][google.cloud.aiplatform.v1beta1.Endpoint.name].
// * `display_name` supports = and, !=
// * `labels` supports general map functions that is:
// * `labels.key=value` - key:value equality
@@ -194,34 +206,44 @@ message ListEndpointsRequest {
// Optional. The standard list page token.
// Typically obtained via
- // [ListEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token] of the previous
- // [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints] call.
+ // [ListEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token]
+ // of the previous
+ // [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints]
+ // call.
string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. Mask specifying which fields to read.
- google.protobuf.FieldMask read_mask = 5 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.FieldMask read_mask = 5
+ [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints].
+// Response message for
+// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints].
message ListEndpointsResponse {
// List of Endpoints in the requested page.
repeated Endpoint endpoints = 1;
// A token to retrieve the next page of results.
- // Pass to [ListEndpointsRequest.page_token][google.cloud.aiplatform.v1beta1.ListEndpointsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListEndpointsRequest.page_token][google.cloud.aiplatform.v1beta1.ListEndpointsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint].
+// Request message for
+// [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint].
message UpdateEndpointRequest {
// Required. The Endpoint which replaces the resource on the server.
Endpoint endpoint = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The update mask applies to the resource. See
+ // [google.protobuf.FieldMask][google.protobuf.FieldMask].
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeleteEndpoint].
+// Request message for
+// [EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeleteEndpoint].
message DeleteEndpointRequest {
// Required. The name of the Endpoint resource to be deleted.
// Format:
@@ -234,7 +256,8 @@ message DeleteEndpointRequest {
];
}
-// Request message for [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel].
+// Request message for
+// [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel].
message DeployModelRequest {
// Required. The name of the Endpoint resource into which to deploy a Model.
// Format:
@@ -247,8 +270,9 @@ message DeployModelRequest {
];
// Required. The DeployedModel to be created within the Endpoint. Note that
- // [Endpoint.traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] must be updated for the DeployedModel to start
- // receiving traffic, either as part of this call, or via
+ // [Endpoint.traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split]
+ // must be updated for the DeployedModel to start receiving traffic, either as
+ // part of this call, or via
// [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint].
DeployedModel deployed_model = 2 [(google.api.field_behavior) = REQUIRED];
@@ -256,29 +280,34 @@ message DeployModelRequest {
// traffic that should be forwarded to that DeployedModel.
//
// If this field is non-empty, then the Endpoint's
- // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] will be overwritten with it.
- // To refer to the ID of the just being deployed Model, a "0" should be used,
- // and the actual ID of the new DeployedModel will be filled in its place by
- // this method. The traffic percentage values must add up to 100.
+ // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split]
+ // will be overwritten with it. To refer to the ID of the just being deployed
+ // Model, a "0" should be used, and the actual ID of the new DeployedModel
+ // will be filled in its place by this method. The traffic percentage values
+ // must add up to 100.
//
// If this field is empty, then the Endpoint's
- // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] is not updated.
+ // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] is
+ // not updated.
map traffic_split = 3;
}
-// Response message for [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel].
+// Response message for
+// [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel].
message DeployModelResponse {
// The DeployedModel that had been deployed in the Endpoint.
DeployedModel deployed_model = 1;
}
-// Runtime operation information for [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel].
+// Runtime operation information for
+// [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel].
message DeployModelOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel].
+// Request message for
+// [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel].
message UndeployModelRequest {
// Required. The name of the Endpoint resource from which to undeploy a Model.
// Format:
@@ -294,21 +323,21 @@ message UndeployModelRequest {
string deployed_model_id = 2 [(google.api.field_behavior) = REQUIRED];
// If this field is provided, then the Endpoint's
- // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] will be overwritten with it. If
- // last DeployedModel is being undeployed from the Endpoint, the
- // [Endpoint.traffic_split] will always end up empty when this call returns.
- // A DeployedModel will be successfully undeployed only if it doesn't have
- // any traffic assigned to it when this method executes, or if this field
- // unassigns any traffic to it.
+ // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split]
+ // will be overwritten with it. If last DeployedModel is being undeployed from
+ // the Endpoint, the [Endpoint.traffic_split] will always end up empty when
+ // this call returns. A DeployedModel will be successfully undeployed only if
+ // it doesn't have any traffic assigned to it when this method executes, or if
+ // this field unassigns any traffic to it.
map traffic_split = 3;
}
-// Response message for [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel].
-message UndeployModelResponse {
-
-}
+// Response message for
+// [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel].
+message UndeployModelResponse {}
-// Runtime operation information for [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel].
+// Runtime operation information for
+// [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel].
message UndeployModelOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/entity_type.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/entity_type.proto
index 9bb2cdf09..445529203 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/entity_type.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/entity_type.proto
@@ -22,7 +22,7 @@ import "google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EntityTypeProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -52,12 +52,15 @@ message EntityType {
string description = 2 [(google.api.field_behavior) = OPTIONAL];
// Output only. Timestamp when this EntityType was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this EntityType was most recently updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. The labels with user-defined metadata to organize your EntityTypes.
+ // Optional. The labels with user-defined metadata to organize your
+ // EntityTypes.
//
// Label keys and values can be no longer than 64 characters
// (Unicode codepoints), can only contain lowercase letters, numeric
@@ -70,19 +73,21 @@ message EntityType {
// and are immutable.
map labels = 6 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Used to perform a consistent read-modify-write updates. If not set, a blind
- // "overwrite" update happens.
+ // Optional. Used to perform a consistent read-modify-write updates. If not
+ // set, a blind "overwrite" update happens.
string etag = 7 [(google.api.field_behavior) = OPTIONAL];
- // Optional. The default monitoring configuration for all Features with value type
- // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL, STRING, DOUBLE or INT64 under this
- // EntityType.
+ // Optional. The default monitoring configuration for all Features with value
+ // type
+ // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType])
+ // BOOL, STRING, DOUBLE or INT64 under this EntityType.
//
// If this is populated with
// [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot
// analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is
// disabled.
- FeaturestoreMonitoringConfig monitoring_config = 8 [(google.api.field_behavior) = OPTIONAL];
+ FeaturestoreMonitoringConfig monitoring_config = 8
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. Config for data retention policy in offline storage.
// TTL in days for feature values that will be stored in offline storage.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/env_var.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/env_var.proto
index 5e1d677b9..8dc7bbf17 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/env_var.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/env_var.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EnvVarProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/evaluated_annotation.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/evaluated_annotation.proto
new file mode 100644
index 000000000..9379cdeb3
--- /dev/null
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/evaluated_annotation.proto
@@ -0,0 +1,185 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.aiplatform.v1beta1;
+
+import "google/api/field_behavior.proto";
+import "google/cloud/aiplatform/v1beta1/explanation.proto";
+import "google/protobuf/struct.proto";
+
+option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
+option java_multiple_files = true;
+option java_outer_classname = "EvaluatedAnnotationProto";
+option java_package = "com.google.cloud.aiplatform.v1beta1";
+option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
+option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
+
+// True positive, false positive, or false negative.
+//
+// EvaluatedAnnotation is only available under ModelEvaluationSlice with slice
+// of `annotationSpec` dimension.
+message EvaluatedAnnotation {
+ // Describes the type of the EvaluatedAnnotation. The type is determined
+ enum EvaluatedAnnotationType {
+ // Invalid value.
+ EVALUATED_ANNOTATION_TYPE_UNSPECIFIED = 0;
+
+ // The EvaluatedAnnotation is a true positive. It has a prediction created
+ // by the Model and a ground truth Annotation which the prediction matches.
+ TRUE_POSITIVE = 1;
+
+ // The EvaluatedAnnotation is false positive. It has a prediction created by
+ // the Model which does not match any ground truth annotation.
+ FALSE_POSITIVE = 2;
+
+ // The EvaluatedAnnotation is false negative. It has a ground truth
+ // annotation which is not matched by any of the model created predictions.
+ FALSE_NEGATIVE = 3;
+ }
+
+ // Output only. Type of the EvaluatedAnnotation.
+ EvaluatedAnnotationType type = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The model predicted annotations.
+ //
+ // For true positive, there is one and only one prediction, which matches the
+ // only one ground truth annotation in
+ // [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths].
+ //
+ // For false positive, there is one and only one prediction, which doesn't
+ // match any ground truth annotation of the corresponding
+ // [data_item_view_id][EvaluatedAnnotation.data_item_view_id].
+ //
+ // For false negative, there are zero or more predictions which are similar to
+ // the only ground truth annotation in
+ // [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths]
+ // but not enough for a match.
+ //
+ // The schema of the prediction is stored in
+ // [ModelEvaluation.annotation_schema_uri][]
+ repeated google.protobuf.Value predictions = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The ground truth Annotations, i.e. the Annotations that exist
+ // in the test data the Model is evaluated on.
+ //
+ // For true positive, there is one and only one ground truth annotation, which
+ // matches the only prediction in
+ // [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
+ //
+ // For false positive, there are zero or more ground truth annotations that
+ // are similar to the only prediction in
+ // [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions],
+ // but not enough for a match.
+ //
+ // For false negative, there is one and only one ground truth annotation,
+ // which doesn't match any predictions created by the model.
+ //
+ // The schema of the ground truth is stored in
+ // [ModelEvaluation.annotation_schema_uri][]
+ repeated google.protobuf.Value ground_truths = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The data item payload that the Model predicted this
+ // EvaluatedAnnotation on.
+ google.protobuf.Value data_item_payload = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. ID of the EvaluatedDataItemView under the same ancestor
+ // ModelEvaluation. The EvaluatedDataItemView consists of all ground truths
+ // and predictions on
+ // [data_item_payload][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.data_item_payload].
+ //
+ // Can be passed in
+ // [GetEvaluatedDataItemView's][ModelService.GetEvaluatedDataItemView][]
+ // [id][GetEvaluatedDataItemViewRequest.id].
+ string evaluated_data_item_view_id = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Explanations of
+ // [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
+ // Each element of the explanations indicates the explanation for one
+ // explanation Method.
+ //
+ // The attributions list in the
+ // [EvaluatedAnnotationExplanation.explanation][google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation.explanation]
+ // object corresponds to the
+ // [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions]
+ // list. For example, the second element in the attributions list explains the
+ // second element in the predictions list.
+ repeated EvaluatedAnnotationExplanation explanations = 8;
+
+ // Annotations of model error analysis results.
+ repeated ErrorAnalysisAnnotation error_analysis_annotations = 9;
+}
+
+// Explanation result of the prediction produced by the Model.
+message EvaluatedAnnotationExplanation {
+ // Explanation type.
+ //
+ // For AutoML Image Classification models, possible values are:
+ //
+ // * `image-integrated-gradients`
+ // * `image-xrai`
+ string explanation_type = 1;
+
+ // Explanation attribution response details.
+ Explanation explanation = 2;
+}
+
+// Model error analysis for each annotation.
+message ErrorAnalysisAnnotation {
+ // Attributed items for a given annotation, typically representing neighbors
+ // from the training sets constrained by the query type.
+ message AttributedItem {
+ // The unique ID for each annotation. Used by FE to allocate the annotation
+ // in DB.
+ string annotation_resource_name = 1;
+
+ // The distance of this item to the annotation.
+ double distance = 2;
+ }
+
+ // The query type used for finding the attributed items.
+ enum QueryType {
+ // Unspecified query type for model error analysis.
+ QUERY_TYPE_UNSPECIFIED = 0;
+
+ // Query similar samples across all classes in the dataset.
+ ALL_SIMILAR = 1;
+
+ // Query similar samples from the same class of the input sample.
+ SAME_CLASS_SIMILAR = 2;
+
+ // Query dissimilar samples from the same class of the input sample.
+ SAME_CLASS_DISSIMILAR = 3;
+ }
+
+ // Attributed items for a given annotation, typically representing neighbors
+ // from the training sets constrained by the query type.
+ repeated AttributedItem attributed_items = 1;
+
+ // The query type used for finding the attributed items.
+ QueryType query_type = 2;
+
+ // The outlier score of this annotated item. Usually defined as the min of all
+ // distances from attributed items.
+ double outlier_score = 3;
+
+ // The threshold used to determine if this annotation is an outlier or not.
+ double outlier_threshold = 4;
+}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/event.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/event.proto
index 5cbb25c8c..d6c5794bf 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/event.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/event.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "EventProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -60,7 +60,8 @@ message Event {
];
// Output only. Time the Event occurred.
- google.protobuf.Timestamp event_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp event_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Required. The type of the Event.
Type type = 4 [(google.api.field_behavior) = REQUIRED];
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/execution.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/execution.proto
index 281b2a193..260c8246d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/execution.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/execution.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ExecutionProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -87,10 +87,12 @@ message Execution {
map labels = 10;
// Output only. Timestamp when this Execution was created.
- google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Execution was last updated.
- google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The title of the schema describing the metadata.
//
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/explanation.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/explanation.proto
index 6dccd06e4..28970d9d1 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/explanation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/explanation.proto
@@ -22,15 +22,17 @@ import "google/cloud/aiplatform/v1beta1/io.proto";
import "google/protobuf/struct.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ExplanationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
-// Explanation of a prediction (provided in [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions])
-// produced by the Model on a given [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances].
+// Explanation of a prediction (provided in
+// [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions])
+// produced by the Model on a given
+// [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances].
message Explanation {
// Output only. Feature attributions grouped by predicted outputs.
//
@@ -38,15 +40,21 @@ message Explanation {
// predict only one score, there is only one attibution that explains the
// predicted output. For Models that predict multiple outputs, such as
// multiclass Models that predict multiple classes, each element explains one
- // specific item. [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] can be used to identify which
- // output this attribution is explaining.
+ // specific item.
+ // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
+ // can be used to identify which output this attribution is explaining.
//
- // If users set [ExplanationParameters.top_k][google.cloud.aiplatform.v1beta1.ExplanationParameters.top_k], the attributions are sorted
- // by [instance_output_value][Attributions.instance_output_value] in
- // descending order. If [ExplanationParameters.output_indices][google.cloud.aiplatform.v1beta1.ExplanationParameters.output_indices] is specified,
- // the attributions are stored by [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] in the same
- // order as they appear in the output_indices.
- repeated Attribution attributions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // If users set
+ // [ExplanationParameters.top_k][google.cloud.aiplatform.v1beta1.ExplanationParameters.top_k],
+ // the attributions are sorted by
+ // [instance_output_value][Attributions.instance_output_value] in descending
+ // order. If
+ // [ExplanationParameters.output_indices][google.cloud.aiplatform.v1beta1.ExplanationParameters.output_indices]
+ // is specified, the attributions are stored by
+ // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
+ // in the same order as they appear in the output_indices.
+ repeated Attribution attributions = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. List of the nearest neighbors for example-based explanations.
//
@@ -57,54 +65,66 @@ message Explanation {
// Aggregated explanation metrics for a Model over a set of instances.
message ModelExplanation {
- // Output only. Aggregated attributions explaining the Model's prediction outputs over the
- // set of instances. The attributions are grouped by outputs.
+ // Output only. Aggregated attributions explaining the Model's prediction
+ // outputs over the set of instances. The attributions are grouped by outputs.
//
// For Models that predict only one output, such as regression Models that
// predict only one score, there is only one attibution that explains the
// predicted output. For Models that predict multiple outputs, such as
// multiclass Models that predict multiple classes, each element explains one
- // specific item. [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] can be used to identify which
- // output this attribution is explaining.
+ // specific item.
+ // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
+ // can be used to identify which output this attribution is explaining.
//
- // The [baselineOutputValue][google.cloud.aiplatform.v1beta1.Attribution.baseline_output_value],
- // [instanceOutputValue][google.cloud.aiplatform.v1beta1.Attribution.instance_output_value] and
- // [featureAttributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions] fields are
- // averaged over the test data.
+ // The
+ // [baselineOutputValue][google.cloud.aiplatform.v1beta1.Attribution.baseline_output_value],
+ // [instanceOutputValue][google.cloud.aiplatform.v1beta1.Attribution.instance_output_value]
+ // and
+ // [featureAttributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions]
+ // fields are averaged over the test data.
//
// NOTE: Currently AutoML tabular classification Models produce only one
// attribution, which averages attributions over all the classes it predicts.
- // [Attribution.approximation_error][google.cloud.aiplatform.v1beta1.Attribution.approximation_error] is not populated.
- repeated Attribution mean_attributions = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // [Attribution.approximation_error][google.cloud.aiplatform.v1beta1.Attribution.approximation_error]
+ // is not populated.
+ repeated Attribution mean_attributions = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Attribution that explains a particular prediction output.
message Attribution {
- // Output only. Model predicted output if the input instance is constructed from the
- // baselines of all the features defined in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs].
+ // Output only. Model predicted output if the input instance is constructed
+ // from the baselines of all the features defined in
+ // [ExplanationMetadata.inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs].
// The field name of the output is determined by the key in
// [ExplanationMetadata.outputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.outputs].
//
// If the Model's predicted output has multiple dimensions (rank > 1), this is
- // the value in the output located by [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index].
+ // the value in the output located by
+ // [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index].
//
// If there are multiple baselines, their output values are averaged.
double baseline_output_value = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Model predicted output on the corresponding [explanation
// instance][ExplainRequest.instances]. The field name of the output is
- // determined by the key in [ExplanationMetadata.outputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.outputs].
+ // determined by the key in
+ // [ExplanationMetadata.outputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.outputs].
//
// If the Model predicted output has multiple dimensions, this is the value in
- // the output located by [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index].
+ // the output located by
+ // [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index].
double instance_output_value = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Attributions of each explained feature. Features are extracted from
- // the [prediction instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] according to
- // [explanation metadata for inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs].
+ // Output only. Attributions of each explained feature. Features are extracted
+ // from the [prediction
+ // instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances]
+ // according to [explanation metadata for
+ // inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs].
//
// The value is a struct, whose keys are the name of the feature. The values
- // are how much the feature in the [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances]
+ // are how much the feature in the
+ // [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances]
// contributed to the predicted result.
//
// The format of the value is determined by the feature's input format:
@@ -121,11 +141,16 @@ message Attribution {
// struct. The formats of the values in the attribution struct are
// determined by the formats of the values in the feature struct.
//
- // The [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1beta1.ExplanationMetadata.feature_attributions_schema_uri] field,
- // pointed to by the [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] field of the
- // [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] object, points to the schema file that
- // describes the features and their attribution values (if it is populated).
- google.protobuf.Value feature_attributions = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // The
+ // [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1beta1.ExplanationMetadata.feature_attributions_schema_uri]
+ // field, pointed to by the
+ // [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] field of
+ // the
+ // [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models]
+ // object, points to the schema file that describes the features and their
+ // attribution values (if it is populated).
+ google.protobuf.Value feature_attributions = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The index that locates the explained prediction output.
//
@@ -136,8 +161,9 @@ message Attribution {
// of the output vector. Indices start from 0.
repeated int32 output_index = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The display name of the output identified by [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]. For example,
- // the predicted class name by a multi-classification Model.
+ // Output only. The display name of the output identified by
+ // [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index].
+ // For example, the predicted class name by a multi-classification Model.
//
// This field is only populated iff the Model predicts display names as a
// separate field along with the explained output. The predicted display name
@@ -145,20 +171,26 @@ message Attribution {
// output_index.
string output_display_name = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Error of [feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions] caused by approximation used in the
- // explanation method. Lower value means more precise attributions.
+ // Output only. Error of
+ // [feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions]
+ // caused by approximation used in the explanation method. Lower value means
+ // more precise attributions.
//
// * For Sampled Shapley
// [attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.sampled_shapley_attribution],
- // increasing [path_count][google.cloud.aiplatform.v1beta1.SampledShapleyAttribution.path_count] might reduce
- // the error.
+ // increasing
+ // [path_count][google.cloud.aiplatform.v1beta1.SampledShapleyAttribution.path_count]
+ // might reduce the error.
// * For Integrated Gradients
// [attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution],
- // increasing [step_count][google.cloud.aiplatform.v1beta1.IntegratedGradientsAttribution.step_count] might
- // reduce the error.
- // * For [XRAI attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution],
// increasing
- // [step_count][google.cloud.aiplatform.v1beta1.XraiAttribution.step_count] might reduce the error.
+ // [step_count][google.cloud.aiplatform.v1beta1.IntegratedGradientsAttribution.step_count]
+ // might reduce the error.
+ // * For [XRAI
+ // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution],
+ // increasing
+ // [step_count][google.cloud.aiplatform.v1beta1.XraiAttribution.step_count]
+ // might reduce the error.
//
// See [this introduction](/vertex-ai/docs/explainable-ai/overview)
// for more information.
@@ -224,13 +256,14 @@ message ExplanationParameters {
int32 top_k = 4;
// If populated, only returns attributions that have
- // [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] contained in output_indices. It
- // must be an ndarray of integers, with the same shape of the output it's
- // explaining.
+ // [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
+ // contained in output_indices. It must be an ndarray of integers, with the
+ // same shape of the output it's explaining.
//
- // If not populated, returns attributions for [top_k][google.cloud.aiplatform.v1beta1.ExplanationParameters.top_k] indices of outputs.
- // If neither top_k nor output_indices is populated, returns the argmax
- // index of the outputs.
+ // If not populated, returns attributions for
+ // [top_k][google.cloud.aiplatform.v1beta1.ExplanationParameters.top_k]
+ // indices of outputs. If neither top_k nor output_indices is populated,
+ // returns the argmax index of the outputs.
//
// Only applicable to Models that predict multiple outputs (e,g, multi-class
// Models that predict multiple classes).
@@ -241,8 +274,8 @@ message ExplanationParameters {
// contribute to the label being predicted. A sampling strategy is used to
// approximate the value rather than considering all subsets of features.
message SampledShapleyAttribution {
- // Required. The number of feature permutations to consider when approximating the
- // Shapley values.
+ // Required. The number of feature permutations to consider when approximating
+ // the Shapley values.
//
// Valid range of its value is [1, 50], inclusively.
int32 path_count = 1 [(google.api.field_behavior) = REQUIRED];
@@ -329,16 +362,18 @@ message SmoothGradConfig {
// paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1.
//
// If the distribution is different per feature, set
- // [feature_noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.feature_noise_sigma] instead
- // for each feature.
+ // [feature_noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.feature_noise_sigma]
+ // instead for each feature.
float noise_sigma = 1;
- // This is similar to [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma], but
- // provides additional flexibility. A separate noise sigma can be provided
- // for each feature, which is useful if their distributions are different.
- // No noise is added to features that are not set. If this field is unset,
- // [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma] will be used for all
- // features.
+ // This is similar to
+ // [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma],
+ // but provides additional flexibility. A separate noise sigma can be
+ // provided for each feature, which is useful if their distributions are
+ // different. No noise is added to features that are not set. If this field
+ // is unset,
+ // [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma]
+ // will be used for all features.
FeatureNoiseSigma feature_noise_sigma = 2;
}
@@ -357,13 +392,15 @@ message FeatureNoiseSigma {
message NoiseSigmaForFeature {
// The name of the input feature for which noise sigma is provided. The
// features are defined in
- // [explanation metadata inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs].
+ // [explanation metadata
+ // inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs].
string name = 1;
// This represents the standard deviation of the Gaussian kernel that will
// be used to add noise to the feature prior to computing gradients. Similar
- // to [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma] but represents the
- // noise added to the current feature. Defaults to 0.1.
+ // to
+ // [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma]
+ // but represents the noise added to the current feature. Defaults to 0.1.
float sigma = 2;
}
@@ -390,7 +427,8 @@ message BlurBaselineConfig {
message Examples {
oneof config {
// The configuration for the generated index, the semantics are the same as
- // [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match NearestNeighborSearchConfig.
+ // [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should
+ // match NearestNeighborSearchConfig.
google.protobuf.Value nearest_neighbor_search_config = 2;
// Preset config based on the desired query speed-precision trade-off
@@ -439,12 +477,13 @@ message Presets {
Modality modality = 2;
}
-// The [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] entries that can be overridden at
-// [online explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time.
+// The [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec]
+// entries that can be overridden at [online
+// explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time.
message ExplanationSpecOverride {
// The parameters to be overridden. Note that the
- // [method][google.cloud.aiplatform.v1beta1.ExplanationParameters.method] cannot be changed. If not specified,
- // no parameter is overridden.
+ // [method][google.cloud.aiplatform.v1beta1.ExplanationParameters.method]
+ // cannot be changed. If not specified, no parameter is overridden.
ExplanationParameters parameters = 1;
// The metadata to be overridden. If not specified, no metadata is overridden.
@@ -454,11 +493,14 @@ message ExplanationSpecOverride {
ExamplesOverride examples_override = 3;
}
-// The [ExplanationMetadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata] entries that can be overridden at
-// [online explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time.
+// The
+// [ExplanationMetadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata]
+// entries that can be overridden at [online
+// explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time.
message ExplanationMetadataOverride {
- // The [input metadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata] entries to be
- // overridden.
+ // The [input
+ // metadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata]
+ // entries to be overridden.
message InputMetadataOverride {
// Baseline inputs for this feature.
//
@@ -469,12 +511,14 @@ message ExplanationMetadataOverride {
repeated google.protobuf.Value input_baselines = 1;
}
- // Required. Overrides the [input metadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs] of the features.
- // The key is the name of the feature to be overridden. The keys specified
- // here must exist in the input metadata to be overridden. If a feature is
- // not specified here, the corresponding feature's input metadata is not
- // overridden.
- map inputs = 1 [(google.api.field_behavior) = REQUIRED];
+ // Required. Overrides the [input
+ // metadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs] of
+ // the features. The key is the name of the feature to be overridden. The keys
+ // specified here must exist in the input metadata to be overridden. If a
+ // feature is not specified here, the corresponding feature's input metadata
+ // is not overridden.
+ map inputs = 1
+ [(google.api.field_behavior) = REQUIRED];
}
// Overrides for example-based explanations.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/explanation_metadata.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/explanation_metadata.proto
index ef962a519..c7f079c8c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/explanation_metadata.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/explanation_metadata.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/protobuf/struct.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ExplanationMetadataProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -31,8 +31,10 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
message ExplanationMetadata {
// Metadata of the input of a feature.
//
- // Fields other than [InputMetadata.input_baselines][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.input_baselines] are applicable only
- // for Models that are using Vertex AI-provided images for Tensorflow.
+ // Fields other than
+ // [InputMetadata.input_baselines][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.input_baselines]
+ // are applicable only for Models that are using Vertex AI-provided images for
+ // Tensorflow.
message InputMetadata {
// Domain details of the input feature value. Provides numeric information
// about the feature, such as its range (min, max). If the feature has been
@@ -63,7 +65,8 @@ message ExplanationMetadata {
// Visualization configurations for image explanation.
message Visualization {
// Type of the image visualization. Only applicable to
- // [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution].
+ // [Integrated Gradients
+ // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution].
enum Type {
// Should not be used.
TYPE_UNSPECIFIED = 0;
@@ -141,7 +144,8 @@ message ExplanationMetadata {
}
// Type of the image visualization. Only applicable to
- // [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution].
+ // [Integrated Gradients
+ // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution].
// OUTLINES shows regions of attribution, while PIXELS shows per-pixel
// attribution. Defaults to OUTLINES.
Type type = 1;
@@ -153,12 +157,14 @@ message ExplanationMetadata {
// The color scheme used for the highlighted areas.
//
// Defaults to PINK_GREEN for
- // [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution],
+ // [Integrated Gradients
+ // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution],
// which shows positive attributions in green and negative in pink.
//
// Defaults to VIRIDIS for
- // [XRAI attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution], which
- // highlights the most influential regions in yellow and the least
+ // [XRAI
+ // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution],
+ // which highlights the most influential regions in yellow and the least
// influential in blue.
ColorMap color_map = 3;
@@ -188,8 +194,9 @@ message ExplanationMetadata {
IDENTITY = 1;
// The tensor represents a bag of features where each index maps to
- // a feature. [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping] must be provided for
- // this encoding. For example:
+ // a feature.
+ // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping]
+ // must be provided for this encoding. For example:
// ```
// input = [27, 6.0, 150]
// index_feature_mapping = ["age", "height", "weight"]
@@ -198,8 +205,9 @@ message ExplanationMetadata {
// The tensor represents a bag of features where each index maps to a
// feature. Zero values in the tensor indicates feature being
- // non-existent. [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping] must be provided
- // for this encoding. For example:
+ // non-existent.
+ // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping]
+ // must be provided for this encoding. For example:
// ```
// input = [2, 0, 5, 0, 1]
// index_feature_mapping = ["a", "b", "c", "d", "e"]
@@ -207,7 +215,8 @@ message ExplanationMetadata {
BAG_OF_FEATURES_SPARSE = 3;
// The tensor is a list of binaries representing whether a feature exists
- // or not (1 indicates existence). [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping]
+ // or not (1 indicates existence).
+ // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping]
// must be provided for this encoding. For example:
// ```
// input = [1, 0, 1, 0, 1]
@@ -216,8 +225,9 @@ message ExplanationMetadata {
INDICATOR = 4;
// The tensor is encoded into a 1-dimensional array represented by an
- // encoded tensor. [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoded_tensor_name] must be provided
- // for this encoding. For example:
+ // encoded tensor.
+ // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoded_tensor_name]
+ // must be provided for this encoding. For example:
// ```
// input = ["This", "is", "a", "test", "."]
// encoded = [0.1, 0.2, 0.3, 0.4, 0.5]
@@ -226,9 +236,9 @@ message ExplanationMetadata {
// Select this encoding when the input tensor is encoded into a
// 2-dimensional array represented by an encoded tensor.
- // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoded_tensor_name] must be provided for this
- // encoding. The first dimension of the encoded tensor's shape is the same
- // as the input tensor's shape. For example:
+ // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoded_tensor_name]
+ // must be provided for this encoding. The first dimension of the encoded
+ // tensor's shape is the same as the input tensor's shape. For example:
// ```
// input = ["This", "is", "a", "test", "."]
// encoded = [[0.1, 0.2, 0.3, 0.4, 0.5],
@@ -244,7 +254,8 @@ message ExplanationMetadata {
//
// If no baseline is specified, Vertex AI chooses the baseline for this
// feature. If multiple baselines are specified, Vertex AI returns the
- // average attributions across them in [Attribution.feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions].
+ // average attributions across them in
+ // [Attribution.feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions].
//
// For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape
// of each baseline must match the shape of the input tensor. If a scalar is
@@ -252,8 +263,9 @@ message ExplanationMetadata {
//
// For custom images, the element of the baselines must be in the same
// format as the feature's input in the
- // [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances][]. The schema of any single instance
- // may be specified via Endpoint's DeployedModels'
+ // [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances][].
+ // The schema of any single instance may be specified via Endpoint's
+ // DeployedModels'
// [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model]
// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
// [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
@@ -287,15 +299,18 @@ message ExplanationMetadata {
string dense_shape_tensor_name = 7;
// A list of feature names for each index in the input tensor.
- // Required when the input [InputMetadata.encoding][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoding] is BAG_OF_FEATURES,
- // BAG_OF_FEATURES_SPARSE, INDICATOR.
+ // Required when the input
+ // [InputMetadata.encoding][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoding]
+ // is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
repeated string index_feature_mapping = 8;
// Encoded tensor is a transformation of the input tensor. Must be provided
// if choosing
- // [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution]
- // or [XRAI attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution] and the
- // input tensor is not differentiable.
+ // [Integrated Gradients
+ // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution]
+ // or [XRAI
+ // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution]
+ // and the input tensor is not differentiable.
//
// An encoded tensor is generated if the input tensor is encoded by a lookup
// table.
@@ -315,17 +330,21 @@ message ExplanationMetadata {
// name will be treated as one feature when computing attributions. Features
// grouped together can have different shapes in value. If provided, there
// will be one single attribution generated in
- // [Attribution.feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions], keyed by the group name.
+ // [Attribution.feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions],
+ // keyed by the group name.
string group_name = 12;
}
// Metadata of the prediction output to be explained.
message OutputMetadata {
- // Defines how to map [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] to
+ // Defines how to map
+ // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
+ // to
// [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name].
//
// If neither of the fields are specified,
- // [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name] will not be populated.
+ // [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name]
+ // will not be populated.
oneof display_name_mapping {
// Static mapping between the index and display name.
//
@@ -337,8 +356,10 @@ message ExplanationMetadata {
//
// The shape of the value must be an n-dimensional array of strings. The
// number of dimensions must match that of the outputs to be explained.
- // The [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name] is populated by locating in the
- // mapping with [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index].
+ // The
+ // [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name]
+ // is populated by locating in the mapping with
+ // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index].
google.protobuf.Value index_display_name_mapping = 1;
// Specify a field name in the prediction to look for the display name.
@@ -346,8 +367,9 @@ message ExplanationMetadata {
// Use this if the prediction contains the display names for the outputs.
//
// The display names in the prediction must have the same shape of the
- // outputs, so that it can be located by [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] for
- // a specific output.
+ // outputs, so that it can be located by
+ // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]
+ // for a specific output.
string display_name_mapping_key = 2;
}
@@ -356,21 +378,23 @@ message ExplanationMetadata {
string output_tensor_name = 3;
}
- // Required. Map from feature names to feature input metadata. Keys are the name of the
- // features. Values are the specification of the feature.
+ // Required. Map from feature names to feature input metadata. Keys are the
+ // name of the features. Values are the specification of the feature.
//
// An empty InputMetadata is valid. It describes a text feature which has the
- // name specified as the key in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs]. The baseline
- // of the empty feature is chosen by Vertex AI.
+ // name specified as the key in
+ // [ExplanationMetadata.inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs].
+ // The baseline of the empty feature is chosen by Vertex AI.
//
// For Vertex AI-provided Tensorflow images, the key can be any friendly
// name of the feature. Once specified,
- // [featureAttributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions] are keyed by
- // this key (if not grouped with another feature).
+ // [featureAttributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions]
+ // are keyed by this key (if not grouped with another feature).
//
// For custom images, the key must match with the key in
// [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances].
- map inputs = 1 [(google.api.field_behavior) = REQUIRED];
+ map inputs = 1
+ [(google.api.field_behavior) = REQUIRED];
// Required. Map from output names to output metadata.
//
@@ -381,10 +405,12 @@ message ExplanationMetadata {
// to be explained.
//
// Currently only one key is allowed.
- map outputs = 2 [(google.api.field_behavior) = REQUIRED];
+ map outputs = 2
+ [(google.api.field_behavior) = REQUIRED];
// Points to a YAML file stored on Google Cloud Storage describing the format
- // of the [feature attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions].
+ // of the [feature
+ // attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions].
// The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
// AutoML tabular Models always have this field populated by Vertex AI.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature.proto
index cf67cf3e9..c9dc14a7c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature.proto
@@ -23,7 +23,7 @@ import "google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeatureProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -42,7 +42,9 @@ message Feature {
// A list of historical [Snapshot
// Analysis][FeaturestoreMonitoringConfig.SnapshotAnalysis] or [Import Feature
// Analysis] [FeaturestoreMonitoringConfig.ImportFeatureAnalysis] stats
- // requested by user, sorted by [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time] descending.
+ // requested by user, sorted by
+ // [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time]
+ // descending.
message MonitoringStatsAnomaly {
// If the objective in the request is both
// Import Feature Analysis and Snapshot Analysis, this objective could be
@@ -63,7 +65,8 @@ message Feature {
Objective objective = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The stats and anomalies generated at specific timestamp.
- FeatureStatsAnomaly feature_stats_anomaly = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ FeatureStatsAnomaly feature_stats_anomaly = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// An enum representing the value type of a feature.
@@ -119,10 +122,12 @@ message Feature {
];
// Output only. Timestamp when this EntityType was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this EntityType was most recently updated.
- google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The labels with user-defined metadata to organize your Features.
//
@@ -141,11 +146,11 @@ message Feature {
// "overwrite" update happens.
string etag = 7;
- // Optional. Deprecated: The custom monitoring configuration for this Feature, if not
- // set, use the monitoring_config defined for the EntityType this Feature
- // belongs to.
- // Only Features with type ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL, STRING, DOUBLE or
- // INT64 can enable monitoring.
+ // Optional. Deprecated: The custom monitoring configuration for this Feature,
+ // if not set, use the monitoring_config defined for the EntityType this
+ // Feature belongs to. Only Features with type
+ // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType])
+ // BOOL, STRING, DOUBLE or INT64 can enable monitoring.
//
// If this is populated with
// [FeaturestoreMonitoringConfig.disabled][] = true, snapshot analysis
@@ -153,15 +158,13 @@ message Feature {
// [FeaturestoreMonitoringConfig.monitoring_interval][] specified, snapshot
// analysis monitoring is enabled. Otherwise, snapshot analysis monitoring
// config is same as the EntityType's this Feature belongs to.
- FeaturestoreMonitoringConfig monitoring_config = 9 [
- deprecated = true,
- (google.api.field_behavior) = OPTIONAL
- ];
+ FeaturestoreMonitoringConfig monitoring_config = 9
+ [deprecated = true, (google.api.field_behavior) = OPTIONAL];
- // Optional. If not set, use the monitoring_config defined for the EntityType this
- // Feature belongs to.
- // Only Features with type ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL, STRING, DOUBLE or
- // INT64 can enable monitoring.
+ // Optional. If not set, use the monitoring_config defined for the EntityType
+ // this Feature belongs to. Only Features with type
+ // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType])
+ // BOOL, STRING, DOUBLE or INT64 can enable monitoring.
//
// If set to true, all types of data monitoring are disabled despite the
// config on EntityType.
@@ -169,10 +172,14 @@ message Feature {
// Output only. A list of historical [Snapshot
// Analysis][FeaturestoreMonitoringConfig.SnapshotAnalysis]
- // stats requested by user, sorted by [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time]
+ // stats requested by user, sorted by
+ // [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time]
// descending.
- repeated FeatureStatsAnomaly monitoring_stats = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated FeatureStatsAnomaly monitoring_stats = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The list of historical stats and anomalies with specified objectives.
- repeated MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The list of historical stats and anomalies with specified
+ // objectives.
+ repeated MonitoringStatsAnomaly monitoring_stats_anomalies = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature_monitoring_stats.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature_monitoring_stats.proto
index 30ffbd951..b1f490deb 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature_monitoring_stats.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature_monitoring_stats.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1;
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeatureMonitoringStatsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -39,7 +39,8 @@ message FeatureStatsAnomaly {
// Feature importance score, only populated when cross-feature monitoring is
// enabled. For now only used to represent feature attribution score within
// range [0, 1] for
- // [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW] and
+ // [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW]
+ // and
// [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT].
double score = 1;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature_selector.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature_selector.proto
index 907f14e23..c29347c49 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature_selector.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/feature_selector.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeatureSelectorProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore.proto
index 3a3026e77..8ae1c7d81 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore.proto
@@ -22,7 +22,7 @@ import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -45,13 +45,22 @@ message Featurestore {
// max_node_count are set to the same value, the cluster will be configured
// with the fixed number of node (no auto-scaling).
message Scaling {
- // Required. The minimum number of nodes to scale down to. Must be greater than or
- // equal to 1.
+ // Required. The minimum number of nodes to scale down to. Must be greater
+ // than or equal to 1.
int32 min_node_count = 1 [(google.api.field_behavior) = REQUIRED];
// The maximum number of nodes to scale up to. Must be greater than
// min_node_count, and less than or equal to 10 times of 'min_node_count'.
int32 max_node_count = 2;
+
+ // Optional. The cpu utilization that the Autoscaler should be trying to
+ // achieve. This number is on a scale from 0 (no utilization) to 100
+ // (total utilization), and is limited between 10 and 80. When a cluster's
+ // CPU utilization exceeds the target that you have set, Bigtable
+ // immediately adds nodes to the cluster. When CPU utilization is
+ // substantially lower than the target, Bigtable removes nodes. If not set
+ // or set to 0, default to 50.
+ int32 cpu_utilization_target = 3 [(google.api.field_behavior) = OPTIONAL];
}
// The number of nodes for the online store. The number of nodes doesn't
@@ -94,16 +103,19 @@ message Featurestore {
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Featurestore was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Featurestore was last updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. Used to perform consistent read-modify-write updates. If not set, a blind
- // "overwrite" update happens.
+ // Optional. Used to perform consistent read-modify-write updates. If not set,
+ // a blind "overwrite" update happens.
string etag = 5 [(google.api.field_behavior) = OPTIONAL];
- // Optional. The labels with user-defined metadata to organize your Featurestore.
+ // Optional. The labels with user-defined metadata to organize your
+ // Featurestore.
//
// Label keys and values can be no longer than 64 characters
// (Unicode codepoints), can only contain lowercase letters, numeric
@@ -116,25 +128,25 @@ message Featurestore {
// and are immutable.
map labels = 6 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Config for online storage resources. The field should not co-exist with the
- // field of `OnlineStoreReplicationConfig`. If both of it and
- // OnlineStoreReplicationConfig are unset, the feature store will not have an
- // online store and cannot be used for online serving.
- OnlineServingConfig online_serving_config = 7 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. Config for online storage resources. The field should not
+ // co-exist with the field of `OnlineStoreReplicationConfig`. If both of it
+ // and OnlineStoreReplicationConfig are unset, the feature store will not have
+ // an online store and cannot be used for online serving.
+ OnlineServingConfig online_serving_config = 7
+ [(google.api.field_behavior) = OPTIONAL];
// Output only. State of the featurestore.
State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. TTL in days for feature values that will be stored in online serving
- // storage. The Feature Store online storage periodically removes obsolete
- // feature values older than `online_storage_ttl_days` since the feature
- // generation time.
- // Note that `online_storage_ttl_days` should be less than or equal to
- // `offline_storage_ttl_days` for each EntityType under a featurestore.
- // If not set, default to 4000 days
+ // Optional. TTL in days for feature values that will be stored in online
+ // serving storage. The Feature Store online storage periodically removes
+ // obsolete feature values older than `online_storage_ttl_days` since the
+ // feature generation time. Note that `online_storage_ttl_days` should be less
+ // than or equal to `offline_storage_ttl_days` for each EntityType under a
+ // featurestore. If not set, default to 4000 days
int32 online_storage_ttl_days = 13 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Customer-managed encryption key spec for data storage. If set, both of the
- // online and offline data storage will be secured by this key.
+ // Optional. Customer-managed encryption key spec for data storage. If set,
+ // both of the online and offline data storage will be secured by this key.
EncryptionSpec encryption_spec = 10 [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto
index fefe9e772..7099d8e0b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1;
import "google/protobuf/duration.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreMonitoringProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -48,16 +48,16 @@ message FeaturestoreMonitoringConfig {
// Configuration of the snapshot analysis based monitoring pipeline running
// interval. The value is rolled up to full day.
+ // If both
+ // [monitoring_interval_days][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days]
+ // and the deprecated `monitoring_interval` field
+ // are set when creating/updating EntityTypes/Features,
+ // [monitoring_interval_days][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days]
+ // will be used.
google.protobuf.Duration monitoring_interval = 2 [deprecated = true];
// Configuration of the snapshot analysis based monitoring pipeline
// running interval. The value indicates number of days.
- // If both
- // [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days]
- // and [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval]
- // are set when creating/updating EntityTypes/Features,
- // [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days]
- // will be used.
int32 monitoring_interval_days = 3;
// Customized export features time window for snapshot analysis. Unit is one
@@ -68,7 +68,9 @@ message FeaturestoreMonitoringConfig {
// Configuration of the Featurestore's ImportFeature Analysis Based
// Monitoring. This type of analysis generates statistics for values of each
- // Feature imported by every [ImportFeatureValues][] operation.
+ // Feature imported by every
+ // [ImportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues]
+ // operation.
message ImportFeaturesAnalysis {
// The state defines whether to enable ImportFeature analysis.
enum State {
@@ -95,7 +97,9 @@ message FeaturestoreMonitoringConfig {
}
// Defines the baseline to do anomaly detection for feature values imported
- // by each [ImportFeatureValues][] operation.
+ // by each
+ // [ImportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues]
+ // operation.
enum Baseline {
// Should not be used.
BASELINE_UNSPECIFIED = 0;
@@ -145,11 +149,15 @@ message FeaturestoreMonitoringConfig {
// Threshold for numerical features of anomaly detection.
// This is shared by all objectives of Featurestore Monitoring for numerical
- // features (i.e. Features with type ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) DOUBLE or INT64).
+ // features (i.e. Features with type
+ // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType])
+ // DOUBLE or INT64).
ThresholdConfig numerical_threshold_config = 3;
// Threshold for categorical features of anomaly detection.
// This is shared by all types of Featurestore Monitoring for categorical
- // features (i.e. Features with type ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL or STRING).
+ // features (i.e. Features with type
+ // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType])
+ // BOOL or STRING).
ThresholdConfig categorical_threshold_config = 4;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_online_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_online_service.proto
index 5f7cbd144..0a6922b9d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_online_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_online_service.proto
@@ -25,7 +25,7 @@ import "google/cloud/aiplatform/v1beta1/types.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreOnlineServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -35,12 +35,14 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for serving online feature values.
service FeaturestoreOnlineServingService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Reads Feature values of a specific entity of an EntityType. For reading
// feature values of multiple entities of an EntityType, please use
// StreamingReadFeatureValues.
- rpc ReadFeatureValues(ReadFeatureValuesRequest) returns (ReadFeatureValuesResponse) {
+ rpc ReadFeatureValues(ReadFeatureValuesRequest)
+ returns (ReadFeatureValuesResponse) {
option (google.api.http) = {
post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:readFeatureValues"
body: "*"
@@ -51,7 +53,8 @@ service FeaturestoreOnlineServingService {
// Reads Feature values for multiple entities. Depending on their size, data
// for different entities may be broken
// up across multiple responses.
- rpc StreamingReadFeatureValues(StreamingReadFeatureValuesRequest) returns (stream ReadFeatureValuesResponse) {
+ rpc StreamingReadFeatureValues(StreamingReadFeatureValuesRequest)
+ returns (stream ReadFeatureValuesResponse) {
option (google.api.http) = {
post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:streamingReadFeatureValues"
body: "*"
@@ -64,7 +67,8 @@ service FeaturestoreOnlineServingService {
// The Feature values are merged into existing entities if any. The Feature
// values to be written must have timestamp within the online storage
// retention.
- rpc WriteFeatureValues(WriteFeatureValuesRequest) returns (WriteFeatureValuesResponse) {
+ rpc WriteFeatureValues(WriteFeatureValuesRequest)
+ returns (WriteFeatureValuesResponse) {
option (google.api.http) = {
post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:writeFeatureValues"
body: "*"
@@ -73,10 +77,12 @@ service FeaturestoreOnlineServingService {
}
}
-// Request message for [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues].
+// Request message for
+// [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues].
message WriteFeatureValuesRequest {
- // Required. The resource name of the EntityType for the entities being written.
- // Value format: `projects/{project}/locations/{location}/featurestores/
+ // Required. The resource name of the EntityType for the entities being
+ // written. Value format:
+ // `projects/{project}/locations/{location}/featurestores/
// {featurestore}/entityTypes/{entityType}`. For example,
// for a machine learning model predicting user clicks on a website, an
// EntityType ID could be `user`.
@@ -87,9 +93,10 @@ message WriteFeatureValuesRequest {
}
];
- // Required. The entities to be written. Up to 100,000 feature values can be written
- // across all `payloads`.
- repeated WriteFeatureValuesPayload payloads = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The entities to be written. Up to 100,000 feature values can be
+ // written across all `payloads`.
+ repeated WriteFeatureValuesPayload payloads = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Contains Feature values to be written for a specific entity.
@@ -97,19 +104,20 @@ message WriteFeatureValuesPayload {
// Required. The ID of the entity.
string entity_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. Feature values to be written, mapping from Feature ID to value. Up to
- // 100,000 `feature_values` entries may be written across all payloads. The
- // feature generation time, aligned by days, must be no older than five
+ // Required. Feature values to be written, mapping from Feature ID to value.
+ // Up to 100,000 `feature_values` entries may be written across all payloads.
+ // The feature generation time, aligned by days, must be no older than five
// years (1825 days) and no later than one year (366 days) in the future.
- map feature_values = 2 [(google.api.field_behavior) = REQUIRED];
+ map feature_values = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues].
-message WriteFeatureValuesResponse {
-
-}
+// Response message for
+// [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues].
+message WriteFeatureValuesResponse {}
-// Request message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues].
+// Request message for
+// [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues].
message ReadFeatureValuesRequest {
// Required. The resource name of the EntityType for the entity being read.
// Value format:
@@ -132,7 +140,8 @@ message ReadFeatureValuesRequest {
FeatureSelector feature_selector = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues].
+// Response message for
+// [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues].
message ReadFeatureValuesResponse {
// Metadata for requested Features.
message FeatureDescriptor {
@@ -141,14 +150,16 @@ message ReadFeatureValuesResponse {
}
// Response header with metadata for the requested
- // [ReadFeatureValuesRequest.entity_type][google.cloud.aiplatform.v1beta1.ReadFeatureValuesRequest.entity_type] and Features.
+ // [ReadFeatureValuesRequest.entity_type][google.cloud.aiplatform.v1beta1.ReadFeatureValuesRequest.entity_type]
+ // and Features.
message Header {
// The resource name of the EntityType from the
- // [ReadFeatureValuesRequest][google.cloud.aiplatform.v1beta1.ReadFeatureValuesRequest]. Value format:
+ // [ReadFeatureValuesRequest][google.cloud.aiplatform.v1beta1.ReadFeatureValuesRequest].
+ // Value format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
string entity_type = 1 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/EntityType"
- }];
+ type: "aiplatform.googleapis.com/EntityType"
+ }];
// List of Feature metadata corresponding to each piece of
// [ReadFeatureValuesResponse.data][].
@@ -179,7 +190,8 @@ message ReadFeatureValuesResponse {
// requested values for one requested Feature. If no values
// for the requested Feature exist, the corresponding cell will be empty.
// This has the same size and is in the same order as the features from the
- // header [ReadFeatureValuesResponse.header][google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse.header].
+ // header
+ // [ReadFeatureValuesResponse.header][google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse.header].
repeated Data data = 2;
}
@@ -209,13 +221,13 @@ message StreamingReadFeatureValuesRequest {
}
];
- // Required. IDs of entities to read Feature values of. The maximum number of IDs is
- // 100. For example, for a machine learning model predicting user clicks on a
- // website, an entity ID could be `user_123`.
+ // Required. IDs of entities to read Feature values of. The maximum number of
+ // IDs is 100. For example, for a machine learning model predicting user
+ // clicks on a website, an entity ID could be `user_123`.
repeated string entity_ids = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. Selector choosing Features of the target EntityType. Feature IDs will be
- // deduplicated.
+ // Required. Selector choosing Features of the target EntityType. Feature IDs
+ // will be deduplicated.
FeatureSelector feature_selector = 3 [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_service.proto
index 5db9e02bf..86fa13380 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/featurestore_service.proto
@@ -27,12 +27,13 @@ import "google/cloud/aiplatform/v1beta1/featurestore.proto";
import "google/cloud/aiplatform/v1beta1/io.proto";
import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "google/type/interval.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -42,16 +43,19 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// The service that handles CRUD and List for resources for Featurestore.
service FeaturestoreService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a new Featurestore in a given project and location.
- rpc CreateFeaturestore(CreateFeaturestoreRequest) returns (google.longrunning.Operation) {
+ rpc CreateFeaturestore(CreateFeaturestoreRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/featurestores"
body: "featurestore"
};
option (google.api.method_signature) = "parent,featurestore";
- option (google.api.method_signature) = "parent,featurestore,featurestore_id";
+ option (google.api.method_signature) =
+ "parent,featurestore,featurestore_id";
option (google.longrunning.operation_info) = {
response_type: "Featurestore"
metadata_type: "CreateFeaturestoreOperationMetadata"
@@ -67,7 +71,8 @@ service FeaturestoreService {
}
// Lists Featurestores in a given project and location.
- rpc ListFeaturestores(ListFeaturestoresRequest) returns (ListFeaturestoresResponse) {
+ rpc ListFeaturestores(ListFeaturestoresRequest)
+ returns (ListFeaturestoresResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/featurestores"
};
@@ -75,7 +80,8 @@ service FeaturestoreService {
}
// Updates the parameters of a single Featurestore.
- rpc UpdateFeaturestore(UpdateFeaturestoreRequest) returns (google.longrunning.Operation) {
+ rpc UpdateFeaturestore(UpdateFeaturestoreRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1beta1/{featurestore.name=projects/*/locations/*/featurestores/*}"
body: "featurestore"
@@ -89,7 +95,8 @@ service FeaturestoreService {
// Deletes a single Featurestore. The Featurestore must not contain any
// EntityTypes or `force` must be set to true for the request to succeed.
- rpc DeleteFeaturestore(DeleteFeaturestoreRequest) returns (google.longrunning.Operation) {
+ rpc DeleteFeaturestore(DeleteFeaturestoreRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/featurestores/*}"
};
@@ -102,7 +109,8 @@ service FeaturestoreService {
}
// Creates a new EntityType in a given Featurestore.
- rpc CreateEntityType(CreateEntityTypeRequest) returns (google.longrunning.Operation) {
+ rpc CreateEntityType(CreateEntityTypeRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/featurestores/*}/entityTypes"
body: "entity_type"
@@ -124,7 +132,8 @@ service FeaturestoreService {
}
// Lists EntityTypes in a given Featurestore.
- rpc ListEntityTypes(ListEntityTypesRequest) returns (ListEntityTypesResponse) {
+ rpc ListEntityTypes(ListEntityTypesRequest)
+ returns (ListEntityTypesResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/featurestores/*}/entityTypes"
};
@@ -142,7 +151,8 @@ service FeaturestoreService {
// Deletes a single EntityType. The EntityType must not have any Features
// or `force` must be set to true for the request to succeed.
- rpc DeleteEntityType(DeleteEntityTypeRequest) returns (google.longrunning.Operation) {
+ rpc DeleteEntityType(DeleteEntityTypeRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/featurestores/*/entityTypes/*}"
};
@@ -155,7 +165,8 @@ service FeaturestoreService {
}
// Creates a new Feature in a given EntityType.
- rpc CreateFeature(CreateFeatureRequest) returns (google.longrunning.Operation) {
+ rpc CreateFeature(CreateFeatureRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/featurestores/*/entityTypes/*}/features"
body: "feature"
@@ -169,7 +180,8 @@ service FeaturestoreService {
}
// Creates a batch of Features in a given EntityType.
- rpc BatchCreateFeatures(BatchCreateFeaturesRequest) returns (google.longrunning.Operation) {
+ rpc BatchCreateFeatures(BatchCreateFeaturesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/featurestores/*/entityTypes/*}/features:batchCreate"
body: "*"
@@ -207,7 +219,8 @@ service FeaturestoreService {
}
// Deletes a single Feature.
- rpc DeleteFeature(DeleteFeatureRequest) returns (google.longrunning.Operation) {
+ rpc DeleteFeature(DeleteFeatureRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*}"
};
@@ -238,7 +251,8 @@ service FeaturestoreService {
// include but are not limited to changing storage location, storage class,
// or retention policy.
// - Online serving cluster is under-provisioned.
- rpc ImportFeatureValues(ImportFeatureValuesRequest) returns (google.longrunning.Operation) {
+ rpc ImportFeatureValues(ImportFeatureValuesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:importFeatureValues"
body: "*"
@@ -256,7 +270,8 @@ service FeaturestoreService {
// instance in the batch may read Feature values of entities from one or
// more EntityTypes. Point-in-time correctness is guaranteed for Feature
// values of each read instance as of each instance's read timestamp.
- rpc BatchReadFeatureValues(BatchReadFeatureValuesRequest) returns (google.longrunning.Operation) {
+ rpc BatchReadFeatureValues(BatchReadFeatureValuesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{featurestore=projects/*/locations/*/featurestores/*}:batchReadFeatureValues"
body: "*"
@@ -269,7 +284,8 @@ service FeaturestoreService {
}
// Exports Feature values from all the entities of a target EntityType.
- rpc ExportFeatureValues(ExportFeatureValuesRequest) returns (google.longrunning.Operation) {
+ rpc ExportFeatureValues(ExportFeatureValuesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:exportFeatureValues"
body: "*"
@@ -291,7 +307,8 @@ service FeaturestoreService {
// returned from reads and exports may be inconsistent. If consistency is
// required, the caller must retry the same delete request again and wait till
// the new operation returned is marked as successfully done.
- rpc DeleteFeatureValues(DeleteFeatureValuesRequest) returns (google.longrunning.Operation) {
+ rpc DeleteFeatureValues(DeleteFeatureValuesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:deleteFeatureValues"
body: "*"
@@ -313,7 +330,8 @@ service FeaturestoreService {
}
}
-// Request message for [FeaturestoreService.CreateFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeaturestore].
+// Request message for
+// [FeaturestoreService.CreateFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeaturestore].
message CreateFeaturestoreRequest {
// Required. The resource name of the Location to create Featurestores.
// Format:
@@ -328,8 +346,8 @@ message CreateFeaturestoreRequest {
// Required. The Featurestore to create.
Featurestore featurestore = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. The ID to use for this Featurestore, which will become the final component
- // of the Featurestore's resource name.
+ // Required. The ID to use for this Featurestore, which will become the final
+ // component of the Featurestore's resource name.
//
// This value may be up to 60 characters, and valid characters are
// `[a-z0-9_]`. The first character cannot be a number.
@@ -338,7 +356,8 @@ message CreateFeaturestoreRequest {
string featurestore_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [FeaturestoreService.GetFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeaturestore].
+// Request message for
+// [FeaturestoreService.GetFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeaturestore].
message GetFeaturestoreRequest {
// Required. The name of the Featurestore resource.
string name = 1 [
@@ -349,7 +368,8 @@ message GetFeaturestoreRequest {
];
}
-// Request message for [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores].
+// Request message for
+// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores].
message ListFeaturestoresRequest {
// Required. The resource name of the Location to list Featurestores.
// Format:
@@ -389,12 +409,12 @@ message ListFeaturestoresRequest {
int32 page_size = 3;
// A page token, received from a previous
- // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores] call.
- // Provide this to retrieve the subsequent page.
+ // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores] must
- // match the call that provided the page token.
+ // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores]
+ // must match the call that provided the page token.
string page_token = 4;
// A comma-separated list of fields to order by, sorted in ascending order.
@@ -410,22 +430,24 @@ message ListFeaturestoresRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores].
+// Response message for
+// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores].
message ListFeaturestoresResponse {
// The Featurestores matching the request.
repeated Featurestore featurestores = 1;
- // A token, which can be sent as [ListFeaturestoresRequest.page_token][google.cloud.aiplatform.v1beta1.ListFeaturestoresRequest.page_token] to
- // retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // A token, which can be sent as
+ // [ListFeaturestoresRequest.page_token][google.cloud.aiplatform.v1beta1.ListFeaturestoresRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [FeaturestoreService.UpdateFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeaturestore].
+// Request message for
+// [FeaturestoreService.UpdateFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeaturestore].
message UpdateFeaturestoreRequest {
- // Required. The Featurestore's `name` field is used to identify the Featurestore to be
- // updated.
- // Format:
+ // Required. The Featurestore's `name` field is used to identify the
+ // Featurestore to be updated. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}`
Featurestore featurestore = 1 [(google.api.field_behavior) = REQUIRED];
@@ -442,11 +464,12 @@ message UpdateFeaturestoreRequest {
// * `labels`
// * `online_serving_config.fixed_node_count`
// * `online_serving_config.scaling`
- // * `online_storage_ttl_days`
+ // * `online_storage_ttl_days` (available in Preview)
google.protobuf.FieldMask update_mask = 2;
}
-// Request message for [FeaturestoreService.DeleteFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeaturestore].
+// Request message for
+// [FeaturestoreService.DeleteFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeaturestore].
message DeleteFeaturestoreRequest {
// Required. The name of the Featurestore to be deleted.
// Format:
@@ -464,12 +487,13 @@ message DeleteFeaturestoreRequest {
bool force = 2;
}
-// Request message for [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues].
+// Request message for
+// [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues].
message ImportFeatureValuesRequest {
// Defines the Feature value(s) to import.
message FeatureSpec {
- // Required. ID of the Feature to import values of. This Feature must exist in the
- // target EntityType, or the request will fail.
+ // Required. ID of the Feature to import values of. This Feature must exist
+ // in the target EntityType, or the request will fail.
string id = 1 [(google.api.field_behavior) = REQUIRED];
// Source column to get the Feature values from. If not set, uses the column
@@ -499,8 +523,8 @@ message ImportFeatureValuesRequest {
google.protobuf.Timestamp feature_time = 7;
}
- // Required. The resource name of the EntityType grouping the Features for which values
- // are being imported. Format:
+ // Required. The resource name of the EntityType grouping the Features for
+ // which values are being imported. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
string entity_type = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -513,10 +537,11 @@ message ImportFeatureValuesRequest {
// extracted from the column named `entity_id`.
string entity_id_field = 5;
- // Required. Specifications defining which Feature values to import from the entity. The
- // request fails if no feature_specs are provided, and having multiple
- // feature_specs for one Feature is not allowed.
- repeated FeatureSpec feature_specs = 8 [(google.api.field_behavior) = REQUIRED];
+ // Required. Specifications defining which Feature values to import from the
+ // entity. The request fails if no feature_specs are provided, and having
+ // multiple feature_specs for one Feature is not allowed.
+ repeated FeatureSpec feature_specs = 8
+ [(google.api.field_behavior) = REQUIRED];
// If set, data will not be imported for online serving. This
// is typically used for backfilling, where Feature generation timestamps are
@@ -535,7 +560,8 @@ message ImportFeatureValuesRequest {
bool disable_ingestion_analysis = 12;
}
-// Response message for [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues].
+// Response message for
+// [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues].
message ImportFeatureValuesResponse {
// Number of entities that have been imported by the operation.
int64 imported_entity_count = 1;
@@ -555,25 +581,30 @@ message ImportFeatureValuesResponse {
int64 timestamp_outside_retention_rows_count = 4;
}
-// Request message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues].
+// Request message for
+// [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues].
message BatchReadFeatureValuesRequest {
// Describe pass-through fields in read_instance source.
message PassThroughField {
- // Required. The name of the field in the CSV header or the name of the column in
- // BigQuery table. The naming restriction is the same as [Feature.name][google.cloud.aiplatform.v1beta1.Feature.name].
+ // Required. The name of the field in the CSV header or the name of the
+ // column in BigQuery table. The naming restriction is the same as
+ // [Feature.name][google.cloud.aiplatform.v1beta1.Feature.name].
string field_name = 1 [(google.api.field_behavior) = REQUIRED];
}
// Selects Features of an EntityType to read values of and specifies read
// settings.
message EntityTypeSpec {
- // Required. ID of the EntityType to select Features. The EntityType id is the
- // [entity_type_id][google.cloud.aiplatform.v1beta1.CreateEntityTypeRequest.entity_type_id] specified
- // during EntityType creation.
+ // Required. ID of the EntityType to select Features. The EntityType id is
+ // the
+ // [entity_type_id][google.cloud.aiplatform.v1beta1.CreateEntityTypeRequest.entity_type_id]
+ // specified during EntityType creation.
string entity_type_id = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. Selectors choosing which Feature values to read from the EntityType.
- FeatureSelector feature_selector = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. Selectors choosing which Feature values to read from the
+ // EntityType.
+ FeatureSelector feature_selector = 2
+ [(google.api.field_behavior) = REQUIRED];
// Per-Feature settings for the batch read.
repeated DestinationFeatureSetting settings = 3;
@@ -610,8 +641,8 @@ message BatchReadFeatureValuesRequest {
BigQuerySource bigquery_read_instances = 5;
}
- // Required. The resource name of the Featurestore from which to query Feature values.
- // Format:
+ // Required. The resource name of the Featurestore from which to query Feature
+ // values. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}`
string featurestore = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -621,7 +652,8 @@ message BatchReadFeatureValuesRequest {
];
// Required. Specifies output location and format.
- FeatureValueDestination destination = 4 [(google.api.field_behavior) = REQUIRED];
+ FeatureValueDestination destination = 4
+ [(google.api.field_behavior) = REQUIRED];
// When not empty, the specified fields in the *_read_instances source will be
// joined as-is in the output, in addition to those fields from the
@@ -632,20 +664,23 @@ message BatchReadFeatureValuesRequest {
// passed as opaque bytes.
repeated PassThroughField pass_through_fields = 8;
- // Required. Specifies EntityType grouping Features to read values of and settings.
- // Each EntityType referenced in
+ // Required. Specifies EntityType grouping Features to read values of and
+ // settings. Each EntityType referenced in
// [BatchReadFeatureValuesRequest.entity_type_specs] must have a column
// specifying entity IDs in the EntityType in
// [BatchReadFeatureValuesRequest.request][] .
- repeated EntityTypeSpec entity_type_specs = 7 [(google.api.field_behavior) = REQUIRED];
+ repeated EntityTypeSpec entity_type_specs = 7
+ [(google.api.field_behavior) = REQUIRED];
- // Optional. Excludes Feature values with feature generation timestamp before this
- // timestamp. If not set, retrieve oldest values kept in Feature Store.
+ // Optional. Excludes Feature values with feature generation timestamp before
+ // this timestamp. If not set, retrieve oldest values kept in Feature Store.
// Timestamp, if present, must not have higher than millisecond precision.
- google.protobuf.Timestamp start_time = 11 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.Timestamp start_time = 11
+ [(google.api.field_behavior) = OPTIONAL];
}
-// Request message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues].
+// Request message for
+// [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues].
message ExportFeatureValuesRequest {
// Describes exporting the latest Feature values of all entities of the
// EntityType between [start_time, snapshot_time].
@@ -686,8 +721,8 @@ message ExportFeatureValuesRequest {
FullExport full_export = 7;
}
- // Required. The resource name of the EntityType from which to export Feature values.
- // Format:
+ // Required. The resource name of the EntityType from which to export Feature
+ // values. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
string entity_type = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -697,7 +732,8 @@ message ExportFeatureValuesRequest {
];
// Required. Specifies destination location and format.
- FeatureValueDestination destination = 4 [(google.api.field_behavior) = REQUIRED];
+ FeatureValueDestination destination = 4
+ [(google.api.field_behavior) = REQUIRED];
// Required. Selects Features to export values of.
FeatureSelector feature_selector = 5 [(google.api.field_behavior) = REQUIRED];
@@ -719,8 +755,10 @@ message DestinationFeatureSetting {
message FeatureValueDestination {
oneof destination {
// Output in BigQuery format.
- // [BigQueryDestination.output_uri][google.cloud.aiplatform.v1beta1.BigQueryDestination.output_uri] in
- // [FeatureValueDestination.bigquery_destination][google.cloud.aiplatform.v1beta1.FeatureValueDestination.bigquery_destination] must refer to a table.
+ // [BigQueryDestination.output_uri][google.cloud.aiplatform.v1beta1.BigQueryDestination.output_uri]
+ // in
+ // [FeatureValueDestination.bigquery_destination][google.cloud.aiplatform.v1beta1.FeatureValueDestination.bigquery_destination]
+ // must refer to a table.
BigQueryDestination bigquery_destination = 1;
// Output in TFRecord format.
@@ -742,17 +780,16 @@ message FeatureValueDestination {
}
}
-// Response message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues].
-message ExportFeatureValuesResponse {
+// Response message for
+// [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues].
+message ExportFeatureValuesResponse {}
-}
-
-// Response message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues].
-message BatchReadFeatureValuesResponse {
+// Response message for
+// [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues].
+message BatchReadFeatureValuesResponse {}
-}
-
-// Request message for [FeaturestoreService.CreateEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateEntityType].
+// Request message for
+// [FeaturestoreService.CreateEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateEntityType].
message CreateEntityTypeRequest {
// Required. The resource name of the Featurestore to create EntityTypes.
// Format:
@@ -767,8 +804,8 @@ message CreateEntityTypeRequest {
// The EntityType to create.
EntityType entity_type = 2;
- // Required. The ID to use for the EntityType, which will become the final component of
- // the EntityType's resource name.
+ // Required. The ID to use for the EntityType, which will become the final
+ // component of the EntityType's resource name.
//
// This value may be up to 60 characters, and valid characters are
// `[a-z0-9_]`. The first character cannot be a number.
@@ -777,7 +814,8 @@ message CreateEntityTypeRequest {
string entity_type_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [FeaturestoreService.GetEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetEntityType].
+// Request message for
+// [FeaturestoreService.GetEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetEntityType].
message GetEntityTypeRequest {
// Required. The name of the EntityType resource.
// Format:
@@ -790,7 +828,8 @@ message GetEntityTypeRequest {
];
}
-// Request message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes].
+// Request message for
+// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes].
message ListEntityTypesRequest {
// Required. The resource name of the Featurestore to list EntityTypes.
// Format:
@@ -829,12 +868,12 @@ message ListEntityTypesRequest {
int32 page_size = 3;
// A page token, received from a previous
- // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes] call.
- // Provide this to retrieve the subsequent page.
+ // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes] must
- // match the call that provided the page token.
+ // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes]
+ // must match the call that provided the page token.
string page_token = 4;
// A comma-separated list of fields to order by, sorted in ascending order.
@@ -851,22 +890,24 @@ message ListEntityTypesRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes].
+// Response message for
+// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes].
message ListEntityTypesResponse {
// The EntityTypes matching the request.
repeated EntityType entity_types = 1;
- // A token, which can be sent as [ListEntityTypesRequest.page_token][google.cloud.aiplatform.v1beta1.ListEntityTypesRequest.page_token] to
- // retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // A token, which can be sent as
+ // [ListEntityTypesRequest.page_token][google.cloud.aiplatform.v1beta1.ListEntityTypesRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [FeaturestoreService.UpdateEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateEntityType].
+// Request message for
+// [FeaturestoreService.UpdateEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateEntityType].
message UpdateEntityTypeRequest {
- // Required. The EntityType's `name` field is used to identify the EntityType to be
- // updated.
- // Format:
+ // Required. The EntityType's `name` field is used to identify the EntityType
+ // to be updated. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
EntityType entity_type = 1 [(google.api.field_behavior) = REQUIRED];
@@ -889,7 +930,7 @@ message UpdateEntityTypeRequest {
// * `monitoring_config.import_features_analysis.anomaly_detection_baseline`
// * `monitoring_config.numerical_threshold_config.value`
// * `monitoring_config.categorical_threshold_config.value`
- // * `offline_storage_ttl_days`
+ // * `offline_storage_ttl_days` (available in Preview)
google.protobuf.FieldMask update_mask = 2;
}
@@ -910,7 +951,8 @@ message DeleteEntityTypeRequest {
bool force = 2;
}
-// Request message for [FeaturestoreService.CreateFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeature].
+// Request message for
+// [FeaturestoreService.CreateFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeature].
message CreateFeatureRequest {
// Required. The resource name of the EntityType to create a Feature.
// Format:
@@ -925,8 +967,8 @@ message CreateFeatureRequest {
// Required. The Feature to create.
Feature feature = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. The ID to use for the Feature, which will become the final component of
- // the Feature's resource name.
+ // Required. The ID to use for the Feature, which will become the final
+ // component of the Feature's resource name.
//
// This value may be up to 128 characters, and valid characters are
// `[a-z0-9_]`. The first character cannot be a number.
@@ -935,10 +977,11 @@ message CreateFeatureRequest {
string feature_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures].
+// Request message for
+// [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures].
message BatchCreateFeaturesRequest {
- // Required. The resource name of the EntityType to create the batch of Features under.
- // Format:
+ // Required. The resource name of the EntityType to create the batch of
+ // Features under. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -947,20 +990,24 @@ message BatchCreateFeaturesRequest {
}
];
- // Required. The request message specifying the Features to create. All Features must be
- // created under the same parent EntityType. The `parent` field in each child
- // request message can be omitted. If `parent` is set in a child request, then
- // the value must match the `parent` value in this request message.
- repeated CreateFeatureRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The request message specifying the Features to create. All
+ // Features must be created under the same parent EntityType. The `parent`
+ // field in each child request message can be omitted. If `parent` is set in a
+ // child request, then the value must match the `parent` value in this request
+ // message.
+ repeated CreateFeatureRequest requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures].
+// Response message for
+// [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures].
message BatchCreateFeaturesResponse {
// The Features created.
repeated Feature features = 1;
}
-// Request message for [FeaturestoreService.GetFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeature].
+// Request message for
+// [FeaturestoreService.GetFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeature].
message GetFeatureRequest {
// Required. The name of the Feature resource.
// Format:
@@ -973,7 +1020,8 @@ message GetFeatureRequest {
];
}
-// Request message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures].
+// Request message for
+// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures].
message ListFeaturesRequest {
// Required. The resource name of the Location to list Features.
// Format:
@@ -1014,12 +1062,12 @@ message ListFeaturesRequest {
int32 page_size = 3;
// A page token, received from a previous
- // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures] call.
- // Provide this to retrieve the subsequent page.
+ // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures] must
- // match the call that provided the page token.
+ // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures]
+ // must match the call that provided the page token.
string page_token = 4;
// A comma-separated list of fields to order by, sorted in ascending order.
@@ -1035,25 +1083,30 @@ message ListFeaturesRequest {
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 6;
- // If set, return the most recent [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count]
+ // If set, return the most recent
+ // [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count]
// of stats for each Feature in response. Valid value is [0, 10]. If number of
- // stats exists < [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count], return all
- // existing stats.
+ // stats exists <
+ // [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count],
+ // return all existing stats.
int32 latest_stats_count = 7;
}
-// Response message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures].
+// Response message for
+// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures].
message ListFeaturesResponse {
// The Features matching the request.
repeated Feature features = 1;
- // A token, which can be sent as [ListFeaturesRequest.page_token][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.page_token] to
- // retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // A token, which can be sent as
+ // [ListFeaturesRequest.page_token][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures].
+// Request message for
+// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures].
message SearchFeaturesRequest {
// Required. The resource name of the Location to search Features.
// Format:
@@ -1133,16 +1186,17 @@ message SearchFeaturesRequest {
int32 page_size = 4;
// A page token, received from a previous
- // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures] call.
- // Provide this to retrieve the subsequent page.
+ // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures], except `page_size`, must
- // match the call that provided the page token.
+ // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures],
+ // except `page_size`, must match the call that provided the page token.
string page_token = 5;
}
-// Response message for [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures].
+// Response message for
+// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures].
message SearchFeaturesResponse {
// The Features matching the request.
//
@@ -1155,13 +1209,15 @@ message SearchFeaturesResponse {
// * `update_time`
repeated Feature features = 1;
- // A token, which can be sent as [SearchFeaturesRequest.page_token][google.cloud.aiplatform.v1beta1.SearchFeaturesRequest.page_token] to
- // retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // A token, which can be sent as
+ // [SearchFeaturesRequest.page_token][google.cloud.aiplatform.v1beta1.SearchFeaturesRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [FeaturestoreService.UpdateFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeature].
+// Request message for
+// [FeaturestoreService.UpdateFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeature].
message UpdateFeatureRequest {
// Required. The Feature's `name` field is used to identify the Feature to be
// updated.
@@ -1185,7 +1241,8 @@ message UpdateFeatureRequest {
google.protobuf.FieldMask update_mask = 2;
}
-// Request message for [FeaturestoreService.DeleteFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeature].
+// Request message for
+// [FeaturestoreService.DeleteFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeature].
message DeleteFeatureRequest {
// Required. The name of the Features to be deleted.
// Format:
@@ -1272,15 +1329,17 @@ message BatchCreateFeaturesOperationMetadata {
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues].
+// Request message for
+// [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues].
message DeleteFeatureValuesRequest {
// Message to select entity.
// If an entity id is selected, all the feature values corresponding to the
// entity id will be deleted, including the entityId.
message SelectEntity {
- // Required. Selectors choosing feature values of which entity id to be deleted from
- // the EntityType.
- EntityIdSelector entity_id_selector = 1 [(google.api.field_behavior) = REQUIRED];
+ // Required. Selectors choosing feature values of which entity id to be
+ // deleted from the EntityType.
+ EntityIdSelector entity_id_selector = 1
+ [(google.api.field_behavior) = REQUIRED];
}
// Message to select time range and feature.
@@ -1292,11 +1351,13 @@ message DeleteFeatureValuesRequest {
message SelectTimeRangeAndFeature {
// Required. Select feature generated within a half-inclusive time range.
// The time range is lower inclusive and upper exclusive.
- google.type.Interval time_range = 1 [(google.api.field_behavior) = REQUIRED];
+ google.type.Interval time_range = 1
+ [(google.api.field_behavior) = REQUIRED];
// Required. Selectors choosing which feature values to be deleted from the
// EntityType.
- FeatureSelector feature_selector = 2 [(google.api.field_behavior) = REQUIRED];
+ FeatureSelector feature_selector = 2
+ [(google.api.field_behavior) = REQUIRED];
// If set, data will not be deleted from online storage.
// When time range is older than the data in online storage, setting this to
@@ -1314,8 +1375,8 @@ message DeleteFeatureValuesRequest {
SelectTimeRangeAndFeature select_time_range_and_feature = 3;
}
- // Required. The resource name of the EntityType grouping the Features for which values
- // are being deleted from. Format:
+ // Required. The resource name of the EntityType grouping the Features for
+ // which values are being deleted from. Format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
string entity_type = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -1325,9 +1386,50 @@ message DeleteFeatureValuesRequest {
];
}
-// Response message for [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues].
+// Response message for
+// [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues].
message DeleteFeatureValuesResponse {
+ // Response message if the request uses the SelectEntity option.
+ message SelectEntity {
+ // The count of deleted entity rows in the offline storage.
+ // Each row corresponds to the combination of an entity ID and a timestamp.
+ // One entity ID can have multiple rows in the offline storage.
+ int64 offline_storage_deleted_entity_row_count = 1;
+
+ // The count of deleted entities in the online storage.
+ // Each entity ID corresponds to one entity.
+ int64 online_storage_deleted_entity_count = 2;
+ }
+ // Response message if the request uses the SelectTimeRangeAndFeature option.
+ message SelectTimeRangeAndFeature {
+ // The count of the features or columns impacted.
+ // This is the same as the feature count in the request.
+ int64 impacted_feature_count = 1;
+
+ // The count of modified entity rows in the offline storage.
+ // Each row corresponds to the combination of an entity ID and a timestamp.
+ // One entity ID can have multiple rows in the offline storage.
+ // Within each row, only the features specified in the request are
+ // deleted.
+ int64 offline_storage_modified_entity_row_count = 2;
+
+ // The count of modified entities in the online storage.
+ // Each entity ID corresponds to one entity.
+ // Within each entity, only the features specified in the request are
+ // deleted.
+ int64 online_storage_modified_entity_count = 3;
+ }
+
+ // Response based on which delete option is specified in the
+ // request
+ oneof response {
+ // Response for request specifying the entities to delete
+ SelectEntity select_entity = 1;
+
+ // Response for request specifying time range and feature
+ SelectTimeRangeAndFeature select_time_range_and_feature = 2;
+ }
}
// Selector for entityId. Getting ids from the given source.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto
index 587680bc3..7f8e8c183 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto
@@ -26,7 +26,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "HyperparameterTuningJobProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -66,8 +66,8 @@ message HyperparameterTuningJob {
// before the whole job fails.
int32 max_failed_trial_count = 7;
- // Required. The spec of a trial job. The same spec applies to the CustomJobs created
- // in all the trials.
+ // Required. The spec of a trial job. The same spec applies to the CustomJobs
+ // created in all the trials.
CustomJobSpec trial_job_spec = 8 [(google.api.field_behavior) = REQUIRED];
// Output only. Trials of the HyperparameterTuningJob.
@@ -77,18 +77,24 @@ message HyperparameterTuningJob {
JobState state = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the HyperparameterTuningJob was created.
- google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Time when the HyperparameterTuningJob for the first time entered the
- // `JOB_STATE_RUNNING` state.
- google.protobuf.Timestamp start_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Time when the HyperparameterTuningJob entered any of the following states:
- // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
- google.protobuf.Timestamp end_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Time when the HyperparameterTuningJob was most recently updated.
- google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the HyperparameterTuningJob for the first time
+ // entered the `JOB_STATE_RUNNING` state.
+ google.protobuf.Timestamp start_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the HyperparameterTuningJob entered any of the
+ // following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
+ // `JOB_STATE_CANCELLED`.
+ google.protobuf.Timestamp end_time = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the HyperparameterTuningJob was most recently
+ // updated.
+ google.protobuf.Timestamp update_time = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Only populated when job's state is JOB_STATE_FAILED or
// JOB_STATE_CANCELLED.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/index.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/index.proto
index 9e010542e..35dbfe230 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/index.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/index.proto
@@ -23,7 +23,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "IndexProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -64,10 +64,10 @@ message Index {
// The description of the Index.
string description = 3;
- // Immutable. Points to a YAML file stored on Google Cloud Storage describing additional
- // information about the Index, that is specific to it. Unset if the Index
- // does not have any additional information.
- // The schema is defined as an OpenAPI 3.0.2 [Schema
+ // Immutable. Points to a YAML file stored on Google Cloud Storage describing
+ // additional information about the Index, that is specific to it. Unset if
+ // the Index does not have any additional information. The schema is defined
+ // as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
// Note: The URI given on output will be immutable and probably different,
// including the URI scheme, than the one given on input. The output URI will
@@ -75,13 +75,15 @@ message Index {
string metadata_schema_uri = 4 [(google.api.field_behavior) = IMMUTABLE];
// An additional information about the Index; the schema of the metadata can
- // be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Index.metadata_schema_uri].
+ // be found in
+ // [metadata_schema][google.cloud.aiplatform.v1beta1.Index.metadata_schema_uri].
google.protobuf.Value metadata = 6;
// Output only. The pointers to DeployedIndexes created from this Index.
// An Index can be only deleted if all its DeployedIndexes had been undeployed
// first.
- repeated DeployedIndexRef deployed_indexes = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated DeployedIndexRef deployed_indexes = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Used to perform consistent read-modify-write updates. If not set, a blind
// "overwrite" update happens.
@@ -97,24 +99,27 @@ message Index {
map labels = 9;
// Output only. Timestamp when this Index was created.
- google.protobuf.Timestamp create_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Index was most recently updated.
// This also includes any update to the contents of the Index.
// Note that Operations working on this Index may have their
// [Operations.metadata.generic_metadata.update_time]
- // [google.cloud.aiplatform.v1beta1.GenericOperationMetadata.update_time] a little after the value of this
- // timestamp, yet that does not mean their results are not already reflected
- // in the Index. Result of any successfully completed Operation on the Index
- // is reflected in it.
- google.protobuf.Timestamp update_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // [google.cloud.aiplatform.v1beta1.GenericOperationMetadata.update_time] a
+ // little after the value of this timestamp, yet that does not mean their
+ // results are not already reflected in the Index. Result of any successfully
+ // completed Operation on the Index is reflected in it.
+ google.protobuf.Timestamp update_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Stats of the index resource.
IndexStats index_stats = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be
- // used by default.
- IndexUpdateMethod index_update_method = 16 [(google.api.field_behavior) = IMMUTABLE];
+ // Immutable. The update method to use with this Index. If not set,
+ // BATCH_UPDATE will be used by default.
+ IndexUpdateMethod index_update_method = 16
+ [(google.api.field_behavior) = IMMUTABLE];
}
// A datapoint of Index.
@@ -151,14 +156,14 @@ message IndexDatapoint {
// [NearestNeighborSearchConfig.dimensions].
repeated float feature_vector = 2 [(google.api.field_behavior) = REQUIRED];
- // Optional. List of Restrict of the datapoint, used to perform "restricted searches"
- // where boolean rule are used to filter the subset of the database eligible
- // for matching.
- // See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
+ // Optional. List of Restrict of the datapoint, used to perform "restricted
+ // searches" where boolean rule are used to filter the subset of the database
+ // eligible for matching. See:
+ // https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
repeated Restriction restricts = 4 [(google.api.field_behavior) = OPTIONAL];
- // Optional. CrowdingTag of the datapoint, the number of neighbors to return in each
- // crowding can be configured during query.
+ // Optional. CrowdingTag of the datapoint, the number of neighbors to return
+ // in each crowding can be configured during query.
CrowdingTag crowding_tag = 5 [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_endpoint.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_endpoint.proto
index ba443ca38..fc387c80b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_endpoint.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_endpoint.proto
@@ -19,10 +19,11 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/machine_resources.proto";
+import "google/cloud/aiplatform/v1beta1/service_networking.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "IndexEndpointProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -49,7 +50,8 @@ message IndexEndpoint {
string description = 3;
// Output only. The indexes deployed in this endpoint.
- repeated DeployedIndex deployed_indexes = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated DeployedIndex deployed_indexes = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Used to perform consistent read-modify-write updates. If not set, a blind
// "overwrite" update happens.
@@ -65,13 +67,15 @@ message IndexEndpoint {
map labels = 6;
// Output only. Timestamp when this IndexEndpoint was created.
- google.protobuf.Timestamp create_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this IndexEndpoint was last updated.
// This timestamp is not updated when the endpoint's DeployedIndexes are
// updated, e.g. due to updates of the original Indexes they are the
// deployments of.
- google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The full name of the Google Compute Engine
// [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
@@ -90,15 +94,23 @@ message IndexEndpoint {
// network name.
string network = 9 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Deprecated: If true, expose the IndexEndpoint via private service connect.
+ // Optional. Deprecated: If true, expose the IndexEndpoint via private service
+ // connect.
//
- // Only one of the fields, [network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] or
+ // Only one of the fields,
+ // [network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] or
// [enable_private_service_connect][google.cloud.aiplatform.v1beta1.IndexEndpoint.enable_private_service_connect],
// can be set.
- bool enable_private_service_connect = 10 [
- deprecated = true,
- (google.api.field_behavior) = OPTIONAL
- ];
+ bool enable_private_service_connect = 10
+ [deprecated = true, (google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Configuration for private service connect.
+ //
+ // [network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] and
+ // [private_service_connect_config][google.cloud.aiplatform.v1beta1.IndexEndpoint.private_service_connect_config]
+ // are mutually exclusive.
+ PrivateServiceConnectConfig private_service_connect_config = 12
+ [(google.api.field_behavior) = OPTIONAL];
}
// A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.
@@ -123,20 +135,25 @@ message DeployedIndex {
string display_name = 3;
// Output only. Timestamp when the DeployedIndex was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Provides paths for users to send requests directly to the deployed index
- // services running on Cloud via private services access. This field is
- // populated if [network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is configured.
- IndexPrivateEndpoints private_endpoints = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The DeployedIndex may depend on various data on its original Index.
- // Additionally when certain changes to the original Index are being done
- // (e.g. when what the Index contains is being changed) the DeployedIndex may
- // be asynchronously updated in the background to reflect this changes.
- // If this timestamp's value is at least the [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of the
- // original Index, it means that this DeployedIndex and the original Index are
- // in sync. If this timestamp is older, then to see which updates this
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Provides paths for users to send requests directly to the
+ // deployed index services running on Cloud via private services access. This
+ // field is populated if
+ // [network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is
+ // configured.
+ IndexPrivateEndpoints private_endpoints = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The DeployedIndex may depend on various data on its original
+ // Index. Additionally when certain changes to the original Index are being
+ // done (e.g. when what the Index contains is being changed) the DeployedIndex
+ // may be asynchronously updated in the background to reflect this changes. If
+ // this timestamp's value is at least the
+ // [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of
+ // the original Index, it means that this DeployedIndex and the original Index
+ // are in sync. If this timestamp is older, then to see which updates this
// DeployedIndex already contains (and which not), one must
// [list][Operations.ListOperations] [Operations][Operation]
// [working][Operation.name] on the original Index. Only
@@ -144,30 +161,41 @@ message DeployedIndex {
// [Operations.metadata.generic_metadata.update_time]
// [google.cloud.aiplatform.v1beta1.GenericOperationMetadata.update_time]
// equal or before this sync time are contained in this DeployedIndex.
- google.protobuf.Timestamp index_sync_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp index_sync_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Optional. A description of resources that the DeployedIndex uses, which to large
- // degree are decided by Vertex AI, and optionally allows only a modest
+ // Optional. A description of resources that the DeployedIndex uses, which to
+ // large degree are decided by Vertex AI, and optionally allows only a modest
// additional configuration.
// If min_replica_count is not set, the default value is 2 (we don't provide
// SLA when min_replica_count=1). If max_replica_count is not set, the
// default value is min_replica_count. The max allowed replica count is
// 1000.
- AutomaticResources automatic_resources = 7 [(google.api.field_behavior) = OPTIONAL];
-
- // Optional. A description of resources that are dedicated to the DeployedIndex, and
- // that need a higher degree of manual configuration.
- // If min_replica_count is not set, the default value is 2 (we don't provide
- // SLA when min_replica_count=1). If max_replica_count is not set, the
- // default value is min_replica_count. The max allowed replica count is
- // 1000.
+ AutomaticResources automatic_resources = 7
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. A description of resources that are dedicated to the
+ // DeployedIndex, and that need a higher degree of manual configuration. If
+ // min_replica_count is not set, the default value is 2 (we don't provide SLA
+ // when min_replica_count=1). If max_replica_count is not set, the default
+ // value is min_replica_count. The max allowed replica count is 1000.
+ //
+ // Available machine types for SMALL shard:
+ // e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
+ //
+ // Available machine types for MEDIUM shard:
+ // e2-standard-16 and all machine types available for LARGE shard.
+ //
+ // Available machine types for LARGE shard:
+ // e2-highmem-16, n2d-standard-32.
//
- // Available machine types:
- // n1-standard-16
- // n1-standard-32
- DedicatedResources dedicated_resources = 16 [(google.api.field_behavior) = OPTIONAL];
+ // n1-standard-16 and n1-standard-32 are still available, but we recommend
+ // e2-standard-16 and e2-highmem-16 for cost efficiency.
+ DedicatedResources dedicated_resources = 16
+ [(google.api.field_behavior) = OPTIONAL];
- // Optional. If true, private endpoint's access logs are sent to StackDriver Logging.
+ // Optional. If true, private endpoint's access logs are sent to StackDriver
+ // Logging.
//
// These logs are like standard server access logs, containing
// information like timestamp and latency for each MatchRequest.
@@ -178,7 +206,8 @@ message DeployedIndex {
bool enable_access_logging = 8 [(google.api.field_behavior) = OPTIONAL];
// Optional. If set, the authentication is enabled for the private endpoint.
- DeployedIndexAuthConfig deployed_index_auth_config = 9 [(google.api.field_behavior) = OPTIONAL];
+ DeployedIndexAuthConfig deployed_index_auth_config = 9
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. A list of reserved ip ranges under the VPC network that can be
// used for this DeployedIndex.
@@ -190,7 +219,8 @@ message DeployedIndex {
// The value sohuld be the name of the address
// (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
// Example: 'vertex-ai-ip-range'.
- repeated string reserved_ip_ranges = 10 [(google.api.field_behavior) = OPTIONAL];
+ repeated string reserved_ip_ranges = 10
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. The deployment group can be no longer than 64 characters (eg:
// 'test', 'prod'). If not set, we will use the 'default' deployment group.
@@ -239,7 +269,7 @@ message IndexPrivateEndpoints {
// Output only. The ip address used to send match gRPC requests.
string match_grpc_address = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The name of the service attachment resource. Populated if private service
- // connect is enabled.
+ // Output only. The name of the service attachment resource. Populated if
+ // private service connect is enabled.
string service_attachment = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_endpoint_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_endpoint_service.proto
index c688741fa..fbbc5095c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_endpoint_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_endpoint_service.proto
@@ -23,10 +23,11 @@ import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/index_endpoint.proto";
import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "IndexEndpointServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -36,10 +37,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for managing Vertex AI's IndexEndpoints.
service IndexEndpointService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates an IndexEndpoint.
- rpc CreateIndexEndpoint(CreateIndexEndpointRequest) returns (google.longrunning.Operation) {
+ rpc CreateIndexEndpoint(CreateIndexEndpointRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/indexEndpoints"
body: "index_endpoint"
@@ -60,7 +63,8 @@ service IndexEndpointService {
}
// Lists IndexEndpoints in a Location.
- rpc ListIndexEndpoints(ListIndexEndpointsRequest) returns (ListIndexEndpointsResponse) {
+ rpc ListIndexEndpoints(ListIndexEndpointsRequest)
+ returns (ListIndexEndpointsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/indexEndpoints"
};
@@ -77,7 +81,8 @@ service IndexEndpointService {
}
// Deletes an IndexEndpoint.
- rpc DeleteIndexEndpoint(DeleteIndexEndpointRequest) returns (google.longrunning.Operation) {
+ rpc DeleteIndexEndpoint(DeleteIndexEndpointRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/indexEndpoints/*}"
};
@@ -105,7 +110,8 @@ service IndexEndpointService {
// Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it,
// and freeing all resources it's using.
- rpc UndeployIndex(UndeployIndexRequest) returns (google.longrunning.Operation) {
+ rpc UndeployIndex(UndeployIndexRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:undeployIndex"
body: "*"
@@ -118,7 +124,8 @@ service IndexEndpointService {
}
// Update an existing DeployedIndex under an IndexEndpoint.
- rpc MutateDeployedIndex(MutateDeployedIndexRequest) returns (google.longrunning.Operation) {
+ rpc MutateDeployedIndex(MutateDeployedIndexRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:mutateDeployedIndex"
body: "deployed_index"
@@ -131,7 +138,8 @@ service IndexEndpointService {
}
}
-// Request message for [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.CreateIndexEndpoint].
+// Request message for
+// [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.CreateIndexEndpoint].
message CreateIndexEndpointRequest {
// Required. The resource name of the Location to create the IndexEndpoint in.
// Format: `projects/{project}/locations/{location}`
@@ -153,7 +161,8 @@ message CreateIndexEndpointOperationMetadata {
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.GetIndexEndpoint]
+// Request message for
+// [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.GetIndexEndpoint]
message GetIndexEndpointRequest {
// Required. The name of the IndexEndpoint resource.
// Format:
@@ -166,10 +175,11 @@ message GetIndexEndpointRequest {
];
}
-// Request message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints].
+// Request message for
+// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints].
message ListIndexEndpointsRequest {
- // Required. The resource name of the Location from which to list the IndexEndpoints.
- // Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location from which to list the
+ // IndexEndpoints. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -177,8 +187,8 @@ message ListIndexEndpointsRequest {
}
];
- // Optional. An expression for filtering the results of the request. For field names
- // both snake_case and camelCase are supported.
+ // Optional. An expression for filtering the results of the request. For field
+ // names both snake_case and camelCase are supported.
//
// * `index_endpoint` supports = and !=. `index_endpoint` represents the
// IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
@@ -202,34 +212,44 @@ message ListIndexEndpointsRequest {
// Optional. The standard list page token.
// Typically obtained via
- // [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token] of the previous
- // [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints] call.
+ // [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token]
+ // of the previous
+ // [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints]
+ // call.
string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. Mask specifying which fields to read.
- google.protobuf.FieldMask read_mask = 5 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.FieldMask read_mask = 5
+ [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints].
+// Response message for
+// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints].
message ListIndexEndpointsResponse {
// List of IndexEndpoints in the requested page.
repeated IndexEndpoint index_endpoints = 1;
// A token to retrieve next page of results.
- // Pass to [ListIndexEndpointsRequest.page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListIndexEndpointsRequest.page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.UpdateIndexEndpoint].
+// Request message for
+// [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.UpdateIndexEndpoint].
message UpdateIndexEndpointRequest {
// Required. The IndexEndpoint which replaces the resource on the server.
IndexEndpoint index_endpoint = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The update mask applies to the resource. See
+ // [google.protobuf.FieldMask][google.protobuf.FieldMask].
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeleteIndexEndpoint].
+// Request message for
+// [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeleteIndexEndpoint].
message DeleteIndexEndpointRequest {
// Required. The name of the IndexEndpoint resource to be deleted.
// Format:
@@ -242,10 +262,11 @@ message DeleteIndexEndpointRequest {
];
}
-// Request message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex].
+// Request message for
+// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex].
message DeployIndexRequest {
- // Required. The name of the IndexEndpoint resource into which to deploy an Index.
- // Format:
+ // Required. The name of the IndexEndpoint resource into which to deploy an
+ // Index. Format:
// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
string index_endpoint = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -258,13 +279,15 @@ message DeployIndexRequest {
DeployedIndex deployed_index = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex].
+// Response message for
+// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex].
message DeployIndexResponse {
// The DeployedIndex that had been deployed in the IndexEndpoint.
DeployedIndex deployed_index = 1;
}
-// Runtime operation information for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex].
+// Runtime operation information for
+// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex].
message DeployIndexOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
@@ -273,10 +296,11 @@ message DeployIndexOperationMetadata {
string deployed_index_id = 2;
}
-// Request message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex].
+// Request message for
+// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex].
message UndeployIndexRequest {
- // Required. The name of the IndexEndpoint resource from which to undeploy an Index.
- // Format:
+ // Required. The name of the IndexEndpoint resource from which to undeploy an
+ // Index. Format:
// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
string index_endpoint = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -285,25 +309,27 @@ message UndeployIndexRequest {
}
];
- // Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
+ // Required. The ID of the DeployedIndex to be undeployed from the
+ // IndexEndpoint.
string deployed_index_id = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex].
-message UndeployIndexResponse {
+// Response message for
+// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex].
+message UndeployIndexResponse {}
-}
-
-// Runtime operation information for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex].
+// Runtime operation information for
+// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex].
message UndeployIndexOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex].
+// Request message for
+// [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex].
message MutateDeployedIndexRequest {
- // Required. The name of the IndexEndpoint resource into which to deploy an Index.
- // Format:
+ // Required. The name of the IndexEndpoint resource into which to deploy an
+ // Index. Format:
// `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
string index_endpoint = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -318,7 +344,8 @@ message MutateDeployedIndexRequest {
DeployedIndex deployed_index = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex].
+// Response message for
+// [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex].
message MutateDeployedIndexResponse {
// The DeployedIndex that had been updated in the IndexEndpoint.
DeployedIndex deployed_index = 1;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_service.proto
index 813f648c9..f74394c0e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/index_service.proto
@@ -23,10 +23,11 @@ import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/index.proto";
import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "IndexServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -36,7 +37,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for creating and managing Vertex AI's Index resources.
service IndexService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates an Index.
rpc CreateIndex(CreateIndexRequest) returns (google.longrunning.Operation) {
@@ -82,7 +84,8 @@ service IndexService {
// Deletes an Index.
// An Index can only be deleted when all its
- // [DeployedIndexes][google.cloud.aiplatform.v1beta1.Index.deployed_indexes] had been undeployed.
+ // [DeployedIndexes][google.cloud.aiplatform.v1beta1.Index.deployed_indexes]
+ // had been undeployed.
rpc DeleteIndex(DeleteIndexRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/indexes/*}"
@@ -95,7 +98,8 @@ service IndexService {
}
// Add/update Datapoints into an Index.
- rpc UpsertDatapoints(UpsertDatapointsRequest) returns (UpsertDatapointsResponse) {
+ rpc UpsertDatapoints(UpsertDatapointsRequest)
+ returns (UpsertDatapointsResponse) {
option (google.api.http) = {
post: "/v1beta1/{index=projects/*/locations/*/indexes/*}:upsertDatapoints"
body: "*"
@@ -103,7 +107,8 @@ service IndexService {
}
// Remove Datapoints from an Index.
- rpc RemoveDatapoints(RemoveDatapointsRequest) returns (RemoveDatapointsResponse) {
+ rpc RemoveDatapoints(RemoveDatapointsRequest)
+ returns (RemoveDatapointsResponse) {
option (google.api.http) = {
post: "/v1beta1/{index=projects/*/locations/*/indexes/*}:removeDatapoints"
body: "*"
@@ -111,7 +116,8 @@ service IndexService {
}
}
-// Request message for [IndexService.CreateIndex][google.cloud.aiplatform.v1beta1.IndexService.CreateIndex].
+// Request message for
+// [IndexService.CreateIndex][google.cloud.aiplatform.v1beta1.IndexService.CreateIndex].
message CreateIndexRequest {
// Required. The resource name of the Location to create the Index in.
// Format: `projects/{project}/locations/{location}`
@@ -126,16 +132,19 @@ message CreateIndexRequest {
Index index = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Runtime operation information for [IndexService.CreateIndex][google.cloud.aiplatform.v1beta1.IndexService.CreateIndex].
+// Runtime operation information for
+// [IndexService.CreateIndex][google.cloud.aiplatform.v1beta1.IndexService.CreateIndex].
message CreateIndexOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
// The operation metadata with regard to Matching Engine Index operation.
- NearestNeighborSearchOperationMetadata nearest_neighbor_search_operation_metadata = 2;
+ NearestNeighborSearchOperationMetadata
+ nearest_neighbor_search_operation_metadata = 2;
}
-// Request message for [IndexService.GetIndex][google.cloud.aiplatform.v1beta1.IndexService.GetIndex]
+// Request message for
+// [IndexService.GetIndex][google.cloud.aiplatform.v1beta1.IndexService.GetIndex]
message GetIndexRequest {
// Required. The name of the Index resource.
// Format:
@@ -148,7 +157,8 @@ message GetIndexRequest {
];
}
-// Request message for [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes].
+// Request message for
+// [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes].
message ListIndexesRequest {
// Required. The resource name of the Location from which to list the Indexes.
// Format: `projects/{project}/locations/{location}`
@@ -167,44 +177,54 @@ message ListIndexesRequest {
// The standard list page token.
// Typically obtained via
- // [ListIndexesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token] of the previous
- // [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes] call.
+ // [ListIndexesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token]
+ // of the previous
+ // [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes].
+// Response message for
+// [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes].
message ListIndexesResponse {
// List of indexes in the requested page.
repeated Index indexes = 1;
// A token to retrieve next page of results.
- // Pass to [ListIndexesRequest.page_token][google.cloud.aiplatform.v1beta1.ListIndexesRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListIndexesRequest.page_token][google.cloud.aiplatform.v1beta1.ListIndexesRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [IndexService.UpdateIndex][google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex].
+// Request message for
+// [IndexService.UpdateIndex][google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex].
message UpdateIndexRequest {
// Required. The Index which updates the resource on the server.
Index index = 1 [(google.api.field_behavior) = REQUIRED];
// The update mask applies to the resource.
- // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask].
+ // For the `FieldMask` definition, see
+ // [google.protobuf.FieldMask][google.protobuf.FieldMask].
google.protobuf.FieldMask update_mask = 2;
}
-// Runtime operation information for [IndexService.UpdateIndex][google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex].
+// Runtime operation information for
+// [IndexService.UpdateIndex][google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex].
message UpdateIndexOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
// The operation metadata with regard to Matching Engine Index operation.
- NearestNeighborSearchOperationMetadata nearest_neighbor_search_operation_metadata = 2;
+ NearestNeighborSearchOperationMetadata
+ nearest_neighbor_search_operation_metadata = 2;
}
-// Request message for [IndexService.DeleteIndex][google.cloud.aiplatform.v1beta1.IndexService.DeleteIndex].
+// Request message for
+// [IndexService.DeleteIndex][google.cloud.aiplatform.v1beta1.IndexService.DeleteIndex].
message DeleteIndexRequest {
// Required. The name of the Index resource to be deleted.
// Format:
@@ -217,7 +237,8 @@ message DeleteIndexRequest {
];
}
-// Request message for [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints]
+// Request message for
+// [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints]
message UpsertDatapointsRequest {
// Required. The name of the Index resource to be updated.
// Format:
@@ -233,12 +254,12 @@ message UpsertDatapointsRequest {
repeated IndexDatapoint datapoints = 2;
}
-// Response message for [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints]
-message UpsertDatapointsResponse {
+// Response message for
+// [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints]
+message UpsertDatapointsResponse {}
-}
-
-// Request message for [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints]
+// Request message for
+// [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints]
message RemoveDatapointsRequest {
// Required. The name of the Index resource to be updated.
// Format:
@@ -254,10 +275,9 @@ message RemoveDatapointsRequest {
repeated string datapoint_ids = 2;
}
-// Response message for [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints]
-message RemoveDatapointsResponse {
-
-}
+// Response message for
+// [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints]
+message RemoveDatapointsResponse {}
// Runtime operation metadata with regard to Matching Engine Index.
message NearestNeighborSearchOperationMetadata {
@@ -325,9 +345,10 @@ message NearestNeighborSearchOperationMetadata {
// The validation stats of the content (per file) to be inserted or
// updated on the Matching Engine Index resource. Populated if
- // contentsDeltaUri is provided as part of [Index.metadata][google.cloud.aiplatform.v1beta1.Index.metadata]. Please note
- // that, currently for those files that are broken or has unsupported file
- // format, we will not have the stats for those files.
+ // contentsDeltaUri is provided as part of
+ // [Index.metadata][google.cloud.aiplatform.v1beta1.Index.metadata]. Please
+ // note that, currently for those files that are broken or has unsupported
+ // file format, we will not have the stats for those files.
repeated ContentValidationStats content_validation_stats = 1;
// The ingested data size in bytes.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/io.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/io.proto
index f571bb62f..7bc38c315 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/io.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/io.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "IoProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -48,7 +48,8 @@ message GcsSource {
// The Google Cloud Storage location where the output is to be written to.
message GcsDestination {
- // Required. Google Cloud Storage URI to output directory. If the uri doesn't end with
+ // Required. Google Cloud Storage URI to output directory. If the uri doesn't
+ // end with
// '/', a '/' will be automatically appended. The directory is created if it
// doesn't exist.
string output_uri_prefix = 1 [(google.api.field_behavior) = REQUIRED];
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/job_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/job_service.proto
index 9095e1e28..abde6266b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/job_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/job_service.proto
@@ -25,6 +25,7 @@ import "google/cloud/aiplatform/v1beta1/custom_job.proto";
import "google/cloud/aiplatform/v1beta1/data_labeling_job.proto";
import "google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto";
import "google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto";
+import "google/cloud/aiplatform/v1beta1/nas_job.proto";
import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
@@ -32,7 +33,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "JobServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -42,7 +43,9 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for creating and managing Vertex AI's jobs.
service JobService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform,"
+ "https://www.googleapis.com/auth/cloud-platform.read-only";
// Creates a CustomJob. A created CustomJob right away
// will be attempted to be run.
@@ -71,7 +74,8 @@ service JobService {
}
// Deletes a CustomJob.
- rpc DeleteCustomJob(DeleteCustomJobRequest) returns (google.longrunning.Operation) {
+ rpc DeleteCustomJob(DeleteCustomJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/customJobs/*}"
};
@@ -85,13 +89,16 @@ service JobService {
// Cancels a CustomJob.
// Starts asynchronous cancellation on the CustomJob. The server
// makes a best effort to cancel the job, but success is not
- // guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1beta1.JobService.GetCustomJob] or
- // other methods to check whether the cancellation succeeded or whether the
+ // guaranteed. Clients can use
+ // [JobService.GetCustomJob][google.cloud.aiplatform.v1beta1.JobService.GetCustomJob]
+ // or other methods to check whether the cancellation succeeded or whether the
// job completed despite cancellation. On successful cancellation,
// the CustomJob is not deleted; instead it becomes a job with
- // a [CustomJob.error][google.cloud.aiplatform.v1beta1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
- // corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1beta1.CustomJob.state] is set to
- // `CANCELLED`.
+ // a [CustomJob.error][google.cloud.aiplatform.v1beta1.CustomJob.error] value
+ // with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding
+ // to `Code.CANCELLED`, and
+ // [CustomJob.state][google.cloud.aiplatform.v1beta1.CustomJob.state] is set
+ // to `CANCELLED`.
rpc CancelCustomJob(CancelCustomJobRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/customJobs/*}:cancel"
@@ -101,7 +108,8 @@ service JobService {
}
// Creates a DataLabelingJob.
- rpc CreateDataLabelingJob(CreateDataLabelingJobRequest) returns (DataLabelingJob) {
+ rpc CreateDataLabelingJob(CreateDataLabelingJobRequest)
+ returns (DataLabelingJob) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/dataLabelingJobs"
body: "data_labeling_job"
@@ -118,7 +126,8 @@ service JobService {
}
// Lists DataLabelingJobs in a Location.
- rpc ListDataLabelingJobs(ListDataLabelingJobsRequest) returns (ListDataLabelingJobsResponse) {
+ rpc ListDataLabelingJobs(ListDataLabelingJobsRequest)
+ returns (ListDataLabelingJobsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/dataLabelingJobs"
};
@@ -126,7 +135,8 @@ service JobService {
}
// Deletes a DataLabelingJob.
- rpc DeleteDataLabelingJob(DeleteDataLabelingJobRequest) returns (google.longrunning.Operation) {
+ rpc DeleteDataLabelingJob(DeleteDataLabelingJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/dataLabelingJobs/*}"
};
@@ -138,7 +148,8 @@ service JobService {
}
// Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
- rpc CancelDataLabelingJob(CancelDataLabelingJobRequest) returns (google.protobuf.Empty) {
+ rpc CancelDataLabelingJob(CancelDataLabelingJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/dataLabelingJobs/*}:cancel"
body: "*"
@@ -147,7 +158,8 @@ service JobService {
}
// Creates a HyperparameterTuningJob
- rpc CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest) returns (HyperparameterTuningJob) {
+ rpc CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest)
+ returns (HyperparameterTuningJob) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/hyperparameterTuningJobs"
body: "hyperparameter_tuning_job"
@@ -156,7 +168,8 @@ service JobService {
}
// Gets a HyperparameterTuningJob
- rpc GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest) returns (HyperparameterTuningJob) {
+ rpc GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest)
+ returns (HyperparameterTuningJob) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}"
};
@@ -164,7 +177,8 @@ service JobService {
}
// Lists HyperparameterTuningJobs in a Location.
- rpc ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest) returns (ListHyperparameterTuningJobsResponse) {
+ rpc ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest)
+ returns (ListHyperparameterTuningJobsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/hyperparameterTuningJobs"
};
@@ -172,7 +186,8 @@ service JobService {
}
// Deletes a HyperparameterTuningJob.
- rpc DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest) returns (google.longrunning.Operation) {
+ rpc DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}"
};
@@ -186,14 +201,19 @@ service JobService {
// Cancels a HyperparameterTuningJob.
// Starts asynchronous cancellation on the HyperparameterTuningJob. The server
// makes a best effort to cancel the job, but success is not
- // guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob] or
- // other methods to check whether the cancellation succeeded or whether the
+ // guaranteed. Clients can use
+ // [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob]
+ // or other methods to check whether the cancellation succeeded or whether the
// job completed despite cancellation. On successful cancellation,
// the HyperparameterTuningJob is not deleted; instead it becomes a job with
- // a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code]
- // of 1, corresponding to `Code.CANCELLED`, and
- // [HyperparameterTuningJob.state][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.state] is set to `CANCELLED`.
- rpc CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest) returns (google.protobuf.Empty) {
+ // a
+ // [HyperparameterTuningJob.error][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.error]
+ // value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
+ // corresponding to `Code.CANCELLED`, and
+ // [HyperparameterTuningJob.state][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.state]
+ // is set to `CANCELLED`.
+ rpc CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}:cancel"
body: "*"
@@ -201,9 +221,85 @@ service JobService {
option (google.api.method_signature) = "name";
}
+ // Creates a NasJob
+ rpc CreateNasJob(CreateNasJobRequest) returns (NasJob) {
+ option (google.api.http) = {
+ post: "/v1beta1/{parent=projects/*/locations/*}/nasJobs"
+ body: "nas_job"
+ };
+ option (google.api.method_signature) = "parent,nas_job";
+ }
+
+ // Gets a NasJob
+ rpc GetNasJob(GetNasJobRequest) returns (NasJob) {
+ option (google.api.http) = {
+ get: "/v1beta1/{name=projects/*/locations/*/nasJobs/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Lists NasJobs in a Location.
+ rpc ListNasJobs(ListNasJobsRequest) returns (ListNasJobsResponse) {
+ option (google.api.http) = {
+ get: "/v1beta1/{parent=projects/*/locations/*}/nasJobs"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Deletes a NasJob.
+ rpc DeleteNasJob(DeleteNasJobRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1beta1/{name=projects/*/locations/*/nasJobs/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "DeleteOperationMetadata"
+ };
+ }
+
+ // Cancels a NasJob.
+ // Starts asynchronous cancellation on the NasJob. The server
+ // makes a best effort to cancel the job, but success is not
+ // guaranteed. Clients can use
+ // [JobService.GetNasJob][google.cloud.aiplatform.v1beta1.JobService.GetNasJob]
+ // or other methods to check whether the cancellation succeeded or whether the
+ // job completed despite cancellation. On successful cancellation,
+ // the NasJob is not deleted; instead it becomes a job with
+ // a [NasJob.error][google.cloud.aiplatform.v1beta1.NasJob.error] value with a
+ // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
+ // `Code.CANCELLED`, and
+ // [NasJob.state][google.cloud.aiplatform.v1beta1.NasJob.state] is set to
+ // `CANCELLED`.
+ rpc CancelNasJob(CancelNasJobRequest) returns (google.protobuf.Empty) {
+ option (google.api.http) = {
+ post: "/v1beta1/{name=projects/*/locations/*/nasJobs/*}:cancel"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Gets a NasTrialDetail.
+ rpc GetNasTrialDetail(GetNasTrialDetailRequest) returns (NasTrialDetail) {
+ option (google.api.http) = {
+ get: "/v1beta1/{name=projects/*/locations/*/nasJobs/*/nasTrialDetails/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // List top NasTrialDetails of a NasJob.
+ rpc ListNasTrialDetails(ListNasTrialDetailsRequest)
+ returns (ListNasTrialDetailsResponse) {
+ option (google.api.http) = {
+ get: "/v1beta1/{parent=projects/*/locations/*/nasJobs/*}/nasTrialDetails"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
// Creates a BatchPredictionJob. A BatchPredictionJob once created will
// right away be attempted to start.
- rpc CreateBatchPredictionJob(CreateBatchPredictionJobRequest) returns (BatchPredictionJob) {
+ rpc CreateBatchPredictionJob(CreateBatchPredictionJobRequest)
+ returns (BatchPredictionJob) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/batchPredictionJobs"
body: "batch_prediction_job"
@@ -212,7 +308,8 @@ service JobService {
}
// Gets a BatchPredictionJob
- rpc GetBatchPredictionJob(GetBatchPredictionJobRequest) returns (BatchPredictionJob) {
+ rpc GetBatchPredictionJob(GetBatchPredictionJobRequest)
+ returns (BatchPredictionJob) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/batchPredictionJobs/*}"
};
@@ -220,7 +317,8 @@ service JobService {
}
// Lists BatchPredictionJobs in a Location.
- rpc ListBatchPredictionJobs(ListBatchPredictionJobsRequest) returns (ListBatchPredictionJobsResponse) {
+ rpc ListBatchPredictionJobs(ListBatchPredictionJobsRequest)
+ returns (ListBatchPredictionJobsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/batchPredictionJobs"
};
@@ -229,7 +327,8 @@ service JobService {
// Deletes a BatchPredictionJob. Can only be called on jobs that already
// finished.
- rpc DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest) returns (google.longrunning.Operation) {
+ rpc DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/batchPredictionJobs/*}"
};
@@ -244,13 +343,16 @@ service JobService {
//
// Starts asynchronous cancellation on the BatchPredictionJob. The server
// makes the best effort to cancel the job, but success is not
- // guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob] or
- // other methods to check whether the cancellation succeeded or whether the
+ // guaranteed. Clients can use
+ // [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob]
+ // or other methods to check whether the cancellation succeeded or whether the
// job completed despite cancellation. On a successful cancellation,
// the BatchPredictionJob is not deleted;instead its
- // [BatchPredictionJob.state][google.cloud.aiplatform.v1beta1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already
- // outputted by the job are not deleted.
- rpc CancelBatchPredictionJob(CancelBatchPredictionJobRequest) returns (google.protobuf.Empty) {
+ // [BatchPredictionJob.state][google.cloud.aiplatform.v1beta1.BatchPredictionJob.state]
+ // is set to `CANCELLED`. Any files already outputted by the job are not
+ // deleted.
+ rpc CancelBatchPredictionJob(CancelBatchPredictionJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/batchPredictionJobs/*}:cancel"
body: "*"
@@ -260,25 +362,32 @@ service JobService {
// Creates a ModelDeploymentMonitoringJob. It will run periodically on a
// configured interval.
- rpc CreateModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest) returns (ModelDeploymentMonitoringJob) {
+ rpc CreateModelDeploymentMonitoringJob(
+ CreateModelDeploymentMonitoringJobRequest)
+ returns (ModelDeploymentMonitoringJob) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/modelDeploymentMonitoringJobs"
body: "model_deployment_monitoring_job"
};
- option (google.api.method_signature) = "parent,model_deployment_monitoring_job";
+ option (google.api.method_signature) =
+ "parent,model_deployment_monitoring_job";
}
// Searches Model Monitoring Statistics generated within a given time window.
- rpc SearchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest) returns (SearchModelDeploymentMonitoringStatsAnomaliesResponse) {
+ rpc SearchModelDeploymentMonitoringStatsAnomalies(
+ SearchModelDeploymentMonitoringStatsAnomaliesRequest)
+ returns (SearchModelDeploymentMonitoringStatsAnomaliesResponse) {
option (google.api.http) = {
post: "/v1beta1/{model_deployment_monitoring_job=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:searchModelDeploymentMonitoringStatsAnomalies"
body: "*"
};
- option (google.api.method_signature) = "model_deployment_monitoring_job,deployed_model_id";
+ option (google.api.method_signature) =
+ "model_deployment_monitoring_job,deployed_model_id";
}
// Gets a ModelDeploymentMonitoringJob.
- rpc GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest) returns (ModelDeploymentMonitoringJob) {
+ rpc GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest)
+ returns (ModelDeploymentMonitoringJob) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}"
};
@@ -286,7 +395,9 @@ service JobService {
}
// Lists ModelDeploymentMonitoringJobs in a Location.
- rpc ListModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest) returns (ListModelDeploymentMonitoringJobsResponse) {
+ rpc ListModelDeploymentMonitoringJobs(
+ ListModelDeploymentMonitoringJobsRequest)
+ returns (ListModelDeploymentMonitoringJobsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/modelDeploymentMonitoringJobs"
};
@@ -294,12 +405,15 @@ service JobService {
}
// Updates a ModelDeploymentMonitoringJob.
- rpc UpdateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest) returns (google.longrunning.Operation) {
+ rpc UpdateModelDeploymentMonitoringJob(
+ UpdateModelDeploymentMonitoringJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1beta1/{model_deployment_monitoring_job.name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}"
body: "model_deployment_monitoring_job"
};
- option (google.api.method_signature) = "model_deployment_monitoring_job,update_mask";
+ option (google.api.method_signature) =
+ "model_deployment_monitoring_job,update_mask";
option (google.longrunning.operation_info) = {
response_type: "ModelDeploymentMonitoringJob"
metadata_type: "UpdateModelDeploymentMonitoringJobOperationMetadata"
@@ -307,7 +421,9 @@ service JobService {
}
// Deletes a ModelDeploymentMonitoringJob.
- rpc DeleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest) returns (google.longrunning.Operation) {
+ rpc DeleteModelDeploymentMonitoringJob(
+ DeleteModelDeploymentMonitoringJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}"
};
@@ -320,8 +436,11 @@ service JobService {
// Pauses a ModelDeploymentMonitoringJob. If the job is running, the server
// makes a best effort to cancel the job. Will mark
- // [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.
- rpc PauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest) returns (google.protobuf.Empty) {
+ // [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.state]
+ // to 'PAUSED'.
+ rpc PauseModelDeploymentMonitoringJob(
+ PauseModelDeploymentMonitoringJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:pause"
body: "*"
@@ -332,7 +451,9 @@ service JobService {
// Resumes a paused ModelDeploymentMonitoringJob. It will start to run from
// next scheduled time. A deleted ModelDeploymentMonitoringJob can't be
// resumed.
- rpc ResumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest) returns (google.protobuf.Empty) {
+ rpc ResumeModelDeploymentMonitoringJob(
+ ResumeModelDeploymentMonitoringJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:resume"
body: "*"
@@ -341,7 +462,8 @@ service JobService {
}
}
-// Request message for [JobService.CreateCustomJob][google.cloud.aiplatform.v1beta1.JobService.CreateCustomJob].
+// Request message for
+// [JobService.CreateCustomJob][google.cloud.aiplatform.v1beta1.JobService.CreateCustomJob].
message CreateCustomJobRequest {
// Required. The resource name of the Location to create the CustomJob in.
// Format: `projects/{project}/locations/{location}`
@@ -356,7 +478,8 @@ message CreateCustomJobRequest {
CustomJob custom_job = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [JobService.GetCustomJob][google.cloud.aiplatform.v1beta1.JobService.GetCustomJob].
+// Request message for
+// [JobService.GetCustomJob][google.cloud.aiplatform.v1beta1.JobService.GetCustomJob].
message GetCustomJobRequest {
// Required. The name of the CustomJob resource.
// Format:
@@ -369,7 +492,8 @@ message GetCustomJobRequest {
];
}
-// Request message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs].
+// Request message for
+// [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs].
message ListCustomJobsRequest {
// Required. The resource name of the Location to list the CustomJobs from.
// Format: `projects/{project}/locations/{location}`
@@ -407,25 +531,31 @@ message ListCustomJobsRequest {
// The standard list page token.
// Typically obtained via
- // [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token] of the previous
- // [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs] call.
+ // [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token]
+ // of the previous
+ // [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs]
+// Response message for
+// [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs]
message ListCustomJobsResponse {
// List of CustomJobs in the requested page.
repeated CustomJob custom_jobs = 1;
// A token to retrieve the next page of results.
- // Pass to [ListCustomJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListCustomJobsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListCustomJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListCustomJobsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [JobService.DeleteCustomJob][google.cloud.aiplatform.v1beta1.JobService.DeleteCustomJob].
+// Request message for
+// [JobService.DeleteCustomJob][google.cloud.aiplatform.v1beta1.JobService.DeleteCustomJob].
message DeleteCustomJobRequest {
// Required. The name of the CustomJob resource to be deleted.
// Format:
@@ -438,7 +568,8 @@ message DeleteCustomJobRequest {
];
}
-// Request message for [JobService.CancelCustomJob][google.cloud.aiplatform.v1beta1.JobService.CancelCustomJob].
+// Request message for
+// [JobService.CancelCustomJob][google.cloud.aiplatform.v1beta1.JobService.CancelCustomJob].
message CancelCustomJobRequest {
// Required. The name of the CustomJob to cancel.
// Format:
@@ -451,7 +582,8 @@ message CancelCustomJobRequest {
];
}
-// Request message for [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.CreateDataLabelingJob].
+// Request message for
+// [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.CreateDataLabelingJob].
message CreateDataLabelingJobRequest {
// Required. The parent of the DataLabelingJob.
// Format: `projects/{project}/locations/{location}`
@@ -463,10 +595,12 @@ message CreateDataLabelingJobRequest {
];
// Required. The DataLabelingJob to create.
- DataLabelingJob data_labeling_job = 2 [(google.api.field_behavior) = REQUIRED];
+ DataLabelingJob data_labeling_job = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.GetDataLabelingJob].
+// Request message for
+// [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.GetDataLabelingJob].
message GetDataLabelingJobRequest {
// Required. The name of the DataLabelingJob.
// Format:
@@ -479,7 +613,8 @@ message GetDataLabelingJobRequest {
];
}
-// Request message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs].
+// Request message for
+// [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs].
message ListDataLabelingJobsRequest {
// Required. The parent of the DataLabelingJob.
// Format: `projects/{project}/locations/{location}`
@@ -530,7 +665,8 @@ message ListDataLabelingJobsRequest {
string order_by = 6;
}
-// Response message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs].
+// Response message for
+// [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs].
message ListDataLabelingJobsResponse {
// A list of DataLabelingJobs that matches the specified filter in the
// request.
@@ -540,7 +676,8 @@ message ListDataLabelingJobsResponse {
string next_page_token = 2;
}
-// Request message for [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.DeleteDataLabelingJob].
+// Request message for
+// [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.DeleteDataLabelingJob].
message DeleteDataLabelingJobRequest {
// Required. The name of the DataLabelingJob to be deleted.
// Format:
@@ -553,7 +690,8 @@ message DeleteDataLabelingJobRequest {
];
}
-// Request message for [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.CancelDataLabelingJob].
+// Request message for
+// [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.CancelDataLabelingJob].
message CancelDataLabelingJobRequest {
// Required. The name of the DataLabelingJob.
// Format:
@@ -566,10 +704,12 @@ message CancelDataLabelingJobRequest {
];
}
-// Request message for [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.CreateHyperparameterTuningJob].
+// Request message for
+// [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.CreateHyperparameterTuningJob].
message CreateHyperparameterTuningJobRequest {
- // Required. The resource name of the Location to create the HyperparameterTuningJob in.
- // Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location to create the
+ // HyperparameterTuningJob in. Format:
+ // `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -578,10 +718,12 @@ message CreateHyperparameterTuningJobRequest {
];
// Required. The HyperparameterTuningJob to create.
- HyperparameterTuningJob hyperparameter_tuning_job = 2 [(google.api.field_behavior) = REQUIRED];
+ HyperparameterTuningJob hyperparameter_tuning_job = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob].
+// Request message for
+// [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob].
message GetHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob resource.
// Format:
@@ -594,10 +736,12 @@ message GetHyperparameterTuningJobRequest {
];
}
-// Request message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs].
+// Request message for
+// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs].
message ListHyperparameterTuningJobsRequest {
- // Required. The resource name of the Location to list the HyperparameterTuningJobs
- // from. Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location to list the
+ // HyperparameterTuningJobs from. Format:
+ // `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -632,27 +776,33 @@ message ListHyperparameterTuningJobsRequest {
// The standard list page token.
// Typically obtained via
- // [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token] of the previous
- // [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs] call.
+ // [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token]
+ // of the previous
+ // [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs]
+// Response message for
+// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs]
message ListHyperparameterTuningJobsResponse {
// List of HyperparameterTuningJobs in the requested page.
- // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials] of the jobs will be not be returned.
+ // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]
+ // of the jobs will be not be returned.
repeated HyperparameterTuningJob hyperparameter_tuning_jobs = 1;
// A token to retrieve the next page of results.
- // Pass to [ListHyperparameterTuningJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsRequest.page_token] to obtain that
- // page.
+ // Pass to
+ // [ListHyperparameterTuningJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [JobService.DeleteHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.DeleteHyperparameterTuningJob].
+// Request message for
+// [JobService.DeleteHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.DeleteHyperparameterTuningJob].
message DeleteHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob resource to be deleted.
// Format:
@@ -665,7 +815,8 @@ message DeleteHyperparameterTuningJobRequest {
];
}
-// Request message for [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.CancelHyperparameterTuningJob].
+// Request message for
+// [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.CancelHyperparameterTuningJob].
message CancelHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob to cancel.
// Format:
@@ -678,9 +829,10 @@ message CancelHyperparameterTuningJobRequest {
];
}
-// Request message for [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.CreateBatchPredictionJob].
-message CreateBatchPredictionJobRequest {
- // Required. The resource name of the Location to create the BatchPredictionJob in.
+// Request message for
+// [JobService.CreateNasJob][google.cloud.aiplatform.v1beta1.JobService.CreateNasJob].
+message CreateNasJobRequest {
+ // Required. The resource name of the Location to create the NasJob in.
// Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -689,11 +841,187 @@ message CreateBatchPredictionJobRequest {
}
];
+ // Required. The NasJob to create.
+ NasJob nas_job = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for
+// [JobService.GetNasJob][google.cloud.aiplatform.v1beta1.JobService.GetNasJob].
+message GetNasJobRequest {
+ // Required. The name of the NasJob resource.
+ // Format:
+ // `projects/{project}/locations/{location}/nasJobs/{nas_job}`
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/NasJob"
+ }
+ ];
+}
+
+// Request message for
+// [JobService.ListNasJobs][google.cloud.aiplatform.v1beta1.JobService.ListNasJobs].
+message ListNasJobsRequest {
+ // Required. The resource name of the Location to list the NasJobs
+ // from. Format: `projects/{project}/locations/{location}`
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "locations.googleapis.com/Location"
+ }
+ ];
+
+ // The standard list filter.
+ //
+ // Supported fields:
+ //
+ // * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
+ // * `state` supports `=`, `!=` comparisons.
+ // * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
+ // `create_time` must be in RFC 3339 format.
+ // * `labels` supports general map functions that is:
+ // `labels.key=value` - key:value equality
+ // `labels.key:* - key existence
+ //
+ // Some examples of using the filter are:
+ //
+ // * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
+ // * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
+ // * `NOT display_name="my_job"`
+ // * `create_time>"2021-05-18T00:00:00Z"`
+ // * `labels.keyA=valueA`
+ // * `labels.keyB:*`
+ string filter = 2;
+
+ // The standard list page size.
+ int32 page_size = 3;
+
+ // The standard list page token.
+ // Typically obtained via
+ // [ListNasJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListNasJobsResponse.next_page_token]
+ // of the previous
+ // [JobService.ListNasJobs][google.cloud.aiplatform.v1beta1.JobService.ListNasJobs]
+ // call.
+ string page_token = 4;
+
+ // Mask specifying which fields to read.
+ google.protobuf.FieldMask read_mask = 5;
+}
+
+// Response message for
+// [JobService.ListNasJobs][google.cloud.aiplatform.v1beta1.JobService.ListNasJobs]
+message ListNasJobsResponse {
+ // List of NasJobs in the requested page.
+ // [NasJob.nas_job_output][google.cloud.aiplatform.v1beta1.NasJob.nas_job_output]
+ // of the jobs will not be returned.
+ repeated NasJob nas_jobs = 1;
+
+ // A token to retrieve the next page of results.
+ // Pass to
+ // [ListNasJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListNasJobsRequest.page_token]
+ // to obtain that page.
+ string next_page_token = 2;
+}
+
+// Request message for
+// [JobService.DeleteNasJob][google.cloud.aiplatform.v1beta1.JobService.DeleteNasJob].
+message DeleteNasJobRequest {
+ // Required. The name of the NasJob resource to be deleted.
+ // Format:
+ // `projects/{project}/locations/{location}/nasJobs/{nas_job}`
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/NasJob"
+ }
+ ];
+}
+
+// Request message for
+// [JobService.CancelNasJob][google.cloud.aiplatform.v1beta1.JobService.CancelNasJob].
+message CancelNasJobRequest {
+ // Required. The name of the NasJob to cancel.
+ // Format:
+ // `projects/{project}/locations/{location}/nasJobs/{nas_job}`
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/NasJob"
+ }
+ ];
+}
+
+// Request message for
+// [JobService.GetNasTrialDetail][google.cloud.aiplatform.v1beta1.JobService.GetNasTrialDetail].
+message GetNasTrialDetailRequest {
+ // Required. The name of the NasTrialDetail resource.
+ // Format:
+ // `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/NasTrialDetail"
+ }
+ ];
+}
+
+// Request message for
+// [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails].
+message ListNasTrialDetailsRequest {
+ // Required. The name of the NasJob resource.
+ // Format:
+ // `projects/{project}/locations/{location}/nasJobs/{nas_job}`
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/NasJob"
+ }
+ ];
+
+ // The standard list page size.
+ int32 page_size = 2;
+
+ // The standard list page token.
+ // Typically obtained via
+ // [ListNasTrialDetailsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListNasTrialDetailsResponse.next_page_token]
+ // of the previous
+ // [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails]
+ // call.
+ string page_token = 3;
+}
+
+// Response message for
+// [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails]
+message ListNasTrialDetailsResponse {
+ // List of top NasTrials in the requested page.
+ repeated NasTrialDetail nas_trial_details = 1;
+
+ // A token to retrieve the next page of results.
+ // Pass to
+ // [ListNasTrialDetailsRequest.page_token][google.cloud.aiplatform.v1beta1.ListNasTrialDetailsRequest.page_token]
+ // to obtain that page.
+ string next_page_token = 2;
+}
+
+// Request message for
+// [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.CreateBatchPredictionJob].
+message CreateBatchPredictionJobRequest {
+ // Required. The resource name of the Location to create the
+ // BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "locations.googleapis.com/Location"
+ }
+ ];
+
// Required. The BatchPredictionJob to create.
- BatchPredictionJob batch_prediction_job = 2 [(google.api.field_behavior) = REQUIRED];
+ BatchPredictionJob batch_prediction_job = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob].
+// Request message for
+// [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob].
message GetBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob resource.
// Format:
@@ -706,7 +1034,8 @@ message GetBatchPredictionJobRequest {
];
}
-// Request message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs].
+// Request message for
+// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs].
message ListBatchPredictionJobsRequest {
// Required. The resource name of the Location to list the BatchPredictionJobs
// from. Format: `projects/{project}/locations/{location}`
@@ -745,26 +1074,31 @@ message ListBatchPredictionJobsRequest {
// The standard list page token.
// Typically obtained via
- // [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token] of the previous
- // [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs] call.
+ // [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token]
+ // of the previous
+ // [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs]
+// Response message for
+// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs]
message ListBatchPredictionJobsResponse {
// List of BatchPredictionJobs in the requested page.
repeated BatchPredictionJob batch_prediction_jobs = 1;
// A token to retrieve the next page of results.
- // Pass to [ListBatchPredictionJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsRequest.page_token] to obtain that
- // page.
+ // Pass to
+ // [ListBatchPredictionJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.DeleteBatchPredictionJob].
+// Request message for
+// [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.DeleteBatchPredictionJob].
message DeleteBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob resource to be deleted.
// Format:
@@ -777,7 +1111,8 @@ message DeleteBatchPredictionJobRequest {
];
}
-// Request message for [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.CancelBatchPredictionJob].
+// Request message for
+// [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.CancelBatchPredictionJob].
message CancelBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob to cancel.
// Format:
@@ -803,7 +1138,8 @@ message CreateModelDeploymentMonitoringJobRequest {
];
// Required. The ModelDeploymentMonitoringJob to create
- ModelDeploymentMonitoringJob model_deployment_monitoring_job = 2 [(google.api.field_behavior) = REQUIRED];
+ ModelDeploymentMonitoringJob model_deployment_monitoring_job = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for
@@ -814,11 +1150,12 @@ message SearchModelDeploymentMonitoringStatsAnomaliesRequest {
ModelDeploymentMonitoringObjectiveType type = 1;
// If set, all attribution scores between
- // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time][google.cloud.aiplatform.v1beta1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time] and
- // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time][google.cloud.aiplatform.v1beta1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time] are
- // fetched, and page token doesn't take effect in this case.
- // Only used to retrieve attribution score for the top Features which has
- // the highest attribution score in the latest monitoring run.
+ // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time][google.cloud.aiplatform.v1beta1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time]
+ // and
+ // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time][google.cloud.aiplatform.v1beta1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time]
+ // are fetched, and page token doesn't take effect in this case. Only used
+ // to retrieve attribution score for the top Features which has the highest
+ // attribution score in the latest monitoring run.
int32 top_feature_count = 4;
}
@@ -843,7 +1180,8 @@ message SearchModelDeploymentMonitoringStatsAnomaliesRequest {
string feature_display_name = 3;
// Required. Objectives of the stats to retrieve.
- repeated StatsAnomaliesObjective objectives = 4 [(google.api.field_behavior) = REQUIRED];
+ repeated StatsAnomaliesObjective objectives = 4
+ [(google.api.field_behavior) = REQUIRED];
// The standard list page size.
int32 page_size = 5;
@@ -949,18 +1287,18 @@ message ListModelDeploymentMonitoringJobsResponse {
// Request message for
// [JobService.UpdateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1beta1.JobService.UpdateModelDeploymentMonitoringJob].
message UpdateModelDeploymentMonitoringJobRequest {
- // Required. The model monitoring configuration which replaces the resource on the
- // server.
- ModelDeploymentMonitoringJob model_deployment_monitoring_job = 1 [(google.api.field_behavior) = REQUIRED];
-
- // Required. The update mask is used to specify the fields to be overwritten in the
- // ModelDeploymentMonitoringJob resource by the update.
- // The fields specified in the update_mask are relative to the resource, not
- // the full request. A field will be overwritten if it is in the mask. If the
- // user does not provide a mask then only the non-empty fields present in the
- // request will be overwritten. Set the update_mask to `*` to override all
- // fields.
- // For the objective config, the user can either provide the update mask for
+ // Required. The model monitoring configuration which replaces the resource on
+ // the server.
+ ModelDeploymentMonitoringJob model_deployment_monitoring_job = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The update mask is used to specify the fields to be overwritten
+ // in the ModelDeploymentMonitoringJob resource by the update. The fields
+ // specified in the update_mask are relative to the resource, not the full
+ // request. A field will be overwritten if it is in the mask. If the user does
+ // not provide a mask then only the non-empty fields present in the request
+ // will be overwritten. Set the update_mask to `*` to override all fields. For
+ // the objective config, the user can either provide the update mask for
// model_deployment_monitoring_objective_configs or any combination of its
// nested fields, such as:
// model_deployment_monitoring_objective_configs.objective_config.training_dataset.
@@ -980,7 +1318,8 @@ message UpdateModelDeploymentMonitoringJobRequest {
// * `model_deployment_monitoring_objective_configs.objective_config.training_dataset`
// * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config`
// * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/job_state.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/job_state.proto
index 14458e2ee..7a53cd2cf 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/job_state.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/job_state.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1beta1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "JobStateProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -57,10 +57,7 @@ enum JobState {
// The job has expired.
JOB_STATE_EXPIRED = 9;
- // The job is being updated. The job is only able to be updated at RUNNING
- // state; if the update operation succeeds, job goes back to RUNNING state; if
- // the update operation fails, the job goes back to RUNNING state with error
- // messages written to [ModelDeploymentMonitoringJob.partial_errors][] field
- // if it is a ModelDeploymentMonitoringJob.
+ // The job is being updated. Only jobs in the `RUNNING` state can be updated.
+ // After updating, the job goes back to the `RUNNING` state.
JOB_STATE_UPDATING = 10;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/lineage_subgraph.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/lineage_subgraph.proto
index ce2797179..58d308733 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/lineage_subgraph.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/lineage_subgraph.proto
@@ -21,7 +21,7 @@ import "google/cloud/aiplatform/v1beta1/event.proto";
import "google/cloud/aiplatform/v1beta1/execution.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "LineageSubgraphProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/machine_resources.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/machine_resources.proto
index fa1d1faaf..7f26271c3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/machine_resources.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/machine_resources.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/cloud/aiplatform/v1beta1/accelerator_type.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MachineResourcesProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -37,14 +37,18 @@ message MachineSpec {
// See the [list of machine types supported for custom
// training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types).
//
- // For [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] this field is optional, and the default
- // value is `n1-standard-2`. For [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob] or as part of
- // [WorkerPoolSpec][google.cloud.aiplatform.v1beta1.WorkerPoolSpec] this field is required.
+ // For [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] this
+ // field is optional, and the default value is `n1-standard-2`. For
+ // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob] or
+ // as part of [WorkerPoolSpec][google.cloud.aiplatform.v1beta1.WorkerPoolSpec]
+ // this field is required.
string machine_type = 1 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The type of accelerator(s) that may be attached to the machine as per
+ // Immutable. The type of accelerator(s) that may be attached to the machine
+ // as per
// [accelerator_count][google.cloud.aiplatform.v1beta1.MachineSpec.accelerator_count].
- AcceleratorType accelerator_type = 2 [(google.api.field_behavior) = IMMUTABLE];
+ AcceleratorType accelerator_type = 2
+ [(google.api.field_behavior) = IMMUTABLE];
// The number of accelerators to attach to the machine.
int32 accelerator_count = 3;
@@ -53,14 +57,16 @@ message MachineSpec {
// A description of resources that are dedicated to a DeployedModel, and
// that need a higher degree of manual configuration.
message DedicatedResources {
- // Required. Immutable. The specification of a single machine used by the prediction.
+ // Required. Immutable. The specification of a single machine used by the
+ // prediction.
MachineSpec machine_spec = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
];
- // Required. Immutable. The minimum number of machine replicas this DeployedModel will be always
- // deployed on. This value must be greater than or equal to 1.
+ // Required. Immutable. The minimum number of machine replicas this
+ // DeployedModel will be always deployed on. This value must be greater than
+ // or equal to 1.
//
// If traffic against the DeployedModel increases, it may dynamically be
// deployed onto more replicas, and as traffic decreases, some of these extra
@@ -70,14 +76,15 @@ message DedicatedResources {
(google.api.field_behavior) = IMMUTABLE
];
- // Immutable. The maximum number of replicas this DeployedModel may be deployed on when
- // the traffic against it increases. If the requested value is too large,
- // the deployment will error, but if deployment succeeds then the ability
- // to scale the model to that many replicas is guaranteed (barring service
- // outages). If traffic against the DeployedModel increases beyond what its
- // replicas at maximum may handle, a portion of the traffic will be dropped.
- // If this value is not provided, will use [min_replica_count][google.cloud.aiplatform.v1beta1.DedicatedResources.min_replica_count] as the
- // default value.
+ // Immutable. The maximum number of replicas this DeployedModel may be
+ // deployed on when the traffic against it increases. If the requested value
+ // is too large, the deployment will error, but if deployment succeeds then
+ // the ability to scale the model to that many replicas is guaranteed (barring
+ // service outages). If traffic against the DeployedModel increases beyond
+ // what its replicas at maximum may handle, a portion of the traffic will be
+ // dropped. If this value is not provided, will use
+ // [min_replica_count][google.cloud.aiplatform.v1beta1.DedicatedResources.min_replica_count]
+ // as the default value.
//
// The value of this field impacts the charge against Vertex CPU and GPU
// quotas. Specifically, you will be charged for (max_replica_count *
@@ -90,44 +97,49 @@ message DedicatedResources {
// target value (default to 60 if not set). At most one entry is allowed per
// metric.
//
- // If [machine_spec.accelerator_count][google.cloud.aiplatform.v1beta1.MachineSpec.accelerator_count] is
- // above 0, the autoscaling will be based on both CPU utilization and
+ // If
+ // [machine_spec.accelerator_count][google.cloud.aiplatform.v1beta1.MachineSpec.accelerator_count]
+ // is above 0, the autoscaling will be based on both CPU utilization and
// accelerator's duty cycle metrics and scale up when either metrics exceeds
// its target value while scale down if both metrics are under their target
// value. The default target value is 60 for both metrics.
//
- // If [machine_spec.accelerator_count][google.cloud.aiplatform.v1beta1.MachineSpec.accelerator_count] is
- // 0, the autoscaling will be based on CPU utilization metric only with
+ // If
+ // [machine_spec.accelerator_count][google.cloud.aiplatform.v1beta1.MachineSpec.accelerator_count]
+ // is 0, the autoscaling will be based on CPU utilization metric only with
// default target value 60 if not explicitly set.
//
// For example, in the case of Online Prediction, if you want to override
// target CPU utilization to 80, you should set
// [autoscaling_metric_specs.metric_name][google.cloud.aiplatform.v1beta1.AutoscalingMetricSpec.metric_name]
// to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and
- // [autoscaling_metric_specs.target][google.cloud.aiplatform.v1beta1.AutoscalingMetricSpec.target] to `80`.
- repeated AutoscalingMetricSpec autoscaling_metric_specs = 4 [(google.api.field_behavior) = IMMUTABLE];
+ // [autoscaling_metric_specs.target][google.cloud.aiplatform.v1beta1.AutoscalingMetricSpec.target]
+ // to `80`.
+ repeated AutoscalingMetricSpec autoscaling_metric_specs = 4
+ [(google.api.field_behavior) = IMMUTABLE];
}
// A description of resources that to large degree are decided by Vertex AI,
// and require only a modest additional configuration.
// Each Model supporting these resources documents its specific guidelines.
message AutomaticResources {
- // Immutable. The minimum number of replicas this DeployedModel will be always deployed
- // on. If traffic against it increases, it may dynamically be deployed onto
- // more replicas up to [max_replica_count][google.cloud.aiplatform.v1beta1.AutomaticResources.max_replica_count], and as traffic decreases, some
- // of these extra replicas may be freed.
- // If the requested value is too large, the deployment will error.
+ // Immutable. The minimum number of replicas this DeployedModel will be always
+ // deployed on. If traffic against it increases, it may dynamically be
+ // deployed onto more replicas up to
+ // [max_replica_count][google.cloud.aiplatform.v1beta1.AutomaticResources.max_replica_count],
+ // and as traffic decreases, some of these extra replicas may be freed. If the
+ // requested value is too large, the deployment will error.
int32 min_replica_count = 1 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The maximum number of replicas this DeployedModel may be deployed on when
- // the traffic against it increases. If the requested value is too large,
- // the deployment will error, but if deployment succeeds then the ability
- // to scale the model to that many replicas is guaranteed (barring service
- // outages). If traffic against the DeployedModel increases beyond what its
- // replicas at maximum may handle, a portion of the traffic will be dropped.
- // If this value is not provided, a no upper bound for scaling under heavy
- // traffic will be assume, though Vertex AI may be unable to scale beyond
- // certain replica number.
+ // Immutable. The maximum number of replicas this DeployedModel may be
+ // deployed on when the traffic against it increases. If the requested value
+ // is too large, the deployment will error, but if deployment succeeds then
+ // the ability to scale the model to that many replicas is guaranteed (barring
+ // service outages). If traffic against the DeployedModel increases beyond
+ // what its replicas at maximum may handle, a portion of the traffic will be
+ // dropped. If this value is not provided, a no upper bound for scaling under
+ // heavy traffic will be assume, though Vertex AI may be unable to scale
+ // beyond certain replica number.
int32 max_replica_count = 2 [(google.api.field_behavior) = IMMUTABLE];
}
@@ -140,21 +152,21 @@ message BatchDedicatedResources {
(google.api.field_behavior) = IMMUTABLE
];
- // Immutable. The number of machine replicas used at the start of the batch operation.
- // If not set, Vertex AI decides starting number, not greater than
+ // Immutable. The number of machine replicas used at the start of the batch
+ // operation. If not set, Vertex AI decides starting number, not greater than
// [max_replica_count][google.cloud.aiplatform.v1beta1.BatchDedicatedResources.max_replica_count]
int32 starting_replica_count = 2 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. The maximum number of machine replicas the batch operation may be scaled
- // to. The default value is 10.
+ // Immutable. The maximum number of machine replicas the batch operation may
+ // be scaled to. The default value is 10.
int32 max_replica_count = 3 [(google.api.field_behavior) = IMMUTABLE];
}
// Statistics information about resource consumption.
message ResourcesConsumed {
- // Output only. The number of replica hours used. Note that many replicas may run in
- // parallel, and additionally any given work may be queued for some time.
- // Therefore this value is not strictly related to wall time.
+ // Output only. The number of replica hours used. Note that many replicas may
+ // run in parallel, and additionally any given work may be queued for some
+ // time. Therefore this value is not strictly related to wall time.
double replica_hours = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -179,8 +191,8 @@ message NfsMount {
// the source mount path in the form of `server:path`
string path = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. Destination mount path. The NFS will be mounted for the user under
- // /mnt/nfs/
+ // Required. Destination mount path. The NFS will be mounted for the user
+ // under /mnt/nfs/
string mount_point = 3 [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/manual_batch_tuning_parameters.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/manual_batch_tuning_parameters.proto
index 5498d89d4..1131aa2e1 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/manual_batch_tuning_parameters.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/manual_batch_tuning_parameters.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ManualBatchTuningParametersProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -28,11 +28,11 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Manual batch tuning parameters.
message ManualBatchTuningParameters {
- // Immutable. The number of the records (e.g. instances) of the operation given in
- // each batch to a machine replica. Machine type, and size of a single
- // record should be considered when setting this parameter, higher value
- // speeds up the batch operation's execution, but too high value will result
- // in a whole batch not fitting in a machine's memory, and the whole
+ // Immutable. The number of the records (e.g. instances) of the operation
+ // given in each batch to a machine replica. Machine type, and size of a
+ // single record should be considered when setting this parameter, higher
+ // value speeds up the batch operation's execution, but too high value will
+ // result in a whole batch not fitting in a machine's memory, and the whole
// operation will fail.
// The default value is 64.
int32 batch_size = 1 [(google.api.field_behavior) = IMMUTABLE];
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/match_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/match_service.proto
new file mode 100644
index 000000000..bac8de1b3
--- /dev/null
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/match_service.proto
@@ -0,0 +1,176 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.aiplatform.v1beta1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/aiplatform/v1beta1/index.proto";
+
+option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
+option java_multiple_files = true;
+option java_outer_classname = "MatchServiceProto";
+option java_package = "com.google.cloud.aiplatform.v1beta1";
+option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
+option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
+
+// MatchService is a Google managed service for efficient vector similarity
+// search at scale.
+service MatchService {
+ option (google.api.default_host) = "aiplatform.googleapis.com";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
+
+ // Finds the nearest neighbors of each vector within the request.
+ rpc FindNeighbors(FindNeighborsRequest) returns (FindNeighborsResponse) {
+ option (google.api.http) = {
+ post: "/v1beta1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:findNeighbors"
+ body: "*"
+ };
+ }
+
+ // Reads the datapoints/vectors of the given IDs.
+ // A maximum of 1000 datapoints can be retrieved in a batch.
+ rpc ReadIndexDatapoints(ReadIndexDatapointsRequest)
+ returns (ReadIndexDatapointsResponse) {
+ option (google.api.http) = {
+ post: "/v1beta1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:readIndexDatapoints"
+ body: "*"
+ };
+ }
+}
+
+// The request message for
+// [MatchService.FindNeighbors][google.cloud.aiplatform.v1beta1.MatchService.FindNeighbors].
+message FindNeighborsRequest {
+ // A query to find a number of the nearest neighbors (most similar vectors)
+ // of a vector.
+ message Query {
+ // Required. The datapoint/vector whose nearest neighbors should be searched
+ // for.
+ IndexDatapoint datapoint = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // The number of nearest neighbors to be retrieved from database for each
+ // query. If not set, will use the default from the service configuration
+ // (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config).
+ int32 neighbor_count = 2;
+
+ // Crowding is a constraint on a neighbor list produced by nearest neighbor
+ // search requiring that no more than some value k' of the k neighbors
+ // returned have the same value of crowding_attribute.
+ // It's used for improving result diversity.
+ // This field is the maximum number of matches with the same crowding tag.
+ int32 per_crowding_attribute_neighbor_count = 3;
+
+ // The number of neighbors to find via approximate search before
+ // exact reordering is performed. If not set, the default value from scam
+ // config is used; if set, this value must be > 0.
+ int32 approximate_neighbor_count = 4;
+
+ // The fraction of the number of leaves to search, set at query time allows
+ // user to tune search performance. This value increase result in both
+ // search accuracy and latency increase. The value should be between 0.0
+ // and 1.0. If not set or set to 0.0, query uses the default value specified
+ // in
+ // NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.
+ double fraction_leaf_nodes_to_search_override = 5;
+ }
+
+ // Required. The name of the index endpoint.
+ // Format:
+ // `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
+ string index_endpoint = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/IndexEndpoint"
+ }
+ ];
+
+ // The ID of the DeploydIndex that will serve the request. This request is
+ // sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
+ // IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
+ // has a DeployedIndex.id field.
+ // The value of the field below must equal one of the DeployedIndex.id
+ // fields of the IndexEndpoint that is being called for this request.
+ string deployed_index_id = 2;
+
+ // The list of queries.
+ repeated Query queries = 3;
+
+ // If set to true, the full datapoints (including all vector values and
+ // restricts) of the nearest neighbors are returned.
+ // Note that returning full datapoint will significantly increase the
+ // latency and cost of the query.
+ bool return_full_datapoint = 4;
+}
+
+// The response message for
+// [MatchService.FindNeighbors][google.cloud.aiplatform.v1beta1.MatchService.FindNeighbors].
+message FindNeighborsResponse {
+ // A neighbor of the query vector.
+ message Neighbor {
+ // The datapoint of the neighbor.
+ // Note that full datapoints are returned only when "return_full_datapoint"
+ // is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
+ // fields are populated.
+ IndexDatapoint datapoint = 1;
+
+ // The distance between the neighbor and the query vector.
+ double distance = 2;
+ }
+
+ // Nearest neighbors for one query.
+ message NearestNeighbors {
+ // The ID of the query datapoint.
+ string id = 1;
+
+ // All its neighbors.
+ repeated Neighbor neighbors = 2;
+ }
+
+ // The nearest neighbors of the query datapoints.
+ repeated NearestNeighbors nearest_neighbors = 1;
+}
+
+// The request message for
+// [MatchService.ReadIndexDatapoints][google.cloud.aiplatform.v1beta1.MatchService.ReadIndexDatapoints].
+message ReadIndexDatapointsRequest {
+ // Required. The name of the index endpoint.
+ // Format:
+ // `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
+ string index_endpoint = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/IndexEndpoint"
+ }
+ ];
+
+ // The ID of the DeploydIndex that will serve the request.
+ string deployed_index_id = 2;
+
+ // IDs of the datapoints to be searched for.
+ repeated string ids = 3;
+}
+
+// The response message for
+// [MatchService.ReadIndexDatapoints][google.cloud.aiplatform.v1beta1.MatchService.ReadIndexDatapoints].
+message ReadIndexDatapointsResponse {
+ // The result list of datapoints.
+ repeated IndexDatapoint datapoints = 1;
+}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_schema.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_schema.proto
index 0623a3ee9..a3042d2f4 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_schema.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_schema.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MetadataSchemaProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -58,9 +58,9 @@ message MetadataSchema {
// allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
string schema_version = 2;
- // Required. The raw YAML string representation of the MetadataSchema. The combination
- // of [MetadataSchema.version] and the schema name given by `title` in
- // [MetadataSchema.schema] must be unique within a MetadataStore.
+ // Required. The raw YAML string representation of the MetadataSchema. The
+ // combination of [MetadataSchema.version] and the schema name given by
+ // `title` in [MetadataSchema.schema] must be unique within a MetadataStore.
//
// The schema is defined as an OpenAPI 3.0.2
// [MetadataSchema
@@ -72,7 +72,8 @@ message MetadataSchema {
MetadataSchemaType schema_type = 4;
// Output only. Timestamp when this MetadataSchema was created.
- google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Description of the Metadata Schema
string description = 6;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_service.proto
index 9e1767a09..8e23652d5 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_service.proto
@@ -29,10 +29,11 @@ import "google/cloud/aiplatform/v1beta1/metadata_schema.proto";
import "google/cloud/aiplatform/v1beta1/metadata_store.proto";
import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MetadataServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -42,15 +43,18 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Service for reading and writing metadata entries.
service MetadataService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Initializes a MetadataStore, including allocation of resources.
- rpc CreateMetadataStore(CreateMetadataStoreRequest) returns (google.longrunning.Operation) {
+ rpc CreateMetadataStore(CreateMetadataStoreRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/metadataStores"
body: "metadata_store"
};
- option (google.api.method_signature) = "parent,metadata_store,metadata_store_id";
+ option (google.api.method_signature) =
+ "parent,metadata_store,metadata_store_id";
option (google.longrunning.operation_info) = {
response_type: "MetadataStore"
metadata_type: "CreateMetadataStoreOperationMetadata"
@@ -66,7 +70,8 @@ service MetadataService {
}
// Lists MetadataStores for a Location.
- rpc ListMetadataStores(ListMetadataStoresRequest) returns (ListMetadataStoresResponse) {
+ rpc ListMetadataStores(ListMetadataStoresRequest)
+ returns (ListMetadataStoresResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/metadataStores"
};
@@ -75,7 +80,8 @@ service MetadataService {
// Deletes a single MetadataStore and all its child resources (Artifacts,
// Executions, and Contexts).
- rpc DeleteMetadataStore(DeleteMetadataStoreRequest) returns (google.longrunning.Operation) {
+ rpc DeleteMetadataStore(DeleteMetadataStoreRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/metadataStores/*}"
};
@@ -121,7 +127,8 @@ service MetadataService {
}
// Deletes an Artifact.
- rpc DeleteArtifact(DeleteArtifactRequest) returns (google.longrunning.Operation) {
+ rpc DeleteArtifact(DeleteArtifactRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/metadataStores/*/artifacts/*}"
};
@@ -133,7 +140,8 @@ service MetadataService {
}
// Purges Artifacts.
- rpc PurgeArtifacts(PurgeArtifactsRequest) returns (google.longrunning.Operation) {
+ rpc PurgeArtifacts(PurgeArtifactsRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/artifacts:purge"
body: "*"
@@ -180,7 +188,8 @@ service MetadataService {
}
// Deletes a stored Context.
- rpc DeleteContext(DeleteContextRequest) returns (google.longrunning.Operation) {
+ rpc DeleteContext(DeleteContextRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/metadataStores/*/contexts/*}"
};
@@ -192,7 +201,8 @@ service MetadataService {
}
// Purges Contexts.
- rpc PurgeContexts(PurgeContextsRequest) returns (google.longrunning.Operation) {
+ rpc PurgeContexts(PurgeContextsRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/contexts:purge"
body: "*"
@@ -207,7 +217,8 @@ service MetadataService {
// Adds a set of Artifacts and Executions to a Context. If any of the
// Artifacts or Executions have already been added to a Context, they are
// simply skipped.
- rpc AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest) returns (AddContextArtifactsAndExecutionsResponse) {
+ rpc AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest)
+ returns (AddContextArtifactsAndExecutionsResponse) {
option (google.api.http) = {
post: "/v1beta1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:addContextArtifactsAndExecutions"
body: "*"
@@ -220,7 +231,8 @@ service MetadataService {
// simply skipped. If this call would create a cycle or cause any Context to
// have more than 10 parents, the request will fail with an INVALID_ARGUMENT
// error.
- rpc AddContextChildren(AddContextChildrenRequest) returns (AddContextChildrenResponse) {
+ rpc AddContextChildren(AddContextChildrenRequest)
+ returns (AddContextChildrenResponse) {
option (google.api.http) = {
post: "/v1beta1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:addContextChildren"
body: "*"
@@ -231,7 +243,8 @@ service MetadataService {
// Remove a set of children contexts from a parent Context. If any of the
// child Contexts were NOT added to the parent Context, they are
// simply skipped.
- rpc RemoveContextChildren(RemoveContextChildrenRequest) returns (RemoveContextChildrenResponse) {
+ rpc RemoveContextChildren(RemoveContextChildrenRequest)
+ returns (RemoveContextChildrenResponse) {
option (google.api.http) = {
post: "/v1beta1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:removeContextChildren"
body: "*"
@@ -241,7 +254,8 @@ service MetadataService {
// Retrieves Artifacts and Executions within the specified Context, connected
// by Event edges and returned as a LineageSubgraph.
- rpc QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest) returns (LineageSubgraph) {
+ rpc QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest)
+ returns (LineageSubgraph) {
option (google.api.http) = {
get: "/v1beta1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:queryContextLineageSubgraph"
};
@@ -283,7 +297,8 @@ service MetadataService {
}
// Deletes an Execution.
- rpc DeleteExecution(DeleteExecutionRequest) returns (google.longrunning.Operation) {
+ rpc DeleteExecution(DeleteExecutionRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/metadataStores/*/executions/*}"
};
@@ -295,7 +310,8 @@ service MetadataService {
}
// Purges Executions.
- rpc PurgeExecutions(PurgeExecutionsRequest) returns (google.longrunning.Operation) {
+ rpc PurgeExecutions(PurgeExecutionsRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/executions:purge"
body: "*"
@@ -311,7 +327,8 @@ service MetadataService {
// Artifact was used as an input or output for an Execution. If an Event
// already exists between the Execution and the Artifact, the Event is
// skipped.
- rpc AddExecutionEvents(AddExecutionEventsRequest) returns (AddExecutionEventsResponse) {
+ rpc AddExecutionEvents(AddExecutionEventsRequest)
+ returns (AddExecutionEventsResponse) {
option (google.api.http) = {
post: "/v1beta1/{execution=projects/*/locations/*/metadataStores/*/executions/*}:addExecutionEvents"
body: "*"
@@ -322,7 +339,8 @@ service MetadataService {
// Obtains the set of input and output Artifacts for this Execution, in the
// form of LineageSubgraph that also contains the Execution and connecting
// Events.
- rpc QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest) returns (LineageSubgraph) {
+ rpc QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest)
+ returns (LineageSubgraph) {
option (google.api.http) = {
get: "/v1beta1/{execution=projects/*/locations/*/metadataStores/*/executions/*}:queryExecutionInputsAndOutputs"
};
@@ -330,12 +348,14 @@ service MetadataService {
}
// Creates a MetadataSchema.
- rpc CreateMetadataSchema(CreateMetadataSchemaRequest) returns (MetadataSchema) {
+ rpc CreateMetadataSchema(CreateMetadataSchemaRequest)
+ returns (MetadataSchema) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/metadataSchemas"
body: "metadata_schema"
};
- option (google.api.method_signature) = "parent,metadata_schema,metadata_schema_id";
+ option (google.api.method_signature) =
+ "parent,metadata_schema,metadata_schema_id";
}
// Retrieves a specific MetadataSchema.
@@ -347,7 +367,8 @@ service MetadataService {
}
// Lists MetadataSchemas.
- rpc ListMetadataSchemas(ListMetadataSchemasRequest) returns (ListMetadataSchemasResponse) {
+ rpc ListMetadataSchemas(ListMetadataSchemasRequest)
+ returns (ListMetadataSchemasResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/metadataSchemas"
};
@@ -356,7 +377,8 @@ service MetadataService {
// Retrieves lineage of an Artifact represented through Artifacts and
// Executions connected by Event edges and returned as a LineageSubgraph.
- rpc QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest) returns (LineageSubgraph) {
+ rpc QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest)
+ returns (LineageSubgraph) {
option (google.api.http) = {
get: "/v1beta1/{artifact=projects/*/locations/*/metadataStores/*/artifacts/*}:queryArtifactLineageSubgraph"
};
@@ -364,7 +386,8 @@ service MetadataService {
}
}
-// Request message for [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore].
+// Request message for
+// [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore].
message CreateMetadataStoreRequest {
// Required. The resource name of the Location where the MetadataStore should
// be created.
@@ -390,13 +413,15 @@ message CreateMetadataStoreRequest {
string metadata_store_id = 3;
}
-// Details of operations that perform [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore].
+// Details of operations that perform
+// [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore].
message CreateMetadataStoreOperationMetadata {
// Operation metadata for creating a MetadataStore.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [MetadataService.GetMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataStore].
+// Request message for
+// [MetadataService.GetMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataStore].
message GetMetadataStoreRequest {
// Required. The resource name of the MetadataStore to retrieve.
// Format:
@@ -409,7 +434,8 @@ message GetMetadataStoreRequest {
];
}
-// Request message for [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores].
+// Request message for
+// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores].
message ListMetadataStoresRequest {
// Required. The Location whose MetadataStores should be listed.
// Format:
@@ -427,8 +453,8 @@ message ListMetadataStoresRequest {
int32 page_size = 2;
// A page token, received from a previous
- // [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores] call. Provide this to retrieve the
- // subsequent page.
+ // [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other provided parameters must match the call that
// provided the page token. (Otherwise the request will fail with
@@ -436,18 +462,21 @@ message ListMetadataStoresRequest {
string page_token = 3;
}
-// Response message for [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores].
+// Response message for
+// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores].
message ListMetadataStoresResponse {
// The MetadataStores found for the Location.
repeated MetadataStore metadata_stores = 1;
// A token, which can be sent as
- // [ListMetadataStoresRequest.page_token][google.cloud.aiplatform.v1beta1.ListMetadataStoresRequest.page_token] to retrieve the next
- // page. If this field is not populated, there are no subsequent pages.
+ // [ListMetadataStoresRequest.page_token][google.cloud.aiplatform.v1beta1.ListMetadataStoresRequest.page_token]
+ // to retrieve the next page. If this field is not populated, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore].
+// Request message for
+// [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore].
message DeleteMetadataStoreRequest {
// Required. The resource name of the MetadataStore to delete.
// Format:
@@ -463,13 +492,15 @@ message DeleteMetadataStoreRequest {
bool force = 2 [deprecated = true];
}
-// Details of operations that perform [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore].
+// Details of operations that perform
+// [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore].
message DeleteMetadataStoreOperationMetadata {
// Operation metadata for deleting a MetadataStore.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [MetadataService.CreateArtifact][google.cloud.aiplatform.v1beta1.MetadataService.CreateArtifact].
+// Request message for
+// [MetadataService.CreateArtifact][google.cloud.aiplatform.v1beta1.MetadataService.CreateArtifact].
message CreateArtifactRequest {
// Required. The resource name of the MetadataStore where the Artifact should
// be created.
@@ -495,7 +526,8 @@ message CreateArtifactRequest {
string artifact_id = 3;
}
-// Request message for [MetadataService.GetArtifact][google.cloud.aiplatform.v1beta1.MetadataService.GetArtifact].
+// Request message for
+// [MetadataService.GetArtifact][google.cloud.aiplatform.v1beta1.MetadataService.GetArtifact].
message GetArtifactRequest {
// Required. The resource name of the Artifact to retrieve.
// Format:
@@ -508,7 +540,8 @@ message GetArtifactRequest {
];
}
-// Request message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts].
+// Request message for
+// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts].
message ListArtifactsRequest {
// Required. The MetadataStore whose Artifacts should be listed.
// Format:
@@ -524,7 +557,8 @@ message ListArtifactsRequest {
// Must be in range 1-1000, inclusive. Defaults to 100.
int32 page_size = 2;
- // A page token, received from a previous [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts]
+ // A page token, received from a previous
+ // [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other provided parameters must match the call that
@@ -571,36 +605,42 @@ message ListArtifactsRequest {
string order_by = 5;
}
-// Response message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts].
+// Response message for
+// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts].
message ListArtifactsResponse {
// The Artifacts retrieved from the MetadataStore.
repeated Artifact artifacts = 1;
- // A token, which can be sent as [ListArtifactsRequest.page_token][google.cloud.aiplatform.v1beta1.ListArtifactsRequest.page_token]
+ // A token, which can be sent as
+ // [ListArtifactsRequest.page_token][google.cloud.aiplatform.v1beta1.ListArtifactsRequest.page_token]
// to retrieve the next page.
// If this field is not populated, there are no subsequent pages.
string next_page_token = 2;
}
-// Request message for [MetadataService.UpdateArtifact][google.cloud.aiplatform.v1beta1.MetadataService.UpdateArtifact].
+// Request message for
+// [MetadataService.UpdateArtifact][google.cloud.aiplatform.v1beta1.MetadataService.UpdateArtifact].
message UpdateArtifactRequest {
// Required. The Artifact containing updates.
- // The Artifact's [Artifact.name][google.cloud.aiplatform.v1beta1.Artifact.name] field is used to identify the Artifact to
- // be updated.
- // Format:
+ // The Artifact's
+ // [Artifact.name][google.cloud.aiplatform.v1beta1.Artifact.name] field is
+ // used to identify the Artifact to be updated. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
Artifact artifact = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. A FieldMask indicating which fields should be updated.
// Functionality of this field is not yet supported.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = OPTIONAL];
- // If set to true, and the [Artifact][google.cloud.aiplatform.v1beta1.Artifact] is not found, a new [Artifact][google.cloud.aiplatform.v1beta1.Artifact] is
- // created.
+ // If set to true, and the
+ // [Artifact][google.cloud.aiplatform.v1beta1.Artifact] is not found, a new
+ // [Artifact][google.cloud.aiplatform.v1beta1.Artifact] is created.
bool allow_missing = 3;
}
-// Request message for [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1beta1.MetadataService.DeleteArtifact].
+// Request message for
+// [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1beta1.MetadataService.DeleteArtifact].
message DeleteArtifactRequest {
// Required. The resource name of the Artifact to delete.
// Format:
@@ -618,7 +658,8 @@ message DeleteArtifactRequest {
string etag = 2 [(google.api.field_behavior) = OPTIONAL];
}
-// Request message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts].
+// Request message for
+// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts].
message PurgeArtifactsRequest {
// Required. The metadata store to purge Artifacts from.
// Format:
@@ -640,7 +681,8 @@ message PurgeArtifactsRequest {
bool force = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts].
+// Response message for
+// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts].
message PurgeArtifactsResponse {
// The number of Artifacts that this request deleted (or, if `force` is false,
// the number of Artifacts that will be deleted). This can be an estimate.
@@ -650,21 +692,22 @@ message PurgeArtifactsResponse {
// Only populated if `force` is set to false. The maximum number of samples is
// 100 (it is possible to return fewer).
repeated string purge_sample = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Artifact"
- }];
+ type: "aiplatform.googleapis.com/Artifact"
+ }];
}
-// Details of operations that perform [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts].
+// Details of operations that perform
+// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts].
message PurgeArtifactsMetadata {
// Operation metadata for purging Artifacts.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [MetadataService.CreateContext][google.cloud.aiplatform.v1beta1.MetadataService.CreateContext].
+// Request message for
+// [MetadataService.CreateContext][google.cloud.aiplatform.v1beta1.MetadataService.CreateContext].
message CreateContextRequest {
- // Required. The resource name of the MetadataStore where the Context should be
- // created.
- // Format:
+ // Required. The resource name of the MetadataStore where the Context should
+ // be created. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -686,7 +729,8 @@ message CreateContextRequest {
string context_id = 3;
}
-// Request message for [MetadataService.GetContext][google.cloud.aiplatform.v1beta1.MetadataService.GetContext].
+// Request message for
+// [MetadataService.GetContext][google.cloud.aiplatform.v1beta1.MetadataService.GetContext].
message GetContextRequest {
// Required. The resource name of the Context to retrieve.
// Format:
@@ -699,7 +743,8 @@ message GetContextRequest {
];
}
-// Request message for [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]
+// Request message for
+// [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]
message ListContextsRequest {
// Required. The MetadataStore whose Contexts should be listed.
// Format:
@@ -715,7 +760,8 @@ message ListContextsRequest {
// Must be in range 1-1000, inclusive. Defaults to 100.
int32 page_size = 2;
- // A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]
+ // A page token, received from a previous
+ // [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other provided parameters must match the call that
@@ -766,36 +812,41 @@ message ListContextsRequest {
string order_by = 5;
}
-// Response message for [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts].
+// Response message for
+// [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts].
message ListContextsResponse {
// The Contexts retrieved from the MetadataStore.
repeated Context contexts = 1;
- // A token, which can be sent as [ListContextsRequest.page_token][google.cloud.aiplatform.v1beta1.ListContextsRequest.page_token]
+ // A token, which can be sent as
+ // [ListContextsRequest.page_token][google.cloud.aiplatform.v1beta1.ListContextsRequest.page_token]
// to retrieve the next page.
// If this field is not populated, there are no subsequent pages.
string next_page_token = 2;
}
-// Request message for [MetadataService.UpdateContext][google.cloud.aiplatform.v1beta1.MetadataService.UpdateContext].
+// Request message for
+// [MetadataService.UpdateContext][google.cloud.aiplatform.v1beta1.MetadataService.UpdateContext].
message UpdateContextRequest {
// Required. The Context containing updates.
- // The Context's [Context.name][google.cloud.aiplatform.v1beta1.Context.name] field is used to identify the Context to be
- // updated.
- // Format:
+ // The Context's [Context.name][google.cloud.aiplatform.v1beta1.Context.name]
+ // field is used to identify the Context to be updated. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Context context = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. A FieldMask indicating which fields should be updated.
// Functionality of this field is not yet supported.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = OPTIONAL];
- // If set to true, and the [Context][google.cloud.aiplatform.v1beta1.Context] is not found, a new [Context][google.cloud.aiplatform.v1beta1.Context] is
+ // If set to true, and the [Context][google.cloud.aiplatform.v1beta1.Context]
+ // is not found, a new [Context][google.cloud.aiplatform.v1beta1.Context] is
// created.
bool allow_missing = 3;
}
-// Request message for [MetadataService.DeleteContext][google.cloud.aiplatform.v1beta1.MetadataService.DeleteContext].
+// Request message for
+// [MetadataService.DeleteContext][google.cloud.aiplatform.v1beta1.MetadataService.DeleteContext].
message DeleteContextRequest {
// Required. The resource name of the Context to delete.
// Format:
@@ -817,7 +868,8 @@ message DeleteContextRequest {
string etag = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Request message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts].
+// Request message for
+// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts].
message PurgeContextsRequest {
// Required. The metadata store to purge Contexts from.
// Format:
@@ -839,7 +891,8 @@ message PurgeContextsRequest {
bool force = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts].
+// Response message for
+// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts].
message PurgeContextsResponse {
// The number of Contexts that this request deleted (or, if `force` is false,
// the number of Contexts that will be deleted). This can be an estimate.
@@ -849,21 +902,22 @@ message PurgeContextsResponse {
// Only populated if `force` is set to false. The maximum number of samples is
// 100 (it is possible to return fewer).
repeated string purge_sample = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Context"
- }];
+ type: "aiplatform.googleapis.com/Context"
+ }];
}
-// Details of operations that perform [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts].
+// Details of operations that perform
+// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts].
message PurgeContextsMetadata {
// Operation metadata for purging Contexts.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions].
+// Request message for
+// [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions].
message AddContextArtifactsAndExecutionsRequest {
- // Required. The resource name of the Context that the Artifacts and Executions
- // belong to.
- // Format:
+ // Required. The resource name of the Context that the Artifacts and
+ // Executions belong to. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
string context = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -877,8 +931,8 @@ message AddContextArtifactsAndExecutionsRequest {
// Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
repeated string artifacts = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Artifact"
- }];
+ type: "aiplatform.googleapis.com/Artifact"
+ }];
// The resource names of the Executions to associate with the
// Context.
@@ -886,16 +940,16 @@ message AddContextArtifactsAndExecutionsRequest {
// Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
repeated string executions = 3 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Execution"
- }];
+ type: "aiplatform.googleapis.com/Execution"
+ }];
}
-// Response message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions].
-message AddContextArtifactsAndExecutionsResponse {
+// Response message for
+// [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions].
+message AddContextArtifactsAndExecutionsResponse {}
-}
-
-// Request message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren].
+// Request message for
+// [MetadataService.AddContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren].
message AddContextChildrenRequest {
// Required. The resource name of the parent Context.
//
@@ -910,14 +964,13 @@ message AddContextChildrenRequest {
// The resource names of the child Contexts.
repeated string child_contexts = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Context"
- }];
+ type: "aiplatform.googleapis.com/Context"
+ }];
}
-// Response message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren].
-message AddContextChildrenResponse {
-
-}
+// Response message for
+// [MetadataService.AddContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren].
+message AddContextChildrenResponse {}
// Request message for
// [MetadataService.DeleteContextChildrenRequest][].
@@ -935,16 +988,16 @@ message RemoveContextChildrenRequest {
// The resource names of the child Contexts.
repeated string child_contexts = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Context"
- }];
+ type: "aiplatform.googleapis.com/Context"
+ }];
}
-// Response message for [MetadataService.RemoveContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.RemoveContextChildren].
-message RemoveContextChildrenResponse {
+// Response message for
+// [MetadataService.RemoveContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.RemoveContextChildren].
+message RemoveContextChildrenResponse {}
-}
-
-// Request message for [MetadataService.QueryContextLineageSubgraph][google.cloud.aiplatform.v1beta1.MetadataService.QueryContextLineageSubgraph].
+// Request message for
+// [MetadataService.QueryContextLineageSubgraph][google.cloud.aiplatform.v1beta1.MetadataService.QueryContextLineageSubgraph].
message QueryContextLineageSubgraphRequest {
// Required. The resource name of the Context whose Artifacts and Executions
// should be retrieved as a LineageSubgraph.
@@ -962,7 +1015,8 @@ message QueryContextLineageSubgraphRequest {
];
}
-// Request message for [MetadataService.CreateExecution][google.cloud.aiplatform.v1beta1.MetadataService.CreateExecution].
+// Request message for
+// [MetadataService.CreateExecution][google.cloud.aiplatform.v1beta1.MetadataService.CreateExecution].
message CreateExecutionRequest {
// Required. The resource name of the MetadataStore where the Execution should
// be created.
@@ -989,7 +1043,8 @@ message CreateExecutionRequest {
string execution_id = 3;
}
-// Request message for [MetadataService.GetExecution][google.cloud.aiplatform.v1beta1.MetadataService.GetExecution].
+// Request message for
+// [MetadataService.GetExecution][google.cloud.aiplatform.v1beta1.MetadataService.GetExecution].
message GetExecutionRequest {
// Required. The resource name of the Execution to retrieve.
// Format:
@@ -1002,7 +1057,8 @@ message GetExecutionRequest {
];
}
-// Request message for [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions].
+// Request message for
+// [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions].
message ListExecutionsRequest {
// Required. The MetadataStore whose Executions should be listed.
// Format:
@@ -1018,7 +1074,8 @@ message ListExecutionsRequest {
// Must be in range 1-1000, inclusive. Defaults to 100.
int32 page_size = 2;
- // A page token, received from a previous [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions]
+ // A page token, received from a previous
+ // [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions]
// call. Provide this to retrieve the subsequent page.
//
// When paginating, all other provided parameters must match the call that
@@ -1065,36 +1122,42 @@ message ListExecutionsRequest {
string order_by = 5;
}
-// Response message for [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions].
+// Response message for
+// [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions].
message ListExecutionsResponse {
// The Executions retrieved from the MetadataStore.
repeated Execution executions = 1;
- // A token, which can be sent as [ListExecutionsRequest.page_token][google.cloud.aiplatform.v1beta1.ListExecutionsRequest.page_token]
+ // A token, which can be sent as
+ // [ListExecutionsRequest.page_token][google.cloud.aiplatform.v1beta1.ListExecutionsRequest.page_token]
// to retrieve the next page.
// If this field is not populated, there are no subsequent pages.
string next_page_token = 2;
}
-// Request message for [MetadataService.UpdateExecution][google.cloud.aiplatform.v1beta1.MetadataService.UpdateExecution].
+// Request message for
+// [MetadataService.UpdateExecution][google.cloud.aiplatform.v1beta1.MetadataService.UpdateExecution].
message UpdateExecutionRequest {
// Required. The Execution containing updates.
- // The Execution's [Execution.name][google.cloud.aiplatform.v1beta1.Execution.name] field is used to identify the Execution
- // to be updated.
- // Format:
+ // The Execution's
+ // [Execution.name][google.cloud.aiplatform.v1beta1.Execution.name] field is
+ // used to identify the Execution to be updated. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
Execution execution = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. A FieldMask indicating which fields should be updated.
// Functionality of this field is not yet supported.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = OPTIONAL];
- // If set to true, and the [Execution][google.cloud.aiplatform.v1beta1.Execution] is not found, a new [Execution][google.cloud.aiplatform.v1beta1.Execution]
- // is created.
+ // If set to true, and the
+ // [Execution][google.cloud.aiplatform.v1beta1.Execution] is not found, a new
+ // [Execution][google.cloud.aiplatform.v1beta1.Execution] is created.
bool allow_missing = 3;
}
-// Request message for [MetadataService.DeleteExecution][google.cloud.aiplatform.v1beta1.MetadataService.DeleteExecution].
+// Request message for
+// [MetadataService.DeleteExecution][google.cloud.aiplatform.v1beta1.MetadataService.DeleteExecution].
message DeleteExecutionRequest {
// Required. The resource name of the Execution to delete.
// Format:
@@ -1112,7 +1175,8 @@ message DeleteExecutionRequest {
string etag = 2 [(google.api.field_behavior) = OPTIONAL];
}
-// Request message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions].
+// Request message for
+// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions].
message PurgeExecutionsRequest {
// Required. The metadata store to purge Executions from.
// Format:
@@ -1134,7 +1198,8 @@ message PurgeExecutionsRequest {
bool force = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions].
+// Response message for
+// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions].
message PurgeExecutionsResponse {
// The number of Executions that this request deleted (or, if `force` is
// false, the number of Executions that will be deleted). This can be an
@@ -1145,17 +1210,19 @@ message PurgeExecutionsResponse {
// Only populated if `force` is set to false. The maximum number of samples is
// 100 (it is possible to return fewer).
repeated string purge_sample = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Execution"
- }];
+ type: "aiplatform.googleapis.com/Execution"
+ }];
}
-// Details of operations that perform [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions].
+// Details of operations that perform
+// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions].
message PurgeExecutionsMetadata {
// Operation metadata for purging Executions.
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents].
+// Request message for
+// [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents].
message AddExecutionEventsRequest {
// Required. The resource name of the Execution that the Events connect
// Artifacts with.
@@ -1172,16 +1239,15 @@ message AddExecutionEventsRequest {
repeated Event events = 2;
}
-// Response message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents].
-message AddExecutionEventsResponse {
+// Response message for
+// [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents].
+message AddExecutionEventsResponse {}
-}
-
-// Request message for [MetadataService.QueryExecutionInputsAndOutputs][google.cloud.aiplatform.v1beta1.MetadataService.QueryExecutionInputsAndOutputs].
+// Request message for
+// [MetadataService.QueryExecutionInputsAndOutputs][google.cloud.aiplatform.v1beta1.MetadataService.QueryExecutionInputsAndOutputs].
message QueryExecutionInputsAndOutputsRequest {
- // Required. The resource name of the Execution whose input and output Artifacts should
- // be retrieved as a LineageSubgraph.
- // Format:
+ // Required. The resource name of the Execution whose input and output
+ // Artifacts should be retrieved as a LineageSubgraph. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
string execution = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -1191,11 +1257,11 @@ message QueryExecutionInputsAndOutputsRequest {
];
}
-// Request message for [MetadataService.CreateMetadataSchema][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataSchema].
+// Request message for
+// [MetadataService.CreateMetadataSchema][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataSchema].
message CreateMetadataSchemaRequest {
- // Required. The resource name of the MetadataStore where the MetadataSchema should
- // be created.
- // Format:
+ // Required. The resource name of the MetadataStore where the MetadataSchema
+ // should be created. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -1218,7 +1284,8 @@ message CreateMetadataSchemaRequest {
string metadata_schema_id = 3;
}
-// Request message for [MetadataService.GetMetadataSchema][google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataSchema].
+// Request message for
+// [MetadataService.GetMetadataSchema][google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataSchema].
message GetMetadataSchemaRequest {
// Required. The resource name of the MetadataSchema to retrieve.
// Format:
@@ -1231,7 +1298,8 @@ message GetMetadataSchemaRequest {
];
}
-// Request message for [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas].
+// Request message for
+// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas].
message ListMetadataSchemasRequest {
// Required. The MetadataStore whose MetadataSchemas should be listed.
// Format:
@@ -1249,8 +1317,8 @@ message ListMetadataSchemasRequest {
int32 page_size = 2;
// A page token, received from a previous
- // [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas] call. Provide this to retrieve the
- // next page.
+ // [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas]
+ // call. Provide this to retrieve the next page.
//
// When paginating, all other provided parameters must match the call that
// provided the page token. (Otherwise the request will fail with
@@ -1261,22 +1329,24 @@ message ListMetadataSchemasRequest {
string filter = 4;
}
-// Response message for [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas].
+// Response message for
+// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas].
message ListMetadataSchemasResponse {
// The MetadataSchemas found for the MetadataStore.
repeated MetadataSchema metadata_schemas = 1;
// A token, which can be sent as
- // [ListMetadataSchemasRequest.page_token][google.cloud.aiplatform.v1beta1.ListMetadataSchemasRequest.page_token] to retrieve the next
- // page. If this field is not populated, there are no subsequent pages.
+ // [ListMetadataSchemasRequest.page_token][google.cloud.aiplatform.v1beta1.ListMetadataSchemasRequest.page_token]
+ // to retrieve the next page. If this field is not populated, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1beta1.MetadataService.QueryArtifactLineageSubgraph].
+// Request message for
+// [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1beta1.MetadataService.QueryArtifactLineageSubgraph].
message QueryArtifactLineageSubgraphRequest {
- // Required. The resource name of the Artifact whose Lineage needs to be retrieved as a
- // LineageSubgraph.
- // Format:
+ // Required. The resource name of the Artifact whose Lineage needs to be
+ // retrieved as a LineageSubgraph. Format:
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
//
// The request may error with FAILED_PRECONDITION if the number of Artifacts,
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_store.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_store.proto
index 2d8a19d3a..a96a5780e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_store.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/metadata_store.proto
@@ -22,7 +22,7 @@ import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MetadataProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -47,10 +47,12 @@ message MetadataStore {
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this MetadataStore was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this MetadataStore was last updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Customer-managed encryption key spec for a Metadata Store. If set, this
// Metadata Store and all sub-resources of this Metadata Store are secured
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/migratable_resource.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/migratable_resource.proto
index bd8aa7301..21ab28c9d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/migratable_resource.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/migratable_resource.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MigratableResourceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -65,9 +65,9 @@ message MigratableResource {
// Full resource name of ml engine model Version.
// Format: `projects/{project}/models/{model}/versions/{version}`.
- string version = 2 [(google.api.resource_reference) = {
- type: "ml.googleapis.com/Version"
- }];
+ string version = 2 [
+ (google.api.resource_reference) = { type: "ml.googleapis.com/Version" }
+ ];
}
// Represents one Model in automl.googleapis.com.
@@ -75,9 +75,9 @@ message MigratableResource {
// Full resource name of automl Model.
// Format:
// `projects/{project}/locations/{location}/models/{model}`.
- string model = 1 [(google.api.resource_reference) = {
- type: "automl.googleapis.com/Model"
- }];
+ string model = 1 [
+ (google.api.resource_reference) = { type: "automl.googleapis.com/Model" }
+ ];
// The Model's display name in automl.googleapis.com.
string model_display_name = 3;
@@ -89,8 +89,8 @@ message MigratableResource {
// Format:
// `projects/{project}/locations/{location}/datasets/{dataset}`.
string dataset = 1 [(google.api.resource_reference) = {
- type: "automl.googleapis.com/Dataset"
- }];
+ type: "automl.googleapis.com/Dataset"
+ }];
// The Dataset's display name in automl.googleapis.com.
string dataset_display_name = 4;
@@ -104,8 +104,8 @@ message MigratableResource {
// Format:
// `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.
string annotated_dataset = 1 [(google.api.resource_reference) = {
- type: "datalabeling.googleapis.com/AnnotatedDataset"
- }];
+ type: "datalabeling.googleapis.com/AnnotatedDataset"
+ }];
// The AnnotatedDataset's display name in datalabeling.googleapis.com.
string annotated_dataset_display_name = 3;
@@ -115,8 +115,8 @@ message MigratableResource {
// Format:
// `projects/{project}/datasets/{dataset}`.
string dataset = 1 [(google.api.resource_reference) = {
- type: "datalabeling.googleapis.com/Dataset"
- }];
+ type: "datalabeling.googleapis.com/Dataset"
+ }];
// The Dataset's display name in datalabeling.googleapis.com.
string dataset_display_name = 4;
@@ -128,23 +128,28 @@ message MigratableResource {
oneof resource {
// Output only. Represents one Version in ml.googleapis.com.
- MlEngineModelVersion ml_engine_model_version = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ MlEngineModelVersion ml_engine_model_version = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Represents one Model in automl.googleapis.com.
AutomlModel automl_model = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Represents one Dataset in automl.googleapis.com.
- AutomlDataset automl_dataset = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ AutomlDataset automl_dataset = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Represents one Dataset in datalabeling.googleapis.com.
- DataLabelingDataset data_labeling_dataset = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ DataLabelingDataset data_labeling_dataset = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
- // Output only. Timestamp when the last migration attempt on this MigratableResource
- // started. Will not be set if there's no migration attempt on this
- // MigratableResource.
- google.protobuf.Timestamp last_migrate_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Timestamp when the last migration attempt on this
+ // MigratableResource started. Will not be set if there's no migration attempt
+ // on this MigratableResource.
+ google.protobuf.Timestamp last_migrate_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this MigratableResource was last updated.
- google.protobuf.Timestamp last_update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp last_update_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/migration_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/migration_service.proto
index f08ad889c..00e4f582f 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/migration_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/migration_service.proto
@@ -26,7 +26,7 @@ import "google/longrunning/operations.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "MigrationServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -37,12 +37,14 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
service MigrationService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Searches all of the resources in automl.googleapis.com,
// datalabeling.googleapis.com and ml.googleapis.com that can be migrated to
// Vertex AI's given location.
- rpc SearchMigratableResources(SearchMigratableResourcesRequest) returns (SearchMigratableResourcesResponse) {
+ rpc SearchMigratableResources(SearchMigratableResourcesRequest)
+ returns (SearchMigratableResourcesResponse) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/migratableResources:search"
body: "*"
@@ -52,7 +54,8 @@ service MigrationService {
// Batch migrates resources from ml.googleapis.com, automl.googleapis.com,
// and datalabeling.googleapis.com to Vertex AI.
- rpc BatchMigrateResources(BatchMigrateResourcesRequest) returns (google.longrunning.Operation) {
+ rpc BatchMigrateResources(BatchMigrateResourcesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/migratableResources:batchMigrate"
body: "*"
@@ -65,12 +68,12 @@ service MigrationService {
}
}
-// Request message for [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources].
+// Request message for
+// [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources].
message SearchMigratableResourcesRequest {
- // Required. The location that the migratable resources should be searched from.
- // It's the Vertex AI location that the resources can be migrated to, not
- // the resources' original location.
- // Format:
+ // Required. The location that the migratable resources should be searched
+ // from. It's the Vertex AI location that the resources can be migrated to,
+ // not the resources' original location. Format:
// `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -89,7 +92,8 @@ message SearchMigratableResourcesRequest {
// A filter for your search. You can use the following types of filters:
//
// * Resource type filters. The following strings filter for a specific type
- // of [MigratableResource][google.cloud.aiplatform.v1beta1.MigratableResource]:
+ // of
+ // [MigratableResource][google.cloud.aiplatform.v1beta1.MigratableResource]:
// * `ml_engine_model_version:*`
// * `automl_model:*`
// * `automl_dataset:*`
@@ -101,7 +105,8 @@ message SearchMigratableResourcesRequest {
string filter = 4;
}
-// Response message for [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources].
+// Response message for
+// [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources].
message SearchMigratableResourcesResponse {
// All migratable resources that can be migrated to the
// location specified in the request.
@@ -113,7 +118,8 @@ message SearchMigratableResourcesResponse {
string next_page_token = 2;
}
-// Request message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources].
+// Request message for
+// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources].
message BatchMigrateResourcesRequest {
// Required. The location of the migrated resource will live in.
// Format: `projects/{project}/locations/{location}`
@@ -127,7 +133,8 @@ message BatchMigrateResourcesRequest {
// Required. The request messages specifying the resources to migrate.
// They must be in the same location as the destination.
// Up to 50 resources can be migrated in one batch.
- repeated MigrateResourceRequest migrate_resource_requests = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated MigrateResourceRequest migrate_resource_requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Config of migrating one resource from automl.googleapis.com,
@@ -135,9 +142,8 @@ message BatchMigrateResourcesRequest {
message MigrateResourceRequest {
// Config for migrating version in ml.googleapis.com to Vertex AI's Model.
message MigrateMlEngineModelVersionConfig {
- // Required. The ml.googleapis.com endpoint that this model version should be migrated
- // from.
- // Example values:
+ // Required. The ml.googleapis.com endpoint that this model version should
+ // be migrated from. Example values:
//
// * ml.googleapis.com
//
@@ -152,9 +158,7 @@ message MigrateResourceRequest {
// Format: `projects/{project}/models/{model}/versions/{version}`.
string model_version = 2 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "ml.googleapis.com/Version"
- }
+ (google.api.resource_reference) = { type: "ml.googleapis.com/Version" }
];
// Required. Display name of the model in Vertex AI.
@@ -169,9 +173,7 @@ message MigrateResourceRequest {
// `projects/{project}/locations/{location}/models/{model}`.
string model = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "automl.googleapis.com/Model"
- }
+ (google.api.resource_reference) = { type: "automl.googleapis.com/Model" }
];
// Optional. Display name of the model in Vertex AI.
@@ -228,15 +230,18 @@ message MigrateResourceRequest {
// System will pick a display name if unspecified.
string dataset_display_name = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Configs for migrating AnnotatedDataset in datalabeling.googleapis.com to
- // Vertex AI's SavedQuery. The specified AnnotatedDatasets have to belong
- // to the datalabeling Dataset.
- repeated MigrateDataLabelingAnnotatedDatasetConfig migrate_data_labeling_annotated_dataset_configs = 3 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. Configs for migrating AnnotatedDataset in
+ // datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified
+ // AnnotatedDatasets have to belong to the datalabeling Dataset.
+ repeated MigrateDataLabelingAnnotatedDatasetConfig
+ migrate_data_labeling_annotated_dataset_configs = 3
+ [(google.api.field_behavior) = OPTIONAL];
}
oneof request {
// Config for migrating Version in ml.googleapis.com to Vertex AI's Model.
- MigrateMlEngineModelVersionConfig migrate_ml_engine_model_version_config = 1;
+ MigrateMlEngineModelVersionConfig migrate_ml_engine_model_version_config =
+ 1;
// Config for migrating Model in automl.googleapis.com to Vertex AI's
// Model.
@@ -252,7 +257,8 @@ message MigrateResourceRequest {
}
}
-// Response message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources].
+// Response message for
+// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources].
message BatchMigrateResourcesResponse {
// Successfully migrated resources.
repeated MigrateResourceResponse migrate_resource_responses = 1;
@@ -264,13 +270,13 @@ message MigrateResourceResponse {
oneof migrated_resource {
// Migrated Dataset's resource name.
string dataset = 1 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Dataset"
- }];
+ type: "aiplatform.googleapis.com/Dataset"
+ }];
// Migrated Model's resource name.
string model = 2 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Model"
- }];
+ type: "aiplatform.googleapis.com/Model"
+ }];
}
// Before migration, the identifier in ml.googleapis.com,
@@ -278,7 +284,8 @@ message MigrateResourceResponse {
MigratableResource migratable_resource = 3;
}
-// Runtime operation information for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources].
+// Runtime operation information for
+// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources].
message BatchMigrateResourcesOperationMetadata {
// Represents a partial result in batch migration operation for one
// [MigrateResourceRequest][google.cloud.aiplatform.v1beta1.MigrateResourceRequest].
@@ -292,13 +299,13 @@ message BatchMigrateResourcesOperationMetadata {
// Migrated model resource name.
string model = 3 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Model"
- }];
+ type: "aiplatform.googleapis.com/Model"
+ }];
// Migrated dataset resource name.
string dataset = 4 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Dataset"
- }];
+ type: "aiplatform.googleapis.com/Dataset"
+ }];
}
// It's the same as the value in
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model.proto
index 7b5f9f0a0..5801b2e42 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model.proto
@@ -26,7 +26,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -50,12 +50,15 @@ message Model {
// Model artifact and any of its supported files. Will be exported to the
// location specified by the `artifactDestination` field of the
- // [ExportModelRequest.output_config][google.cloud.aiplatform.v1beta1.ExportModelRequest.output_config] object.
+ // [ExportModelRequest.output_config][google.cloud.aiplatform.v1beta1.ExportModelRequest.output_config]
+ // object.
ARTIFACT = 1;
// The container image that is to be used when deploying this Model. Will
// be exported to the location specified by the `imageDestination` field
- // of the [ExportModelRequest.output_config][google.cloud.aiplatform.v1beta1.ExportModelRequest.output_config] object.
+ // of the
+ // [ExportModelRequest.output_config][google.cloud.aiplatform.v1beta1.ExportModelRequest.output_config]
+ // object.
IMAGE = 2;
}
@@ -83,7 +86,28 @@ message Model {
string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The content of this Model that may be exported.
- repeated ExportableContent exportable_contents = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated ExportableContent exportable_contents = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Contains information about the original Model if this Model is a copy.
+ message OriginalModelInfo {
+ // Output only. The resource name of the Model this Model is a copy of,
+ // including the revision. Format:
+ // `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
+ string model = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/Model"
+ }
+ ];
+ }
+
+ // Contains information about the Large Model.
+ message LargeModelReference {
+ // Required. The unique name of the large Foundation or pre-built model.
+ // Like "chat-panda", "text-panda".
+ string name = 1 [(google.api.field_behavior) = REQUIRED];
}
// Identifies a type of Model's prediction resources.
@@ -91,16 +115,20 @@ message Model {
// Should not be used.
DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0;
- // Resources that are dedicated to the [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel], and that need a
- // higher degree of manual configuration.
+ // Resources that are dedicated to the
+ // [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel], and that
+ // need a higher degree of manual configuration.
DEDICATED_RESOURCES = 1;
// Resources that to large degree are decided by Vertex AI, and require
// only a modest additional configuration.
AUTOMATIC_RESOURCES = 2;
- // Resources that can be shared by multiple [DeployedModels][google.cloud.aiplatform.v1beta1.DeployedModel].
- // A pre-configured [DeploymentResourcePool][google.cloud.aiplatform.v1beta1.DeploymentResourcePool] is required.
+ // Resources that can be shared by multiple
+ // [DeployedModels][google.cloud.aiplatform.v1beta1.DeployedModel]. A
+ // pre-configured
+ // [DeploymentResourcePool][google.cloud.aiplatform.v1beta1.DeploymentResourcePool]
+ // is required.
SHARED_RESOURCES = 3;
}
@@ -128,10 +156,12 @@ message Model {
repeated string version_aliases = 29;
// Output only. Timestamp when this version was created.
- google.protobuf.Timestamp version_create_time = 31 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp version_create_time = 31
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this version was most recently updated.
- google.protobuf.Timestamp version_update_time = 32 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp version_update_time = 32
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Required. The display name of the Model.
// The name can be up to 128 characters long and can consist of any UTF-8
@@ -146,13 +176,15 @@ message Model {
// The schemata that describe formats of the Model's predictions and
// explanations as given and returned via
- // [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
+ // [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict]
+ // and
+ // [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
PredictSchemata predict_schemata = 4;
- // Immutable. Points to a YAML file stored on Google Cloud Storage describing additional
- // information about the Model, that is specific to it. Unset if the Model
- // does not have any additional information.
- // The schema is defined as an OpenAPI 3.0.2 [Schema
+ // Immutable. Points to a YAML file stored on Google Cloud Storage describing
+ // additional information about the Model, that is specific to it. Unset if
+ // the Model does not have any additional information. The schema is defined
+ // as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
// AutoML Models always have this field populated by Vertex AI, if no
// additional metadata is needed, this field is set to an empty string.
@@ -161,17 +193,19 @@ message Model {
// point to a location where the user only has a read access.
string metadata_schema_uri = 5 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. An additional information about the Model; the schema of the metadata can
- // be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Model.metadata_schema_uri].
+ // Immutable. An additional information about the Model; the schema of the
+ // metadata can be found in
+ // [metadata_schema][google.cloud.aiplatform.v1beta1.Model.metadata_schema_uri].
// Unset if the Model does not have any additional information.
google.protobuf.Value metadata = 6 [(google.api.field_behavior) = IMMUTABLE];
- // Output only. The formats in which this Model may be exported. If empty, this Model is
- // not available for export.
- repeated ExportFormat supported_export_formats = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The formats in which this Model may be exported. If empty,
+ // this Model is not available for export.
+ repeated ExportFormat supported_export_formats = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The resource name of the TrainingPipeline that uploaded this Model, if
- // any.
+ // Output only. The resource name of the TrainingPipeline that uploaded this
+ // Model, if any.
string training_pipeline = 7 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -179,35 +213,43 @@ message Model {
}
];
- // Input only. The specification of the container that is to be used when deploying
- // this Model. The specification is ingested upon
- // [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel], and all binaries it contains are copied
- // and stored internally by Vertex AI.
- // Not present for AutoML Models.
- ModelContainerSpec container_spec = 9 [(google.api.field_behavior) = INPUT_ONLY];
+ // Input only. The specification of the container that is to be used when
+ // deploying this Model. The specification is ingested upon
+ // [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel],
+ // and all binaries it contains are copied and stored internally by Vertex AI.
+ // Not present for AutoML Models or Large Models.
+ ModelContainerSpec container_spec = 9
+ [(google.api.field_behavior) = INPUT_ONLY];
- // Immutable. The path to the directory containing the Model artifact and any of its
- // supporting files.
- // Not present for AutoML Models.
+ // Immutable. The path to the directory containing the Model artifact and any
+ // of its supporting files. Not present for AutoML Models or Large Models.
string artifact_uri = 26 [(google.api.field_behavior) = IMMUTABLE];
- // Output only. When this Model is deployed, its prediction resources are described by the
- // `prediction_resources` field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] object.
- // Because not all Models support all resource configuration types, the
- // configuration types this Model supports are listed here. If no
+ // Output only. When this Model is deployed, its prediction resources are
+ // described by the `prediction_resources` field of the
+ // [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models]
+ // object. Because not all Models support all resource configuration types,
+ // the configuration types this Model supports are listed here. If no
// configuration types are listed, the Model cannot be deployed to an
// [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and does not support
- // online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or
- // [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]). Such a Model can serve predictions by
- // using a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob], if it has at least one entry each in
- // [supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats] and
+ // online predictions
+ // ([PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict]
+ // or
+ // [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]).
+ // Such a Model can serve predictions by using a
+ // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob],
+ // if it has at least one entry each in
+ // [supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats]
+ // and
// [supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats].
- repeated DeploymentResourcesType supported_deployment_resources_types = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated DeploymentResourcesType supported_deployment_resources_types = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The formats this Model supports in
- // [BatchPredictionJob.input_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. If
- // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] exists, the instances
- // should be given as per that schema.
+ // [BatchPredictionJob.input_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config].
+ // If
+ // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
+ // exists, the instances should be given as per that schema.
//
// The possible formats are:
//
@@ -218,11 +260,13 @@ message Model {
// * `csv`
// The CSV format, where each instance is a single comma-separated line.
// The first line in the file is the header, containing comma-separated field
- // names. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source].
+ // names. Uses
+ // [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source].
//
// * `tf-record`
// The TFRecord format, where each instance is a single record in tfrecord
- // syntax. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source].
+ // syntax. Uses
+ // [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source].
//
// * `tf-record-gzip`
// Similar to `tf-record`, but the file is gzipped. Uses
@@ -235,23 +279,31 @@ message Model {
// * `file-list`
// Each line of the file is the location of an instance to process, uses
// `gcs_source` field of the
- // [InputConfig][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig] object.
+ // [InputConfig][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig]
+ // object.
//
//
// If this Model doesn't support any of these formats it means it cannot be
- // used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has
- // [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online
- // predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or
+ // used with a
+ // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
+ // However, if it has
+ // [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types],
+ // it could serve online predictions by using
+ // [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict]
+ // or
// [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
- repeated string supported_input_storage_formats = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated string supported_input_storage_formats = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The formats this Model supports in
- // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]. If both
- // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] and
- // [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri] exist, the predictions
- // are returned together with their instances. In other words, the
- // prediction has the original instance data first, followed
- // by the actual prediction content (as per the schema).
+ // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config].
+ // If both
+ // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
+ // and
+ // [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri]
+ // exist, the predictions are returned together with their instances. In other
+ // words, the prediction has the original instance data first, followed by the
+ // actual prediction content (as per the schema).
//
// The possible formats are:
//
@@ -272,43 +324,63 @@ message Model {
//
//
// If this Model doesn't support any of these formats it means it cannot be
- // used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has
- // [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online
- // predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or
+ // used with a
+ // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
+ // However, if it has
+ // [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types],
+ // it could serve online predictions by using
+ // [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict]
+ // or
// [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
- repeated string supported_output_storage_formats = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated string supported_output_storage_formats = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Model was uploaded into Vertex AI.
- google.protobuf.Timestamp create_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Model was most recently updated.
- google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The pointers to DeployedModels created from this Model. Note that
- // Model could have been deployed to Endpoints in different Locations.
- repeated DeployedModelRef deployed_models = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The pointers to DeployedModels created from this Model. Note
+ // that Model could have been deployed to Endpoints in different Locations.
+ repeated DeployedModelRef deployed_models = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The default explanation specification for this Model.
//
- // The Model can be used for [requesting
- // explanation][PredictionService.Explain] after being
- // [deployed][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel] if it is populated.
- // The Model can be used for [batch
- // explanation][BatchPredictionJob.generate_explanation] if it is populated.
+ // The Model can be used for
+ // [requesting
+ // explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain]
+ // after being
+ // [deployed][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel] if
+ // it is populated. The Model can be used for [batch
+ // explanation][google.cloud.aiplatform.v1beta1.BatchPredictionJob.generate_explanation]
+ // if it is populated.
//
// All fields of the explanation_spec can be overridden by
- // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of
- // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model], or
- // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] of
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
+ // of
+ // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model],
+ // or
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
+ // of
// [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
//
// If the default explanation specification is not set for this Model, this
- // Model can still be used for [requesting
- // explanation][PredictionService.Explain] by setting
- // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of
- // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model] and for [batch
- // explanation][BatchPredictionJob.generate_explanation] by setting
- // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] of
+ // Model can still be used for
+ // [requesting
+ // explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] by
+ // setting
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
+ // of
+ // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model]
+ // and for [batch
+ // explanation][google.cloud.aiplatform.v1beta1.BatchPredictionJob.generate_explanation]
+ // by setting
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
+ // of
// [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
ExplanationSpec explanation_spec = 23;
@@ -329,23 +401,38 @@ message Model {
// Model and all sub-resources of this Model will be secured by this key.
EncryptionSpec encryption_spec = 24;
- // Output only. Source of a model. It can either be automl training pipeline, custom
- // training pipeline, BigQuery ML, or existing Vertex AI Model.
- ModelSourceInfo model_source_info = 38 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Source of a model. It can either be automl training pipeline,
+ // custom training pipeline, BigQuery ML, or existing Vertex AI Model.
+ ModelSourceInfo model_source_info = 38
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. If this Model is a copy of another Model, this contains info
+ // about the original.
+ OriginalModelInfo original_model_info = 34
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The resource name of the Artifact that was created in MetadataStore when
- // creating the Model. The Artifact resource name pattern is
+ // Output only. The resource name of the Artifact that was created in
+ // MetadataStore when creating the Model. The Artifact resource name pattern
+ // is
// `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
string metadata_artifact = 44 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Optional. Used to specify the large model reference.
+ // Only present for Large Models.
+ LargeModelReference large_model_reference = 45
+ [(google.api.field_behavior) = OPTIONAL];
}
// Contains the schemata used in Model's predictions and explanations via
-// [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict], [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain] and
-// [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
+// [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict],
+// [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]
+// and [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
message PredictSchemata {
- // Immutable. Points to a YAML file stored on Google Cloud Storage describing the format
- // of a single instance, which are used in [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances],
- // [ExplainRequest.instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] and
+ // Immutable. Points to a YAML file stored on Google Cloud Storage describing
+ // the format of a single instance, which are used in
+ // [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances],
+ // [ExplainRequest.instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances]
+ // and
// [BatchPredictionJob.input_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config].
// The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
@@ -355,9 +442,11 @@ message PredictSchemata {
// point to a location where the user only has a read access.
string instance_schema_uri = 1 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. Points to a YAML file stored on Google Cloud Storage describing the
- // parameters of prediction and explanation via
- // [PredictRequest.parameters][google.cloud.aiplatform.v1beta1.PredictRequest.parameters], [ExplainRequest.parameters][google.cloud.aiplatform.v1beta1.ExplainRequest.parameters] and
+ // Immutable. Points to a YAML file stored on Google Cloud Storage describing
+ // the parameters of prediction and explanation via
+ // [PredictRequest.parameters][google.cloud.aiplatform.v1beta1.PredictRequest.parameters],
+ // [ExplainRequest.parameters][google.cloud.aiplatform.v1beta1.ExplainRequest.parameters]
+ // and
// [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model_parameters].
// The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
@@ -368,9 +457,12 @@ message PredictSchemata {
// point to a location where the user only has a read access.
string parameters_schema_uri = 2 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. Points to a YAML file stored on Google Cloud Storage describing the format
- // of a single prediction produced by this Model, which are returned via
- // [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions], [ExplainResponse.explanations][google.cloud.aiplatform.v1beta1.ExplainResponse.explanations], and
+ // Immutable. Points to a YAML file stored on Google Cloud Storage describing
+ // the format of a single prediction produced by this Model, which are
+ // returned via
+ // [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions],
+ // [ExplainResponse.explanations][google.cloud.aiplatform.v1beta1.ExplainResponse.explanations],
+ // and
// [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config].
// The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
@@ -385,14 +477,16 @@ message PredictSchemata {
// message correspond to fields in the [Kubernetes Container v1 core
// specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
message ModelContainerSpec {
- // Required. Immutable. URI of the Docker image to be used as the custom container for serving
- // predictions. This URI must identify an image in Artifact Registry or
- // Container Registry. Learn more about the [container publishing
+ // Required. Immutable. URI of the Docker image to be used as the custom
+ // container for serving predictions. This URI must identify an image in
+ // Artifact Registry or Container Registry. Learn more about the [container
+ // publishing
// requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing),
// including permissions requirements for the Vertex AI Service Agent.
//
- // The container image is ingested upon [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel], stored
- // internally, and this original path is afterwards not used.
+ // The container image is ingested upon
+ // [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel],
+ // stored internally, and this original path is afterwards not used.
//
// To learn about the requirements for the Docker image itself, see
// [Custom container
@@ -406,18 +500,20 @@ message ModelContainerSpec {
(google.api.field_behavior) = IMMUTABLE
];
- // Immutable. Specifies the command that runs when the container starts. This overrides
- // the container's
+ // Immutable. Specifies the command that runs when the container starts. This
+ // overrides the container's
// [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint).
// Specify this field as an array of executable and arguments, similar to a
// Docker `ENTRYPOINT`'s "exec" form, not its "shell" form.
//
// If you do not specify this field, then the container's `ENTRYPOINT` runs,
- // in conjunction with the [args][google.cloud.aiplatform.v1beta1.ModelContainerSpec.args] field or the
- // container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd),
- // if either exists. If this field is not specified and the container does not
- // have an `ENTRYPOINT`, then refer to the Docker documentation about [how
- // `CMD` and `ENTRYPOINT`
+ // in conjunction with the
+ // [args][google.cloud.aiplatform.v1beta1.ModelContainerSpec.args] field or
+ // the container's
+ // [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either
+ // exists. If this field is not specified and the container does not have an
+ // `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and
+ // `ENTRYPOINT`
// interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact).
//
// If you specify this field, then you can also specify the `args` field to
@@ -429,9 +525,10 @@ message ModelContainerSpec {
//
// In this field, you can reference [environment variables set by Vertex
// AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables)
- // and environment variables set in the [env][google.cloud.aiplatform.v1beta1.ModelContainerSpec.env] field.
- // You cannot reference environment variables set in the Docker image. In
- // order for environment variables to be expanded, reference them by using the
+ // and environment variables set in the
+ // [env][google.cloud.aiplatform.v1beta1.ModelContainerSpec.env] field. You
+ // cannot reference environment variables set in the Docker image. In order
+ // for environment variables to be expanded, reference them by using the
// following syntax:
// $(VARIABLE_NAME)
// Note that this differs from Bash variable expansion, which does not use
@@ -444,16 +541,16 @@ message ModelContainerSpec {
// API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
repeated string command = 2 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. Specifies arguments for the command that runs when the container starts.
- // This overrides the container's
+ // Immutable. Specifies arguments for the command that runs when the container
+ // starts. This overrides the container's
// [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify
// this field as an array of executable and arguments, similar to a Docker
// `CMD`'s "default parameters" form.
//
// If you don't specify this field but do specify the
- // [command][google.cloud.aiplatform.v1beta1.ModelContainerSpec.command] field, then the command from the
- // `command` field runs without any additional arguments. See the
- // [Kubernetes documentation about how the
+ // [command][google.cloud.aiplatform.v1beta1.ModelContainerSpec.command]
+ // field, then the command from the `command` field runs without any
+ // additional arguments. See the [Kubernetes documentation about how the
// `command` and `args` fields interact with a container's `ENTRYPOINT` and
// `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes).
//
@@ -467,9 +564,10 @@ message ModelContainerSpec {
// In this field, you can reference [environment variables
// set by Vertex
// AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables)
- // and environment variables set in the [env][google.cloud.aiplatform.v1beta1.ModelContainerSpec.env] field.
- // You cannot reference environment variables set in the Docker image. In
- // order for environment variables to be expanded, reference them by using the
+ // and environment variables set in the
+ // [env][google.cloud.aiplatform.v1beta1.ModelContainerSpec.env] field. You
+ // cannot reference environment variables set in the Docker image. In order
+ // for environment variables to be expanded, reference them by using the
// following syntax:
// $(VARIABLE_NAME)
// Note that this differs from Bash variable expansion, which does not use
@@ -482,14 +580,16 @@ message ModelContainerSpec {
// API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
repeated string args = 3 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. List of environment variables to set in the container. After the container
- // starts running, code running in the container can read these environment
- // variables.
+ // Immutable. List of environment variables to set in the container. After the
+ // container starts running, code running in the container can read these
+ // environment variables.
//
- // Additionally, the [command][google.cloud.aiplatform.v1beta1.ModelContainerSpec.command] and
- // [args][google.cloud.aiplatform.v1beta1.ModelContainerSpec.args] fields can reference these variables. Later
- // entries in this list can also reference earlier entries. For example, the
- // following example sets the variable `VAR_2` to have the value `foo bar`:
+ // Additionally, the
+ // [command][google.cloud.aiplatform.v1beta1.ModelContainerSpec.command] and
+ // [args][google.cloud.aiplatform.v1beta1.ModelContainerSpec.args] fields can
+ // reference these variables. Later entries in this list can also reference
+ // earlier entries. For example, the following example sets the variable
+ // `VAR_2` to have the value `foo bar`:
//
// ```json
// [
@@ -535,11 +635,11 @@ message ModelContainerSpec {
// API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
repeated Port ports = 5 [(google.api.field_behavior) = IMMUTABLE];
- // Immutable. HTTP path on the container to send prediction requests to. Vertex AI
- // forwards requests sent using
- // [projects.locations.endpoints.predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] to this
- // path on the container's IP address and port. Vertex AI then returns the
- // container's response in the API response.
+ // Immutable. HTTP path on the container to send prediction requests to.
+ // Vertex AI forwards requests sent using
+ // [projects.locations.endpoints.predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict]
+ // to this path on the container's IP address and port. Vertex AI then returns
+ // the container's response in the API response.
//
// For example, if you set this field to `/foo`, then when Vertex AI
// receives a prediction request, it forwards the request body in a POST
@@ -548,7 +648,8 @@ message ModelContainerSpec {
// [ports][google.cloud.aiplatform.v1beta1.ModelContainerSpec.ports] field.
//
// If you don't specify this field, it defaults to the following value when
- // you [deploy this Model to an Endpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]:
+ // you [deploy this Model to an
+ // Endpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]:
// /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict
// The placeholders in this value are replaced as follows:
//
@@ -558,7 +659,9 @@ message ModelContainerSpec {
// as the [`AIP_ENDPOINT_ID` environment
// variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
//
- // * DEPLOYED_MODEL: [DeployedModel.id][google.cloud.aiplatform.v1beta1.DeployedModel.id] of the `DeployedModel`.
+ // * DEPLOYED_MODEL:
+ // [DeployedModel.id][google.cloud.aiplatform.v1beta1.DeployedModel.id] of the
+ // `DeployedModel`.
// (Vertex AI makes this value available to your container code
// as the [`AIP_DEPLOYED_MODEL_ID` environment
// variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
@@ -576,7 +679,8 @@ message ModelContainerSpec {
// [ports][google.cloud.aiplatform.v1beta1.ModelContainerSpec.ports] field.
//
// If you don't specify this field, it defaults to the following value when
- // you [deploy this Model to an Endpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]:
+ // you [deploy this Model to an
+ // Endpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]:
// /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict
// The placeholders in this value are replaced as follows:
//
@@ -586,7 +690,9 @@ message ModelContainerSpec {
// as the [`AIP_ENDPOINT_ID` environment
// variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
//
- // * DEPLOYED_MODEL: [DeployedModel.id][google.cloud.aiplatform.v1beta1.DeployedModel.id] of the `DeployedModel`.
+ // * DEPLOYED_MODEL:
+ // [DeployedModel.id][google.cloud.aiplatform.v1beta1.DeployedModel.id] of the
+ // `DeployedModel`.
// (Vertex AI makes this value available to your container code as the
// [`AIP_DEPLOYED_MODEL_ID` environment
// variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto
index e8b94d1d1..487077079 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto
@@ -29,7 +29,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelDeploymentMonitoringJobProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -118,20 +118,27 @@ message ModelDeploymentMonitoringJob {
JobState state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Schedule state when the monitoring job is in Running state.
- MonitoringScheduleState schedule_state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ MonitoringScheduleState schedule_state = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Latest triggered monitoring pipeline metadata.
- LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
+ LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Required. The config for monitoring objectives. This is a per DeployedModel config.
- // Each DeployedModel needs to be configured separately.
- repeated ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(google.api.field_behavior) = REQUIRED];
+ // Required. The config for monitoring objectives. This is a per DeployedModel
+ // config. Each DeployedModel needs to be configured separately.
+ repeated ModelDeploymentMonitoringObjectiveConfig
+ model_deployment_monitoring_objective_configs = 6
+ [(google.api.field_behavior) = REQUIRED];
// Required. Schedule config for running the monitoring job.
- ModelDeploymentMonitoringScheduleConfig model_deployment_monitoring_schedule_config = 7 [(google.api.field_behavior) = REQUIRED];
+ ModelDeploymentMonitoringScheduleConfig
+ model_deployment_monitoring_schedule_config = 7
+ [(google.api.field_behavior) = REQUIRED];
// Required. Sample Strategy for logging.
- SamplingStrategy logging_sampling_strategy = 8 [(google.api.field_behavior) = REQUIRED];
+ SamplingStrategy logging_sampling_strategy = 8
+ [(google.api.field_behavior) = REQUIRED];
// Alert config for model monitoring.
ModelMonitoringAlertConfig model_monitoring_alert_config = 15;
@@ -142,10 +149,12 @@ message ModelDeploymentMonitoringJob {
// requests.
string predict_instance_schema_uri = 9;
- // Sample Predict instance, same format as [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances],
+ // Sample Predict instance, same format as
+ // [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances],
// this can be set as a replacement of
- // [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri]. If not set,
- // we will generate predict schema from collected predict requests.
+ // [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri].
+ // If not set, we will generate predict schema from collected predict
+ // requests.
google.protobuf.Value sample_predict_instance = 19;
// YAML schema file uri describing the format of a single instance that you
@@ -161,12 +170,13 @@ message ModelDeploymentMonitoringJob {
// fields in predict instance formatted as string.
string analysis_instance_schema_uri = 16;
- // Output only. The created bigquery tables for the job under customer project. Customer
- // could do their own query & analysis. There could be 4 log tables in
- // maximum:
+ // Output only. The created bigquery tables for the job under customer
+ // project. Customer could do their own query & analysis. There could be 4 log
+ // tables in maximum:
// 1. Training data logging predict request/response
// 2. Serving data logging predict request/response
- repeated ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The TTL of BigQuery tables in user projects which stores logs.
// A day is the basic unit of the TTL and we take the ceil of TTL/86400(a
@@ -184,14 +194,18 @@ message ModelDeploymentMonitoringJob {
map labels = 11;
// Output only. Timestamp when this ModelDeploymentMonitoringJob was created.
- google.protobuf.Timestamp create_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.
- google.protobuf.Timestamp update_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Timestamp when this ModelDeploymentMonitoringJob was updated
+ // most recently.
+ google.protobuf.Timestamp update_time = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Timestamp when this monitoring pipeline will be scheduled to run for the
- // next round.
- google.protobuf.Timestamp next_schedule_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Timestamp when this monitoring pipeline will be scheduled to
+ // run for the next round.
+ google.protobuf.Timestamp next_schedule_time = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Stats anomalies base folder path.
GcsDestination stats_anomalies_base_directory = 20;
@@ -263,17 +277,19 @@ message ModelDeploymentMonitoringObjectiveConfig {
// The config for scheduling monitoring job.
message ModelDeploymentMonitoringScheduleConfig {
- // Required. The model monitoring job scheduling interval. It will be rounded up to next
- // full hour. This defines how often the monitoring jobs are triggered.
- google.protobuf.Duration monitor_interval = 1 [(google.api.field_behavior) = REQUIRED];
+ // Required. The model monitoring job scheduling interval. It will be rounded
+ // up to next full hour. This defines how often the monitoring jobs are
+ // triggered.
+ google.protobuf.Duration monitor_interval = 1
+ [(google.api.field_behavior) = REQUIRED];
// The time window of the prediction data being included in each prediction
// dataset. This window specifies how long the data should be collected from
// historical model results for each run. If not set,
- // [ModelDeploymentMonitoringScheduleConfig.monitor_interval][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringScheduleConfig.monitor_interval] will be used.
- // e.g. If currently the cutoff time is 2022-01-08 14:30:00 and the
- // monitor_window is set to be 3600, then data from 2022-01-08 13:30:00
- // to 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the
+ // [ModelDeploymentMonitoringScheduleConfig.monitor_interval][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringScheduleConfig.monitor_interval]
+ // will be used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and
+ // the monitor_window is set to be 3600, then data from 2022-01-08 13:30:00 to
+ // 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the
// monitoring statistics.
google.protobuf.Duration monitor_window = 2;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_evaluation.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_evaluation.proto
index 4e2c903e1..96d2d1016 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_evaluation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_evaluation.proto
@@ -23,7 +23,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelEvaluationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -58,8 +58,8 @@ message ModelEvaluation {
string display_name = 10;
// Points to a YAML file stored on Google Cloud Storage describing the
- // [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics] of this ModelEvaluation. The schema is
- // defined as an OpenAPI 3.0.2 [Schema
+ // [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics] of this
+ // ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
string metrics_schema_uri = 2;
@@ -68,12 +68,13 @@ message ModelEvaluation {
google.protobuf.Value metrics = 3;
// Output only. Timestamp when this ModelEvaluation was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// All possible [dimensions][ModelEvaluationSlice.slice.dimension] of
// ModelEvaluationSlices. The dimensions can be used as the filter of the
- // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices] request, in the form of
- // `slice.dimension = `.
+ // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices]
+ // request, in the form of `slice.dimension = `.
repeated string slice_dimensions = 5;
// Aggregated explanation metrics for the Model's prediction output over the
@@ -82,8 +83,9 @@ message ModelEvaluation {
//
ModelExplanation model_explanation = 8;
- // Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are used for explaining
- // the predicted values on the evaluated data.
+ // Describes the values of
+ // [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are
+ // used for explaining the predicted values on the evaluated data.
repeated ModelEvaluationExplanationSpec explanation_specs = 9;
// The metadata of the ModelEvaluation.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto
index aa39f1118..287ee6c31 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto
@@ -18,11 +18,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
+import "google/cloud/aiplatform/v1beta1/explanation.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelEvaluationSliceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -39,15 +41,125 @@ message ModelEvaluationSlice {
// Definition of a slice.
message Slice {
+ // Specification for how the data should be sliced.
+ message SliceSpec {
+ // Specification message containing the config for this SliceSpec.
+ // When `kind` is selected as `value` and/or `range`, only a single slice
+ // will be computed.
+ // When `all_values` is present, a separate slice will be computed for
+ // each possible label/value for the corresponding key in `config`.
+ // Examples, with feature zip_code with values 12345, 23334, 88888 and
+ // feature country with values "US", "Canada", "Mexico" in the dataset:
+ //
+ // Example 1:
+ //
+ // {
+ // "zip_code": { "value": { "float_value": 12345.0 } }
+ // }
+ //
+ // A single slice for any data with zip_code 12345 in the dataset.
+ //
+ // Example 2:
+ //
+ // {
+ // "zip_code": { "range": { "low": 12345, "high": 20000 } }
+ // }
+ //
+ // A single slice containing data where the zip_codes between 12345 and
+ // 20000 For this example, data with the zip_code of 12345 will be in this
+ // slice.
+ //
+ // Example 3:
+ //
+ // {
+ // "zip_code": { "range": { "low": 10000, "high": 20000 } },
+ // "country": { "value": { "string_value": "US" } }
+ // }
+ //
+ // A single slice containing data where the zip_codes between 10000 and
+ // 20000 has the country "US". For this example, data with the zip_code of
+ // 12345 and country "US" will be in this slice.
+ //
+ // Example 4:
+ //
+ // { "country": {"all_values": { "value": true } } }
+ //
+ // Three slices are computed, one for each unique country in the dataset.
+ //
+ // Example 5:
+ //
+ // {
+ // "country": { "all_values": { "value": true } },
+ // "zip_code": { "value": { "float_value": 12345.0 } }
+ // }
+ //
+ // Three slices are computed, one for each unique country in the dataset
+ // where the zip_code is also 12345. For this example, data with zip_code
+ // 12345 and country "US" will be in one slice, zip_code 12345 and country
+ // "Canada" in another slice, and zip_code 12345 and country "Mexico" in
+ // another slice, totaling 3 slices.
+ message SliceConfig {
+ oneof kind {
+ // A unique specific value for a given feature.
+ // Example: `{ "value": { "string_value": "12345" } }`
+ Value value = 1;
+
+ // A range of values for a numerical feature.
+ // Example: `{"range":{"low":10000.0,"high":50000.0}}`
+ // will capture 12345 and 23334 in the slice.
+ Range range = 2;
+
+ // If all_values is set to true, then all possible labels of the keyed
+ // feature will have another slice computed.
+ // Example: `{"all_values":{"value":true}}`
+ google.protobuf.BoolValue all_values = 3;
+ }
+ }
+
+ // A range of values for slice(s).
+ // `low` is inclusive, `high` is exclusive.
+ message Range {
+ // Inclusive low value for the range.
+ float low = 1;
+
+ // Exclusive high value for the range.
+ float high = 2;
+ }
+
+ // Single value that supports strings and floats.
+ message Value {
+ oneof kind {
+ // String type.
+ string string_value = 1;
+
+ // Float type.
+ float float_value = 2;
+ }
+ }
+
+ // Mapping configuration for this SliceSpec.
+ // The key is the name of the feature.
+ // By default, the key will be prefixed by "instance" as a dictionary
+ // prefix for Vertex Batch Predictions output format.
+ map configs = 1;
+ }
+
// Output only. The dimension of the slice.
// Well-known dimensions are:
// * `annotationSpec`: This slice is on the test data that has either
- // ground truth or prediction with [AnnotationSpec.display_name][google.cloud.aiplatform.v1beta1.AnnotationSpec.display_name]
- // equals to [value][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice.value].
+ // ground truth or prediction with
+ // [AnnotationSpec.display_name][google.cloud.aiplatform.v1beta1.AnnotationSpec.display_name]
+ // equals to
+ // [value][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice.value].
+ // * `slice`: This slice is a user customized slice defined by its
+ // SliceSpec.
string dimension = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The value of the dimension in this slice.
string value = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Specification for how the data was sliced.
+ SliceSpec slice_spec = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. The resource name of the ModelEvaluationSlice.
@@ -56,16 +168,27 @@ message ModelEvaluationSlice {
// Output only. The slice of the test data that is used to evaluate the Model.
Slice slice = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Points to a YAML file stored on Google Cloud Storage describing the
- // [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics] of this ModelEvaluationSlice. The
- // schema is defined as an OpenAPI 3.0.2 [Schema
+ // Output only. Points to a YAML file stored on Google Cloud Storage
+ // describing the
+ // [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics] of
+ // this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2
+ // [Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
string metrics_schema_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored
- // in [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri]
+ // Output only. Sliced evaluation metrics of the Model. The schema of the
+ // metrics is stored in
+ // [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri]
google.protobuf.Value metrics = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this ModelEvaluationSlice was created.
- google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Aggregated explanation metrics for the Model's prediction
+ // output over the data this ModelEvaluation uses. This field is populated
+ // only if the Model is evaluated with explanations, and only for tabular
+ // Models.
+ ModelExplanation model_explanation = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_monitoring.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_monitoring.proto
index 955314ecd..73bc3c6b3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_monitoring.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_monitoring.proto
@@ -20,7 +20,7 @@ import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/io.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelMonitoringProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -59,8 +59,8 @@ message ModelMonitoringObjectiveConfig {
oneof data_source {
// The resource name of the Dataset used to train this Model.
string dataset = 3 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Dataset"
- }];
+ type: "aiplatform.googleapis.com/Dataset"
+ }];
// The Google Cloud Storage uri of the unmanaged Dataset used to train
// this Model.
@@ -135,8 +135,10 @@ message ModelMonitoringObjectiveConfig {
// The config for integrating with Vertex Explainable AI. Only applicable if
// the Model has explanation_spec populated.
message ExplanationConfig {
- // Output from [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob] for Model Monitoring baseline dataset,
- // which can be used to generate baseline attribution scores.
+ // Output from
+ // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]
+ // for Model Monitoring baseline dataset, which can be used to generate
+ // baseline attribution scores.
message ExplanationBaseline {
// The storage format of the predictions generated BatchPrediction job.
enum PredictionFormat {
@@ -178,7 +180,8 @@ message ModelMonitoringObjectiveConfig {
TrainingDataset training_dataset = 1;
// The config for skew between training data and prediction data.
- TrainingPredictionSkewDetectionConfig training_prediction_skew_detection_config = 2;
+ TrainingPredictionSkewDetectionConfig
+ training_prediction_skew_detection_config = 2;
// The config for drift of prediction data.
PredictionDriftDetectionConfig prediction_drift_detection_config = 3;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_service.proto
index 9fad50db7..af56ead5a 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/model_service.proto
@@ -20,6 +20,8 @@ import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
+import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
+import "google/cloud/aiplatform/v1beta1/evaluated_annotation.proto";
import "google/cloud/aiplatform/v1beta1/explanation.proto";
import "google/cloud/aiplatform/v1beta1/io.proto";
import "google/cloud/aiplatform/v1beta1/model.proto";
@@ -27,10 +29,11 @@ import "google/cloud/aiplatform/v1beta1/model_evaluation.proto";
import "google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto";
import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ModelServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -40,7 +43,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for managing Vertex AI's machine learning Models.
service ModelService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Uploads a Model artifact into Vertex AI.
rpc UploadModel(UploadModelRequest) returns (google.longrunning.Operation) {
@@ -72,7 +76,8 @@ service ModelService {
}
// Lists versions of the specified model.
- rpc ListModelVersions(ListModelVersionsRequest) returns (ListModelVersionsResponse) {
+ rpc ListModelVersions(ListModelVersionsRequest)
+ returns (ListModelVersionsResponse) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/models/*}:listVersions"
};
@@ -89,7 +94,8 @@ service ModelService {
}
// Incrementally update the dataset used for an examples model.
- rpc UpdateExplanationDataset(UpdateExplanationDatasetRequest) returns (google.longrunning.Operation) {
+ rpc UpdateExplanationDataset(UpdateExplanationDatasetRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{model=projects/*/locations/*/models/*}:updateExplanationDataset"
body: "*"
@@ -103,9 +109,12 @@ service ModelService {
// Deletes a Model.
//
- // A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] resource has a
- // [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] based on the model in its
- // [deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] field.
+ // A model cannot be deleted if any
+ // [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] resource has a
+ // [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] based on the
+ // model in its
+ // [deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models]
+ // field.
rpc DeleteModel(DeleteModelRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/models/*}"
@@ -119,10 +128,13 @@ service ModelService {
// Deletes a Model version.
//
- // Model version can only be deleted if there are no [DeployedModels][]
- // created from it. Deleting the only version in the Model is not allowed. Use
- // [DeleteModel][google.cloud.aiplatform.v1beta1.ModelService.DeleteModel] for deleting the Model instead.
- rpc DeleteModelVersion(DeleteModelVersionRequest) returns (google.longrunning.Operation) {
+ // Model version can only be deleted if there are no
+ // [DeployedModels][google.cloud.aiplatform.v1beta1.DeployedModel] created
+ // from it. Deleting the only version in the Model is not allowed. Use
+ // [DeleteModel][google.cloud.aiplatform.v1beta1.ModelService.DeleteModel] for
+ // deleting the Model instead.
+ rpc DeleteModelVersion(DeleteModelVersionRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/models/*}:deleteVersion"
};
@@ -144,7 +156,8 @@ service ModelService {
// Exports a trained, exportable Model to a location specified by the
// user. A Model is considered to be exportable if it has at least one
- // [supported export format][google.cloud.aiplatform.v1beta1.Model.supported_export_formats].
+ // [supported export
+ // format][google.cloud.aiplatform.v1beta1.Model.supported_export_formats].
rpc ExportModel(ExportModelRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/models/*}:export"
@@ -157,8 +170,27 @@ service ModelService {
};
}
+ // Copies an already existing Vertex AI Model into the specified Location.
+ // The source Model must exist in the same Project.
+ // When copying custom Models, the users themselves are responsible for
+ // [Model.metadata][google.cloud.aiplatform.v1beta1.Model.metadata] content to
+ // be region-agnostic, as well as making sure that any resources (e.g. files)
+ // it depends on remain accessible.
+ rpc CopyModel(CopyModelRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1beta1/{parent=projects/*/locations/*}/models:copy"
+ body: "*"
+ };
+ option (google.api.method_signature) = "parent,source_model";
+ option (google.longrunning.operation_info) = {
+ response_type: "CopyModelResponse"
+ metadata_type: "CopyModelOperationMetadata"
+ };
+ }
+
// Imports an externally generated ModelEvaluation.
- rpc ImportModelEvaluation(ImportModelEvaluationRequest) returns (ModelEvaluation) {
+ rpc ImportModelEvaluation(ImportModelEvaluationRequest)
+ returns (ModelEvaluation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/models/*}/evaluations:import"
body: "*"
@@ -167,7 +199,8 @@ service ModelService {
}
// Imports a list of externally generated ModelEvaluationSlice.
- rpc BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest) returns (BatchImportModelEvaluationSlicesResponse) {
+ rpc BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest)
+ returns (BatchImportModelEvaluationSlicesResponse) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/models/*/evaluations/*}/slices:batchImport"
body: "*"
@@ -175,6 +208,16 @@ service ModelService {
option (google.api.method_signature) = "parent,model_evaluation_slices";
}
+ // Imports a list of externally generated EvaluatedAnnotations.
+ rpc BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest)
+ returns (BatchImportEvaluatedAnnotationsResponse) {
+ option (google.api.http) = {
+ post: "/v1beta1/{parent=projects/*/locations/*/models/*/evaluations/*/slices/*}:batchImport"
+ body: "*"
+ };
+ option (google.api.method_signature) = "parent,evaluated_annotations";
+ }
+
// Gets a ModelEvaluation.
rpc GetModelEvaluation(GetModelEvaluationRequest) returns (ModelEvaluation) {
option (google.api.http) = {
@@ -184,7 +227,8 @@ service ModelService {
}
// Lists ModelEvaluations in a Model.
- rpc ListModelEvaluations(ListModelEvaluationsRequest) returns (ListModelEvaluationsResponse) {
+ rpc ListModelEvaluations(ListModelEvaluationsRequest)
+ returns (ListModelEvaluationsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/models/*}/evaluations"
};
@@ -192,7 +236,8 @@ service ModelService {
}
// Gets a ModelEvaluationSlice.
- rpc GetModelEvaluationSlice(GetModelEvaluationSliceRequest) returns (ModelEvaluationSlice) {
+ rpc GetModelEvaluationSlice(GetModelEvaluationSliceRequest)
+ returns (ModelEvaluationSlice) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/slices/*}"
};
@@ -200,7 +245,8 @@ service ModelService {
}
// Lists ModelEvaluationSlices in a ModelEvaluation.
- rpc ListModelEvaluationSlices(ListModelEvaluationSlicesRequest) returns (ListModelEvaluationSlicesResponse) {
+ rpc ListModelEvaluationSlices(ListModelEvaluationSlicesRequest)
+ returns (ListModelEvaluationSlicesResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/models/*/evaluations/*}/slices"
};
@@ -208,7 +254,8 @@ service ModelService {
}
}
-// Request message for [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel].
+// Request message for
+// [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel].
message UploadModelRequest {
// Required. The resource name of the Location into which to upload the Model.
// Format: `projects/{project}/locations/{location}`
@@ -219,8 +266,8 @@ message UploadModelRequest {
}
];
- // Optional. The resource name of the model into which to upload the version. Only
- // specify this field when uploading a new version.
+ // Optional. The resource name of the model into which to upload the version.
+ // Only specify this field when uploading a new version.
string parent_model = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. The ID to use for the uploaded Model, which will become the final
@@ -243,25 +290,30 @@ message UploadModelRequest {
string service_account = 6 [(google.api.field_behavior) = OPTIONAL];
}
-// Details of [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] operation.
+// Details of
+// [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]
+// operation.
message UploadModelOperationMetadata {
// The common part of the operation metadata.
GenericOperationMetadata generic_metadata = 1;
}
-// Response message of [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] operation.
+// Response message of
+// [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]
+// operation.
message UploadModelResponse {
// The name of the uploaded Model resource.
// Format: `projects/{project}/locations/{location}/models/{model}`
string model = 1 [(google.api.resource_reference) = {
- type: "aiplatform.googleapis.com/Model"
- }];
+ type: "aiplatform.googleapis.com/Model"
+ }];
// Output only. The version ID of the model that is uploaded.
string model_version_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Request message for [ModelService.GetModel][google.cloud.aiplatform.v1beta1.ModelService.GetModel].
+// Request message for
+// [ModelService.GetModel][google.cloud.aiplatform.v1beta1.ModelService.GetModel].
message GetModelRequest {
// Required. The name of the Model resource.
// Format: `projects/{project}/locations/{location}/models/{model}`
@@ -283,7 +335,8 @@ message GetModelRequest {
];
}
-// Request message for [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels].
+// Request message for
+// [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels].
message ListModelsRequest {
// Required. The resource name of the Location to list the Models from.
// Format: `projects/{project}/locations/{location}`
@@ -298,7 +351,8 @@ message ListModelsRequest {
// both snake_case and camelCase are supported.
//
// * `model` supports = and !=. `model` represents the Model ID,
- // i.e. the last segment of the Model's [resource name][google.cloud.aiplatform.v1beta1.Model.name].
+ // i.e. the last segment of the Model's [resource
+ // name][google.cloud.aiplatform.v1beta1.Model.name].
// * `display_name` supports = and !=
// * `labels` supports general map functions that is:
// * `labels.key=value` - key:value equality
@@ -317,25 +371,31 @@ message ListModelsRequest {
// The standard list page token.
// Typically obtained via
- // [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token] of the previous
- // [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels] call.
+ // [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token]
+ // of the previous
+ // [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels]
+// Response message for
+// [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels]
message ListModelsResponse {
// List of Models in the requested page.
repeated Model models = 1;
// A token to retrieve next page of results.
- // Pass to [ListModelsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListModelsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [ModelService.ListModelVersions][google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions].
+// Request message for
+// [ModelService.ListModelVersions][google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions].
message ListModelVersionsRequest {
// Required. The name of the model to list versions for.
string name = 1 [
@@ -350,8 +410,8 @@ message ListModelVersionsRequest {
// The standard list page token.
// Typically obtained via
- // [ListModelVersionsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token] of the previous
- // [ModelService.ListModelversions][] call.
+ // [ListModelVersionsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token]
+ // of the previous [ModelService.ListModelversions][] call.
string page_token = 3;
// An expression for filtering the results of the request. For field names
@@ -369,9 +429,20 @@ message ListModelVersionsRequest {
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
+
+ // A comma-separated list of fields to order by, sorted in ascending order.
+ // Use "desc" after a field name for descending.
+ // Supported fields:
+ //
+ // * `create_time`
+ // * `update_time`
+ //
+ // Example: `update_time asc, create_time desc`.
+ string order_by = 6;
}
-// Response message for [ModelService.ListModelVersions][google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions]
+// Response message for
+// [ModelService.ListModelVersions][google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions]
message ListModelVersionsResponse {
// List of Model versions in the requested page.
// In the returned Model name field, version ID instead of regvision tag will
@@ -379,11 +450,14 @@ message ListModelVersionsResponse {
repeated Model models = 1;
// A token to retrieve the next page of results.
- // Pass to [ListModelVersionsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelVersionsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListModelVersionsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelVersionsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [ModelService.UpdateModel][google.cloud.aiplatform.v1beta1.ModelService.UpdateModel].
+// Request message for
+// [ModelService.UpdateModel][google.cloud.aiplatform.v1beta1.ModelService.UpdateModel].
message UpdateModelRequest {
// Required. The Model which replaces the resource on the server.
// When Model Versioning is enabled, the model.name will be used to determine
@@ -406,8 +480,10 @@ message UpdateModelRequest {
Model model = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource.
- // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask].
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // For the `FieldMask` definition, see
+ // [google.protobuf.FieldMask][google.protobuf.FieldMask].
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request message for
@@ -433,7 +509,8 @@ message UpdateExplanationDatasetOperationMetadata {
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [ModelService.DeleteModel][google.cloud.aiplatform.v1beta1.ModelService.DeleteModel].
+// Request message for
+// [ModelService.DeleteModel][google.cloud.aiplatform.v1beta1.ModelService.DeleteModel].
message DeleteModelRequest {
// Required. The name of the Model resource to be deleted.
// Format: `projects/{project}/locations/{location}/models/{model}`
@@ -445,10 +522,11 @@ message DeleteModelRequest {
];
}
-// Request message for [ModelService.DeleteModelVersion][google.cloud.aiplatform.v1beta1.ModelService.DeleteModelVersion].
+// Request message for
+// [ModelService.DeleteModelVersion][google.cloud.aiplatform.v1beta1.ModelService.DeleteModelVersion].
message DeleteModelVersionRequest {
- // Required. The name of the model version to be deleted, with a version ID explicitly
- // included.
+ // Required. The name of the model version to be deleted, with a version ID
+ // explicitly included.
//
// Example: `projects/{project}/locations/{location}/models/{model}@1234`
string name = 1 [
@@ -459,7 +537,8 @@ message DeleteModelVersionRequest {
];
}
-// Request message for [ModelService.MergeVersionAliases][google.cloud.aiplatform.v1beta1.ModelService.MergeVersionAliases].
+// Request message for
+// [ModelService.MergeVersionAliases][google.cloud.aiplatform.v1beta1.ModelService.MergeVersionAliases].
message MergeVersionAliasesRequest {
// Required. The name of the model version to merge aliases, with a version ID
// explicitly included.
@@ -487,12 +566,14 @@ message MergeVersionAliasesRequest {
repeated string version_aliases = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel].
+// Request message for
+// [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel].
message ExportModelRequest {
// Output configuration for the Model export.
message OutputConfig {
// The ID of the format in which the Model must be exported. Each Model
- // lists the [export formats it supports][google.cloud.aiplatform.v1beta1.Model.supported_export_formats].
+ // lists the [export formats it
+ // supports][google.cloud.aiplatform.v1beta1.Model.supported_export_formats].
// If no value is provided here, then the first from the list of the Model's
// supported formats is used by default.
string export_format_id = 1;
@@ -528,39 +609,112 @@ message ExportModelRequest {
OutputConfig output_config = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Details of [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel] operation.
+// Details of
+// [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel]
+// operation.
message ExportModelOperationMetadata {
// Further describes the output of the ExportModel. Supplements
// [ExportModelRequest.OutputConfig][google.cloud.aiplatform.v1beta1.ExportModelRequest.OutputConfig].
message OutputInfo {
- // Output only. If the Model artifact is being exported to Google Cloud Storage this is
- // the full path of the directory created, into which the Model files are
- // being written to.
+ // Output only. If the Model artifact is being exported to Google Cloud
+ // Storage this is the full path of the directory created, into which the
+ // Model files are being written to.
string artifact_output_uri = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. If the Model image is being exported to Google Container Registry or
- // Artifact Registry this is the full path of the image created.
+ // Output only. If the Model image is being exported to Google Container
+ // Registry or Artifact Registry this is the full path of the image created.
string image_output_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The common part of the operation metadata.
GenericOperationMetadata generic_metadata = 1;
- // Output only. Information further describing the output of this Model export.
+ // Output only. Information further describing the output of this Model
+ // export.
OutputInfo output_info = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Response message of [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1beta1.ModelService.UpdateExplanationDataset] operation.
-message UpdateExplanationDatasetResponse {
+// Response message of
+// [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1beta1.ModelService.UpdateExplanationDataset]
+// operation.
+message UpdateExplanationDatasetResponse {}
+
+// Response message of
+// [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel]
+// operation.
+message ExportModelResponse {}
+
+// Request message for
+// [ModelService.CopyModel][google.cloud.aiplatform.v1beta1.ModelService.CopyModel].
+message CopyModelRequest {
+ // If both fields are unset, a new Model will be created with a generated ID.
+ oneof destination_model {
+ // Optional. Copy source_model into a new Model with this ID. The ID will
+ // become the final component of the model resource name.
+ //
+ // This value may be up to 63 characters, and valid characters are
+ // `[a-z0-9_-]`. The first character cannot be a number or hyphen.
+ string model_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Specify this field to copy source_model into this existing
+ // Model as a new version. Format:
+ // `projects/{project}/locations/{location}/models/{model}`
+ string parent_model = 5 [
+ (google.api.field_behavior) = OPTIONAL,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/Model"
+ }
+ ];
+ }
+
+ // Required. The resource name of the Location into which to copy the Model.
+ // Format: `projects/{project}/locations/{location}`
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "locations.googleapis.com/Location"
+ }
+ ];
+
+ // Required. The resource name of the Model to copy. That Model must be in the
+ // same Project. Format:
+ // `projects/{project}/locations/{location}/models/{model}`
+ string source_model = 2 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/Model"
+ }
+ ];
+
+ // Customer-managed encryption key options. If this is set,
+ // then the Model copy will be encrypted with the provided encryption key.
+ EncryptionSpec encryption_spec = 3;
+}
+// Details of
+// [ModelService.CopyModel][google.cloud.aiplatform.v1beta1.ModelService.CopyModel]
+// operation.
+message CopyModelOperationMetadata {
+ // The common part of the operation metadata.
+ GenericOperationMetadata generic_metadata = 1;
}
-// Response message of [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel] operation.
-message ExportModelResponse {
+// Response message of
+// [ModelService.CopyModel][google.cloud.aiplatform.v1beta1.ModelService.CopyModel]
+// operation.
+message CopyModelResponse {
+ // The name of the copied Model resource.
+ // Format: `projects/{project}/locations/{location}/models/{model}`
+ string model = 1 [(google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/Model"
+ }];
+ // Output only. The version ID of the model that is copied.
+ string model_version_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Request message for [ModelService.ImportModelEvaluation][google.cloud.aiplatform.v1beta1.ModelService.ImportModelEvaluation]
+// Request message for
+// [ModelService.ImportModelEvaluation][google.cloud.aiplatform.v1beta1.ModelService.ImportModelEvaluation]
message ImportModelEvaluationRequest {
// Required. The name of the parent model resource.
// Format: `projects/{project}/locations/{location}/models/{model}`
@@ -575,7 +729,8 @@ message ImportModelEvaluationRequest {
ModelEvaluation model_evaluation = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices]
+// Request message for
+// [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices]
message BatchImportModelEvaluationSlicesRequest {
// Required. The name of the parent ModelEvaluation resource.
// Format:
@@ -588,16 +743,47 @@ message BatchImportModelEvaluationSlicesRequest {
];
// Required. Model evaluation slice resource to be imported.
- repeated ModelEvaluationSlice model_evaluation_slices = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated ModelEvaluationSlice model_evaluation_slices = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices]
+// Response message for
+// [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices]
message BatchImportModelEvaluationSlicesResponse {
- // Output only. List of imported [ModelEvaluationSlice.name][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.name].
- repeated string imported_model_evaluation_slices = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. List of imported
+ // [ModelEvaluationSlice.name][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.name].
+ repeated string imported_model_evaluation_slices = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Request message for [ModelService.GetModelEvaluation][google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluation].
+// Request message for
+// [ModelService.BatchImportEvaluatedAnnotations][google.cloud.aiplatform.v1beta1.ModelService.BatchImportEvaluatedAnnotations]
+message BatchImportEvaluatedAnnotationsRequest {
+ // Required. The name of the parent ModelEvaluationSlice resource.
+ // Format:
+ // `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/ModelEvaluationSlice"
+ }
+ ];
+
+ // Required. Evaluated annotations resource to be imported.
+ repeated EvaluatedAnnotation evaluated_annotations = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response message for
+// [ModelService.BatchImportEvaluatedAnnotations][google.cloud.aiplatform.v1beta1.ModelService.BatchImportEvaluatedAnnotations]
+message BatchImportEvaluatedAnnotationsResponse {
+ // Output only. Number of EvaluatedAnnotations imported.
+ int32 imported_evaluated_annotations_count = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Request message for
+// [ModelService.GetModelEvaluation][google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluation].
message GetModelEvaluationRequest {
// Required. The name of the ModelEvaluation resource.
// Format:
@@ -610,7 +796,8 @@ message GetModelEvaluationRequest {
];
}
-// Request message for [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations].
+// Request message for
+// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations].
message ListModelEvaluationsRequest {
// Required. The resource name of the Model to list the ModelEvaluations from.
// Format: `projects/{project}/locations/{location}/models/{model}`
@@ -629,25 +816,31 @@ message ListModelEvaluationsRequest {
// The standard list page token.
// Typically obtained via
- // [ListModelEvaluationsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token] of the previous
- // [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations] call.
+ // [ListModelEvaluationsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token]
+ // of the previous
+ // [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations].
+// Response message for
+// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations].
message ListModelEvaluationsResponse {
// List of ModelEvaluations in the requested page.
repeated ModelEvaluation model_evaluations = 1;
// A token to retrieve next page of results.
- // Pass to [ListModelEvaluationsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListModelEvaluationsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [ModelService.GetModelEvaluationSlice][google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluationSlice].
+// Request message for
+// [ModelService.GetModelEvaluationSlice][google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluationSlice].
message GetModelEvaluationSliceRequest {
// Required. The name of the ModelEvaluationSlice resource.
// Format:
@@ -660,10 +853,11 @@ message GetModelEvaluationSliceRequest {
];
}
-// Request message for [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices].
+// Request message for
+// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices].
message ListModelEvaluationSlicesRequest {
- // Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices
- // from. Format:
+ // Required. The resource name of the ModelEvaluation to list the
+ // ModelEvaluationSlices from. Format:
// `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -682,21 +876,25 @@ message ListModelEvaluationSlicesRequest {
// The standard list page token.
// Typically obtained via
- // [ListModelEvaluationSlicesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token] of the previous
- // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices] call.
+ // [ListModelEvaluationSlicesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token]
+ // of the previous
+ // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices].
+// Response message for
+// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices].
message ListModelEvaluationSlicesResponse {
// List of ModelEvaluations in the requested page.
repeated ModelEvaluationSlice model_evaluation_slices = 1;
// A token to retrieve next page of results.
- // Pass to [ListModelEvaluationSlicesRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesRequest.page_token] to obtain that
- // page.
+ // Pass to
+ // [ListModelEvaluationSlicesRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/nas_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/nas_job.proto
new file mode 100644
index 000000000..39f468cc1
--- /dev/null
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/nas_job.proto
@@ -0,0 +1,306 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.aiplatform.v1beta1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/aiplatform/v1beta1/custom_job.proto";
+import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
+import "google/cloud/aiplatform/v1beta1/job_state.proto";
+import "google/cloud/aiplatform/v1beta1/study.proto";
+import "google/protobuf/timestamp.proto";
+import "google/rpc/status.proto";
+
+option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
+option java_multiple_files = true;
+option java_outer_classname = "NasJobProto";
+option java_package = "com.google.cloud.aiplatform.v1beta1";
+option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
+option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
+
+// Represents a Neural Architecture Search (NAS) job.
+message NasJob {
+ option (google.api.resource) = {
+ type: "aiplatform.googleapis.com/NasJob"
+ pattern: "projects/{project}/locations/{location}/nasJobs/{nas_job}"
+ };
+
+ // Output only. Resource name of the NasJob.
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The display name of the NasJob.
+ // The name can be up to 128 characters long and can consist of any UTF-8
+ // characters.
+ string display_name = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The specification of a NasJob.
+ NasJobSpec nas_job_spec = 4 [(google.api.field_behavior) = REQUIRED];
+
+ // Output only. Output of the NasJob.
+ NasJobOutput nas_job_output = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The detailed state of the job.
+ JobState state = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasJob was created.
+ google.protobuf.Timestamp create_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasJob for the first time entered the
+ // `JOB_STATE_RUNNING` state.
+ google.protobuf.Timestamp start_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasJob entered any of the following states:
+ // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
+ google.protobuf.Timestamp end_time = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasJob was most recently updated.
+ google.protobuf.Timestamp update_time = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Only populated when job's state is JOB_STATE_FAILED or
+ // JOB_STATE_CANCELLED.
+ google.rpc.Status error = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The labels with user-defined metadata to organize NasJobs.
+ //
+ // Label keys and values can be no longer than 64 characters
+ // (Unicode codepoints), can only contain lowercase letters, numeric
+ // characters, underscores and dashes. International characters are allowed.
+ //
+ // See https://goo.gl/xmQnxf for more information and examples of labels.
+ map labels = 12;
+
+ // Customer-managed encryption key options for a NasJob.
+ // If this is set, then all resources created by the NasJob
+ // will be encrypted with the provided encryption key.
+ EncryptionSpec encryption_spec = 13;
+
+ // Optional. Enable a separation of Custom model training
+ // and restricted image training for tenant project.
+ bool enable_restricted_image_training = 14
+ [deprecated = true, (google.api.field_behavior) = OPTIONAL];
+}
+
+// Represents a NasTrial details along with it's parameters. If there is a
+// corresponding train NasTrial, the train NasTrial is also returned.
+message NasTrialDetail {
+ option (google.api.resource) = {
+ type: "aiplatform.googleapis.com/NasTrialDetail"
+ pattern: "projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}"
+ };
+
+ // Output only. Resource name of the NasTrialDetail.
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The parameters for the NasJob NasTrial.
+ string parameters = 2;
+
+ // The requested search NasTrial.
+ NasTrial search_trial = 3;
+
+ // The train NasTrial corresponding to
+ // [search_trial][google.cloud.aiplatform.v1beta1.NasTrialDetail.search_trial].
+ // Only populated if
+ // [search_trial][google.cloud.aiplatform.v1beta1.NasTrialDetail.search_trial]
+ // is used for training.
+ NasTrial train_trial = 4;
+}
+
+// Represents the spec of a NasJob.
+message NasJobSpec {
+ // The spec of multi-trial Neural Architecture Search (NAS).
+ message MultiTrialAlgorithmSpec {
+ // Represents a metric to optimize.
+ message MetricSpec {
+ // The available types of optimization goals.
+ enum GoalType {
+ // Goal Type will default to maximize.
+ GOAL_TYPE_UNSPECIFIED = 0;
+
+ // Maximize the goal metric.
+ MAXIMIZE = 1;
+
+ // Minimize the goal metric.
+ MINIMIZE = 2;
+ }
+
+ // Required. The ID of the metric. Must not contain whitespaces.
+ string metric_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The optimization goal of the metric.
+ GoalType goal = 2 [(google.api.field_behavior) = REQUIRED];
+ }
+
+ // Represent spec for search trials.
+ message SearchTrialSpec {
+ // Required. The spec of a search trial job. The same spec applies to
+ // all search trials.
+ CustomJobSpec search_trial_job_spec = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The maximum number of Neural Architecture Search (NAS) trials
+ // to run.
+ int32 max_trial_count = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The maximum number of trials to run in parallel.
+ int32 max_parallel_trial_count = 3
+ [(google.api.field_behavior) = REQUIRED];
+
+ // The number of failed trials that need to be seen before failing
+ // the NasJob.
+ //
+ // If set to 0, Vertex AI decides how many trials must fail
+ // before the whole job fails.
+ int32 max_failed_trial_count = 4;
+ }
+
+ // Represent spec for train trials.
+ message TrainTrialSpec {
+ // Required. The spec of a train trial job. The same spec applies to
+ // all train trials.
+ CustomJobSpec train_trial_job_spec = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The maximum number of trials to run in parallel.
+ int32 max_parallel_trial_count = 2
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Frequency of search trials to start train stage. Top N
+ // [TrainTrialSpec.max_parallel_trial_count]
+ // search trials will be trained for every M
+ // [TrainTrialSpec.frequency] trials searched.
+ int32 frequency = 3 [(google.api.field_behavior) = REQUIRED];
+ }
+
+ // The available types of multi-trial algorithms.
+ enum MultiTrialAlgorithm {
+ // Defaults to `REINFORCEMENT_LEARNING`.
+ MULTI_TRIAL_ALGORITHM_UNSPECIFIED = 0;
+
+ // The Reinforcement Learning Algorithm for Multi-trial Neural
+ // Architecture Search (NAS).
+ REINFORCEMENT_LEARNING = 1;
+
+ // The Grid Search Algorithm for Multi-trial Neural
+ // Architecture Search (NAS).
+ GRID_SEARCH = 2;
+ }
+
+ // The multi-trial Neural Architecture Search (NAS) algorithm
+ // type. Defaults to `REINFORCEMENT_LEARNING`.
+ MultiTrialAlgorithm multi_trial_algorithm = 1;
+
+ // Metric specs for the NAS job.
+ // Validation for this field is done at `multi_trial_algorithm_spec` field.
+ MetricSpec metric = 2;
+
+ // Required. Spec for search trials.
+ SearchTrialSpec search_trial_spec = 3
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Spec for train trials. Top N [TrainTrialSpec.max_parallel_trial_count]
+ // search trials will be trained for every M
+ // [TrainTrialSpec.frequency] trials searched.
+ TrainTrialSpec train_trial_spec = 4;
+ }
+
+ // The Neural Architecture Search (NAS) algorithm specification.
+ oneof nas_algorithm_spec {
+ // The spec of multi-trial algorithms.
+ MultiTrialAlgorithmSpec multi_trial_algorithm_spec = 2;
+ }
+
+ // The ID of the existing NasJob in the same Project and Location
+ // which will be used to resume search. search_space_spec and
+ // nas_algorithm_spec are obtained from previous NasJob hence should not
+ // provide them again for this NasJob.
+ string resume_nas_job_id = 3;
+
+ // It defines the search space for Neural Architecture Search (NAS).
+ string search_space_spec = 1;
+}
+
+// Represents a uCAIP NasJob output.
+message NasJobOutput {
+ // The output of a multi-trial Neural Architecture Search (NAS) jobs.
+ message MultiTrialJobOutput {
+ // Output only. List of NasTrials that were started as part of search stage.
+ repeated NasTrial search_trials = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. List of NasTrials that were started as part of train stage.
+ repeated NasTrial train_trials = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The output of this Neural Architecture Search (NAS) job.
+ oneof output {
+ // Output only. The output of this multi-trial Neural Architecture Search
+ // (NAS) job.
+ MultiTrialJobOutput multi_trial_job_output = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+}
+
+// Represents a uCAIP NasJob trial.
+message NasTrial {
+ // Describes a NasTrial state.
+ enum State {
+ // The NasTrial state is unspecified.
+ STATE_UNSPECIFIED = 0;
+
+ // Indicates that a specific NasTrial has been requested, but it has not yet
+ // been suggested by the service.
+ REQUESTED = 1;
+
+ // Indicates that the NasTrial has been suggested.
+ ACTIVE = 2;
+
+ // Indicates that the NasTrial should stop according to the service.
+ STOPPING = 3;
+
+ // Indicates that the NasTrial is completed successfully.
+ SUCCEEDED = 4;
+
+ // Indicates that the NasTrial should not be attempted again.
+ // The service will set a NasTrial to INFEASIBLE when it's done but missing
+ // the final_measurement.
+ INFEASIBLE = 5;
+ }
+
+ // Output only. The identifier of the NasTrial assigned by the service.
+ string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The detailed state of the NasTrial.
+ State state = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The final measurement containing the objective value.
+ Measurement final_measurement = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasTrial was started.
+ google.protobuf.Timestamp start_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Time when the NasTrial's status changed to `SUCCEEDED` or
+ // `INFEASIBLE`.
+ google.protobuf.Timestamp end_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/operation.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/operation.proto
index 4a6d0edf2..b7ea2af4b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/operation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/operation.proto
@@ -21,7 +21,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "OperationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -34,15 +34,18 @@ message GenericOperationMetadata {
// E.g. single files that couldn't be read.
// This field should never exceed 20 entries.
// Status details field will contain standard Google Cloud error details.
- repeated google.rpc.Status partial_failures = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated google.rpc.Status partial_failures = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the operation was created.
- google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the operation was updated for the last time.
// If the operation has finished (successfully or not), this is the finish
// time.
- google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Details of operations that perform deletes of any entities.
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_failure_policy.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_failure_policy.proto
index f197f510f..8d4ecef39 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_failure_policy.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_failure_policy.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1beta1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "PipelineFailurePolicyProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_job.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_job.proto
index 8ecf60844..88d66b176 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_job.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_job.proto
@@ -30,7 +30,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "Pipeline";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -62,16 +62,18 @@ message PipelineJob {
}
}
- // Deprecated. Use [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.parameter_values] instead. The runtime
- // parameters of the PipelineJob. The parameters will be passed into
- // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec] to replace the placeholders at runtime.
- // This field is used by pipelines built using
- // `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as
- // pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
+ // Deprecated. Use
+ // [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.parameter_values]
+ // instead. The runtime parameters of the PipelineJob. The parameters will
+ // be passed into
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec]
+ // to replace the placeholders at runtime. This field is used by pipelines
+ // built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
+ // such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
map parameters = 1 [deprecated = true];
- // Required. A path in a Cloud Storage bucket, which will be treated as the root
- // output directory of the pipeline. It is used by the system to
+ // Required. A path in a Cloud Storage bucket, which will be treated as the
+ // root output directory of the pipeline. It is used by the system to
// generate the paths of output artifacts. The artifact paths are generated
// with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
// specified output directory. The service account specified in this
@@ -80,10 +82,12 @@ message PipelineJob {
string gcs_output_directory = 2 [(google.api.field_behavior) = REQUIRED];
// The runtime parameters of the PipelineJob. The parameters will be
- // passed into [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec] to replace the placeholders
- // at runtime. This field is used by pipelines built using
- // `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built
- // using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
+ // passed into
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec]
+ // to replace the placeholders at runtime. This field is used by pipelines
+ // built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
+ // pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
+ // DSL.
map parameter_values = 3;
// Represents the failure policy of a pipeline. Currently, the default of a
@@ -108,16 +112,20 @@ message PipelineJob {
string display_name = 2;
// Output only. Pipeline creation time.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Pipeline start time.
- google.protobuf.Timestamp start_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Pipeline end time.
- google.protobuf.Timestamp end_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this PipelineJob was most recently updated.
- google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The spec of the pipeline.
google.protobuf.Struct pipeline_spec = 7;
@@ -172,27 +180,32 @@ message PipelineJob {
// resources being launched, if applied, such as Vertex AI
// Training or Dataflow job. If left unspecified, the workload is not peered
// with any network.
- string network = 18 [(google.api.resource_reference) = {
- type: "compute.googleapis.com/Network"
- }];
+ string network = 18 [
+ (google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
+ ];
- // A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], if empty, will
- // be downloaded.
+ // A template uri from where the
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec],
+ // if empty, will be downloaded.
string template_uri = 19;
// Output only. Pipeline template metadata. Will fill up fields if
- // [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported template registry.
- PipelineTemplateMetadata template_metadata = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri]
+ // is from supported template registry.
+ PipelineTemplateMetadata template_metadata = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Pipeline template metadata if [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported
-// template registry. Currently, the only supported registry is Artifact
-// Registry.
+// Pipeline template metadata if
+// [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri]
+// is from supported template registry. Currently, the only supported registry
+// is Artifact Registry.
message PipelineTemplateMetadata {
// The version_name in artifact registry.
//
- // Will always be presented in output if the [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is
- // from supported template registry.
+ // Will always be presented in output if the
+ // [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri]
+ // is from supported template registry.
//
// Format is "sha256:abcdef123456...".
string version = 3;
@@ -207,7 +220,8 @@ message PipelineJobDetail {
Context pipeline_run_context = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The runtime details of the tasks under the pipeline.
- repeated PipelineTaskDetail task_details = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated PipelineTaskDetail task_details = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The runtime detail of a task execution.
@@ -215,17 +229,17 @@ message PipelineTaskDetail {
// A single record of the task status.
message PipelineTaskStatus {
// Output only. Update time of this status.
- google.protobuf.Timestamp update_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The state of the task.
State state = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The error that occurred during the state. May be set when the state is
- // any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state.
- // If the state is FAILED, the error here is final and not going to be
- // retried.
- // If the state is a non-final state, the error indicates a system-error
- // being retried.
+ // Output only. The error that occurred during the state. May be set when
+ // the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or
+ // FAILED state. If the state is FAILED, the error here is final and not
+ // going to be retried. If the state is a non-final state, the error
+ // indicates a system-error being retried.
google.rpc.Status error = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -266,15 +280,16 @@ message PipelineTaskDetail {
// Specifies that the task was not triggered because the task's trigger
// policy is not satisfied. The trigger policy is specified in the
- // `condition` field of [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec].
+ // `condition` field of
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec].
NOT_TRIGGERED = 9;
}
// Output only. The system generated ID of the task.
int64 task_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The id of the parent task if the task is within a component scope.
- // Empty if the task is at the root level.
+ // Output only. The id of the parent task if the task is within a component
+ // scope. Empty if the task is at the root level.
int64 parent_task_id = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The user specified name of the task that is defined in
@@ -282,16 +297,20 @@ message PipelineTaskDetail {
string task_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Task create time.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Task start time.
- google.protobuf.Timestamp start_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Task end time.
- google.protobuf.Timestamp end_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The detailed execution info.
- PipelineTaskExecutorDetail executor_detail = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ PipelineTaskExecutorDetail executor_detail = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. State of the task.
State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -303,15 +322,18 @@ message PipelineTaskDetail {
// Only populated when the task's state is FAILED or CANCELLED.
google.rpc.Status error = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A list of task status. This field keeps a record of task status evolving
- // over time.
- repeated PipelineTaskStatus pipeline_task_status = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. A list of task status. This field keeps a record of task
+ // status evolving over time.
+ repeated PipelineTaskStatus pipeline_task_status = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The runtime input artifacts of the task.
- map inputs = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ map inputs = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The runtime output artifacts of the task.
- map outputs = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ map outputs = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The runtime detail of a pipeline executor.
@@ -319,7 +341,9 @@ message PipelineTaskExecutorDetail {
// The detail of a container execution. It contains the job names of the
// lifecycle of a container execution.
message ContainerDetail {
- // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the main container execution.
+ // Output only. The name of the
+ // [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the main
+ // container execution.
string main_job = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -327,10 +351,11 @@ message PipelineTaskExecutorDetail {
}
];
- // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the pre-caching-check container
- // execution. This job will be available if the
- // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec] specifies the `pre_caching_check` hook in
- // the lifecycle events.
+ // Output only. The name of the
+ // [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the
+ // pre-caching-check container execution. This job will be available if the
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec]
+ // specifies the `pre_caching_check` hook in the lifecycle events.
string pre_caching_check_job = 2 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -338,39 +363,47 @@ message PipelineTaskExecutorDetail {
}
];
- // Output only. The names of the previously failed [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the main container
- // executions. The list includes the all attempts in chronological order.
- repeated string failed_main_jobs = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The names of the previously failed
+ // [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the main
+ // container executions. The list includes the all attempts in chronological
+ // order.
+ repeated string failed_main_jobs = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The names of the previously failed [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the
+ // Output only. The names of the previously failed
+ // [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the
// pre-caching-check container executions. This job will be available if the
- // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec] specifies the `pre_caching_check` hook in
- // the lifecycle events.
- // The list includes the all attempts in chronological order.
- repeated string failed_pre_caching_check_jobs = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec]
+ // specifies the `pre_caching_check` hook in the lifecycle events. The list
+ // includes the all attempts in chronological order.
+ repeated string failed_pre_caching_check_jobs = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The detailed info for a custom job executor.
message CustomJobDetail {
- option deprecated = true;
-
- // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob].
+ // Output only. The name of the
+ // [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob].
string job = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/CustomJob"
}
];
+
+ // Output only. The names of the previously failed
+ // [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob]. The list includes
+ // the all attempts in chronological order.
+ repeated string failed_jobs = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
oneof details {
// Output only. The detailed info for a container executor.
- ContainerDetail container_detail = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ ContainerDetail container_detail = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The detailed info for a custom job executor.
- CustomJobDetail custom_job_detail = 2 [
- deprecated = true,
- (google.api.field_behavior) = OUTPUT_ONLY
- ];
+ CustomJobDetail custom_job_detail = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_service.proto
index 8126d7b88..e0e4d9ee4 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_service.proto
@@ -20,6 +20,7 @@ import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
+import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/cloud/aiplatform/v1beta1/pipeline_job.proto";
import "google/cloud/aiplatform/v1beta1/training_pipeline.proto";
import "google/longrunning/operations.proto";
@@ -27,7 +28,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "PipelineServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -39,11 +40,13 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// `PipelineJob` resources (used for Vertex AI Pipelines).
service PipelineService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a TrainingPipeline. A created TrainingPipeline right away will be
// attempted to be run.
- rpc CreateTrainingPipeline(CreateTrainingPipelineRequest) returns (TrainingPipeline) {
+ rpc CreateTrainingPipeline(CreateTrainingPipelineRequest)
+ returns (TrainingPipeline) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/trainingPipelines"
body: "training_pipeline"
@@ -52,7 +55,8 @@ service PipelineService {
}
// Gets a TrainingPipeline.
- rpc GetTrainingPipeline(GetTrainingPipelineRequest) returns (TrainingPipeline) {
+ rpc GetTrainingPipeline(GetTrainingPipelineRequest)
+ returns (TrainingPipeline) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/trainingPipelines/*}"
};
@@ -60,7 +64,8 @@ service PipelineService {
}
// Lists TrainingPipelines in a Location.
- rpc ListTrainingPipelines(ListTrainingPipelinesRequest) returns (ListTrainingPipelinesResponse) {
+ rpc ListTrainingPipelines(ListTrainingPipelinesRequest)
+ returns (ListTrainingPipelinesResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/trainingPipelines"
};
@@ -68,7 +73,8 @@ service PipelineService {
}
// Deletes a TrainingPipeline.
- rpc DeleteTrainingPipeline(DeleteTrainingPipelineRequest) returns (google.longrunning.Operation) {
+ rpc DeleteTrainingPipeline(DeleteTrainingPipelineRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/trainingPipelines/*}"
};
@@ -82,14 +88,19 @@ service PipelineService {
// Cancels a TrainingPipeline.
// Starts asynchronous cancellation on the TrainingPipeline. The server
// makes a best effort to cancel the pipeline, but success is not
- // guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline] or
- // other methods to check whether the cancellation succeeded or whether the
+ // guaranteed. Clients can use
+ // [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline]
+ // or other methods to check whether the cancellation succeeded or whether the
// pipeline completed despite cancellation. On successful cancellation,
// the TrainingPipeline is not deleted; instead it becomes a pipeline with
- // a [TrainingPipeline.error][google.cloud.aiplatform.v1beta1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
- // corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1beta1.TrainingPipeline.state] is set to
- // `CANCELLED`.
- rpc CancelTrainingPipeline(CancelTrainingPipelineRequest) returns (google.protobuf.Empty) {
+ // a
+ // [TrainingPipeline.error][google.cloud.aiplatform.v1beta1.TrainingPipeline.error]
+ // value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
+ // corresponding to `Code.CANCELLED`, and
+ // [TrainingPipeline.state][google.cloud.aiplatform.v1beta1.TrainingPipeline.state]
+ // is set to `CANCELLED`.
+ rpc CancelTrainingPipeline(CancelTrainingPipelineRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/trainingPipelines/*}:cancel"
body: "*"
@@ -103,7 +114,8 @@ service PipelineService {
post: "/v1beta1/{parent=projects/*/locations/*}/pipelineJobs"
body: "pipeline_job"
};
- option (google.api.method_signature) = "parent,pipeline_job,pipeline_job_id";
+ option (google.api.method_signature) =
+ "parent,pipeline_job,pipeline_job_id";
}
// Gets a PipelineJob.
@@ -115,7 +127,8 @@ service PipelineService {
}
// Lists PipelineJobs in a Location.
- rpc ListPipelineJobs(ListPipelineJobsRequest) returns (ListPipelineJobsResponse) {
+ rpc ListPipelineJobs(ListPipelineJobsRequest)
+ returns (ListPipelineJobsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/pipelineJobs"
};
@@ -123,7 +136,8 @@ service PipelineService {
}
// Deletes a PipelineJob.
- rpc DeletePipelineJob(DeletePipelineJobRequest) returns (google.longrunning.Operation) {
+ rpc DeletePipelineJob(DeletePipelineJobRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}"
};
@@ -137,14 +151,18 @@ service PipelineService {
// Cancels a PipelineJob.
// Starts asynchronous cancellation on the PipelineJob. The server
// makes a best effort to cancel the pipeline, but success is not
- // guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob] or
- // other methods to check whether the cancellation succeeded or whether the
+ // guaranteed. Clients can use
+ // [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob]
+ // or other methods to check whether the cancellation succeeded or whether the
// pipeline completed despite cancellation. On successful cancellation,
// the PipelineJob is not deleted; instead it becomes a pipeline with
- // a [PipelineJob.error][google.cloud.aiplatform.v1beta1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
- // corresponding to `Code.CANCELLED`, and [PipelineJob.state][google.cloud.aiplatform.v1beta1.PipelineJob.state] is set to
- // `CANCELLED`.
- rpc CancelPipelineJob(CancelPipelineJobRequest) returns (google.protobuf.Empty) {
+ // a [PipelineJob.error][google.cloud.aiplatform.v1beta1.PipelineJob.error]
+ // value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
+ // corresponding to `Code.CANCELLED`, and
+ // [PipelineJob.state][google.cloud.aiplatform.v1beta1.PipelineJob.state] is
+ // set to `CANCELLED`.
+ rpc CancelPipelineJob(CancelPipelineJobRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}:cancel"
body: "*"
@@ -153,10 +171,11 @@ service PipelineService {
}
}
-// Request message for [PipelineService.CreateTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.CreateTrainingPipeline].
+// Request message for
+// [PipelineService.CreateTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.CreateTrainingPipeline].
message CreateTrainingPipelineRequest {
- // Required. The resource name of the Location to create the TrainingPipeline in.
- // Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location to create the TrainingPipeline
+ // in. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -165,10 +184,12 @@ message CreateTrainingPipelineRequest {
];
// Required. The TrainingPipeline to create.
- TrainingPipeline training_pipeline = 2 [(google.api.field_behavior) = REQUIRED];
+ TrainingPipeline training_pipeline = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline].
+// Request message for
+// [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline].
message GetTrainingPipelineRequest {
// Required. The name of the TrainingPipeline resource.
// Format:
@@ -181,10 +202,11 @@ message GetTrainingPipelineRequest {
];
}
-// Request message for [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines].
+// Request message for
+// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines].
message ListTrainingPipelinesRequest {
- // Required. The resource name of the Location to list the TrainingPipelines from.
- // Format: `projects/{project}/locations/{location}`
+ // Required. The resource name of the Location to list the TrainingPipelines
+ // from. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -219,25 +241,31 @@ message ListTrainingPipelinesRequest {
// The standard list page token.
// Typically obtained via
- // [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token] of the previous
- // [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines] call.
+ // [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token]
+ // of the previous
+ // [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines]
+ // call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
-// Response message for [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines]
+// Response message for
+// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines]
message ListTrainingPipelinesResponse {
// List of TrainingPipelines in the requested page.
repeated TrainingPipeline training_pipelines = 1;
// A token to retrieve the next page of results.
- // Pass to [ListTrainingPipelinesRequest.page_token][google.cloud.aiplatform.v1beta1.ListTrainingPipelinesRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListTrainingPipelinesRequest.page_token][google.cloud.aiplatform.v1beta1.ListTrainingPipelinesRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [PipelineService.DeleteTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.DeleteTrainingPipeline].
+// Request message for
+// [PipelineService.DeleteTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.DeleteTrainingPipeline].
message DeleteTrainingPipelineRequest {
// Required. The name of the TrainingPipeline resource to be deleted.
// Format:
@@ -250,7 +278,8 @@ message DeleteTrainingPipelineRequest {
];
}
-// Request message for [PipelineService.CancelTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.CancelTrainingPipeline].
+// Request message for
+// [PipelineService.CancelTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.CancelTrainingPipeline].
message CancelTrainingPipelineRequest {
// Required. The name of the TrainingPipeline to cancel.
// Format:
@@ -263,7 +292,8 @@ message CancelTrainingPipelineRequest {
];
}
-// Request message for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob].
+// Request message for
+// [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob].
message CreatePipelineJobRequest {
// Required. The resource name of the Location to create the PipelineJob in.
// Format: `projects/{project}/locations/{location}`
@@ -286,7 +316,8 @@ message CreatePipelineJobRequest {
string pipeline_job_id = 3;
}
-// Request message for [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob].
+// Request message for
+// [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob].
message GetPipelineJobRequest {
// Required. The name of the PipelineJob resource.
// Format:
@@ -299,7 +330,8 @@ message GetPipelineJobRequest {
];
}
-// Request message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs].
+// Request message for
+// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs].
message ListPipelineJobsRequest {
// Required. The resource name of the Location to list the PipelineJobs from.
// Format: `projects/{project}/locations/{location}`
@@ -351,8 +383,10 @@ message ListPipelineJobsRequest {
// The standard list page token.
// Typically obtained via
- // [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token] of the previous
- // [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs] call.
+ // [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token]
+ // of the previous
+ // [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs]
+ // call.
string page_token = 4;
// A comma-separated list of fields to order by. The default sort order is in
@@ -374,17 +408,21 @@ message ListPipelineJobsRequest {
google.protobuf.FieldMask read_mask = 7;
}
-// Response message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs]
+// Response message for
+// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs]
message ListPipelineJobsResponse {
// List of PipelineJobs in the requested page.
repeated PipelineJob pipeline_jobs = 1;
// A token to retrieve the next page of results.
- // Pass to [ListPipelineJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsRequest.page_token] to obtain that page.
+ // Pass to
+ // [ListPipelineJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsRequest.page_token]
+ // to obtain that page.
string next_page_token = 2;
}
-// Request message for [PipelineService.DeletePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.DeletePipelineJob].
+// Request message for
+// [PipelineService.DeletePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.DeletePipelineJob].
message DeletePipelineJobRequest {
// Required. The name of the PipelineJob resource to be deleted.
// Format:
@@ -397,7 +435,8 @@ message DeletePipelineJobRequest {
];
}
-// Request message for [PipelineService.CancelPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CancelPipelineJob].
+// Request message for
+// [PipelineService.CancelPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CancelPipelineJob].
message CancelPipelineJobRequest {
// Required. The name of the PipelineJob to cancel.
// Format:
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_state.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_state.proto
index 41f2fb6ae..1d4356bb4 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_state.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/pipeline_state.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1beta1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "PipelineStateProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/prediction_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/prediction_service.proto
index e24524205..1171de23f 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/prediction_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/prediction_service.proto
@@ -25,7 +25,7 @@ import "google/cloud/aiplatform/v1beta1/explanation.proto";
import "google/protobuf/struct.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "PredictionServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -35,7 +35,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for online predictions and explanations.
service PredictionService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Perform an online prediction.
rpc Predict(PredictRequest) returns (PredictResponse) {
@@ -50,11 +51,13 @@ service PredictionService {
//
// The response includes the following HTTP headers:
//
- // * `X-Vertex-AI-Endpoint-Id`: ID of the [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] that served this
+ // * `X-Vertex-AI-Endpoint-Id`: ID of the
+ // [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] that served this
// prediction.
//
- // * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel]
- // that served this prediction.
+ // * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's
+ // [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] that served
+ // this prediction.
rpc RawPredict(RawPredictRequest) returns (google.api.HttpBody) {
option (google.api.http) = {
post: "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:rawPredict"
@@ -65,10 +68,12 @@ service PredictionService {
// Perform an online explanation.
//
- // If [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id] is specified,
- // the corresponding DeployModel must have
+ // If
+ // [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id]
+ // is specified, the corresponding DeployModel must have
// [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
- // populated. If [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id]
+ // populated. If
+ // [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id]
// is not specified, all DeployedModels must have
// [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
// populated. Only deployed AutoML tabular Models have
@@ -78,11 +83,13 @@ service PredictionService {
post: "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:explain"
body: "*"
};
- option (google.api.method_signature) = "endpoint,instances,parameters,deployed_model_id";
+ option (google.api.method_signature) =
+ "endpoint,instances,parameters,deployed_model_id";
}
}
-// Request message for [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict].
+// Request message for
+// [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict].
message PredictRequest {
// Required. The name of the Endpoint requested to serve the prediction.
// Format:
@@ -100,23 +107,28 @@ message PredictRequest {
// in case of AutoML Models, or, in case of customer created Models, the
// behaviour is as documented by that Model.
// The schema of any single instance may be specified via Endpoint's
- // DeployedModels' [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model]
+ // DeployedModels'
+ // [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model]
// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
// [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
- repeated google.protobuf.Value instances = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated google.protobuf.Value instances = 2
+ [(google.api.field_behavior) = REQUIRED];
// The parameters that govern the prediction. The schema of the parameters may
- // be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1beta1.DeployedModel.model]
+ // be specified via Endpoint's DeployedModels' [Model's
+ // ][google.cloud.aiplatform.v1beta1.DeployedModel.model]
// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
// [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
google.protobuf.Value parameters = 3;
}
-// Response message for [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict].
+// Response message for
+// [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict].
message PredictResponse {
// The predictions that are the output of the predictions call.
// The schema of any single prediction may be specified via Endpoint's
- // DeployedModels' [Model's ][google.cloud.aiplatform.v1beta1.DeployedModel.model]
+ // DeployedModels' [Model's
+ // ][google.cloud.aiplatform.v1beta1.DeployedModel.model]
// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
// [prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri].
repeated google.protobuf.Value predictions = 1;
@@ -124,8 +136,8 @@ message PredictResponse {
// ID of the Endpoint's DeployedModel that served this prediction.
string deployed_model_id = 2;
- // Output only. The resource name of the Model which is deployed as the DeployedModel that
- // this prediction hits.
+ // Output only. The resource name of the Model which is deployed as the
+ // DeployedModel that this prediction hits.
string model = 3 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
@@ -133,16 +145,18 @@ message PredictResponse {
}
];
- // Output only. The version ID of the Model which is deployed as the DeployedModel that
- // this prediction hits.
+ // Output only. The version ID of the Model which is deployed as the
+ // DeployedModel that this prediction hits.
string model_version_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The [display name][google.cloud.aiplatform.v1beta1.Model.display_name] of the Model which is deployed as
- // the DeployedModel that this prediction hits.
+ // Output only. The [display
+ // name][google.cloud.aiplatform.v1beta1.Model.display_name] of the Model
+ // which is deployed as the DeployedModel that this prediction hits.
string model_display_name = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
-// Request message for [PredictionService.RawPredict][google.cloud.aiplatform.v1beta1.PredictionService.RawPredict].
+// Request message for
+// [PredictionService.RawPredict][google.cloud.aiplatform.v1beta1.PredictionService.RawPredict].
message RawPredictRequest {
// Required. The name of the Endpoint requested to serve the prediction.
// Format:
@@ -156,21 +170,24 @@ message RawPredictRequest {
// The prediction input. Supports HTTP headers and arbitrary data payload.
//
- // A [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] may have an upper limit on the number of instances it
- // supports per request. When this limit it is exceeded for an AutoML model,
- // the [RawPredict][google.cloud.aiplatform.v1beta1.PredictionService.RawPredict] method returns an error.
- // When this limit is exceeded for a custom-trained model, the behavior varies
- // depending on the model.
+ // A [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] may have
+ // an upper limit on the number of instances it supports per request. When
+ // this limit it is exceeded for an AutoML model, the
+ // [RawPredict][google.cloud.aiplatform.v1beta1.PredictionService.RawPredict]
+ // method returns an error. When this limit is exceeded for a custom-trained
+ // model, the behavior varies depending on the model.
//
// You can specify the schema for each instance in the
// [predict_schemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
- // field when you create a [Model][google.cloud.aiplatform.v1beta1.Model]. This schema applies when you deploy the
- // `Model` as a `DeployedModel` to an [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and use the `RawPredict`
- // method.
+ // field when you create a [Model][google.cloud.aiplatform.v1beta1.Model].
+ // This schema applies when you deploy the `Model` as a `DeployedModel` to an
+ // [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and use the
+ // `RawPredict` method.
google.api.HttpBody http_body = 2;
}
-// Request message for [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
+// Request message for
+// [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
message ExplainRequest {
// Required. The name of the Endpoint requested to serve the explanation.
// Format:
@@ -188,21 +205,24 @@ message ExplainRequest {
// in case of AutoML Models, or, in case of customer created Models, the
// behaviour is as documented by that Model.
// The schema of any single instance may be specified via Endpoint's
- // DeployedModels' [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model]
+ // DeployedModels'
+ // [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model]
// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
// [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
- repeated google.protobuf.Value instances = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated google.protobuf.Value instances = 2
+ [(google.api.field_behavior) = REQUIRED];
// The parameters that govern the prediction. The schema of the parameters may
- // be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1beta1.DeployedModel.model]
+ // be specified via Endpoint's DeployedModels' [Model's
+ // ][google.cloud.aiplatform.v1beta1.DeployedModel.model]
// [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
// [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
google.protobuf.Value parameters = 4;
// If specified, overrides the
- // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of the DeployedModel.
- // Can be used for explaining prediction results with different
- // configurations, such as:
+ // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec]
+ // of the DeployedModel. Can be used for explaining prediction results with
+ // different configurations, such as:
// - Explaining top-5 predictions results as opposed to top-1;
// - Increasing path count or step count of the attribution methods to reduce
// approximate errors;
@@ -210,22 +230,27 @@ message ExplainRequest {
ExplanationSpecOverride explanation_spec_override = 5;
// If specified, this ExplainRequest will be served by the chosen
- // DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split].
+ // DeployedModel, overriding
+ // [Endpoint.traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split].
string deployed_model_id = 3;
}
-// Response message for [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
+// Response message for
+// [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
message ExplainResponse {
- // The explanations of the Model's [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
+ // The explanations of the Model's
+ // [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
//
- // It has the same number of elements as [instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances]
- // to be explained.
+ // It has the same number of elements as
+ // [instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] to be
+ // explained.
repeated Explanation explanations = 1;
// ID of the Endpoint's DeployedModel that served this explanation.
string deployed_model_id = 2;
// The predictions that are the output of the predictions call.
- // Same as [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
+ // Same as
+ // [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
repeated google.protobuf.Value predictions = 3;
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/saved_query.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/saved_query.proto
index da02d8a50..d78fd1006 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/saved_query.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/saved_query.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "SavedQueryProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -49,10 +49,12 @@ message SavedQuery {
google.protobuf.Value metadata = 12;
// Output only. Timestamp when this SavedQuery was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when SavedQuery was last updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Filters on the Annotations in the dataset.
string annotation_filter = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -79,7 +81,7 @@ message SavedQuery {
// "overwrite" update happens.
string etag = 8;
- // Output only. If the Annotations belonging to the SavedQuery can be used for AutoML
- // training.
+ // Output only. If the Annotations belonging to the SavedQuery can be used for
+ // AutoML training.
bool support_automl_training = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/BUILD.bazel
index 39b3ec311..c9ba9b556 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/BUILD.bazel
@@ -58,7 +58,7 @@ load(
go_proto_library(
name = "schema_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema",
+ importpath = "cloud.google.com/go/aiplatform/apiv1beta1/schema/schemapb",
protos = [":schema_proto"],
deps = [
"//google/api:annotations_go_proto",
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/annotation_payload.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/annotation_payload.proto
index 249c5ca3c..18950e844 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/annotation_payload.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/annotation_payload.proto
@@ -21,7 +21,7 @@ import "google/cloud/aiplatform/v1beta1/schema/geometry.proto";
import "google/protobuf/duration.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/schemapb;schemapb";
option java_multiple_files = true;
option java_outer_classname = "AnnotationPayloadProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/annotation_spec_color.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/annotation_spec_color.proto
index 5a4b97674..b5ae22ffc 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/annotation_spec_color.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/annotation_spec_color.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1.schema;
import "google/type/color.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/schemapb;schemapb";
option java_multiple_files = true;
option java_outer_classname = "AnnotationSpecColorProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/data_item_payload.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/data_item_payload.proto
index 6f8b3eff8..8911cd607 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/data_item_payload.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/data_item_payload.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1.schema;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/schemapb;schemapb";
option java_multiple_files = true;
option java_outer_classname = "DataItemPayloadProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/dataset_metadata.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/dataset_metadata.proto
index d35bbc33c..730280aee 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/dataset_metadata.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/dataset_metadata.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/schemapb;schemapb";
option java_multiple_files = true;
option java_outer_classname = "DatasetMetadataProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/geometry.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/geometry.proto
index 5dd708e37..f196fe352 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/geometry.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/geometry.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/schemapb;schemapb";
option java_multiple_files = true;
option java_outer_classname = "GeometryProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/io_format.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/io_format.proto
index 50a286e8f..120558d6d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/io_format.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/io_format.proto
@@ -25,7 +25,7 @@ import "google/rpc/code.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/schemapb;schemapb";
option java_multiple_files = true;
option java_outer_classname = "IoFormatProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/BUILD.bazel
index ce6db4d5c..7b47b2176 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/BUILD.bazel
@@ -57,7 +57,7 @@ load(
go_proto_library(
name = "instance_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance",
+ importpath = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/instance/instancepb",
protos = [":instance_proto"],
deps = [
"//google/api:annotations_go_proto",
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_classification.proto
index 7ce0a3442..3a9cd5b3b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "ImageClassificationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_object_detection.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_object_detection.proto
index b92db336c..1edc6cc8e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_object_detection.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_object_detection.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "ImageObjectDetectionPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_segmentation.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_segmentation.proto
index a83b7fbcc..5056881c1 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_segmentation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/image_segmentation.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "ImageSegmentationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_classification.proto
index 99b8deda7..bf773184d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "TextClassificationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_extraction.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_extraction.proto
index 0265e4c03..764eeea7e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_extraction.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_extraction.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "TextExtractionPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_sentiment.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_sentiment.proto
index 17480d0c1..73bf08939 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_sentiment.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/text_sentiment.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "TextSentimentPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_action_recognition.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_action_recognition.proto
index f65c6d2b1..570f0394e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_action_recognition.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_action_recognition.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "VideoActionRecognitionPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_classification.proto
index 9261a2402..52eee2a81 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "VideoClassificationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_object_tracking.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_object_tracking.proto
index 6a420074a..b347e9925 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_object_tracking.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/instance/video_object_tracking.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/instance/instancepb;instancepb";
option java_multiple_files = true;
option java_outer_classname = "VideoObjectTrackingPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/BUILD.bazel
index 1dcc830a2..6981a20b3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/BUILD.bazel
@@ -54,7 +54,7 @@ load(
go_proto_library(
name = "params_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params",
+ importpath = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/params/paramspb",
protos = [":params_proto"],
deps = [
"//google/api:annotations_go_proto",
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_classification.proto
index 088f04952..808219511 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "ImageClassificationPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_object_detection.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_object_detection.proto
index 32861f2b6..637d1569e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_object_detection.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_object_detection.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "ImageObjectDetectionPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_segmentation.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_segmentation.proto
index a49c81364..47d8ddcf2 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_segmentation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/image_segmentation.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "ImageSegmentationPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_action_recognition.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_action_recognition.proto
index 02e8ec9fb..fad0f06ef 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_action_recognition.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_action_recognition.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "VideoActionRecognitionPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_classification.proto
index c93ccb6be..57dc95f67 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "VideoClassificationPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_object_tracking.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_object_tracking.proto
index 25c91dd71..8232278bb 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_object_tracking.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/params/video_object_tracking.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/params/paramspb;paramspb";
option java_multiple_files = true;
option java_outer_classname = "VideoObjectTrackingPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/BUILD.bazel
index 1f8af1aa0..a1e26bc0c 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/BUILD.bazel
@@ -63,7 +63,7 @@ load(
go_proto_library(
name = "prediction_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction",
+ importpath = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb",
protos = [":prediction_proto"],
deps = [
"//google/api:annotations_go_proto",
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/classification.proto
index b7b6d3db1..1bd03d4de 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "ClassificationPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/image_object_detection.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/image_object_detection.proto
index a5489b1bc..3521f7955 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/image_object_detection.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/image_object_detection.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.prediction;
import "google/protobuf/struct.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "ImageObjectDetectionPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/image_segmentation.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/image_segmentation.proto
index 77629ccff..edd3a740b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/image_segmentation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/image_segmentation.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "ImageSegmentationPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/tabular_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/tabular_classification.proto
index 1616dfca5..ffdb99576 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/tabular_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/tabular_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "TabularClassificationPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/tabular_regression.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/tabular_regression.proto
index 0aa04bdda..65fd7cfcc 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/tabular_regression.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/tabular_regression.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "TabularRegressionPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/text_extraction.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/text_extraction.proto
index e7c0cffce..1b42997ee 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/text_extraction.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/text_extraction.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "TextExtractionPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/text_sentiment.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/text_sentiment.proto
index b5b7a1458..23c1b68a9 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/text_sentiment.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/text_sentiment.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "TextSentimentPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/time_series_forecasting.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/time_series_forecasting.proto
index e2db5812d..c9f641e65 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/time_series_forecasting.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/time_series_forecasting.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.predict.prediction;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "TimeSeriesForecastingPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_action_recognition.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_action_recognition.proto
index 86ff341c2..30bfd9963 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_action_recognition.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_action_recognition.proto
@@ -20,7 +20,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "VideoActionRecognitionPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_classification.proto
index 6cff97622..faac51147 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_classification.proto
@@ -20,7 +20,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "VideoClassificationPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_object_tracking.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_object_tracking.proto
index 11e28a9aa..6af9eea3d 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_object_tracking.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/predict/prediction/video_object_tracking.proto
@@ -20,7 +20,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/predict/prediction/predictionpb;predictionpb";
option java_multiple_files = true;
option java_outer_classname = "VideoObjectTrackingPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/BUILD.bazel b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/BUILD.bazel
index e9573e757..5e1b43a8e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/BUILD.bazel
@@ -61,7 +61,7 @@ load(
go_proto_library(
name = "definition_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition",
+ importpath = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb",
protos = [":definition_proto"],
deps = [
"//google/api:annotations_go_proto",
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_classification.proto
index 1b874b03b..1a2c9ede4 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLImageClassificationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_object_detection.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_object_detection.proto
index 938ece400..b80309b50 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_object_detection.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_object_detection.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLImageObjectDetectionProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_segmentation.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_segmentation.proto
index e368e00b6..b4385fbc0 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_segmentation.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_image_segmentation.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLImageSegmentationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_tables.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_tables.proto
index 5488f747f..5930e1699 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_tables.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_tables.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
import "google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/export_evaluated_data_items_config.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLTablesProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_classification.proto
index b57492a5f..61c16c434 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLTextClassificationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_extraction.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_extraction.proto
index a367486a4..f92b0b467 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_extraction.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_extraction.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLTextExtractionProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_sentiment.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_sentiment.proto
index b63162d7c..75563ff2a 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_sentiment.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_text_sentiment.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLTextSentimentProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_time_series_forecasting.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_time_series_forecasting.proto
index 596d0abd5..130a2f0eb 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_time_series_forecasting.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_time_series_forecasting.proto
@@ -19,7 +19,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
import "google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/export_evaluated_data_items_config.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLForecastingProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_action_recognition.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_action_recognition.proto
index ef5284b7d..750ddfa4b 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_action_recognition.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_action_recognition.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLVideoActionRecognitionProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_classification.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_classification.proto
index c6e152291..e69c1ab03 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_classification.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_classification.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLVideoClassificationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_object_tracking.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_object_tracking.proto
index 7d929d203..72132b3e3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_object_tracking.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/automl_video_object_tracking.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMLVideoObjectTrackingProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/export_evaluated_data_items_config.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/export_evaluated_data_items_config.proto
index b88d0c4f1..0fec2c855 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/export_evaluated_data_items_config.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/schema/trainingjob/definition/export_evaluated_data_items_config.proto
@@ -18,7 +18,7 @@ package google.cloud.aiplatform.v1beta1.schema.trainingjob.definition;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.TrainingJob.Definition";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/trainingjob/definition;definition";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/schema/trainingjob/definition/definitionpb;definitionpb";
option java_multiple_files = true;
option java_outer_classname = "ExportEvaluatedDataItemsConfigProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.trainingjob.definition";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/service_networking.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/service_networking.proto
new file mode 100644
index 000000000..3c3052633
--- /dev/null
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/service_networking.proto
@@ -0,0 +1,38 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.aiplatform.v1beta1;
+
+import "google/api/field_behavior.proto";
+
+option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
+option java_multiple_files = true;
+option java_outer_classname = "ServiceNetworkingProto";
+option java_package = "com.google.cloud.aiplatform.v1beta1";
+option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
+option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
+
+// Represents configuration for private service connect.
+message PrivateServiceConnectConfig {
+ // Required. If true, expose the IndexEndpoint via private service connect.
+ bool enable_private_service_connect = 1
+ [(google.api.field_behavior) = REQUIRED];
+
+ // A list of Projects from which the forwarding rule will target the service
+ // attachment.
+ repeated string project_allowlist = 2;
+}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/specialist_pool.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/specialist_pool.proto
index cb35f9da2..1c57376cd 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/specialist_pool.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/specialist_pool.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "SpecialistPoolProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -49,13 +49,15 @@ message SpecialistPool {
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
// Output only. The number of managers in this SpecialistPool.
- int32 specialist_managers_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ int32 specialist_managers_count = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The email addresses of the managers in the SpecialistPool.
repeated string specialist_manager_emails = 4;
// Output only. The resource name of the pending data labeling jobs.
- repeated string pending_data_labeling_jobs = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated string pending_data_labeling_jobs = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The email addresses of workers in the SpecialistPool.
repeated string specialist_worker_emails = 7;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/specialist_pool_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/specialist_pool_service.proto
index a110b9cb8..82a2f8f25 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/specialist_pool_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/specialist_pool_service.proto
@@ -23,10 +23,11 @@ import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/cloud/aiplatform/v1beta1/specialist_pool.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "SpecialistPoolServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -41,10 +42,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// CrowdCompute console.
service SpecialistPoolService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a SpecialistPool.
- rpc CreateSpecialistPool(CreateSpecialistPoolRequest) returns (google.longrunning.Operation) {
+ rpc CreateSpecialistPool(CreateSpecialistPoolRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/specialistPools"
body: "specialist_pool"
@@ -65,7 +68,8 @@ service SpecialistPoolService {
}
// Lists SpecialistPools in a Location.
- rpc ListSpecialistPools(ListSpecialistPoolsRequest) returns (ListSpecialistPoolsResponse) {
+ rpc ListSpecialistPools(ListSpecialistPoolsRequest)
+ returns (ListSpecialistPoolsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/specialistPools"
};
@@ -73,7 +77,8 @@ service SpecialistPoolService {
}
// Deletes a SpecialistPool as well as all Specialists in the pool.
- rpc DeleteSpecialistPool(DeleteSpecialistPoolRequest) returns (google.longrunning.Operation) {
+ rpc DeleteSpecialistPool(DeleteSpecialistPoolRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/specialistPools/*}"
};
@@ -85,7 +90,8 @@ service SpecialistPoolService {
}
// Updates a SpecialistPool.
- rpc UpdateSpecialistPool(UpdateSpecialistPoolRequest) returns (google.longrunning.Operation) {
+ rpc UpdateSpecialistPool(UpdateSpecialistPoolRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1beta1/{specialist_pool.name=projects/*/locations/*/specialistPools/*}"
body: "specialist_pool"
@@ -98,7 +104,8 @@ service SpecialistPoolService {
}
}
-// Request message for [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.CreateSpecialistPool].
+// Request message for
+// [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.CreateSpecialistPool].
message CreateSpecialistPoolRequest {
// Required. The parent Project name for the new SpecialistPool.
// The form is `projects/{project}/locations/{location}`.
@@ -120,7 +127,8 @@ message CreateSpecialistPoolOperationMetadata {
GenericOperationMetadata generic_metadata = 1;
}
-// Request message for [SpecialistPoolService.GetSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.GetSpecialistPool].
+// Request message for
+// [SpecialistPoolService.GetSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.GetSpecialistPool].
message GetSpecialistPoolRequest {
// Required. The name of the SpecialistPool resource.
// The form is
@@ -133,7 +141,8 @@ message GetSpecialistPoolRequest {
];
}
-// Request message for [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools].
+// Request message for
+// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools].
message ListSpecialistPoolsRequest {
// Required. The name of the SpecialistPool's parent resource.
// Format: `projects/{project}/locations/{location}`
@@ -148,16 +157,19 @@ message ListSpecialistPoolsRequest {
int32 page_size = 2;
// The standard list page token.
- // Typically obtained by [ListSpecialistPoolsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token] of
- // the previous [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools] call. Return
- // first page if empty.
+ // Typically obtained by
+ // [ListSpecialistPoolsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token]
+ // of the previous
+ // [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools]
+ // call. Return first page if empty.
string page_token = 3;
// Mask specifying which fields to read. FieldMask represents a set of
google.protobuf.FieldMask read_mask = 4;
}
-// Response message for [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools].
+// Response message for
+// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools].
message ListSpecialistPoolsResponse {
// A list of SpecialistPools that matches the specified filter in the request.
repeated SpecialistPool specialist_pools = 1;
@@ -166,7 +178,8 @@ message ListSpecialistPoolsResponse {
string next_page_token = 2;
}
-// Request message for [SpecialistPoolService.DeleteSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.DeleteSpecialistPool].
+// Request message for
+// [SpecialistPoolService.DeleteSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.DeleteSpecialistPool].
message DeleteSpecialistPoolRequest {
// Required. The resource name of the SpecialistPool to delete. Format:
// `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`
@@ -183,20 +196,22 @@ message DeleteSpecialistPoolRequest {
bool force = 2;
}
-// Request message for [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.UpdateSpecialistPool].
+// Request message for
+// [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.UpdateSpecialistPool].
message UpdateSpecialistPoolRequest {
// Required. The SpecialistPool which replaces the resource on the server.
SpecialistPool specialist_pool = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Runtime operation metadata for
// [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.UpdateSpecialistPool].
message UpdateSpecialistPoolOperationMetadata {
- // Output only. The name of the SpecialistPool to which the specialists are being added.
- // Format:
+ // Output only. The name of the SpecialistPool to which the specialists are
+ // being added. Format:
// `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}`
string specialist_pool = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/study.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/study.proto
index 5ca0eb1a0..03a9cfb72 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/study.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/study.proto
@@ -23,7 +23,7 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "StudyProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -67,7 +67,8 @@ message Study {
State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time at which the study was created.
- google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. A human readable reason why the Study is inactive.
// This should be empty if a study is ACTIVE or COMPLETED.
@@ -86,7 +87,8 @@ message Trial {
// A message representing a parameter to be tuned.
message Parameter {
// Output only. The ID of the parameter. The parameter should be defined in
- // [StudySpec's Parameters][google.cloud.aiplatform.v1beta1.StudySpec.parameters].
+ // [StudySpec's
+ // Parameters][google.cloud.aiplatform.v1beta1.StudySpec.parameters].
string parameter_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The value of the parameter.
@@ -139,17 +141,21 @@ message Trial {
// Output only. A list of measurements that are strictly lexicographically
// ordered by their induced tuples (steps, elapsed_duration).
// These are used for early stopping computations.
- repeated Measurement measurements = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated Measurement measurements = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the Trial was started.
- google.protobuf.Timestamp start_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`.
- google.protobuf.Timestamp end_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Time when the Trial's status changed to `SUCCEEDED` or
+ // `INFEASIBLE`.
+ google.protobuf.Timestamp end_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The identifier of the client that originally requested this Trial.
- // Each client is identified by a unique client_id. When a client
- // asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client
+ // Output only. The identifier of the client that originally requested this
+ // Trial. Each client is identified by a unique client_id. When a client asks
+ // for a suggestion, Vertex AI Vizier will assign it a Trial. The client
// should evaluate the Trial, complete it, and report back to Vertex AI
// Vizier. If suggestion is asked again by same client_id before the Trial is
// completed, the same Trial will be returned. Multiple clients with
@@ -173,9 +179,11 @@ message Trial {
// Output only. URIs for accessing [interactive
// shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
// (one URI for each training node). Only available if this trial is part of
- // a [HyperparameterTuningJob][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob] and the job's
- // [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1beta1.CustomJobSpec.enable_web_access] field
- // is `true`.
+ // a
+ // [HyperparameterTuningJob][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob]
+ // and the job's
+ // [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1beta1.CustomJobSpec.enable_web_access]
+ // field is `true`.
//
// The keys are names of each node used for the trial; for example,
// `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
@@ -183,13 +191,29 @@ message Trial {
// second worker pool.
//
// The values are the URIs for each node's interactive shell.
- map web_access_uris = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ map web_access_uris = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Represents specification of a Study.
message StudySpec {
// Represents a metric to optimize.
message MetricSpec {
+ // Used in safe optimization to specify threshold levels and risk tolerance.
+ message SafetyMetricConfig {
+ // Safety threshold (boundary value between safe and unsafe). NOTE that if
+ // you leave SafetyMetricConfig unset, a default value of 0 will be used.
+ double safety_threshold = 1;
+
+ // Desired minimum fraction of safe trials (over total number of trials)
+ // that should be targeted by the algorithm at any time during the
+ // study (best effort). This should be between 0.0 and 1.0 and a value of
+ // 0.0 means that there is no minimum and an algorithm proceeds without
+ // targeting any specific fraction. A value of 1.0 means that the
+ // algorithm attempts to only Suggest safe Trials.
+ optional double desired_min_safe_trials_fraction = 2;
+ }
+
// The available types of optimization goals.
enum GoalType {
// Goal Type will default to maximize.
@@ -202,12 +226,16 @@ message StudySpec {
MINIMIZE = 2;
}
- // Required. The ID of the metric. Must not contain whitespaces and must be unique
- // amongst all MetricSpecs.
+ // Required. The ID of the metric. Must not contain whitespaces and must be
+ // unique amongst all MetricSpecs.
string metric_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The optimization goal of the metric.
GoalType goal = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Used for safe search. In the case, the metric will be a safety
+ // metric. You must provide a separate metric for objective metric.
+ optional SafetyMetricConfig safety_config = 3;
}
// Represents a single parameter to optimize.
@@ -298,8 +326,8 @@ message StudySpec {
// Represents the spec to match categorical values from parent parameter.
message CategoricalValueCondition {
- // Required. Matches values of the parent parameter of 'CATEGORICAL' type.
- // All values must exist in `categorical_value_spec` of parent
+ // Required. Matches values of the parent parameter of 'CATEGORICAL'
+ // type. All values must exist in `categorical_value_spec` of parent
// parameter.
repeated string values = 1 [(google.api.field_behavior) = REQUIRED];
}
@@ -357,8 +385,8 @@ message StudySpec {
DiscreteValueSpec discrete_value_spec = 5;
}
- // Required. The ID of the parameter. Must not contain whitespaces and must be unique
- // amongst all ParameterSpecs.
+ // Required. The ID of the parameter. Must not contain whitespaces and must
+ // be unique amongst all ParameterSpecs.
string parameter_id = 1 [(google.api.field_behavior) = REQUIRED];
// How the parameter should be scaled.
@@ -379,9 +407,11 @@ message StudySpec {
// Trial. Early stopping is requested for the current Trial if there is very
// low probability to exceed the optimal value found so far.
message DecayCurveAutomatedStoppingSpec {
- // True if [Measurement.elapsed_duration][google.cloud.aiplatform.v1beta1.Measurement.elapsed_duration] is used as the x-axis of each
- // Trials Decay Curve. Otherwise, [Measurement.step_count][google.cloud.aiplatform.v1beta1.Measurement.step_count] will be used
- // as the x-axis.
+ // True if
+ // [Measurement.elapsed_duration][google.cloud.aiplatform.v1beta1.Measurement.elapsed_duration]
+ // is used as the x-axis of each Trials Decay Curve. Otherwise,
+ // [Measurement.step_count][google.cloud.aiplatform.v1beta1.Measurement.step_count]
+ // will be used as the x-axis.
bool use_elapsed_duration = 1;
}
@@ -392,9 +422,10 @@ message StudySpec {
// values reported by the Trial in each measurement.
message MedianAutomatedStoppingSpec {
// True if median automated stopping rule applies on
- // [Measurement.elapsed_duration][google.cloud.aiplatform.v1beta1.Measurement.elapsed_duration]. It means that elapsed_duration
- // field of latest measurement of current Trial is used to compute median
- // objective value for each completed Trials.
+ // [Measurement.elapsed_duration][google.cloud.aiplatform.v1beta1.Measurement.elapsed_duration].
+ // It means that elapsed_duration field of latest measurement of current
+ // Trial is used to compute median objective value for each completed
+ // Trials.
bool use_elapsed_duration = 1;
}
@@ -444,6 +475,15 @@ message StudySpec {
// min_num_steps are overloaded to contain max_elapsed_seconds and
// min_elapsed_seconds.
bool use_elapsed_duration = 5;
+
+ // ConvexAutomatedStoppingSpec by default only updates the trials that needs
+ // to be early stopped using a newly trained auto-regressive model. When
+ // this flag is set to True, all stopped trials from the beginning are
+ // potentially updated in terms of their `final_measurement`. Also, note
+ // that the training logic of autoregressive models is different in this
+ // case. Enabling this option has shown better results and this may be the
+ // default option in the future.
+ optional bool update_all_stopped_trials = 6;
}
// Configuration for ConvexStopPolicy.
@@ -495,7 +535,8 @@ message StudySpec {
bool disable_transfer_learning = 1;
// Output only. Names of previously completed studies
- repeated string prior_study_names = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated string prior_study_names = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The available search algorithms for the Study.
@@ -574,7 +615,8 @@ message StudySpec {
repeated MetricSpec metrics = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The set of parameters to tune.
- repeated ParameterSpec parameters = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated ParameterSpec parameters = 2
+ [(google.api.field_behavior) = REQUIRED];
// The search algorithm specified for the Study.
Algorithm algorithm = 3;
@@ -606,14 +648,16 @@ message Measurement {
double value = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
- // Output only. Time that the Trial has been running at the point of this Measurement.
- google.protobuf.Duration elapsed_duration = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Time that the Trial has been running at the point of this
+ // Measurement.
+ google.protobuf.Duration elapsed_duration = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The number of steps the machine learning model has been trained for.
- // Must be non-negative.
+ // Output only. The number of steps the machine learning model has been
+ // trained for. Must be non-negative.
int64 step_count = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A list of metrics got by evaluating the objective functions using suggested
- // Parameter values.
+ // Output only. A list of metrics got by evaluating the objective functions
+ // using suggested Parameter values.
repeated Metric metrics = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard.proto
index 32f7adddb..b4bb6897f 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard.proto
@@ -22,7 +22,7 @@ import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -54,18 +54,21 @@ message Tensorboard {
// this key.
EncryptionSpec encryption_spec = 11;
- // Output only. Consumer project Cloud Storage path prefix used to store blob data, which
- // can either be a bucket or directory. Does not end with a '/'.
- string blob_storage_path_prefix = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Consumer project Cloud Storage path prefix used to store blob
+ // data, which can either be a bucket or directory. Does not end with a '/'.
+ string blob_storage_path_prefix = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The number of Runs stored in this Tensorboard.
int32 run_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Tensorboard was created.
- google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this Tensorboard was last updated.
- google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize your Tensorboards.
//
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_data.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_data.proto
index cfc36e302..7bdee1604 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_data.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_data.proto
@@ -21,7 +21,7 @@ import "google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardDataProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -30,19 +30,21 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// All the data stored in a TensorboardTimeSeries.
message TimeSeriesData {
- // Required. The ID of the TensorboardTimeSeries, which will become the final component
- // of the TensorboardTimeSeries' resource name
- string tensorboard_time_series_id = 1 [(google.api.field_behavior) = REQUIRED];
+ // Required. The ID of the TensorboardTimeSeries, which will become the final
+ // component of the TensorboardTimeSeries' resource name
+ string tensorboard_time_series_id = 1
+ [(google.api.field_behavior) = REQUIRED];
- // Required. Immutable. The value type of this time series. All the values in this time series data
- // must match this value type.
+ // Required. Immutable. The value type of this time series. All the values in
+ // this time series data must match this value type.
TensorboardTimeSeries.ValueType value_type = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
];
// Required. Data points in this time series.
- repeated TimeSeriesDataPoint values = 3 [(google.api.field_behavior) = REQUIRED];
+ repeated TimeSeriesDataPoint values = 3
+ [(google.api.field_behavior) = REQUIRED];
}
// A TensorboardTimeSeries data point.
@@ -78,7 +80,8 @@ message TensorboardTensor {
// https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto
bytes value = 1 [(google.api.field_behavior) = REQUIRED];
- // Optional. Version number of TensorProto used to serialize [value][google.cloud.aiplatform.v1beta1.TensorboardTensor.value].
+ // Optional. Version number of TensorProto used to serialize
+ // [value][google.cloud.aiplatform.v1beta1.TensorboardTensor.value].
int32 version_number = 2 [(google.api.field_behavior) = OPTIONAL];
}
@@ -91,8 +94,8 @@ message TensorboardBlobSequence {
// One blob (e.g, image, graph) viewable on a blob metric plot.
message TensorboardBlob {
- // Output only. A URI safe key uniquely identifying a blob. Can be used to locate the blob
- // stored in the Cloud Storage bucket of the consumer project.
+ // Output only. A URI safe key uniquely identifying a blob. Can be used to
+ // locate the blob stored in the Cloud Storage bucket of the consumer project.
string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The bytes of the blob is not present unless it's returned by the
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_experiment.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_experiment.proto
index 0258ef6d1..d4f40a27e 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_experiment.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_experiment.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardExperimentProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -48,10 +48,12 @@ message TensorboardExperiment {
string description = 3;
// Output only. Timestamp when this TensorboardExperiment was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this TensorboardExperiment was last updated.
- google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize your Datasets.
//
@@ -73,6 +75,7 @@ message TensorboardExperiment {
// "overwrite" update happens.
string etag = 7;
- // Immutable. Source of the TensorboardExperiment. Example: a custom training job.
+ // Immutable. Source of the TensorboardExperiment. Example: a custom training
+ // job.
string source = 8 [(google.api.field_behavior) = IMMUTABLE];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_run.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_run.proto
index b5f570c87..5239784a1 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_run.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_run.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardRunProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -50,10 +50,12 @@ message TensorboardRun {
string description = 3;
// Output only. Timestamp when this TensorboardRun was created.
- google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this TensorboardRun was last updated.
- google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize your TensorboardRuns.
//
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_service.proto
index 6cbfe7e7f..2dbd620ba 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_service.proto
@@ -27,10 +27,11 @@ import "google/cloud/aiplatform/v1beta1/tensorboard_experiment.proto";
import "google/cloud/aiplatform/v1beta1/tensorboard_run.proto";
import "google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -40,10 +41,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// TensorboardService
service TensorboardService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a Tensorboard.
- rpc CreateTensorboard(CreateTensorboardRequest) returns (google.longrunning.Operation) {
+ rpc CreateTensorboard(CreateTensorboardRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/tensorboards"
body: "tensorboard"
@@ -63,8 +66,18 @@ service TensorboardService {
option (google.api.method_signature) = "name";
}
+ // Returns a list of monthly active users for a given TensorBoard instance.
+ rpc ReadTensorboardUsage(ReadTensorboardUsageRequest)
+ returns (ReadTensorboardUsageResponse) {
+ option (google.api.http) = {
+ get: "/v1beta1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage"
+ };
+ option (google.api.method_signature) = "tensorboard";
+ }
+
// Updates a Tensorboard.
- rpc UpdateTensorboard(UpdateTensorboardRequest) returns (google.longrunning.Operation) {
+ rpc UpdateTensorboard(UpdateTensorboardRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1beta1/{tensorboard.name=projects/*/locations/*/tensorboards/*}"
body: "tensorboard"
@@ -77,7 +90,8 @@ service TensorboardService {
}
// Lists Tensorboards in a Location.
- rpc ListTensorboards(ListTensorboardsRequest) returns (ListTensorboardsResponse) {
+ rpc ListTensorboards(ListTensorboardsRequest)
+ returns (ListTensorboardsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/tensorboards"
};
@@ -85,7 +99,8 @@ service TensorboardService {
}
// Deletes a Tensorboard.
- rpc DeleteTensorboard(DeleteTensorboardRequest) returns (google.longrunning.Operation) {
+ rpc DeleteTensorboard(DeleteTensorboardRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/tensorboards/*}"
};
@@ -97,16 +112,19 @@ service TensorboardService {
}
// Creates a TensorboardExperiment.
- rpc CreateTensorboardExperiment(CreateTensorboardExperimentRequest) returns (TensorboardExperiment) {
+ rpc CreateTensorboardExperiment(CreateTensorboardExperimentRequest)
+ returns (TensorboardExperiment) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*}/experiments"
body: "tensorboard_experiment"
};
- option (google.api.method_signature) = "parent,tensorboard_experiment,tensorboard_experiment_id";
+ option (google.api.method_signature) =
+ "parent,tensorboard_experiment,tensorboard_experiment_id";
}
// Gets a TensorboardExperiment.
- rpc GetTensorboardExperiment(GetTensorboardExperimentRequest) returns (TensorboardExperiment) {
+ rpc GetTensorboardExperiment(GetTensorboardExperimentRequest)
+ returns (TensorboardExperiment) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*}"
};
@@ -114,7 +132,8 @@ service TensorboardService {
}
// Updates a TensorboardExperiment.
- rpc UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest) returns (TensorboardExperiment) {
+ rpc UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest)
+ returns (TensorboardExperiment) {
option (google.api.http) = {
patch: "/v1beta1/{tensorboard_experiment.name=projects/*/locations/*/tensorboards/*/experiments/*}"
body: "tensorboard_experiment"
@@ -123,7 +142,8 @@ service TensorboardService {
}
// Lists TensorboardExperiments in a Location.
- rpc ListTensorboardExperiments(ListTensorboardExperimentsRequest) returns (ListTensorboardExperimentsResponse) {
+ rpc ListTensorboardExperiments(ListTensorboardExperimentsRequest)
+ returns (ListTensorboardExperimentsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*}/experiments"
};
@@ -131,7 +151,8 @@ service TensorboardService {
}
// Deletes a TensorboardExperiment.
- rpc DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest) returns (google.longrunning.Operation) {
+ rpc DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*}"
};
@@ -143,16 +164,19 @@ service TensorboardService {
}
// Creates a TensorboardRun.
- rpc CreateTensorboardRun(CreateTensorboardRunRequest) returns (TensorboardRun) {
+ rpc CreateTensorboardRun(CreateTensorboardRunRequest)
+ returns (TensorboardRun) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs"
body: "tensorboard_run"
};
- option (google.api.method_signature) = "parent,tensorboard_run,tensorboard_run_id";
+ option (google.api.method_signature) =
+ "parent,tensorboard_run,tensorboard_run_id";
}
// Batch create TensorboardRuns.
- rpc BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest) returns (BatchCreateTensorboardRunsResponse) {
+ rpc BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest)
+ returns (BatchCreateTensorboardRunsResponse) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs:batchCreate"
body: "*"
@@ -169,7 +193,8 @@ service TensorboardService {
}
// Updates a TensorboardRun.
- rpc UpdateTensorboardRun(UpdateTensorboardRunRequest) returns (TensorboardRun) {
+ rpc UpdateTensorboardRun(UpdateTensorboardRunRequest)
+ returns (TensorboardRun) {
option (google.api.http) = {
patch: "/v1beta1/{tensorboard_run.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}"
body: "tensorboard_run"
@@ -178,7 +203,8 @@ service TensorboardService {
}
// Lists TensorboardRuns in a Location.
- rpc ListTensorboardRuns(ListTensorboardRunsRequest) returns (ListTensorboardRunsResponse) {
+ rpc ListTensorboardRuns(ListTensorboardRunsRequest)
+ returns (ListTensorboardRunsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs"
};
@@ -186,7 +212,8 @@ service TensorboardService {
}
// Deletes a TensorboardRun.
- rpc DeleteTensorboardRun(DeleteTensorboardRunRequest) returns (google.longrunning.Operation) {
+ rpc DeleteTensorboardRun(DeleteTensorboardRunRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}"
};
@@ -198,7 +225,8 @@ service TensorboardService {
}
// Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
- rpc BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest) returns (BatchCreateTensorboardTimeSeriesResponse) {
+ rpc BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest)
+ returns (BatchCreateTensorboardTimeSeriesResponse) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs/*/timeSeries:batchCreate"
body: "*"
@@ -207,7 +235,8 @@ service TensorboardService {
}
// Creates a TensorboardTimeSeries.
- rpc CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) {
+ rpc CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest)
+ returns (TensorboardTimeSeries) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries"
body: "tensorboard_time_series"
@@ -216,7 +245,8 @@ service TensorboardService {
}
// Gets a TensorboardTimeSeries.
- rpc GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) {
+ rpc GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest)
+ returns (TensorboardTimeSeries) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
};
@@ -224,16 +254,19 @@ service TensorboardService {
}
// Updates a TensorboardTimeSeries.
- rpc UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) {
+ rpc UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest)
+ returns (TensorboardTimeSeries) {
option (google.api.http) = {
patch: "/v1beta1/{tensorboard_time_series.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
body: "tensorboard_time_series"
};
- option (google.api.method_signature) = "tensorboard_time_series,update_mask";
+ option (google.api.method_signature) =
+ "tensorboard_time_series,update_mask";
}
// Lists TensorboardTimeSeries in a Location.
- rpc ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest) returns (ListTensorboardTimeSeriesResponse) {
+ rpc ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest)
+ returns (ListTensorboardTimeSeriesResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries"
};
@@ -241,7 +274,8 @@ service TensorboardService {
}
// Deletes a TensorboardTimeSeries.
- rpc DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest) returns (google.longrunning.Operation) {
+ rpc DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}"
};
@@ -254,10 +288,12 @@ service TensorboardService {
// Reads multiple TensorboardTimeSeries' data. The data point number limit is
// 1000 for scalars, 100 for tensors and blob references. If the number of
- // data points stored is less than the limit, all data will be returned.
- // Otherwise, that limit number of data points will be randomly selected from
+ // data points stored is less than the limit, all data is returned.
+ // Otherwise, the number limit of data points is randomly selected from
// this time series and returned.
- rpc BatchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest) returns (BatchReadTensorboardTimeSeriesDataResponse) {
+ rpc BatchReadTensorboardTimeSeriesData(
+ BatchReadTensorboardTimeSeriesDataRequest)
+ returns (BatchReadTensorboardTimeSeriesDataResponse) {
option (google.api.http) = {
get: "/v1beta1/{tensorboard=projects/*/locations/*/tensorboards/*}/experiments/*/runs/*/timeSeries:batchRead"
};
@@ -265,11 +301,12 @@ service TensorboardService {
}
// Reads a TensorboardTimeSeries' data. By default, if the number of data
- // points stored is less than 1000, all data will be returned. Otherwise, 1000
- // data points will be randomly selected from this time series and returned.
+ // points stored is less than 1000, all data is returned. Otherwise, 1000
+ // data points is randomly selected from this time series and returned.
// This value can be changed by changing max_data_points, which can't be
// greater than 10k.
- rpc ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest) returns (ReadTensorboardTimeSeriesDataResponse) {
+ rpc ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest)
+ returns (ReadTensorboardTimeSeriesDataResponse) {
option (google.api.http) = {
get: "/v1beta1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:read"
};
@@ -280,7 +317,8 @@ service TensorboardService {
// This is to allow reading blob data stored in consumer project's Cloud
// Storage bucket without users having to obtain Cloud Storage access
// permission.
- rpc ReadTensorboardBlobData(ReadTensorboardBlobDataRequest) returns (stream ReadTensorboardBlobDataResponse) {
+ rpc ReadTensorboardBlobData(ReadTensorboardBlobDataRequest)
+ returns (stream ReadTensorboardBlobDataResponse) {
option (google.api.http) = {
get: "/v1beta1/{time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:readBlobData"
};
@@ -288,20 +326,21 @@ service TensorboardService {
}
// Write time series data points of multiple TensorboardTimeSeries in multiple
- // TensorboardRun's. If any data fail to be ingested, an error will be
- // returned.
- rpc WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest) returns (WriteTensorboardExperimentDataResponse) {
+ // TensorboardRun's. If any data fail to be ingested, an error is returned.
+ rpc WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest)
+ returns (WriteTensorboardExperimentDataResponse) {
option (google.api.http) = {
post: "/v1beta1/{tensorboard_experiment=projects/*/locations/*/tensorboards/*/experiments/*}:write"
body: "*"
};
- option (google.api.method_signature) = "tensorboard_experiment,write_run_data_requests";
+ option (google.api.method_signature) =
+ "tensorboard_experiment,write_run_data_requests";
}
// Write time series data points into multiple TensorboardTimeSeries under
- // a TensorboardRun. If any data fail to be ingested, an error will be
- // returned.
- rpc WriteTensorboardRunData(WriteTensorboardRunDataRequest) returns (WriteTensorboardRunDataResponse) {
+ // a TensorboardRun. If any data fail to be ingested, an error is returned.
+ rpc WriteTensorboardRunData(WriteTensorboardRunDataRequest)
+ returns (WriteTensorboardRunDataResponse) {
option (google.api.http) = {
post: "/v1beta1/{tensorboard_run=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}:write"
body: "*"
@@ -311,7 +350,8 @@ service TensorboardService {
// Exports a TensorboardTimeSeries' data. Data is returned in paginated
// responses.
- rpc ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest) returns (ExportTensorboardTimeSeriesDataResponse) {
+ rpc ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest)
+ returns (ExportTensorboardTimeSeriesDataResponse) {
option (google.api.http) = {
post: "/v1beta1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:exportTensorboardTimeSeries"
body: "*"
@@ -320,7 +360,8 @@ service TensorboardService {
}
}
-// Request message for [TensorboardService.CreateTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboard].
+// Request message for
+// [TensorboardService.CreateTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboard].
message CreateTensorboardRequest {
// Required. The resource name of the Location to create the Tensorboard in.
// Format: `projects/{project}/locations/{location}`
@@ -335,7 +376,8 @@ message CreateTensorboardRequest {
Tensorboard tensorboard = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.GetTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboard].
+// Request message for
+// [TensorboardService.GetTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboard].
message GetTensorboardRequest {
// Required. The name of the Tensorboard resource.
// Format:
@@ -348,7 +390,43 @@ message GetTensorboardRequest {
];
}
-// Request message for [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards].
+// Request message for [TensorboardService.GetTensorboardUsage][].
+message ReadTensorboardUsageRequest {
+ // Required. The name of the Tensorboard resource.
+ // Format:
+ // `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
+ string tensorboard = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "aiplatform.googleapis.com/Tensorboard"
+ }
+ ];
+}
+
+// Response message for
+// [TensorboardService.ReadTensorboardUsage][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardUsage].
+message ReadTensorboardUsageResponse {
+ // Per user usage data.
+ message PerUserUsageData {
+ // User's username
+ string username = 1;
+
+ // Number of times the user has read data within the Tensorboard.
+ int64 view_count = 2;
+ }
+
+ // Per month usage data
+ message PerMonthUsageData {
+ // Usage data for each user in the given month.
+ repeated PerUserUsageData user_usage_data = 1;
+ }
+
+ // Maps year-month (YYYYMM) string to per month usage data.
+ map monthly_usage_data = 1;
+}
+
+// Request message for
+// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards].
message ListTensorboardsRequest {
// Required. The resource name of the Location to list Tensorboards.
// Format:
@@ -364,18 +442,18 @@ message ListTensorboardsRequest {
string filter = 2;
// The maximum number of Tensorboards to return. The service may return
- // fewer than this value. If unspecified, at most 100 Tensorboards will be
- // returned. The maximum value is 100; values above 100 will be coerced to
+ // fewer than this value. If unspecified, at most 100 Tensorboards are
+ // returned. The maximum value is 100; values above 100 are coerced to
// 100.
int32 page_size = 3;
// A page token, received from a previous
- // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards] call.
- // Provide this to retrieve the subsequent page.
+ // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards] must
- // match the call that provided the page token.
+ // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
+ // must match the call that provided the page token.
string page_token = 4;
// Field to use to sort the list.
@@ -385,26 +463,30 @@ message ListTensorboardsRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards].
+// Response message for
+// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards].
message ListTensorboardsResponse {
// The Tensorboards mathching the request.
repeated Tensorboard tensorboards = 1;
- // A token, which can be sent as [ListTensorboardsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardsRequest.page_token]
+ // A token, which can be sent as
+ // [ListTensorboardsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardsRequest.page_token]
// to retrieve the next page. If this field is omitted, there are no
// subsequent pages.
string next_page_token = 2;
}
-// Request message for [TensorboardService.UpdateTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboard].
+// Request message for
+// [TensorboardService.UpdateTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboard].
message UpdateTensorboardRequest {
// Required. Field mask is used to specify the fields to be overwritten in the
// Tensorboard resource by the update.
// The fields specified in the update_mask are relative to the resource, not
- // the full request. A field will be overwritten if it is in the mask. If the
- // user does not provide a mask then all fields will be overwritten if new
+ // the full request. A field is overwritten if it's in the mask. If the
+ // user does not provide a mask then all fields are overwritten if new
// values are specified.
- google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = REQUIRED];
// Required. The Tensorboard's `name` field is used to identify the
// Tensorboard to be updated. Format:
@@ -412,7 +494,8 @@ message UpdateTensorboardRequest {
Tensorboard tensorboard = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.DeleteTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboard].
+// Request message for
+// [TensorboardService.DeleteTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboard].
message DeleteTensorboardRequest {
// Required. The name of the Tensorboard to be deleted.
// Format:
@@ -425,10 +508,11 @@ message DeleteTensorboardRequest {
];
}
-// Request message for [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardExperiment].
+// Request message for
+// [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardExperiment].
message CreateTensorboardExperimentRequest {
- // Required. The resource name of the Tensorboard to create the TensorboardExperiment
- // in. Format:
+ // Required. The resource name of the Tensorboard to create the
+ // TensorboardExperiment in. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -440,15 +524,16 @@ message CreateTensorboardExperimentRequest {
// The TensorboardExperiment to create.
TensorboardExperiment tensorboard_experiment = 2;
- // Required. The ID to use for the Tensorboard experiment, which will become the final
- // component of the Tensorboard experiment's resource name.
+ // Required. The ID to use for the Tensorboard experiment, which becomes the
+ // final component of the Tensorboard experiment's resource name.
//
// This value should be 1-128 characters, and valid characters
// are /[a-z][0-9]-/.
string tensorboard_experiment_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.GetTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardExperiment].
+// Request message for
+// [TensorboardService.GetTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardExperiment].
message GetTensorboardExperimentRequest {
// Required. The name of the TensorboardExperiment resource.
// Format:
@@ -461,10 +546,11 @@ message GetTensorboardExperimentRequest {
];
}
-// Request message for [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments].
+// Request message for
+// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments].
message ListTensorboardExperimentsRequest {
- // Required. The resource name of the Tensorboard to list TensorboardExperiments.
- // Format:
+ // Required. The resource name of the Tensorboard to list
+ // TensorboardExperiments. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -478,17 +564,17 @@ message ListTensorboardExperimentsRequest {
// The maximum number of TensorboardExperiments to return. The service may
// return fewer than this value. If unspecified, at most 50
- // TensorboardExperiments will be returned. The maximum value is 1000; values
- // above 1000 will be coerced to 1000.
+ // TensorboardExperiments are returned. The maximum value is 1000; values
+ // above 1000 are coerced to 1000.
int32 page_size = 3;
// A page token, received from a previous
- // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments] call.
- // Provide this to retrieve the subsequent page.
+ // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments] must
- // match the call that provided the page token.
+ // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments]
+ // must match the call that provided the page token.
string page_token = 4;
// Field to use to sort the list.
@@ -498,34 +584,40 @@ message ListTensorboardExperimentsRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments].
+// Response message for
+// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments].
message ListTensorboardExperimentsResponse {
// The TensorboardExperiments mathching the request.
repeated TensorboardExperiment tensorboard_experiments = 1;
// A token, which can be sent as
- // [ListTensorboardExperimentsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardExperimentsRequest.page_token] to retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // [ListTensorboardExperimentsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardExperimentsRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [TensorboardService.UpdateTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardExperiment].
+// Request message for
+// [TensorboardService.UpdateTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardExperiment].
message UpdateTensorboardExperimentRequest {
// Required. Field mask is used to specify the fields to be overwritten in the
// TensorboardExperiment resource by the update.
// The fields specified in the update_mask are relative to the resource, not
- // the full request. A field will be overwritten if it is in the mask. If the
- // user does not provide a mask then all fields will be overwritten if new
+ // the full request. A field is overwritten if it's in the mask. If the
+ // user does not provide a mask then all fields are overwritten if new
// values are specified.
- google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = REQUIRED];
// Required. The TensorboardExperiment's `name` field is used to identify the
// TensorboardExperiment to be updated. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
- TensorboardExperiment tensorboard_experiment = 2 [(google.api.field_behavior) = REQUIRED];
+ TensorboardExperiment tensorboard_experiment = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.DeleteTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardExperiment].
+// Request message for
+// [TensorboardService.DeleteTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardExperiment].
message DeleteTensorboardExperimentRequest {
// Required. The name of the TensorboardExperiment to be deleted.
// Format:
@@ -538,7 +630,8 @@ message DeleteTensorboardExperimentRequest {
];
}
-// Request message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns].
+// Request message for
+// [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns].
message BatchCreateTensorboardRunsRequest {
// Required. The resource name of the TensorboardExperiment to create the
// TensorboardRuns in. Format:
@@ -554,19 +647,22 @@ message BatchCreateTensorboardRunsRequest {
// Required. The request message specifying the TensorboardRuns to create.
// A maximum of 1000 TensorboardRuns can be created in a batch.
- repeated CreateTensorboardRunRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated CreateTensorboardRunRequest requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns].
+// Response message for
+// [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns].
message BatchCreateTensorboardRunsResponse {
// The created TensorboardRuns.
repeated TensorboardRun tensorboard_runs = 1;
}
-// Request message for [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardRun].
+// Request message for
+// [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardRun].
message CreateTensorboardRunRequest {
- // Required. The resource name of the TensorboardExperiment to create the TensorboardRun
- // in. Format:
+ // Required. The resource name of the TensorboardExperiment to create the
+ // TensorboardRun in. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -578,7 +674,7 @@ message CreateTensorboardRunRequest {
// Required. The TensorboardRun to create.
TensorboardRun tensorboard_run = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. The ID to use for the Tensorboard run, which will become the final
+ // Required. The ID to use for the Tensorboard run, which becomes the final
// component of the Tensorboard run's resource name.
//
// This value should be 1-128 characters, and valid characters
@@ -586,7 +682,8 @@ message CreateTensorboardRunRequest {
string tensorboard_run_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.GetTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardRun].
+// Request message for
+// [TensorboardService.GetTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardRun].
message GetTensorboardRunRequest {
// Required. The name of the TensorboardRun resource.
// Format:
@@ -599,7 +696,8 @@ message GetTensorboardRunRequest {
];
}
-// Request message for [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData].
+// Request message for
+// [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData].
message ReadTensorboardBlobDataRequest {
// Required. The resource name of the TensorboardTimeSeries to list Blobs.
// Format:
@@ -615,16 +713,18 @@ message ReadTensorboardBlobDataRequest {
repeated string blob_ids = 2;
}
-// Response message for [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData].
+// Response message for
+// [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData].
message ReadTensorboardBlobDataResponse {
// Blob messages containing blob bytes.
repeated TensorboardBlob blobs = 1;
}
-// Request message for [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns].
+// Request message for
+// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns].
message ListTensorboardRunsRequest {
- // Required. The resource name of the TensorboardExperiment to list TensorboardRuns.
- // Format:
+ // Required. The resource name of the TensorboardExperiment to list
+ // TensorboardRuns. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -637,18 +737,18 @@ message ListTensorboardRunsRequest {
string filter = 2;
// The maximum number of TensorboardRuns to return. The service may return
- // fewer than this value. If unspecified, at most 50 TensorboardRuns will be
- // returned. The maximum value is 1000; values above 1000 will be coerced to
+ // fewer than this value. If unspecified, at most 50 TensorboardRuns are
+ // returned. The maximum value is 1000; values above 1000 are coerced to
// 1000.
int32 page_size = 3;
// A page token, received from a previous
- // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns] call.
- // Provide this to retrieve the subsequent page.
+ // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns] must
- // match the call that provided the page token.
+ // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns]
+ // must match the call that provided the page token.
string page_token = 4;
// Field to use to sort the list.
@@ -658,34 +758,39 @@ message ListTensorboardRunsRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns].
+// Response message for
+// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns].
message ListTensorboardRunsResponse {
// The TensorboardRuns mathching the request.
repeated TensorboardRun tensorboard_runs = 1;
- // A token, which can be sent as [ListTensorboardRunsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardRunsRequest.page_token] to
- // retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // A token, which can be sent as
+ // [ListTensorboardRunsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardRunsRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [TensorboardService.UpdateTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardRun].
+// Request message for
+// [TensorboardService.UpdateTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardRun].
message UpdateTensorboardRunRequest {
// Required. Field mask is used to specify the fields to be overwritten in the
// TensorboardRun resource by the update.
// The fields specified in the update_mask are relative to the resource, not
- // the full request. A field will be overwritten if it is in the mask. If the
- // user does not provide a mask then all fields will be overwritten if new
+ // the full request. A field is overwritten if it's in the mask. If the
+ // user does not provide a mask then all fields are overwritten if new
// values are specified.
- google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = REQUIRED];
- // Required. The TensorboardRun's `name` field is used to identify the TensorboardRun to
- // be updated. Format:
+ // Required. The TensorboardRun's `name` field is used to identify the
+ // TensorboardRun to be updated. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
TensorboardRun tensorboard_run = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.DeleteTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardRun].
+// Request message for
+// [TensorboardService.DeleteTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardRun].
message DeleteTensorboardRunRequest {
// Required. The name of the TensorboardRun to be deleted.
// Format:
@@ -698,7 +803,8 @@ message DeleteTensorboardRunRequest {
];
}
-// Request message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries].
message BatchCreateTensorboardTimeSeriesRequest {
// Required. The resource name of the TensorboardExperiment to create the
// TensorboardTimeSeries in.
@@ -714,18 +820,21 @@ message BatchCreateTensorboardTimeSeriesRequest {
}
];
- // Required. The request message specifying the TensorboardTimeSeries to create.
- // A maximum of 1000 TensorboardTimeSeries can be created in a batch.
- repeated CreateTensorboardTimeSeriesRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. The request message specifying the TensorboardTimeSeries to
+ // create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.
+ repeated CreateTensorboardTimeSeriesRequest requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries].
+// Response message for
+// [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries].
message BatchCreateTensorboardTimeSeriesResponse {
// The created TensorboardTimeSeries.
repeated TensorboardTimeSeries tensorboard_time_series = 1;
}
-// Request message for [TensorboardService.CreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.CreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardTimeSeries].
message CreateTensorboardTimeSeriesRequest {
// Required. The resource name of the TensorboardRun to create the
// TensorboardTimeSeries in.
@@ -738,17 +847,20 @@ message CreateTensorboardTimeSeriesRequest {
}
];
- // Optional. The user specified unique ID to use for the TensorboardTimeSeries, which
- // will become the final component of the TensorboardTimeSeries's resource
- // name.
- // This value should match "[a-z0-9][a-z0-9-]{0, 127}"
- string tensorboard_time_series_id = 3 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. The user specified unique ID to use for the
+ // TensorboardTimeSeries, which becomes the final component of the
+ // TensorboardTimeSeries's resource name. This value should match
+ // "[a-z0-9][a-z0-9-]{0, 127}"
+ string tensorboard_time_series_id = 3
+ [(google.api.field_behavior) = OPTIONAL];
// Required. The TensorboardTimeSeries to create.
- TensorboardTimeSeries tensorboard_time_series = 2 [(google.api.field_behavior) = REQUIRED];
+ TensorboardTimeSeries tensorboard_time_series = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.GetTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.GetTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardTimeSeries].
message GetTensorboardTimeSeriesRequest {
// Required. The name of the TensorboardTimeSeries resource.
// Format:
@@ -761,10 +873,11 @@ message GetTensorboardTimeSeriesRequest {
];
}
-// Request message for [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries].
message ListTensorboardTimeSeriesRequest {
- // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries.
- // Format:
+ // Required. The resource name of the TensorboardRun to list
+ // TensorboardTimeSeries. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -778,17 +891,17 @@ message ListTensorboardTimeSeriesRequest {
// The maximum number of TensorboardTimeSeries to return. The service may
// return fewer than this value. If unspecified, at most 50
- // TensorboardTimeSeries will be returned. The maximum value is 1000; values
- // above 1000 will be coerced to 1000.
+ // TensorboardTimeSeries are returned. The maximum value is 1000; values
+ // above 1000 are coerced to 1000.
int32 page_size = 3;
// A page token, received from a previous
- // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries] call.
- // Provide this to retrieve the subsequent page.
+ // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries]
+ // call. Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to
- // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries] must
- // match the call that provided the page token.
+ // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries]
+ // must match the call that provided the page token.
string page_token = 4;
// Field to use to sort the list.
@@ -798,35 +911,41 @@ message ListTensorboardTimeSeriesRequest {
google.protobuf.FieldMask read_mask = 6;
}
-// Response message for [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries].
+// Response message for
+// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries].
message ListTensorboardTimeSeriesResponse {
// The TensorboardTimeSeries mathching the request.
repeated TensorboardTimeSeries tensorboard_time_series = 1;
// A token, which can be sent as
- // [ListTensorboardTimeSeriesRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardTimeSeriesRequest.page_token] to retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
+ // [ListTensorboardTimeSeriesRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardTimeSeriesRequest.page_token]
+ // to retrieve the next page. If this field is omitted, there are no
+ // subsequent pages.
string next_page_token = 2;
}
-// Request message for [TensorboardService.UpdateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.UpdateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardTimeSeries].
message UpdateTensorboardTimeSeriesRequest {
// Required. Field mask is used to specify the fields to be overwritten in the
// TensorboardTimeSeries resource by the update.
// The fields specified in the update_mask are relative to the resource, not
- // the full request. A field will be overwritten if it is in the mask. If the
- // user does not provide a mask then all fields will be overwritten if new
+ // the full request. A field is overwritten if it's in the mask. If the
+ // user does not provide a mask then all fields are overwritten if new
// values are specified.
- google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = REQUIRED];
// Required. The TensorboardTimeSeries' `name` field is used to identify the
// TensorboardTimeSeries to be updated.
// Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
- TensorboardTimeSeries tensorboard_time_series = 2 [(google.api.field_behavior) = REQUIRED];
+ TensorboardTimeSeries tensorboard_time_series = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [TensorboardService.DeleteTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardTimeSeries].
+// Request message for
+// [TensorboardService.DeleteTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardTimeSeries].
message DeleteTensorboardTimeSeriesRequest {
// Required. The name of the TensorboardTimeSeries to be deleted.
// Format:
@@ -842,11 +961,12 @@ message DeleteTensorboardTimeSeriesRequest {
// Request message for
// [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.BatchReadTensorboardTimeSeriesData].
message BatchReadTensorboardTimeSeriesDataRequest {
- // Required. The resource name of the Tensorboard containing TensorboardTimeSeries to
- // read data from. Format:
+ // Required. The resource name of the Tensorboard containing
+ // TensorboardTimeSeries to read data from. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`.
- // The TensorboardTimeSeries referenced by [time_series][google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataRequest.time_series] must be sub
- // resources of this Tensorboard.
+ // The TensorboardTimeSeries referenced by
+ // [time_series][google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataRequest.time_series]
+ // must be sub resources of this Tensorboard.
string tensorboard = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -854,7 +974,8 @@ message BatchReadTensorboardTimeSeriesDataRequest {
}
];
- // Required. The resource names of the TensorboardTimeSeries to read data from. Format:
+ // Required. The resource names of the TensorboardTimeSeries to read data
+ // from. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
repeated string time_series = 2 [
(google.api.field_behavior) = REQUIRED,
@@ -871,7 +992,8 @@ message BatchReadTensorboardTimeSeriesDataResponse {
repeated TimeSeriesData time_series_data = 1;
}
-// Request message for [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData].
+// Request message for
+// [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData].
message ReadTensorboardTimeSeriesDataRequest {
// Required. The resource name of the TensorboardTimeSeries to read data from.
// Format:
@@ -893,13 +1015,15 @@ message ReadTensorboardTimeSeriesDataRequest {
string filter = 3;
}
-// Response message for [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData].
+// Response message for
+// [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData].
message ReadTensorboardTimeSeriesDataResponse {
// The returned time series data.
TimeSeriesData time_series_data = 1;
}
-// Request message for [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData].
+// Request message for
+// [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData].
message WriteTensorboardExperimentDataRequest {
// Required. The resource name of the TensorboardExperiment to write data to.
// Format:
@@ -912,15 +1036,16 @@ message WriteTensorboardExperimentDataRequest {
];
// Required. Requests containing per-run TensorboardTimeSeries data to write.
- repeated WriteTensorboardRunDataRequest write_run_data_requests = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated WriteTensorboardRunDataRequest write_run_data_requests = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData].
-message WriteTensorboardExperimentDataResponse {
-
-}
+// Response message for
+// [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData].
+message WriteTensorboardExperimentDataResponse {}
-// Request message for [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData].
+// Request message for
+// [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData].
message WriteTensorboardRunDataRequest {
// Required. The resource name of the TensorboardRun to write data to.
// Format:
@@ -937,18 +1062,19 @@ message WriteTensorboardRunDataRequest {
// Repeated writes to the same step will overwrite the existing value for that
// step.
// The upper limit of data points per write request is 5000.
- repeated TimeSeriesData time_series_data = 2 [(google.api.field_behavior) = REQUIRED];
+ repeated TimeSeriesData time_series_data = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData].
-message WriteTensorboardRunDataResponse {
-
-}
+// Response message for
+// [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData].
+message WriteTensorboardRunDataResponse {}
-// Request message for [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData].
+// Request message for
+// [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData].
message ExportTensorboardTimeSeriesDataRequest {
- // Required. The resource name of the TensorboardTimeSeries to export data from.
- // Format:
+ // Required. The resource name of the TensorboardTimeSeries to export data
+ // from. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
string tensorboard_time_series = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -961,8 +1087,8 @@ message ExportTensorboardTimeSeriesDataRequest {
string filter = 2;
// The maximum number of data points to return per page.
- // The default page_size will be 1000. Values must be between 1 and 10000.
- // Values above 10000 will be coerced to 10000.
+ // The default page_size is 1000. Values must be between 1 and 10000.
+ // Values above 10000 are coerced to 10000.
int32 page_size = 3;
// A page token, received from a previous
@@ -975,12 +1101,13 @@ message ExportTensorboardTimeSeriesDataRequest {
string page_token = 4;
// Field to use to sort the TensorboardTimeSeries' data.
- // By default, TensorboardTimeSeries' data will be returned in a pseudo random
+ // By default, TensorboardTimeSeries' data is returned in a pseudo random
// order.
string order_by = 5;
}
-// Response message for [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData].
+// Response message for
+// [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData].
message ExportTensorboardTimeSeriesDataResponse {
// The returned time series data points.
repeated TimeSeriesDataPoint time_series_data_points = 1;
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto
index 6e202a6ef..cc07a7bbe 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TensorboardTimeSeriesProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -37,16 +37,19 @@ message TensorboardTimeSeries {
// Describes metadata for a TensorboardTimeSeries.
message Metadata {
- // Output only. Max step index of all data points within a TensorboardTimeSeries.
+ // Output only. Max step index of all data points within a
+ // TensorboardTimeSeries.
int64 max_step = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Max wall clock timestamp of all data points within a
// TensorboardTimeSeries.
- google.protobuf.Timestamp max_wall_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp max_wall_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The largest blob sequence length (number of blobs) of all data points in
- // this time series, if its ValueType is BLOB_SEQUENCE.
- int64 max_blob_sequence_length = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The largest blob sequence length (number of blobs) of all
+ // data points in this time series, if its ValueType is BLOB_SEQUENCE.
+ int64 max_blob_sequence_length = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// An enum representing the value type of a TensorboardTimeSeries.
@@ -85,22 +88,25 @@ message TensorboardTimeSeries {
];
// Output only. Timestamp when this TensorboardTimeSeries was created.
- google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Timestamp when this TensorboardTimeSeries was last updated.
- google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Used to perform a consistent read-modify-write updates. If not set, a blind
// "overwrite" update happens.
string etag = 7;
- // Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor,
- // Blob
+ // Immutable. Name of the plugin this time series pertain to. Such as Scalar,
+ // Tensor, Blob
string plugin_name = 8 [(google.api.field_behavior) = IMMUTABLE];
// Data of the current plugin, with the size limited to 65KB.
bytes plugin_data = 9;
- // Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.
+ // Output only. Scalar, Tensor, or Blob metadata for this
+ // TensorboardTimeSeries.
Metadata metadata = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/training_pipeline.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/training_pipeline.proto
index cf7af508c..42ab55457 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/training_pipeline.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/training_pipeline.proto
@@ -27,7 +27,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TrainingPipelineProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -37,8 +37,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// The TrainingPipeline orchestrates tasks associated with training a Model. It
// always executes the training task, and optionally may also
// export data from Vertex AI's Dataset which becomes the training input,
-// [upload][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] the Model to Vertex AI, and evaluate the
-// Model.
+// [upload][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] the Model
+// to Vertex AI, and evaluate the Model.
message TrainingPipeline {
option (google.api.resource) = {
type: "aiplatform.googleapis.com/TrainingPipeline"
@@ -52,17 +52,20 @@ message TrainingPipeline {
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
// Specifies Vertex AI owned input data that may be used for training the
- // Model. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] should make
- // clear whether this config is used and if there are any special requirements
- // on how it should be filled. If nothing about this config is mentioned in
- // the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], then it should be assumed that the
- // TrainingPipeline does not depend on this configuration.
+ // Model. The TrainingPipeline's
+ // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]
+ // should make clear whether this config is used and if there are any special
+ // requirements on how it should be filled. If nothing about this config is
+ // mentioned in the
+ // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition],
+ // then it should be assumed that the TrainingPipeline does not depend on this
+ // configuration.
InputDataConfig input_data_config = 3;
- // Required. A Google Cloud Storage path to the YAML file that defines the training task
- // which is responsible for producing the model artifact, and may also include
- // additional auxiliary work.
- // The definition files that can be used here are found in
+ // Required. A Google Cloud Storage path to the YAML file that defines the
+ // training task which is responsible for producing the model artifact, and
+ // may also include additional auxiliary work. The definition files that can
+ // be used here are found in
// gs://google-cloud-aiplatform/schema/trainingjob/definition/.
// Note: The URI given on output will be immutable and probably different,
// including the URI scheme, than the one given on input. The output URI will
@@ -70,28 +73,37 @@ message TrainingPipeline {
string training_task_definition = 4 [(google.api.field_behavior) = REQUIRED];
// Required. The training task's parameter(s), as specified in the
- // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s `inputs`.
- google.protobuf.Value training_task_inputs = 5 [(google.api.field_behavior) = REQUIRED];
+ // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s
+ // `inputs`.
+ google.protobuf.Value training_task_inputs = 5
+ [(google.api.field_behavior) = REQUIRED];
- // Output only. The metadata information as specified in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s
+ // Output only. The metadata information as specified in the
+ // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s
// `metadata`. This metadata is an auxiliary runtime and final information
// about the training task. While the pipeline is running this information is
// populated only at a best effort basis. Only present if the
- // pipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] contains `metadata` object.
- google.protobuf.Value training_task_metadata = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel])
+ // pipeline's
+ // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]
+ // contains `metadata` object.
+ google.protobuf.Value training_task_metadata = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Describes the Model that may be uploaded (via
+ // [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel])
// by this TrainingPipeline. The TrainingPipeline's
- // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] should make clear whether this Model
- // description should be populated, and if there are any special requirements
- // regarding how it should be filled. If nothing is mentioned in the
- // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], then it should be assumed that this field
- // should not be filled and the training task either uploads the Model without
- // a need of this information, or that training task does not support
- // uploading a Model as part of the pipeline.
- // When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and
+ // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]
+ // should make clear whether this Model description should be populated, and
+ // if there are any special requirements regarding how it should be filled. If
+ // nothing is mentioned in the
+ // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition],
+ // then it should be assumed that this field should not be filled and the
+ // training task either uploads the Model without a need of this information,
+ // or that training task does not support uploading a Model as part of the
+ // pipeline. When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and
// the trained Model had been uploaded into Vertex AI, then the
- // model_to_upload's resource [name][google.cloud.aiplatform.v1beta1.Model.name] is populated. The Model
+ // model_to_upload's resource
+ // [name][google.cloud.aiplatform.v1beta1.Model.name] is populated. The Model
// is always uploaded into the Project and Location in which this pipeline
// is.
Model model_to_upload = 7;
@@ -103,31 +115,36 @@ message TrainingPipeline {
// `[a-z0-9_-]`. The first character cannot be a number or hyphen.
string model_id = 22 [(google.api.field_behavior) = OPTIONAL];
- // Optional. When specify this field, the `model_to_upload` will not be uploaded as a
- // new model, instead, it will become a new version of this `parent_model`.
+ // Optional. When specify this field, the `model_to_upload` will not be
+ // uploaded as a new model, instead, it will become a new version of this
+ // `parent_model`.
string parent_model = 21 [(google.api.field_behavior) = OPTIONAL];
// Output only. The detailed state of the pipeline.
PipelineState state = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Only populated when the pipeline's state is `PIPELINE_STATE_FAILED` or
- // `PIPELINE_STATE_CANCELLED`.
+ // Output only. Only populated when the pipeline's state is
+ // `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
google.rpc.Status error = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the TrainingPipeline was created.
- google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the TrainingPipeline for the first time entered the
// `PIPELINE_STATE_RUNNING` state.
- google.protobuf.Timestamp start_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Time when the TrainingPipeline entered any of the following states:
- // `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`,
+ // Output only. Time when the TrainingPipeline entered any of the following
+ // states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`,
// `PIPELINE_STATE_CANCELLED`.
- google.protobuf.Timestamp end_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when the TrainingPipeline was most recently updated.
- google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels with user-defined metadata to organize TrainingPipelines.
//
@@ -142,7 +159,8 @@ message TrainingPipeline {
// TrainingPipeline will be secured by this key.
//
// Note: Model trained by this TrainingPipeline is also secured by this key if
- // [model_to_upload][google.cloud.aiplatform.v1beta1.TrainingPipeline.encryption_spec] is not set separately.
+ // [model_to_upload][google.cloud.aiplatform.v1beta1.TrainingPipeline.encryption_spec]
+ // is not set separately.
EncryptionSpec encryption_spec = 18;
}
@@ -151,7 +169,9 @@ message TrainingPipeline {
message InputDataConfig {
// The instructions how the input data should be split between the
// training, validation and test sets.
- // If no split type is provided, the [fraction_split][google.cloud.aiplatform.v1beta1.InputDataConfig.fraction_split] is used by default.
+ // If no split type is provided, the
+ // [fraction_split][google.cloud.aiplatform.v1beta1.InputDataConfig.fraction_split]
+ // is used by default.
oneof split {
// Split based on fractions defining the size of each set.
FractionSplit fraction_split = 2;
@@ -235,9 +255,9 @@ message InputDataConfig {
BigQueryDestination bigquery_destination = 10;
}
- // Required. The ID of the Dataset in the same Project and Location which data will be
- // used to train the Model. The Dataset must use schema compatible with
- // Model being trained, and what is compatible should be described in the
+ // Required. The ID of the Dataset in the same Project and Location which data
+ // will be used to train the Model. The Dataset must use schema compatible
+ // with Model being trained, and what is compatible should be described in the
// used TrainingPipeline's [training_task_definition]
// [google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition].
// For tabular Datasets, all their data is exported to training, to pick
@@ -251,9 +271,9 @@ message InputDataConfig {
// are used in respectively training, validation or test role, depending on
// the role of the DataItem they are on (for the auto-assigned that role is
// decided by Vertex AI). A filter with same syntax as the one used in
- // [ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations] may be used, but note
- // here it filters across all Annotations of the Dataset, and not just within
- // a single DataItem.
+ // [ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations]
+ // may be used, but note here it filters across all Annotations of the
+ // Dataset, and not just within a single DataItem.
string annotations_filter = 6;
// Applicable only to custom training with Datasets that have DataItems and
@@ -265,30 +285,41 @@ message InputDataConfig {
// The schema files that can be used here are found in
// gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the
// chosen schema must be consistent with
- // [metadata][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri] of the Dataset specified by
+ // [metadata][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri] of
+ // the Dataset specified by
// [dataset_id][google.cloud.aiplatform.v1beta1.InputDataConfig.dataset_id].
//
// Only Annotations that both match this schema and belong to DataItems not
// ignored by the split method are used in respectively training, validation
// or test role, depending on the role of the DataItem they are on.
//
- // When used in conjunction with [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter], the Annotations used
- // for training are filtered by both [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter] and
+ // When used in conjunction with
+ // [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter],
+ // the Annotations used for training are filtered by both
+ // [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter]
+ // and
// [annotation_schema_uri][google.cloud.aiplatform.v1beta1.InputDataConfig.annotation_schema_uri].
string annotation_schema_uri = 9;
// Only applicable to Datasets that have SavedQueries.
//
// The ID of a SavedQuery (annotation set) under the Dataset specified by
- // [dataset_id][google.cloud.aiplatform.v1beta1.InputDataConfig.dataset_id] used for filtering Annotations for training.
+ // [dataset_id][google.cloud.aiplatform.v1beta1.InputDataConfig.dataset_id]
+ // used for filtering Annotations for training.
//
// Only Annotations that are associated with this SavedQuery are used in
// respectively training. When used in conjunction with
- // [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter], the Annotations used for training are filtered by
- // both [saved_query_id][google.cloud.aiplatform.v1beta1.InputDataConfig.saved_query_id] and [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter].
+ // [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter],
+ // the Annotations used for training are filtered by both
+ // [saved_query_id][google.cloud.aiplatform.v1beta1.InputDataConfig.saved_query_id]
+ // and
+ // [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter].
//
- // Only one of [saved_query_id][google.cloud.aiplatform.v1beta1.InputDataConfig.saved_query_id] and [annotation_schema_uri][google.cloud.aiplatform.v1beta1.InputDataConfig.annotation_schema_uri] should be
- // specified as both of them represent the same thing: problem type.
+ // Only one of
+ // [saved_query_id][google.cloud.aiplatform.v1beta1.InputDataConfig.saved_query_id]
+ // and
+ // [annotation_schema_uri][google.cloud.aiplatform.v1beta1.InputDataConfig.annotation_schema_uri]
+ // should be specified as both of them represent the same thing: problem type.
string saved_query_id = 7;
// Whether to persist the ML use assignment to data item system labels.
@@ -323,26 +354,29 @@ message FractionSplit {
message FilterSplit {
// Required. A filter on DataItems of the Dataset. DataItems that match
// this filter are used to train the Model. A filter with same syntax
- // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems] may be used. If a
- // single DataItem is matched by more than one of the FilterSplit filters,
- // then it is assigned to the first set that applies to it in the
- // training, validation, test order.
+ // as the one used in
+ // [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems]
+ // may be used. If a single DataItem is matched by more than one of the
+ // FilterSplit filters, then it is assigned to the first set that applies to
+ // it in the training, validation, test order.
string training_filter = 1 [(google.api.field_behavior) = REQUIRED];
// Required. A filter on DataItems of the Dataset. DataItems that match
// this filter are used to validate the Model. A filter with same syntax
- // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems] may be used. If a
- // single DataItem is matched by more than one of the FilterSplit filters,
- // then it is assigned to the first set that applies to it in the
- // training, validation, test order.
+ // as the one used in
+ // [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems]
+ // may be used. If a single DataItem is matched by more than one of the
+ // FilterSplit filters, then it is assigned to the first set that applies to
+ // it in the training, validation, test order.
string validation_filter = 2 [(google.api.field_behavior) = REQUIRED];
// Required. A filter on DataItems of the Dataset. DataItems that match
// this filter are used to test the Model. A filter with same syntax
- // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems] may be used. If a
- // single DataItem is matched by more than one of the FilterSplit filters,
- // then it is assigned to the first set that applies to it in the
- // training, validation, test order.
+ // as the one used in
+ // [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems]
+ // may be used. If a single DataItem is matched by more than one of the
+ // FilterSplit filters, then it is assigned to the first set that applies to
+ // it in the training, validation, test order.
string test_filter = 3 [(google.api.field_behavior) = REQUIRED];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/types.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/types.proto
index d62b772cf..4f1855616 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/types.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/types.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1beta1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "TypesProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/unmanaged_container_model.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/unmanaged_container_model.proto
index 7b0d6bdcd..354dd926a 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/unmanaged_container_model.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/unmanaged_container_model.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/cloud/aiplatform/v1beta1/model.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "UnmanagedContainerModelProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -37,7 +37,8 @@ message UnmanagedContainerModel {
// Contains the schemata used in Model's predictions and explanations
PredictSchemata predict_schemata = 2;
- // Input only. The specification of the container that is to be used when deploying
- // this Model.
- ModelContainerSpec container_spec = 3 [(google.api.field_behavior) = INPUT_ONLY];
+ // Input only. The specification of the container that is to be used when
+ // deploying this Model.
+ ModelContainerSpec container_spec = 3
+ [(google.api.field_behavior) = INPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/user_action_reference.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/user_action_reference.proto
index 4ecf45989..dab68d4c9 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/user_action_reference.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/user_action_reference.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1beta1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "UserActionReferenceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/value.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/value.proto
index 9468f580a..0de95affe 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/value.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/value.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.aiplatform.v1beta1;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ValueProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
diff --git a/third_party/googleapis/google/cloud/aiplatform/v1beta1/vizier_service.proto b/third_party/googleapis/google/cloud/aiplatform/v1beta1/vizier_service.proto
index 88aec042e..0e75beaa3 100644
--- a/third_party/googleapis/google/cloud/aiplatform/v1beta1/vizier_service.proto
+++ b/third_party/googleapis/google/cloud/aiplatform/v1beta1/vizier_service.proto
@@ -27,7 +27,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
+option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "VizierServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
@@ -41,7 +41,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// learning architectures.
service VizierService {
option (google.api.default_host) = "aiplatform.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a Study. A resource name will be generated after creation of the
// Study.
@@ -92,7 +93,8 @@ service VizierService {
// operation associated with the generation of Trial suggestions.
// When this long-running operation succeeds, it will contain
// a [SuggestTrialsResponse][google.cloud.ml.v1.SuggestTrialsResponse].
- rpc SuggestTrials(SuggestTrialsRequest) returns (google.longrunning.Operation) {
+ rpc SuggestTrials(SuggestTrialsRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials:suggest"
body: "*"
@@ -156,8 +158,9 @@ service VizierService {
// Checks whether a Trial should stop or not. Returns a
// long-running operation. When the operation is successful,
// it will contain a
- // [CheckTrialEarlyStoppingStateResponse][google.cloud.ml.v1.CheckTrialEarlyStoppingStateResponse].
- rpc CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest) returns (google.longrunning.Operation) {
+ // [CheckTrialEarlyStoppingStateResponse][google.cloud.aiplatform.v1beta1.CheckTrialEarlyStoppingStateResponse].
+ rpc CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{trial_name=projects/*/locations/*/studies/*/trials/*}:checkTrialEarlyStoppingState"
body: "*"
@@ -180,7 +183,8 @@ service VizierService {
// optimal Trials for single-objective Study. The definition of
// pareto-optimal can be checked in wiki page.
// https://en.wikipedia.org/wiki/Pareto_efficiency
- rpc ListOptimalTrials(ListOptimalTrialsRequest) returns (ListOptimalTrialsResponse) {
+ rpc ListOptimalTrials(ListOptimalTrialsRequest)
+ returns (ListOptimalTrialsResponse) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials:listOptimalTrials"
body: "*"
@@ -189,7 +193,8 @@ service VizierService {
}
}
-// Request message for [VizierService.GetStudy][google.cloud.aiplatform.v1beta1.VizierService.GetStudy].
+// Request message for
+// [VizierService.GetStudy][google.cloud.aiplatform.v1beta1.VizierService.GetStudy].
message GetStudyRequest {
// Required. The name of the Study resource.
// Format: `projects/{project}/locations/{location}/studies/{study}`
@@ -201,7 +206,8 @@ message GetStudyRequest {
];
}
-// Request message for [VizierService.CreateStudy][google.cloud.aiplatform.v1beta1.VizierService.CreateStudy].
+// Request message for
+// [VizierService.CreateStudy][google.cloud.aiplatform.v1beta1.VizierService.CreateStudy].
message CreateStudyRequest {
// Required. The resource name of the Location to create the CustomJob in.
// Format: `projects/{project}/locations/{location}`
@@ -216,7 +222,8 @@ message CreateStudyRequest {
Study study = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [VizierService.ListStudies][google.cloud.aiplatform.v1beta1.VizierService.ListStudies].
+// Request message for
+// [VizierService.ListStudies][google.cloud.aiplatform.v1beta1.VizierService.ListStudies].
message ListStudiesRequest {
// Required. The resource name of the Location to list the Study from.
// Format: `projects/{project}/locations/{location}`
@@ -236,7 +243,8 @@ message ListStudiesRequest {
int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [VizierService.ListStudies][google.cloud.aiplatform.v1beta1.VizierService.ListStudies].
+// Response message for
+// [VizierService.ListStudies][google.cloud.aiplatform.v1beta1.VizierService.ListStudies].
message ListStudiesResponse {
// The studies associated with the project.
repeated Study studies = 1;
@@ -247,7 +255,8 @@ message ListStudiesResponse {
string next_page_token = 2;
}
-// Request message for [VizierService.DeleteStudy][google.cloud.aiplatform.v1beta1.VizierService.DeleteStudy].
+// Request message for
+// [VizierService.DeleteStudy][google.cloud.aiplatform.v1beta1.VizierService.DeleteStudy].
message DeleteStudyRequest {
// Required. The name of the Study resource to be deleted.
// Format: `projects/{project}/locations/{location}/studies/{study}`
@@ -259,7 +268,8 @@ message DeleteStudyRequest {
];
}
-// Request message for [VizierService.LookupStudy][google.cloud.aiplatform.v1beta1.VizierService.LookupStudy].
+// Request message for
+// [VizierService.LookupStudy][google.cloud.aiplatform.v1beta1.VizierService.LookupStudy].
message LookupStudyRequest {
// Required. The resource name of the Location to get the Study from.
// Format: `projects/{project}/locations/{location}`
@@ -274,7 +284,8 @@ message LookupStudyRequest {
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [VizierService.SuggestTrials][google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials].
+// Request message for
+// [VizierService.SuggestTrials][google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials].
message SuggestTrialsRequest {
// Required. The project and location that the Study belongs to.
// Format: `projects/{project}/locations/{location}/studies/{study}`
@@ -296,7 +307,8 @@ message SuggestTrialsRequest {
string client_id = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Response message for [VizierService.SuggestTrials][google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials].
+// Response message for
+// [VizierService.SuggestTrials][google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials].
message SuggestTrialsResponse {
// A list of Trials.
repeated Trial trials = 1;
@@ -324,7 +336,8 @@ message SuggestTrialsMetadata {
string client_id = 2;
}
-// Request message for [VizierService.CreateTrial][google.cloud.aiplatform.v1beta1.VizierService.CreateTrial].
+// Request message for
+// [VizierService.CreateTrial][google.cloud.aiplatform.v1beta1.VizierService.CreateTrial].
message CreateTrialRequest {
// Required. The resource name of the Study to create the Trial in.
// Format: `projects/{project}/locations/{location}/studies/{study}`
@@ -339,7 +352,8 @@ message CreateTrialRequest {
Trial trial = 2 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [VizierService.GetTrial][google.cloud.aiplatform.v1beta1.VizierService.GetTrial].
+// Request message for
+// [VizierService.GetTrial][google.cloud.aiplatform.v1beta1.VizierService.GetTrial].
message GetTrialRequest {
// Required. The name of the Trial resource.
// Format:
@@ -352,7 +366,8 @@ message GetTrialRequest {
];
}
-// Request message for [VizierService.ListTrials][google.cloud.aiplatform.v1beta1.VizierService.ListTrials].
+// Request message for
+// [VizierService.ListTrials][google.cloud.aiplatform.v1beta1.VizierService.ListTrials].
message ListTrialsRequest {
// Required. The resource name of the Study to list the Trial from.
// Format: `projects/{project}/locations/{location}/studies/{study}`
@@ -372,7 +387,8 @@ message ListTrialsRequest {
int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
}
-// Response message for [VizierService.ListTrials][google.cloud.aiplatform.v1beta1.VizierService.ListTrials].
+// Response message for
+// [VizierService.ListTrials][google.cloud.aiplatform.v1beta1.VizierService.ListTrials].
message ListTrialsResponse {
// The Trials associated with the Study.
repeated Trial trials = 1;
@@ -383,7 +399,8 @@ message ListTrialsResponse {
string next_page_token = 2;
}
-// Request message for [VizierService.AddTrialMeasurement][google.cloud.aiplatform.v1beta1.VizierService.AddTrialMeasurement].
+// Request message for
+// [VizierService.AddTrialMeasurement][google.cloud.aiplatform.v1beta1.VizierService.AddTrialMeasurement].
message AddTrialMeasurementRequest {
// Required. The name of the trial to add measurement.
// Format:
@@ -399,7 +416,8 @@ message AddTrialMeasurementRequest {
Measurement measurement = 3 [(google.api.field_behavior) = REQUIRED];
}
-// Request message for [VizierService.CompleteTrial][google.cloud.aiplatform.v1beta1.VizierService.CompleteTrial].
+// Request message for
+// [VizierService.CompleteTrial][google.cloud.aiplatform.v1beta1.VizierService.CompleteTrial].
message CompleteTrialRequest {
// Required. The Trial's name.
// Format:
@@ -425,7 +443,8 @@ message CompleteTrialRequest {
string infeasible_reason = 4 [(google.api.field_behavior) = OPTIONAL];
}
-// Request message for [VizierService.DeleteTrial][google.cloud.aiplatform.v1beta1.VizierService.DeleteTrial].
+// Request message for
+// [VizierService.DeleteTrial][google.cloud.aiplatform.v1beta1.VizierService.DeleteTrial].
message DeleteTrialRequest {
// Required. The Trial's name.
// Format:
@@ -438,7 +457,8 @@ message DeleteTrialRequest {
];
}
-// Request message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState].
+// Request message for
+// [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState].
message CheckTrialEarlyStoppingStateRequest {
// Required. The Trial's name.
// Format:
@@ -451,7 +471,8 @@ message CheckTrialEarlyStoppingStateRequest {
];
}
-// Response message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState].
+// Response message for
+// [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState].
message CheckTrialEarlyStoppingStateResponse {
// True if the Trial should stop.
bool should_stop = 1;
@@ -471,7 +492,8 @@ message CheckTrialEarlyStoppingStateMetatdata {
string trial = 3;
}
-// Request message for [VizierService.StopTrial][google.cloud.aiplatform.v1beta1.VizierService.StopTrial].
+// Request message for
+// [VizierService.StopTrial][google.cloud.aiplatform.v1beta1.VizierService.StopTrial].
message StopTrialRequest {
// Required. The Trial's name.
// Format:
@@ -484,7 +506,8 @@ message StopTrialRequest {
];
}
-// Request message for [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials].
+// Request message for
+// [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials].
message ListOptimalTrialsRequest {
// Required. The name of the Study that the optimal Trial belongs to.
string parent = 1 [
@@ -495,7 +518,8 @@ message ListOptimalTrialsRequest {
];
}
-// Response message for [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials].
+// Response message for
+// [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials].
message ListOptimalTrialsResponse {
// The pareto-optimal Trials for multiple objective Study or the
// optimal trial for single objective Study. The definition of
diff --git a/third_party/googleapis/google/cloud/alloydb/v1/BUILD.bazel b/third_party/googleapis/google/cloud/alloydb/v1/BUILD.bazel
new file mode 100644
index 000000000..2a3a74ccc
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1/BUILD.bazel
@@ -0,0 +1,410 @@
+# This file was automatically generated by BuildFileGenerator
+# https://github.com/googleapis/rules_gapic/tree/master/bazel
+
+# Most of the manual changes to this file will be overwritten.
+# It's **only** allowed to change the following rule attribute values:
+# - names of *_gapic_assembly_* rules
+# - certain parameters of *_gapic_library rules, including but not limited to:
+# * extra_protoc_parameters
+# * extra_protoc_file_parameters
+# The complete list of preserved parameters can be found in the source code.
+
+# This is an API workspace, having public visibility by default makes perfect sense.
+package(default_visibility = ["//visibility:public"])
+
+##############################################################################
+# Common
+##############################################################################
+load("@rules_proto//proto:defs.bzl", "proto_library")
+load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
+
+proto_library(
+ name = "alloydb_proto",
+ srcs = [
+ "resources.proto",
+ "service.proto",
+ ],
+ deps = [
+ "//google/api:annotations_proto",
+ "//google/api:client_proto",
+ "//google/api:field_behavior_proto",
+ "//google/api:resource_proto",
+ "//google/longrunning:operations_proto",
+ "//google/rpc:status_proto",
+ "//google/type:dayofweek_proto",
+ "//google/type:timeofday_proto",
+ "@com_google_protobuf//:duration_proto",
+ "@com_google_protobuf//:empty_proto",
+ "@com_google_protobuf//:field_mask_proto",
+ "@com_google_protobuf//:timestamp_proto",
+ "@com_google_protobuf//:wrappers_proto",
+ ],
+)
+
+proto_library_with_info(
+ name = "alloydb_proto_with_info",
+ deps = [
+ ":alloydb_proto",
+ "//google/cloud:common_resources_proto",
+ "//google/cloud/location:location_proto",
+ "//google/iam/v1:iam_policy_proto",
+ ],
+)
+
+##############################################################################
+# Java
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "java_gapic_assembly_gradle_pkg",
+ "java_gapic_library",
+ "java_gapic_test",
+ "java_grpc_library",
+ "java_proto_library",
+)
+
+java_proto_library(
+ name = "alloydb_java_proto",
+ deps = [":alloydb_proto"],
+)
+
+java_grpc_library(
+ name = "alloydb_java_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_java_proto"],
+)
+
+java_gapic_library(
+ name = "alloydb_java_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ gapic_yaml = None,
+ grpc_service_config = "alloydb_v1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1.yaml",
+ test_deps = [
+ "//google/cloud/location:location_java_grpc",
+ "//google/iam/v1:iam_java_grpc",
+ ":alloydb_java_grpc",
+ ],
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_java_proto",
+ "//google/api:api_java_proto",
+ "//google/cloud/location:location_java_proto",
+ "//google/iam/v1:iam_java_proto",
+ ],
+)
+
+java_gapic_test(
+ name = "alloydb_java_gapic_test_suite",
+ test_classes = [
+ "com.google.cloud.alloydb.v1.AlloyDBAdminClientHttpJsonTest",
+ "com.google.cloud.alloydb.v1.AlloyDBAdminClientTest",
+ ],
+ runtime_deps = [":alloydb_java_gapic_test"],
+)
+
+# Open Source Packages
+java_gapic_assembly_gradle_pkg(
+ name = "google-cloud-alloydb-v1-java",
+ include_samples = True,
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_java_gapic",
+ ":alloydb_java_grpc",
+ ":alloydb_java_proto",
+ ":alloydb_proto",
+ ],
+)
+
+##############################################################################
+# Go
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "go_gapic_assembly_pkg",
+ "go_gapic_library",
+ "go_proto_library",
+ "go_test",
+)
+
+go_proto_library(
+ name = "alloydb_go_proto",
+ compilers = ["@io_bazel_rules_go//proto:go_grpc"],
+ importpath = "cloud.google.com/go/alloydb/apiv1/alloydbpb",
+ protos = [":alloydb_proto"],
+ deps = [
+ "//google/api:annotations_go_proto",
+ "//google/longrunning:longrunning_go_proto",
+ "//google/rpc:status_go_proto",
+ "//google/type:dayofweek_go_proto",
+ "//google/type:timeofday_go_proto",
+ ],
+)
+
+go_gapic_library(
+ name = "alloydb_go_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ grpc_service_config = "alloydb_v1_grpc_service_config.json",
+ importpath = "cloud.google.com/go/alloydb/apiv1;alloydb",
+ metadata = True,
+ release_level = "beta",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_go_proto",
+ "//google/cloud/location:location_go_proto",
+ "//google/iam/v1:iam_go_proto",
+ "//google/longrunning:longrunning_go_proto",
+ "@com_google_cloud_go_longrunning//:go_default_library",
+ "@com_google_cloud_go_longrunning//autogen:go_default_library",
+ "@io_bazel_rules_go//proto/wkt:duration_go_proto",
+ ],
+)
+
+go_test(
+ name = "alloydb_go_gapic_test",
+ srcs = [":alloydb_go_gapic_srcjar_test"],
+ embed = [":alloydb_go_gapic"],
+ importpath = "cloud.google.com/go/alloydb/apiv1",
+)
+
+# Open Source Packages
+go_gapic_assembly_pkg(
+ name = "gapi-cloud-alloydb-v1-go",
+ deps = [
+ ":alloydb_go_gapic",
+ ":alloydb_go_gapic_srcjar-metadata.srcjar",
+ ":alloydb_go_gapic_srcjar-test.srcjar",
+ ":alloydb_go_proto",
+ ],
+)
+
+##############################################################################
+# Python
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "py_gapic_assembly_pkg",
+ "py_gapic_library",
+ "py_test",
+)
+
+py_gapic_library(
+ name = "alloydb_py_gapic",
+ srcs = [":alloydb_proto"],
+ grpc_service_config = "alloydb_v1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ "//google/iam/v1:iam_policy_py_proto",
+ ],
+)
+
+py_test(
+ name = "alloydb_py_gapic_test",
+ srcs = [
+ "alloydb_py_gapic_pytest.py",
+ "alloydb_py_gapic_test.py",
+ ],
+ legacy_create_init = False,
+ deps = [":alloydb_py_gapic"],
+)
+
+# Open Source Packages
+py_gapic_assembly_pkg(
+ name = "alloydb-v1-py",
+ deps = [
+ ":alloydb_py_gapic",
+ ],
+)
+
+##############################################################################
+# PHP
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "php_gapic_assembly_pkg",
+ "php_gapic_library",
+ "php_grpc_library",
+ "php_proto_library",
+)
+
+php_proto_library(
+ name = "alloydb_php_proto",
+ deps = [":alloydb_proto"],
+)
+
+php_grpc_library(
+ name = "alloydb_php_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_php_proto"],
+)
+
+php_gapic_library(
+ name = "alloydb_php_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ grpc_service_config = "alloydb_v1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_php_grpc",
+ ":alloydb_php_proto",
+ ],
+)
+
+# Open Source Packages
+php_gapic_assembly_pkg(
+ name = "google-cloud-alloydb-v1-php",
+ deps = [
+ ":alloydb_php_gapic",
+ ":alloydb_php_grpc",
+ ":alloydb_php_proto",
+ ],
+)
+
+##############################################################################
+# Node.js
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "nodejs_gapic_assembly_pkg",
+ "nodejs_gapic_library",
+)
+
+nodejs_gapic_library(
+ name = "alloydb_nodejs_gapic",
+ package_name = "@google-cloud/alloydb",
+ src = ":alloydb_proto_with_info",
+ extra_protoc_parameters = ["metadata"],
+ grpc_service_config = "alloydb_v1_grpc_service_config.json",
+ package = "google.cloud.alloydb.v1",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1.yaml",
+ transport = "grpc+rest",
+ deps = [],
+)
+
+nodejs_gapic_assembly_pkg(
+ name = "alloydb-v1-nodejs",
+ deps = [
+ ":alloydb_nodejs_gapic",
+ ":alloydb_proto",
+ ],
+)
+
+##############################################################################
+# Ruby
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "ruby_cloud_gapic_library",
+ "ruby_gapic_assembly_pkg",
+ "ruby_grpc_library",
+ "ruby_proto_library",
+)
+
+ruby_proto_library(
+ name = "alloydb_ruby_proto",
+ deps = [":alloydb_proto"],
+)
+
+ruby_grpc_library(
+ name = "alloydb_ruby_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_ruby_proto"],
+)
+
+ruby_cloud_gapic_library(
+ name = "alloydb_ruby_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ extra_protoc_parameters = [
+ "ruby-cloud-gem-name=google-cloud-alloydb-v1",
+ ],
+ grpc_service_config = "alloydb_v1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1.yaml",
+ deps = [
+ ":alloydb_ruby_grpc",
+ ":alloydb_ruby_proto",
+ ],
+)
+
+# Open Source Packages
+ruby_gapic_assembly_pkg(
+ name = "google-cloud-alloydb-v1-ruby",
+ deps = [
+ ":alloydb_ruby_gapic",
+ ":alloydb_ruby_grpc",
+ ":alloydb_ruby_proto",
+ ],
+)
+
+##############################################################################
+# C#
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "csharp_gapic_assembly_pkg",
+ "csharp_gapic_library",
+ "csharp_grpc_library",
+ "csharp_proto_library",
+)
+
+csharp_proto_library(
+ name = "alloydb_csharp_proto",
+ deps = [":alloydb_proto"],
+)
+
+csharp_grpc_library(
+ name = "alloydb_csharp_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_csharp_proto"],
+)
+
+csharp_gapic_library(
+ name = "alloydb_csharp_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
+ grpc_service_config = "alloydb_v1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1.yaml",
+ deps = [
+ ":alloydb_csharp_grpc",
+ ":alloydb_csharp_proto",
+ ],
+)
+
+# Open Source Packages
+csharp_gapic_assembly_pkg(
+ name = "google-cloud-alloydb-v1-csharp",
+ deps = [
+ ":alloydb_csharp_gapic",
+ ":alloydb_csharp_grpc",
+ ":alloydb_csharp_proto",
+ ],
+)
+
+##############################################################################
+# C++
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "cc_grpc_library",
+ "cc_proto_library",
+)
+
+cc_proto_library(
+ name = "alloydb_cc_proto",
+ deps = [":alloydb_proto"],
+)
+
+cc_grpc_library(
+ name = "alloydb_cc_grpc",
+ srcs = [":alloydb_proto"],
+ grpc_only = True,
+ deps = [":alloydb_cc_proto"],
+)
diff --git a/third_party/googleapis/google/cloud/alloydb/v1/alloydb_v1.yaml b/third_party/googleapis/google/cloud/alloydb/v1/alloydb_v1.yaml
new file mode 100644
index 000000000..f20d021d4
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1/alloydb_v1.yaml
@@ -0,0 +1,230 @@
+type: google.api.Service
+config_version: 3
+name: alloydb.googleapis.com
+title: AlloyDB API
+
+apis:
+- name: google.cloud.alloydb.v1.AlloyDBAdmin
+- name: google.cloud.location.Locations
+- name: google.iam.v1.IAMPolicy
+- name: google.longrunning.Operations
+
+types:
+- name: google.cloud.alloydb.v1.BatchCreateInstancesResponse
+- name: google.cloud.alloydb.v1.OperationMetadata
+
+documentation:
+ summary: |-
+ AlloyDB for PostgreSQL is an open source-compatible database service that
+ provides a powerful option for migrating, modernizing, or building
+ commercial-grade applications. It offers full compatibility with standard
+ PostgreSQL, and is more than 4x faster for transactional workloads and up
+ to 100x faster for analytical queries than standard PostgreSQL in our
+ performance tests. AlloyDB for PostgreSQL offers a 99.99 percent
+ availability SLA inclusive of maintenance.
AlloyDB is optimized
+ for the most demanding use cases, allowing you to build new applications
+ that require high transaction throughput, large database sizes, or
+ multiple read resources; scale existing PostgreSQL workloads with no
+ application changes; and modernize legacy proprietary databases.
+ rules:
+ - selector: google.cloud.location.Locations.GetLocation
+ description: Gets information about a location.
+
+ - selector: google.cloud.location.Locations.ListLocations
+ description: Lists information about the supported locations for this service.
+
+ - selector: google.iam.v1.IAMPolicy.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.
+
+ - selector: google.iam.v1.IAMPolicy.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.
+
+ - selector: google.iam.v1.IAMPolicy.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.
+
+backend:
+ rules:
+ - selector: 'google.cloud.alloydb.v1.AlloyDBAdmin.*'
+ deadline: 60.0
+ - selector: google.cloud.location.Locations.GetLocation
+ deadline: 60.0
+ - selector: google.cloud.location.Locations.ListLocations
+ deadline: 60.0
+ - selector: 'google.iam.v1.IAMPolicy.*'
+ deadline: 60.0
+ - selector: 'google.longrunning.Operations.*'
+ deadline: 60.0
+
+http:
+ rules:
+ - selector: google.cloud.location.Locations.GetLocation
+ get: '/v1/{name=projects/*/locations/*}'
+ - selector: google.cloud.location.Locations.ListLocations
+ get: '/v1/{name=projects/*}/locations'
+ - selector: google.longrunning.Operations.CancelOperation
+ post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
+ body: '*'
+ - selector: google.longrunning.Operations.DeleteOperation
+ delete: '/v1/{name=projects/*/locations/*/operations/*}'
+ - selector: google.longrunning.Operations.GetOperation
+ get: '/v1/{name=projects/*/locations/*/operations/*}'
+ - selector: google.longrunning.Operations.ListOperations
+ get: '/v1/{name=projects/*/locations/*}/operations'
+
+authentication:
+ rules:
+ - selector: 'google.cloud.alloydb.v1.AlloyDBAdmin.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: google.cloud.location.Locations.GetLocation
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: google.cloud.location.Locations.ListLocations
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: 'google.iam.v1.IAMPolicy.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: 'google.longrunning.Operations.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+
+publishing:
+ organization: CLOUD
+ new_issue_uri: 'https://issuetracker.google.com/issues/new?component=1029828'
+ documentation_uri: 'https://cloud.google.com/alloydb/docs'
+ api_short_name: 'alloydb'
+ github_label: 'api: alloydb'
+ doc_tag_prefix: 'alloydb'
+ codeowner_github_teams:
+ library_settings:
+ - version: 'google.cloud.alloydb.v1'
+ launch_stage: GA
+ rest_numeric_enums: false
+ java_settings:
+ library_package: ''
+ service_class_names:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ cpp_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ php_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ python_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ node_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ dotnet_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ ruby_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ go_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ - version: 'google.cloud.alloydb.v1beta'
+ launch_stage: BETA
+ rest_numeric_enums: false
+ java_settings:
+ library_package: ''
+ service_class_names:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ cpp_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ php_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ python_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ node_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ dotnet_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ ruby_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ go_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ - version: 'google.cloud.alloydb.v1alpha'
+ launch_stage: ALPHA
+ rest_numeric_enums: false
+ java_settings:
+ library_package: ''
+ service_class_names:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ cpp_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ php_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ python_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ node_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ dotnet_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ ruby_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ go_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
diff --git a/third_party/googleapis/google/cloud/alloydb/v1/alloydb_v1_grpc_service_config.json b/third_party/googleapis/google/cloud/alloydb/v1/alloydb_v1_grpc_service_config.json
new file mode 100644
index 000000000..b29d480d1
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1/alloydb_v1_grpc_service_config.json
@@ -0,0 +1,26 @@
+{
+ "methodConfig": [{
+ "name": [
+ { "service": "google.cloud.alloydb.v1.AlloyDBAdmin", "method": "ListClusters" },
+ { "service": "google.cloud.alloydb.v1.AlloyDBAdmin", "method": "GetCluster" },
+ { "service": "google.cloud.alloydb.v1.AlloyDBAdmin", "method": "ListInstances" },
+ { "service": "google.cloud.alloydb.v1.AlloyDBAdmin", "method": "GetInstance" },
+ { "service": "google.cloud.alloydb.v1.AlloyDBAdmin", "method": "ListBackups" },
+ { "service": "google.cloud.alloydb.v1.AlloyDBAdmin", "method": "GetBackup" },
+ { "service": "google.cloud.alloydb.v1.AlloyDBAdmin", "method": "ListSupportedDatabaseFlags" }
+ ],
+ "timeout": "60s",
+ "retryPolicy": {
+ "initialBackoff": "1s",
+ "maxBackoff": "60s",
+ "backoffMultiplier": 1.3,
+ "retryableStatusCodes": ["UNAVAILABLE"]
+ }
+ },
+ {
+ "name": [
+ { "service": "google.cloud.alloydb.v1.AlloyDBAdmin" }
+ ],
+ "timeout": "60s"
+ }]
+}
diff --git a/third_party/googleapis/google/cloud/alloydb/v1/resources.proto b/third_party/googleapis/google/cloud/alloydb/v1/resources.proto
new file mode 100644
index 000000000..86885370d
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1/resources.proto
@@ -0,0 +1,945 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.alloydb.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "google/type/dayofweek.proto";
+import "google/type/timeofday.proto";
+
+option csharp_namespace = "Google.Cloud.AlloyDb.V1";
+option go_package = "cloud.google.com/go/alloydb/apiv1/alloydbpb;alloydbpb";
+option java_multiple_files = true;
+option java_outer_classname = "ResourcesProto";
+option java_package = "com.google.cloud.alloydb.v1";
+option php_namespace = "Google\\Cloud\\AlloyDb\\V1";
+option ruby_package = "Google::Cloud::AlloyDb::V1";
+option (google.api.resource_definition) = {
+ type: "cloudkms.googleapis.com/CryptoKeyVersion"
+ pattern: "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}"
+};
+option (google.api.resource_definition) = {
+ type: "compute.googleapis.com/Network"
+ pattern: "projects/{project}/global/networks/{network}"
+};
+
+// The supported database engine versions.
+enum DatabaseVersion {
+ // This is an unknown database version.
+ DATABASE_VERSION_UNSPECIFIED = 0;
+
+ // DEPRECATED - The database version is Postgres 13.
+ POSTGRES_13 = 1 [deprecated = true];
+
+ // The database version is Postgres 14.
+ POSTGRES_14 = 2;
+}
+
+// View on Instance. Pass this enum to rpcs that returns an Instance message to
+// control which subsets of fields to get.
+enum InstanceView {
+ // INSTANCE_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
+ INSTANCE_VIEW_UNSPECIFIED = 0;
+
+ // BASIC server responses for a primary or read instance include all the
+ // relevant instance details, excluding the details of each node in the
+ // instance. The default value.
+ INSTANCE_VIEW_BASIC = 1;
+
+ // FULL response is equivalent to BASIC for primary instance (for now).
+ // For read pool instance, this includes details of each node in the pool.
+ INSTANCE_VIEW_FULL = 2;
+}
+
+// The username/password for a database user. Used for specifying initial
+// users at cluster creation time.
+message UserPassword {
+ // The database username.
+ string user = 1;
+
+ // The initial password for the user.
+ string password = 2;
+}
+
+// Subset of the source instance configuration that is available when reading
+// the cluster resource.
+message MigrationSource {
+ // Denote the type of migration source that created this cluster.
+ enum MigrationSourceType {
+ // Migration source is unknown.
+ MIGRATION_SOURCE_TYPE_UNSPECIFIED = 0;
+
+ // DMS source means the cluster was created via DMS migration job.
+ DMS = 1;
+ }
+
+ // Output only. The host and port of the on-premises instance in host:port
+ // format
+ string host_port = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Place holder for the external source identifier(e.g DMS job
+ // name) that created the cluster.
+ string reference_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Type of migration source.
+ MigrationSourceType source_type = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// EncryptionConfig describes the encryption config of a cluster or a backup
+// that is encrypted with a CMEK (customer-managed encryption key).
+message EncryptionConfig {
+ // The fully-qualified resource name of the KMS key.
+ // Each Cloud KMS key is regionalized and has the following format:
+ // projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
+ string kms_key_name = 1;
+}
+
+// EncryptionInfo describes the encryption information of a cluster or a backup.
+message EncryptionInfo {
+ // Possible encryption types.
+ enum Type {
+ // Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.
+ TYPE_UNSPECIFIED = 0;
+
+ // The data is encrypted at rest with a key that is fully managed by Google.
+ // No key version will be populated. This is the default state.
+ GOOGLE_DEFAULT_ENCRYPTION = 1;
+
+ // The data is encrypted at rest with a key that is managed by the customer.
+ // KMS key versions will be populated.
+ CUSTOMER_MANAGED_ENCRYPTION = 2;
+ }
+
+ // Output only. Type of encryption.
+ Type encryption_type = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Cloud KMS key versions that are being used to protect the
+ // database or the backup.
+ repeated string kms_key_versions = 2 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "cloudkms.googleapis.com/CryptoKeyVersion"
+ }
+ ];
+}
+
+// SSL configuration for an AlloyDB Cluster.
+message SslConfig {
+ // SSL mode options.
+ enum SslMode {
+ // SSL mode not specified. Defaults to SSL_MODE_ALLOW.
+ SSL_MODE_UNSPECIFIED = 0;
+
+ // SSL connections are optional. CA verification not enforced.
+ SSL_MODE_ALLOW = 1;
+
+ // SSL connections are required. CA verification not enforced.
+ // Clients may use locally self-signed certificates (default psql client
+ // behavior).
+ SSL_MODE_REQUIRE = 2;
+
+ // SSL connections are required. CA verification enforced.
+ // Clients must have certificates signed by a Cluster CA, e.g. via
+ // GenerateClientCertificate.
+ SSL_MODE_VERIFY_CA = 3;
+ }
+
+ // Certificate Authority (CA) source for SSL/TLS certificates.
+ enum CaSource {
+ // Certificate Authority (CA) source not specified. Defaults to
+ // CA_SOURCE_MANAGED.
+ CA_SOURCE_UNSPECIFIED = 0;
+
+ // Certificate Authority (CA) managed by the AlloyDB Cluster.
+ CA_SOURCE_MANAGED = 1;
+ }
+
+ // Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
+ SslMode ssl_mode = 1 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is
+ // supported currently, and is the default value.
+ CaSource ca_source = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message describing the user-specified automated backup policy.
+//
+// All fields in the automated backup policy are optional. Defaults for each
+// field are provided if they are not set.
+message AutomatedBackupPolicy {
+ // A weekly schedule starts a backup at prescribed start times within a
+ // day, for the specified days of the week.
+ //
+ // The weekly schedule message is flexible and can be used to create many
+ // types of schedules. For example, to have a daily backup that starts at
+ // 22:00, configure the `start_times` field to have one element "22:00" and
+ // the `days_of_week` field to have all seven days of the week.
+ message WeeklySchedule {
+ // The times during the day to start a backup. The start times are assumed
+ // to be in UTC and to be an exact hour (e.g., 04:00:00).
+ //
+ // If no start times are provided, a single fixed start time is chosen
+ // arbitrarily.
+ repeated google.type.TimeOfDay start_times = 1;
+
+ // The days of the week to perform a backup.
+ //
+ // If this field is left empty, the default of every day of the week is
+ // used.
+ repeated google.type.DayOfWeek days_of_week = 2;
+ }
+
+ // A time based retention policy specifies that all backups within a certain
+ // time period should be retained.
+ message TimeBasedRetention {
+ // The retention period.
+ google.protobuf.Duration retention_period = 1;
+ }
+
+ // A quantity based policy specifies that a certain number of the most recent
+ // successful backups should be retained.
+ message QuantityBasedRetention {
+ // The number of backups to retain.
+ int32 count = 1;
+ }
+
+ // The schedule for this automated backup policy.
+ //
+ // A schedule specifies times at which to start a backup. If a backup
+ // window is also provided, the backup is guaranteed to be started and
+ // completed within the start time plus the backup window. If the backup is
+ // not completed within the backup window it is marked as failed.
+ //
+ // If not set, the schedule defaults to a weekly schedule with one backup
+ // per day and a start time chosen arbitrarily.
+ oneof schedule {
+ // Weekly schedule for the Backup.
+ WeeklySchedule weekly_schedule = 2;
+ }
+
+ // The retention policy for automated backups.
+ //
+ // The retention policy for a backup is fixed at the time the backup is
+ // created. Changes to this field only apply to new backups taken with the
+ // policy; the retentions of existing backups remain unchanged.
+ //
+ // If no retention policy is set, a default of 14 days is used.
+ oneof retention {
+ // Time-based Backup retention policy.
+ TimeBasedRetention time_based_retention = 4;
+
+ // Quantity-based Backup retention policy to retain recent backups.
+ QuantityBasedRetention quantity_based_retention = 5;
+ }
+
+ // Whether automated automated backups are enabled. If not set, defaults to
+ // true.
+ optional bool enabled = 1;
+
+ // The length of the time window during which a backup can be
+ // taken. If a backup does not succeed within this time window, it will be
+ // canceled and considered failed.
+ //
+ // The backup window must be at least 5 minutes long. There is no upper bound
+ // on the window. If not set, it defaults to 1 hour.
+ google.protobuf.Duration backup_window = 3;
+
+ // Optional. The encryption config can be specified to encrypt the
+ // backups with a customer-managed encryption key (CMEK). When this field is
+ // not specified, the backup will then use default encryption scheme to
+ // protect the user data.
+ EncryptionConfig encryption_config = 8
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // The location where the backup will be stored. Currently, the only supported
+ // option is to store the backup in the same region as the cluster.
+ //
+ // If empty, defaults to the region of the cluster.
+ string location = 6;
+
+ // Labels to apply to backups created using this configuration.
+ map labels = 7;
+}
+
+// Message describing a BackupSource.
+message BackupSource {
+ // Output only. The system-generated UID of the backup which was used to
+ // create this resource. The UID is generated when the backup is created, and
+ // it is retained until the backup is deleted.
+ string backup_uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The name of the backup resource with the format:
+ // * projects/{project}/locations/{region}/backups/{backup_id}
+ string backup_name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Backup" }
+ ];
+}
+
+// A cluster is a collection of regional AlloyDB resources. It can include a
+// primary instance and one or more read pool instances.
+// All cluster resources share a storage layer, which scales as needed.
+message Cluster {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/Cluster"
+ pattern: "projects/{project}/locations/{location}/clusters/{cluster}"
+ style: DECLARATIVE_FRIENDLY
+ };
+
+ // Configuration information for the secondary cluster. This should be set
+ // if and only if the cluster is of type SECONDARY.
+ message SecondaryConfig {
+ // The name of the primary cluster name with the format:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}
+ string primary_cluster_name = 1;
+ }
+
+ // Configuration for the primary cluster. It has the list of clusters that are
+ // replicating from this cluster. This should be set if and only if the
+ // cluster is of type PRIMARY.
+ message PrimaryConfig {
+ // Output only. Names of the clusters that are replicating from this
+ // cluster.
+ repeated string secondary_cluster_names = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Cluster State
+ enum State {
+ // The state of the cluster is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // The cluster is active and running.
+ READY = 1;
+
+ // The cluster is stopped. All instances in the cluster are stopped.
+ // Customers can start a stopped cluster at any point and all their
+ // instances will come back to life with same names and IP resources. In
+ // this state, customer pays for storage.
+ // Associated backups could also be present in a stopped cluster.
+ STOPPED = 2;
+
+ // The cluster is empty and has no associated resources.
+ // All instances, associated storage and backups have been deleted.
+ EMPTY = 3;
+
+ // The cluster is being created.
+ CREATING = 4;
+
+ // The cluster is being deleted.
+ DELETING = 5;
+
+ // The creation of the cluster failed.
+ FAILED = 6;
+
+ // The cluster is bootstrapping with data from some other source.
+ // Direct mutations to the cluster (e.g. adding read pool) are not allowed.
+ BOOTSTRAPPING = 7;
+
+ // The cluster is under maintenance. AlloyDB regularly performs maintenance
+ // and upgrades on customer clusters. Updates on the cluster are
+ // not allowed while the cluster is in this state.
+ MAINTENANCE = 8;
+
+ // The cluster is being promoted.
+ PROMOTING = 9;
+ }
+
+ // Type of Cluster
+ enum ClusterType {
+ // The type of the cluster is unknown.
+ CLUSTER_TYPE_UNSPECIFIED = 0;
+
+ // Primary cluster that support read and write operations.
+ PRIMARY = 1;
+
+ // Secondary cluster that is replicating from another region.
+ // This only supports read.
+ SECONDARY = 2;
+ }
+
+ // In case of an imported cluster, this field contains information about the
+ // source this cluster was imported from.
+ oneof source {
+ // Output only. Cluster created from backup.
+ BackupSource backup_source = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Cluster created via DMS migration.
+ MigrationSource migration_source = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Output only. The name of the cluster resource with the format:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}
+ // where the cluster ID segment should satisfy the regex expression
+ // `[a-z0-9-]+`. For more details see https://google.aip.dev/122.
+ // The prefix of the cluster resource name is the name of the parent resource:
+ // * projects/{project}/locations/{region}
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // User-settable and human-readable display name for the Cluster.
+ string display_name = 2;
+
+ // Output only. The system-generated UID of the resource. The UID is assigned
+ // when the resource is created, and it is retained until it is deleted.
+ string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Create time stamp
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Update time stamp
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Delete time stamp
+ google.protobuf.Timestamp delete_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Labels as key value pairs
+ map labels = 7;
+
+ // Output only. The current serving state of the cluster.
+ State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The type of the cluster. This is an output-only field and it's
+ // populated at the Cluster creation time or the Cluster promotion
+ // time. The cluster type is determined by which RPC was used to create
+ // the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
+ ClusterType cluster_type = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The database engine major version. This is an output-only
+ // field and it's populated at the Cluster creation time. This field cannot be
+ // changed after cluster creation.
+ DatabaseVersion database_version = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The resource link for the VPC network in which cluster resources
+ // are created and from which they are accessible via Private IP. The network
+ // must belong to the same project as the cluster. It is specified in the
+ // form: "projects/{project_number}/global/networks/{network_id}". This is
+ // required to create a cluster. It can be updated, but it cannot be removed.
+ string network = 10 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
+ ];
+
+ // For Resource freshness validation (https://google.aip.dev/154)
+ string etag = 11;
+
+ // Annotations to allow client tools to store small amount of arbitrary data.
+ // This is distinct from labels.
+ // https://google.aip.dev/128
+ map annotations = 12;
+
+ // Output only. Reconciling (https://google.aip.dev/128#reconciliation).
+ // Set to true if the current state of Cluster does not match the user's
+ // intended state, and the service is actively updating the resource to
+ // reconcile them. This can happen due to user-triggered updates or
+ // system actions like failover or maintenance.
+ bool reconciling = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Input only. Initial user to setup during cluster creation. Required.
+ // If used in `RestoreCluster` this is ignored.
+ UserPassword initial_user = 14 [(google.api.field_behavior) = INPUT_ONLY];
+
+ // The automated backup policy for this cluster.
+ //
+ // If no policy is provided then the default policy will be used. If backups
+ // are supported for the cluster, the default policy takes one backup a day,
+ // has a backup window of 1 hour, and retains backups for 14 days.
+ // For more information on the defaults, consult the
+ // documentation for the message type.
+ AutomatedBackupPolicy automated_backup_policy = 17;
+
+ // SSL configuration for this AlloyDB Cluster.
+ SslConfig ssl_config = 18;
+
+ // Optional. The encryption config can be specified to encrypt the data disks
+ // and other persistent data resources of a cluster with a
+ // customer-managed encryption key (CMEK). When this field is not
+ // specified, the cluster will then use default encryption scheme to
+ // protect the user data.
+ EncryptionConfig encryption_config = 19
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Output only. The encryption information for the cluster.
+ EncryptionInfo encryption_info = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Cross Region replication config specific to SECONDARY cluster.
+ SecondaryConfig secondary_config = 22;
+
+ // Output only. Cross Region replication config specific to PRIMARY cluster.
+ PrimaryConfig primary_config = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// An Instance is a computing unit that an end customer can connect to.
+// It's the main unit of computing resources in AlloyDB.
+message Instance {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/Instance"
+ pattern: "projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}"
+ style: DECLARATIVE_FRIENDLY
+ };
+
+ // MachineConfig describes the configuration of a machine.
+ message MachineConfig {
+ // The number of CPU's in the VM instance.
+ int32 cpu_count = 1;
+ }
+
+ // Details of a single node in the instance.
+ // Nodes in an AlloyDB instance are ephemereal, they can change during
+ // update, failover, autohealing and resize operations.
+ message Node {
+ // The Compute Engine zone of the VM e.g. "us-central1-b".
+ string zone_id = 1;
+
+ // The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
+ string id = 2;
+
+ // The private IP address of the VM e.g. "10.57.0.34".
+ string ip = 3;
+
+ // Determined by state of the compute VM and postgres-service health.
+ // Compute VM state can have values listed in
+ // https://cloud.google.com/compute/docs/instances/instance-life-cycle and
+ // postgres-service health can have values: HEALTHY and UNHEALTHY.
+ string state = 4;
+ }
+
+ // QueryInsights Instance specific configuration.
+ message QueryInsightsInstanceConfig {
+ // Record application tags for an instance.
+ // This flag is turned "on" by default.
+ optional bool record_application_tags = 2;
+
+ // Record client address for an instance. Client address is PII information.
+ // This flag is turned "on" by default.
+ optional bool record_client_address = 3;
+
+ // Query string length. The default value is 1024.
+ // Any integer between 256 and 4500 is considered valid.
+ uint32 query_string_length = 4;
+
+ // Number of query execution plans captured by Insights per minute
+ // for all queries combined. The default value is 5.
+ // Any integer between 0 and 20 is considered valid.
+ optional uint32 query_plans_per_minute = 5;
+ }
+
+ // Configuration for a read pool instance.
+ message ReadPoolConfig {
+ // Read capacity, i.e. number of nodes in a read pool instance.
+ int32 node_count = 1;
+ }
+
+ // Instance State
+ enum State {
+ // The state of the instance is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // The instance is active and running.
+ READY = 1;
+
+ // The instance is stopped. Instance name and IP resources are preserved.
+ STOPPED = 2;
+
+ // The instance is being created.
+ CREATING = 3;
+
+ // The instance is being deleted.
+ DELETING = 4;
+
+ // The instance is down for maintenance.
+ MAINTENANCE = 5;
+
+ // The creation of the instance failed or a fatal error occurred during
+ // an operation on the instance.
+ // Note: Instances in this state would tried to be auto-repaired. And
+ // Customers should be able to restart, update or delete these instances.
+ FAILED = 6;
+
+ // Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
+ // index unused in case that state also needs to exposed via consumer apis
+ // in future.
+ // The instance has been configured to sync data from some other source.
+ BOOTSTRAPPING = 8;
+
+ // The instance is being promoted.
+ PROMOTING = 9;
+ }
+
+ // Type of an Instance
+ enum InstanceType {
+ // The type of the instance is unknown.
+ INSTANCE_TYPE_UNSPECIFIED = 0;
+
+ // PRIMARY instances support read and write operations.
+ PRIMARY = 1;
+
+ // READ POOL instances support read operations only. Each read pool instance
+ // consists of one or more homogeneous nodes.
+ // * Read pool of size 1 can only have zonal availability.
+ // * Read pools with node count of 2 or more can have regional
+ // availability (nodes are present in 2 or more zones in a region).
+ READ_POOL = 2;
+
+ // SECONDARY instances support read operations only. SECONDARY instance
+ // is a cross-region read replica
+ SECONDARY = 3;
+ }
+
+ // The Availability type of an instance. Potential values:
+ //
ZONAL: The instance serves data from only one zone.
+ // Outages in that zone affect instance availability.
+ //
REGIONAL: The instance can serve data from more than one zone
+ // in a region (it is highly available).
+ enum AvailabilityType {
+ // This is an unknown Availability type.
+ AVAILABILITY_TYPE_UNSPECIFIED = 0;
+
+ // Zonal available instance.
+ ZONAL = 1;
+
+ // Regional (or Highly) available instance.
+ REGIONAL = 2;
+ }
+
+ // Output only. The name of the instance resource with the format:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id}
+ // where the cluster and instance ID segments should satisfy the regex
+ // expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
+ // lowercase letters, numbers, and dashes, starting with a letter, and ending
+ // with a letter or number. For more details see https://google.aip.dev/122.
+ // The prefix of the instance resource name is the name of the parent
+ // resource:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // User-settable and human-readable display name for the Instance.
+ string display_name = 2;
+
+ // Output only. The system-generated UID of the resource. The UID is assigned
+ // when the resource is created, and it is retained until it is deleted.
+ string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Create time stamp
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Update time stamp
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Delete time stamp
+ google.protobuf.Timestamp delete_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Labels as key value pairs
+ map labels = 7;
+
+ // Output only. The current serving state of the instance.
+ State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The type of the instance. Specified at creation time.
+ InstanceType instance_type = 9 [(google.api.field_behavior) = REQUIRED];
+
+ // Configurations for the machines that host the underlying
+ // database engine.
+ MachineConfig machine_config = 10;
+
+ // Availability type of an Instance.
+ // Defaults to REGIONAL for both primary and read instances.
+ // Note that primary and read instances can have different availability types.
+ AvailabilityType availability_type = 11;
+
+ // The Compute Engine zone that the instance should serve from, per
+ // https://cloud.google.com/compute/docs/regions-zones
+ // This can ONLY be specified for ZONAL instances.
+ // If present for a REGIONAL instance, an error will be thrown.
+ // If this is absent for a ZONAL instance, instance is created in a random
+ // zone with available capacity.
+ string gce_zone = 12;
+
+ // Database flags. Set at instance level.
+ // * They are copied from primary instance on read instance creation.
+ // * Read instances can set new or override existing flags that are relevant
+ // for reads, e.g. for enabling columnar cache on a read instance. Flags
+ // set on read instance may or may not be present on primary.
+ //
+ //
+ // This is a list of "key": "value" pairs.
+ // "key": The name of the flag. These flags are passed at instance setup time,
+ // so include both server options and system variables for Postgres. Flags are
+ // specified with underscores, not hyphens.
+ // "value": 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.
+ map database_flags = 13;
+
+ // Output only. This is set for the read-write VM of the PRIMARY instance
+ // only.
+ Node writable_node = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. List of available read-only VMs in this instance, including
+ // the standby for a PRIMARY instance.
+ repeated Node nodes = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Configuration for query insights.
+ QueryInsightsInstanceConfig query_insights_config = 21;
+
+ // Read pool specific config.
+ ReadPoolConfig read_pool_config = 14;
+
+ // Output only. The IP address for the Instance.
+ // This is the connection endpoint for an end-user application.
+ string ip_address = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Reconciling (https://google.aip.dev/128#reconciliation).
+ // Set to true if the current state of Instance does not match the user's
+ // intended state, and the service is actively updating the resource to
+ // reconcile them. This can happen due to user-triggered updates or
+ // system actions like failover or maintenance.
+ bool reconciling = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // For Resource freshness validation (https://google.aip.dev/154)
+ string etag = 17;
+
+ // Annotations to allow client tools to store small amount of arbitrary data.
+ // This is distinct from labels.
+ // https://google.aip.dev/128
+ map annotations = 18;
+}
+
+// Message describing Backup object
+message Backup {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/Backup"
+ pattern: "projects/{project}/locations/{location}/backups/{backup}"
+ style: DECLARATIVE_FRIENDLY
+ };
+
+ // Backup State
+ enum State {
+ // The state of the backup is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // The backup is ready.
+ READY = 1;
+
+ // The backup is creating.
+ CREATING = 2;
+
+ // The backup failed.
+ FAILED = 3;
+
+ // The backup is being deleted.
+ DELETING = 4;
+ }
+
+ // Backup Type
+ enum Type {
+ // Backup Type is unknown.
+ TYPE_UNSPECIFIED = 0;
+
+ // ON_DEMAND backups that were triggered by the customer (e.g., not
+ // AUTOMATED).
+ ON_DEMAND = 1;
+
+ // AUTOMATED backups triggered by the automated backups scheduler pursuant
+ // to an automated backup policy.
+ AUTOMATED = 2;
+
+ // CONTINUOUS backups triggered by the automated backups scheduler
+ // due to a continuous backup policy.
+ CONTINUOUS = 3;
+ }
+
+ // Output only. The name of the backup resource with the format:
+ // * projects/{project}/locations/{region}/backups/{backup_id}
+ // where the cluster and backup ID segments should satisfy the regex
+ // expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
+ // lowercase letters, numbers, and dashes, starting with a letter, and ending
+ // with a letter or number. For more details see https://google.aip.dev/122.
+ // The prefix of the backup resource name is the name of the parent
+ // resource:
+ // * projects/{project}/locations/{region}
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // User-settable and human-readable display name for the Backup.
+ string display_name = 2;
+
+ // Output only. The system-generated UID of the resource. The UID is assigned
+ // when the resource is created, and it is retained until it is deleted.
+ string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Create time stamp
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Update time stamp
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Delete time stamp
+ google.protobuf.Timestamp delete_time = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Labels as key value pairs
+ map labels = 6;
+
+ // Output only. The current state of the backup.
+ State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The backup type, which suggests the trigger for the backup.
+ Type type = 8;
+
+ // User-provided description of the backup.
+ string description = 9;
+
+ // Output only. The system-generated UID of the cluster which was used to
+ // create this resource.
+ string cluster_uid = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The full resource name of the backup source cluster
+ // (e.g., projects//locations//clusters/).
+ string cluster_name = 10 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+
+ // Output only. Reconciling (https://google.aip.dev/128#reconciliation), if
+ // true, indicates that the service is actively updating the resource. This
+ // can happen due to user-triggered updates or system actions like failover or
+ // maintenance.
+ bool reconciling = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Optional. The encryption config can be specified to encrypt the
+ // backup with a customer-managed encryption key (CMEK). When this field is
+ // not specified, the backup will then use default encryption scheme to
+ // protect the user data.
+ EncryptionConfig encryption_config = 12
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Output only. The encryption information for the backup.
+ EncryptionInfo encryption_info = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // For Resource freshness validation (https://google.aip.dev/154)
+ string etag = 14;
+
+ // Annotations to allow client tools to store small amount of arbitrary data.
+ // This is distinct from labels.
+ // https://google.aip.dev/128
+ map annotations = 16;
+
+ // Output only. The size of the backup in bytes.
+ int64 size_bytes = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time at which after the backup is eligible to be garbage
+ // collected. It is the duration specified by the backup's retention policy,
+ // added to the backup's create_time.
+ google.protobuf.Timestamp expiry_time = 19
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// SupportedDatabaseFlag gives general information about a database flag,
+// like type and allowed values. This is a static value that is defined
+// on the server side, and it cannot be modified by callers.
+// To set the Database flags on a particular Instance, a caller should modify
+// the Instance.database_flags field.
+message SupportedDatabaseFlag {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/SupportedDatabaseFlag"
+ pattern: "projects/{project}/locations/{location}/flags/{flag}"
+ };
+
+ // Restrictions on STRING type values
+ message StringRestrictions {
+ // The list of allowed values, if bounded. This field will be empty
+ // if there is a unbounded number of allowed values.
+ repeated string allowed_values = 1;
+ }
+
+ // Restrictions on INTEGER type values.
+ message IntegerRestrictions {
+ // The minimum value that can be specified, if applicable.
+ google.protobuf.Int64Value min_value = 1;
+
+ // The maximum value that can be specified, if applicable.
+ google.protobuf.Int64Value max_value = 2;
+ }
+
+ // ValueType describes the semantic type of the value that the flag accepts.
+ // Regardless of the ValueType, the Instance.database_flags field accepts the
+ // stringified version of the value, i.e. "20" or "3.14".
+ enum ValueType {
+ // This is an unknown flag type.
+ VALUE_TYPE_UNSPECIFIED = 0;
+
+ // String type flag.
+ STRING = 1;
+
+ // Integer type flag.
+ INTEGER = 2;
+
+ // Float type flag.
+ FLOAT = 3;
+
+ // Denotes that the flag does not accept any values.
+ NONE = 4;
+ }
+
+ // The restrictions on the flag value per type.
+ oneof restrictions {
+ // Restriction on STRING type value.
+ StringRestrictions string_restrictions = 7;
+
+ // Restriction on INTEGER type value.
+ IntegerRestrictions integer_restrictions = 8;
+ }
+
+ // The name of the flag resource, following Google Cloud conventions, e.g.:
+ // * projects/{project}/locations/{location}/flags/{flag}
+ // This field currently has no semantic meaning.
+ string name = 1;
+
+ // The name of the database flag, e.g. "max_allowed_packets".
+ // The is a possibly key for the Instance.database_flags map field.
+ string flag_name = 2;
+
+ ValueType value_type = 3;
+
+ // Whether the database flag accepts multiple values. If true,
+ // a comma-separated list of stringified values may be specified.
+ bool accepts_multiple_values = 4;
+
+ // Major database engine versions for which this flag is supported.
+ repeated DatabaseVersion supported_db_versions = 5;
+
+ // Whether setting or updating this flag on an Instance requires a database
+ // restart. If a flag that requires database restart is set, the backend
+ // will automatically restart the database (making sure to satisfy any
+ // availability SLO's).
+ bool requires_db_restart = 6;
+}
diff --git a/third_party/googleapis/google/cloud/alloydb/v1/service.proto b/third_party/googleapis/google/cloud/alloydb/v1/service.proto
new file mode 100644
index 000000000..faba39ad8
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1/service.proto
@@ -0,0 +1,1072 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.alloydb.v1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/alloydb/v1/resources.proto";
+import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
+import "google/rpc/status.proto";
+
+option csharp_namespace = "Google.Cloud.AlloyDb.V1";
+option go_package = "cloud.google.com/go/alloydb/apiv1/alloydbpb;alloydbpb";
+option java_multiple_files = true;
+option java_outer_classname = "ServiceProto";
+option java_package = "com.google.cloud.alloydb.v1";
+option php_namespace = "Google\\Cloud\\AlloyDb\\V1";
+option ruby_package = "Google::Cloud::AlloyDb::V1";
+
+// Service describing handlers for resources
+service AlloyDBAdmin {
+ option (google.api.default_host) = "alloydb.googleapis.com";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
+
+ // Lists Clusters in a given project and location.
+ rpc ListClusters(ListClustersRequest) returns (ListClustersResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=projects/*/locations/*}/clusters"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Gets details of a single Cluster.
+ rpc GetCluster(GetClusterRequest) returns (Cluster) {
+ option (google.api.http) = {
+ get: "/v1/{name=projects/*/locations/*/clusters/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Creates a new Cluster in a given project and location.
+ rpc CreateCluster(CreateClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*}/clusters"
+ body: "cluster"
+ };
+ option (google.api.method_signature) = "parent,cluster,cluster_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Updates the parameters of a single Cluster.
+ rpc UpdateCluster(UpdateClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ patch: "/v1/{cluster.name=projects/*/locations/*/clusters/*}"
+ body: "cluster"
+ };
+ option (google.api.method_signature) = "cluster,update_mask";
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Deletes a single Cluster.
+ rpc DeleteCluster(DeleteClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1/{name=projects/*/locations/*/clusters/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Creates a new Cluster in a given project and location, with a volume
+ // restored from the provided source, either a backup ID or a point-in-time
+ // and a source cluster.
+ rpc RestoreCluster(RestoreClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*}/clusters:restore"
+ body: "*"
+ };
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Lists Instances in a given project and location.
+ rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=projects/*/locations/*/clusters/*}/instances"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Gets details of a single Instance.
+ rpc GetInstance(GetInstanceRequest) returns (Instance) {
+ option (google.api.http) = {
+ get: "/v1/{name=projects/*/locations/*/clusters/*/instances/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Creates a new Instance in a given project and location.
+ rpc CreateInstance(CreateInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*/clusters/*}/instances"
+ body: "instance"
+ };
+ option (google.api.method_signature) = "parent,instance,instance_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Creates new instances under the given project, location and cluster.
+ // There can be only one primary instance in a cluster. If the primary
+ // instance exists in the cluster as well as this request, then API will
+ // throw an error.
+ // The primary instance should exist before any read pool instance is
+ // created. If the primary instance is a part of the request payload, then
+ // the API will take care of creating instances in the correct order.
+ // This method is here to support Google-internal use cases, and is not meant
+ // for external customers to consume. Please do not start relying on it; its
+ // behavior is subject to change without notice.
+ rpc BatchCreateInstances(BatchCreateInstancesRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*/clusters/*}/instances:batchCreate"
+ body: "requests"
+ };
+ option (google.longrunning.operation_info) = {
+ response_type: "BatchCreateInstancesResponse"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Updates the parameters of a single Instance.
+ rpc UpdateInstance(UpdateInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ patch: "/v1/{instance.name=projects/*/locations/*/clusters/*/instances/*}"
+ body: "instance"
+ };
+ option (google.api.method_signature) = "instance,update_mask";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Deletes a single Instance.
+ rpc DeleteInstance(DeleteInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1/{name=projects/*/locations/*/clusters/*/instances/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Forces a Failover for a highly available instance.
+ // Failover promotes the HA standby instance as the new primary.
+ // Imperative only.
+ rpc FailoverInstance(FailoverInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1/{name=projects/*/locations/*/clusters/*/instances/*}:failover"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Restart an Instance in a cluster.
+ // Imperative only.
+ rpc RestartInstance(RestartInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1/{name=projects/*/locations/*/clusters/*/instances/*}:restart"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Lists Backups in a given project and location.
+ rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=projects/*/locations/*}/backups"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Gets details of a single Backup.
+ rpc GetBackup(GetBackupRequest) returns (Backup) {
+ option (google.api.http) = {
+ get: "/v1/{name=projects/*/locations/*/backups/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Creates a new Backup in a given project and location.
+ rpc CreateBackup(CreateBackupRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*}/backups"
+ body: "backup"
+ };
+ option (google.api.method_signature) = "parent,backup,backup_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Backup"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Updates the parameters of a single Backup.
+ rpc UpdateBackup(UpdateBackupRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ patch: "/v1/{backup.name=projects/*/locations/*/backups/*}"
+ body: "backup"
+ };
+ option (google.api.method_signature) = "backup,update_mask";
+ option (google.longrunning.operation_info) = {
+ response_type: "Backup"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Deletes a single Backup.
+ rpc DeleteBackup(DeleteBackupRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1/{name=projects/*/locations/*/backups/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Lists SupportedDatabaseFlags for a given project and location.
+ rpc ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest)
+ returns (ListSupportedDatabaseFlagsResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=projects/*/locations/*}/supportedDatabaseFlags"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+}
+
+// Message for requesting list of Clusters
+message ListClustersRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Cluster.name field. Additionally, you can perform an
+ // aggregated list operation by specifying a value with the following format:
+ // * projects/{project}/locations/-
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Cluster"
+ }
+ ];
+
+ // Optional. Requested page size. Server may return fewer items than
+ // requested. If unspecified, server will pick an appropriate default.
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+
+ // Optional. Filtering results
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Hint for how to order the results
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for response to listing Clusters
+message ListClustersResponse {
+ // The list of Cluster
+ repeated Cluster clusters = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+
+ // Locations that could not be reached.
+ repeated string unreachable = 3;
+}
+
+// Message for getting a Cluster
+message GetClusterRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+}
+
+// Message for creating a Cluster
+message CreateClusterRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Cluster"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the create
+ // request.
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for updating a Cluster
+message UpdateClusterRequest {
+ // Optional. Field mask is used to specify the fields to be overwritten in the
+ // Cluster resource by the update.
+ // The fields specified in the update_mask are relative to the resource, not
+ // the full request. A field will be overwritten if it is in the mask. If the
+ // user does not provide a mask then all fields will be overwritten.
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The resource being updated
+ Cluster cluster = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the update
+ // request.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set to true, update succeeds even if cluster is not found. In
+ // that case, a new cluster is created and `update_mask` is ignored.
+ bool allow_missing = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for deleting a Cluster
+message DeleteClusterRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The current etag of the Cluster.
+ // If an etag is provided and does not match the current etag of the Cluster,
+ // deletion will be blocked and an ABORTED error will be returned.
+ string etag = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the delete.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Whether to cascade delete child instances for given cluster.
+ bool force = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for restoring a Cluster from a backup or another cluster at a given
+// point in time.
+message RestoreClusterRequest {
+ // Required.
+ // The source to import from.
+ oneof source {
+ // Backup source.
+ BackupSource backup_source = 4;
+ }
+
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Cluster"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 5 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the import
+ // request.
+ bool validate_only = 6 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for requesting list of Instances
+message ListInstancesRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Instance.name field. Additionally, you can perform an
+ // aggregated list operation by specifying a value with one of the following
+ // formats:
+ // * projects/{project}/locations/-/clusters/-
+ // * projects/{project}/locations/{region}/clusters/-
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. Requested page size. Server may return fewer items than
+ // requested. If unspecified, server will pick an appropriate default.
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+
+ // Optional. Filtering results
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Hint for how to order the results
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for response to listing Instances
+message ListInstancesResponse {
+ // The list of Instance
+ repeated Instance instances = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+
+ // Locations that could not be reached.
+ repeated string unreachable = 3;
+}
+
+// Message for getting a Instance
+message GetInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // The view of the instance to return.
+ InstanceView view = 2;
+}
+
+// Message for creating a Instance
+message CreateInstanceRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Instance.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Instance instance = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the create
+ // request.
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// See usage below for notes.
+message CreateInstanceRequests {
+ // Required. Primary and read replica instances to be created. This list
+ // should not be empty.
+ repeated CreateInstanceRequest create_instance_requests = 1
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Message for creating a batch of instances under the specified cluster.
+message BatchCreateInstancesRequest {
+ // Required. The name of the parent resource.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Required. Resources being created.
+ CreateInstanceRequests requests = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for creating batches of instances in a cluster.
+message BatchCreateInstancesResponse {
+ // Created instances.
+ repeated Instance instances = 1;
+}
+
+// Message for metadata that is specific to BatchCreateInstances API.
+message BatchCreateInstancesMetadata {
+ // The instances being created in the API call. Each string in this list
+ // is the server defined resource path for target instances in the request
+ // and for the format of each string, see the comment on the Instance.name
+ // field.
+ repeated string instance_targets = 1;
+
+ // A map representing state of the instances involved in the
+ // BatchCreateInstances operation during the operation execution.
+ // The instance state will be in STATE_UNSPECIFIED state if the instance has
+ // not yet been picked up for processing.
+ // The key of the map is the name of the instance resource.
+ // For the format, see the comment on the Instance.name field.
+ map instance_statuses = 2;
+}
+
+// Message for current status of an instance in the BatchCreateInstances
+// operation.
+// For example, lets say a BatchCreateInstances workflow has 4 instances,
+// Instance1 through Instance4. Lets also assume that 2 instances succeeded
+// but the third failed to create and the 4th was never picked up for creation
+// because of failure of the previous one. Then, resulting states would look
+// something like:
+// 1. Instance1 = ROLLED_BACK
+// 2. Instance2 = ROLLED_BACK
+// 3. Instance3 = FAILED
+// 4. Instance4 = FAILED
+// However, while the operation is running, the instance might be in other
+// states including PENDING_CREATE, ACTIVE, DELETING and CREATING. The states
+// / do not get further updated once the operation is done.
+message BatchCreateInstanceStatus {
+ // State contains all valid instance states for the BatchCreateInstances
+ // operation. This is mainly used for status reporting through the LRO
+ // metadata.
+ enum State {
+ // The state of the instance is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // Instance is pending creation and has not yet been picked up for
+ // processsing in the backend.
+ PENDING_CREATE = 1;
+
+ // The instance is active and running.
+ READY = 2;
+
+ // The instance is being created.
+ CREATING = 3;
+
+ // The instance is being deleted.
+ DELETING = 4;
+
+ // The creation of the instance failed or a fatal error occurred during
+ // an operation on the instance or a batch of instances.
+ FAILED = 5;
+
+ // The instance was created successfully, but was rolled back and deleted
+ // due to some other failure during BatchCreateInstances operation.
+ ROLLED_BACK = 6;
+ }
+
+ // The current state of an instance involved in the batch create operation.
+ // Once the operation is complete, the final state of the instances in the
+ // LRO can be one of:
+ // 1. ACTIVE, indicating that instances were created successfully
+ // 2. FAILED, indicating that a particular instance failed creation
+ // 3. ROLLED_BACK indicating that although the instance was created
+ // successfully, it had to be rolled back and deleted due to failure in
+ // other steps of the workflow.
+ State state = 1;
+
+ // DEPRECATED - Use the error field instead.
+ // Error, if any error occurred and is available, during instance creation.
+ string error_msg = 2;
+
+ // The RPC status of the instance creation operation. This field will be
+ // present if an error happened during the instance creation.
+ google.rpc.Status error = 4;
+
+ Instance.InstanceType type = 3;
+}
+
+// Message for updating a Instance
+message UpdateInstanceRequest {
+ // Optional. Field mask is used to specify the fields to be overwritten in the
+ // Instance resource by the update.
+ // The fields specified in the update_mask are relative to the resource, not
+ // the full request. A field will be overwritten if it is in the mask. If the
+ // user does not provide a mask then all fields will be overwritten.
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The resource being updated
+ Instance instance = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the update
+ // request.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set to true, update succeeds even if instance is not found. In
+ // that case, a new instance is created and `update_mask` is ignored.
+ bool allow_missing = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for deleting a Instance
+message DeleteInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The current etag of the Instance.
+ // If an etag is provided and does not match the current etag of the Instance,
+ // deletion will be blocked and an ABORTED error will be returned.
+ string etag = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the delete.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for triggering failover on an Instance
+message FailoverInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the failover.
+ bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+message RestartInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the restart.
+ bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for requesting list of Backups
+message ListBackupsRequest {
+ // Required. Parent value for ListBackupsRequest
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Backup"
+ }
+ ];
+
+ // Requested page size. Server may return fewer items than requested.
+ // If unspecified, server will pick an appropriate default.
+ int32 page_size = 2;
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+
+ // Filtering results
+ string filter = 4;
+
+ // Hint for how to order the results
+ string order_by = 5;
+}
+
+// Message for response to listing Backups
+message ListBackupsResponse {
+ // The list of Backup
+ repeated Backup backups = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+
+ // Locations that could not be reached.
+ repeated string unreachable = 3;
+}
+
+// Message for getting a Backup
+message GetBackupRequest {
+ // Required. Name of the resource
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Backup" }
+ ];
+}
+
+// Message for creating a Backup
+message CreateBackupRequest {
+ // Required. Value for parent.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Backup"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string backup_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Backup backup = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, the backend validates the request, but doesn't actually
+ // execute it.
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for updating a Backup
+message UpdateBackupRequest {
+ // Optional. Field mask is used to specify the fields to be overwritten in the
+ // Backup resource by the update.
+ // The fields specified in the update_mask are relative to the resource, not
+ // the full request. A field will be overwritten if it is in the mask. If the
+ // user does not provide a mask then all fields will be overwritten.
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The resource being updated
+ Backup backup = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, the backend validates the request, but doesn't actually
+ // execute it.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set to true, update succeeds even if instance is not found. In
+ // that case, a new backup is created and `update_mask` is ignored.
+ bool allow_missing = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for deleting a Backup
+message DeleteBackupRequest {
+ // Required. Name of the resource. For the required format, see the comment on
+ // the Backup.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Backup" }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, the backend validates the request, but doesn't actually
+ // execute it.
+ bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The current etag of the Backup.
+ // If an etag is provided and does not match the current etag of the Backup,
+ // deletion will be blocked and an ABORTED error will be returned.
+ string etag = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for listing the information about the supported Database flags.
+message ListSupportedDatabaseFlagsRequest {
+ // Required. The name of the parent resource. The required format is:
+ // * projects/{project}/locations/{location}
+ //
+ // Regardless of the parent specified here, as long it is contains a valid
+ // project and location, the service will return a static list of supported
+ // flags resources. Note that we do not yet support region-specific
+ // flags.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/SupportedDatabaseFlag"
+ }
+ ];
+
+ // Requested page size. Server may return fewer items than requested.
+ // If unspecified, server will pick an appropriate default.
+ int32 page_size = 2;
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+}
+
+// Message for response to listing SupportedDatabaseFlags.
+message ListSupportedDatabaseFlagsResponse {
+ // The list of SupportedDatabaseFlags.
+ repeated SupportedDatabaseFlag supported_database_flags = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+}
+
+// Represents the metadata of the long-running operation.
+message OperationMetadata {
+ // Request specific metadata, if any.
+ oneof request_specific {
+ // Output only. BatchCreateInstances related metadata.
+ BatchCreateInstancesMetadata batch_create_instances_metadata = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Output only. The time the operation was created.
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time the operation finished running.
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Server-defined resource path for the target of the operation.
+ string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Name of the verb executed by the operation.
+ string verb = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Human-readable status of the operation, if any.
+ string status_message = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Identifies whether the user has requested cancellation
+ // of the operation. Operations that have successfully been cancelled
+ // have [Operation.error][] value with a
+ // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
+ // `Code.CANCELLED`.
+ bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. API version used to start the operation.
+ string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/cloud/alloydb/v1alpha/BUILD.bazel b/third_party/googleapis/google/cloud/alloydb/v1alpha/BUILD.bazel
new file mode 100644
index 000000000..c8ac70113
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1alpha/BUILD.bazel
@@ -0,0 +1,410 @@
+# This file was automatically generated by BuildFileGenerator
+# https://github.com/googleapis/rules_gapic/tree/master/bazel
+
+# Most of the manual changes to this file will be overwritten.
+# It's **only** allowed to change the following rule attribute values:
+# - names of *_gapic_assembly_* rules
+# - certain parameters of *_gapic_library rules, including but not limited to:
+# * extra_protoc_parameters
+# * extra_protoc_file_parameters
+# The complete list of preserved parameters can be found in the source code.
+
+# This is an API workspace, having public visibility by default makes perfect sense.
+package(default_visibility = ["//visibility:public"])
+
+##############################################################################
+# Common
+##############################################################################
+load("@rules_proto//proto:defs.bzl", "proto_library")
+load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
+
+proto_library(
+ name = "alloydb_proto",
+ srcs = [
+ "resources.proto",
+ "service.proto",
+ ],
+ deps = [
+ "//google/api:annotations_proto",
+ "//google/api:client_proto",
+ "//google/api:field_behavior_proto",
+ "//google/api:resource_proto",
+ "//google/longrunning:operations_proto",
+ "//google/rpc:status_proto",
+ "//google/type:dayofweek_proto",
+ "//google/type:timeofday_proto",
+ "@com_google_protobuf//:duration_proto",
+ "@com_google_protobuf//:empty_proto",
+ "@com_google_protobuf//:field_mask_proto",
+ "@com_google_protobuf//:timestamp_proto",
+ "@com_google_protobuf//:wrappers_proto",
+ ],
+)
+
+proto_library_with_info(
+ name = "alloydb_proto_with_info",
+ deps = [
+ ":alloydb_proto",
+ "//google/cloud:common_resources_proto",
+ "//google/cloud/location:location_proto",
+ "//google/iam/v1:iam_policy_proto",
+ ],
+)
+
+##############################################################################
+# Java
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "java_gapic_assembly_gradle_pkg",
+ "java_gapic_library",
+ "java_gapic_test",
+ "java_grpc_library",
+ "java_proto_library",
+)
+
+java_proto_library(
+ name = "alloydb_java_proto",
+ deps = [":alloydb_proto"],
+)
+
+java_grpc_library(
+ name = "alloydb_java_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_java_proto"],
+)
+
+java_gapic_library(
+ name = "alloydb_java_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ gapic_yaml = None,
+ grpc_service_config = "alloydb_v1alpha_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1alpha.yaml",
+ test_deps = [
+ "//google/cloud/location:location_java_grpc",
+ "//google/iam/v1:iam_java_grpc",
+ ":alloydb_java_grpc",
+ ],
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_java_proto",
+ "//google/api:api_java_proto",
+ "//google/cloud/location:location_java_proto",
+ "//google/iam/v1:iam_java_proto",
+ ],
+)
+
+java_gapic_test(
+ name = "alloydb_java_gapic_test_suite",
+ test_classes = [
+ "com.google.cloud.alloydb.v1alpha.AlloyDBAdminClientHttpJsonTest",
+ "com.google.cloud.alloydb.v1alpha.AlloyDBAdminClientTest",
+ ],
+ runtime_deps = [":alloydb_java_gapic_test"],
+)
+
+# Open Source Packages
+java_gapic_assembly_gradle_pkg(
+ name = "google-cloud-alloydb-v1alpha-java",
+ include_samples = True,
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_java_gapic",
+ ":alloydb_java_grpc",
+ ":alloydb_java_proto",
+ ":alloydb_proto",
+ ],
+)
+
+##############################################################################
+# Go
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "go_gapic_assembly_pkg",
+ "go_gapic_library",
+ "go_proto_library",
+ "go_test",
+)
+
+go_proto_library(
+ name = "alloydb_go_proto",
+ compilers = ["@io_bazel_rules_go//proto:go_grpc"],
+ importpath = "cloud.google.com/go/alloydb/apiv1alpha/alloydbpb",
+ protos = [":alloydb_proto"],
+ deps = [
+ "//google/api:annotations_go_proto",
+ "//google/longrunning:longrunning_go_proto",
+ "//google/rpc:status_go_proto",
+ "//google/type:dayofweek_go_proto",
+ "//google/type:timeofday_go_proto",
+ ],
+)
+
+go_gapic_library(
+ name = "alloydb_go_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ grpc_service_config = "alloydb_v1alpha_grpc_service_config.json",
+ importpath = "cloud.google.com/go/alloydb/apiv1alpha;alloydb",
+ metadata = True,
+ release_level = "beta",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1alpha.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_go_proto",
+ "//google/cloud/location:location_go_proto",
+ "//google/iam/v1:iam_go_proto",
+ "//google/longrunning:longrunning_go_proto",
+ "@com_google_cloud_go_longrunning//:go_default_library",
+ "@com_google_cloud_go_longrunning//autogen:go_default_library",
+ "@io_bazel_rules_go//proto/wkt:duration_go_proto",
+ ],
+)
+
+go_test(
+ name = "alloydb_go_gapic_test",
+ srcs = [":alloydb_go_gapic_srcjar_test"],
+ embed = [":alloydb_go_gapic"],
+ importpath = "cloud.google.com/go/alloydb/apiv1alpha",
+)
+
+# Open Source Packages
+go_gapic_assembly_pkg(
+ name = "gapi-cloud-alloydb-v1alpha-go",
+ deps = [
+ ":alloydb_go_gapic",
+ ":alloydb_go_gapic_srcjar-metadata.srcjar",
+ ":alloydb_go_gapic_srcjar-test.srcjar",
+ ":alloydb_go_proto",
+ ],
+)
+
+##############################################################################
+# Python
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "py_gapic_assembly_pkg",
+ "py_gapic_library",
+ "py_test",
+)
+
+py_gapic_library(
+ name = "alloydb_py_gapic",
+ srcs = [":alloydb_proto"],
+ grpc_service_config = "alloydb_v1alpha_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1alpha.yaml",
+ transport = "grpc+rest",
+ deps = [
+ "//google/iam/v1:iam_policy_py_proto",
+ ],
+)
+
+py_test(
+ name = "alloydb_py_gapic_test",
+ srcs = [
+ "alloydb_py_gapic_pytest.py",
+ "alloydb_py_gapic_test.py",
+ ],
+ legacy_create_init = False,
+ deps = [":alloydb_py_gapic"],
+)
+
+# Open Source Packages
+py_gapic_assembly_pkg(
+ name = "alloydb-v1alpha-py",
+ deps = [
+ ":alloydb_py_gapic",
+ ],
+)
+
+##############################################################################
+# PHP
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "php_gapic_assembly_pkg",
+ "php_gapic_library",
+ "php_grpc_library",
+ "php_proto_library",
+)
+
+php_proto_library(
+ name = "alloydb_php_proto",
+ deps = [":alloydb_proto"],
+)
+
+php_grpc_library(
+ name = "alloydb_php_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_php_proto"],
+)
+
+php_gapic_library(
+ name = "alloydb_php_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ grpc_service_config = "alloydb_v1alpha_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1alpha.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_php_grpc",
+ ":alloydb_php_proto",
+ ],
+)
+
+# Open Source Packages
+php_gapic_assembly_pkg(
+ name = "google-cloud-alloydb-v1alpha-php",
+ deps = [
+ ":alloydb_php_gapic",
+ ":alloydb_php_grpc",
+ ":alloydb_php_proto",
+ ],
+)
+
+##############################################################################
+# Node.js
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "nodejs_gapic_assembly_pkg",
+ "nodejs_gapic_library",
+)
+
+nodejs_gapic_library(
+ name = "alloydb_nodejs_gapic",
+ package_name = "@google-cloud/alloydb",
+ src = ":alloydb_proto_with_info",
+ extra_protoc_parameters = ["metadata"],
+ grpc_service_config = "alloydb_v1alpha_grpc_service_config.json",
+ package = "google.cloud.alloydb.v1alpha",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1alpha.yaml",
+ transport = "grpc+rest",
+ deps = [],
+)
+
+nodejs_gapic_assembly_pkg(
+ name = "alloydb-v1alpha-nodejs",
+ deps = [
+ ":alloydb_nodejs_gapic",
+ ":alloydb_proto",
+ ],
+)
+
+##############################################################################
+# Ruby
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "ruby_cloud_gapic_library",
+ "ruby_gapic_assembly_pkg",
+ "ruby_grpc_library",
+ "ruby_proto_library",
+)
+
+ruby_proto_library(
+ name = "alloydb_ruby_proto",
+ deps = [":alloydb_proto"],
+)
+
+ruby_grpc_library(
+ name = "alloydb_ruby_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_ruby_proto"],
+)
+
+ruby_cloud_gapic_library(
+ name = "alloydb_ruby_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ extra_protoc_parameters = [
+ "ruby-cloud-gem-name=google-cloud-alloydb-v1alpha",
+ ],
+ grpc_service_config = "alloydb_v1alpha_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1alpha.yaml",
+ deps = [
+ ":alloydb_ruby_grpc",
+ ":alloydb_ruby_proto",
+ ],
+)
+
+# Open Source Packages
+ruby_gapic_assembly_pkg(
+ name = "google-cloud-alloydb-v1alpha-ruby",
+ deps = [
+ ":alloydb_ruby_gapic",
+ ":alloydb_ruby_grpc",
+ ":alloydb_ruby_proto",
+ ],
+)
+
+##############################################################################
+# C#
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "csharp_gapic_assembly_pkg",
+ "csharp_gapic_library",
+ "csharp_grpc_library",
+ "csharp_proto_library",
+)
+
+csharp_proto_library(
+ name = "alloydb_csharp_proto",
+ deps = [":alloydb_proto"],
+)
+
+csharp_grpc_library(
+ name = "alloydb_csharp_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_csharp_proto"],
+)
+
+csharp_gapic_library(
+ name = "alloydb_csharp_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
+ grpc_service_config = "alloydb_v1alpha_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1alpha.yaml",
+ deps = [
+ ":alloydb_csharp_grpc",
+ ":alloydb_csharp_proto",
+ ],
+)
+
+# Open Source Packages
+csharp_gapic_assembly_pkg(
+ name = "google-cloud-alloydb-v1alpha-csharp",
+ deps = [
+ ":alloydb_csharp_gapic",
+ ":alloydb_csharp_grpc",
+ ":alloydb_csharp_proto",
+ ],
+)
+
+##############################################################################
+# C++
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "cc_grpc_library",
+ "cc_proto_library",
+)
+
+cc_proto_library(
+ name = "alloydb_cc_proto",
+ deps = [":alloydb_proto"],
+)
+
+cc_grpc_library(
+ name = "alloydb_cc_grpc",
+ srcs = [":alloydb_proto"],
+ grpc_only = True,
+ deps = [":alloydb_cc_proto"],
+)
diff --git a/third_party/googleapis/google/cloud/alloydb/v1alpha/alloydb_v1alpha.yaml b/third_party/googleapis/google/cloud/alloydb/v1alpha/alloydb_v1alpha.yaml
new file mode 100644
index 000000000..064560244
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1alpha/alloydb_v1alpha.yaml
@@ -0,0 +1,230 @@
+type: google.api.Service
+config_version: 3
+name: alloydb.googleapis.com
+title: AlloyDB API
+
+apis:
+- name: google.cloud.alloydb.v1alpha.AlloyDBAdmin
+- name: google.cloud.location.Locations
+- name: google.iam.v1.IAMPolicy
+- name: google.longrunning.Operations
+
+types:
+- name: google.cloud.alloydb.v1alpha.BatchCreateInstancesResponse
+- name: google.cloud.alloydb.v1alpha.OperationMetadata
+
+documentation:
+ summary: |-
+ AlloyDB for PostgreSQL is an open source-compatible database service that
+ provides a powerful option for migrating, modernizing, or building
+ commercial-grade applications. It offers full compatibility with standard
+ PostgreSQL, and is more than 4x faster for transactional workloads and up
+ to 100x faster for analytical queries than standard PostgreSQL in our
+ performance tests. AlloyDB for PostgreSQL offers a 99.99 percent
+ availability SLA inclusive of maintenance.
AlloyDB is optimized
+ for the most demanding use cases, allowing you to build new applications
+ that require high transaction throughput, large database sizes, or
+ multiple read resources; scale existing PostgreSQL workloads with no
+ application changes; and modernize legacy proprietary databases.
+ rules:
+ - selector: google.cloud.location.Locations.GetLocation
+ description: Gets information about a location.
+
+ - selector: google.cloud.location.Locations.ListLocations
+ description: Lists information about the supported locations for this service.
+
+ - selector: google.iam.v1.IAMPolicy.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.
+
+ - selector: google.iam.v1.IAMPolicy.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.
+
+ - selector: google.iam.v1.IAMPolicy.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.
+
+backend:
+ rules:
+ - selector: 'google.cloud.alloydb.v1alpha.AlloyDBAdmin.*'
+ deadline: 60.0
+ - selector: google.cloud.location.Locations.GetLocation
+ deadline: 60.0
+ - selector: google.cloud.location.Locations.ListLocations
+ deadline: 60.0
+ - selector: 'google.iam.v1.IAMPolicy.*'
+ deadline: 60.0
+ - selector: 'google.longrunning.Operations.*'
+ deadline: 60.0
+
+http:
+ rules:
+ - selector: google.cloud.location.Locations.GetLocation
+ get: '/v1alpha/{name=projects/*/locations/*}'
+ - selector: google.cloud.location.Locations.ListLocations
+ get: '/v1alpha/{name=projects/*}/locations'
+ - selector: google.longrunning.Operations.CancelOperation
+ post: '/v1alpha/{name=projects/*/locations/*/operations/*}:cancel'
+ body: '*'
+ - selector: google.longrunning.Operations.DeleteOperation
+ delete: '/v1alpha/{name=projects/*/locations/*/operations/*}'
+ - selector: google.longrunning.Operations.GetOperation
+ get: '/v1alpha/{name=projects/*/locations/*/operations/*}'
+ - selector: google.longrunning.Operations.ListOperations
+ get: '/v1alpha/{name=projects/*/locations/*}/operations'
+
+authentication:
+ rules:
+ - selector: 'google.cloud.alloydb.v1alpha.AlloyDBAdmin.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: google.cloud.location.Locations.GetLocation
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: google.cloud.location.Locations.ListLocations
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: 'google.iam.v1.IAMPolicy.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: 'google.longrunning.Operations.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+
+publishing:
+ organization: CLOUD
+ new_issue_uri: 'https://issuetracker.google.com/issues/new?component=1029828'
+ documentation_uri: 'https://cloud.google.com/alloydb/docs'
+ api_short_name: 'alloydb'
+ github_label: 'api: alloydb'
+ doc_tag_prefix: 'alloydb'
+ codeowner_github_teams:
+ library_settings:
+ - version: 'google.cloud.alloydb.v1'
+ launch_stage: GA
+ rest_numeric_enums: false
+ java_settings:
+ library_package: ''
+ service_class_names:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ cpp_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ php_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ python_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ node_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ dotnet_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ ruby_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ go_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ - version: 'google.cloud.alloydb.v1beta'
+ launch_stage: BETA
+ rest_numeric_enums: false
+ java_settings:
+ library_package: ''
+ service_class_names:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ cpp_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ php_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ python_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ node_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ dotnet_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ ruby_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ go_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ - version: 'google.cloud.alloydb.v1alpha'
+ launch_stage: ALPHA
+ rest_numeric_enums: false
+ java_settings:
+ library_package: ''
+ service_class_names:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ cpp_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ php_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ python_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ node_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ dotnet_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ ruby_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ go_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
diff --git a/third_party/googleapis/google/cloud/alloydb/v1alpha/alloydb_v1alpha_grpc_service_config.json b/third_party/googleapis/google/cloud/alloydb/v1alpha/alloydb_v1alpha_grpc_service_config.json
new file mode 100644
index 000000000..4e486336a
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1alpha/alloydb_v1alpha_grpc_service_config.json
@@ -0,0 +1,30 @@
+{
+ "methodConfig": [{
+ "name": [
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin", "method": "ListClusters" },
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin", "method": "GetCluster" },
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin", "method": "ListInstances" },
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin", "method": "GetInstance" },
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin", "method": "ListBackups" },
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin", "method": "GetBackup" },
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin", "method": "ListSupportedDatabaseFlags" },
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin", "method": "GenerateClientCertificate" },
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin", "method": "GetConnectionInfo" },
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin", "method": "ListUsers" },
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin", "method": "GetUser" }
+ ],
+ "timeout": "60s",
+ "retryPolicy": {
+ "initialBackoff": "1s",
+ "maxBackoff": "60s",
+ "backoffMultiplier": 1.3,
+ "retryableStatusCodes": ["UNAVAILABLE"]
+ }
+ },
+ {
+ "name": [
+ { "service": "google.cloud.alloydb.v1alpha.AlloyDBAdmin" }
+ ],
+ "timeout": "60s"
+ }]
+}
diff --git a/third_party/googleapis/google/cloud/alloydb/v1alpha/resources.proto b/third_party/googleapis/google/cloud/alloydb/v1alpha/resources.proto
new file mode 100644
index 000000000..9fb582bb9
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1alpha/resources.proto
@@ -0,0 +1,1028 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.alloydb.v1alpha;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "google/type/dayofweek.proto";
+import "google/type/timeofday.proto";
+
+option csharp_namespace = "Google.Cloud.AlloyDb.V1Alpha";
+option go_package = "cloud.google.com/go/alloydb/apiv1alpha/alloydbpb;alloydbpb";
+option java_multiple_files = true;
+option java_outer_classname = "ResourcesProto";
+option java_package = "com.google.cloud.alloydb.v1alpha";
+option php_namespace = "Google\\Cloud\\AlloyDb\\V1alpha";
+option ruby_package = "Google::Cloud::AlloyDb::V1alpha";
+option (google.api.resource_definition) = {
+ type: "cloudkms.googleapis.com/CryptoKeyVersion"
+ pattern: "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}"
+};
+option (google.api.resource_definition) = {
+ type: "compute.googleapis.com/Network"
+ pattern: "projects/{project}/global/networks/{network}"
+};
+
+// The supported database engine versions.
+enum DatabaseVersion {
+ // This is an unknown database version.
+ DATABASE_VERSION_UNSPECIFIED = 0;
+
+ // DEPRECATED - The database version is Postgres 13.
+ POSTGRES_13 = 1 [deprecated = true];
+
+ // The database version is Postgres 14.
+ POSTGRES_14 = 2;
+}
+
+// View on Instance. Pass this enum to rpcs that returns an Instance message to
+// control which subsets of fields to get.
+enum InstanceView {
+ // INSTANCE_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
+ INSTANCE_VIEW_UNSPECIFIED = 0;
+
+ // BASIC server responses for a primary or read instance include all the
+ // relevant instance details, excluding the details of each node in the
+ // instance. The default value.
+ INSTANCE_VIEW_BASIC = 1;
+
+ // FULL response is equivalent to BASIC for primary instance (for now).
+ // For read pool instance, this includes details of each node in the pool.
+ INSTANCE_VIEW_FULL = 2;
+}
+
+// The username/password for a database user. Used for specifying initial
+// users at cluster creation time.
+message UserPassword {
+ // The database username.
+ string user = 1;
+
+ // The initial password for the user.
+ string password = 2;
+}
+
+// Subset of the source instance configuration that is available when reading
+// the cluster resource.
+message MigrationSource {
+ // Denote the type of migration source that created this cluster.
+ enum MigrationSourceType {
+ // Migration source is unknown.
+ MIGRATION_SOURCE_TYPE_UNSPECIFIED = 0;
+
+ // DMS source means the cluster was created via DMS migration job.
+ DMS = 1;
+ }
+
+ // Output only. The host and port of the on-premises instance in host:port
+ // format
+ string host_port = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Place holder for the external source identifier(e.g DMS job
+ // name) that created the cluster.
+ string reference_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Type of migration source.
+ MigrationSourceType source_type = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// EncryptionConfig describes the encryption config of a cluster or a backup
+// that is encrypted with a CMEK (customer-managed encryption key).
+message EncryptionConfig {
+ // The fully-qualified resource name of the KMS key.
+ // Each Cloud KMS key is regionalized and has the following format:
+ // projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
+ string kms_key_name = 1;
+}
+
+// EncryptionInfo describes the encryption information of a cluster or a backup.
+message EncryptionInfo {
+ // Possible encryption types.
+ enum Type {
+ // Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.
+ TYPE_UNSPECIFIED = 0;
+
+ // The data is encrypted at rest with a key that is fully managed by Google.
+ // No key version will be populated. This is the default state.
+ GOOGLE_DEFAULT_ENCRYPTION = 1;
+
+ // The data is encrypted at rest with a key that is managed by the customer.
+ // KMS key versions will be populated.
+ CUSTOMER_MANAGED_ENCRYPTION = 2;
+ }
+
+ // Output only. Type of encryption.
+ Type encryption_type = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Cloud KMS key versions that are being used to protect the
+ // database or the backup.
+ repeated string kms_key_versions = 2 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "cloudkms.googleapis.com/CryptoKeyVersion"
+ }
+ ];
+}
+
+// SSL configuration for an AlloyDB Cluster.
+message SslConfig {
+ // SSL mode options.
+ enum SslMode {
+ // SSL mode not specified. Defaults to SSL_MODE_ALLOW.
+ SSL_MODE_UNSPECIFIED = 0;
+
+ // SSL connections are optional. CA verification not enforced.
+ SSL_MODE_ALLOW = 1;
+
+ // SSL connections are required. CA verification not enforced.
+ // Clients may use locally self-signed certificates (default psql client
+ // behavior).
+ SSL_MODE_REQUIRE = 2;
+
+ // SSL connections are required. CA verification enforced.
+ // Clients must have certificates signed by a Cluster CA, e.g. via
+ // GenerateClientCertificate.
+ SSL_MODE_VERIFY_CA = 3;
+ }
+
+ // Certificate Authority (CA) source for SSL/TLS certificates.
+ enum CaSource {
+ // Certificate Authority (CA) source not specified. Defaults to
+ // CA_SOURCE_MANAGED.
+ CA_SOURCE_UNSPECIFIED = 0;
+
+ // Certificate Authority (CA) managed by the AlloyDB Cluster.
+ CA_SOURCE_MANAGED = 1;
+ }
+
+ // Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
+ SslMode ssl_mode = 1 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is
+ // supported currently, and is the default value.
+ CaSource ca_source = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message describing the user-specified automated backup policy.
+//
+// All fields in the automated backup policy are optional. Defaults for each
+// field are provided if they are not set.
+message AutomatedBackupPolicy {
+ // A weekly schedule starts a backup at prescribed start times within a
+ // day, for the specified days of the week.
+ //
+ // The weekly schedule message is flexible and can be used to create many
+ // types of schedules. For example, to have a daily backup that starts at
+ // 22:00, configure the `start_times` field to have one element "22:00" and
+ // the `days_of_week` field to have all seven days of the week.
+ message WeeklySchedule {
+ // The times during the day to start a backup. The start times are assumed
+ // to be in UTC and to be an exact hour (e.g., 04:00:00).
+ //
+ // If no start times are provided, a single fixed start time is chosen
+ // arbitrarily.
+ repeated google.type.TimeOfDay start_times = 1;
+
+ // The days of the week to perform a backup.
+ //
+ // If this field is left empty, the default of every day of the week is
+ // used.
+ repeated google.type.DayOfWeek days_of_week = 2;
+ }
+
+ // A time based retention policy specifies that all backups within a certain
+ // time period should be retained.
+ message TimeBasedRetention {
+ // The retention period.
+ google.protobuf.Duration retention_period = 1;
+ }
+
+ // A quantity based policy specifies that a certain number of the most recent
+ // successful backups should be retained.
+ message QuantityBasedRetention {
+ // The number of backups to retain.
+ int32 count = 1;
+ }
+
+ // The schedule for this automated backup policy.
+ //
+ // A schedule specifies times at which to start a backup. If a backup
+ // window is also provided, the backup is guaranteed to be started and
+ // completed within the start time plus the backup window. If the backup is
+ // not completed within the backup window it is marked as failed.
+ //
+ // If not set, the schedule defaults to a weekly schedule with one backup
+ // per day and a start time chosen arbitrarily.
+ oneof schedule {
+ // Weekly schedule for the Backup.
+ WeeklySchedule weekly_schedule = 2;
+ }
+
+ // The retention policy for automated backups.
+ //
+ // The retention policy for a backup is fixed at the time the backup is
+ // created. Changes to this field only apply to new backups taken with the
+ // policy; the retentions of existing backups remain unchanged.
+ //
+ // If no retention policy is set, a default of 14 days is used.
+ oneof retention {
+ // Time-based Backup retention policy.
+ TimeBasedRetention time_based_retention = 4;
+
+ // Quantity-based Backup retention policy to retain recent backups.
+ QuantityBasedRetention quantity_based_retention = 5;
+ }
+
+ // Whether automated automated backups are enabled. If not set, defaults to
+ // true.
+ optional bool enabled = 1;
+
+ // The length of the time window during which a backup can be
+ // taken. If a backup does not succeed within this time window, it will be
+ // canceled and considered failed.
+ //
+ // The backup window must be at least 5 minutes long. There is no upper bound
+ // on the window. If not set, it defaults to 1 hour.
+ google.protobuf.Duration backup_window = 3;
+
+ // Optional. The encryption config can be specified to encrypt the
+ // backups with a customer-managed encryption key (CMEK). When this field is
+ // not specified, the backup will then use default encryption scheme to
+ // protect the user data.
+ EncryptionConfig encryption_config = 8
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // The location where the backup will be stored. Currently, the only supported
+ // option is to store the backup in the same region as the cluster.
+ //
+ // If empty, defaults to the region of the cluster.
+ string location = 6;
+
+ // Labels to apply to backups created using this configuration.
+ map labels = 7;
+}
+
+// ContinuousBackupConfig describes the continuous backups recovery
+// configurations of a cluster.
+message ContinuousBackupConfig {
+ // Whether ContinuousBackup is enabled.
+ optional bool enabled = 1;
+
+ // The number of days backups and logs will be retained, which determines the
+ // window of time that data is recoverable for. If not set, it defaults to 14
+ // days.
+ int32 recovery_window_days = 4;
+
+ // The encryption config can be specified to encrypt the
+ // backups with a customer-managed encryption key (CMEK). When this field is
+ // not specified, the backup will then use default encryption scheme to
+ // protect the user data.
+ EncryptionConfig encryption_config = 3;
+}
+
+// ContinuousBackupInfo describes the continuous backup properties of a
+// cluster.
+message ContinuousBackupInfo {
+ // Output only. The encryption information for the WALs and backups required
+ // for ContinuousBackup.
+ EncryptionInfo encryption_info = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. When ContinuousBackup was most recently enabled. Set to null
+ // if ContinuousBackup is not enabled.
+ google.protobuf.Timestamp enabled_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Days of the week on which a continuous backup is taken. Output
+ // only field. Ignored if passed into the request.
+ repeated google.type.DayOfWeek schedule = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Message describing a BackupSource.
+message BackupSource {
+ // Output only. The system-generated UID of the backup which was used to
+ // create this resource. The UID is generated when the backup is created, and
+ // it is retained until the backup is deleted.
+ string backup_uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The name of the backup resource with the format:
+ // * projects/{project}/locations/{region}/backups/{backup_id}
+ string backup_name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Backup" }
+ ];
+}
+
+// Message describing a ContinuousBackupSource.
+message ContinuousBackupSource {
+ // Required. The source cluster from which to restore. This cluster must have
+ // continuous backup enabled for this operation to succeed. For the required
+ // format, see the comment on the Cluster.name field.
+ string cluster = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The point in time to restore to.
+ google.protobuf.Timestamp point_in_time = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// A cluster is a collection of regional AlloyDB resources. It can include a
+// primary instance and one or more read pool instances.
+// All cluster resources share a storage layer, which scales as needed.
+message Cluster {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/Cluster"
+ pattern: "projects/{project}/locations/{location}/clusters/{cluster}"
+ style: DECLARATIVE_FRIENDLY
+ };
+
+ // Configuration information for the secondary cluster. This should be set
+ // if and only if the cluster is of type SECONDARY.
+ message SecondaryConfig {
+ // The name of the primary cluster name with the format:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}
+ string primary_cluster_name = 1;
+ }
+
+ // Configuration for the primary cluster. It has the list of clusters that are
+ // replicating from this cluster. This should be set if and only if the
+ // cluster is of type PRIMARY.
+ message PrimaryConfig {
+ // Output only. Names of the clusters that are replicating from this
+ // cluster.
+ repeated string secondary_cluster_names = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Cluster State
+ enum State {
+ // The state of the cluster is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // The cluster is active and running.
+ READY = 1;
+
+ // The cluster is stopped. All instances in the cluster are stopped.
+ // Customers can start a stopped cluster at any point and all their
+ // instances will come back to life with same names and IP resources. In
+ // this state, customer pays for storage.
+ // Associated backups could also be present in a stopped cluster.
+ STOPPED = 2;
+
+ // The cluster is empty and has no associated resources.
+ // All instances, associated storage and backups have been deleted.
+ EMPTY = 3;
+
+ // The cluster is being created.
+ CREATING = 4;
+
+ // The cluster is being deleted.
+ DELETING = 5;
+
+ // The creation of the cluster failed.
+ FAILED = 6;
+
+ // The cluster is bootstrapping with data from some other source.
+ // Direct mutations to the cluster (e.g. adding read pool) are not allowed.
+ BOOTSTRAPPING = 7;
+
+ // The cluster is under maintenance. AlloyDB regularly performs maintenance
+ // and upgrades on customer clusters. Updates on the cluster are
+ // not allowed while the cluster is in this state.
+ MAINTENANCE = 8;
+
+ // The cluster is being promoted.
+ PROMOTING = 9;
+ }
+
+ // Type of Cluster
+ enum ClusterType {
+ // The type of the cluster is unknown.
+ CLUSTER_TYPE_UNSPECIFIED = 0;
+
+ // Primary cluster that support read and write operations.
+ PRIMARY = 1;
+
+ // Secondary cluster that is replicating from another region.
+ // This only supports read.
+ SECONDARY = 2;
+ }
+
+ // In case of an imported cluster, this field contains information about the
+ // source this cluster was imported from.
+ oneof source {
+ // Output only. Cluster created from backup.
+ BackupSource backup_source = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Cluster created via DMS migration.
+ MigrationSource migration_source = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Output only. The name of the cluster resource with the format:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}
+ // where the cluster ID segment should satisfy the regex expression
+ // `[a-z0-9-]+`. For more details see https://google.aip.dev/122.
+ // The prefix of the cluster resource name is the name of the parent resource:
+ // * projects/{project}/locations/{region}
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // User-settable and human-readable display name for the Cluster.
+ string display_name = 2;
+
+ // Output only. The system-generated UID of the resource. The UID is assigned
+ // when the resource is created, and it is retained until it is deleted.
+ string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Create time stamp
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Update time stamp
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Delete time stamp
+ google.protobuf.Timestamp delete_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Labels as key value pairs
+ map labels = 7;
+
+ // Output only. The current serving state of the cluster.
+ State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The type of the cluster. This is an output-only field and it's
+ // populated at the Cluster creation time or the Cluster promotion
+ // time. The cluster type is determined by which RPC was used to create
+ // the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
+ ClusterType cluster_type = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The database engine major version. This is an output-only
+ // field and it's populated at the Cluster creation time. This field cannot be
+ // changed after cluster creation.
+ DatabaseVersion database_version = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The resource link for the VPC network in which cluster resources
+ // are created and from which they are accessible via Private IP. The network
+ // must belong to the same project as the cluster. It is specified in the
+ // form: "projects/{project_number}/global/networks/{network_id}". This is
+ // required to create a cluster. It can be updated, but it cannot be removed.
+ string network = 10 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
+ ];
+
+ // For Resource freshness validation (https://google.aip.dev/154)
+ string etag = 11;
+
+ // Annotations to allow client tools to store small amount of arbitrary data.
+ // This is distinct from labels.
+ // https://google.aip.dev/128
+ map annotations = 12;
+
+ // Output only. Reconciling (https://google.aip.dev/128#reconciliation).
+ // Set to true if the current state of Cluster does not match the user's
+ // intended state, and the service is actively updating the resource to
+ // reconcile them. This can happen due to user-triggered updates or
+ // system actions like failover or maintenance.
+ bool reconciling = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Input only. Initial user to setup during cluster creation. Required.
+ // If used in `RestoreCluster` this is ignored.
+ UserPassword initial_user = 14 [(google.api.field_behavior) = INPUT_ONLY];
+
+ // The automated backup policy for this cluster.
+ //
+ // If no policy is provided then the default policy will be used. If backups
+ // are supported for the cluster, the default policy takes one backup a day,
+ // has a backup window of 1 hour, and retains backups for 14 days.
+ // For more information on the defaults, consult the
+ // documentation for the message type.
+ AutomatedBackupPolicy automated_backup_policy = 17;
+
+ // SSL configuration for this AlloyDB Cluster.
+ SslConfig ssl_config = 18;
+
+ // Optional. The encryption config can be specified to encrypt the data disks
+ // and other persistent data resources of a cluster with a
+ // customer-managed encryption key (CMEK). When this field is not
+ // specified, the cluster will then use default encryption scheme to
+ // protect the user data.
+ EncryptionConfig encryption_config = 19
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Output only. The encryption information for the cluster.
+ EncryptionInfo encryption_info = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Optional. Continuous backup configuration for this cluster.
+ ContinuousBackupConfig continuous_backup_config = 27
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Output only. Continuous backup properties for this cluster.
+ ContinuousBackupInfo continuous_backup_info = 28
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Cross Region replication config specific to SECONDARY cluster.
+ SecondaryConfig secondary_config = 22;
+
+ // Output only. Cross Region replication config specific to PRIMARY cluster.
+ PrimaryConfig primary_config = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// An Instance is a computing unit that an end customer can connect to.
+// It's the main unit of computing resources in AlloyDB.
+message Instance {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/Instance"
+ pattern: "projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}"
+ style: DECLARATIVE_FRIENDLY
+ };
+
+ // MachineConfig describes the configuration of a machine.
+ message MachineConfig {
+ // The number of CPU's in the VM instance.
+ int32 cpu_count = 1;
+ }
+
+ // Details of a single node in the instance.
+ // Nodes in an AlloyDB instance are ephemereal, they can change during
+ // update, failover, autohealing and resize operations.
+ message Node {
+ // The Compute Engine zone of the VM e.g. "us-central1-b".
+ string zone_id = 1;
+
+ // The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
+ string id = 2;
+
+ // The private IP address of the VM e.g. "10.57.0.34".
+ string ip = 3;
+
+ // Determined by state of the compute VM and postgres-service health.
+ // Compute VM state can have values listed in
+ // https://cloud.google.com/compute/docs/instances/instance-life-cycle and
+ // postgres-service health can have values: HEALTHY and UNHEALTHY.
+ string state = 4;
+ }
+
+ // QueryInsights Instance specific configuration.
+ message QueryInsightsInstanceConfig {
+ // Record application tags for an instance.
+ // This flag is turned "on" by default.
+ optional bool record_application_tags = 2;
+
+ // Record client address for an instance. Client address is PII information.
+ // This flag is turned "on" by default.
+ optional bool record_client_address = 3;
+
+ // Query string length. The default value is 1024.
+ // Any integer between 256 and 4500 is considered valid.
+ uint32 query_string_length = 4;
+
+ // Number of query execution plans captured by Insights per minute
+ // for all queries combined. The default value is 5.
+ // Any integer between 0 and 20 is considered valid.
+ optional uint32 query_plans_per_minute = 5;
+ }
+
+ // Configuration for a read pool instance.
+ message ReadPoolConfig {
+ // Read capacity, i.e. number of nodes in a read pool instance.
+ int32 node_count = 1;
+ }
+
+ // Instance State
+ enum State {
+ // The state of the instance is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // The instance is active and running.
+ READY = 1;
+
+ // The instance is stopped. Instance name and IP resources are preserved.
+ STOPPED = 2;
+
+ // The instance is being created.
+ CREATING = 3;
+
+ // The instance is being deleted.
+ DELETING = 4;
+
+ // The instance is down for maintenance.
+ MAINTENANCE = 5;
+
+ // The creation of the instance failed or a fatal error occurred during
+ // an operation on the instance.
+ // Note: Instances in this state would tried to be auto-repaired. And
+ // Customers should be able to restart, update or delete these instances.
+ FAILED = 6;
+
+ // Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
+ // index unused in case that state also needs to exposed via consumer apis
+ // in future.
+ // The instance has been configured to sync data from some other source.
+ BOOTSTRAPPING = 8;
+
+ // The instance is being promoted.
+ PROMOTING = 9;
+ }
+
+ // Type of an Instance
+ enum InstanceType {
+ // The type of the instance is unknown.
+ INSTANCE_TYPE_UNSPECIFIED = 0;
+
+ // PRIMARY instances support read and write operations.
+ PRIMARY = 1;
+
+ // READ POOL instances support read operations only. Each read pool instance
+ // consists of one or more homogeneous nodes.
+ // * Read pool of size 1 can only have zonal availability.
+ // * Read pools with node count of 2 or more can have regional
+ // availability (nodes are present in 2 or more zones in a region).
+ READ_POOL = 2;
+
+ // SECONDARY instances support read operations only. SECONDARY instance
+ // is a cross-region read replica
+ SECONDARY = 3;
+ }
+
+ // The Availability type of an instance. Potential values:
+ //
ZONAL: The instance serves data from only one zone.
+ // Outages in that zone affect instance availability.
+ //
REGIONAL: The instance can serve data from more than one zone
+ // in a region (it is highly available).
+ enum AvailabilityType {
+ // This is an unknown Availability type.
+ AVAILABILITY_TYPE_UNSPECIFIED = 0;
+
+ // Zonal available instance.
+ ZONAL = 1;
+
+ // Regional (or Highly) available instance.
+ REGIONAL = 2;
+ }
+
+ // Output only. The name of the instance resource with the format:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id}
+ // where the cluster and instance ID segments should satisfy the regex
+ // expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
+ // lowercase letters, numbers, and dashes, starting with a letter, and ending
+ // with a letter or number. For more details see https://google.aip.dev/122.
+ // The prefix of the instance resource name is the name of the parent
+ // resource:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // User-settable and human-readable display name for the Instance.
+ string display_name = 2;
+
+ // Output only. The system-generated UID of the resource. The UID is assigned
+ // when the resource is created, and it is retained until it is deleted.
+ string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Create time stamp
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Update time stamp
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Delete time stamp
+ google.protobuf.Timestamp delete_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Labels as key value pairs
+ map labels = 7;
+
+ // Output only. The current serving state of the instance.
+ State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The type of the instance. Specified at creation time.
+ InstanceType instance_type = 9 [(google.api.field_behavior) = REQUIRED];
+
+ // Configurations for the machines that host the underlying
+ // database engine.
+ MachineConfig machine_config = 10;
+
+ // Availability type of an Instance.
+ // Defaults to REGIONAL for both primary and read instances.
+ // Note that primary and read instances can have different availability types.
+ AvailabilityType availability_type = 11;
+
+ // The Compute Engine zone that the instance should serve from, per
+ // https://cloud.google.com/compute/docs/regions-zones
+ // This can ONLY be specified for ZONAL instances.
+ // If present for a REGIONAL instance, an error will be thrown.
+ // If this is absent for a ZONAL instance, instance is created in a random
+ // zone with available capacity.
+ string gce_zone = 12;
+
+ // Database flags. Set at instance level.
+ // * They are copied from primary instance on read instance creation.
+ // * Read instances can set new or override existing flags that are relevant
+ // for reads, e.g. for enabling columnar cache on a read instance. Flags
+ // set on read instance may or may not be present on primary.
+ //
+ //
+ // This is a list of "key": "value" pairs.
+ // "key": The name of the flag. These flags are passed at instance setup time,
+ // so include both server options and system variables for Postgres. Flags are
+ // specified with underscores, not hyphens.
+ // "value": 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.
+ map database_flags = 13;
+
+ // Output only. This is set for the read-write VM of the PRIMARY instance
+ // only.
+ Node writable_node = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. List of available read-only VMs in this instance, including
+ // the standby for a PRIMARY instance.
+ repeated Node nodes = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Configuration for query insights.
+ QueryInsightsInstanceConfig query_insights_config = 21;
+
+ // Read pool specific config.
+ ReadPoolConfig read_pool_config = 14;
+
+ // Output only. The IP address for the Instance.
+ // This is the connection endpoint for an end-user application.
+ string ip_address = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Reconciling (https://google.aip.dev/128#reconciliation).
+ // Set to true if the current state of Instance does not match the user's
+ // intended state, and the service is actively updating the resource to
+ // reconcile them. This can happen due to user-triggered updates or
+ // system actions like failover or maintenance.
+ bool reconciling = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // For Resource freshness validation (https://google.aip.dev/154)
+ string etag = 17;
+
+ // Annotations to allow client tools to store small amount of arbitrary data.
+ // This is distinct from labels.
+ // https://google.aip.dev/128
+ map annotations = 18;
+}
+
+// ConnectionInfo singleton resource.
+// https://google.aip.dev/156
+message ConnectionInfo {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/ConnectionInfo"
+ pattern: "projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}/connectionInfo"
+ };
+
+ // The name of the ConnectionInfo singleton resource, e.g.:
+ // projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo
+ // This field currently has no semantic meaning.
+ string name = 1;
+
+ // Output only. The IP address for the Instance.
+ // This is the connection endpoint for an end-user application.
+ string ip_address = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The pem-encoded chain that may be used to verify the X.509
+ // certificate. Expected to be in issuer-to-root order according to RFC 5246.
+ repeated string pem_certificate_chain = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The unique ID of the Instance.
+ string instance_uid = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Message describing Backup object
+message Backup {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/Backup"
+ pattern: "projects/{project}/locations/{location}/backups/{backup}"
+ style: DECLARATIVE_FRIENDLY
+ };
+
+ // Backup State
+ enum State {
+ // The state of the backup is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // The backup is ready.
+ READY = 1;
+
+ // The backup is creating.
+ CREATING = 2;
+
+ // The backup failed.
+ FAILED = 3;
+
+ // The backup is being deleted.
+ DELETING = 4;
+ }
+
+ // Backup Type
+ enum Type {
+ // Backup Type is unknown.
+ TYPE_UNSPECIFIED = 0;
+
+ // ON_DEMAND backups that were triggered by the customer (e.g., not
+ // AUTOMATED).
+ ON_DEMAND = 1;
+
+ // AUTOMATED backups triggered by the automated backups scheduler pursuant
+ // to an automated backup policy.
+ AUTOMATED = 2;
+
+ // CONTINUOUS backups triggered by the automated backups scheduler
+ // due to a continuous backup policy.
+ CONTINUOUS = 3;
+ }
+
+ // Output only. The name of the backup resource with the format:
+ // * projects/{project}/locations/{region}/backups/{backup_id}
+ // where the cluster and backup ID segments should satisfy the regex
+ // expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
+ // lowercase letters, numbers, and dashes, starting with a letter, and ending
+ // with a letter or number. For more details see https://google.aip.dev/122.
+ // The prefix of the backup resource name is the name of the parent
+ // resource:
+ // * projects/{project}/locations/{region}
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // User-settable and human-readable display name for the Backup.
+ string display_name = 2;
+
+ // Output only. The system-generated UID of the resource. The UID is assigned
+ // when the resource is created, and it is retained until it is deleted.
+ string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Create time stamp
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Update time stamp
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Delete time stamp
+ google.protobuf.Timestamp delete_time = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Labels as key value pairs
+ map labels = 6;
+
+ // Output only. The current state of the backup.
+ State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The backup type, which suggests the trigger for the backup.
+ Type type = 8;
+
+ // User-provided description of the backup.
+ string description = 9;
+
+ // Output only. The system-generated UID of the cluster which was used to
+ // create this resource.
+ string cluster_uid = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The full resource name of the backup source cluster
+ // (e.g., projects//locations//clusters/).
+ string cluster_name = 10 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+
+ // Output only. Reconciling (https://google.aip.dev/128#reconciliation), if
+ // true, indicates that the service is actively updating the resource. This
+ // can happen due to user-triggered updates or system actions like failover or
+ // maintenance.
+ bool reconciling = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Optional. The encryption config can be specified to encrypt the
+ // backup with a customer-managed encryption key (CMEK). When this field is
+ // not specified, the backup will then use default encryption scheme to
+ // protect the user data.
+ EncryptionConfig encryption_config = 12
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Output only. The encryption information for the backup.
+ EncryptionInfo encryption_info = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // For Resource freshness validation (https://google.aip.dev/154)
+ string etag = 14;
+
+ // Annotations to allow client tools to store small amount of arbitrary data.
+ // This is distinct from labels.
+ // https://google.aip.dev/128
+ map annotations = 16;
+
+ // Output only. The size of the backup in bytes.
+ int64 size_bytes = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time at which after the backup is eligible to be garbage
+ // collected. It is the duration specified by the backup's retention policy,
+ // added to the backup's create_time.
+ google.protobuf.Timestamp expiry_time = 19
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// SupportedDatabaseFlag gives general information about a database flag,
+// like type and allowed values. This is a static value that is defined
+// on the server side, and it cannot be modified by callers.
+// To set the Database flags on a particular Instance, a caller should modify
+// the Instance.database_flags field.
+message SupportedDatabaseFlag {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/SupportedDatabaseFlag"
+ pattern: "projects/{project}/locations/{location}/flags/{flag}"
+ };
+
+ // Restrictions on STRING type values
+ message StringRestrictions {
+ // The list of allowed values, if bounded. This field will be empty
+ // if there is a unbounded number of allowed values.
+ repeated string allowed_values = 1;
+ }
+
+ // Restrictions on INTEGER type values.
+ message IntegerRestrictions {
+ // The minimum value that can be specified, if applicable.
+ google.protobuf.Int64Value min_value = 1;
+
+ // The maximum value that can be specified, if applicable.
+ google.protobuf.Int64Value max_value = 2;
+ }
+
+ // ValueType describes the semantic type of the value that the flag accepts.
+ // Regardless of the ValueType, the Instance.database_flags field accepts the
+ // stringified version of the value, i.e. "20" or "3.14".
+ enum ValueType {
+ // This is an unknown flag type.
+ VALUE_TYPE_UNSPECIFIED = 0;
+
+ // String type flag.
+ STRING = 1;
+
+ // Integer type flag.
+ INTEGER = 2;
+
+ // Float type flag.
+ FLOAT = 3;
+
+ // Denotes that the flag does not accept any values.
+ NONE = 4;
+ }
+
+ // The restrictions on the flag value per type.
+ oneof restrictions {
+ // Restriction on STRING type value.
+ StringRestrictions string_restrictions = 7;
+
+ // Restriction on INTEGER type value.
+ IntegerRestrictions integer_restrictions = 8;
+ }
+
+ // The name of the flag resource, following Google Cloud conventions, e.g.:
+ // * projects/{project}/locations/{location}/flags/{flag}
+ // This field currently has no semantic meaning.
+ string name = 1;
+
+ // The name of the database flag, e.g. "max_allowed_packets".
+ // The is a possibly key for the Instance.database_flags map field.
+ string flag_name = 2;
+
+ ValueType value_type = 3;
+
+ // Whether the database flag accepts multiple values. If true,
+ // a comma-separated list of stringified values may be specified.
+ bool accepts_multiple_values = 4;
+
+ // Major database engine versions for which this flag is supported.
+ repeated DatabaseVersion supported_db_versions = 5;
+
+ // Whether setting or updating this flag on an Instance requires a database
+ // restart. If a flag that requires database restart is set, the backend
+ // will automatically restart the database (making sure to satisfy any
+ // availability SLO's).
+ bool requires_db_restart = 6;
+}
diff --git a/third_party/googleapis/google/cloud/alloydb/v1alpha/service.proto b/third_party/googleapis/google/cloud/alloydb/v1alpha/service.proto
new file mode 100644
index 000000000..792379eb6
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1alpha/service.proto
@@ -0,0 +1,1329 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.alloydb.v1alpha;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/alloydb/v1alpha/resources.proto";
+import "google/longrunning/operations.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
+import "google/rpc/status.proto";
+
+option csharp_namespace = "Google.Cloud.AlloyDb.V1Alpha";
+option go_package = "cloud.google.com/go/alloydb/apiv1alpha/alloydbpb;alloydbpb";
+option java_multiple_files = true;
+option java_outer_classname = "ServiceProto";
+option java_package = "com.google.cloud.alloydb.v1alpha";
+option php_namespace = "Google\\Cloud\\AlloyDb\\V1alpha";
+option ruby_package = "Google::Cloud::AlloyDb::V1alpha";
+
+// Service describing handlers for resources
+service AlloyDBAdmin {
+ option (google.api.default_host) = "alloydb.googleapis.com";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
+
+ // Lists Clusters in a given project and location.
+ rpc ListClusters(ListClustersRequest) returns (ListClustersResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha/{parent=projects/*/locations/*}/clusters"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Gets details of a single Cluster.
+ rpc GetCluster(GetClusterRequest) returns (Cluster) {
+ option (google.api.http) = {
+ get: "/v1alpha/{name=projects/*/locations/*/clusters/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Creates a new Cluster in a given project and location.
+ rpc CreateCluster(CreateClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=projects/*/locations/*}/clusters"
+ body: "cluster"
+ };
+ option (google.api.method_signature) = "parent,cluster,cluster_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Updates the parameters of a single Cluster.
+ rpc UpdateCluster(UpdateClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ patch: "/v1alpha/{cluster.name=projects/*/locations/*/clusters/*}"
+ body: "cluster"
+ };
+ option (google.api.method_signature) = "cluster,update_mask";
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Deletes a single Cluster.
+ rpc DeleteCluster(DeleteClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1alpha/{name=projects/*/locations/*/clusters/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Promotes a SECONDARY cluster. This turns down replication
+ // from the PRIMARY cluster and promotes a secondary cluster
+ // into its own standalone cluster.
+ // Imperative only.
+ rpc PromoteCluster(PromoteClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1alpha/{name=projects/*/locations/*/clusters/*}:promote"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Creates a new Cluster in a given project and location, with a volume
+ // restored from the provided source, either a backup ID or a point-in-time
+ // and a source cluster.
+ rpc RestoreCluster(RestoreClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=projects/*/locations/*}/clusters:restore"
+ body: "*"
+ };
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Creates a cluster of type SECONDARY in the given location using
+ // the primary cluster as the source.
+ rpc CreateSecondaryCluster(CreateSecondaryClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=projects/*/locations/*}/clusters:createsecondary"
+ body: "cluster"
+ };
+ option (google.api.method_signature) = "parent,cluster,cluster_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Lists Instances in a given project and location.
+ rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha/{parent=projects/*/locations/*/clusters/*}/instances"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Gets details of a single Instance.
+ rpc GetInstance(GetInstanceRequest) returns (Instance) {
+ option (google.api.http) = {
+ get: "/v1alpha/{name=projects/*/locations/*/clusters/*/instances/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Creates a new Instance in a given project and location.
+ rpc CreateInstance(CreateInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=projects/*/locations/*/clusters/*}/instances"
+ body: "instance"
+ };
+ option (google.api.method_signature) = "parent,instance,instance_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Creates a new SECONDARY Instance in a given project and location.
+ rpc CreateSecondaryInstance(CreateSecondaryInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=projects/*/locations/*/clusters/*}/instances:createsecondary"
+ body: "instance"
+ };
+ option (google.api.method_signature) = "parent,instance,instance_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Creates new instances under the given project, location and cluster.
+ // There can be only one primary instance in a cluster. If the primary
+ // instance exists in the cluster as well as this request, then API will
+ // throw an error.
+ // The primary instance should exist before any read pool instance is
+ // created. If the primary instance is a part of the request payload, then
+ // the API will take care of creating instances in the correct order.
+ // This method is here to support Google-internal use cases, and is not meant
+ // for external customers to consume. Please do not start relying on it; its
+ // behavior is subject to change without notice.
+ rpc BatchCreateInstances(BatchCreateInstancesRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=projects/*/locations/*/clusters/*}/instances:batchCreate"
+ body: "requests"
+ };
+ option (google.longrunning.operation_info) = {
+ response_type: "BatchCreateInstancesResponse"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Updates the parameters of a single Instance.
+ rpc UpdateInstance(UpdateInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ patch: "/v1alpha/{instance.name=projects/*/locations/*/clusters/*/instances/*}"
+ body: "instance"
+ };
+ option (google.api.method_signature) = "instance,update_mask";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Deletes a single Instance.
+ rpc DeleteInstance(DeleteInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1alpha/{name=projects/*/locations/*/clusters/*/instances/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Forces a Failover for a highly available instance.
+ // Failover promotes the HA standby instance as the new primary.
+ // Imperative only.
+ rpc FailoverInstance(FailoverInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1alpha/{name=projects/*/locations/*/clusters/*/instances/*}:failover"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Restart an Instance in a cluster.
+ // Imperative only.
+ rpc RestartInstance(RestartInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1alpha/{name=projects/*/locations/*/clusters/*/instances/*}:restart"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Lists Backups in a given project and location.
+ rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha/{parent=projects/*/locations/*}/backups"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Gets details of a single Backup.
+ rpc GetBackup(GetBackupRequest) returns (Backup) {
+ option (google.api.http) = {
+ get: "/v1alpha/{name=projects/*/locations/*/backups/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Creates a new Backup in a given project and location.
+ rpc CreateBackup(CreateBackupRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=projects/*/locations/*}/backups"
+ body: "backup"
+ };
+ option (google.api.method_signature) = "parent,backup,backup_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Backup"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Updates the parameters of a single Backup.
+ rpc UpdateBackup(UpdateBackupRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ patch: "/v1alpha/{backup.name=projects/*/locations/*/backups/*}"
+ body: "backup"
+ };
+ option (google.api.method_signature) = "backup,update_mask";
+ option (google.longrunning.operation_info) = {
+ response_type: "Backup"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Deletes a single Backup.
+ rpc DeleteBackup(DeleteBackupRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1alpha/{name=projects/*/locations/*/backups/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Lists SupportedDatabaseFlags for a given project and location.
+ rpc ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest)
+ returns (ListSupportedDatabaseFlagsResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha/{parent=projects/*/locations/*}/supportedDatabaseFlags"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Generate a client certificate signed by a Cluster CA.
+ // The sole purpose of this endpoint is to support the Auth Proxy client and
+ // the endpoint's behavior is subject to change without notice, so do not rely
+ // on its behavior remaining constant. Future changes will not break the Auth
+ // Proxy client.
+ rpc GenerateClientCertificate(GenerateClientCertificateRequest)
+ returns (GenerateClientCertificateResponse) {
+ option (google.api.http) = {
+ post: "/v1alpha/{parent=projects/*/locations/*/clusters/*}:generateClientCertificate"
+ body: "*"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Get instance metadata used for a connection.
+ rpc GetConnectionInfo(GetConnectionInfoRequest) returns (ConnectionInfo) {
+ option (google.api.http) = {
+ get: "/v1alpha/{parent=projects/*/locations/*/clusters/*/instances/*}/connectionInfo"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+}
+
+// Message for requesting list of Clusters
+message ListClustersRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Cluster.name field. Additionally, you can perform an
+ // aggregated list operation by specifying a value with the following format:
+ // * projects/{project}/locations/-
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Cluster"
+ }
+ ];
+
+ // Optional. Requested page size. Server may return fewer items than
+ // requested. If unspecified, server will pick an appropriate default.
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+
+ // Optional. Filtering results
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Hint for how to order the results
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for response to listing Clusters
+message ListClustersResponse {
+ // The list of Cluster
+ repeated Cluster clusters = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+
+ // Locations that could not be reached.
+ repeated string unreachable = 3;
+}
+
+// Message for getting a Cluster
+message GetClusterRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+}
+
+message CreateSecondaryClusterRequest {
+ // Required. The name of the parent resource (the primary cluster). For the
+ // required format, see the comment on the Cluster.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Cluster"
+ }
+ ];
+
+ // Required. ID of the requesting object (the secondary cluster).
+ string cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Configuration of the requesting object (the secondary cluster).
+ Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 5 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the create
+ // request.
+ bool validate_only = 6 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for creating a Cluster
+message CreateClusterRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Cluster"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the create
+ // request.
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for updating a Cluster
+message UpdateClusterRequest {
+ // Optional. Field mask is used to specify the fields to be overwritten in the
+ // Cluster resource by the update.
+ // The fields specified in the update_mask are relative to the resource, not
+ // the full request. A field will be overwritten if it is in the mask. If the
+ // user does not provide a mask then all fields will be overwritten.
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The resource being updated
+ Cluster cluster = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the update
+ // request.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set to true, update succeeds even if cluster is not found. In
+ // that case, a new cluster is created and `update_mask` is ignored.
+ bool allow_missing = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for deleting a Cluster
+message DeleteClusterRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The current etag of the Cluster.
+ // If an etag is provided and does not match the current etag of the Cluster,
+ // deletion will be blocked and an ABORTED error will be returned.
+ string etag = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the delete.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Whether to cascade delete child instances for given cluster.
+ bool force = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for promoting a Cluster
+message PromoteClusterRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Cluster.name field
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The current etag of the Cluster.
+ // If an etag is provided and does not match the current etag of the Cluster,
+ // deletion will be blocked and an ABORTED error will be returned.
+ string etag = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the delete.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for restoring a Cluster from a backup or another cluster at a given
+// point in time.
+message RestoreClusterRequest {
+ // Required.
+ // The source to import from.
+ oneof source {
+ // Backup source.
+ BackupSource backup_source = 4;
+
+ // ContinuousBackup source. Continuous backup needs to be enabled in the
+ // source cluster for this operation to succeed.
+ ContinuousBackupSource continuous_backup_source = 8;
+ }
+
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Cluster"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 5 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the import
+ // request.
+ bool validate_only = 6 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for requesting list of Instances
+message ListInstancesRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Instance.name field. Additionally, you can perform an
+ // aggregated list operation by specifying a value with one of the following
+ // formats:
+ // * projects/{project}/locations/-/clusters/-
+ // * projects/{project}/locations/{region}/clusters/-
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. Requested page size. Server may return fewer items than
+ // requested. If unspecified, server will pick an appropriate default.
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+
+ // Optional. Filtering results
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Hint for how to order the results
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for response to listing Instances
+message ListInstancesResponse {
+ // The list of Instance
+ repeated Instance instances = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+
+ // Locations that could not be reached.
+ repeated string unreachable = 3;
+}
+
+// Message for getting a Instance
+message GetInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // The view of the instance to return.
+ InstanceView view = 2;
+}
+
+// Message for creating a Instance
+message CreateInstanceRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Instance.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Instance instance = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the create
+ // request.
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for creating a Secondary Instance
+message CreateSecondaryInstanceRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Instance.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Instance instance = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the create
+ // request.
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// See usage below for notes.
+message CreateInstanceRequests {
+ // Required. Primary and read replica instances to be created. This list
+ // should not be empty.
+ repeated CreateInstanceRequest create_instance_requests = 1
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Message for creating a batch of instances under the specified cluster.
+message BatchCreateInstancesRequest {
+ // Required. The name of the parent resource.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Required. Resources being created.
+ CreateInstanceRequests requests = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for creating batches of instances in a cluster.
+message BatchCreateInstancesResponse {
+ // Created instances.
+ repeated Instance instances = 1;
+}
+
+// Message for metadata that is specific to BatchCreateInstances API.
+message BatchCreateInstancesMetadata {
+ // The instances being created in the API call. Each string in this list
+ // is the server defined resource path for target instances in the request
+ // and for the format of each string, see the comment on the Instance.name
+ // field.
+ repeated string instance_targets = 1;
+
+ // A map representing state of the instances involved in the
+ // BatchCreateInstances operation during the operation execution.
+ // The instance state will be in STATE_UNSPECIFIED state if the instance has
+ // not yet been picked up for processing.
+ // The key of the map is the name of the instance resource.
+ // For the format, see the comment on the Instance.name field.
+ map instance_statuses = 2;
+}
+
+// Message for current status of an instance in the BatchCreateInstances
+// operation.
+// For example, lets say a BatchCreateInstances workflow has 4 instances,
+// Instance1 through Instance4. Lets also assume that 2 instances succeeded
+// but the third failed to create and the 4th was never picked up for creation
+// because of failure of the previous one. Then, resulting states would look
+// something like:
+// 1. Instance1 = ROLLED_BACK
+// 2. Instance2 = ROLLED_BACK
+// 3. Instance3 = FAILED
+// 4. Instance4 = FAILED
+// However, while the operation is running, the instance might be in other
+// states including PENDING_CREATE, ACTIVE, DELETING and CREATING. The states
+// / do not get further updated once the operation is done.
+message BatchCreateInstanceStatus {
+ // State contains all valid instance states for the BatchCreateInstances
+ // operation. This is mainly used for status reporting through the LRO
+ // metadata.
+ enum State {
+ // The state of the instance is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // Instance is pending creation and has not yet been picked up for
+ // processsing in the backend.
+ PENDING_CREATE = 1;
+
+ // The instance is active and running.
+ READY = 2;
+
+ // The instance is being created.
+ CREATING = 3;
+
+ // The instance is being deleted.
+ DELETING = 4;
+
+ // The creation of the instance failed or a fatal error occurred during
+ // an operation on the instance or a batch of instances.
+ FAILED = 5;
+
+ // The instance was created successfully, but was rolled back and deleted
+ // due to some other failure during BatchCreateInstances operation.
+ ROLLED_BACK = 6;
+ }
+
+ // The current state of an instance involved in the batch create operation.
+ // Once the operation is complete, the final state of the instances in the
+ // LRO can be one of:
+ // 1. ACTIVE, indicating that instances were created successfully
+ // 2. FAILED, indicating that a particular instance failed creation
+ // 3. ROLLED_BACK indicating that although the instance was created
+ // successfully, it had to be rolled back and deleted due to failure in
+ // other steps of the workflow.
+ State state = 1;
+
+ // DEPRECATED - Use the error field instead.
+ // Error, if any error occurred and is available, during instance creation.
+ string error_msg = 2;
+
+ // The RPC status of the instance creation operation. This field will be
+ // present if an error happened during the instance creation.
+ google.rpc.Status error = 4;
+
+ Instance.InstanceType type = 3;
+}
+
+// Message for updating a Instance
+message UpdateInstanceRequest {
+ // Optional. Field mask is used to specify the fields to be overwritten in the
+ // Instance resource by the update.
+ // The fields specified in the update_mask are relative to the resource, not
+ // the full request. A field will be overwritten if it is in the mask. If the
+ // user does not provide a mask then all fields will be overwritten.
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The resource being updated
+ Instance instance = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the update
+ // request.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set to true, update succeeds even if instance is not found. In
+ // that case, a new instance is created and `update_mask` is ignored.
+ bool allow_missing = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for deleting a Instance
+message DeleteInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The current etag of the Instance.
+ // If an etag is provided and does not match the current etag of the Instance,
+ // deletion will be blocked and an ABORTED error will be returned.
+ string etag = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the delete.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for triggering failover on an Instance
+message FailoverInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the failover.
+ bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+message RestartInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the restart.
+ bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for requesting list of Backups
+message ListBackupsRequest {
+ // Required. Parent value for ListBackupsRequest
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Backup"
+ }
+ ];
+
+ // Requested page size. Server may return fewer items than requested.
+ // If unspecified, server will pick an appropriate default.
+ int32 page_size = 2;
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+
+ // Filtering results
+ string filter = 4;
+
+ // Hint for how to order the results
+ string order_by = 5;
+}
+
+// Message for response to listing Backups
+message ListBackupsResponse {
+ // The list of Backup
+ repeated Backup backups = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+
+ // Locations that could not be reached.
+ repeated string unreachable = 3;
+}
+
+// Message for getting a Backup
+message GetBackupRequest {
+ // Required. Name of the resource
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Backup" }
+ ];
+}
+
+// Message for creating a Backup
+message CreateBackupRequest {
+ // Required. Value for parent.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Backup"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string backup_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Backup backup = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, the backend validates the request, but doesn't actually
+ // execute it.
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for updating a Backup
+message UpdateBackupRequest {
+ // Optional. Field mask is used to specify the fields to be overwritten in the
+ // Backup resource by the update.
+ // The fields specified in the update_mask are relative to the resource, not
+ // the full request. A field will be overwritten if it is in the mask. If the
+ // user does not provide a mask then all fields will be overwritten.
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The resource being updated
+ Backup backup = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, the backend validates the request, but doesn't actually
+ // execute it.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set to true, update succeeds even if instance is not found. In
+ // that case, a new backup is created and `update_mask` is ignored.
+ bool allow_missing = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for deleting a Backup
+message DeleteBackupRequest {
+ // Required. Name of the resource. For the required format, see the comment on
+ // the Backup.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Backup" }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, the backend validates the request, but doesn't actually
+ // execute it.
+ bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The current etag of the Backup.
+ // If an etag is provided and does not match the current etag of the Backup,
+ // deletion will be blocked and an ABORTED error will be returned.
+ string etag = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for listing the information about the supported Database flags.
+message ListSupportedDatabaseFlagsRequest {
+ // Required. The name of the parent resource. The required format is:
+ // * projects/{project}/locations/{location}
+ //
+ // Regardless of the parent specified here, as long it is contains a valid
+ // project and location, the service will return a static list of supported
+ // flags resources. Note that we do not yet support region-specific
+ // flags.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/SupportedDatabaseFlag"
+ }
+ ];
+
+ // Requested page size. Server may return fewer items than requested.
+ // If unspecified, server will pick an appropriate default.
+ int32 page_size = 2;
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+}
+
+// Message for response to listing SupportedDatabaseFlags.
+message ListSupportedDatabaseFlagsResponse {
+ // The list of SupportedDatabaseFlags.
+ repeated SupportedDatabaseFlag supported_database_flags = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+}
+
+// Message for requests to generate a client certificate signed by the Cluster
+// CA.
+message GenerateClientCertificateRequest {
+ // Required. The name of the parent resource. The required format is:
+ // * projects/{project}/locations/{location}/clusters/{cluster}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. A pem-encoded X.509 certificate signing request (CSR).
+ string pem_csr = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. An optional hint to the endpoint to generate the client
+ // certificate with the requested duration. The duration can be from 1 hour to
+ // 24 hours. The endpoint may or may not honor the hint. If the hint is left
+ // unspecified or is not honored, then the endpoint will pick an appropriate
+ // default duration.
+ google.protobuf.Duration cert_duration = 4
+ [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message returned by a GenerateClientCertificate operation.
+message GenerateClientCertificateResponse {
+ // Output only. The pem-encoded, signed X.509 certificate.
+ string pem_certificate = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The pem-encoded chain that may be used to verify the X.509
+ // certificate. Expected to be in issuer-to-root order according to RFC 5246.
+ repeated string pem_certificate_chain = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Request message for GetConnectionInfo.
+message GetConnectionInfoRequest {
+ // Required. The name of the parent resource. The required format is:
+ // projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Represents the metadata of the long-running operation.
+message OperationMetadata {
+ // Request specific metadata, if any.
+ oneof request_specific {
+ // Output only. BatchCreateInstances related metadata.
+ BatchCreateInstancesMetadata batch_create_instances_metadata = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Output only. The time the operation was created.
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time the operation finished running.
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Server-defined resource path for the target of the operation.
+ string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Name of the verb executed by the operation.
+ string verb = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Human-readable status of the operation, if any.
+ string status_message = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Identifies whether the user has requested cancellation
+ // of the operation. Operations that have successfully been cancelled
+ // have [Operation.error][] value with a
+ // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
+ // `Code.CANCELLED`.
+ bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. API version used to start the operation.
+ string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/cloud/alloydb/v1beta/BUILD.bazel b/third_party/googleapis/google/cloud/alloydb/v1beta/BUILD.bazel
new file mode 100644
index 000000000..f505602df
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1beta/BUILD.bazel
@@ -0,0 +1,410 @@
+# This file was automatically generated by BuildFileGenerator
+# https://github.com/googleapis/rules_gapic/tree/master/bazel
+
+# Most of the manual changes to this file will be overwritten.
+# It's **only** allowed to change the following rule attribute values:
+# - names of *_gapic_assembly_* rules
+# - certain parameters of *_gapic_library rules, including but not limited to:
+# * extra_protoc_parameters
+# * extra_protoc_file_parameters
+# The complete list of preserved parameters can be found in the source code.
+
+# This is an API workspace, having public visibility by default makes perfect sense.
+package(default_visibility = ["//visibility:public"])
+
+##############################################################################
+# Common
+##############################################################################
+load("@rules_proto//proto:defs.bzl", "proto_library")
+load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
+
+proto_library(
+ name = "alloydb_proto",
+ srcs = [
+ "resources.proto",
+ "service.proto",
+ ],
+ deps = [
+ "//google/api:annotations_proto",
+ "//google/api:client_proto",
+ "//google/api:field_behavior_proto",
+ "//google/api:resource_proto",
+ "//google/longrunning:operations_proto",
+ "//google/rpc:status_proto",
+ "//google/type:dayofweek_proto",
+ "//google/type:timeofday_proto",
+ "@com_google_protobuf//:duration_proto",
+ "@com_google_protobuf//:empty_proto",
+ "@com_google_protobuf//:field_mask_proto",
+ "@com_google_protobuf//:timestamp_proto",
+ "@com_google_protobuf//:wrappers_proto",
+ ],
+)
+
+proto_library_with_info(
+ name = "alloydb_proto_with_info",
+ deps = [
+ ":alloydb_proto",
+ "//google/cloud:common_resources_proto",
+ "//google/cloud/location:location_proto",
+ "//google/iam/v1:iam_policy_proto",
+ ],
+)
+
+##############################################################################
+# Java
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "java_gapic_assembly_gradle_pkg",
+ "java_gapic_library",
+ "java_gapic_test",
+ "java_grpc_library",
+ "java_proto_library",
+)
+
+java_proto_library(
+ name = "alloydb_java_proto",
+ deps = [":alloydb_proto"],
+)
+
+java_grpc_library(
+ name = "alloydb_java_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_java_proto"],
+)
+
+java_gapic_library(
+ name = "alloydb_java_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ gapic_yaml = None,
+ grpc_service_config = "alloydb_v1beta_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1beta.yaml",
+ test_deps = [
+ "//google/cloud/location:location_java_grpc",
+ "//google/iam/v1:iam_java_grpc",
+ ":alloydb_java_grpc",
+ ],
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_java_proto",
+ "//google/api:api_java_proto",
+ "//google/cloud/location:location_java_proto",
+ "//google/iam/v1:iam_java_proto",
+ ],
+)
+
+java_gapic_test(
+ name = "alloydb_java_gapic_test_suite",
+ test_classes = [
+ "com.google.cloud.alloydb.v1beta.AlloyDBAdminClientHttpJsonTest",
+ "com.google.cloud.alloydb.v1beta.AlloyDBAdminClientTest",
+ ],
+ runtime_deps = [":alloydb_java_gapic_test"],
+)
+
+# Open Source Packages
+java_gapic_assembly_gradle_pkg(
+ name = "google-cloud-alloydb-v1beta-java",
+ include_samples = True,
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_java_gapic",
+ ":alloydb_java_grpc",
+ ":alloydb_java_proto",
+ ":alloydb_proto",
+ ],
+)
+
+##############################################################################
+# Go
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "go_gapic_assembly_pkg",
+ "go_gapic_library",
+ "go_proto_library",
+ "go_test",
+)
+
+go_proto_library(
+ name = "alloydb_go_proto",
+ compilers = ["@io_bazel_rules_go//proto:go_grpc"],
+ importpath = "cloud.google.com/go/alloydb/apiv1beta/alloydbpb",
+ protos = [":alloydb_proto"],
+ deps = [
+ "//google/api:annotations_go_proto",
+ "//google/longrunning:longrunning_go_proto",
+ "//google/rpc:status_go_proto",
+ "//google/type:dayofweek_go_proto",
+ "//google/type:timeofday_go_proto",
+ ],
+)
+
+go_gapic_library(
+ name = "alloydb_go_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ grpc_service_config = "alloydb_v1beta_grpc_service_config.json",
+ importpath = "cloud.google.com/go/alloydb/apiv1beta;alloydb",
+ metadata = True,
+ release_level = "beta",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1beta.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_go_proto",
+ "//google/cloud/location:location_go_proto",
+ "//google/iam/v1:iam_go_proto",
+ "//google/longrunning:longrunning_go_proto",
+ "@com_google_cloud_go_longrunning//:go_default_library",
+ "@com_google_cloud_go_longrunning//autogen:go_default_library",
+ "@io_bazel_rules_go//proto/wkt:duration_go_proto",
+ ],
+)
+
+go_test(
+ name = "alloydb_go_gapic_test",
+ srcs = [":alloydb_go_gapic_srcjar_test"],
+ embed = [":alloydb_go_gapic"],
+ importpath = "cloud.google.com/go/alloydb/apiv1beta",
+)
+
+# Open Source Packages
+go_gapic_assembly_pkg(
+ name = "gapi-cloud-alloydb-v1beta-go",
+ deps = [
+ ":alloydb_go_gapic",
+ ":alloydb_go_gapic_srcjar-metadata.srcjar",
+ ":alloydb_go_gapic_srcjar-test.srcjar",
+ ":alloydb_go_proto",
+ ],
+)
+
+##############################################################################
+# Python
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "py_gapic_assembly_pkg",
+ "py_gapic_library",
+ "py_test",
+)
+
+py_gapic_library(
+ name = "alloydb_py_gapic",
+ srcs = [":alloydb_proto"],
+ grpc_service_config = "alloydb_v1beta_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1beta.yaml",
+ transport = "grpc+rest",
+ deps = [
+ "//google/iam/v1:iam_policy_py_proto",
+ ],
+)
+
+py_test(
+ name = "alloydb_py_gapic_test",
+ srcs = [
+ "alloydb_py_gapic_pytest.py",
+ "alloydb_py_gapic_test.py",
+ ],
+ legacy_create_init = False,
+ deps = [":alloydb_py_gapic"],
+)
+
+# Open Source Packages
+py_gapic_assembly_pkg(
+ name = "alloydb-v1beta-py",
+ deps = [
+ ":alloydb_py_gapic",
+ ],
+)
+
+##############################################################################
+# PHP
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "php_gapic_assembly_pkg",
+ "php_gapic_library",
+ "php_grpc_library",
+ "php_proto_library",
+)
+
+php_proto_library(
+ name = "alloydb_php_proto",
+ deps = [":alloydb_proto"],
+)
+
+php_grpc_library(
+ name = "alloydb_php_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_php_proto"],
+)
+
+php_gapic_library(
+ name = "alloydb_php_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ grpc_service_config = "alloydb_v1beta_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1beta.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":alloydb_php_grpc",
+ ":alloydb_php_proto",
+ ],
+)
+
+# Open Source Packages
+php_gapic_assembly_pkg(
+ name = "google-cloud-alloydb-v1beta-php",
+ deps = [
+ ":alloydb_php_gapic",
+ ":alloydb_php_grpc",
+ ":alloydb_php_proto",
+ ],
+)
+
+##############################################################################
+# Node.js
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "nodejs_gapic_assembly_pkg",
+ "nodejs_gapic_library",
+)
+
+nodejs_gapic_library(
+ name = "alloydb_nodejs_gapic",
+ package_name = "@google-cloud/alloydb",
+ src = ":alloydb_proto_with_info",
+ extra_protoc_parameters = ["metadata"],
+ grpc_service_config = "alloydb_v1beta_grpc_service_config.json",
+ package = "google.cloud.alloydb.v1beta",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1beta.yaml",
+ transport = "grpc+rest",
+ deps = [],
+)
+
+nodejs_gapic_assembly_pkg(
+ name = "alloydb-v1beta-nodejs",
+ deps = [
+ ":alloydb_nodejs_gapic",
+ ":alloydb_proto",
+ ],
+)
+
+##############################################################################
+# Ruby
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "ruby_cloud_gapic_library",
+ "ruby_gapic_assembly_pkg",
+ "ruby_grpc_library",
+ "ruby_proto_library",
+)
+
+ruby_proto_library(
+ name = "alloydb_ruby_proto",
+ deps = [":alloydb_proto"],
+)
+
+ruby_grpc_library(
+ name = "alloydb_ruby_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_ruby_proto"],
+)
+
+ruby_cloud_gapic_library(
+ name = "alloydb_ruby_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ extra_protoc_parameters = [
+ "ruby-cloud-gem-name=google-cloud-alloydb-v1beta",
+ ],
+ grpc_service_config = "alloydb_v1beta_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1beta.yaml",
+ deps = [
+ ":alloydb_ruby_grpc",
+ ":alloydb_ruby_proto",
+ ],
+)
+
+# Open Source Packages
+ruby_gapic_assembly_pkg(
+ name = "google-cloud-alloydb-v1beta-ruby",
+ deps = [
+ ":alloydb_ruby_gapic",
+ ":alloydb_ruby_grpc",
+ ":alloydb_ruby_proto",
+ ],
+)
+
+##############################################################################
+# C#
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "csharp_gapic_assembly_pkg",
+ "csharp_gapic_library",
+ "csharp_grpc_library",
+ "csharp_proto_library",
+)
+
+csharp_proto_library(
+ name = "alloydb_csharp_proto",
+ deps = [":alloydb_proto"],
+)
+
+csharp_grpc_library(
+ name = "alloydb_csharp_grpc",
+ srcs = [":alloydb_proto"],
+ deps = [":alloydb_csharp_proto"],
+)
+
+csharp_gapic_library(
+ name = "alloydb_csharp_gapic",
+ srcs = [":alloydb_proto_with_info"],
+ common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
+ grpc_service_config = "alloydb_v1beta_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "alloydb_v1beta.yaml",
+ deps = [
+ ":alloydb_csharp_grpc",
+ ":alloydb_csharp_proto",
+ ],
+)
+
+# Open Source Packages
+csharp_gapic_assembly_pkg(
+ name = "google-cloud-alloydb-v1beta-csharp",
+ deps = [
+ ":alloydb_csharp_gapic",
+ ":alloydb_csharp_grpc",
+ ":alloydb_csharp_proto",
+ ],
+)
+
+##############################################################################
+# C++
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "cc_grpc_library",
+ "cc_proto_library",
+)
+
+cc_proto_library(
+ name = "alloydb_cc_proto",
+ deps = [":alloydb_proto"],
+)
+
+cc_grpc_library(
+ name = "alloydb_cc_grpc",
+ srcs = [":alloydb_proto"],
+ grpc_only = True,
+ deps = [":alloydb_cc_proto"],
+)
diff --git a/third_party/googleapis/google/cloud/alloydb/v1beta/alloydb_v1beta.yaml b/third_party/googleapis/google/cloud/alloydb/v1beta/alloydb_v1beta.yaml
new file mode 100644
index 000000000..e5c69fcf7
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1beta/alloydb_v1beta.yaml
@@ -0,0 +1,229 @@
+type: google.api.Service
+config_version: 3
+name: alloydb.googleapis.com
+title: AlloyDB API
+
+apis:
+- name: google.cloud.alloydb.v1beta.AlloyDBAdmin
+- name: google.cloud.location.Locations
+- name: google.iam.v1.IAMPolicy
+- name: google.longrunning.Operations
+
+types:
+- name: google.cloud.alloydb.v1beta.BatchCreateInstancesResponse
+- name: google.cloud.alloydb.v1beta.OperationMetadata
+
+documentation:
+ summary: |-
+ AlloyDB for PostgreSQL is an open source-compatible database service that
+ provides a powerful option for migrating, modernizing, or building
+ commercial-grade applications. It offers full compatibility with standard
+ PostgreSQL, and is more than 4x faster for transactional workloads and up
+ to 100x faster for analytical queries than standard PostgreSQL in our
+ performance tests. AlloyDB for PostgreSQL offers a 99.99 percent
+ availability SLA inclusive of maintenance.
AlloyDB is optimized
+ for the most demanding use cases, allowing you to build new applications
+ that require high transaction throughput, large database sizes, or
+ multiple read resources; scale existing PostgreSQL workloads with no
+ application changes; and modernize legacy proprietary databases.
+ rules:
+ - selector: google.cloud.location.Locations.GetLocation
+ description: Gets information about a location.
+
+ - selector: google.cloud.location.Locations.ListLocations
+ description: Lists information about the supported locations for this service.
+
+ - selector: google.iam.v1.IAMPolicy.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.
+
+ - selector: google.iam.v1.IAMPolicy.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.
+
+ - selector: google.iam.v1.IAMPolicy.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.
+
+backend:
+ rules:
+ - selector: 'google.cloud.alloydb.v1beta.AlloyDBAdmin.*'
+ deadline: 60.0
+ - selector: google.cloud.location.Locations.GetLocation
+ deadline: 60.0
+ - selector: google.cloud.location.Locations.ListLocations
+ deadline: 60.0
+ - selector: 'google.iam.v1.IAMPolicy.*'
+ deadline: 60.0
+ - selector: 'google.longrunning.Operations.*'
+ deadline: 60.0
+
+http:
+ rules:
+ - selector: google.cloud.location.Locations.GetLocation
+ get: '/v1beta/{name=projects/*/locations/*}'
+ - selector: google.cloud.location.Locations.ListLocations
+ get: '/v1beta/{name=projects/*}/locations'
+ - selector: google.longrunning.Operations.CancelOperation
+ post: '/v1beta/{name=projects/*/locations/*/operations/*}:cancel'
+ - selector: google.longrunning.Operations.DeleteOperation
+ delete: '/v1beta/{name=projects/*/locations/*/operations/*}'
+ - selector: google.longrunning.Operations.GetOperation
+ get: '/v1beta/{name=projects/*/locations/*/operations/*}'
+ - selector: google.longrunning.Operations.ListOperations
+ get: '/v1beta/{name=projects/*/locations/*}/operations'
+
+authentication:
+ rules:
+ - selector: 'google.cloud.alloydb.v1beta.AlloyDBAdmin.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: google.cloud.location.Locations.GetLocation
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: google.cloud.location.Locations.ListLocations
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: 'google.iam.v1.IAMPolicy.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: 'google.longrunning.Operations.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+
+publishing:
+ organization: CLOUD
+ new_issue_uri: 'https://issuetracker.google.com/issues/new?component=1029828'
+ documentation_uri: 'https://cloud.google.com/alloydb/docs'
+ api_short_name: 'alloydb'
+ github_label: 'api: alloydb'
+ doc_tag_prefix: 'alloydb'
+ codeowner_github_teams:
+ library_settings:
+ - version: 'google.cloud.alloydb.v1'
+ launch_stage: GA
+ rest_numeric_enums: false
+ java_settings:
+ library_package: ''
+ service_class_names:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ cpp_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ php_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ python_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ node_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ dotnet_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ ruby_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ go_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ - version: 'google.cloud.alloydb.v1beta'
+ launch_stage: BETA
+ rest_numeric_enums: false
+ java_settings:
+ library_package: ''
+ service_class_names:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ cpp_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ php_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ python_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ node_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ dotnet_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ ruby_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ go_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ - version: 'google.cloud.alloydb.v1alpha'
+ launch_stage: ALPHA
+ rest_numeric_enums: false
+ java_settings:
+ library_package: ''
+ service_class_names:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ cpp_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ php_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ python_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ node_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ dotnet_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ ruby_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
+ go_settings:
+ common:
+ destinations:
+ - PACKAGE_MANAGER
diff --git a/third_party/googleapis/google/cloud/alloydb/v1beta/alloydb_v1beta_grpc_service_config.json b/third_party/googleapis/google/cloud/alloydb/v1beta/alloydb_v1beta_grpc_service_config.json
new file mode 100644
index 000000000..442133114
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1beta/alloydb_v1beta_grpc_service_config.json
@@ -0,0 +1,30 @@
+{
+ "methodConfig": [{
+ "name": [
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin", "method": "ListClusters" },
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin", "method": "GetCluster" },
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin", "method": "ListInstances" },
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin", "method": "GetInstance" },
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin", "method": "ListBackups" },
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin", "method": "GetBackup" },
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin", "method": "ListSupportedDatabaseFlags" },
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin", "method": "GenerateClientCertificate" },
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin", "method": "GetConnectionInfo" },
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin", "method": "ListUsers" },
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin", "method": "GetUser" }
+ ],
+ "timeout": "60s",
+ "retryPolicy": {
+ "initialBackoff": "1s",
+ "maxBackoff": "60s",
+ "backoffMultiplier": 1.3,
+ "retryableStatusCodes": ["UNAVAILABLE"]
+ }
+ },
+ {
+ "name": [
+ { "service": "google.cloud.alloydb.v1beta.AlloyDBAdmin" }
+ ],
+ "timeout": "60s"
+ }]
+}
diff --git a/third_party/googleapis/google/cloud/alloydb/v1beta/resources.proto b/third_party/googleapis/google/cloud/alloydb/v1beta/resources.proto
new file mode 100644
index 000000000..8f71c71fa
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1beta/resources.proto
@@ -0,0 +1,1028 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.alloydb.v1beta;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "google/type/dayofweek.proto";
+import "google/type/timeofday.proto";
+
+option csharp_namespace = "Google.Cloud.AlloyDb.V1Beta";
+option go_package = "cloud.google.com/go/alloydb/apiv1beta/alloydbpb;alloydbpb";
+option java_multiple_files = true;
+option java_outer_classname = "ResourcesProto";
+option java_package = "com.google.cloud.alloydb.v1beta";
+option php_namespace = "Google\\Cloud\\AlloyDb\\V1beta";
+option ruby_package = "Google::Cloud::AlloyDb::V1beta";
+option (google.api.resource_definition) = {
+ type: "cloudkms.googleapis.com/CryptoKeyVersion"
+ pattern: "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}"
+};
+option (google.api.resource_definition) = {
+ type: "compute.googleapis.com/Network"
+ pattern: "projects/{project}/global/networks/{network}"
+};
+
+// The supported database engine versions.
+enum DatabaseVersion {
+ // This is an unknown database version.
+ DATABASE_VERSION_UNSPECIFIED = 0;
+
+ // DEPRECATED - The database version is Postgres 13.
+ POSTGRES_13 = 1 [deprecated = true];
+
+ // The database version is Postgres 14.
+ POSTGRES_14 = 2;
+}
+
+// View on Instance. Pass this enum to rpcs that returns an Instance message to
+// control which subsets of fields to get.
+enum InstanceView {
+ // INSTANCE_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
+ INSTANCE_VIEW_UNSPECIFIED = 0;
+
+ // BASIC server responses for a primary or read instance include all the
+ // relevant instance details, excluding the details of each node in the
+ // instance. The default value.
+ INSTANCE_VIEW_BASIC = 1;
+
+ // FULL response is equivalent to BASIC for primary instance (for now).
+ // For read pool instance, this includes details of each node in the pool.
+ INSTANCE_VIEW_FULL = 2;
+}
+
+// The username/password for a database user. Used for specifying initial
+// users at cluster creation time.
+message UserPassword {
+ // The database username.
+ string user = 1;
+
+ // The initial password for the user.
+ string password = 2;
+}
+
+// Subset of the source instance configuration that is available when reading
+// the cluster resource.
+message MigrationSource {
+ // Denote the type of migration source that created this cluster.
+ enum MigrationSourceType {
+ // Migration source is unknown.
+ MIGRATION_SOURCE_TYPE_UNSPECIFIED = 0;
+
+ // DMS source means the cluster was created via DMS migration job.
+ DMS = 1;
+ }
+
+ // Output only. The host and port of the on-premises instance in host:port
+ // format
+ string host_port = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Place holder for the external source identifier(e.g DMS job
+ // name) that created the cluster.
+ string reference_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Type of migration source.
+ MigrationSourceType source_type = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// EncryptionConfig describes the encryption config of a cluster or a backup
+// that is encrypted with a CMEK (customer-managed encryption key).
+message EncryptionConfig {
+ // The fully-qualified resource name of the KMS key.
+ // Each Cloud KMS key is regionalized and has the following format:
+ // projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
+ string kms_key_name = 1;
+}
+
+// EncryptionInfo describes the encryption information of a cluster or a backup.
+message EncryptionInfo {
+ // Possible encryption types.
+ enum Type {
+ // Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.
+ TYPE_UNSPECIFIED = 0;
+
+ // The data is encrypted at rest with a key that is fully managed by Google.
+ // No key version will be populated. This is the default state.
+ GOOGLE_DEFAULT_ENCRYPTION = 1;
+
+ // The data is encrypted at rest with a key that is managed by the customer.
+ // KMS key versions will be populated.
+ CUSTOMER_MANAGED_ENCRYPTION = 2;
+ }
+
+ // Output only. Type of encryption.
+ Type encryption_type = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Cloud KMS key versions that are being used to protect the
+ // database or the backup.
+ repeated string kms_key_versions = 2 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "cloudkms.googleapis.com/CryptoKeyVersion"
+ }
+ ];
+}
+
+// SSL configuration for an AlloyDB Cluster.
+message SslConfig {
+ // SSL mode options.
+ enum SslMode {
+ // SSL mode not specified. Defaults to SSL_MODE_ALLOW.
+ SSL_MODE_UNSPECIFIED = 0;
+
+ // SSL connections are optional. CA verification not enforced.
+ SSL_MODE_ALLOW = 1;
+
+ // SSL connections are required. CA verification not enforced.
+ // Clients may use locally self-signed certificates (default psql client
+ // behavior).
+ SSL_MODE_REQUIRE = 2;
+
+ // SSL connections are required. CA verification enforced.
+ // Clients must have certificates signed by a Cluster CA, e.g. via
+ // GenerateClientCertificate.
+ SSL_MODE_VERIFY_CA = 3;
+ }
+
+ // Certificate Authority (CA) source for SSL/TLS certificates.
+ enum CaSource {
+ // Certificate Authority (CA) source not specified. Defaults to
+ // CA_SOURCE_MANAGED.
+ CA_SOURCE_UNSPECIFIED = 0;
+
+ // Certificate Authority (CA) managed by the AlloyDB Cluster.
+ CA_SOURCE_MANAGED = 1;
+ }
+
+ // Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
+ SslMode ssl_mode = 1 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is
+ // supported currently, and is the default value.
+ CaSource ca_source = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message describing the user-specified automated backup policy.
+//
+// All fields in the automated backup policy are optional. Defaults for each
+// field are provided if they are not set.
+message AutomatedBackupPolicy {
+ // A weekly schedule starts a backup at prescribed start times within a
+ // day, for the specified days of the week.
+ //
+ // The weekly schedule message is flexible and can be used to create many
+ // types of schedules. For example, to have a daily backup that starts at
+ // 22:00, configure the `start_times` field to have one element "22:00" and
+ // the `days_of_week` field to have all seven days of the week.
+ message WeeklySchedule {
+ // The times during the day to start a backup. The start times are assumed
+ // to be in UTC and to be an exact hour (e.g., 04:00:00).
+ //
+ // If no start times are provided, a single fixed start time is chosen
+ // arbitrarily.
+ repeated google.type.TimeOfDay start_times = 1;
+
+ // The days of the week to perform a backup.
+ //
+ // If this field is left empty, the default of every day of the week is
+ // used.
+ repeated google.type.DayOfWeek days_of_week = 2;
+ }
+
+ // A time based retention policy specifies that all backups within a certain
+ // time period should be retained.
+ message TimeBasedRetention {
+ // The retention period.
+ google.protobuf.Duration retention_period = 1;
+ }
+
+ // A quantity based policy specifies that a certain number of the most recent
+ // successful backups should be retained.
+ message QuantityBasedRetention {
+ // The number of backups to retain.
+ int32 count = 1;
+ }
+
+ // The schedule for this automated backup policy.
+ //
+ // A schedule specifies times at which to start a backup. If a backup
+ // window is also provided, the backup is guaranteed to be started and
+ // completed within the start time plus the backup window. If the backup is
+ // not completed within the backup window it is marked as failed.
+ //
+ // If not set, the schedule defaults to a weekly schedule with one backup
+ // per day and a start time chosen arbitrarily.
+ oneof schedule {
+ // Weekly schedule for the Backup.
+ WeeklySchedule weekly_schedule = 2;
+ }
+
+ // The retention policy for automated backups.
+ //
+ // The retention policy for a backup is fixed at the time the backup is
+ // created. Changes to this field only apply to new backups taken with the
+ // policy; the retentions of existing backups remain unchanged.
+ //
+ // If no retention policy is set, a default of 14 days is used.
+ oneof retention {
+ // Time-based Backup retention policy.
+ TimeBasedRetention time_based_retention = 4;
+
+ // Quantity-based Backup retention policy to retain recent backups.
+ QuantityBasedRetention quantity_based_retention = 5;
+ }
+
+ // Whether automated automated backups are enabled. If not set, defaults to
+ // true.
+ optional bool enabled = 1;
+
+ // The length of the time window during which a backup can be
+ // taken. If a backup does not succeed within this time window, it will be
+ // canceled and considered failed.
+ //
+ // The backup window must be at least 5 minutes long. There is no upper bound
+ // on the window. If not set, it defaults to 1 hour.
+ google.protobuf.Duration backup_window = 3;
+
+ // Optional. The encryption config can be specified to encrypt the
+ // backups with a customer-managed encryption key (CMEK). When this field is
+ // not specified, the backup will then use default encryption scheme to
+ // protect the user data.
+ EncryptionConfig encryption_config = 8
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // The location where the backup will be stored. Currently, the only supported
+ // option is to store the backup in the same region as the cluster.
+ //
+ // If empty, defaults to the region of the cluster.
+ string location = 6;
+
+ // Labels to apply to backups created using this configuration.
+ map labels = 7;
+}
+
+// ContinuousBackupConfig describes the continuous backups recovery
+// configurations of a cluster.
+message ContinuousBackupConfig {
+ // Whether ContinuousBackup is enabled.
+ optional bool enabled = 1;
+
+ // The number of days backups and logs will be retained, which determines the
+ // window of time that data is recoverable for. If not set, it defaults to 14
+ // days.
+ int32 recovery_window_days = 4;
+
+ // The encryption config can be specified to encrypt the
+ // backups with a customer-managed encryption key (CMEK). When this field is
+ // not specified, the backup will then use default encryption scheme to
+ // protect the user data.
+ EncryptionConfig encryption_config = 3;
+}
+
+// ContinuousBackupInfo describes the continuous backup properties of a
+// cluster.
+message ContinuousBackupInfo {
+ // Output only. The encryption information for the WALs and backups required
+ // for ContinuousBackup.
+ EncryptionInfo encryption_info = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. When ContinuousBackup was most recently enabled. Set to null
+ // if ContinuousBackup is not enabled.
+ google.protobuf.Timestamp enabled_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Days of the week on which a continuous backup is taken. Output
+ // only field. Ignored if passed into the request.
+ repeated google.type.DayOfWeek schedule = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Message describing a BackupSource.
+message BackupSource {
+ // Output only. The system-generated UID of the backup which was used to
+ // create this resource. The UID is generated when the backup is created, and
+ // it is retained until the backup is deleted.
+ string backup_uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The name of the backup resource with the format:
+ // * projects/{project}/locations/{region}/backups/{backup_id}
+ string backup_name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Backup" }
+ ];
+}
+
+// Message describing a ContinuousBackupSource.
+message ContinuousBackupSource {
+ // Required. The source cluster from which to restore. This cluster must have
+ // continuous backup enabled for this operation to succeed. For the required
+ // format, see the comment on the Cluster.name field.
+ string cluster = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The point in time to restore to.
+ google.protobuf.Timestamp point_in_time = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// A cluster is a collection of regional AlloyDB resources. It can include a
+// primary instance and one or more read pool instances.
+// All cluster resources share a storage layer, which scales as needed.
+message Cluster {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/Cluster"
+ pattern: "projects/{project}/locations/{location}/clusters/{cluster}"
+ style: DECLARATIVE_FRIENDLY
+ };
+
+ // Configuration information for the secondary cluster. This should be set
+ // if and only if the cluster is of type SECONDARY.
+ message SecondaryConfig {
+ // The name of the primary cluster name with the format:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}
+ string primary_cluster_name = 1;
+ }
+
+ // Configuration for the primary cluster. It has the list of clusters that are
+ // replicating from this cluster. This should be set if and only if the
+ // cluster is of type PRIMARY.
+ message PrimaryConfig {
+ // Output only. Names of the clusters that are replicating from this
+ // cluster.
+ repeated string secondary_cluster_names = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Cluster State
+ enum State {
+ // The state of the cluster is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // The cluster is active and running.
+ READY = 1;
+
+ // The cluster is stopped. All instances in the cluster are stopped.
+ // Customers can start a stopped cluster at any point and all their
+ // instances will come back to life with same names and IP resources. In
+ // this state, customer pays for storage.
+ // Associated backups could also be present in a stopped cluster.
+ STOPPED = 2;
+
+ // The cluster is empty and has no associated resources.
+ // All instances, associated storage and backups have been deleted.
+ EMPTY = 3;
+
+ // The cluster is being created.
+ CREATING = 4;
+
+ // The cluster is being deleted.
+ DELETING = 5;
+
+ // The creation of the cluster failed.
+ FAILED = 6;
+
+ // The cluster is bootstrapping with data from some other source.
+ // Direct mutations to the cluster (e.g. adding read pool) are not allowed.
+ BOOTSTRAPPING = 7;
+
+ // The cluster is under maintenance. AlloyDB regularly performs maintenance
+ // and upgrades on customer clusters. Updates on the cluster are
+ // not allowed while the cluster is in this state.
+ MAINTENANCE = 8;
+
+ // The cluster is being promoted.
+ PROMOTING = 9;
+ }
+
+ // Type of Cluster
+ enum ClusterType {
+ // The type of the cluster is unknown.
+ CLUSTER_TYPE_UNSPECIFIED = 0;
+
+ // Primary cluster that support read and write operations.
+ PRIMARY = 1;
+
+ // Secondary cluster that is replicating from another region.
+ // This only supports read.
+ SECONDARY = 2;
+ }
+
+ // In case of an imported cluster, this field contains information about the
+ // source this cluster was imported from.
+ oneof source {
+ // Output only. Cluster created from backup.
+ BackupSource backup_source = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Cluster created via DMS migration.
+ MigrationSource migration_source = 16
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Output only. The name of the cluster resource with the format:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}
+ // where the cluster ID segment should satisfy the regex expression
+ // `[a-z0-9-]+`. For more details see https://google.aip.dev/122.
+ // The prefix of the cluster resource name is the name of the parent resource:
+ // * projects/{project}/locations/{region}
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // User-settable and human-readable display name for the Cluster.
+ string display_name = 2;
+
+ // Output only. The system-generated UID of the resource. The UID is assigned
+ // when the resource is created, and it is retained until it is deleted.
+ string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Create time stamp
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Update time stamp
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Delete time stamp
+ google.protobuf.Timestamp delete_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Labels as key value pairs
+ map labels = 7;
+
+ // Output only. The current serving state of the cluster.
+ State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The type of the cluster. This is an output-only field and it's
+ // populated at the Cluster creation time or the Cluster promotion
+ // time. The cluster type is determined by which RPC was used to create
+ // the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
+ ClusterType cluster_type = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The database engine major version. This is an output-only
+ // field and it's populated at the Cluster creation time. This field cannot be
+ // changed after cluster creation.
+ DatabaseVersion database_version = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The resource link for the VPC network in which cluster resources
+ // are created and from which they are accessible via Private IP. The network
+ // must belong to the same project as the cluster. It is specified in the
+ // form: "projects/{project_number}/global/networks/{network_id}". This is
+ // required to create a cluster. It can be updated, but it cannot be removed.
+ string network = 10 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
+ ];
+
+ // For Resource freshness validation (https://google.aip.dev/154)
+ string etag = 11;
+
+ // Annotations to allow client tools to store small amount of arbitrary data.
+ // This is distinct from labels.
+ // https://google.aip.dev/128
+ map annotations = 12;
+
+ // Output only. Reconciling (https://google.aip.dev/128#reconciliation).
+ // Set to true if the current state of Cluster does not match the user's
+ // intended state, and the service is actively updating the resource to
+ // reconcile them. This can happen due to user-triggered updates or
+ // system actions like failover or maintenance.
+ bool reconciling = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Input only. Initial user to setup during cluster creation. Required.
+ // If used in `RestoreCluster` this is ignored.
+ UserPassword initial_user = 14 [(google.api.field_behavior) = INPUT_ONLY];
+
+ // The automated backup policy for this cluster.
+ //
+ // If no policy is provided then the default policy will be used. If backups
+ // are supported for the cluster, the default policy takes one backup a day,
+ // has a backup window of 1 hour, and retains backups for 14 days.
+ // For more information on the defaults, consult the
+ // documentation for the message type.
+ AutomatedBackupPolicy automated_backup_policy = 17;
+
+ // SSL configuration for this AlloyDB Cluster.
+ SslConfig ssl_config = 18;
+
+ // Optional. The encryption config can be specified to encrypt the data disks
+ // and other persistent data resources of a cluster with a
+ // customer-managed encryption key (CMEK). When this field is not
+ // specified, the cluster will then use default encryption scheme to
+ // protect the user data.
+ EncryptionConfig encryption_config = 19
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Output only. The encryption information for the cluster.
+ EncryptionInfo encryption_info = 20
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Optional. Continuous backup configuration for this cluster.
+ ContinuousBackupConfig continuous_backup_config = 27
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Output only. Continuous backup properties for this cluster.
+ ContinuousBackupInfo continuous_backup_info = 28
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Cross Region replication config specific to SECONDARY cluster.
+ SecondaryConfig secondary_config = 22;
+
+ // Output only. Cross Region replication config specific to PRIMARY cluster.
+ PrimaryConfig primary_config = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// An Instance is a computing unit that an end customer can connect to.
+// It's the main unit of computing resources in AlloyDB.
+message Instance {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/Instance"
+ pattern: "projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}"
+ style: DECLARATIVE_FRIENDLY
+ };
+
+ // MachineConfig describes the configuration of a machine.
+ message MachineConfig {
+ // The number of CPU's in the VM instance.
+ int32 cpu_count = 1;
+ }
+
+ // Details of a single node in the instance.
+ // Nodes in an AlloyDB instance are ephemereal, they can change during
+ // update, failover, autohealing and resize operations.
+ message Node {
+ // The Compute Engine zone of the VM e.g. "us-central1-b".
+ string zone_id = 1;
+
+ // The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
+ string id = 2;
+
+ // The private IP address of the VM e.g. "10.57.0.34".
+ string ip = 3;
+
+ // Determined by state of the compute VM and postgres-service health.
+ // Compute VM state can have values listed in
+ // https://cloud.google.com/compute/docs/instances/instance-life-cycle and
+ // postgres-service health can have values: HEALTHY and UNHEALTHY.
+ string state = 4;
+ }
+
+ // QueryInsights Instance specific configuration.
+ message QueryInsightsInstanceConfig {
+ // Record application tags for an instance.
+ // This flag is turned "on" by default.
+ optional bool record_application_tags = 2;
+
+ // Record client address for an instance. Client address is PII information.
+ // This flag is turned "on" by default.
+ optional bool record_client_address = 3;
+
+ // Query string length. The default value is 1024.
+ // Any integer between 256 and 4500 is considered valid.
+ uint32 query_string_length = 4;
+
+ // Number of query execution plans captured by Insights per minute
+ // for all queries combined. The default value is 5.
+ // Any integer between 0 and 20 is considered valid.
+ optional uint32 query_plans_per_minute = 5;
+ }
+
+ // Configuration for a read pool instance.
+ message ReadPoolConfig {
+ // Read capacity, i.e. number of nodes in a read pool instance.
+ int32 node_count = 1;
+ }
+
+ // Instance State
+ enum State {
+ // The state of the instance is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // The instance is active and running.
+ READY = 1;
+
+ // The instance is stopped. Instance name and IP resources are preserved.
+ STOPPED = 2;
+
+ // The instance is being created.
+ CREATING = 3;
+
+ // The instance is being deleted.
+ DELETING = 4;
+
+ // The instance is down for maintenance.
+ MAINTENANCE = 5;
+
+ // The creation of the instance failed or a fatal error occurred during
+ // an operation on the instance.
+ // Note: Instances in this state would tried to be auto-repaired. And
+ // Customers should be able to restart, update or delete these instances.
+ FAILED = 6;
+
+ // Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
+ // index unused in case that state also needs to exposed via consumer apis
+ // in future.
+ // The instance has been configured to sync data from some other source.
+ BOOTSTRAPPING = 8;
+
+ // The instance is being promoted.
+ PROMOTING = 9;
+ }
+
+ // Type of an Instance
+ enum InstanceType {
+ // The type of the instance is unknown.
+ INSTANCE_TYPE_UNSPECIFIED = 0;
+
+ // PRIMARY instances support read and write operations.
+ PRIMARY = 1;
+
+ // READ POOL instances support read operations only. Each read pool instance
+ // consists of one or more homogeneous nodes.
+ // * Read pool of size 1 can only have zonal availability.
+ // * Read pools with node count of 2 or more can have regional
+ // availability (nodes are present in 2 or more zones in a region).
+ READ_POOL = 2;
+
+ // SECONDARY instances support read operations only. SECONDARY instance
+ // is a cross-region read replica
+ SECONDARY = 3;
+ }
+
+ // The Availability type of an instance. Potential values:
+ //
ZONAL: The instance serves data from only one zone.
+ // Outages in that zone affect instance availability.
+ //
REGIONAL: The instance can serve data from more than one zone
+ // in a region (it is highly available).
+ enum AvailabilityType {
+ // This is an unknown Availability type.
+ AVAILABILITY_TYPE_UNSPECIFIED = 0;
+
+ // Zonal available instance.
+ ZONAL = 1;
+
+ // Regional (or Highly) available instance.
+ REGIONAL = 2;
+ }
+
+ // Output only. The name of the instance resource with the format:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id}
+ // where the cluster and instance ID segments should satisfy the regex
+ // expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
+ // lowercase letters, numbers, and dashes, starting with a letter, and ending
+ // with a letter or number. For more details see https://google.aip.dev/122.
+ // The prefix of the instance resource name is the name of the parent
+ // resource:
+ // * projects/{project}/locations/{region}/clusters/{cluster_id}
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // User-settable and human-readable display name for the Instance.
+ string display_name = 2;
+
+ // Output only. The system-generated UID of the resource. The UID is assigned
+ // when the resource is created, and it is retained until it is deleted.
+ string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Create time stamp
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Update time stamp
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Delete time stamp
+ google.protobuf.Timestamp delete_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Labels as key value pairs
+ map labels = 7;
+
+ // Output only. The current serving state of the instance.
+ State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The type of the instance. Specified at creation time.
+ InstanceType instance_type = 9 [(google.api.field_behavior) = REQUIRED];
+
+ // Configurations for the machines that host the underlying
+ // database engine.
+ MachineConfig machine_config = 10;
+
+ // Availability type of an Instance.
+ // Defaults to REGIONAL for both primary and read instances.
+ // Note that primary and read instances can have different availability types.
+ AvailabilityType availability_type = 11;
+
+ // The Compute Engine zone that the instance should serve from, per
+ // https://cloud.google.com/compute/docs/regions-zones
+ // This can ONLY be specified for ZONAL instances.
+ // If present for a REGIONAL instance, an error will be thrown.
+ // If this is absent for a ZONAL instance, instance is created in a random
+ // zone with available capacity.
+ string gce_zone = 12;
+
+ // Database flags. Set at instance level.
+ // * They are copied from primary instance on read instance creation.
+ // * Read instances can set new or override existing flags that are relevant
+ // for reads, e.g. for enabling columnar cache on a read instance. Flags
+ // set on read instance may or may not be present on primary.
+ //
+ //
+ // This is a list of "key": "value" pairs.
+ // "key": The name of the flag. These flags are passed at instance setup time,
+ // so include both server options and system variables for Postgres. Flags are
+ // specified with underscores, not hyphens.
+ // "value": 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.
+ map database_flags = 13;
+
+ // Output only. This is set for the read-write VM of the PRIMARY instance
+ // only.
+ Node writable_node = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. List of available read-only VMs in this instance, including
+ // the standby for a PRIMARY instance.
+ repeated Node nodes = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Configuration for query insights.
+ QueryInsightsInstanceConfig query_insights_config = 21;
+
+ // Read pool specific config.
+ ReadPoolConfig read_pool_config = 14;
+
+ // Output only. The IP address for the Instance.
+ // This is the connection endpoint for an end-user application.
+ string ip_address = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Reconciling (https://google.aip.dev/128#reconciliation).
+ // Set to true if the current state of Instance does not match the user's
+ // intended state, and the service is actively updating the resource to
+ // reconcile them. This can happen due to user-triggered updates or
+ // system actions like failover or maintenance.
+ bool reconciling = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // For Resource freshness validation (https://google.aip.dev/154)
+ string etag = 17;
+
+ // Annotations to allow client tools to store small amount of arbitrary data.
+ // This is distinct from labels.
+ // https://google.aip.dev/128
+ map annotations = 18;
+}
+
+// ConnectionInfo singleton resource.
+// https://google.aip.dev/156
+message ConnectionInfo {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/ConnectionInfo"
+ pattern: "projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}/connectionInfo"
+ };
+
+ // The name of the ConnectionInfo singleton resource, e.g.:
+ // projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo
+ // This field currently has no semantic meaning.
+ string name = 1;
+
+ // Output only. The IP address for the Instance.
+ // This is the connection endpoint for an end-user application.
+ string ip_address = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The pem-encoded chain that may be used to verify the X.509
+ // certificate. Expected to be in issuer-to-root order according to RFC 5246.
+ repeated string pem_certificate_chain = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The unique ID of the Instance.
+ string instance_uid = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Message describing Backup object
+message Backup {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/Backup"
+ pattern: "projects/{project}/locations/{location}/backups/{backup}"
+ style: DECLARATIVE_FRIENDLY
+ };
+
+ // Backup State
+ enum State {
+ // The state of the backup is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // The backup is ready.
+ READY = 1;
+
+ // The backup is creating.
+ CREATING = 2;
+
+ // The backup failed.
+ FAILED = 3;
+
+ // The backup is being deleted.
+ DELETING = 4;
+ }
+
+ // Backup Type
+ enum Type {
+ // Backup Type is unknown.
+ TYPE_UNSPECIFIED = 0;
+
+ // ON_DEMAND backups that were triggered by the customer (e.g., not
+ // AUTOMATED).
+ ON_DEMAND = 1;
+
+ // AUTOMATED backups triggered by the automated backups scheduler pursuant
+ // to an automated backup policy.
+ AUTOMATED = 2;
+
+ // CONTINUOUS backups triggered by the automated backups scheduler
+ // due to a continuous backup policy.
+ CONTINUOUS = 3;
+ }
+
+ // Output only. The name of the backup resource with the format:
+ // * projects/{project}/locations/{region}/backups/{backup_id}
+ // where the cluster and backup ID segments should satisfy the regex
+ // expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
+ // lowercase letters, numbers, and dashes, starting with a letter, and ending
+ // with a letter or number. For more details see https://google.aip.dev/122.
+ // The prefix of the backup resource name is the name of the parent
+ // resource:
+ // * projects/{project}/locations/{region}
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // User-settable and human-readable display name for the Backup.
+ string display_name = 2;
+
+ // Output only. The system-generated UID of the resource. The UID is assigned
+ // when the resource is created, and it is retained until it is deleted.
+ string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Create time stamp
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Update time stamp
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Delete time stamp
+ google.protobuf.Timestamp delete_time = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Labels as key value pairs
+ map labels = 6;
+
+ // Output only. The current state of the backup.
+ State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The backup type, which suggests the trigger for the backup.
+ Type type = 8;
+
+ // User-provided description of the backup.
+ string description = 9;
+
+ // Output only. The system-generated UID of the cluster which was used to
+ // create this resource.
+ string cluster_uid = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The full resource name of the backup source cluster
+ // (e.g., projects//locations//clusters/).
+ string cluster_name = 10 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+
+ // Output only. Reconciling (https://google.aip.dev/128#reconciliation), if
+ // true, indicates that the service is actively updating the resource. This
+ // can happen due to user-triggered updates or system actions like failover or
+ // maintenance.
+ bool reconciling = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Optional. The encryption config can be specified to encrypt the
+ // backup with a customer-managed encryption key (CMEK). When this field is
+ // not specified, the backup will then use default encryption scheme to
+ // protect the user data.
+ EncryptionConfig encryption_config = 12
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Output only. The encryption information for the backup.
+ EncryptionInfo encryption_info = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // For Resource freshness validation (https://google.aip.dev/154)
+ string etag = 14;
+
+ // Annotations to allow client tools to store small amount of arbitrary data.
+ // This is distinct from labels.
+ // https://google.aip.dev/128
+ map annotations = 16;
+
+ // Output only. The size of the backup in bytes.
+ int64 size_bytes = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time at which after the backup is eligible to be garbage
+ // collected. It is the duration specified by the backup's retention policy,
+ // added to the backup's create_time.
+ google.protobuf.Timestamp expiry_time = 19
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// SupportedDatabaseFlag gives general information about a database flag,
+// like type and allowed values. This is a static value that is defined
+// on the server side, and it cannot be modified by callers.
+// To set the Database flags on a particular Instance, a caller should modify
+// the Instance.database_flags field.
+message SupportedDatabaseFlag {
+ option (google.api.resource) = {
+ type: "alloydb.googleapis.com/SupportedDatabaseFlag"
+ pattern: "projects/{project}/locations/{location}/flags/{flag}"
+ };
+
+ // Restrictions on STRING type values
+ message StringRestrictions {
+ // The list of allowed values, if bounded. This field will be empty
+ // if there is a unbounded number of allowed values.
+ repeated string allowed_values = 1;
+ }
+
+ // Restrictions on INTEGER type values.
+ message IntegerRestrictions {
+ // The minimum value that can be specified, if applicable.
+ google.protobuf.Int64Value min_value = 1;
+
+ // The maximum value that can be specified, if applicable.
+ google.protobuf.Int64Value max_value = 2;
+ }
+
+ // ValueType describes the semantic type of the value that the flag accepts.
+ // Regardless of the ValueType, the Instance.database_flags field accepts the
+ // stringified version of the value, i.e. "20" or "3.14".
+ enum ValueType {
+ // This is an unknown flag type.
+ VALUE_TYPE_UNSPECIFIED = 0;
+
+ // String type flag.
+ STRING = 1;
+
+ // Integer type flag.
+ INTEGER = 2;
+
+ // Float type flag.
+ FLOAT = 3;
+
+ // Denotes that the flag does not accept any values.
+ NONE = 4;
+ }
+
+ // The restrictions on the flag value per type.
+ oneof restrictions {
+ // Restriction on STRING type value.
+ StringRestrictions string_restrictions = 7;
+
+ // Restriction on INTEGER type value.
+ IntegerRestrictions integer_restrictions = 8;
+ }
+
+ // The name of the flag resource, following Google Cloud conventions, e.g.:
+ // * projects/{project}/locations/{location}/flags/{flag}
+ // This field currently has no semantic meaning.
+ string name = 1;
+
+ // The name of the database flag, e.g. "max_allowed_packets".
+ // The is a possibly key for the Instance.database_flags map field.
+ string flag_name = 2;
+
+ ValueType value_type = 3;
+
+ // Whether the database flag accepts multiple values. If true,
+ // a comma-separated list of stringified values may be specified.
+ bool accepts_multiple_values = 4;
+
+ // Major database engine versions for which this flag is supported.
+ repeated DatabaseVersion supported_db_versions = 5;
+
+ // Whether setting or updating this flag on an Instance requires a database
+ // restart. If a flag that requires database restart is set, the backend
+ // will automatically restart the database (making sure to satisfy any
+ // availability SLO's).
+ bool requires_db_restart = 6;
+}
diff --git a/third_party/googleapis/google/cloud/alloydb/v1beta/service.proto b/third_party/googleapis/google/cloud/alloydb/v1beta/service.proto
new file mode 100644
index 000000000..4b081d95b
--- /dev/null
+++ b/third_party/googleapis/google/cloud/alloydb/v1beta/service.proto
@@ -0,0 +1,1329 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.alloydb.v1beta;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/alloydb/v1beta/resources.proto";
+import "google/longrunning/operations.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
+import "google/rpc/status.proto";
+
+option csharp_namespace = "Google.Cloud.AlloyDb.V1Beta";
+option go_package = "cloud.google.com/go/alloydb/apiv1beta/alloydbpb;alloydbpb";
+option java_multiple_files = true;
+option java_outer_classname = "ServiceProto";
+option java_package = "com.google.cloud.alloydb.v1beta";
+option php_namespace = "Google\\Cloud\\AlloyDb\\V1beta";
+option ruby_package = "Google::Cloud::AlloyDb::V1beta";
+
+// Service describing handlers for resources
+service AlloyDBAdmin {
+ option (google.api.default_host) = "alloydb.googleapis.com";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
+
+ // Lists Clusters in a given project and location.
+ rpc ListClusters(ListClustersRequest) returns (ListClustersResponse) {
+ option (google.api.http) = {
+ get: "/v1beta/{parent=projects/*/locations/*}/clusters"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Gets details of a single Cluster.
+ rpc GetCluster(GetClusterRequest) returns (Cluster) {
+ option (google.api.http) = {
+ get: "/v1beta/{name=projects/*/locations/*/clusters/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Creates a new Cluster in a given project and location.
+ rpc CreateCluster(CreateClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1beta/{parent=projects/*/locations/*}/clusters"
+ body: "cluster"
+ };
+ option (google.api.method_signature) = "parent,cluster,cluster_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Updates the parameters of a single Cluster.
+ rpc UpdateCluster(UpdateClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ patch: "/v1beta/{cluster.name=projects/*/locations/*/clusters/*}"
+ body: "cluster"
+ };
+ option (google.api.method_signature) = "cluster,update_mask";
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Deletes a single Cluster.
+ rpc DeleteCluster(DeleteClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1beta/{name=projects/*/locations/*/clusters/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Promotes a SECONDARY cluster. This turns down replication
+ // from the PRIMARY cluster and promotes a secondary cluster
+ // into its own standalone cluster.
+ // Imperative only.
+ rpc PromoteCluster(PromoteClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1beta/{name=projects/*/locations/*/clusters/*}:promote"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Creates a new Cluster in a given project and location, with a volume
+ // restored from the provided source, either a backup ID or a point-in-time
+ // and a source cluster.
+ rpc RestoreCluster(RestoreClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1beta/{parent=projects/*/locations/*}/clusters:restore"
+ body: "*"
+ };
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Creates a cluster of type SECONDARY in the given location using
+ // the primary cluster as the source.
+ rpc CreateSecondaryCluster(CreateSecondaryClusterRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1beta/{parent=projects/*/locations/*}/clusters:createsecondary"
+ body: "cluster"
+ };
+ option (google.api.method_signature) = "parent,cluster,cluster_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Cluster"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Lists Instances in a given project and location.
+ rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse) {
+ option (google.api.http) = {
+ get: "/v1beta/{parent=projects/*/locations/*/clusters/*}/instances"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Gets details of a single Instance.
+ rpc GetInstance(GetInstanceRequest) returns (Instance) {
+ option (google.api.http) = {
+ get: "/v1beta/{name=projects/*/locations/*/clusters/*/instances/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Creates a new Instance in a given project and location.
+ rpc CreateInstance(CreateInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1beta/{parent=projects/*/locations/*/clusters/*}/instances"
+ body: "instance"
+ };
+ option (google.api.method_signature) = "parent,instance,instance_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Creates a new SECONDARY Instance in a given project and location.
+ rpc CreateSecondaryInstance(CreateSecondaryInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1beta/{parent=projects/*/locations/*/clusters/*}/instances:createsecondary"
+ body: "instance"
+ };
+ option (google.api.method_signature) = "parent,instance,instance_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Creates new instances under the given project, location and cluster.
+ // There can be only one primary instance in a cluster. If the primary
+ // instance exists in the cluster as well as this request, then API will
+ // throw an error.
+ // The primary instance should exist before any read pool instance is
+ // created. If the primary instance is a part of the request payload, then
+ // the API will take care of creating instances in the correct order.
+ // This method is here to support Google-internal use cases, and is not meant
+ // for external customers to consume. Please do not start relying on it; its
+ // behavior is subject to change without notice.
+ rpc BatchCreateInstances(BatchCreateInstancesRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1beta/{parent=projects/*/locations/*/clusters/*}/instances:batchCreate"
+ body: "requests"
+ };
+ option (google.longrunning.operation_info) = {
+ response_type: "BatchCreateInstancesResponse"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Updates the parameters of a single Instance.
+ rpc UpdateInstance(UpdateInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ patch: "/v1beta/{instance.name=projects/*/locations/*/clusters/*/instances/*}"
+ body: "instance"
+ };
+ option (google.api.method_signature) = "instance,update_mask";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Deletes a single Instance.
+ rpc DeleteInstance(DeleteInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1beta/{name=projects/*/locations/*/clusters/*/instances/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Forces a Failover for a highly available instance.
+ // Failover promotes the HA standby instance as the new primary.
+ // Imperative only.
+ rpc FailoverInstance(FailoverInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1beta/{name=projects/*/locations/*/clusters/*/instances/*}:failover"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Restart an Instance in a cluster.
+ // Imperative only.
+ rpc RestartInstance(RestartInstanceRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1beta/{name=projects/*/locations/*/clusters/*/instances/*}:restart"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "Instance"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Lists Backups in a given project and location.
+ rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse) {
+ option (google.api.http) = {
+ get: "/v1beta/{parent=projects/*/locations/*}/backups"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Gets details of a single Backup.
+ rpc GetBackup(GetBackupRequest) returns (Backup) {
+ option (google.api.http) = {
+ get: "/v1beta/{name=projects/*/locations/*/backups/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Creates a new Backup in a given project and location.
+ rpc CreateBackup(CreateBackupRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1beta/{parent=projects/*/locations/*}/backups"
+ body: "backup"
+ };
+ option (google.api.method_signature) = "parent,backup,backup_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "Backup"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Updates the parameters of a single Backup.
+ rpc UpdateBackup(UpdateBackupRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ patch: "/v1beta/{backup.name=projects/*/locations/*/backups/*}"
+ body: "backup"
+ };
+ option (google.api.method_signature) = "backup,update_mask";
+ option (google.longrunning.operation_info) = {
+ response_type: "Backup"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Deletes a single Backup.
+ rpc DeleteBackup(DeleteBackupRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1beta/{name=projects/*/locations/*/backups/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Lists SupportedDatabaseFlags for a given project and location.
+ rpc ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest)
+ returns (ListSupportedDatabaseFlagsResponse) {
+ option (google.api.http) = {
+ get: "/v1beta/{parent=projects/*/locations/*}/supportedDatabaseFlags"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Generate a client certificate signed by a Cluster CA.
+ // The sole purpose of this endpoint is to support the Auth Proxy client and
+ // the endpoint's behavior is subject to change without notice, so do not rely
+ // on its behavior remaining constant. Future changes will not break the Auth
+ // Proxy client.
+ rpc GenerateClientCertificate(GenerateClientCertificateRequest)
+ returns (GenerateClientCertificateResponse) {
+ option (google.api.http) = {
+ post: "/v1beta/{parent=projects/*/locations/*/clusters/*}:generateClientCertificate"
+ body: "*"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Get instance metadata used for a connection.
+ rpc GetConnectionInfo(GetConnectionInfoRequest) returns (ConnectionInfo) {
+ option (google.api.http) = {
+ get: "/v1beta/{parent=projects/*/locations/*/clusters/*/instances/*}/connectionInfo"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+}
+
+// Message for requesting list of Clusters
+message ListClustersRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Cluster.name field. Additionally, you can perform an
+ // aggregated list operation by specifying a value with the following format:
+ // * projects/{project}/locations/-
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Cluster"
+ }
+ ];
+
+ // Optional. Requested page size. Server may return fewer items than
+ // requested. If unspecified, server will pick an appropriate default.
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+
+ // Optional. Filtering results
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Hint for how to order the results
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for response to listing Clusters
+message ListClustersResponse {
+ // The list of Cluster
+ repeated Cluster clusters = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+
+ // Locations that could not be reached.
+ repeated string unreachable = 3;
+}
+
+// Message for getting a Cluster
+message GetClusterRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+}
+
+message CreateSecondaryClusterRequest {
+ // Required. The name of the parent resource (the primary cluster). For the
+ // required format, see the comment on the Cluster.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Cluster"
+ }
+ ];
+
+ // Required. ID of the requesting object (the secondary cluster).
+ string cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Configuration of the requesting object (the secondary cluster).
+ Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 5 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the create
+ // request.
+ bool validate_only = 6 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for creating a Cluster
+message CreateClusterRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Cluster"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the create
+ // request.
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for updating a Cluster
+message UpdateClusterRequest {
+ // Optional. Field mask is used to specify the fields to be overwritten in the
+ // Cluster resource by the update.
+ // The fields specified in the update_mask are relative to the resource, not
+ // the full request. A field will be overwritten if it is in the mask. If the
+ // user does not provide a mask then all fields will be overwritten.
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The resource being updated
+ Cluster cluster = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the update
+ // request.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set to true, update succeeds even if cluster is not found. In
+ // that case, a new cluster is created and `update_mask` is ignored.
+ bool allow_missing = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for deleting a Cluster
+message DeleteClusterRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The current etag of the Cluster.
+ // If an etag is provided and does not match the current etag of the Cluster,
+ // deletion will be blocked and an ABORTED error will be returned.
+ string etag = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the delete.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Whether to cascade delete child instances for given cluster.
+ bool force = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for promoting a Cluster
+message PromoteClusterRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Cluster.name field
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The current etag of the Cluster.
+ // If an etag is provided and does not match the current etag of the Cluster,
+ // deletion will be blocked and an ABORTED error will be returned.
+ string etag = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the delete.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for restoring a Cluster from a backup or another cluster at a given
+// point in time.
+message RestoreClusterRequest {
+ // Required.
+ // The source to import from.
+ oneof source {
+ // Backup source.
+ BackupSource backup_source = 4;
+
+ // ContinuousBackup source. Continuous backup needs to be enabled in the
+ // source cluster for this operation to succeed.
+ ContinuousBackupSource continuous_backup_source = 8;
+ }
+
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Cluster.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Cluster"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 5 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the import
+ // request.
+ bool validate_only = 6 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for requesting list of Instances
+message ListInstancesRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Instance.name field. Additionally, you can perform an
+ // aggregated list operation by specifying a value with one of the following
+ // formats:
+ // * projects/{project}/locations/-/clusters/-
+ // * projects/{project}/locations/{region}/clusters/-
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. Requested page size. Server may return fewer items than
+ // requested. If unspecified, server will pick an appropriate default.
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+
+ // Optional. Filtering results
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Hint for how to order the results
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for response to listing Instances
+message ListInstancesResponse {
+ // The list of Instance
+ repeated Instance instances = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+
+ // Locations that could not be reached.
+ repeated string unreachable = 3;
+}
+
+// Message for getting a Instance
+message GetInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // The view of the instance to return.
+ InstanceView view = 2;
+}
+
+// Message for creating a Instance
+message CreateInstanceRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Instance.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Instance instance = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the create
+ // request.
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for creating a Secondary Instance
+message CreateSecondaryInstanceRequest {
+ // Required. The name of the parent resource. For the required format, see the
+ // comment on the Instance.name field.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Instance instance = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the create
+ // request.
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// See usage below for notes.
+message CreateInstanceRequests {
+ // Required. Primary and read replica instances to be created. This list
+ // should not be empty.
+ repeated CreateInstanceRequest create_instance_requests = 1
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Message for creating a batch of instances under the specified cluster.
+message BatchCreateInstancesRequest {
+ // Required. The name of the parent resource.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Required. Resources being created.
+ CreateInstanceRequests requests = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for creating batches of instances in a cluster.
+message BatchCreateInstancesResponse {
+ // Created instances.
+ repeated Instance instances = 1;
+}
+
+// Message for metadata that is specific to BatchCreateInstances API.
+message BatchCreateInstancesMetadata {
+ // The instances being created in the API call. Each string in this list
+ // is the server defined resource path for target instances in the request
+ // and for the format of each string, see the comment on the Instance.name
+ // field.
+ repeated string instance_targets = 1;
+
+ // A map representing state of the instances involved in the
+ // BatchCreateInstances operation during the operation execution.
+ // The instance state will be in STATE_UNSPECIFIED state if the instance has
+ // not yet been picked up for processing.
+ // The key of the map is the name of the instance resource.
+ // For the format, see the comment on the Instance.name field.
+ map instance_statuses = 2;
+}
+
+// Message for current status of an instance in the BatchCreateInstances
+// operation.
+// For example, lets say a BatchCreateInstances workflow has 4 instances,
+// Instance1 through Instance4. Lets also assume that 2 instances succeeded
+// but the third failed to create and the 4th was never picked up for creation
+// because of failure of the previous one. Then, resulting states would look
+// something like:
+// 1. Instance1 = ROLLED_BACK
+// 2. Instance2 = ROLLED_BACK
+// 3. Instance3 = FAILED
+// 4. Instance4 = FAILED
+// However, while the operation is running, the instance might be in other
+// states including PENDING_CREATE, ACTIVE, DELETING and CREATING. The states
+// / do not get further updated once the operation is done.
+message BatchCreateInstanceStatus {
+ // State contains all valid instance states for the BatchCreateInstances
+ // operation. This is mainly used for status reporting through the LRO
+ // metadata.
+ enum State {
+ // The state of the instance is unknown.
+ STATE_UNSPECIFIED = 0;
+
+ // Instance is pending creation and has not yet been picked up for
+ // processsing in the backend.
+ PENDING_CREATE = 1;
+
+ // The instance is active and running.
+ READY = 2;
+
+ // The instance is being created.
+ CREATING = 3;
+
+ // The instance is being deleted.
+ DELETING = 4;
+
+ // The creation of the instance failed or a fatal error occurred during
+ // an operation on the instance or a batch of instances.
+ FAILED = 5;
+
+ // The instance was created successfully, but was rolled back and deleted
+ // due to some other failure during BatchCreateInstances operation.
+ ROLLED_BACK = 6;
+ }
+
+ // The current state of an instance involved in the batch create operation.
+ // Once the operation is complete, the final state of the instances in the
+ // LRO can be one of:
+ // 1. ACTIVE, indicating that instances were created successfully
+ // 2. FAILED, indicating that a particular instance failed creation
+ // 3. ROLLED_BACK indicating that although the instance was created
+ // successfully, it had to be rolled back and deleted due to failure in
+ // other steps of the workflow.
+ State state = 1;
+
+ // DEPRECATED - Use the error field instead.
+ // Error, if any error occurred and is available, during instance creation.
+ string error_msg = 2;
+
+ // The RPC status of the instance creation operation. This field will be
+ // present if an error happened during the instance creation.
+ google.rpc.Status error = 4;
+
+ Instance.InstanceType type = 3;
+}
+
+// Message for updating a Instance
+message UpdateInstanceRequest {
+ // Optional. Field mask is used to specify the fields to be overwritten in the
+ // Instance resource by the update.
+ // The fields specified in the update_mask are relative to the resource, not
+ // the full request. A field will be overwritten if it is in the mask. If the
+ // user does not provide a mask then all fields will be overwritten.
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The resource being updated
+ Instance instance = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the update
+ // request.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set to true, update succeeds even if instance is not found. In
+ // that case, a new instance is created and `update_mask` is ignored.
+ bool allow_missing = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for deleting a Instance
+message DeleteInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The current etag of the Instance.
+ // If an etag is provided and does not match the current etag of the Instance,
+ // deletion will be blocked and an ABORTED error will be returned.
+ string etag = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the delete.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for triggering failover on an Instance
+message FailoverInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the failover.
+ bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+message RestartInstanceRequest {
+ // Required. The name of the resource. For the required format, see the
+ // comment on the Instance.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, performs request validation (e.g. permission checks and
+ // any other type of validation), but do not actually execute the restart.
+ bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for requesting list of Backups
+message ListBackupsRequest {
+ // Required. Parent value for ListBackupsRequest
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Backup"
+ }
+ ];
+
+ // Requested page size. Server may return fewer items than requested.
+ // If unspecified, server will pick an appropriate default.
+ int32 page_size = 2;
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+
+ // Filtering results
+ string filter = 4;
+
+ // Hint for how to order the results
+ string order_by = 5;
+}
+
+// Message for response to listing Backups
+message ListBackupsResponse {
+ // The list of Backup
+ repeated Backup backups = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+
+ // Locations that could not be reached.
+ repeated string unreachable = 3;
+}
+
+// Message for getting a Backup
+message GetBackupRequest {
+ // Required. Name of the resource
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Backup" }
+ ];
+}
+
+// Message for creating a Backup
+message CreateBackupRequest {
+ // Required. Value for parent.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/Backup"
+ }
+ ];
+
+ // Required. ID of the requesting object.
+ string backup_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The resource being created
+ Backup backup = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, the backend validates the request, but doesn't actually
+ // execute it.
+ bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for updating a Backup
+message UpdateBackupRequest {
+ // Optional. Field mask is used to specify the fields to be overwritten in the
+ // Backup resource by the update.
+ // The fields specified in the update_mask are relative to the resource, not
+ // the full request. A field will be overwritten if it is in the mask. If the
+ // user does not provide a mask then all fields will be overwritten.
+ google.protobuf.FieldMask update_mask = 1
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The resource being updated
+ Backup backup = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, the backend validates the request, but doesn't actually
+ // execute it.
+ bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set to true, update succeeds even if instance is not found. In
+ // that case, a new backup is created and `update_mask` is ignored.
+ bool allow_missing = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for deleting a Backup
+message DeleteBackupRequest {
+ // Required. Name of the resource. For the required format, see the comment on
+ // the Backup.name field.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Backup" }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If set, the backend validates the request, but doesn't actually
+ // execute it.
+ bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The current etag of the Backup.
+ // If an etag is provided and does not match the current etag of the Backup,
+ // deletion will be blocked and an ABORTED error will be returned.
+ string etag = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message for listing the information about the supported Database flags.
+message ListSupportedDatabaseFlagsRequest {
+ // Required. The name of the parent resource. The required format is:
+ // * projects/{project}/locations/{location}
+ //
+ // Regardless of the parent specified here, as long it is contains a valid
+ // project and location, the service will return a static list of supported
+ // flags resources. Note that we do not yet support region-specific
+ // flags.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "alloydb.googleapis.com/SupportedDatabaseFlag"
+ }
+ ];
+
+ // Requested page size. Server may return fewer items than requested.
+ // If unspecified, server will pick an appropriate default.
+ int32 page_size = 2;
+
+ // A token identifying a page of results the server should return.
+ string page_token = 3;
+}
+
+// Message for response to listing SupportedDatabaseFlags.
+message ListSupportedDatabaseFlagsResponse {
+ // The list of SupportedDatabaseFlags.
+ repeated SupportedDatabaseFlag supported_database_flags = 1;
+
+ // A token identifying a page of results the server should return.
+ string next_page_token = 2;
+}
+
+// Message for requests to generate a client certificate signed by the Cluster
+// CA.
+message GenerateClientCertificateRequest {
+ // Required. The name of the parent resource. The required format is:
+ // * projects/{project}/locations/{location}/clusters/{cluster}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "alloydb.googleapis.com/Cluster" }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. A pem-encoded X.509 certificate signing request (CSR).
+ string pem_csr = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. An optional hint to the endpoint to generate the client
+ // certificate with the requested duration. The duration can be from 1 hour to
+ // 24 hours. The endpoint may or may not honor the hint. If the hint is left
+ // unspecified or is not honored, then the endpoint will pick an appropriate
+ // default duration.
+ google.protobuf.Duration cert_duration = 4
+ [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Message returned by a GenerateClientCertificate operation.
+message GenerateClientCertificateResponse {
+ // Output only. The pem-encoded, signed X.509 certificate.
+ string pem_certificate = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The pem-encoded chain that may be used to verify the X.509
+ // certificate. Expected to be in issuer-to-root order according to RFC 5246.
+ repeated string pem_certificate_chain = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Request message for GetConnectionInfo.
+message GetConnectionInfoRequest {
+ // Required. The name of the parent resource. The required format is:
+ // projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "alloydb.googleapis.com/Instance"
+ }
+ ];
+
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
+ //
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
+ // ID, the server can check if original operation with the same request ID
+ // was received, and if so, will ignore the second request. This prevents
+ // clients from accidentally creating duplicate commitments.
+ //
+ // The request ID must be a valid UUID with the exception that zero UUID is
+ // not supported (00000000-0000-0000-0000-000000000000).
+ string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Represents the metadata of the long-running operation.
+message OperationMetadata {
+ // Request specific metadata, if any.
+ oneof request_specific {
+ // Output only. BatchCreateInstances related metadata.
+ BatchCreateInstancesMetadata batch_create_instances_metadata = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // Output only. The time the operation was created.
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time the operation finished running.
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Server-defined resource path for the target of the operation.
+ string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Name of the verb executed by the operation.
+ string verb = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Human-readable status of the operation, if any.
+ string status_message = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Identifies whether the user has requested cancellation
+ // of the operation. Operations that have successfully been cancelled
+ // have [Operation.error][] value with a
+ // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
+ // `Code.CANCELLED`.
+ bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. API version used to start the operation.
+ string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
diff --git a/third_party/googleapis/google/cloud/apigateway/v1/BUILD.bazel b/third_party/googleapis/google/cloud/apigateway/v1/BUILD.bazel
index 287cfce30..0de112cf0 100644
--- a/third_party/googleapis/google/cloud/apigateway/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/apigateway/v1/BUILD.bazel
@@ -30,6 +30,7 @@ proto_library(
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
@@ -116,7 +117,7 @@ load(
go_proto_library(
name = "apigateway_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/apigateway/v1",
+ importpath = "cloud.google.com/go/apigateway/apiv1/apigatewaypb",
protos = [":apigateway_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -130,6 +131,7 @@ go_gapic_library(
grpc_service_config = "apigateway_grpc_service_config.json",
importpath = "cloud.google.com/go/apigateway/apiv1;apigateway",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "apigateway_v1.yaml",
transport = "grpc+rest",
@@ -175,7 +177,8 @@ py_gapic_library(
grpc_service_config = "apigateway_grpc_service_config.json",
opt_args = ["warehouse-package-name=google-cloud-api-gateway"],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "apigateway_v1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -307,6 +310,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "API Gateway enables you to provide secure access to your backend services through a well-defined REST API that is consistent across all of your services, regardless of the service implementation. Clients consume your REST APIS to implement standalone apps for a mobile device or tablet, through apps running in a browser, or through any other type of app that can make a request to an HTTP endpoint.",
ruby_cloud_title = "API Gateway V1",
+ service_yaml = "apigateway_v1.yaml",
deps = [
":apigateway_ruby_grpc",
":apigateway_ruby_proto",
@@ -352,6 +356,7 @@ csharp_gapic_library(
grpc_service_config = "apigateway_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "apigateway_v1.yaml",
+ transport = "grpc+rest",
deps = [
":apigateway_csharp_grpc",
":apigateway_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/apigateway/v1/apigateway.proto b/third_party/googleapis/google/cloud/apigateway/v1/apigateway.proto
index d1dccc740..436435b20 100644
--- a/third_party/googleapis/google/cloud/apigateway/v1/apigateway.proto
+++ b/third_party/googleapis/google/cloud/apigateway/v1/apigateway.proto
@@ -22,7 +22,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.ApiGateway.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/apigateway/v1;apigateway";
+option go_package = "cloud.google.com/go/apigateway/apiv1/apigatewaypb;apigatewaypb";
option java_multiple_files = true;
option java_package = "com.google.cloud.apigateway.v1";
option php_namespace = "Google\\Cloud\\ApiGateway\\V1";
diff --git a/third_party/googleapis/google/cloud/apigateway/v1/apigateway_service.proto b/third_party/googleapis/google/cloud/apigateway/v1/apigateway_service.proto
index 0738d7081..84d8b2a9e 100644
--- a/third_party/googleapis/google/cloud/apigateway/v1/apigateway_service.proto
+++ b/third_party/googleapis/google/cloud/apigateway/v1/apigateway_service.proto
@@ -22,7 +22,7 @@ import "google/cloud/apigateway/v1/apigateway.proto";
import "google/longrunning/operations.proto";
option csharp_namespace = "Google.Cloud.ApiGateway.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/apigateway/v1;apigateway";
+option go_package = "cloud.google.com/go/apigateway/apiv1/apigatewaypb;apigatewaypb";
option java_multiple_files = true;
option java_package = "com.google.cloud.apigateway.v1";
option php_namespace = "Google\\Cloud\\ApiGateway\\V1";
diff --git a/third_party/googleapis/google/cloud/apigeeconnect/v1/BUILD.bazel b/third_party/googleapis/google/cloud/apigeeconnect/v1/BUILD.bazel
index ba6b5cbb3..da7448ade 100644
--- a/third_party/googleapis/google/cloud/apigeeconnect/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/apigeeconnect/v1/BUILD.bazel
@@ -84,7 +84,6 @@ java_gapic_test(
test_classes = [
"com.google.cloud.apigeeconnect.v1.ConnectionServiceClientHttpJsonTest",
"com.google.cloud.apigeeconnect.v1.ConnectionServiceClientTest",
- "com.google.cloud.apigeeconnect.v1.TetherClientHttpJsonTest",
"com.google.cloud.apigeeconnect.v1.TetherClientTest",
],
runtime_deps = [":apigeeconnect_java_gapic_test"],
@@ -117,7 +116,7 @@ load(
go_proto_library(
name = "apigeeconnect_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/apigeeconnect/v1",
+ importpath = "cloud.google.com/go/apigeeconnect/apiv1/apigeeconnectpb",
protos = [":apigeeconnect_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -131,6 +130,7 @@ go_gapic_library(
grpc_service_config = "connection_grpc_service_config.json",
importpath = "cloud.google.com/go/apigeeconnect/apiv1;apigeeconnect",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "apigeeconnect_v1.yaml",
deps = [
@@ -173,6 +173,7 @@ py_gapic_library(
grpc_service_config = "connection_grpc_service_config.json",
opt_args = ["warehouse-package-name=google-cloud-apigee-connect"],
rest_numeric_enums = True,
+ service_yaml = "apigeeconnect_v1.yaml",
transport = "grpc",
)
@@ -305,6 +306,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Apigee Connect allows the Apigee hybrid management plane to connect securely to the MART service in the runtime plane without requiring you to expose the MART endpoint on the internet. If you use Apigee Connect, you do not need to configure the MART ingress gateway with a host alias and an authorized DNS certificate.",
ruby_cloud_title = "Apigee Connect V1",
+ service_yaml = "apigeeconnect_v1.yaml",
deps = [
":apigeeconnect_ruby_grpc",
":apigeeconnect_ruby_proto",
@@ -350,6 +352,7 @@ csharp_gapic_library(
grpc_service_config = "connection_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "apigeeconnect_v1.yaml",
+ transport = "grpc+rest",
deps = [
":apigeeconnect_csharp_grpc",
":apigeeconnect_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/apigeeconnect/v1/connection.proto b/third_party/googleapis/google/cloud/apigeeconnect/v1/connection.proto
index 021ae3b26..5800b36ec 100644
--- a/third_party/googleapis/google/cloud/apigeeconnect/v1/connection.proto
+++ b/third_party/googleapis/google/cloud/apigeeconnect/v1/connection.proto
@@ -22,7 +22,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.ApigeeConnect.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/apigeeconnect/v1;apigeeconnect";
+option go_package = "cloud.google.com/go/apigeeconnect/apiv1/apigeeconnectpb;apigeeconnectpb";
option java_multiple_files = true;
option java_outer_classname = "ConnectionProto";
option java_package = "com.google.cloud.apigeeconnect.v1";
diff --git a/third_party/googleapis/google/cloud/apigeeconnect/v1/tether.proto b/third_party/googleapis/google/cloud/apigeeconnect/v1/tether.proto
index 8cd4eccb8..abd36c822 100644
--- a/third_party/googleapis/google/cloud/apigeeconnect/v1/tether.proto
+++ b/third_party/googleapis/google/cloud/apigeeconnect/v1/tether.proto
@@ -21,7 +21,7 @@ import "google/rpc/status.proto";
import "google/api/client.proto";
option csharp_namespace = "Google.Cloud.ApigeeConnect.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/apigeeconnect/v1;apigeeconnect";
+option go_package = "cloud.google.com/go/apigeeconnect/apiv1/apigeeconnectpb;apigeeconnectpb";
option java_multiple_files = true;
option java_outer_classname = "TetherProto";
option java_package = "com.google.cloud.apigeeconnect.v1";
diff --git a/third_party/googleapis/google/cloud/apigeeregistry/v1/BUILD.bazel b/third_party/googleapis/google/cloud/apigeeregistry/v1/BUILD.bazel
index 3274768d9..ececc3e65 100644
--- a/third_party/googleapis/google/cloud/apigeeregistry/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/apigeeregistry/v1/BUILD.bazel
@@ -130,7 +130,7 @@ load(
go_proto_library(
name = "apigeeregistry_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/apigeeregistry/v1",
+ importpath = "cloud.google.com/go/apigeeregistry/apiv1/apigeeregistrypb",
protos = [":apigeeregistry_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -145,6 +145,7 @@ go_gapic_library(
grpc_service_config = "apigeeregistry_grpc_service_config.json",
importpath = "cloud.google.com/go/apigeeregistry/apiv1;apigeeregistry",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "apigeeregistry_v1.yaml",
deps = [
@@ -377,6 +378,7 @@ csharp_gapic_library(
grpc_service_config = "apigeeregistry_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "apigeeregistry_v1.yaml",
+ transport = "grpc+rest",
deps = [
":apigeeregistry_csharp_grpc",
":apigeeregistry_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/apigeeregistry/v1/provisioning_service.proto b/third_party/googleapis/google/cloud/apigeeregistry/v1/provisioning_service.proto
index 9e7baee58..cca6753c6 100644
--- a/third_party/googleapis/google/cloud/apigeeregistry/v1/provisioning_service.proto
+++ b/third_party/googleapis/google/cloud/apigeeregistry/v1/provisioning_service.proto
@@ -24,7 +24,7 @@ import "google/longrunning/operations.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.ApigeeRegistry.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/apigeeregistry/v1;apigeeregistry";
+option go_package = "cloud.google.com/go/apigeeregistry/apiv1/apigeeregistrypb;apigeeregistrypb";
option java_multiple_files = true;
option java_outer_classname = "ProvisioningServiceProto";
option java_package = "com.google.cloud.apigeeregistry.v1";
diff --git a/third_party/googleapis/google/cloud/apigeeregistry/v1/registry_models.proto b/third_party/googleapis/google/cloud/apigeeregistry/v1/registry_models.proto
index 8411f9ecf..a1c29b4d5 100644
--- a/third_party/googleapis/google/cloud/apigeeregistry/v1/registry_models.proto
+++ b/third_party/googleapis/google/cloud/apigeeregistry/v1/registry_models.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.ApigeeRegistry.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/apigeeregistry/v1;apigeeregistry";
+option go_package = "cloud.google.com/go/apigeeregistry/apiv1/apigeeregistrypb;apigeeregistrypb";
option java_multiple_files = true;
option java_outer_classname = "RegistryModelsProto";
option java_package = "com.google.cloud.apigeeregistry.v1";
diff --git a/third_party/googleapis/google/cloud/apigeeregistry/v1/registry_service.proto b/third_party/googleapis/google/cloud/apigeeregistry/v1/registry_service.proto
index 1eec64e8b..041796be4 100644
--- a/third_party/googleapis/google/cloud/apigeeregistry/v1/registry_service.proto
+++ b/third_party/googleapis/google/cloud/apigeeregistry/v1/registry_service.proto
@@ -26,7 +26,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.ApigeeRegistry.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/apigeeregistry/v1;apigeeregistry";
+option go_package = "cloud.google.com/go/apigeeregistry/apiv1/apigeeregistrypb;apigeeregistrypb";
option java_multiple_files = true;
option java_outer_classname = "RegistryServiceProto";
option java_package = "com.google.cloud.apigeeregistry.v1";
diff --git a/third_party/googleapis/google/cloud/asset/v1/BUILD.bazel b/third_party/googleapis/google/cloud/asset/v1/BUILD.bazel
index cc6280646..3301aa00d 100644
--- a/third_party/googleapis/google/cloud/asset/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/asset/v1/BUILD.bazel
@@ -120,7 +120,7 @@ load(
go_proto_library(
name = "asset_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/asset/v1",
+ importpath = "cloud.google.com/go/asset/apiv1/assetpb",
protos = [":asset_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -140,6 +140,7 @@ go_gapic_library(
srcs = [":asset_proto_with_info"],
grpc_service_config = "cloudasset_grpc_service_config.json",
importpath = "cloud.google.com/go/asset/apiv1;asset",
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "cloudasset_v1.yaml",
transport = "grpc+rest",
@@ -187,7 +188,8 @@ py_gapic_library(
srcs = [":asset_proto"],
grpc_service_config = "cloudasset_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "cloudasset_v1.yaml",
+ transport = "grpc+rest",
deps = [
"//google/cloud/orgpolicy/v1:orgpolicy_py_original_proto",
"//google/cloud/osconfig/v1:osconfig_py_proto",
@@ -332,6 +334,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "A metadata inventory service that allows you to view, monitor, and analyze all your GCP and Anthos assets across projects and services.",
ruby_cloud_title = "Cloud Asset V1",
+ service_yaml = "cloudasset_v1.yaml",
deps = [
":asset_ruby_grpc",
":asset_ruby_proto",
@@ -377,6 +380,7 @@ csharp_gapic_library(
grpc_service_config = "cloudasset_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "cloudasset_v1.yaml",
+ transport = "grpc+rest",
deps = [
":asset_csharp_grpc",
":asset_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/asset/v1/asset_service.proto b/third_party/googleapis/google/cloud/asset/v1/asset_service.proto
index 9e13d0662..d024e6a0f 100644
--- a/third_party/googleapis/google/cloud/asset/v1/asset_service.proto
+++ b/third_party/googleapis/google/cloud/asset/v1/asset_service.proto
@@ -32,7 +32,7 @@ import "google/rpc/status.proto";
import "google/type/expr.proto";
option csharp_namespace = "Google.Cloud.Asset.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/asset/v1;asset";
+option go_package = "cloud.google.com/go/asset/apiv1/assetpb;assetpb";
option java_multiple_files = true;
option java_outer_classname = "AssetServiceProto";
option java_package = "com.google.cloud.asset.v1";
@@ -41,18 +41,20 @@ option php_namespace = "Google\\Cloud\\Asset\\V1";
// Asset service definition.
service AssetService {
option (google.api.default_host) = "cloudasset.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Exports assets with time and resource types to a given Cloud Storage
// location/BigQuery table. For Cloud Storage location destinations, the
// output format is newline-delimited JSON. Each line represents a
- // [google.cloud.asset.v1.Asset][google.cloud.asset.v1.Asset] in the JSON format; for BigQuery table
- // destinations, the output table stores the fields in asset Protobuf as
- // columns. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API,
- // which allows you to keep track of the export. We recommend intervals of at
- // least 2 seconds with exponential retry to poll the export operation result.
- // For regular-size resource parent, the export operation usually finishes
- // within 5 minutes.
+ // [google.cloud.asset.v1.Asset][google.cloud.asset.v1.Asset] in the JSON
+ // format; for BigQuery table destinations, the output table stores the fields
+ // in asset Protobuf as columns. This API implements the
+ // [google.longrunning.Operation][google.longrunning.Operation] API, which
+ // allows you to keep track of the export. We recommend intervals of at least
+ // 2 seconds with exponential retry to poll the export operation result. For
+ // regular-size resource parent, the export operation usually finishes within
+ // 5 minutes.
rpc ExportAssets(ExportAssetsRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=*/*}:exportAssets"
@@ -80,7 +82,8 @@ service AssetService {
// deleted status.
// If a specified asset does not exist, this API returns an INVALID_ARGUMENT
// error.
- rpc BatchGetAssetsHistory(BatchGetAssetsHistoryRequest) returns (BatchGetAssetsHistoryResponse) {
+ rpc BatchGetAssetsHistory(BatchGetAssetsHistoryRequest)
+ returns (BatchGetAssetsHistoryResponse) {
option (google.api.http) = {
get: "/v1/{parent=*/*}:batchGetAssetsHistory"
};
@@ -129,11 +132,12 @@ service AssetService {
option (google.api.method_signature) = "name";
}
- // Searches all Cloud resources within the specified scope, such as a project,
- // folder, or organization. The caller must be granted the
+ // Searches all Google Cloud resources within the specified scope, such as a
+ // project, folder, or organization. The caller must be granted the
// `cloudasset.assets.searchAllResources` permission on the desired scope,
// otherwise the request will be rejected.
- rpc SearchAllResources(SearchAllResourcesRequest) returns (SearchAllResourcesResponse) {
+ rpc SearchAllResources(SearchAllResourcesRequest)
+ returns (SearchAllResourcesResponse) {
option (google.api.http) = {
get: "/v1/{scope=*/*}:searchAllResources"
};
@@ -144,7 +148,8 @@ service AssetService {
// folder, or organization. The caller must be granted the
// `cloudasset.assets.searchAllIamPolicies` permission on the desired scope,
// otherwise the request will be rejected.
- rpc SearchAllIamPolicies(SearchAllIamPoliciesRequest) returns (SearchAllIamPoliciesResponse) {
+ rpc SearchAllIamPolicies(SearchAllIamPoliciesRequest)
+ returns (SearchAllIamPoliciesResponse) {
option (google.api.http) = {
get: "/v1/{scope=*/*}:searchAllIamPolicies"
};
@@ -153,7 +158,8 @@ service AssetService {
// Analyzes IAM policies to answer which identities have what accesses on
// which resources.
- rpc AnalyzeIamPolicy(AnalyzeIamPolicyRequest) returns (AnalyzeIamPolicyResponse) {
+ rpc AnalyzeIamPolicy(AnalyzeIamPolicyRequest)
+ returns (AnalyzeIamPolicyResponse) {
option (google.api.http) = {
get: "/v1/{analysis_query.scope=*/*}:analyzeIamPolicy"
};
@@ -163,12 +169,14 @@ service AssetService {
// accesses on which resources, and writes the analysis results to a Google
// Cloud Storage or a BigQuery destination. For Cloud Storage destination, the
// output format is the JSON format that represents a
- // [AnalyzeIamPolicyResponse][google.cloud.asset.v1.AnalyzeIamPolicyResponse]. This method implements the
- // [google.longrunning.Operation][google.longrunning.Operation], which allows you to track the operation
- // status. We recommend intervals of at least 2 seconds with exponential
- // backoff retry to poll the operation result. The metadata contains the
- // metadata for the long-running operation.
- rpc AnalyzeIamPolicyLongrunning(AnalyzeIamPolicyLongrunningRequest) returns (google.longrunning.Operation) {
+ // [AnalyzeIamPolicyResponse][google.cloud.asset.v1.AnalyzeIamPolicyResponse].
+ // This method implements the
+ // [google.longrunning.Operation][google.longrunning.Operation], which allows
+ // you to track the operation status. We recommend intervals of at least 2
+ // seconds with exponential backoff retry to poll the operation result. The
+ // metadata contains the metadata for the long-running operation.
+ rpc AnalyzeIamPolicyLongrunning(AnalyzeIamPolicyLongrunningRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{analysis_query.scope=*/*}:analyzeIamPolicyLongrunning"
body: "*"
@@ -229,7 +237,8 @@ service AssetService {
}
// Lists all saved queries in a parent project/folder/organization.
- rpc ListSavedQueries(ListSavedQueriesRequest) returns (ListSavedQueriesResponse) {
+ rpc ListSavedQueries(ListSavedQueriesRequest)
+ returns (ListSavedQueriesResponse) {
option (google.api.http) = {
get: "/v1/{parent=*/*}/savedQueries"
};
@@ -246,7 +255,8 @@ service AssetService {
}
// Deletes a saved query.
- rpc DeleteSavedQuery(DeleteSavedQueryRequest) returns (google.protobuf.Empty) {
+ rpc DeleteSavedQuery(DeleteSavedQueryRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=*/*/savedQueries/*}"
};
@@ -254,18 +264,67 @@ service AssetService {
}
// Gets effective IAM policies for a batch of resources.
- rpc BatchGetEffectiveIamPolicies(BatchGetEffectiveIamPoliciesRequest) returns (BatchGetEffectiveIamPoliciesResponse) {
+ rpc BatchGetEffectiveIamPolicies(BatchGetEffectiveIamPoliciesRequest)
+ returns (BatchGetEffectiveIamPoliciesResponse) {
option (google.api.http) = {
get: "/v1/{scope=*/*}/effectiveIamPolicies:batchGet"
};
}
+
+ // Analyzes organization policies under a scope.
+ rpc AnalyzeOrgPolicies(AnalyzeOrgPoliciesRequest)
+ returns (AnalyzeOrgPoliciesResponse) {
+ option (google.api.http) = {
+ get: "/v1/{scope=*/*}:analyzeOrgPolicies"
+ };
+ option (google.api.method_signature) = "scope,constraint,filter";
+ }
+
+ // Analyzes organization policies governed containers (projects, folders or
+ // organization) under a scope.
+ rpc AnalyzeOrgPolicyGovernedContainers(
+ AnalyzeOrgPolicyGovernedContainersRequest)
+ returns (AnalyzeOrgPolicyGovernedContainersResponse) {
+ option (google.api.http) = {
+ get: "/v1/{scope=*/*}:analyzeOrgPolicyGovernedContainers"
+ };
+ option (google.api.method_signature) = "scope,constraint,filter";
+ }
+
+ // Analyzes organization policies governed assets (Google Cloud resources or
+ // policies) under a scope. This RPC supports custom constraints and the
+ // following 10 canned constraints:
+ //
+ // * storage.uniformBucketLevelAccess
+ // * iam.disableServiceAccountKeyCreation
+ // * iam.allowedPolicyMemberDomains
+ // * compute.vmExternalIpAccess
+ // * appengine.enforceServiceAccountActAsCheck
+ // * gcp.resourceLocations
+ // * compute.trustedImageProjects
+ // * compute.skipDefaultNetworkCreation
+ // * compute.requireOsLogin
+ // * compute.disableNestedVirtualization
+ //
+ // This RPC only returns either resources of types supported by [searchable
+ // asset
+ // types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types),
+ // or IAM policies.
+ rpc AnalyzeOrgPolicyGovernedAssets(AnalyzeOrgPolicyGovernedAssetsRequest)
+ returns (AnalyzeOrgPolicyGovernedAssetsResponse) {
+ option (google.api.http) = {
+ get: "/v1/{scope=*/*}:analyzeOrgPolicyGovernedAssets"
+ };
+ option (google.api.method_signature) = "scope,constraint,filter";
+ }
}
// Represents the metadata of the longrunning operation for the
-// AnalyzeIamPolicyLongrunning rpc.
+// AnalyzeIamPolicyLongrunning RPC.
message AnalyzeIamPolicyLongrunningMetadata {
// Output only. The time the operation was created.
- google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Export asset request.
@@ -312,7 +371,8 @@ message ExportAssetsRequest {
// returned.
ContentType content_type = 4;
- // Required. Output configuration indicating where the results will be output to.
+ // Required. Output configuration indicating where the results will be output
+ // to.
OutputConfig output_config = 5 [(google.api.field_behavior) = REQUIRED];
// A list of relationship types to export, for example:
@@ -334,8 +394,10 @@ message ExportAssetsRequest {
}
// The export asset response. This message is returned by the
-// [google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] method in the returned
-// [google.longrunning.Operation.response][google.longrunning.Operation.response] field.
+// [google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation]
+// method in the returned
+// [google.longrunning.Operation.response][google.longrunning.Operation.response]
+// field.
message ExportAssetsResponse {
// Time the snapshot was taken.
google.protobuf.Timestamp read_time = 1;
@@ -344,20 +406,20 @@ message ExportAssetsResponse {
OutputConfig output_config = 2;
// Output result indicating where the assets were exported to. For example, a
- // set of actual Google Cloud Storage object uris where the assets are
- // exported to. The uris can be different from what [output_config] has
- // specified, as the service will split the output object into multiple ones
- // once it exceeds a single Google Cloud Storage object limit.
+ // set of actual Cloud Storage object URIs where the assets are exported to.
+ // The URIs can be different from what [output_config] has specified, as the
+ // service will split the output object into multiple ones once it exceeds a
+ // single Cloud Storage object limit.
OutputResult output_result = 3;
}
// ListAssets request.
message ListAssetsRequest {
- // Required. Name of the organization, folder, or project the assets belong to. Format:
- // "organizations/[organization-number]" (such as "organizations/123"),
- // "projects/[project-id]" (such as "projects/my-project-id"),
- // "projects/[project-number]" (such as "projects/12345"), or
- // "folders/[folder-number]" (such as "folders/12345").
+ // Required. Name of the organization, folder, or project the assets belong
+ // to. Format: "organizations/[organization-number]" (such as
+ // "organizations/123"), "projects/[project-id]" (such as
+ // "projects/my-project-id"), "projects/[project-number]" (such as
+ // "projects/12345"), or "folders/[folder-number]" (such as "folders/12345").
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -486,7 +548,8 @@ message BatchGetAssetsHistoryRequest {
// See [Introduction to Cloud Asset
// Inventory](https://cloud.google.com/asset-inventory/docs/overview) for all
// supported asset types and relationship types.
- repeated string relationship_types = 5 [(google.api.field_behavior) = OPTIONAL];
+ repeated string relationship_types = 5
+ [(google.api.field_behavior) = OPTIONAL];
}
// Batch get assets history response.
@@ -508,9 +571,8 @@ message CreateFeedRequest {
// be unique under a specific parent project/folder/organization.
string feed_id = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. The feed details. The field `name` must be empty and it will be generated
- // in the format of:
- // projects/project_number/feeds/feed_id
+ // Required. The feed details. The field `name` must be empty and it will be
+ // generated in the format of: projects/project_number/feeds/feed_id
// folders/folder_number/feeds/feed_id
// organizations/organization_number/feeds/feed_id
Feed feed = 3 [(google.api.field_behavior) = REQUIRED];
@@ -524,9 +586,7 @@ message GetFeedRequest {
// organizations/organization_number/feeds/feed_id
string name = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudasset.googleapis.com/Feed"
- }
+ (google.api.resource_reference) = { type: "cloudasset.googleapis.com/Feed" }
];
}
@@ -545,8 +605,8 @@ message ListFeedsResponse {
// Update asset feed request.
message UpdateFeedRequest {
- // Required. The new values of feed details. It must match an existing feed and the
- // field `name` must be in the format of:
+ // Required. The new values of feed details. It must match an existing feed
+ // and the field `name` must be in the format of:
// projects/project_number/feeds/feed_id or
// folders/folder_number/feeds/feed_id or
// organizations/organization_number/feeds/feed_id.
@@ -555,7 +615,8 @@ message UpdateFeedRequest {
// Required. Only updates the `feed` fields indicated by this mask.
// The field mask must not be empty, and it must not contain fields that
// are immutable or only set by the server.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
message DeleteFeedRequest {
@@ -565,9 +626,7 @@ message DeleteFeedRequest {
// organizations/organization_number/feeds/feed_id
string name = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudasset.googleapis.com/Feed"
- }
+ (google.api.resource_reference) = { type: "cloudasset.googleapis.com/Feed" }
];
}
@@ -595,7 +654,7 @@ message OutputResult {
// A Cloud Storage output result.
message GcsOutputResult {
- // List of uris of the Cloud Storage objects. Example:
+ // List of URIs of the Cloud Storage objects. Example:
// "gs://bucket_name/object_name".
repeated string uris = 1;
}
@@ -604,7 +663,7 @@ message GcsOutputResult {
message GcsDestination {
// Required.
oneof object_uri {
- // The uri of the Cloud Storage object. It's the same uri that is used by
+ // The URI of the Cloud Storage object. It's the same URI that is used by
// gsutil. Example: "gs://bucket_name/object_name". See [Viewing and
// Editing Object
// Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
@@ -615,8 +674,8 @@ message GcsDestination {
// overwritten with the exported result.
string uri = 1;
- // The uri prefix of all generated Cloud Storage objects. Example:
- // "gs://bucket_name/object_name_prefix". Each object uri is in format:
+ // The URI prefix of all generated Cloud Storage objects. Example:
+ // "gs://bucket_name/object_name_prefix". Each object URI is in format:
// "gs://bucket_name/object_name_prefix// and only
// contains assets for that type. starts from 0. Example:
// "gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0" is
@@ -792,7 +851,8 @@ message Feed {
// Required. Feed output configuration defining where the asset updates are
// published to.
- FeedOutputConfig feed_output_config = 5 [(google.api.field_behavior) = REQUIRED];
+ FeedOutputConfig feed_output_config = 5
+ [(google.api.field_behavior) = REQUIRED];
// A condition which determines whether an asset update should be published.
// If specified, an asset will be returned only when the expression evaluates
@@ -829,8 +889,9 @@ message Feed {
// Search all resources request.
message SearchAllResourcesRequest {
- // Required. A scope can be a project, a folder, or an organization. The search is
- // limited to the resources within the `scope`. The caller must be granted the
+ // Required. A scope can be a project, a folder, or an organization. The
+ // search is limited to the resources within the `scope`. The caller must be
+ // granted the
// [`cloudasset.assets.searchAllResources`](https://cloud.google.com/asset-inventory/docs/access-control#required_permissions)
// permission on the desired scope.
//
@@ -849,55 +910,55 @@ message SearchAllResourcesRequest {
//
// Examples:
//
- // * `name:Important` to find Cloud resources whose name contains
+ // * `name:Important` to find Google Cloud resources whose name contains
// "Important" as a word.
- // * `name=Important` to find the Cloud resource whose name is exactly
+ // * `name=Important` to find the Google Cloud resource whose name is exactly
// "Important".
- // * `displayName:Impor*` to find Cloud resources whose display name
+ // * `displayName:Impor*` to find Google Cloud resources whose display name
// contains "Impor" as a prefix of any word in the field.
- // * `location:us-west*` to find Cloud resources whose location contains both
- // "us" and "west" as prefixes.
- // * `labels:prod` to find Cloud resources whose labels contain "prod" as
- // a key or value.
- // * `labels.env:prod` to find Cloud resources that have a label "env"
+ // * `location:us-west*` to find Google Cloud resources whose location
+ // contains both "us" and "west" as prefixes.
+ // * `labels:prod` to find Google Cloud resources whose labels contain "prod"
+ // as a key or value.
+ // * `labels.env:prod` to find Google Cloud resources that have a label "env"
// and its value is "prod".
- // * `labels.env:*` to find Cloud resources that have a label "env".
- // * `kmsKey:key` to find Cloud resources encrypted with a customer-managed
- // encryption key whose name contains "key" as a word. This field is
- // deprecated. Please use the `kmsKeys` field to retrieve KMS key
- // information.
- // * `kmsKeys:key` to find Cloud resources encrypted with customer-managed
- // encryption keys whose name contains the word "key".
- // * `relationships:instance-group-1` to find Cloud resources that have
+ // * `labels.env:*` to find Google Cloud resources that have a label "env".
+ // * `kmsKey:key` to find Google Cloud resources encrypted with a
+ // customer-managed encryption key whose name contains "key" as a word. This
+ // field is deprecated. Please use the `kmsKeys` field to retrieve Cloud KMS
+ // key information.
+ // * `kmsKeys:key` to find Google Cloud resources encrypted with
+ // customer-managed encryption keys whose name contains the word "key".
+ // * `relationships:instance-group-1` to find Google Cloud resources that have
// relationships with "instance-group-1" in the related resource name.
- // * `relationships:INSTANCE_TO_INSTANCEGROUP` to find compute instances that
- // have relationships of type "INSTANCE_TO_INSTANCEGROUP".
+ // * `relationships:INSTANCE_TO_INSTANCEGROUP` to find Compute Engine
+ // instances that have relationships of type "INSTANCE_TO_INSTANCEGROUP".
// * `relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1` to find
- // compute instances that have relationships with "instance-group-1" in the
- // compute instance group resource name, for relationship type
+ // Compute Engine instances that have relationships with "instance-group-1"
+ // in the Compute Engine instance group resource name, for relationship type
// "INSTANCE_TO_INSTANCEGROUP".
- // * `state:ACTIVE` to find Cloud resources whose state contains "ACTIVE" as a
- // word.
- // * `NOT state:ACTIVE` to find Cloud resources whose state doesn't contain
+ // * `state:ACTIVE` to find Google Cloud resources whose state contains
// "ACTIVE" as a word.
- // * `createTime<1609459200` to find Cloud resources that were created before
- // "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of
+ // * `NOT state:ACTIVE` to find Google Cloud resources whose state doesn't
+ // contain "ACTIVE" as a word.
+ // * `createTime<1609459200` to find Google Cloud resources that were created
+ // before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of
// "2021-01-01 00:00:00 UTC" in seconds.
- // * `updateTime>1609459200` to find Cloud resources that were updated after
- // "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of
+ // * `updateTime>1609459200` to find Google Cloud resources that were updated
+ // after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of
// "2021-01-01 00:00:00 UTC" in seconds.
- // * `Important` to find Cloud resources that contain "Important" as a word
- // in any of the searchable fields.
- // * `Impor*` to find Cloud resources that contain "Impor" as a prefix of any
+ // * `Important` to find Google Cloud resources that contain "Important" as a
// word in any of the searchable fields.
- // * `Important location:(us-west1 OR global)` to find Cloud
+ // * `Impor*` to find Google Cloud resources that contain "Impor" as a prefix
+ // of any word in any of the searchable fields.
+ // * `Important location:(us-west1 OR global)` to find Google Cloud
// resources that contain "Important" as a word in any of the searchable
// fields and are also located in the "us-west1" region or the "global"
// location.
string query = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. A list of asset types that this request searches for. If empty, it will
- // search all the [searchable asset
+ // Optional. A list of asset types that this request searches for. If empty,
+ // it will search all the [searchable asset
// types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types).
//
// Regular expressions are also supported. For example:
@@ -912,21 +973,22 @@ message SearchAllResourcesRequest {
// supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 3 [(google.api.field_behavior) = OPTIONAL];
- // Optional. The page size for search result pagination. Page size is capped at 500 even
- // if a larger value is given. If set to zero, server will pick an appropriate
- // default. Returned results may be fewer than requested. When this happens,
- // there could be more results as long as `next_page_token` is returned.
+ // Optional. The page size for search result pagination. Page size is capped
+ // at 500 even if a larger value is given. If set to zero, server will pick an
+ // appropriate default. Returned results may be fewer than requested. When
+ // this happens, there could be more results as long as `next_page_token` is
+ // returned.
int32 page_size = 4 [(google.api.field_behavior) = OPTIONAL];
- // Optional. If present, then retrieve the next batch of results from the preceding call
- // to this method. `page_token` must be the value of `next_page_token` from
- // the previous response. The values of all other method parameters, must be
- // identical to those in the previous call.
+ // Optional. If present, then retrieve the next batch of results from the
+ // preceding call to this method. `page_token` must be the value of
+ // `next_page_token` from the previous response. The values of all other
+ // method parameters, must be identical to those in the previous call.
string page_token = 5 [(google.api.field_behavior) = OPTIONAL];
- // Optional. A comma-separated list of fields specifying the sorting order of the
- // results. The default order is ascending. Add " DESC" after the field name
- // to indicate descending order. Redundant space characters are ignored.
+ // Optional. A comma-separated list of fields specifying the sorting order of
+ // the results. The default order is ascending. Add " DESC" after the field
+ // name to indicate descending order. Redundant space characters are ignored.
// Example: "location DESC, name".
// Only singular primitive fields in the response are sortable:
//
@@ -947,10 +1009,10 @@ message SearchAllResourcesRequest {
// `additionalAttributes`) are not supported.
string order_by = 6 [(google.api.field_behavior) = OPTIONAL];
- // Optional. A comma-separated list of fields specifying which fields to be returned in
- // ResourceSearchResult. Only '*' or combination of top level fields can be
- // specified. Field names of both snake_case and camelCase are supported.
- // Examples: `"*"`, `"name,location"`, `"name,versionedResources"`.
+ // Optional. A comma-separated list of fields specifying which fields to be
+ // returned in ResourceSearchResult. Only '*' or combination of top level
+ // fields can be specified. Field names of both snake_case and camelCase are
+ // supported. Examples: `"*"`, `"name,location"`, `"name,versionedResources"`.
//
// The read_mask paths must be valid field paths listed but not limited to
// (both snake_case and camelCase are supported):
@@ -967,7 +1029,7 @@ message SearchAllResourcesRequest {
// * labels
// * networkTags
// * kmsKey (This field is deprecated. Please use the `kmsKeys` field to
- // retrieve KMS key information.)
+ // retrieve Cloud KMS key information.)
// * kmsKeys
// * createTime
// * updateTime
@@ -980,7 +1042,8 @@ message SearchAllResourcesRequest {
// If only '*' is specified, all fields including versionedResources will be
// returned.
// Any invalid field path will trigger INVALID_ARGUMENT error.
- google.protobuf.FieldMask read_mask = 8 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.FieldMask read_mask = 8
+ [(google.api.field_behavior) = OPTIONAL];
}
// Search all resources response.
@@ -997,9 +1060,9 @@ message SearchAllResourcesResponse {
// Search all IAM policies request.
message SearchAllIamPoliciesRequest {
- // Required. A scope can be a project, a folder, or an organization. The search is
- // limited to the IAM policies within the `scope`. The caller must be granted
- // the
+ // Required. A scope can be a project, a folder, or an organization. The
+ // search is limited to the IAM policies within the `scope`. The caller must
+ // be granted the
// [`cloudasset.assets.searchAllIamPolicies`](https://cloud.google.com/asset-inventory/docs/access-control#required_permissions)
// permission on the desired scope.
//
@@ -1015,8 +1078,8 @@ message SearchAllIamPoliciesRequest {
// query](https://cloud.google.com/asset-inventory/docs/searching-iam-policies#how_to_construct_a_query)
// for more information. If not specified or empty, it will search all the
// IAM policies within the specified `scope`. Note that the query string is
- // compared against each Cloud IAM policy binding, including its principals,
- // roles, and Cloud IAM conditions. The returned Cloud IAM policies will only
+ // compared against each IAM policy binding, including its principals,
+ // roles, and IAM conditions. The returned IAM policies will only
// contain the bindings that match your query. To learn more about the IAM
// policy structure, see the [IAM policy
// documentation](https://cloud.google.com/iam/help/allow-policies/structure).
@@ -1055,20 +1118,22 @@ message SearchAllIamPoliciesRequest {
// principal type "user".
string query = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. The page size for search result pagination. Page size is capped at 500 even
- // if a larger value is given. If set to zero, server will pick an appropriate
- // default. Returned results may be fewer than requested. When this happens,
- // there could be more results as long as `next_page_token` is returned.
+ // Optional. The page size for search result pagination. Page size is capped
+ // at 500 even if a larger value is given. If set to zero, server will pick an
+ // appropriate default. Returned results may be fewer than requested. When
+ // this happens, there could be more results as long as `next_page_token` is
+ // returned.
int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
- // Optional. If present, retrieve the next batch of results from the preceding call to
- // this method. `page_token` must be the value of `next_page_token` from the
- // previous response. The values of all other method parameters must be
- // identical to those in the previous call.
+ // Optional. If present, retrieve the next batch of results from the preceding
+ // call to this method. `page_token` must be the value of `next_page_token`
+ // from the previous response. The values of all other method parameters must
+ // be identical to those in the previous call.
string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
- // Optional. A list of asset types that the IAM policies are attached to. If empty, it
- // will search the IAM policies that are attached to all the [searchable asset
+ // Optional. A list of asset types that the IAM policies are attached to. If
+ // empty, it will search the IAM policies that are attached to all the
+ // [searchable asset
// types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types).
//
// Regular expressions are also supported. For example:
@@ -1085,9 +1150,9 @@ message SearchAllIamPoliciesRequest {
// supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 5 [(google.api.field_behavior) = OPTIONAL];
- // Optional. A comma-separated list of fields specifying the sorting order of the
- // results. The default order is ascending. Add " DESC" after the field name
- // to indicate descending order. Redundant space characters are ignored.
+ // Optional. A comma-separated list of fields specifying the sorting order of
+ // the results. The default order is ascending. Add " DESC" after the field
+ // name to indicate descending order. Redundant space characters are ignored.
// Example: "assetType DESC, resource".
// Only singular primitive fields in the response are sortable:
// * resource
@@ -1100,8 +1165,8 @@ message SearchAllIamPoliciesRequest {
// Search all IAM policies response.
message SearchAllIamPoliciesResponse {
- // A list of IamPolicy that match the search query. Related information such
- // as the associated resource is returned along with the policy.
+ // A list of IAM policies that match the search query. Related information
+ // such as the associated resource is returned along with the policy.
repeated IamPolicySearchResult results = 1;
// Set if there are more results than those appearing in this response; to get
@@ -1160,9 +1225,10 @@ message IamPolicyAnalysisQuery {
// Optional. If true, the identities section of the result will expand any
// Google groups appearing in an IAM policy binding.
//
- // If [IamPolicyAnalysisQuery.identity_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.identity_selector] is specified, the
- // identity in the result will be determined by the selector, and this flag
- // is not allowed to set.
+ // If
+ // [IamPolicyAnalysisQuery.identity_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.identity_selector]
+ // is specified, the identity in the result will be determined by the
+ // selector, and this flag is not allowed to set.
//
// If true, the default max expansion per group is 1000 for
// AssetService.AnalyzeIamPolicy][].
@@ -1173,32 +1239,35 @@ message IamPolicyAnalysisQuery {
// Optional. If true, the access section of result will expand any roles
// appearing in IAM policy bindings to include their permissions.
//
- // If [IamPolicyAnalysisQuery.access_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.access_selector] is specified, the access
- // section of the result will be determined by the selector, and this flag
- // is not allowed to set.
+ // If
+ // [IamPolicyAnalysisQuery.access_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.access_selector]
+ // is specified, the access section of the result will be determined by the
+ // selector, and this flag is not allowed to set.
//
// Default is false.
bool expand_roles = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. If true and [IamPolicyAnalysisQuery.resource_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.resource_selector] is not
- // specified, the resource section of the result will expand any resource
- // attached to an IAM policy to include resources lower in the resource
- // hierarchy.
+ // Optional. If true and
+ // [IamPolicyAnalysisQuery.resource_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.resource_selector]
+ // is not specified, the resource section of the result will expand any
+ // resource attached to an IAM policy to include resources lower in the
+ // resource hierarchy.
//
// For example, if the request analyzes for which resources user A has
- // permission P, and the results include an IAM policy with P on a GCP
- // folder, the results will also include resources in that folder with
+ // permission P, and the results include an IAM policy with P on a Google
+ // Cloud folder, the results will also include resources in that folder with
// permission P.
//
- // If true and [IamPolicyAnalysisQuery.resource_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.resource_selector] is specified,
- // the resource section of the result will expand the specified resource to
- // include resources lower in the resource hierarchy. Only project or
- // lower resources are supported. Folder and organization resource cannot be
- // used together with this option.
+ // If true and
+ // [IamPolicyAnalysisQuery.resource_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.resource_selector]
+ // is specified, the resource section of the result will expand the
+ // specified resource to include resources lower in the resource hierarchy.
+ // Only project or lower resources are supported. Folder and organization
+ // resources cannot be used together with this option.
//
// For example, if the request analyzes for which users have permission P on
- // a GCP project with this option enabled, the results will include all
- // users who have permission P on that project or any lower resource.
+ // a Google Cloud project with this option enabled, the results will include
+ // all users who have permission P on that project or any lower resource.
//
// If true, the default max expansion per resource is 1000 for
// AssetService.AnalyzeIamPolicy][] and 100000 for
@@ -1207,36 +1276,38 @@ message IamPolicyAnalysisQuery {
// Default is false.
bool expand_resources = 3 [(google.api.field_behavior) = OPTIONAL];
- // Optional. If true, the result will output the relevant parent/child relationships
- // between resources.
- // Default is false.
+ // Optional. If true, the result will output the relevant parent/child
+ // relationships between resources. Default is false.
bool output_resource_edges = 4 [(google.api.field_behavior) = OPTIONAL];
- // Optional. If true, the result will output the relevant membership relationships
- // between groups and other groups, and between groups and principals.
- // Default is false.
+ // Optional. If true, the result will output the relevant membership
+ // relationships between groups and other groups, and between groups and
+ // principals. Default is false.
bool output_group_edges = 5 [(google.api.field_behavior) = OPTIONAL];
- // Optional. If true, the response will include access analysis from identities to
- // resources via service account impersonation. This is a very expensive
- // operation, because many derived queries will be executed. We highly
- // recommend you use [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning] rpc
- // instead.
+ // Optional. If true, the response will include access analysis from
+ // identities to resources via service account impersonation. This is a very
+ // expensive operation, because many derived queries will be executed. We
+ // highly recommend you use
+ // [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning]
+ // RPC instead.
//
// For example, if the request analyzes for which resources user A has
// permission P, and there's an IAM policy states user A has
// iam.serviceAccounts.getAccessToken permission to a service account SA,
// and there's another IAM policy states service account SA has permission P
- // to a GCP folder F, then user A potentially has access to the GCP folder
- // F. And those advanced analysis results will be included in
+ // to a Google Cloud folder F, then user A potentially has access to the
+ // Google Cloud folder F. And those advanced analysis results will be
+ // included in
// [AnalyzeIamPolicyResponse.service_account_impersonation_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.service_account_impersonation_analysis].
//
// Another example, if the request analyzes for who has
- // permission P to a GCP folder F, and there's an IAM policy states user A
- // has iam.serviceAccounts.actAs permission to a service account SA, and
- // there's another IAM policy states service account SA has permission P to
- // the GCP folder F, then user A potentially has access to the GCP folder
- // F. And those advanced analysis results will be included in
+ // permission P to a Google Cloud folder F, and there's an IAM policy states
+ // user A has iam.serviceAccounts.actAs permission to a service account SA,
+ // and there's another IAM policy states service account SA has permission P
+ // to the Google Cloud folder F, then user A potentially has access to the
+ // Google Cloud folder F. And those advanced analysis results will be
+ // included in
// [AnalyzeIamPolicyResponse.service_account_impersonation_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.service_account_impersonation_analysis].
//
// Only the following permissions are considered in this analysis:
@@ -1249,7 +1320,8 @@ message IamPolicyAnalysisQuery {
// * `iam.serviceAccounts.implicitDelegation`
//
// Default is false.
- bool analyze_service_account_impersonation = 6 [(google.api.field_behavior) = OPTIONAL];
+ bool analyze_service_account_impersonation = 6
+ [(google.api.field_behavior) = OPTIONAL];
}
// The IAM conditions context.
@@ -1263,8 +1335,8 @@ message IamPolicyAnalysisQuery {
}
}
- // Required. The relative name of the root asset. Only resources and IAM policies within
- // the scope will be analyzed.
+ // Required. The relative name of the root asset. Only resources and IAM
+ // policies within the scope will be analyzed.
//
// This can only be an organization number (such as "organizations/123"), a
// folder number (such as "folders/123"), a project ID (such as
@@ -1278,10 +1350,12 @@ message IamPolicyAnalysisQuery {
string scope = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. Specifies a resource for analysis.
- ResourceSelector resource_selector = 2 [(google.api.field_behavior) = OPTIONAL];
+ ResourceSelector resource_selector = 2
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. Specifies an identity for analysis.
- IdentitySelector identity_selector = 3 [(google.api.field_behavior) = OPTIONAL];
+ IdentitySelector identity_selector = 3
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. Specifies roles or permissions for analysis. This is optional.
AccessSelector access_selector = 4 [(google.api.field_behavior) = OPTIONAL];
@@ -1290,13 +1364,16 @@ message IamPolicyAnalysisQuery {
Options options = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional. The hypothetical context for IAM conditions evaluation.
- ConditionContext condition_context = 6 [(google.api.field_behavior) = OPTIONAL];
+ ConditionContext condition_context = 6
+ [(google.api.field_behavior) = OPTIONAL];
}
-// A request message for [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy].
+// A request message for
+// [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy].
message AnalyzeIamPolicyRequest {
// Required. The request query.
- IamPolicyAnalysisQuery analysis_query = 1 [(google.api.field_behavior) = REQUIRED];
+ IamPolicyAnalysisQuery analysis_query = 1
+ [(google.api.field_behavior) = REQUIRED];
// Optional. The name of a saved query, which must be in the format of:
//
@@ -1316,7 +1393,8 @@ message AnalyzeIamPolicyRequest {
// presence yet.
string saved_analysis_query = 3 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Amount of time executable has to complete. See JSON representation of
+ // Optional. Amount of time executable has to complete. See JSON
+ // representation of
// [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json).
//
// If this field is set with a value less than the RPC deadline, and the
@@ -1326,22 +1404,26 @@ message AnalyzeIamPolicyRequest {
// If it's not finished until then, you will get a DEADLINE_EXCEEDED error.
//
// Default is empty.
- google.protobuf.Duration execution_timeout = 2 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.Duration execution_timeout = 2
+ [(google.api.field_behavior) = OPTIONAL];
}
-// A response message for [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy].
+// A response message for
+// [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy].
message AnalyzeIamPolicyResponse {
// An analysis message to group the query and results.
message IamPolicyAnalysis {
// The analysis query.
IamPolicyAnalysisQuery analysis_query = 1;
- // A list of [IamPolicyAnalysisResult][google.cloud.asset.v1.IamPolicyAnalysisResult] that matches the analysis query, or
- // empty if no result is found.
+ // A list of
+ // [IamPolicyAnalysisResult][google.cloud.asset.v1.IamPolicyAnalysisResult]
+ // that matches the analysis query, or empty if no result is found.
repeated IamPolicyAnalysisResult analysis_results = 2;
- // Represents whether all entries in the [analysis_results][google.cloud.asset.v1.AnalyzeIamPolicyResponse.IamPolicyAnalysis.analysis_results] have been
- // fully explored to answer the query.
+ // Represents whether all entries in the
+ // [analysis_results][google.cloud.asset.v1.AnalyzeIamPolicyResponse.IamPolicyAnalysis.analysis_results]
+ // have been fully explored to answer the query.
bool fully_explored = 3;
// A list of non-critical errors happened during the query handling.
@@ -1356,9 +1438,11 @@ message AnalyzeIamPolicyResponse {
// enabled.
repeated IamPolicyAnalysis service_account_impersonation_analysis = 2;
- // Represents whether all entries in the [main_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.main_analysis] and
- // [service_account_impersonation_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.service_account_impersonation_analysis] have been fully explored to
- // answer the query in the request.
+ // Represents whether all entries in the
+ // [main_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.main_analysis]
+ // and
+ // [service_account_impersonation_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.service_account_impersonation_analysis]
+ // have been fully explored to answer the query in the request.
bool fully_explored = 3;
}
@@ -1366,8 +1450,8 @@ message AnalyzeIamPolicyResponse {
message IamPolicyAnalysisOutputConfig {
// A Cloud Storage location.
message GcsDestination {
- // Required. The uri of the Cloud Storage object. It's the same uri that is used by
- // gsutil. Example: "gs://bucket_name/object_name". See [Viewing and
+ // Required. The URI of the Cloud Storage object. It's the same URI that is
+ // used by gsutil. Example: "gs://bucket_name/object_name". See [Viewing and
// Editing Object
// Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
// for more information.
@@ -1395,13 +1479,15 @@ message IamPolicyAnalysisOutputConfig {
REQUEST_TIME = 1;
}
- // Required. The BigQuery dataset in format "projects/projectId/datasets/datasetId",
- // to which the analysis results should be exported. If this dataset does
- // not exist, the export call will return an INVALID_ARGUMENT error.
+ // Required. The BigQuery dataset in format
+ // "projects/projectId/datasets/datasetId", to which the analysis results
+ // should be exported. If this dataset does not exist, the export call will
+ // return an INVALID_ARGUMENT error.
string dataset = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The prefix of the BigQuery tables to which the analysis results will be
- // written. Tables will be created based on this table_prefix if not exist:
+ // Required. The prefix of the BigQuery tables to which the analysis results
+ // will be written. Tables will be created based on this table_prefix if not
+ // exist:
// * _analysis table will contain export operation's metadata.
// * _analysis_result will contain all the
// [IamPolicyAnalysisResult][google.cloud.asset.v1.IamPolicyAnalysisResult].
@@ -1412,8 +1498,8 @@ message IamPolicyAnalysisOutputConfig {
// The partition key for BigQuery partitioned table.
PartitionKey partition_key = 3;
- // Optional. Specifies the action that occurs if the destination table or partition
- // already exists. The following values are supported:
+ // Optional. Specifies the action that occurs if the destination table or
+ // partition already exists. The following values are supported:
//
// * WRITE_TRUNCATE: If the table or partition already exists, BigQuery
// overwrites the entire table or all the partitions data.
@@ -1438,10 +1524,12 @@ message IamPolicyAnalysisOutputConfig {
}
}
-// A request message for [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning].
+// A request message for
+// [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning].
message AnalyzeIamPolicyLongrunningRequest {
// Required. The request query.
- IamPolicyAnalysisQuery analysis_query = 1 [(google.api.field_behavior) = REQUIRED];
+ IamPolicyAnalysisQuery analysis_query = 1
+ [(google.api.field_behavior) = REQUIRED];
// Optional. The name of a saved query, which must be in the format of:
//
@@ -1461,14 +1549,15 @@ message AnalyzeIamPolicyLongrunningRequest {
// presence yet.
string saved_analysis_query = 3 [(google.api.field_behavior) = OPTIONAL];
- // Required. Output configuration indicating where the results will be output to.
- IamPolicyAnalysisOutputConfig output_config = 2 [(google.api.field_behavior) = REQUIRED];
+ // Required. Output configuration indicating where the results will be output
+ // to.
+ IamPolicyAnalysisOutputConfig output_config = 2
+ [(google.api.field_behavior) = REQUIRED];
}
-// A response message for [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning].
-message AnalyzeIamPolicyLongrunningResponse {
-
-}
+// A response message for
+// [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning].
+message AnalyzeIamPolicyLongrunningResponse {}
// A saved query which can be shared with others or used later.
message SavedQuery {
@@ -1483,8 +1572,11 @@ message SavedQuery {
message QueryContent {
oneof query_content {
// An IAM Policy Analysis query, which could be used in
- // the [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy] rpc or
- // the [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning] rpc.
+ // the
+ // [AssetService.AnalyzeIamPolicy][google.cloud.asset.v1.AssetService.AnalyzeIamPolicy]
+ // RPC or the
+ // [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning]
+ // RPC.
IamPolicyAnalysisQuery iam_policy_analysis_query = 1;
}
}
@@ -1501,15 +1593,18 @@ message SavedQuery {
string description = 2;
// Output only. The create time of this saved query.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The account's email address who has created this saved query.
string creator = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The last update time of this saved query.
- google.protobuf.Timestamp last_update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp last_update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The account's email address who has updated this saved query most recently.
+ // Output only. The account's email address who has updated this saved query
+ // most recently.
string last_updater = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// Labels applied on the resource.
@@ -1523,11 +1618,11 @@ message SavedQuery {
// Request to create a saved query.
message CreateSavedQueryRequest {
- // Required. The name of the project/folder/organization where this saved_query
- // should be created in. It can only be an organization number (such as
- // "organizations/123"), a folder number (such as "folders/123"), a project ID
- // (such as "projects/my-project-id")", or a project number (such as
- // "projects/12345").
+ // Required. The name of the project/folder/organization where this
+ // saved_query should be created in. It can only be an organization number
+ // (such as "organizations/123"), a folder number (such as "folders/123"), a
+ // project ID (such as "projects/my-project-id")", or a project number (such
+ // as "projects/12345").
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -1535,16 +1630,16 @@ message CreateSavedQueryRequest {
}
];
- // Required. The saved_query details. The `name` field must be empty as it will be
- // generated based on the parent and saved_query_id.
+ // Required. The saved_query details. The `name` field must be empty as it
+ // will be generated based on the parent and saved_query_id.
SavedQuery saved_query = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. The ID to use for the saved query, which must be unique in the specified
- // parent. It will become the final component of the saved query's resource
- // name.
+ // Required. The ID to use for the saved query, which must be unique in the
+ // specified parent. It will become the final component of the saved query's
+ // resource name.
//
// This value should be 4-63 characters, and valid characters
- // are /[a-z][0-9]-/.
+ // are `[a-z][0-9]-`.
//
// Notice that this field is required in the saved query creation, and the
// `name` field of the `saved_query` will be ignored.
@@ -1568,8 +1663,8 @@ message GetSavedQueryRequest {
// Request to list saved queries.
message ListSavedQueriesRequest {
- // Required. The parent project/folder/organization whose savedQueries are to be
- // listed. It can only be using project/folder/organization number (such as
+ // Required. The parent project/folder/organization whose savedQueries are to
+ // be listed. It can only be using project/folder/organization number (such as
// "folders/12345")", or a project ID (such as "projects/my-project-id").
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -1587,8 +1682,9 @@ message ListSavedQueriesRequest {
// See https://google.aip.dev/160 for more information on the grammar.
string filter = 4 [(google.api.field_behavior) = OPTIONAL];
- // Optional. The maximum number of saved queries to return per page. The service may
- // return fewer than this value. If unspecified, at most 50 will be returned.
+ // Optional. The maximum number of saved queries to return per page. The
+ // service may return fewer than this value. If unspecified, at most 50 will
+ // be returned.
// The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
@@ -1623,12 +1719,14 @@ message UpdateSavedQueryRequest {
SavedQuery saved_query = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of fields to update.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// Request to delete a saved query.
message DeleteSavedQueryRequest {
- // Required. The name of the saved query to delete. It must be in the format of:
+ // Required. The name of the saved query to delete. It must be in the format
+ // of:
//
// * projects/project_number/savedQueries/saved_query_id
// * folders/folder_number/savedQueries/saved_query_id
@@ -1659,15 +1757,15 @@ message AnalyzeMoveRequest {
}
// Required. Name of the resource to perform the analysis against.
- // Only GCP Project are supported as of today. Hence, this can only be Project
- // ID (such as "projects/my-project-id") or a Project Number (such as
- // "projects/12345").
+ // Only Google Cloud projects are supported as of today. Hence, this can only
+ // be a project ID (such as "projects/my-project-id") or a project number
+ // (such as "projects/12345").
string resource = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. Name of the GCP Folder or Organization to reparent the target
- // resource. The analysis will be performed against hypothetically moving the
- // resource to this specified desitination parent. This can only be a Folder
- // number (such as "folders/123") or an Organization number (such as
+ // Required. Name of the Google Cloud folder or organization to reparent the
+ // target resource. The analysis will be performed against hypothetically
+ // moving the resource to this specified desitination parent. This can only be
+ // a folder number (such as "folders/123") or an organization number (such as
// "organizations/123").
string destination_parent = 2 [(google.api.field_behavior) = REQUIRED];
@@ -1679,14 +1777,14 @@ message AnalyzeMoveRequest {
// The response message for resource move analysis.
message AnalyzeMoveResponse {
// The list of analyses returned from performing the intended resource move
- // analysis. The analysis is grouped by different Cloud services.
+ // analysis. The analysis is grouped by different Google Cloud services.
repeated MoveAnalysis move_analysis = 1;
}
// A message to group the analysis information.
message MoveAnalysis {
- // The user friendly display name of the analysis. E.g. IAM, Organization
- // Policy etc.
+ // The user friendly display name of the analysis. E.g. IAM, organization
+ // policy etc.
string display_name = 1;
oneof result {
@@ -1720,12 +1818,13 @@ message MoveImpact {
message QueryAssetsOutputConfig {
// BigQuery destination.
message BigQueryDestination {
- // Required. The BigQuery dataset where the query results will be saved. It has the
- // format of "projects/{projectId}/datasets/{datasetId}".
+ // Required. The BigQuery dataset where the query results will be saved. It
+ // has the format of "projects/{projectId}/datasets/{datasetId}".
string dataset = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The BigQuery table where the query results will be saved. If this table
- // does not exist, a new table with the given name will be created.
+ // Required. The BigQuery table where the query results will be saved. If
+ // this table does not exist, a new table with the given name will be
+ // created.
string table = 2 [(google.api.field_behavior) = REQUIRED];
// Specifies the action that occurs if the destination table or partition
@@ -1766,13 +1865,13 @@ message QueryAssetsRequest {
// SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql).
string statement = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Reference to the query job, which is from the `QueryAssetsResponse` of
- // previous `QueryAssets` call.
+ // Optional. Reference to the query job, which is from the
+ // `QueryAssetsResponse` of previous `QueryAssets` call.
string job_reference = 3 [(google.api.field_behavior) = OPTIONAL];
}
- // Optional. The maximum number of rows to return in the results. Responses are limited
- // to 10 MB and 1000 rows.
+ // Optional. The maximum number of rows to return in the results. Responses
+ // are limited to 10 MB and 1000 rows.
//
// By default, the maximum row count is 1000. When the byte or row count limit
// is reached, the rest of the query results will be paginated.
@@ -1785,10 +1884,11 @@ message QueryAssetsRequest {
// The field will be ignored when [output_config] is specified.
string page_token = 5 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Specifies the maximum amount of time that the client is willing to wait
- // for the query to complete. By default, this limit is 5 min for the first
- // query, and 1 minute for the following queries. If the query is complete,
- // the `done` field in the `QueryAssetsResponse` is true, otherwise false.
+ // Optional. Specifies the maximum amount of time that the client is willing
+ // to wait for the query to complete. By default, this limit is 5 min for the
+ // first query, and 1 minute for the following queries. If the query is
+ // complete, the `done` field in the `QueryAssetsResponse` is true, otherwise
+ // false.
//
// Like BigQuery [jobs.query
// API](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#queryrequest)
@@ -1807,13 +1907,15 @@ message QueryAssetsRequest {
// If data for the timestamp/date range selected does not exist,
// it will simply return a valid response with no rows.
oneof time {
- // Optional. [start_time] is required. [start_time] must be less than [end_time]
- // Defaults [end_time] to now if [start_time] is set and [end_time] isn't.
- // Maximum permitted time range is 7 days.
+ // Optional. [start_time] is required. [start_time] must be less than
+ // [end_time] Defaults [end_time] to now if [start_time] is set and
+ // [end_time] isn't. Maximum permitted time range is 7 days.
TimeWindow read_time_window = 7 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Queries cloud assets as they appeared at the specified point in time.
- google.protobuf.Timestamp read_time = 8 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. Queries cloud assets as they appeared at the specified point in
+ // time.
+ google.protobuf.Timestamp read_time = 8
+ [(google.api.field_behavior) = OPTIONAL];
}
// Optional. Destination where the query results will be saved.
@@ -1825,7 +1927,8 @@ message QueryAssetsRequest {
// Meanwhile, [QueryAssetsResponse.job_reference] will be set and can be used
// to check the status of the query job when passed to a following
// [QueryAssets] API call.
- QueryAssetsOutputConfig output_config = 9 [(google.api.field_behavior) = OPTIONAL];
+ QueryAssetsOutputConfig output_config = 9
+ [(google.api.field_behavior) = OPTIONAL];
}
// QueryAssets response.
@@ -1912,7 +2015,8 @@ message TableFieldSchema {
repeated TableFieldSchema fields = 4;
}
-// A request message for [AssetService.BatchGetEffectiveIamPolicies][google.cloud.asset.v1.AssetService.BatchGetEffectiveIamPolicies].
+// A request message for
+// [AssetService.BatchGetEffectiveIamPolicies][google.cloud.asset.v1.AssetService.BatchGetEffectiveIamPolicies].
message BatchGetEffectiveIamPoliciesRequest {
// Required. Only IAM policies on or below the scope will be returned.
//
@@ -1927,9 +2031,7 @@ message BatchGetEffectiveIamPoliciesRequest {
// ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).
string scope = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "*"
- }
+ (google.api.resource_reference) = { child_type: "*" }
];
// Required. The names refer to the [full_resource_names]
@@ -1939,56 +2041,577 @@ message BatchGetEffectiveIamPoliciesRequest {
// A maximum of 20 resources' effective policies can be retrieved in a batch.
repeated string names = 3 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "*"
- }
+ (google.api.resource_reference) = { type: "*" }
];
}
-// A response message for [AssetService.BatchGetEffectiveIamPolicies][google.cloud.asset.v1.AssetService.BatchGetEffectiveIamPolicies].
+// A response message for
+// [AssetService.BatchGetEffectiveIamPolicies][google.cloud.asset.v1.AssetService.BatchGetEffectiveIamPolicies].
message BatchGetEffectiveIamPoliciesResponse {
// The effective IAM policies on one resource.
message EffectiveIamPolicy {
// The IAM policy and its attached resource.
message PolicyInfo {
- // The full resource name the [policy][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.PolicyInfo.policy] is directly attached to.
+ // The full resource name the
+ // [policy][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.PolicyInfo.policy]
+ // is directly attached to.
string attached_resource = 1;
- // The IAM policy that's directly attached to the [attached_resource][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.PolicyInfo.attached_resource].
+ // The IAM policy that's directly attached to the
+ // [attached_resource][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.PolicyInfo.attached_resource].
google.iam.v1.Policy policy = 2;
}
// The [full_resource_name]
// (https://cloud.google.com/asset-inventory/docs/resource-name-format)
- // for which the [policies][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.policies] are computed. This is one of the
- // [BatchGetEffectiveIamPoliciesRequest.names][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesRequest.names] the caller provides in the
- // request.
+ // for which the
+ // [policies][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.policies]
+ // are computed. This is one of the
+ // [BatchGetEffectiveIamPoliciesRequest.names][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesRequest.names]
+ // the caller provides in the request.
string full_resource_name = 1;
- // The effective policies for the [full_resource_name][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.full_resource_name].
+ // The effective policies for the
+ // [full_resource_name][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.full_resource_name].
//
- // These policies include the policy set on the [full_resource_name][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.full_resource_name] and
- // those set on its parents and ancestors up to the
- // [BatchGetEffectiveIamPoliciesRequest.scope][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesRequest.scope]. Note that these policies
- // are not filtered according to the resource type of the
+ // These policies include the policy set on the
+ // [full_resource_name][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.full_resource_name]
+ // and those set on its parents and ancestors up to the
+ // [BatchGetEffectiveIamPoliciesRequest.scope][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesRequest.scope].
+ // Note that these policies are not filtered according to the resource type
+ // of the
// [full_resource_name][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.full_resource_name].
//
// These policies are hierarchically ordered by
- // [PolicyInfo.attached_resource][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.PolicyInfo.attached_resource] starting from [full_resource_name][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.full_resource_name]
+ // [PolicyInfo.attached_resource][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.PolicyInfo.attached_resource]
+ // starting from
+ // [full_resource_name][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.full_resource_name]
// itself to its parents and ancestors, such that policies[i]'s
- // [PolicyInfo.attached_resource][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.PolicyInfo.attached_resource] is the child of policies[i+1]'s
- // [PolicyInfo.attached_resource][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.PolicyInfo.attached_resource], if policies[i+1] exists.
+ // [PolicyInfo.attached_resource][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.PolicyInfo.attached_resource]
+ // is the child of policies[i+1]'s
+ // [PolicyInfo.attached_resource][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.PolicyInfo.attached_resource],
+ // if policies[i+1] exists.
repeated PolicyInfo policies = 2;
}
// The effective policies for a batch of resources. Note that the results
// order is the same as the order of
- // [BatchGetEffectiveIamPoliciesRequest.names][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesRequest.names]. When a resource does not
- // have any effective IAM policies, its corresponding policy_result will
- // contain empty [EffectiveIamPolicy.policies][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.policies].
+ // [BatchGetEffectiveIamPoliciesRequest.names][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesRequest.names].
+ // When a resource does not have any effective IAM policies, its corresponding
+ // policy_result will contain empty
+ // [EffectiveIamPolicy.policies][google.cloud.asset.v1.BatchGetEffectiveIamPoliciesResponse.EffectiveIamPolicy.policies].
repeated EffectiveIamPolicy policy_results = 2;
}
+// This organization policy message is a modified version of the one defined in
+// the Organization Policy system. This message contains several fields defined
+// in the original organization policy with some new fields for analysis
+// purpose.
+message AnalyzerOrgPolicy {
+ // Represents a rule defined in an organization policy
+ message Rule {
+ // The string values for the list constraints.
+ message StringValues {
+ // List of values allowed at this resource.
+ repeated string allowed_values = 1;
+
+ // List of values denied at this resource.
+ repeated string denied_values = 2;
+ }
+
+ oneof kind {
+ // List of values to be used for this PolicyRule. This field can be set
+ // only in Policies for list constraints.
+ StringValues values = 3;
+
+ // Setting this to true means that all values are allowed. This field can
+ // be set only in Policies for list constraints.
+ bool allow_all = 4;
+
+ // Setting this to true means that all values are denied. This field can
+ // be set only in Policies for list constraints.
+ bool deny_all = 5;
+
+ // If `true`, then the `Policy` is enforced. If `false`, then any
+ // configuration is acceptable.
+ // This field can be set only in Policies for boolean constraints.
+ bool enforce = 6;
+ }
+
+ // The evaluating condition for this rule.
+ google.type.Expr condition = 7;
+ }
+
+ // The [full resource name]
+ // (https://cloud.google.com/asset-inventory/docs/resource-name-format) of
+ // an organization/folder/project resource where this organization policy is
+ // set.
+ //
+ // Notice that some type of constraints are defined with default policy. This
+ // field will be empty for them.
+ string attached_resource = 1;
+
+ // The [full resource name]
+ // (https://cloud.google.com/asset-inventory/docs/resource-name-format) of
+ // an organization/folder/project resource where this organization policy
+ // applies to.
+ //
+ // For any user defined org policies, this field has the same value as
+ // the [attached_resource] field. Only for default policy, this field has
+ // the different value.
+ string applied_resource = 5;
+
+ // List of rules for this organization policy.
+ repeated Rule rules = 2;
+
+ // If `inherit_from_parent` is true, Rules set higher up in the
+ // hierarchy (up to the closest root) are inherited and present in the
+ // effective policy. If it is false, then no rules are inherited, and this
+ // policy becomes the effective root for evaluation.
+ bool inherit_from_parent = 3;
+
+ // Ignores policies set above this resource and restores the default behavior
+ // of the constraint at this resource.
+ // This field can be set in policies for either list or boolean
+ // constraints. If set, `rules` must be empty and `inherit_from_parent`
+ // must be set to false.
+ bool reset = 4;
+}
+
+// The organization policy constraint definition.
+message AnalyzerOrgPolicyConstraint {
+ // The definition of a constraint.
+ message Constraint {
+ // Specifies the default behavior in the absence of any `Policy` for the
+ // `Constraint`. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`.
+ enum ConstraintDefault {
+ // This is only used for distinguishing unset values and should never be
+ // used.
+ CONSTRAINT_DEFAULT_UNSPECIFIED = 0;
+
+ // Indicate that all values are allowed for list constraints.
+ // Indicate that enforcement is off for boolean constraints.
+ ALLOW = 1;
+
+ // Indicate that all values are denied for list constraints.
+ // Indicate that enforcement is on for boolean constraints.
+ DENY = 2;
+ }
+
+ // A `Constraint` that allows or disallows a list of string values, which
+ // are configured by an organization's policy administrator with a `Policy`.
+ message ListConstraint {
+ // Indicates whether values grouped into categories can be used in
+ // `Policy.allowed_values` and `Policy.denied_values`. For example,
+ // `"in:Python"` would match any value in the 'Python' group.
+ bool supports_in = 1;
+
+ // Indicates whether subtrees of Cloud Resource Manager resource hierarchy
+ // can be used in `Policy.allowed_values` and `Policy.denied_values`. For
+ // example, `"under:folders/123"` would match any resource under the
+ // 'folders/123' folder.
+ bool supports_under = 2;
+ }
+
+ // A `Constraint` that is either enforced or not.
+ //
+ // For example a constraint `constraints/compute.disableSerialPortAccess`.
+ // If it is enforced on a VM instance, serial port connections will not be
+ // opened to that instance.
+ message BooleanConstraint {}
+
+ // The unique name of the constraint. Format of the name should be
+ // * `constraints/{constraint_name}`
+ //
+ // For example, `constraints/compute.disableSerialPortAccess`.
+ string name = 1;
+
+ // The human readable name of the constraint.
+ string display_name = 2;
+
+ // Detailed description of what this `Constraint` controls as well as how
+ // and where it is enforced.
+ string description = 3;
+
+ // The evaluation behavior of this constraint in the absence of 'Policy'.
+ ConstraintDefault constraint_default = 4;
+
+ // The type of restrictions for this `Constraint`.
+ //
+ // Immutable after creation.
+ oneof constraint_type {
+ // Defines this constraint as being a ListConstraint.
+ ListConstraint list_constraint = 5;
+
+ // Defines this constraint as being a BooleanConstraint.
+ BooleanConstraint boolean_constraint = 6;
+ }
+ }
+
+ // The definition of a custom constraint.
+ message CustomConstraint {
+ // The operation in which this constraint will be applied. For example:
+ // If the constraint applies only when create VMs, the method_types will be
+ // "CREATE" only. If the constraint applied when create or delete VMs, the
+ // method_types will be "CREATE" and "DELETE".
+ enum MethodType {
+ // Unspecified. Will results in user error.
+ METHOD_TYPE_UNSPECIFIED = 0;
+
+ // Constraint applied when creating the resource.
+ CREATE = 1;
+
+ // Constraint applied when updating the resource.
+ UPDATE = 2;
+
+ // Constraint applied when deleting the resource.
+ DELETE = 3;
+ }
+
+ // Allow or deny type.
+ enum ActionType {
+ // Unspecified. Will results in user error.
+ ACTION_TYPE_UNSPECIFIED = 0;
+
+ // Allowed action type.
+ ALLOW = 1;
+
+ // Deny action type.
+ DENY = 2;
+ }
+
+ // Name of the constraint. This is unique within the organization. Format of
+ // the name should be
+ // * `organizations/{organization_id}/customConstraints/{custom_constraint_id}`
+ //
+ // Example :
+ // "organizations/123/customConstraints/custom.createOnlyE2TypeVms"
+ string name = 1;
+
+ // The Resource Instance type on which this policy applies to. Format will
+ // be of the form : "/" Example:
+ // * `compute.googleapis.com/Instance`.
+ repeated string resource_types = 2;
+
+ // All the operations being applied for this constraint.
+ repeated MethodType method_types = 3;
+
+ // Organization Policy condition/expression. For example:
+ // `resource.instanceName.matches("[production|test]_.*_(\d)+")'` or,
+ // `resource.management.auto_upgrade == true`
+ string condition = 4;
+
+ // Allow or deny type.
+ ActionType action_type = 5;
+
+ // One line display name for the UI.
+ string display_name = 6;
+
+ // Detailed information about this custom policy constraint.
+ string description = 7;
+ }
+
+ oneof constraint_definition {
+ // The definition of the canned constraint defined by Google.
+ Constraint google_defined_constraint = 1;
+
+ // The definition of the custom constraint.
+ CustomConstraint custom_constraint = 2;
+ }
+}
+
+// A request message for
+// [AssetService.AnalyzeOrgPolicies][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicies].
+message AnalyzeOrgPoliciesRequest {
+ // Required. The organization to scope the request. Only organization
+ // policies within the scope will be analyzed.
+ //
+ // * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
+ string scope = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The name of the constraint to analyze organization policies for.
+ // The response only contains analyzed organization policies for the provided
+ // constraint.
+ string constraint = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // The expression to filter
+ // [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results].
+ // The only supported field is `consolidated_policy.attached_resource`, and
+ // the only supported operator is `=`.
+ //
+ // Example:
+ // consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001"
+ // will return the org policy results of"folders/001".
+ string filter = 3;
+
+ // The maximum number of items to return per page. If unspecified,
+ // [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results]
+ // will contain 20 items with a maximum of 200.
+ optional int32 page_size = 4;
+
+ // The pagination token to retrieve the next page.
+ string page_token = 5;
+}
+
+// The response message for
+// [AssetService.AnalyzeOrgPolicies][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicies].
+message AnalyzeOrgPoliciesResponse {
+ // The organization policy result to the query.
+ message OrgPolicyResult {
+ // The consolidated organization policy for the analyzed resource. The
+ // consolidated organization policy is computed by merging and evaluating
+ // [AnalyzeOrgPoliciesResponse.policy_bundle][].
+ // The evaluation will respect the organization policy [hierarchy
+ // rules](https://cloud.google.com/resource-manager/docs/organization-policy/understanding-hierarchy).
+ AnalyzerOrgPolicy consolidated_policy = 1;
+
+ // The ordered list of all organization policies from the
+ // [AnalyzeOrgPoliciesResponse.OrgPolicyResult.consolidated_policy.attached_resource][].
+ // to the scope specified in the request.
+ //
+ // If the constraint is defined with default policy, it will also appear in
+ // the list.
+ repeated AnalyzerOrgPolicy policy_bundle = 2;
+ }
+
+ // The organization policies under the
+ // [AnalyzeOrgPoliciesRequest.scope][google.cloud.asset.v1.AnalyzeOrgPoliciesRequest.scope]
+ // with the
+ // [AnalyzeOrgPoliciesRequest.constraint][google.cloud.asset.v1.AnalyzeOrgPoliciesRequest.constraint].
+ repeated OrgPolicyResult org_policy_results = 1;
+
+ // The definition of the constraint in the request.
+ AnalyzerOrgPolicyConstraint constraint = 2;
+
+ // The page token to fetch the next page for
+ // [AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results].
+ string next_page_token = 3;
+}
+
+// A request message for
+// [AssetService.AnalyzeOrgPolicyGovernedContainers][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedContainers].
+message AnalyzeOrgPolicyGovernedContainersRequest {
+ // Required. The organization to scope the request. Only organization
+ // policies within the scope will be analyzed. The output containers will
+ // also be limited to the ones governed by those in-scope organization
+ // policies.
+ //
+ // * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
+ string scope = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The name of the constraint to analyze governed containers for.
+ // The analysis only contains organization policies for the provided
+ // constraint.
+ string constraint = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // The expression to filter the governed containers in result.
+ // The only supported field is `parent`, and the only supported operator is
+ // `=`.
+ //
+ // Example:
+ // parent="//cloudresourcemanager.googleapis.com/folders/001" will return all
+ // containers under "folders/001".
+ string filter = 3;
+
+ // The maximum number of items to return per page. If unspecified,
+ // [AnalyzeOrgPolicyGovernedContainersResponse.governed_containers][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.governed_containers]
+ // will contain 100 items with a maximum of 200.
+ optional int32 page_size = 4;
+
+ // The pagination token to retrieve the next page.
+ string page_token = 5;
+}
+
+// The response message for
+// [AssetService.AnalyzeOrgPolicyGovernedContainers][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedContainers].
+message AnalyzeOrgPolicyGovernedContainersResponse {
+ // The organization/folder/project resource governed by organization policies
+ // of
+ // [AnalyzeOrgPolicyGovernedContainersRequest.constraint][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersRequest.constraint].
+ message GovernedContainer {
+ // The [full resource name]
+ // (https://cloud.google.com/asset-inventory/docs/resource-name-format) of
+ // an organization/folder/project resource.
+ string full_resource_name = 1;
+
+ // The [full resource name]
+ // (https://cloud.google.com/asset-inventory/docs/resource-name-format) of
+ // the parent of
+ // [AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer.full_resource_name][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer.full_resource_name].
+ string parent = 2;
+
+ // The consolidated organization policy for the analyzed resource. The
+ // consolidated organization policy is computed by merging and evaluating
+ // [AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer.policy_bundle][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.GovernedContainer.policy_bundle].
+ // The evaluation will respect the organization policy [hierarchy
+ // rules](https://cloud.google.com/resource-manager/docs/organization-policy/understanding-hierarchy).
+ AnalyzerOrgPolicy consolidated_policy = 3;
+
+ // The ordered list of all organization policies from the
+ // [AnalyzeOrgPoliciesResponse.OrgPolicyResult.consolidated_policy.attached_resource][].
+ // to the scope specified in the request.
+ //
+ // If the constraint is defined with default policy, it will also appear in
+ // the list.
+ repeated AnalyzerOrgPolicy policy_bundle = 4;
+ }
+
+ // The list of the analyzed governed containers.
+ repeated GovernedContainer governed_containers = 1;
+
+ // The definition of the constraint in the request.
+ AnalyzerOrgPolicyConstraint constraint = 2;
+
+ // The page token to fetch the next page for
+ // [AnalyzeOrgPolicyGovernedContainersResponse.governed_containers][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedContainersResponse.governed_containers].
+ string next_page_token = 3;
+}
+
+// A request message for
+// [AssetService.AnalyzeOrgPolicyGovernedAssets][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedAssets].
+message AnalyzeOrgPolicyGovernedAssetsRequest {
+ // Required. The organization to scope the request. Only organization
+ // policies within the scope will be analyzed. The output assets will
+ // also be limited to the ones governed by those in-scope organization
+ // policies.
+ //
+ // * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
+ string scope = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The name of the constraint to analyze governed assets for. The
+ // analysis only contains analyzed organization policies for the provided
+ // constraint.
+ string constraint = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // The expression to filter the governed assets in result. The only supported
+ // fields for governed resources are `governed_resource.project` and
+ // `governed_resource.folders`. The only supported fields for governed iam
+ // policies are `governed_iam_policy.project` and
+ // `governed_iam_policy.folders`. The only supported operator is `=`.
+ //
+ // Example 1: governed_resource.project="projects/12345678" filter will return
+ // all governed resources under projects/12345678 including the project
+ // ifself, if applicable.
+ //
+ // Example 2: governed_iam_policy.folders="folders/12345678" filter will
+ // return all governed iam policies under folders/12345678, if applicable.
+ string filter = 3;
+
+ // The maximum number of items to return per page. If unspecified,
+ // [AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets]
+ // will contain 100 items with a maximum of 200.
+ optional int32 page_size = 4;
+
+ // The pagination token to retrieve the next page.
+ string page_token = 5;
+}
+
+// The response message for
+// [AssetService.AnalyzeOrgPolicyGovernedAssets][google.cloud.asset.v1.AssetService.AnalyzeOrgPolicyGovernedAssets].
+message AnalyzeOrgPolicyGovernedAssetsResponse {
+ // The Google Cloud resources governed by the organization policies of the
+ // [AnalyzeOrgPolicyGovernedAssetsRequest.constraint][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsRequest.constraint].
+ message GovernedResource {
+ // The [full resource name]
+ // (https://cloud.google.com/asset-inventory/docs/resource-name-format) of
+ // the Google Cloud resource.
+ string full_resource_name = 1;
+
+ // The [full resource name]
+ // (https://cloud.google.com/asset-inventory/docs/resource-name-format) of
+ // the parent of
+ // [AnalyzeOrgPolicyGovernedAssetsResponse.GovernedResource.full_resource_name][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.GovernedResource.full_resource_name].
+ string parent = 2;
+
+ // The project that this resource belongs to, in the form of
+ // projects/{PROJECT_NUMBER}. This field is available when the resource
+ // belongs to a project.
+ string project = 5;
+
+ // The folder(s) that this resource belongs to, in the form of
+ // folders/{FOLDER_NUMBER}. This field is available when the resource
+ // belongs(directly or cascadingly) to one or more folders.
+ repeated string folders = 6;
+
+ // The organization that this resource belongs to, in the form of
+ // organizations/{ORGANIZATION_NUMBER}. This field is available when the
+ // resource belongs(directly or cascadingly) to an organization.
+ string organization = 7;
+ }
+
+ // The IAM policies governed by the organization policies of the
+ // [AnalyzeOrgPolicyGovernedAssetsRequest.constraint][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsRequest.constraint].
+ message GovernedIamPolicy {
+ // The full resource name of the resource associated with this IAM policy.
+ // Example:
+ // `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
+ // See [Cloud Asset Inventory Resource Name
+ // Format](https://cloud.google.com/asset-inventory/docs/resource-name-format)
+ // for more information.
+ string attached_resource = 1;
+
+ // The IAM policy directly set on the given resource.
+ google.iam.v1.Policy policy = 2;
+
+ // The project that this IAM policy belongs to, in the form of
+ // projects/{PROJECT_NUMBER}. This field is available when the IAM policy
+ // belongs to a project.
+ string project = 5;
+
+ // The folder(s) that this IAM policy belongs to, in the form of
+ // folders/{FOLDER_NUMBER}. This field is available when the IAM policy
+ // belongs(directly or cascadingly) to one or more folders.
+ repeated string folders = 6;
+
+ // The organization that this IAM policy belongs to, in the form of
+ // organizations/{ORGANIZATION_NUMBER}. This field is available when the
+ // IAM policy belongs(directly or cascadingly) to an organization.
+ string organization = 7;
+ }
+
+ // Represents a Google Cloud asset(resource or IAM policy) governed by the
+ // organization policies of the
+ // [AnalyzeOrgPolicyGovernedAssetsRequest.constraint][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsRequest.constraint].
+ message GovernedAsset {
+ oneof governed_asset {
+ // A Google Cloud resource governed by the organization
+ // policies of the
+ // [AnalyzeOrgPolicyGovernedAssetsRequest.constraint][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsRequest.constraint].
+ GovernedResource governed_resource = 1;
+
+ // An IAM policy governed by the organization
+ // policies of the
+ // [AnalyzeOrgPolicyGovernedAssetsRequest.constraint][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsRequest.constraint].
+ GovernedIamPolicy governed_iam_policy = 2;
+ }
+
+ // The consolidated policy for the analyzed asset. The consolidated
+ // policy is computed by merging and evaluating
+ // [AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset.policy_bundle][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.GovernedAsset.policy_bundle].
+ // The evaluation will respect the organization policy [hierarchy
+ // rules](https://cloud.google.com/resource-manager/docs/organization-policy/understanding-hierarchy).
+ AnalyzerOrgPolicy consolidated_policy = 3;
+
+ // The ordered list of all organization policies from the
+ // [AnalyzeOrgPoliciesResponse.OrgPolicyResult.consolidated_policy.attached_resource][]
+ // to the scope specified in the request.
+ //
+ // If the constraint is defined with default policy, it will also appear in
+ // the list.
+ repeated AnalyzerOrgPolicy policy_bundle = 4;
+ }
+
+ // The list of the analyzed governed assets.
+ repeated GovernedAsset governed_assets = 1;
+
+ // The definition of the constraint in the request.
+ AnalyzerOrgPolicyConstraint constraint = 2;
+
+ // The page token to fetch the next page for
+ // [AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets][google.cloud.asset.v1.AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets].
+ string next_page_token = 3;
+}
+
// Asset content type.
enum ContentType {
// Unspecified content type.
@@ -2000,10 +2623,10 @@ enum ContentType {
// The actual IAM policy set on a resource.
IAM_POLICY = 2;
- // The Cloud Organization Policy set on an asset.
+ // The organization policy set on an asset.
ORG_POLICY = 4;
- // The Cloud Access context manager Policy set on an asset.
+ // The Access Context Manager policy set on an asset.
ACCESS_POLICY = 5;
// The runtime OS Inventory information.
diff --git a/third_party/googleapis/google/cloud/asset/v1/assets.proto b/third_party/googleapis/google/cloud/asset/v1/assets.proto
index 8f22b5031..e540bf60d 100644
--- a/third_party/googleapis/google/cloud/asset/v1/assets.proto
+++ b/third_party/googleapis/google/cloud/asset/v1/assets.proto
@@ -30,7 +30,7 @@ import "google/rpc/code.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Asset.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/asset/v1;asset";
+option go_package = "cloud.google.com/go/asset/apiv1/assetpb;assetpb";
option java_multiple_files = true;
option java_outer_classname = "AssetProto";
option java_package = "com.google.cloud.asset.v1";
@@ -88,7 +88,7 @@ message TimeWindow {
// [resource
// hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy),
// a resource outside the Google Cloud resource hierarchy (such as Google
-// Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy),
+// Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy),
// or a relationship (e.g. an INSTANCE_TO_INSTANCEGROUP relationship).
// See [Supported asset
// types](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
@@ -121,9 +121,9 @@ message Asset {
// A representation of the resource.
Resource resource = 3;
- // A representation of the Cloud IAM policy set on a Google Cloud resource.
- // There can be a maximum of one Cloud IAM policy set on any given resource.
- // In addition, Cloud IAM policies inherit their granted access scope from any
+ // A representation of the IAM policy set on a Google Cloud resource.
+ // There can be a maximum of one IAM policy set on any given resource.
+ // In addition, IAM policies inherit their granted access scope from any
// policies set on parent resources in the resource hierarchy. Therefore, the
// effectively policy is the union of both the policy set on this resource
// and each policy set on all of the resource's ancestry resource levels in
@@ -151,7 +151,8 @@ message Asset {
// Please also refer to the [service perimeter user
// guide](https://cloud.google.com/vpc-service-controls/docs/overview).
- google.identity.accesscontextmanager.v1.ServicePerimeter service_perimeter = 9;
+ google.identity.accesscontextmanager.v1.ServicePerimeter service_perimeter =
+ 9;
}
// A representation of runtime OS Inventory information. See [this
@@ -213,7 +214,7 @@ message Resource {
// for more information.
//
// For Google Cloud assets, this value is the parent resource defined in the
- // [Cloud IAM policy
+ // [IAM policy
// hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).
// Example:
// `//cloudresourcemanager.googleapis.com/projects/my_project_123`
@@ -270,7 +271,7 @@ message RelationshipAttributes {
// ancestors. An asset can be any resource in the Google Cloud [resource
// hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy),
// a resource outside the Google Cloud resource hierarchy (such as Google
-// Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy).
+// Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy).
// See [Supported asset
// types](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
// for more information.
@@ -282,8 +283,8 @@ message RelatedAsset {
// names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
// for more information.
string asset = 1 [(google.api.resource_reference) = {
- type: "cloudasset.googleapis.com/Asset"
- }];
+ type: "cloudasset.googleapis.com/Asset"
+ }];
// The type of the asset. Example: `compute.googleapis.com/Disk`
//
@@ -389,7 +390,8 @@ message ResourceSearchResult {
// * Use a free text query. Example: `us-west*`
string location = 6;
- // Labels associated with this resource. See [Labelling and grouping GCP
+ // Labels associated with this resource. See [Labelling and grouping Google
+ // Cloud
// resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources)
// for more information. This field is available only when the resource's
// Protobuf contains it.
@@ -404,7 +406,8 @@ message ResourceSearchResult {
map labels = 7;
// Network tags associated with this resource. Like labels, network tags are a
- // type of annotations used to group GCP resources. See [Labelling GCP
+ // type of annotations used to group Google Cloud resources. See [Labelling
+ // Google Cloud
// resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources)
// for more information. This field is available only when the resource's
// Protobuf contains it.
@@ -422,8 +425,8 @@ message ResourceSearchResult {
// name.
//
// This field only presents for the purpose of backward compatibility. Please
- // use the `kms_keys` field to retrieve KMS key information. This field is
- // available only when the resource's Protobuf contains it and will only be
+ // use the `kms_keys` field to retrieve Cloud KMS key information. This field
+ // is available only when the resource's Protobuf contains it and will only be
// populated for [these resource
// types](https://cloud.google.com/asset-inventory/docs/legacy-field-names#resource_types_with_the_to_be_deprecated_kmskey_field)
// for backward compatible purposes.
@@ -485,7 +488,7 @@ message ResourceSearchResult {
// SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. See `status` definition
// in [API
// Reference](https://cloud.google.com/compute/docs/reference/rest/v1/instances).
- // If the resource is a project provided by Cloud Resource Manager, its state
+ // If the resource is a project provided by Resource Manager, its state
// will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and
// DELETE_IN_PROGRESS. See `lifecycleState` definition in [API
// Reference](https://cloud.google.com/resource-manager/reference/rest/v1/projects).
@@ -500,15 +503,15 @@ message ResourceSearchResult {
// vary from one resource type to another. Examples: `projectId` for Project,
// `dnsName` for DNS ManagedZone. This field contains a subset of the resource
// metadata fields that are returned by the List or Get APIs provided by the
- // corresponding GCP service (e.g., Compute Engine). see [API references and
- // supported searchable
+ // corresponding Google Cloud service (e.g., Compute Engine). see [API
+ // references and supported searchable
// attributes](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types)
// to see which fields are included.
//
// You can search values of these fields through free text search. However,
// you should not consume the field programically as the field names and
- // values may change as the GCP service updates to a new incompatible API
- // version.
+ // values may change as the Google Cloud service updates to a new incompatible
+ // API version.
//
// To search against the `additional_attributes`:
//
@@ -700,11 +703,11 @@ message IamPolicySearchResult {
// * specify the `asset_types` field in your search request.
string asset_type = 5;
- // The project that the associated GCP resource belongs to, in the form of
- // projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM
- // instance, Cloud Storage bucket), the project field will indicate the
- // project that contains the resource. If an IAM policy is set on a folder or
- // orgnization, this field will be empty.
+ // The project that the associated Google Cloud resource belongs to, in the
+ // form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource
+ // (like VM instance, Cloud Storage bucket), the project field will indicate
+ // the project that contains the resource. If an IAM policy is set on a folder
+ // or orgnization, this field will be empty.
//
// To search against the `project`:
//
@@ -876,8 +879,10 @@ message IamPolicyAnalysisResult {
repeated Access accesses = 2;
// Resource edges of the graph starting from the policy attached
- // resource to any descendant resources. The [Edge.source_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.source_node] contains
- // the full resource name of a parent resource and [Edge.target_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.target_node]
+ // resource to any descendant resources. The
+ // [Edge.source_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.source_node]
+ // contains the full resource name of a parent resource and
+ // [Edge.target_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.target_node]
// contains the full resource name of a child resource. This field is
// present only if the output_resource_edges option is enabled in request.
repeated Edge resource_edges = 3;
@@ -896,32 +901,41 @@ message IamPolicyAnalysisResult {
repeated Identity identities = 1;
// Group identity edges of the graph starting from the binding's
- // group members to any node of the [identities][google.cloud.asset.v1.IamPolicyAnalysisResult.IdentityList.identities]. The [Edge.source_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.source_node]
+ // group members to any node of the
+ // [identities][google.cloud.asset.v1.IamPolicyAnalysisResult.IdentityList.identities].
+ // The
+ // [Edge.source_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.source_node]
// contains a group, such as `group:parent@google.com`. The
- // [Edge.target_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.target_node] contains a member of the group,
- // such as `group:child@google.com` or `user:foo@google.com`.
- // This field is present only if the output_group_edges option is enabled in
- // request.
+ // [Edge.target_node][google.cloud.asset.v1.IamPolicyAnalysisResult.Edge.target_node]
+ // contains a member of the group, such as `group:child@google.com` or
+ // `user:foo@google.com`. This field is present only if the
+ // output_group_edges option is enabled in request.
repeated Edge group_edges = 2;
}
// The [full resource
// name](https://cloud.google.com/asset-inventory/docs/resource-name-format)
- // of the resource to which the [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding] policy attaches.
+ // of the resource to which the
+ // [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding]
+ // policy attaches.
string attached_resource_full_name = 1;
- // The Cloud IAM policy binding under analysis.
+ // The IAM policy binding under analysis.
google.iam.v1.Binding iam_binding = 2;
- // The access control lists derived from the [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding] that match or
- // potentially match resource and access selectors specified in the request.
+ // The access control lists derived from the
+ // [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding]
+ // that match or potentially match resource and access selectors specified in
+ // the request.
repeated AccessControlList access_control_lists = 3;
- // The identity list derived from members of the [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding] that match or
- // potentially match identity selector specified in the request.
+ // The identity list derived from members of the
+ // [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding]
+ // that match or potentially match identity selector specified in the request.
IdentityList identity_list = 4;
- // Represents whether all analyses on the [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding] have successfully
- // finished.
+ // Represents whether all analyses on the
+ // [iam_binding][google.cloud.asset.v1.IamPolicyAnalysisResult.iam_binding]
+ // have successfully finished.
bool fully_explored = 5;
}
diff --git a/third_party/googleapis/google/cloud/asset/v1/cloudasset_v1.yaml b/third_party/googleapis/google/cloud/asset/v1/cloudasset_v1.yaml
index 338af62a0..0ffb3c8d3 100644
--- a/third_party/googleapis/google/cloud/asset/v1/cloudasset_v1.yaml
+++ b/third_party/googleapis/google/cloud/asset/v1/cloudasset_v1.yaml
@@ -12,14 +12,16 @@ types:
- name: google.cloud.asset.v1.AnalyzeIamPolicyLongrunningResponse
documentation:
- summary: The cloud asset API manages the history and inventory of cloud resources.
+ summary: |-
+ The Cloud Asset API manages the history and inventory of Google Cloud
+ resources.
overview: |-
# Cloud Asset API
- The Cloud Asset API keeps a history of Google Cloud Platform (GCP) asset
- metadata, and allows GCP users to download a dump of all asset metadata
- for the resource types listed below within an organization or a project at
- a given timestamp.
+ The Cloud Asset API keeps a history of Google Cloud asset metadata, and
+ allows Google Cloud users to download a dump of all asset metadata for the
+ resource types listed below within an organization or a project at a given
+ timestamp.
Read more documents here:
https://cloud.google.com/asset-inventory/docs
diff --git a/third_party/googleapis/google/cloud/asset/v1p1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/asset/v1p1beta1/BUILD.bazel
index f8abfd014..55a3a70e8 100644
--- a/third_party/googleapis/google/cloud/asset/v1p1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/asset/v1p1beta1/BUILD.bazel
@@ -106,7 +106,7 @@ load(
go_proto_library(
name = "asset_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/asset/v1p1beta1",
+ importpath = "cloud.google.com/go/asset/apiv1p1beta1/assetpb",
protos = [":asset_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -119,6 +119,7 @@ go_gapic_library(
srcs = [":asset_proto_with_info"],
grpc_service_config = "cloudasset_grpc_service_config.json",
importpath = "cloud.google.com/go/asset/apiv1p1beta1;asset",
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "cloudasset_v1p1beta1.yaml",
transport = "grpc+rest",
@@ -160,7 +161,8 @@ py_gapic_library(
srcs = [":asset_proto"],
grpc_service_config = "cloudasset_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "cloudasset_v1p1beta1.yaml",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -210,6 +212,7 @@ php_gapic_library(
srcs = [":asset_proto_with_info"],
grpc_service_config = "cloudasset_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "cloudasset_v1p1beta1.yaml",
transport = "grpc+rest",
deps = [
":asset_php_grpc",
@@ -284,6 +287,7 @@ ruby_cloud_gapic_library(
srcs = [":asset_proto_with_info"],
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-asset-v1p1beta1"],
rest_numeric_enums = True,
+ service_yaml = "cloudasset_v1p1beta1.yaml",
deps = [
":asset_ruby_grpc",
":asset_ruby_proto",
@@ -329,6 +333,7 @@ csharp_gapic_library(
grpc_service_config = "cloudasset_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "cloudasset_v1p1beta1.yaml",
+ transport = "grpc+rest",
deps = [
":asset_csharp_grpc",
":asset_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/asset/v1p1beta1/asset_service.proto b/third_party/googleapis/google/cloud/asset/v1p1beta1/asset_service.proto
index d5a0d8c41..e3b256f88 100644
--- a/third_party/googleapis/google/cloud/asset/v1p1beta1/asset_service.proto
+++ b/third_party/googleapis/google/cloud/asset/v1p1beta1/asset_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -22,7 +22,7 @@ import "google/api/field_behavior.proto";
import "google/cloud/asset/v1p1beta1/assets.proto";
option csharp_namespace = "Google.Cloud.Asset.V1P1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/asset/v1p1beta1;asset";
+option go_package = "cloud.google.com/go/asset/apiv1p1beta1/assetpb;assetpb";
option java_multiple_files = true;
option java_outer_classname = "AssetServiceProto";
option java_package = "com.google.cloud.asset.v1p1beta1";
@@ -31,28 +31,31 @@ option php_namespace = "Google\\Cloud\\Asset\\V1p1beta1";
// Asset service definition.
service AssetService {
option (google.api.default_host) = "cloudasset.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
-
- // Searches all the resources under a given accessible CRM scope
- // (project/folder/organization). This RPC gives callers
- // especially admins the ability to search all the resources under a scope,
- // even if they don't have .get permission of all the resources. Callers
- // should have cloud.assets.SearchAllResources permission on the requested
- // scope, otherwise it will be rejected.
- rpc SearchAllResources(SearchAllResourcesRequest) returns (SearchAllResourcesResponse) {
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
+
+ // Searches all the resources within a given accessible Resource Manager scope
+ // (project/folder/organization). This RPC gives callers especially
+ // administrators the ability to search all the resources within a scope, even
+ // if they don't have `.get` permission of all the resources. Callers should
+ // have `cloud.assets.SearchAllResources` permission on the requested scope,
+ // otherwise the request will be rejected.
+ rpc SearchAllResources(SearchAllResourcesRequest)
+ returns (SearchAllResourcesResponse) {
option (google.api.http) = {
get: "/v1p1beta1/{scope=*/*}/resources:searchAll"
};
option (google.api.method_signature) = "scope,query,asset_types";
}
- // Searches all the IAM policies under a given accessible CRM scope
- // (project/folder/organization). This RPC gives callers
- // especially admins the ability to search all the IAM policies under a scope,
- // even if they don't have .getIamPolicy permission of all the IAM policies.
- // Callers should have cloud.assets.SearchAllIamPolicies permission on the
- // requested scope, otherwise it will be rejected.
- rpc SearchAllIamPolicies(SearchAllIamPoliciesRequest) returns (SearchAllIamPoliciesResponse) {
+ // Searches all the IAM policies within a given accessible Resource Manager
+ // scope (project/folder/organization). This RPC gives callers especially
+ // administrators the ability to search all the IAM policies within a scope,
+ // even if they don't have `.getIamPolicy` permission of all the IAM policies.
+ // Callers should have `cloud.assets.SearchAllIamPolicies` permission on the
+ // requested scope, otherwise the request will be rejected.
+ rpc SearchAllIamPolicies(SearchAllIamPoliciesRequest)
+ returns (SearchAllIamPoliciesResponse) {
option (google.api.http) = {
get: "/v1p1beta1/{scope=*/*}/iamPolicies:searchAll"
};
@@ -62,37 +65,39 @@ service AssetService {
// Search all resources request.
message SearchAllResourcesRequest {
- // Required. The relative name of an asset. The search is limited to the resources
- // within the `scope`. The allowed value must be:
+ // Required. The relative name of an asset. The search is limited to the
+ // resources within the `scope`. The allowed value must be:
+ //
// * Organization number (such as "organizations/123")
- // * Folder number(such as "folders/1234")
+ // * Folder number (such as "folders/1234")
// * Project number (such as "projects/12345")
- // * Project id (such as "projects/abc")
+ // * Project ID (such as "projects/abc")
string scope = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. The query statement.
string query = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. A list of asset types that this request searches for. If empty, it will
- // search all the supported asset types.
+ // Optional. A list of asset types that this request searches for. If empty,
+ // it will search all the supported asset types.
repeated string asset_types = 3 [(google.api.field_behavior) = OPTIONAL];
- // Optional. The page size for search result pagination. Page size is capped at 500 even
- // if a larger value is given. If set to zero, server will pick an appropriate
- // default. Returned results may be fewer than requested. When this happens,
- // there could be more results as long as `next_page_token` is returned.
+ // Optional. The page size for search result pagination. Page size is capped
+ // at 500 even if a larger value is given. If set to zero, server will pick an
+ // appropriate default. Returned results may be fewer than requested. When
+ // this happens, there could be more results as long as `next_page_token` is
+ // returned.
int32 page_size = 4 [(google.api.field_behavior) = OPTIONAL];
- // Optional. If present, then retrieve the next batch of results from the preceding call
- // to this method. `page_token` must be the value of `next_page_token` from
- // the previous response. The values of all other method parameters, must be
- // identical to those in the previous call.
+ // Optional. If present, then retrieve the next batch of results from the
+ // preceding call to this method. `page_token` must be the value of
+ // `next_page_token` from the previous response. The values of all other
+ // method parameters, must be identical to those in the previous call.
string page_token = 5 [(google.api.field_behavior) = OPTIONAL];
- // Optional. A comma separated list of fields specifying the sorting order of the
- // results. The default order is ascending. Add " desc" after the field name
- // to indicate descending order. Redundant space characters are ignored. For
- // example, " foo , bar desc ".
+ // Optional. A comma separated list of fields specifying the sorting order of
+ // the results. The default order is ascending. Add ` DESC` after the field
+ // name to indicate descending order. Redundant space characters are ignored.
+ // For example, ` location DESC , name `.
string order_by = 10 [(google.api.field_behavior) = OPTIONAL];
}
@@ -109,37 +114,39 @@ message SearchAllResourcesResponse {
// Search all IAM policies request.
message SearchAllIamPoliciesRequest {
- // Required. The relative name of an asset. The search is limited to the resources
- // within the `scope`. The allowed value must be:
+ // Required. The relative name of an asset. The search is limited to the
+ // resources within the `scope`. The allowed value must be:
+ //
// * Organization number (such as "organizations/123")
- // * Folder number(such as "folders/1234")
+ // * Folder number (such as "folders/1234")
// * Project number (such as "projects/12345")
- // * Project id (such as "projects/abc")
+ // * Project ID (such as "projects/abc")
string scope = 1 [(google.api.field_behavior) = REQUIRED];
- // Optional. The query statement.
- // Examples:
+ // Optional. The query statement. Examples:
+ //
// * "policy:myuser@mydomain.com"
// * "policy:(myuser@mydomain.com viewer)"
string query = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. The page size for search result pagination. Page size is capped at 500 even
- // if a larger value is given. If set to zero, server will pick an appropriate
- // default. Returned results may be fewer than requested. When this happens,
- // there could be more results as long as `next_page_token` is returned.
+ // Optional. The page size for search result pagination. Page size is capped
+ // at 500 even if a larger value is given. If set to zero, server will pick an
+ // appropriate default. Returned results may be fewer than requested. When
+ // this happens, there could be more results as long as `next_page_token` is
+ // returned.
int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
- // Optional. If present, retrieve the next batch of results from the preceding call to
- // this method. `page_token` must be the value of `next_page_token` from the
- // previous response. The values of all other method parameters must be
- // identical to those in the previous call.
+ // Optional. If present, retrieve the next batch of results from the preceding
+ // call to this method. `page_token` must be the value of `next_page_token`
+ // from the previous response. The values of all other method parameters must
+ // be identical to those in the previous call.
string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Search all IAM policies response.
message SearchAllIamPoliciesResponse {
- // A list of IamPolicy that match the search query. Related information such
- // as the associated resource is returned along with the policy.
+ // A list of IAM policies that match the search query. Related information
+ // such as the associated resource is returned along with the policy.
repeated IamPolicySearchResult results = 1;
// Set if there are more results than those appearing in this response; to get
diff --git a/third_party/googleapis/google/cloud/asset/v1p1beta1/assets.proto b/third_party/googleapis/google/cloud/asset/v1p1beta1/assets.proto
index c0ac1403a..b10008930 100644
--- a/third_party/googleapis/google/cloud/asset/v1p1beta1/assets.proto
+++ b/third_party/googleapis/google/cloud/asset/v1p1beta1/assets.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@ import "google/iam/v1/policy.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Asset.V1P1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/asset/v1p1beta1;asset";
+option go_package = "cloud.google.com/go/asset/apiv1p1beta1/assetpb;assetpb";
option java_multiple_files = true;
option java_outer_classname = "AssetProto";
option java_package = "com.google.cloud.asset.v1p1beta1";
@@ -59,55 +59,59 @@ message StandardResourceMetadata {
// "us-west1-b".
string location = 11;
- // Labels associated with this resource. See [Labelling and grouping GCP
+ // Labels associated with this resource. See [Labelling and grouping Google
+ // Cloud
// resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources)
// for more information.
map labels = 12;
// Network tags associated with this resource. Like labels, network tags are a
- // type of annotations used to group GCP resources. See [Labelling GCP
+ // type of annotations used to group Google Cloud resources. See [Labelling
+ // Google Cloud
// resources](lhttps://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources)
// for more information.
repeated string network_tags = 13;
}
-// The result for a IAM Policy search.
+// The result for an IAM policy search.
message IamPolicySearchResult {
// Explanation about the IAM policy search result.
message Explanation {
// The map from roles to their included permission matching the permission
- // query (e.g. containing `policy.role.permissions:`). A sample role string:
+ // query (e.g. containing `policy.role.permissions:`). Example role string:
// "roles/compute.instanceAdmin". The roles can also be found in the
// returned `policy` bindings. Note that the map is populated only if
// requesting with a permission query.
map matched_permissions = 1;
}
- // The [full resource
+ // The
+ // [full resource
// name](https://cloud.google.com/apis/design/resource_names#full_resource_name)
// of the resource associated with this IAM policy.
string resource = 1;
- // The project that the associated GCP resource belongs to, in the form of
- // `projects/{project_number}`. If an IAM policy is set on a resource (like VM
- // instance, Cloud Storage bucket), the project field will indicate the
- // project that contains the resource. If an IAM policy is set on a folder or
- // orgnization, the project field will be empty.
+ // The project that the associated Google Cloud resource belongs to, in the
+ // form of `projects/{project_number}`. If an IAM policy is set on a resource
+ // -- such as a Compute Engine instance or a Cloud Storage bucket -- the
+ // project field will indicate the project that contains the resource. If an
+ // IAM policy is set on a folder or orgnization, the project field will be
+ // empty.
string project = 3;
- // The IAM policy directly set on the given resource. Note that the original
+ // The IAM policy attached to the specified resource. Note that the original
// IAM policy can contain multiple bindings. This only contains the bindings
- // that match the given query. For queries that don't contain a constrain on
+ // that match the given query. For queries that don't contain a constraint on
// policies (e.g. an empty query), this contains all the bindings.
google.iam.v1.Policy policy = 4;
// Explanation about the IAM policy search result. It contains additional
- // information to explain why the search result matches the query.
+ // information that explains why the search result matches the query.
Explanation explanation = 5;
}
-// IAM permissions
+// IAM permissions.
message Permissions {
- // A list of permissions. A sample permission string: "compute.disk.get".
+ // A list of permissions. Example permission string: "compute.disk.get".
repeated string permissions = 1;
}
diff --git a/third_party/googleapis/google/cloud/asset/v1p1beta1/cloudasset_v1p1beta1.yaml b/third_party/googleapis/google/cloud/asset/v1p1beta1/cloudasset_v1p1beta1.yaml
index 74aad50aa..96c1be248 100644
--- a/third_party/googleapis/google/cloud/asset/v1p1beta1/cloudasset_v1p1beta1.yaml
+++ b/third_party/googleapis/google/cloud/asset/v1p1beta1/cloudasset_v1p1beta1.yaml
@@ -5,16 +5,19 @@ title: Cloud Asset API
apis:
- name: google.cloud.asset.v1p1beta1.AssetService
+- name: google.longrunning.Operations
documentation:
- summary: The cloud asset API manages the history and inventory of cloud resources.
+ summary: |-
+ The Cloud Asset API manages the history and inventory of Google Cloud
+ resources.
overview: |-
# Cloud Asset API
- The Cloud Asset API keeps a history of Google Cloud Platform (GCP) asset
- metadata, and allows GCP users to download a dump of all asset metadata
- for the resource types listed below within an organization or a project at
- a given timestamp.
+ The Cloud Asset API keeps a history of Google Cloud asset metadata, and
+ allows Google Cloud users to download a dump of all asset metadata for the
+ resource types listed below within an organization or a project at a given
+ timestamp.
Read more documents here:
https://cloud.google.com/asset-inventory/docs
diff --git a/third_party/googleapis/google/cloud/asset/v1p2beta1/BUILD.bazel b/third_party/googleapis/google/cloud/asset/v1p2beta1/BUILD.bazel
index 6b222428a..6cb65974d 100644
--- a/third_party/googleapis/google/cloud/asset/v1p2beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/asset/v1p2beta1/BUILD.bazel
@@ -113,7 +113,7 @@ load(
go_proto_library(
name = "asset_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1",
+ importpath = "cloud.google.com/go/asset/apiv1p2beta1/assetpb",
protos = [":asset_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -127,6 +127,7 @@ go_gapic_library(
srcs = [":asset_proto_with_info"],
grpc_service_config = "cloudasset_grpc_service_config.json",
importpath = "cloud.google.com/go/asset/apiv1p2beta1;asset",
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "cloudasset_v1p2beta1.yaml",
transport = "grpc+rest",
@@ -173,7 +174,8 @@ py_gapic_library(
srcs = [":asset_proto"],
grpc_service_config = "cloudasset_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "cloudasset_v1p2beta1.yaml",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -223,6 +225,7 @@ php_gapic_library(
srcs = [":asset_proto_with_info"],
grpc_service_config = "cloudasset_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "cloudasset_v1p2beta1.yaml",
transport = "grpc+rest",
deps = [
":asset_php_grpc",
@@ -297,6 +300,7 @@ ruby_cloud_gapic_library(
srcs = [":asset_proto_with_info"],
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-asset-v1p2beta1"],
rest_numeric_enums = True,
+ service_yaml = "cloudasset_v1p2beta1.yaml",
deps = [
":asset_ruby_grpc",
":asset_ruby_proto",
@@ -341,6 +345,7 @@ csharp_grpc_library(
# srcs = [":asset_proto_with_info"],
# grpc_service_config = "cloudasset_grpc_service_config.json",
# common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
+# service_yaml = "cloudasset_v1p2beta1.yaml",
# deps = [
# ":asset_csharp_grpc",
# ":asset_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/asset/v1p2beta1/asset_service.proto b/third_party/googleapis/google/cloud/asset/v1p2beta1/asset_service.proto
index 92f285f86..025af8062 100644
--- a/third_party/googleapis/google/cloud/asset/v1p2beta1/asset_service.proto
+++ b/third_party/googleapis/google/cloud/asset/v1p2beta1/asset_service.proto
@@ -26,7 +26,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.Asset.V1p2Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1;asset";
+option go_package = "cloud.google.com/go/asset/apiv1p2beta1/assetpb;assetpb";
option java_multiple_files = true;
option java_outer_classname = "AssetServiceProto";
option java_package = "com.google.cloud.asset.v1p2beta1";
diff --git a/third_party/googleapis/google/cloud/asset/v1p2beta1/assets.proto b/third_party/googleapis/google/cloud/asset/v1p2beta1/assets.proto
index bc2a9c511..abeb14569 100644
--- a/third_party/googleapis/google/cloud/asset/v1p2beta1/assets.proto
+++ b/third_party/googleapis/google/cloud/asset/v1p2beta1/assets.proto
@@ -23,7 +23,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Asset.v1p2beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/asset/v1p2beta1;asset";
+option go_package = "cloud.google.com/go/asset/apiv1p2beta1/assetpb;assetpb";
option java_multiple_files = true;
option java_outer_classname = "AssetProto";
option java_package = "com.google.cloud.asset.v1p2beta1";
diff --git a/third_party/googleapis/google/cloud/asset/v1p2beta1/cloudasset_grpc_service_config.json b/third_party/googleapis/google/cloud/asset/v1p2beta1/cloudasset_grpc_service_config.json
index 7e7147099..579478922 100755
--- a/third_party/googleapis/google/cloud/asset/v1p2beta1/cloudasset_grpc_service_config.json
+++ b/third_party/googleapis/google/cloud/asset/v1p2beta1/cloudasset_grpc_service_config.json
@@ -2,6 +2,10 @@
"methodConfig": [
{
"name": [
+ {
+ "service": "google.cloud.asset.v1p2beta1.AssetService",
+ "method": "ExportAssets"
+ },
{
"service": "google.cloud.asset.v1p2beta1.AssetService",
"method": "CreateFeed"
@@ -15,6 +19,10 @@
},
{
"name": [
+ {
+ "service": "google.cloud.asset.v1p2beta1.AssetService",
+ "method": "BatchGetAssetsHistory"
+ },
{
"service": "google.cloud.asset.v1p2beta1.AssetService",
"method": "GetFeed"
diff --git a/third_party/googleapis/google/cloud/asset/v1p5beta1/BUILD.bazel b/third_party/googleapis/google/cloud/asset/v1p5beta1/BUILD.bazel
index da53417e4..3f79aa9ae 100644
--- a/third_party/googleapis/google/cloud/asset/v1p5beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/asset/v1p5beta1/BUILD.bazel
@@ -112,7 +112,7 @@ load(
go_proto_library(
name = "asset_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/asset/v1p5beta1",
+ importpath = "cloud.google.com/go/asset/apiv1p5beta1/assetpb",
protos = [":asset_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -127,6 +127,7 @@ go_gapic_library(
srcs = [":asset_proto_with_info"],
grpc_service_config = "cloudasset_grpc_service_config.json",
importpath = "cloud.google.com/go/asset/apiv1p5beta1;asset",
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "cloudasset_v1p5beta1.yaml",
transport = "grpc+rest",
@@ -168,7 +169,8 @@ py_gapic_library(
srcs = [":asset_proto"],
grpc_service_config = "cloudasset_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "cloudasset_v1p5beta1.yaml",
+ transport = "grpc+rest",
deps = [
"//google/cloud/orgpolicy/v1:orgpolicy_py_original_proto",
"//google/iam/v1:iam_policy_py_proto",
@@ -222,6 +224,7 @@ php_gapic_library(
name = "asset_php_gapic",
srcs = [":asset_proto_with_info"],
rest_numeric_enums = True,
+ service_yaml = "cloudasset_v1p5beta1.yaml",
transport = "grpc+rest",
deps = [
":asset_php_grpc",
@@ -295,6 +298,7 @@ ruby_cloud_gapic_library(
srcs = [":asset_proto_with_info"],
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-asset-v1p5beta1"],
rest_numeric_enums = True,
+ service_yaml = "cloudasset_v1p5beta1.yaml",
deps = [
":asset_ruby_grpc",
":asset_ruby_proto",
@@ -339,6 +343,7 @@ csharp_grpc_library(
# srcs = [":asset_proto_with_info"],
# grpc_service_config = "cloudasset_grpc_service_config.json",
# common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
+# service_yaml = "cloudasset_v1p5beta1.yaml",
# deps = [
# ":asset_csharp_grpc",
# ":asset_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/asset/v1p5beta1/asset_service.proto b/third_party/googleapis/google/cloud/asset/v1p5beta1/asset_service.proto
index 52233ad05..86bf48920 100644
--- a/third_party/googleapis/google/cloud/asset/v1p5beta1/asset_service.proto
+++ b/third_party/googleapis/google/cloud/asset/v1p5beta1/asset_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -19,11 +19,12 @@ package google.cloud.asset.v1p5beta1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
import "google/cloud/asset/v1p5beta1/assets.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Asset.V1P5Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/asset/v1p5beta1;asset";
+option go_package = "cloud.google.com/go/asset/apiv1p5beta1/assetpb;assetpb";
option java_multiple_files = true;
option java_outer_classname = "AssetServiceProto";
option java_package = "com.google.cloud.asset.v1p5beta1";
@@ -41,6 +42,7 @@ service AssetService {
option (google.api.http) = {
get: "/v1p5beta1/{parent=*/*}/assets"
};
+ option (google.api.method_signature) = "parent";
}
}
@@ -48,21 +50,39 @@ service AssetService {
message ListAssetsRequest {
// Required. Name of the organization or project the assets belong to. Format:
// "organizations/[organization-number]" (such as "organizations/123"),
- // "projects/[project-number]" (such as "projects/my-project-id"), or
- // "projects/[project-id]" (such as "projects/12345").
- string parent = 1 [(google.api.field_behavior) = REQUIRED];
+ // "projects/[project-id]" (such as "projects/my-project-id"), or
+ // "projects/[project-number]" (such as "projects/12345").
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "cloudasset.googleapis.com/Asset"
+ }
+ ];
// Timestamp to take an asset snapshot. This can only be set to a timestamp
- // between 2018-10-02 UTC (inclusive) and the current time. If not specified,
- // the current time will be used. Due to delays in resource data collection
- // and indexing, there is a volatile window during which running the same
- // query may get different results.
+ // between the current time and the current time minus 35 days (inclusive).
+ // If not specified, the current time will be used. Due to delays in resource
+ // data collection and indexing, there is a volatile window during which
+ // running the same query may get different results.
google.protobuf.Timestamp read_time = 2;
- // A list of asset types of which to take a snapshot for. For example:
- // "compute.googleapis.com/Disk". If specified, only matching assets will be
- // returned. See [Introduction to Cloud Asset
- // Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)
+ // A list of asset types to take a snapshot for. For example:
+ // "compute.googleapis.com/Disk".
+ //
+ // Regular expression is also supported. For example:
+ //
+ // * "compute.googleapis.com.*" snapshots resources whose asset type starts
+ // with "compute.googleapis.com".
+ // * ".*Instance" snapshots resources whose asset type ends with "Instance".
+ // * ".*Instance.*" snapshots resources whose asset type contains "Instance".
+ //
+ // See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported
+ // regular expression syntax. If the regular expression does not match any
+ // supported asset type, an INVALID_ARGUMENT error will be returned.
+ //
+ // If specified, only matching assets will be returned, otherwise, it will
+ // snapshot all asset types. See [Introduction to Cloud Asset
+ // Inventory](https://cloud.google.com/asset-inventory/docs/overview)
// for all supported asset types.
repeated string asset_types = 3;
@@ -80,6 +100,20 @@ message ListAssetsRequest {
string page_token = 6;
}
+// ListAssets response.
+message ListAssetsResponse {
+ // Time the snapshot was taken.
+ google.protobuf.Timestamp read_time = 1;
+
+ // Assets.
+ repeated Asset assets = 2;
+
+ // Token to retrieve the next page of results. It expires 72 hours after the
+ // page token for the first page is generated. Set to empty if there are no
+ // remaining results.
+ string next_page_token = 3;
+}
+
// Asset content type.
enum ContentType {
// Unspecified content type.
@@ -91,22 +125,9 @@ enum ContentType {
// The actual IAM policy set on a resource.
IAM_POLICY = 2;
- // The Cloud Organization Policy set on an asset.
+ // The organization policy set on an asset.
ORG_POLICY = 4;
- // The Cloud Access context mananger Policy set on an asset.
+ // The Access Context Manager policy set on an asset.
ACCESS_POLICY = 5;
}
-
-// ListAssets response.
-message ListAssetsResponse {
- // Time the snapshot was taken.
- google.protobuf.Timestamp read_time = 1;
-
- // Assets.
- repeated Asset assets = 2;
-
- // Token to retrieve the next page of results. Set to empty if there are no
- // remaining results.
- string next_page_token = 3;
-}
diff --git a/third_party/googleapis/google/cloud/asset/v1p5beta1/assets.proto b/third_party/googleapis/google/cloud/asset/v1p5beta1/assets.proto
index 7ad133a54..b277e3083 100644
--- a/third_party/googleapis/google/cloud/asset/v1p5beta1/assets.proto
+++ b/third_party/googleapis/google/cloud/asset/v1p5beta1/assets.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -26,83 +26,114 @@ import "google/protobuf/struct.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Asset.V1p5Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/asset/v1p5beta1;asset";
+option go_package = "cloud.google.com/go/asset/apiv1p5beta1/assetpb;assetpb";
option java_multiple_files = true;
option java_outer_classname = "AssetProto";
option java_package = "com.google.cloud.asset.v1p5beta1";
option php_namespace = "Google\\Cloud\\Asset\\V1p5beta1";
-// Cloud asset. This includes all Google Cloud Platform resources,
-// Cloud IAM policies, and other non-GCP assets.
+// An asset in Google Cloud. An asset can be any resource in the Google Cloud
+// [resource
+// hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy),
+// a resource outside the Google Cloud resource hierarchy (such as Google
+// Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy).
+// See [Supported asset
+// types](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
+// for more information.
message Asset {
option (google.api.resource) = {
type: "cloudasset.googleapis.com/Asset"
pattern: "*"
};
- // The full name of the asset. For example:
- // `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
+ // The full name of the asset. Example:
+ // `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`
+ //
// See [Resource
- // Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
+ // names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
// for more information.
string name = 1;
- // Type of the asset. Example: "compute.googleapis.com/Disk".
+ // The type of the asset. Example: `compute.googleapis.com/Disk`
+ //
+ // See [Supported asset
+ // types](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
+ // for more information.
string asset_type = 2;
- // Representation of the resource.
+ // A representation of the resource.
Resource resource = 3;
- // Representation of the actual Cloud IAM policy set on a cloud resource. For
- // each resource, there must be at most one Cloud IAM policy set on it.
+ // A representation of the IAM policy set on a Google Cloud resource.
+ // There can be a maximum of one IAM policy set on any given resource.
+ // In addition, IAM policies inherit their granted access scope from any
+ // policies set on parent resources in the resource hierarchy. Therefore, the
+ // effectively policy is the union of both the policy set on this resource
+ // and each policy set on all of the resource's ancestry resource levels in
+ // the hierarchy. See
+ // [this topic](https://cloud.google.com/iam/help/allow-policies/inheritance)
+ // for more information.
google.iam.v1.Policy iam_policy = 4;
- // Representation of the Cloud Organization Policy set on an asset. For each
- // asset, there could be multiple Organization policies with different
- // constraints.
+ // A representation of an [organization
+ // policy](https://cloud.google.com/resource-manager/docs/organization-policy/overview#organization_policy).
+ // There can be more than one organization policy with different constraints
+ // set on a given resource.
repeated google.cloud.orgpolicy.v1.Policy org_policy = 6;
- // Representation of the Cloud Organization access policy.
+ // A representation of an [access
+ // policy](https://cloud.google.com/access-context-manager/docs/overview#access-policies).
oneof access_context_policy {
+ // Please also refer to the [access policy user
+ // guide](https://cloud.google.com/access-context-manager/docs/overview#access-policies).
google.identity.accesscontextmanager.v1.AccessPolicy access_policy = 7;
+ // Please also refer to the [access level user
+ // guide](https://cloud.google.com/access-context-manager/docs/overview#access-levels).
google.identity.accesscontextmanager.v1.AccessLevel access_level = 8;
+ // Please also refer to the [service perimeter user
+ // guide](https://cloud.google.com/vpc-service-controls/docs/overview).
google.identity.accesscontextmanager.v1.ServicePerimeter service_perimeter =
9;
}
- // Asset's ancestry path in Cloud Resource Manager (CRM) hierarchy,
- // represented as a list of relative resource names. Ancestry path starts with
- // the closest CRM ancestor and ends at root. If the asset is a CRM
- // project/folder/organization, this starts from the asset itself.
+ // The ancestry path of an asset in Google Cloud [resource
+ // hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy),
+ // represented as a list of relative resource names. An ancestry path starts
+ // with the closest ancestor in the hierarchy and ends at root. If the asset
+ // is a project, folder, or organization, the ancestry path starts from the
+ // asset itself.
//
- // Example: ["projects/123456789", "folders/5432", "organizations/1234"]
+ // Example: `["projects/123456789", "folders/5432", "organizations/1234"]`
repeated string ancestors = 10;
}
-// Representation of a cloud resource.
+// A representation of a Google Cloud resource.
message Resource {
// The API version. Example: "v1".
string version = 1;
// The URL of the discovery document containing the resource's JSON schema.
- // For example:
- // `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`.
- // It will be left unspecified for resources without a discovery-based API,
- // such as Cloud Bigtable.
+ // Example:
+ // `https://www.googleapis.com/discovery/v1/apis/compute/v1/rest`
+ //
+ // This value is unspecified for resources that do not have an API based on a
+ // discovery document, such as Cloud Bigtable.
string discovery_document_uri = 2;
- // The JSON schema name listed in the discovery document.
- // Example: "Project". It will be left unspecified for resources (such as
- // Cloud Bigtable) without a discovery-based API.
+ // The JSON schema name listed in the discovery document. Example:
+ // `Project`
+ //
+ // This value is unspecified for resources that do not have an API based on a
+ // discovery document, such as Cloud Bigtable.
string discovery_name = 3;
- // The REST URL for accessing the resource. An HTTP GET operation using this
- // URL returns the resource itself.
- // Example:
- // `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`.
- // It will be left unspecified for resources without a REST API.
+ // The REST URL for accessing the resource. An HTTP `GET` request using this
+ // URL returns the resource itself. Example:
+ // `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`
+ //
+ // This value is unspecified for resources without a REST API.
string resource_url = 4;
// The full name of the immediate parent of this resource. See
@@ -110,15 +141,16 @@ message Resource {
// Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
// for more information.
//
- // For GCP assets, it is the parent resource defined in the [Cloud IAM policy
+ // For Google Cloud assets, this value is the parent resource defined in the
+ // [IAM policy
// hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).
- // For example:
- // `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`.
+ // Example:
+ // `//cloudresourcemanager.googleapis.com/projects/my_project_123`
//
- // For third-party assets, it is up to the users to define.
+ // For third-party assets, this field may be set differently.
string parent = 5;
- // The content of the resource, in which some sensitive fields are scrubbed
- // away and may not be present.
+ // The content of the resource, in which some sensitive fields are removed
+ // and may not be present.
google.protobuf.Struct data = 6;
}
diff --git a/third_party/googleapis/google/cloud/asset/v1p5beta1/cloudasset_v1p5beta1.yaml b/third_party/googleapis/google/cloud/asset/v1p5beta1/cloudasset_v1p5beta1.yaml
index 07dbadacd..3d9a00735 100644
--- a/third_party/googleapis/google/cloud/asset/v1p5beta1/cloudasset_v1p5beta1.yaml
+++ b/third_party/googleapis/google/cloud/asset/v1p5beta1/cloudasset_v1p5beta1.yaml
@@ -5,16 +5,19 @@ title: Cloud Asset API
apis:
- name: google.cloud.asset.v1p5beta1.AssetService
+- name: google.longrunning.Operations
documentation:
- summary: The cloud asset API manages the history and inventory of cloud resources.
+ summary: |-
+ The Cloud Asset API manages the history and inventory of Google Cloud
+ resources.
overview: |-
# Cloud Asset API
- The Cloud Asset API keeps a history of Google Cloud Platform (GCP) asset
- metadata, and allows GCP users to download a dump of all asset metadata
- for the resource types listed below within an organization or a project at
- a given timestamp.
+ The Cloud Asset API keeps a history of Google Cloud asset metadata, and
+ allows Google Cloud users to download a dump of all asset metadata for the
+ resource types listed below within an organization or a project at a given
+ timestamp.
Read more documents here:
https://cloud.google.com/asset-inventory/docs
@@ -23,6 +26,8 @@ backend:
rules:
- selector: google.cloud.asset.v1p5beta1.AssetService.ListAssets
deadline: 600.0
+ - selector: google.longrunning.Operations.GetOperation
+ deadline: 60.0
authentication:
rules:
@@ -30,3 +35,7 @@ authentication:
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
+ - selector: google.longrunning.Operations.GetOperation
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
diff --git a/third_party/googleapis/google/cloud/asset/v1p7beta1/BUILD.bazel b/third_party/googleapis/google/cloud/asset/v1p7beta1/BUILD.bazel
index d302d1966..19a60b361 100644
--- a/third_party/googleapis/google/cloud/asset/v1p7beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/asset/v1p7beta1/BUILD.bazel
@@ -127,7 +127,7 @@ java_gapic_assembly_gradle_pkg(
go_proto_library(
name = "asset_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/asset/v1p7beta1",
+ importpath = "cloud.google.com/go/asset/apiv1p7beta1/assetpb",
protos = [":asset_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -145,6 +145,7 @@ go_gapic_library(
grpc_service_config = "cloudasset_grpc_service_config.json",
importpath = "cloud.google.com/go/asset/apiv1p7beta1;asset",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "cloudasset_v1p7beta1.yaml",
transport = "grpc",
@@ -182,6 +183,7 @@ py_gapic_library(
srcs = [":asset_proto"],
grpc_service_config = "cloudasset_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "cloudasset_v1p7beta1.yaml",
transport = "grpc",
)
@@ -220,6 +222,7 @@ php_gapic_library(
srcs = [":asset_proto_with_info"],
grpc_service_config = "cloudasset_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "cloudasset_v1p7beta1.yaml",
transport = "grpc+rest",
deps = [
":asset_php_grpc",
@@ -274,6 +277,7 @@ ruby_cloud_gapic_library(
srcs = [":asset_proto_with_info"],
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-asset-v1p7beta1"],
rest_numeric_enums = True,
+ service_yaml = "cloudasset_v1p7beta1.yaml",
deps = [
":asset_ruby_grpc",
":asset_ruby_proto",
@@ -307,6 +311,7 @@ csharp_grpc_library(
# srcs = [":asset_proto_with_info"],
# common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
# grpc_service_config = "cloudasset_grpc_service_config.json",
+# service_yaml = "cloudasset_v1p7beta1.yaml",
# deps = [
# ":asset_csharp_grpc",
# ":asset_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/asset/v1p7beta1/asset_service.proto b/third_party/googleapis/google/cloud/asset/v1p7beta1/asset_service.proto
index 18fcff6c4..46333d1c1 100644
--- a/third_party/googleapis/google/cloud/asset/v1p7beta1/asset_service.proto
+++ b/third_party/googleapis/google/cloud/asset/v1p7beta1/asset_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -20,12 +20,11 @@ import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-import "google/cloud/asset/v1p7beta1/assets.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Asset.V1P7Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/asset/v1p7beta1;asset";
+option go_package = "cloud.google.com/go/asset/apiv1p7beta1/assetpb;assetpb";
option java_multiple_files = true;
option java_outer_classname = "AssetServiceProto";
option java_package = "com.google.cloud.asset.v1p7beta1";
@@ -134,10 +133,10 @@ message ExportAssetsResponse {
OutputConfig output_config = 2;
// Output result indicating where the assets were exported to. For example, a
- // set of actual Google Cloud Storage object uris where the assets are
- // exported to. The uris can be different from what [output_config] has
+ // set of actual Cloud Storage object URIs where the assets are
+ // exported to. The URIs can be different from what [output_config] has
// specified, as the service will split the output object into multiple ones
- // once it exceeds a single Google Cloud Storage object limit.
+ // once it exceeds a single Cloud Storage object limit.
OutputResult output_result = 3;
}
@@ -165,7 +164,7 @@ message OutputResult {
// A Cloud Storage output result.
message GcsOutputResult {
- // List of uris of the Cloud Storage objects. Example:
+ // List of URIs of the Cloud Storage objects. Example:
// "gs://bucket_name/object_name".
repeated string uris = 1;
}
@@ -174,15 +173,15 @@ message GcsOutputResult {
message GcsDestination {
// Required.
oneof object_uri {
- // The uri of the Cloud Storage object. It's the same uri that is used by
+ // The URI of the Cloud Storage object. It's the same URI that is used by
// gsutil. Example: "gs://bucket_name/object_name". See [Viewing and
// Editing Object
// Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
// for more information.
string uri = 1;
- // The uri prefix of all generated Cloud Storage objects. Example:
- // "gs://bucket_name/object_name_prefix". Each object uri is in format:
+ // The URI prefix of all generated Cloud Storage objects. Example:
+ // "gs://bucket_name/object_name_prefix". Each object URI is in format:
// "gs://bucket_name/object_name_prefix/{ASSET_TYPE}/{SHARD_NUMBER} and only
// contains assets for that type. starts from 0. Example:
// "gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0" is
@@ -302,10 +301,10 @@ enum ContentType {
// The actual IAM policy set on a resource.
IAM_POLICY = 2;
- // The Cloud Organization Policy set on an asset.
+ // The organization policy set on an asset.
ORG_POLICY = 4;
- // The Cloud Access context manager Policy set on an asset.
+ // The Access Context Manager policy set on an asset.
ACCESS_POLICY = 5;
// The related resources.
diff --git a/third_party/googleapis/google/cloud/asset/v1p7beta1/assets.proto b/third_party/googleapis/google/cloud/asset/v1p7beta1/assets.proto
index 26ac6b205..275d955e1 100644
--- a/third_party/googleapis/google/cloud/asset/v1p7beta1/assets.proto
+++ b/third_party/googleapis/google/cloud/asset/v1p7beta1/assets.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -18,7 +18,6 @@ package google.cloud.asset.v1p7beta1;
import "google/api/resource.proto";
import "google/cloud/orgpolicy/v1/orgpolicy.proto";
-import "google/cloud/osconfig/v1/inventory.proto";
import "google/iam/v1/policy.proto";
import "google/identity/accesscontextmanager/v1/access_level.proto";
import "google/identity/accesscontextmanager/v1/access_policy.proto";
@@ -28,7 +27,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Asset.V1P7Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/asset/v1p7beta1;asset";
+option go_package = "cloud.google.com/go/asset/apiv1p7beta1/assetpb;assetpb";
option java_multiple_files = true;
option java_outer_classname = "AssetProto";
option java_package = "com.google.cloud.asset.v1p7beta1";
@@ -40,7 +39,7 @@ option php_namespace = "Google\\Cloud\\Asset\\V1p7beta1";
// [resource
// hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy),
// a resource outside the Google Cloud resource hierarchy (such as Google
-// Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy).
+// Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy).
// See [Supported asset
// types](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
// for more information.
@@ -72,15 +71,15 @@ message Asset {
// A representation of the resource.
Resource resource = 3;
- // A representation of the Cloud IAM policy set on a Google Cloud resource.
- // There can be a maximum of one Cloud IAM policy set on any given resource.
- // In addition, Cloud IAM policies inherit their granted access scope from any
+ // A representation of the IAM policy set on a Google Cloud resource.
+ // There can be a maximum of one IAM policy set on any given resource.
+ // In addition, IAM policies inherit their granted access scope from any
// policies set on parent resources in the resource hierarchy. Therefore, the
// effectively policy is the union of both the policy set on this resource
// and each policy set on all of the resource's ancestry resource levels in
// the hierarchy. See
- // [this topic](https://cloud.google.com/iam/docs/policies#inheritance) for
- // more information.
+ // [this topic](https://cloud.google.com/iam/help/allow-policies/inheritance)
+ // for more information.
google.iam.v1.Policy iam_policy = 4;
// A representation of an [organization
@@ -154,7 +153,7 @@ message Resource {
// for more information.
//
// For Google Cloud assets, this value is the parent resource defined in the
- // [Cloud IAM policy
+ // [IAM policy
// hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).
// Example:
// `//cloudresourcemanager.googleapis.com/projects/my_project_123`
@@ -201,7 +200,7 @@ message RelationshipAttributes {
// ancestors. An asset can be any resource in the Google Cloud [resource
// hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy),
// a resource outside the Google Cloud resource hierarchy (such as Google
-// Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy).
+// Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy).
// See [Supported asset
// types](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
// for more information.
diff --git a/third_party/googleapis/google/cloud/asset/v1p7beta1/cloudasset_v1p7beta1.yaml b/third_party/googleapis/google/cloud/asset/v1p7beta1/cloudasset_v1p7beta1.yaml
index 73e89e301..bee999b70 100644
--- a/third_party/googleapis/google/cloud/asset/v1p7beta1/cloudasset_v1p7beta1.yaml
+++ b/third_party/googleapis/google/cloud/asset/v1p7beta1/cloudasset_v1p7beta1.yaml
@@ -5,19 +5,22 @@ title: Cloud Asset API
apis:
- name: google.cloud.asset.v1p7beta1.AssetService
+- name: google.longrunning.Operations
types:
- name: google.cloud.asset.v1p7beta1.Asset
documentation:
- summary: The cloud asset API manages the history and inventory of cloud resources.
+ summary: |-
+ The Cloud Asset API manages the history and inventory of Google Cloud
+ resources.
overview: |-
# Cloud Asset API
- The Cloud Asset API keeps a history of Google Cloud Platform (GCP) asset
- metadata, and allows GCP users to download a dump of all asset metadata
- for the resource types listed below within an organization or a project at
- a given timestamp.
+ The Cloud Asset API keeps a history of Google Cloud asset metadata, and
+ allows Google Cloud users to download a dump of all asset metadata for the
+ resource types listed below within an organization or a project at a given
+ timestamp.
Read more documents here:
https://cloud.google.com/asset-inventory/docs
@@ -29,6 +32,11 @@ backend:
- selector: google.longrunning.Operations.GetOperation
deadline: 60.0
+http:
+ rules:
+ - selector: google.longrunning.Operations.GetOperation
+ get: '/v1p7beta1/{name=*/*/operations/*/**}'
+
authentication:
rules:
- selector: google.cloud.asset.v1p7beta1.AssetService.ExportAssets
diff --git a/third_party/googleapis/google/cloud/assuredworkloads/regulatoryintercept/logging/v1/BUILD.bazel b/third_party/googleapis/google/cloud/assuredworkloads/regulatoryintercept/logging/v1/BUILD.bazel
index 8cb928a88..fd1f14a90 100644
--- a/third_party/googleapis/google/cloud/assuredworkloads/regulatoryintercept/logging/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/assuredworkloads/regulatoryintercept/logging/v1/BUILD.bazel
@@ -48,7 +48,7 @@ load(
go_proto_library(
name = "logging_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/assuredworkloads/regulatoryintercept/logging/v1",
+ importpath = "cloud.google.com/go/assuredworkloads/regulatoryintercept/logging/apiv1/loggingpb",
protos = [":logging_proto"],
deps = [
],
diff --git a/third_party/googleapis/google/cloud/assuredworkloads/regulatoryintercept/logging/v1/regulatory_intercept_ack_log_entry.proto b/third_party/googleapis/google/cloud/assuredworkloads/regulatoryintercept/logging/v1/regulatory_intercept_ack_log_entry.proto
index ade950941..a6b575550 100644
--- a/third_party/googleapis/google/cloud/assuredworkloads/regulatoryintercept/logging/v1/regulatory_intercept_ack_log_entry.proto
+++ b/third_party/googleapis/google/cloud/assuredworkloads/regulatoryintercept/logging/v1/regulatory_intercept_ack_log_entry.proto
@@ -16,7 +16,7 @@ syntax = "proto3";
package google.cloud.assuredworkloads.regulatoryintercept.logging.v1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/assuredworkloads/regulatoryintercept/logging/v1;logging";
+option go_package = "cloud.google.com/go/assuredworkloads/regulatoryintercept/logging/apiv1/loggingpb;loggingpb";
option java_multiple_files = true;
option java_outer_classname = "RegulatoryInterceptAckLogEntryProto";
option java_package = "com.google.cloud.assuredworkloads.regulatoryintercept.logging.v1";
diff --git a/third_party/googleapis/google/cloud/assuredworkloads/v1/BUILD.bazel b/third_party/googleapis/google/cloud/assuredworkloads/v1/BUILD.bazel
index a253a9892..76b833295 100644
--- a/third_party/googleapis/google/cloud/assuredworkloads/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/assuredworkloads/v1/BUILD.bazel
@@ -120,7 +120,7 @@ load(
go_proto_library(
name = "assuredworkloads_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/assuredworkloads/v1",
+ importpath = "cloud.google.com/go/assuredworkloads/apiv1/assuredworkloadspb",
protos = [":assuredworkloads_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -134,6 +134,7 @@ go_gapic_library(
grpc_service_config = "assuredworkloads_grpc_service_config.json",
importpath = "cloud.google.com/go/assuredworkloads/apiv1;assuredworkloads",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "assuredworkloads_v1.yaml",
transport = "grpc+rest",
@@ -181,7 +182,7 @@ py_gapic_library(
opt_args = ["warehouse-package-name=google-cloud-assured-workloads"],
rest_numeric_enums = True,
service_yaml = "assuredworkloads_v1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
],
)
@@ -361,6 +362,7 @@ csharp_gapic_library(
grpc_service_config = "assuredworkloads_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "assuredworkloads_v1.yaml",
+ transport = "grpc+rest",
deps = [
":assuredworkloads_csharp_grpc",
":assuredworkloads_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/assuredworkloads/v1/assuredworkloads.proto b/third_party/googleapis/google/cloud/assuredworkloads/v1/assuredworkloads.proto
index f6349f35f..2700056ca 100644
--- a/third_party/googleapis/google/cloud/assuredworkloads/v1/assuredworkloads.proto
+++ b/third_party/googleapis/google/cloud/assuredworkloads/v1/assuredworkloads.proto
@@ -27,7 +27,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AssuredWorkloads.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/assuredworkloads/v1;assuredworkloads";
+option go_package = "cloud.google.com/go/assuredworkloads/apiv1/assuredworkloadspb;assuredworkloadspb";
option java_multiple_files = true;
option java_outer_classname = "AssuredworkloadsProto";
option java_package = "com.google.cloud.assuredworkloads.v1";
diff --git a/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/BUILD.bazel
index 5ce0db125..e61922fe7 100644
--- a/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/BUILD.bazel
@@ -121,7 +121,7 @@ load(
go_proto_library(
name = "assuredworkloads_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/assuredworkloads/v1beta1",
+ importpath = "cloud.google.com/go/assuredworkloads/apiv1beta1/assuredworkloadspb",
protos = [":assuredworkloads_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -135,6 +135,7 @@ go_gapic_library(
grpc_service_config = "assuredworkloads_grpc_service_config.json",
importpath = "cloud.google.com/go/assuredworkloads/apiv1beta1;assuredworkloads",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "assuredworkloads_v1beta1.yaml",
transport = "grpc+rest",
@@ -182,7 +183,7 @@ py_gapic_library(
opt_args = ["warehouse-package-name=google-cloud-assured-workloads"],
rest_numeric_enums = True,
service_yaml = "assuredworkloads_v1beta1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
)
py_test(
@@ -360,6 +361,7 @@ csharp_gapic_library(
grpc_service_config = "assuredworkloads_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "assuredworkloads_v1beta1.yaml",
+ transport = "grpc+rest",
deps = [
":assuredworkloads_csharp_grpc",
":assuredworkloads_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/assuredworkloads.proto b/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/assuredworkloads.proto
index e6a83fae4..c33caa0aa 100644
--- a/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/assuredworkloads.proto
+++ b/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/assuredworkloads.proto
@@ -23,7 +23,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AssuredWorkloads.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/assuredworkloads/v1beta1;assuredworkloads";
+option go_package = "cloud.google.com/go/assuredworkloads/apiv1beta1/assuredworkloadspb;assuredworkloadspb";
option java_multiple_files = true;
option java_outer_classname = "AssuredworkloadsProto";
option java_package = "com.google.cloud.assuredworkloads.v1beta1";
diff --git a/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/assuredworkloads_service.proto b/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/assuredworkloads_service.proto
index 1af45f12a..e62a64a6d 100644
--- a/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/assuredworkloads_service.proto
+++ b/third_party/googleapis/google/cloud/assuredworkloads/v1beta1/assuredworkloads_service.proto
@@ -23,7 +23,7 @@ import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
option csharp_namespace = "Google.Cloud.AssuredWorkloads.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/assuredworkloads/v1beta1;assuredworkloads";
+option go_package = "cloud.google.com/go/assuredworkloads/apiv1beta1/assuredworkloadspb;assuredworkloadspb";
option java_multiple_files = true;
option java_outer_classname = "AssuredworkloadsServiceProto";
option java_package = "com.google.cloud.assuredworkloads.v1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/BUILD.bazel b/third_party/googleapis/google/cloud/automl/v1/BUILD.bazel
index fd2bd8c32..4520253cb 100644
--- a/third_party/googleapis/google/cloud/automl/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/automl/v1/BUILD.bazel
@@ -131,7 +131,7 @@ load(
go_proto_library(
name = "automl_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/automl/v1",
+ importpath = "cloud.google.com/go/automl/apiv1/automlpb",
protos = [":automl_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -145,6 +145,8 @@ go_gapic_library(
srcs = [":automl_proto_with_info"],
grpc_service_config = "automl_grpc_service_config.json",
importpath = "cloud.google.com/go/automl/apiv1;automl",
+ metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "automl_v1.yaml",
transport = "grpc+rest",
@@ -191,7 +193,8 @@ py_gapic_library(
srcs = [":automl_proto"],
grpc_service_config = "automl_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "automl_v1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -327,6 +330,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "AutoML makes the power of machine learning available to you even if you have limited knowledge of machine learning. You can use AutoML to build on Google's machine learning capabilities to create your own custom machine learning models that are tailored to your business needs, and then integrate those models into your applications and web sites.",
ruby_cloud_title = "Cloud AutoML V1",
+ service_yaml = "automl_v1.yaml",
deps = [
":automl_ruby_grpc",
":automl_ruby_proto",
@@ -372,6 +376,7 @@ csharp_gapic_library(
grpc_service_config = "automl_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "automl_v1.yaml",
+ transport = "grpc+rest",
deps = [
":automl_csharp_grpc",
":automl_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/automl/v1/annotation_payload.proto b/third_party/googleapis/google/cloud/automl/v1/annotation_payload.proto
index 75ea55ff0..e8fd89c25 100644
--- a/third_party/googleapis/google/cloud/automl/v1/annotation_payload.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/annotation_payload.proto
@@ -23,7 +23,7 @@ import "google/cloud/automl/v1/text_sentiment.proto";
import "google/cloud/automl/v1/translation.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/annotation_spec.proto b/third_party/googleapis/google/cloud/automl/v1/annotation_spec.proto
index c479b3acb..75cd334f0 100644
--- a/third_party/googleapis/google/cloud/automl/v1/annotation_spec.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/annotation_spec.proto
@@ -19,7 +19,7 @@ package google.cloud.automl.v1;
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/classification.proto b/third_party/googleapis/google/cloud/automl/v1/classification.proto
index b31e9192c..3982ee4bd 100644
--- a/third_party/googleapis/google/cloud/automl/v1/classification.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/classification.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.automl.v1;
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "ClassificationProto";
option java_package = "com.google.cloud.automl.v1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/data_items.proto b/third_party/googleapis/google/cloud/automl/v1/data_items.proto
index d48daed5f..9990e57d9 100644
--- a/third_party/googleapis/google/cloud/automl/v1/data_items.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/data_items.proto
@@ -21,7 +21,7 @@ import "google/cloud/automl/v1/io.proto";
import "google/cloud/automl/v1/text_segment.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/dataset.proto b/third_party/googleapis/google/cloud/automl/v1/dataset.proto
index 2824f35e8..f6f8fc7c4 100644
--- a/third_party/googleapis/google/cloud/automl/v1/dataset.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/dataset.proto
@@ -23,7 +23,7 @@ import "google/cloud/automl/v1/translation.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/detection.proto b/third_party/googleapis/google/cloud/automl/v1/detection.proto
index 6c2d4ce0e..a76c3538d 100644
--- a/third_party/googleapis/google/cloud/automl/v1/detection.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/detection.proto
@@ -19,7 +19,7 @@ package google.cloud.automl.v1;
import "google/cloud/automl/v1/geometry.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/geometry.proto b/third_party/googleapis/google/cloud/automl/v1/geometry.proto
index a524c0afb..a4261d5eb 100644
--- a/third_party/googleapis/google/cloud/automl/v1/geometry.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/geometry.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.automl.v1;
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/image.proto b/third_party/googleapis/google/cloud/automl/v1/image.proto
index c876e4442..5fdc101bc 100644
--- a/third_party/googleapis/google/cloud/automl/v1/image.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/image.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/cloud/automl/v1/classification.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "ImageProto";
option java_package = "com.google.cloud.automl.v1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/io.proto b/third_party/googleapis/google/cloud/automl/v1/io.proto
index 69a080a4f..9c32cf865 100644
--- a/third_party/googleapis/google/cloud/automl/v1/io.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/io.proto
@@ -19,7 +19,7 @@ package google.cloud.automl.v1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/model.proto b/third_party/googleapis/google/cloud/automl/v1/model.proto
index 05811f6ea..3543f3d6a 100644
--- a/third_party/googleapis/google/cloud/automl/v1/model.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/model.proto
@@ -23,7 +23,7 @@ import "google/cloud/automl/v1/translation.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/model_evaluation.proto b/third_party/googleapis/google/cloud/automl/v1/model_evaluation.proto
index 7505bca3e..5bedf4050 100644
--- a/third_party/googleapis/google/cloud/automl/v1/model_evaluation.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/model_evaluation.proto
@@ -25,7 +25,7 @@ import "google/cloud/automl/v1/translation.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/operations.proto b/third_party/googleapis/google/cloud/automl/v1/operations.proto
index ec5bfad62..21801093f 100644
--- a/third_party/googleapis/google/cloud/automl/v1/operations.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/operations.proto
@@ -21,7 +21,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/prediction_service.proto b/third_party/googleapis/google/cloud/automl/v1/prediction_service.proto
index 9db95024f..5d1d80c48 100644
--- a/third_party/googleapis/google/cloud/automl/v1/prediction_service.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/prediction_service.proto
@@ -26,7 +26,7 @@ import "google/cloud/automl/v1/io.proto";
import "google/longrunning/operations.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "PredictionServiceProto";
option java_package = "com.google.cloud.automl.v1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/service.proto b/third_party/googleapis/google/cloud/automl/v1/service.proto
index f72ebdb5c..ea5dc36fb 100644
--- a/third_party/googleapis/google/cloud/automl/v1/service.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/service.proto
@@ -31,7 +31,7 @@ import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMlProto";
option java_package = "com.google.cloud.automl.v1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/text.proto b/third_party/googleapis/google/cloud/automl/v1/text.proto
index 966e3ca7e..e227347f9 100644
--- a/third_party/googleapis/google/cloud/automl/v1/text.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/text.proto
@@ -19,7 +19,7 @@ package google.cloud.automl.v1;
import "google/cloud/automl/v1/classification.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "TextProto";
option java_package = "com.google.cloud.automl.v1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/text_extraction.proto b/third_party/googleapis/google/cloud/automl/v1/text_extraction.proto
index 8b3530e22..239299e88 100644
--- a/third_party/googleapis/google/cloud/automl/v1/text_extraction.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/text_extraction.proto
@@ -19,7 +19,7 @@ package google.cloud.automl.v1;
import "google/cloud/automl/v1/text_segment.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/text_segment.proto b/third_party/googleapis/google/cloud/automl/v1/text_segment.proto
index e710ccc9b..36bf4f343 100644
--- a/third_party/googleapis/google/cloud/automl/v1/text_segment.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/text_segment.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.automl.v1;
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "TextSegmentProto";
option java_package = "com.google.cloud.automl.v1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/text_sentiment.proto b/third_party/googleapis/google/cloud/automl/v1/text_sentiment.proto
index 6e1b3ed01..865459ea6 100644
--- a/third_party/googleapis/google/cloud/automl/v1/text_sentiment.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/text_sentiment.proto
@@ -19,7 +19,7 @@ package google.cloud.automl.v1;
import "google/cloud/automl/v1/classification.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "TextSentimentProto";
option java_package = "com.google.cloud.automl.v1";
diff --git a/third_party/googleapis/google/cloud/automl/v1/translation.proto b/third_party/googleapis/google/cloud/automl/v1/translation.proto
index cc794d608..05b37d627 100644
--- a/third_party/googleapis/google/cloud/automl/v1/translation.proto
+++ b/third_party/googleapis/google/cloud/automl/v1/translation.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/cloud/automl/v1/data_items.proto";
option csharp_namespace = "Google.Cloud.AutoML.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "TranslationProto";
option java_package = "com.google.cloud.automl.v1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/automl/v1beta1/BUILD.bazel
index c453fd13c..36fbf9cfe 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/BUILD.bazel
@@ -140,7 +140,7 @@ load(
go_proto_library(
name = "automl_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1",
+ importpath = "cloud.google.com/go/automl/apiv1beta1/automlpb",
protos = [":automl_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -154,6 +154,8 @@ go_gapic_library(
srcs = [":automl_proto_with_info"],
grpc_service_config = "automl_grpc_service_config.json",
importpath = "cloud.google.com/go/automl/apiv1beta1;automl",
+ metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "automl_v1beta1.yaml",
transport = "grpc+rest",
@@ -200,7 +202,8 @@ py_gapic_library(
srcs = [":automl_proto"],
grpc_service_config = "automl_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "automl_v1beta1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -335,6 +338,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "AutoML makes the power of machine learning available to you even if you have limited knowledge of machine learning. You can use AutoML to build on Google's machine learning capabilities to create your own custom machine learning models that are tailored to your business needs, and then integrate those models into your applications and web sites.",
ruby_cloud_title = "Cloud AutoML V1beta1",
+ service_yaml = "automl_v1beta1.yaml",
deps = [
":automl_ruby_grpc",
":automl_ruby_proto",
@@ -380,6 +384,7 @@ csharp_gapic_library(
grpc_service_config = "automl_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "automl_v1beta1.yaml",
+ transport = "grpc+rest",
deps = [
":automl_csharp_grpc",
":automl_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/annotation_payload.proto b/third_party/googleapis/google/cloud/automl/v1beta1/annotation_payload.proto
index b01aa2c20..5794c2391 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/annotation_payload.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/annotation_payload.proto
@@ -23,7 +23,7 @@ import "google/cloud/automl/v1beta1/text_extraction.proto";
import "google/cloud/automl/v1beta1/text_sentiment.proto";
import "google/cloud/automl/v1beta1/translation.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/annotation_spec.proto b/third_party/googleapis/google/cloud/automl/v1beta1/annotation_spec.proto
index 713c355b1..4072ddde4 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/annotation_spec.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/annotation_spec.proto
@@ -18,7 +18,7 @@ package google.cloud.automl.v1beta1;
import "google/api/resource.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/classification.proto b/third_party/googleapis/google/cloud/automl/v1beta1/classification.proto
index 555de30ca..7a1b83a28 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/classification.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/classification.proto
@@ -18,7 +18,7 @@ package google.cloud.automl.v1beta1;
import "google/cloud/automl/v1beta1/temporal.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_outer_classname = "ClassificationProto";
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/column_spec.proto b/third_party/googleapis/google/cloud/automl/v1beta1/column_spec.proto
index 97c97d9f2..3d15fb51f 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/column_spec.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/column_spec.proto
@@ -20,7 +20,7 @@ import "google/api/resource.proto";
import "google/cloud/automl/v1beta1/data_stats.proto";
import "google/cloud/automl/v1beta1/data_types.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/data_items.proto b/third_party/googleapis/google/cloud/automl/v1beta1/data_items.proto
index 7bc10a749..2eb45f2d5 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/data_items.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/data_items.proto
@@ -22,7 +22,7 @@ import "google/cloud/automl/v1beta1/temporal.proto";
import "google/cloud/automl/v1beta1/text_segment.proto";
import "google/protobuf/struct.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/data_stats.proto b/third_party/googleapis/google/cloud/automl/v1beta1/data_stats.proto
index 64229e65c..8c2c2fe2a 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/data_stats.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/data_stats.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.automl.v1beta1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/data_types.proto b/third_party/googleapis/google/cloud/automl/v1beta1/data_types.proto
index d9ba570d6..72ac65dd3 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/data_types.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/data_types.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.automl.v1beta1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/dataset.proto b/third_party/googleapis/google/cloud/automl/v1beta1/dataset.proto
index a26e29606..22d7f9a6a 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/dataset.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/dataset.proto
@@ -24,7 +24,7 @@ import "google/cloud/automl/v1beta1/translation.proto";
import "google/cloud/automl/v1beta1/video.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/detection.proto b/third_party/googleapis/google/cloud/automl/v1beta1/detection.proto
index e651d9f24..38240dd6e 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/detection.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/detection.proto
@@ -19,7 +19,7 @@ package google.cloud.automl.v1beta1;
import "google/cloud/automl/v1beta1/geometry.proto";
import "google/protobuf/duration.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/geometry.proto b/third_party/googleapis/google/cloud/automl/v1beta1/geometry.proto
index 68e0f5bdd..067ac00aa 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/geometry.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/geometry.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.automl.v1beta1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/image.proto b/third_party/googleapis/google/cloud/automl/v1beta1/image.proto
index 72f687119..56401228e 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/image.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/image.proto
@@ -19,7 +19,7 @@ package google.cloud.automl.v1beta1;
import "google/cloud/automl/v1beta1/annotation_spec.proto";
import "google/cloud/automl/v1beta1/classification.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "ImageProto";
option java_package = "com.google.cloud.automl.v1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/io.proto b/third_party/googleapis/google/cloud/automl/v1beta1/io.proto
index 249ec4013..04808d74a 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/io.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/io.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.automl.v1beta1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/model.proto b/third_party/googleapis/google/cloud/automl/v1beta1/model.proto
index 2aca21826..9db5e4866 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/model.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/model.proto
@@ -24,7 +24,7 @@ import "google/cloud/automl/v1beta1/translation.proto";
import "google/cloud/automl/v1beta1/video.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/model_evaluation.proto b/third_party/googleapis/google/cloud/automl/v1beta1/model_evaluation.proto
index de0e89700..91801bd36 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/model_evaluation.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/model_evaluation.proto
@@ -26,7 +26,7 @@ import "google/cloud/automl/v1beta1/text_sentiment.proto";
import "google/cloud/automl/v1beta1/translation.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/operations.proto b/third_party/googleapis/google/cloud/automl/v1beta1/operations.proto
index 399d75ce7..f75e48d14 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/operations.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/operations.proto
@@ -22,7 +22,7 @@ import "google/cloud/automl/v1beta1/model_evaluation.proto";
import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/prediction_service.proto b/third_party/googleapis/google/cloud/automl/v1beta1/prediction_service.proto
index 0bcf685e0..28148a576 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/prediction_service.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/prediction_service.proto
@@ -26,7 +26,7 @@ import "google/cloud/automl/v1beta1/io.proto";
import "google/cloud/automl/v1beta1/operations.proto";
import "google/longrunning/operations.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "PredictionServiceProto";
option java_package = "com.google.cloud.automl.v1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/ranges.proto b/third_party/googleapis/google/cloud/automl/v1beta1/ranges.proto
index 7adcd61ba..35ebb569a 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/ranges.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/ranges.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.automl.v1beta1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "RangesProto";
option java_package = "com.google.cloud.automl.v1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/regression.proto b/third_party/googleapis/google/cloud/automl/v1beta1/regression.proto
index d14b0f0ef..3c6b269a6 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/regression.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/regression.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.automl.v1beta1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_outer_classname = "RegressionProto";
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/service.proto b/third_party/googleapis/google/cloud/automl/v1beta1/service.proto
index 9a572dd2a..f4ac32315 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/service.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/service.proto
@@ -33,7 +33,7 @@ import "google/cloud/automl/v1beta1/table_spec.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "AutoMlProto";
option java_package = "com.google.cloud.automl.v1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/table_spec.proto b/third_party/googleapis/google/cloud/automl/v1beta1/table_spec.proto
index 1e451a4c1..de1f7a09c 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/table_spec.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/table_spec.proto
@@ -19,7 +19,7 @@ package google.cloud.automl.v1beta1;
import "google/api/resource.proto";
import "google/cloud/automl/v1beta1/io.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/tables.proto b/third_party/googleapis/google/cloud/automl/v1beta1/tables.proto
index 4db553468..34ea99b30 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/tables.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/tables.proto
@@ -26,7 +26,7 @@ import "google/cloud/automl/v1beta1/temporal.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/temporal.proto b/third_party/googleapis/google/cloud/automl/v1beta1/temporal.proto
index c560acff9..55bb231d0 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/temporal.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/temporal.proto
@@ -18,7 +18,7 @@ package google.cloud.automl.v1beta1;
import "google/protobuf/duration.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/text.proto b/third_party/googleapis/google/cloud/automl/v1beta1/text.proto
index 89cb6efe4..b93376ec3 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/text.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/text.proto
@@ -18,7 +18,7 @@ package google.cloud.automl.v1beta1;
import "google/cloud/automl/v1beta1/classification.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "TextProto";
option java_package = "com.google.cloud.automl.v1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/text_extraction.proto b/third_party/googleapis/google/cloud/automl/v1beta1/text_extraction.proto
index 0f004ad8c..61afd5438 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/text_extraction.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/text_extraction.proto
@@ -18,7 +18,7 @@ package google.cloud.automl.v1beta1;
import "google/cloud/automl/v1beta1/text_segment.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/text_segment.proto b/third_party/googleapis/google/cloud/automl/v1beta1/text_segment.proto
index d2de26258..451279c44 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/text_segment.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/text_segment.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.automl.v1beta1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "TextSegmentProto";
option java_package = "com.google.cloud.automl.v1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/text_sentiment.proto b/third_party/googleapis/google/cloud/automl/v1beta1/text_sentiment.proto
index be68e12be..a5b2c005e 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/text_sentiment.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/text_sentiment.proto
@@ -18,7 +18,7 @@ package google.cloud.automl.v1beta1;
import "google/cloud/automl/v1beta1/classification.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_outer_classname = "TextSentimentProto";
option java_package = "com.google.cloud.automl.v1beta1";
option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/translation.proto b/third_party/googleapis/google/cloud/automl/v1beta1/translation.proto
index cb8463f1a..7aefb42bb 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/translation.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/translation.proto
@@ -19,7 +19,7 @@ package google.cloud.automl.v1beta1;
import "google/api/field_behavior.proto";
import "google/cloud/automl/v1beta1/data_items.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "TranslationProto";
option java_package = "com.google.cloud.automl.v1beta1";
diff --git a/third_party/googleapis/google/cloud/automl/v1beta1/video.proto b/third_party/googleapis/google/cloud/automl/v1beta1/video.proto
index 4e96edd50..872adb804 100644
--- a/third_party/googleapis/google/cloud/automl/v1beta1/video.proto
+++ b/third_party/googleapis/google/cloud/automl/v1beta1/video.proto
@@ -18,7 +18,7 @@ package google.cloud.automl.v1beta1;
import "google/cloud/automl/v1beta1/classification.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
+option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
option java_multiple_files = true;
option java_outer_classname = "VideoProto";
option java_package = "com.google.cloud.automl.v1beta1";
diff --git a/third_party/googleapis/google/cloud/backupdr/logging/v1/BUILD.bazel b/third_party/googleapis/google/cloud/backupdr/logging/v1/BUILD.bazel
index bd5a02c01..5a216ae2c 100644
--- a/third_party/googleapis/google/cloud/backupdr/logging/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/backupdr/logging/v1/BUILD.bazel
@@ -106,7 +106,7 @@ java_grpc_library(
go_proto_library(
name = "logging_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/backupdr/logging/v1",
+ importpath = "cloud.google.com/go/backupdr/logging/apiv1/loggingpb",
protos = [":logging_proto"],
deps = [
],
diff --git a/third_party/googleapis/google/cloud/backupdr/logging/v1/eventlog.proto b/third_party/googleapis/google/cloud/backupdr/logging/v1/eventlog.proto
index ce85da9d9..441ad0997 100644
--- a/third_party/googleapis/google/cloud/backupdr/logging/v1/eventlog.proto
+++ b/third_party/googleapis/google/cloud/backupdr/logging/v1/eventlog.proto
@@ -18,7 +18,7 @@ package google.cloud.backupdr.logging.v1;
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/backupdr/logging/v1;logging";
+option go_package = "cloud.google.com/go/backupdr/logging/apiv1/loggingpb;loggingpb";
// This is an event
message Event {
diff --git a/third_party/googleapis/google/cloud/baremetalsolution/v2/BUILD.bazel b/third_party/googleapis/google/cloud/baremetalsolution/v2/BUILD.bazel
index 18eca6fb6..4141b28fe 100644
--- a/third_party/googleapis/google/cloud/baremetalsolution/v2/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/baremetalsolution/v2/BUILD.bazel
@@ -124,7 +124,7 @@ load(
go_proto_library(
name = "baremetalsolution_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/baremetalsolution/v2",
+ importpath = "cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb",
protos = [":baremetalsolution_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -138,6 +138,7 @@ go_gapic_library(
grpc_service_config = "baremetalsolution_grpc_service_config.json",
importpath = "cloud.google.com/go/baremetalsolution/apiv2;baremetalsolution",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "baremetalsolution_v2.yaml",
transport = "grpc+rest",
@@ -188,7 +189,9 @@ py_gapic_library(
"python-gapic-name=bare_metal_solution",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "baremetalsolution_v2.yaml",
+ transport = "grpc+rest",
+ deps = ["//google/iam/v1:iam_policy_py_proto",]
)
py_test(
@@ -365,6 +368,7 @@ csharp_gapic_library(
grpc_service_config = "baremetalsolution_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "baremetalsolution_v2.yaml",
+ transport = "grpc+rest",
deps = [
":baremetalsolution_csharp_grpc",
":baremetalsolution_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/baremetalsolution/v2/baremetalsolution.proto b/third_party/googleapis/google/cloud/baremetalsolution/v2/baremetalsolution.proto
index 87e0f8d5b..975145b63 100644
--- a/third_party/googleapis/google/cloud/baremetalsolution/v2/baremetalsolution.proto
+++ b/third_party/googleapis/google/cloud/baremetalsolution/v2/baremetalsolution.proto
@@ -28,7 +28,7 @@ import "google/longrunning/operations.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.BareMetalSolution.V2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/baremetalsolution/v2;baremetalsolution";
+option go_package = "cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb;baremetalsolutionpb";
option java_multiple_files = true;
option java_outer_classname = "BareMetalSolutionProto";
option java_package = "com.google.cloud.baremetalsolution.v2";
diff --git a/third_party/googleapis/google/cloud/baremetalsolution/v2/instance.proto b/third_party/googleapis/google/cloud/baremetalsolution/v2/instance.proto
index 49105bd8c..364029ee6 100644
--- a/third_party/googleapis/google/cloud/baremetalsolution/v2/instance.proto
+++ b/third_party/googleapis/google/cloud/baremetalsolution/v2/instance.proto
@@ -24,7 +24,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.BareMetalSolution.V2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/baremetalsolution/v2;baremetalsolution";
+option go_package = "cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb;baremetalsolutionpb";
option java_multiple_files = true;
option java_outer_classname = "InstanceProto";
option java_package = "com.google.cloud.baremetalsolution.v2";
diff --git a/third_party/googleapis/google/cloud/baremetalsolution/v2/lun.proto b/third_party/googleapis/google/cloud/baremetalsolution/v2/lun.proto
index c165a5030..11bcf7466 100644
--- a/third_party/googleapis/google/cloud/baremetalsolution/v2/lun.proto
+++ b/third_party/googleapis/google/cloud/baremetalsolution/v2/lun.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.BareMetalSolution.V2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/baremetalsolution/v2;baremetalsolution";
+option go_package = "cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb;baremetalsolutionpb";
option java_multiple_files = true;
option java_outer_classname = "LunProto";
option java_package = "com.google.cloud.baremetalsolution.v2";
diff --git a/third_party/googleapis/google/cloud/baremetalsolution/v2/network.proto b/third_party/googleapis/google/cloud/baremetalsolution/v2/network.proto
index 3f240de01..e46eab9af 100644
--- a/third_party/googleapis/google/cloud/baremetalsolution/v2/network.proto
+++ b/third_party/googleapis/google/cloud/baremetalsolution/v2/network.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.BareMetalSolution.V2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/baremetalsolution/v2;baremetalsolution";
+option go_package = "cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb;baremetalsolutionpb";
option java_multiple_files = true;
option java_outer_classname = "NetworkProto";
option java_package = "com.google.cloud.baremetalsolution.v2";
diff --git a/third_party/googleapis/google/cloud/baremetalsolution/v2/nfs_share.proto b/third_party/googleapis/google/cloud/baremetalsolution/v2/nfs_share.proto
index 29d2a808d..f8a63e8e5 100644
--- a/third_party/googleapis/google/cloud/baremetalsolution/v2/nfs_share.proto
+++ b/third_party/googleapis/google/cloud/baremetalsolution/v2/nfs_share.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.BareMetalSolution.V2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/baremetalsolution/v2;baremetalsolution";
+option go_package = "cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb;baremetalsolutionpb";
option java_multiple_files = true;
option java_outer_classname = "NfsShareProto";
option java_package = "com.google.cloud.baremetalsolution.v2";
diff --git a/third_party/googleapis/google/cloud/baremetalsolution/v2/volume.proto b/third_party/googleapis/google/cloud/baremetalsolution/v2/volume.proto
index 39d66f9ce..8920a6f15 100644
--- a/third_party/googleapis/google/cloud/baremetalsolution/v2/volume.proto
+++ b/third_party/googleapis/google/cloud/baremetalsolution/v2/volume.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.BareMetalSolution.V2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/baremetalsolution/v2;baremetalsolution";
+option go_package = "cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb;baremetalsolutionpb";
option java_multiple_files = true;
option java_outer_classname = "VolumeProto";
option java_package = "com.google.cloud.baremetalsolution.v2";
diff --git a/third_party/googleapis/google/cloud/batch/v1/BUILD.bazel b/third_party/googleapis/google/cloud/batch/v1/BUILD.bazel
index 261c591a5..5141d69a3 100644
--- a/third_party/googleapis/google/cloud/batch/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/batch/v1/BUILD.bazel
@@ -33,6 +33,7 @@ proto_library(
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"@com_google_protobuf//:duration_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:timestamp_proto",
],
)
@@ -127,7 +128,7 @@ load(
go_proto_library(
name = "batch_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/batch/v1",
+ importpath = "cloud.google.com/go/batch/apiv1/batchpb",
protos = [":batch_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -141,6 +142,7 @@ go_gapic_library(
grpc_service_config = "batch_v1_grpc_service_config.json",
importpath = "cloud.google.com/go/batch/apiv1;batch",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "batch_v1.yaml",
transport = "grpc+rest",
@@ -368,6 +370,7 @@ csharp_gapic_library(
grpc_service_config = "batch_v1_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "batch_v1.yaml",
+ transport = "grpc+rest",
deps = [
":batch_csharp_grpc",
":batch_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/batch/v1/batch.proto b/third_party/googleapis/google/cloud/batch/v1/batch.proto
index 1fa330088..4e2e0d9c3 100644
--- a/third_party/googleapis/google/cloud/batch/v1/batch.proto
+++ b/third_party/googleapis/google/cloud/batch/v1/batch.proto
@@ -23,10 +23,11 @@ import "google/api/resource.proto";
import "google/cloud/batch/v1/job.proto";
import "google/cloud/batch/v1/task.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Batch.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/batch/v1;batch";
+option go_package = "cloud.google.com/go/batch/apiv1/batchpb;batchpb";
option java_multiple_files = true;
option java_outer_classname = "BatchProto";
option java_package = "com.google.cloud.batch.v1";
@@ -39,7 +40,8 @@ option ruby_package = "Google::Cloud::Batch::V1";
// Engine VM instances to run the jobs.
service BatchService {
option (google.api.default_host) = "batch.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Create a Job.
rpc CreateJob(CreateJobRequest) returns (Job) {
@@ -101,9 +103,7 @@ message CreateJobRequest {
// Pattern: "projects/{project}/locations/{location}"
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "batch.googleapis.com/Job"
- }
+ (google.api.resource_reference) = { child_type: "batch.googleapis.com/Job" }
];
// ID used to uniquely identify the Job within its parent scope.
@@ -120,13 +120,13 @@ message CreateJobRequest {
// Required. The Job to create.
Job job = 3 [(google.api.field_behavior) = REQUIRED];
- // Optional. An optional request ID to identify requests. Specify a unique request ID
- // so that if you must retry your request, the server will know to ignore
- // the request if it has already been completed. The server will guarantee
- // that for at least 60 minutes since the first request.
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
//
- // For example, consider a situation where you make an initial request and t
- // he request times out. If you make the request again with the same request
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
@@ -141,9 +141,7 @@ message GetJobRequest {
// Required. Job name.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "batch.googleapis.com/Job"
- }
+ (google.api.resource_reference) = { type: "batch.googleapis.com/Job" }
];
}
@@ -155,13 +153,13 @@ message DeleteJobRequest {
// Optional. Reason for this deletion.
string reason = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. An optional request ID to identify requests. Specify a unique request ID
- // so that if you must retry your request, the server will know to ignore
- // the request if it has already been completed. The server will guarantee
- // that for at least 60 minutes after the first request.
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
//
- // For example, consider a situation where you make an initial request and t
- // he request times out. If you make the request again with the same request
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
@@ -205,9 +203,7 @@ message ListTasksRequest {
// "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "batch.googleapis.com/TaskGroup"
- }
+ (google.api.resource_reference) = { type: "batch.googleapis.com/TaskGroup" }
];
// Task filter, null filter matches all Tasks.
@@ -239,19 +235,19 @@ message GetTaskRequest {
// Required. Task name.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "batch.googleapis.com/Task"
- }
+ (google.api.resource_reference) = { type: "batch.googleapis.com/Task" }
];
}
// Represents the metadata of the long-running operation.
message OperationMetadata {
// Output only. The time the operation was created.
- google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the operation finished running.
- google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Server-defined resource path for the target of the operation.
string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -264,8 +260,9 @@ message OperationMetadata {
// Output only. Identifies whether the user has requested cancellation
// of the operation. Operations that have successfully been cancelled
- // have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
- // corresponding to `Code.CANCELLED`.
+ // have [Operation.error][] value with a
+ // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
+ // `Code.CANCELLED`.
bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. API version used to start the operation.
diff --git a/third_party/googleapis/google/cloud/batch/v1/batch_v1.yaml b/third_party/googleapis/google/cloud/batch/v1/batch_v1.yaml
index 15505521c..f934d6334 100644
--- a/third_party/googleapis/google/cloud/batch/v1/batch_v1.yaml
+++ b/third_party/googleapis/google/cloud/batch/v1/batch_v1.yaml
@@ -6,7 +6,6 @@ title: Batch API
apis:
- name: google.cloud.batch.v1.BatchService
- name: google.cloud.location.Locations
-- name: google.iam.v1.IAMPolicy
- name: google.longrunning.Operations
types:
@@ -22,29 +21,6 @@ documentation:
- selector: google.cloud.location.Locations.ListLocations
description: Lists information about the supported locations for this service.
- - selector: google.iam.v1.IAMPolicy.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.
-
- - selector: google.iam.v1.IAMPolicy.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.
-
- - selector: google.iam.v1.IAMPolicy.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.
-
backend:
rules:
- selector: 'google.cloud.batch.v1.BatchService.*'
@@ -53,8 +29,6 @@ backend:
deadline: 60.0
- selector: google.cloud.location.Locations.ListLocations
deadline: 60.0
- - selector: 'google.iam.v1.IAMPolicy.*'
- deadline: 60.0
- selector: 'google.longrunning.Operations.*'
deadline: 60.0
@@ -64,14 +38,6 @@ http:
get: '/v1/{name=projects/*/locations/*}'
- selector: google.cloud.location.Locations.ListLocations
get: '/v1/{name=projects/*}/locations'
- - selector: google.iam.v1.IAMPolicy.GetIamPolicy
- get: '/v1/{resource=projects/*/locations/*/jobs/*}:getIamPolicy'
- - selector: google.iam.v1.IAMPolicy.SetIamPolicy
- post: '/v1/{resource=projects/*/locations/*/jobs/*}:setIamPolicy'
- body: '*'
- - selector: google.iam.v1.IAMPolicy.TestIamPermissions
- post: '/v1/{resource=projects/*/locations/*/jobs/*}:testIamPermissions'
- body: '*'
- selector: google.longrunning.Operations.CancelOperation
post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
body: '*'
@@ -96,10 +62,6 @@ authentication:
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- - selector: 'google.iam.v1.IAMPolicy.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/cloud-platform
- selector: 'google.longrunning.Operations.*'
oauth:
canonical_scopes: |-
@@ -107,3 +69,10 @@ authentication:
publishing:
organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED
+ new_issue_uri: ''
+ documentation_uri: ''
+ api_short_name: ''
+ github_label: ''
+ doc_tag_prefix: ''
+ codeowner_github_teams:
+ library_settings:
diff --git a/third_party/googleapis/google/cloud/batch/v1/job.proto b/third_party/googleapis/google/cloud/batch/v1/job.proto
index 0519f68f4..d41b2e1fe 100644
--- a/third_party/googleapis/google/cloud/batch/v1/job.proto
+++ b/third_party/googleapis/google/cloud/batch/v1/job.proto
@@ -23,7 +23,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Batch.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/batch/v1;batch";
+option go_package = "cloud.google.com/go/batch/apiv1/batchpb;batchpb";
option java_multiple_files = true;
option java_outer_classname = "JobProto";
option java_package = "com.google.cloud.batch.v1";
@@ -46,7 +46,8 @@ message Job {
string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Priority of the Job.
- // The valid value range is [0, 100).
+ // The valid value range is [0, 100). Default value is 0.
+ // Higher value indicates higher priority.
// A job with higher priority value is more likely to run earlier if all other
// requirements are satisfied.
int64 priority = 3;
@@ -73,10 +74,12 @@ message Job {
JobStatus status = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. When the Job was created.
- google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The last time the Job was updated.
- google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Log preservation policy for the Job.
LogsPolicy logs_policy = 13;
@@ -121,6 +124,9 @@ message JobStatus {
// The max number of tasks can be assigned to this instance type.
int64 task_pack = 3;
+
+ // The VM boot disk.
+ AllocationPolicy.Disk boot_disk = 4;
}
// Aggregated task status for a TaskGroup.
@@ -241,20 +247,37 @@ message AllocationPolicy {
// A data source from which a PD will be created.
oneof data_source {
// Name of a public or custom image used as the data source.
+ // For example, the following are all valid URLs:
+ // (1) Specify the image by its family name:
+ // projects/{project}/global/images/family/{image_family}
+ // (2) Specify the image version:
+ // projects/{project}/global/images/{image_version}
+ // You can also use Batch customized image in short names.
+ // The following image values are supported for a boot disk:
+ // "batch-debian": use Batch Debian images.
+ // "batch-centos": use Batch CentOS images.
+ // "batch-cos": use Batch Container-Optimized images.
string image = 4;
// Name of a snapshot used as the data source.
string snapshot = 5;
}
- // Disk type as shown in `gcloud compute disk-types list`
- // For example, "pd-ssd", "pd-standard", "pd-balanced", "local-ssd".
+ // Disk type as shown in `gcloud compute disk-types list`.
+ // For example, local SSD uses type "local-ssd".
+ // Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd"
+ // or "pd-standard".
string type = 1;
// Disk size in GB.
- // This field is ignored if `data_source` is `disk` or `image`.
- // If `type` is `local-ssd`, size_gb should be a multiple of 375GB,
+ // For persistent disk, this field is ignored if `data_source` is `image` or
+ // `snapshot`.
+ // For local SSD, size_gb should be a multiple of 375GB,
// otherwise, the final size will be the next greater multiple of 375 GB.
+ // For boot disk, Batch will calculate the boot disk size based on source
+ // image and task requirements if you do not speicify the size.
+ // If both this field and the boot_disk_mib field in task spec's
+ // compute_resource are defined, Batch will only honor this field.
int64 size_gb = 2;
// Local SSDs are available through both "SCSI" and "NVMe" interfaces.
@@ -311,6 +334,10 @@ message AllocationPolicy {
// The accelerators attached to each VM instance.
repeated Accelerator accelerators = 5;
+ // Book disk to be created and attached to each VM by this InstancePolicy.
+ // Boot disk will be deleted when the VM is deleted.
+ Disk boot_disk = 8;
+
// Non-boot disks to be attached for each VM created by this InstancePolicy.
// New disks will be deleted when the VM is deleted.
repeated AttachedDisk disks = 6;
@@ -337,10 +364,20 @@ message AllocationPolicy {
// A network interface.
message NetworkInterface {
- // The URL of the network resource.
+ // The URL of an existing network resource.
+ // 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/{network}
string network = 1;
- // The URL of the Subnetwork resource.
+ // The URL of an existing subnetwork resource in the network.
+ // You can specify the subnetwork as a full or partial URL.
+ // For example, the following are all valid URLs:
+ // https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}
+ // projects/{project}/regions/{region}/subnetworks/{subnetwork}
+ // regions/{region}/subnetworks/{subnetwork}
string subnetwork = 2;
// Default is false (with an external IP address). Required if
@@ -462,4 +499,8 @@ message ServiceAccount {
// template is being used, the service account has to be specified in the
// instance template and it has to match the email field here.
string email = 1;
+
+ // List of scopes to be enabled for this service account on the VM, in
+ // addition to the cloud-platform API scope that will be added by default.
+ repeated string scopes = 2;
}
diff --git a/third_party/googleapis/google/cloud/batch/v1/task.proto b/third_party/googleapis/google/cloud/batch/v1/task.proto
index 3c6251b94..a4d4ba45c 100644
--- a/third_party/googleapis/google/cloud/batch/v1/task.proto
+++ b/third_party/googleapis/google/cloud/batch/v1/task.proto
@@ -22,7 +22,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Batch.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/batch/v1;batch";
+option go_package = "cloud.google.com/go/batch/apiv1/batchpb;batchpb";
option java_multiple_files = true;
option java_outer_classname = "TaskProto";
option java_package = "com.google.cloud.batch.v1";
@@ -55,6 +55,9 @@ message StatusEvent {
// Task Execution
TaskExecution task_execution = 4;
+
+ // Task State
+ TaskStatus.State task_state = 5;
}
// This Task Execution field includes detail information for
@@ -140,9 +143,23 @@ message Runnable {
message Script {
oneof command {
// Script file path on the host VM.
+ //
+ // To specify an interpreter, please add a `#!`(also known as
+ // [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
+ // first line of the file.(For example, to execute the script using bash,
+ // `#!/bin/bash` should be the first line of the file. To execute the
+ // script using`Python3`, `#!/usr/bin/env python3` should be the first
+ // line of the file.) Otherwise, the file will by default be excuted by
+ // `/bin/sh`.
string path = 1;
// Shell script text.
+ //
+ // To specify an interpreter, please add a `#!\n` at the
+ // beginning of the text.(For example, to execute the script using bash,
+ // `#!/bin/bash\n` should be added. To execute the script using`Python3`,
+ // `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
+ // by default be excuted by `/bin/sh`.
string text = 2;
}
}
@@ -220,13 +237,12 @@ message TaskSpec {
int32 max_retry_count = 5;
// Lifecycle management schema when any task in a task group is failed.
- // The valid size of lifecycle policies are [0, 10].
- // For each lifecycle policy, when the condition is met,
- // the action in that policy will execute.
- // If there are multiple policies that the task execution result matches,
- // we use the action from the first matched policy. If task execution result
- // does not meet with any of the defined lifecycle policy, we consider it as
- // the default policy. Default policy means if the exit code is 0, exit task.
+ // Currently we only support one lifecycle policy.
+ // When the lifecycle policy condition is met,
+ // the action in the policy will execute.
+ // If task execution result does not meet with the defined lifecycle
+ // policy, we consider it as the default policy.
+ // Default policy means if the exit code is 0, exit task.
// If task ends with non-zero exit code, retry the task with max_retry_count.
repeated LifecyclePolicy lifecycle_policies = 9;
@@ -265,6 +281,10 @@ message LifecyclePolicy {
}
// Action to execute when ActionCondition is true.
+ // When RETRY_TASK is specified, we will retry failed tasks
+ // if we notice any exit code match and fail tasks if no match is found.
+ // Likewise, when FAIL_TASK is specified, we will fail tasks
+ // if we notice any exit code match and retry tasks if no match is found.
Action action = 1;
// Conditions that decide why a task failure is dealt with a specific action.
@@ -291,6 +311,23 @@ message Task {
// An Environment describes a collection of environment variables to set when
// executing Tasks.
message Environment {
+ message KMSEnvMap {
+ // The name of the KMS key that will be used to decrypt the cipher text.
+ string key_name = 1;
+
+ // The value of the cipherText response from the `encrypt` method.
+ string cipher_text = 2;
+ }
+
// A map of environment variable names to values.
map variables = 1;
+
+ // A map of environment variable names to Secret Manager secret names.
+ // The VM will access the named secrets to set the value of each environment
+ // variable.
+ map secret_variables = 2;
+
+ // An encrypted JSON dictionary where the key/value pairs correspond to
+ // environment variable names and their values.
+ KMSEnvMap encrypted_variables = 3;
}
diff --git a/third_party/googleapis/google/cloud/batch/v1/volume.proto b/third_party/googleapis/google/cloud/batch/v1/volume.proto
index 7b6ebac48..77413de82 100644
--- a/third_party/googleapis/google/cloud/batch/v1/volume.proto
+++ b/third_party/googleapis/google/cloud/batch/v1/volume.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.batch.v1;
option csharp_namespace = "Google.Cloud.Batch.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/batch/v1;batch";
+option go_package = "cloud.google.com/go/batch/apiv1/batchpb;batchpb";
option java_multiple_files = true;
option java_outer_classname = "VolumeProto";
option java_package = "com.google.cloud.batch.v1";
diff --git a/third_party/googleapis/google/cloud/batch/v1alpha/BUILD.bazel b/third_party/googleapis/google/cloud/batch/v1alpha/BUILD.bazel
index 02857831c..351edd5e5 100644
--- a/third_party/googleapis/google/cloud/batch/v1alpha/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/batch/v1alpha/BUILD.bazel
@@ -33,6 +33,7 @@ proto_library(
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"@com_google_protobuf//:duration_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:timestamp_proto",
],
)
@@ -127,7 +128,7 @@ load(
go_proto_library(
name = "batch_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/batch/v1alpha",
+ importpath = "cloud.google.com/go/batch/apiv1alpha/batchpb",
protos = [":batch_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -141,6 +142,7 @@ go_gapic_library(
grpc_service_config = "batch_v1alpha_grpc_service_config.json",
importpath = "cloud.google.com/go/batch/apiv1alpha;batch",
metadata = True,
+ release_level = "alpha",
rest_numeric_enums = True,
service_yaml = "batch_v1alpha.yaml",
transport = "grpc+rest",
@@ -368,6 +370,7 @@ csharp_gapic_library(
grpc_service_config = "batch_v1alpha_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "batch_v1alpha.yaml",
+ transport = "grpc+rest",
deps = [
":batch_csharp_grpc",
":batch_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/batch/v1alpha/batch.proto b/third_party/googleapis/google/cloud/batch/v1alpha/batch.proto
index cc6dd16a5..d26b4c9e5 100644
--- a/third_party/googleapis/google/cloud/batch/v1alpha/batch.proto
+++ b/third_party/googleapis/google/cloud/batch/v1alpha/batch.proto
@@ -23,10 +23,11 @@ import "google/api/resource.proto";
import "google/cloud/batch/v1alpha/job.proto";
import "google/cloud/batch/v1alpha/task.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Batch.V1Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/batch/v1alpha;batch";
+option go_package = "cloud.google.com/go/batch/apiv1alpha/batchpb;batchpb";
option java_multiple_files = true;
option java_outer_classname = "BatchProto";
option java_package = "com.google.cloud.batch.v1alpha";
@@ -39,7 +40,8 @@ option ruby_package = "Google::Cloud::Batch::V1alpha";
// Engine VM instances to run the jobs.
service BatchService {
option (google.api.default_host) = "batch.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Create a Job.
rpc CreateJob(CreateJobRequest) returns (Job) {
@@ -101,9 +103,7 @@ message CreateJobRequest {
// Pattern: "projects/{project}/locations/{location}"
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "batch.googleapis.com/Job"
- }
+ (google.api.resource_reference) = { child_type: "batch.googleapis.com/Job" }
];
// ID used to uniquely identify the Job within its parent scope.
@@ -120,13 +120,13 @@ message CreateJobRequest {
// Required. The Job to create.
Job job = 3 [(google.api.field_behavior) = REQUIRED];
- // Optional. An optional request ID to identify requests. Specify a unique request ID
- // so that if you must retry your request, the server will know to ignore
- // the request if it has already been completed. The server will guarantee
- // that for at least 60 minutes since the first request.
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes since the first request.
//
- // For example, consider a situation where you make an initial request and t
- // he request times out. If you make the request again with the same request
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
@@ -141,9 +141,7 @@ message GetJobRequest {
// Required. Job name.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "batch.googleapis.com/Job"
- }
+ (google.api.resource_reference) = { type: "batch.googleapis.com/Job" }
];
}
@@ -155,13 +153,13 @@ message DeleteJobRequest {
// Optional. Reason for this deletion.
string reason = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. An optional request ID to identify requests. Specify a unique request ID
- // so that if you must retry your request, the server will know to ignore
- // the request if it has already been completed. The server will guarantee
- // that for at least 60 minutes after the first request.
+ // Optional. An optional request ID to identify requests. Specify a unique
+ // request ID so that if you must retry your request, the server will know to
+ // ignore the request if it has already been completed. The server will
+ // guarantee that for at least 60 minutes after the first request.
//
- // For example, consider a situation where you make an initial request and t
- // he request times out. If you make the request again with the same request
+ // For example, consider a situation where you make an initial request and
+ // the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
@@ -205,9 +203,7 @@ message ListTasksRequest {
// "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "batch.googleapis.com/TaskGroup"
- }
+ (google.api.resource_reference) = { type: "batch.googleapis.com/TaskGroup" }
];
// Task filter, null filter matches all Tasks.
@@ -239,19 +235,19 @@ message GetTaskRequest {
// Required. Task name.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "batch.googleapis.com/Task"
- }
+ (google.api.resource_reference) = { type: "batch.googleapis.com/Task" }
];
}
// Represents the metadata of the long-running operation.
message OperationMetadata {
// Output only. The time the operation was created.
- google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the operation finished running.
- google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Server-defined resource path for the target of the operation.
string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -264,8 +260,9 @@ message OperationMetadata {
// Output only. Identifies whether the user has requested cancellation
// of the operation. Operations that have successfully been cancelled
- // have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
- // corresponding to `Code.CANCELLED`.
+ // have [Operation.error][] value with a
+ // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
+ // `Code.CANCELLED`.
bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. API version used to start the operation.
diff --git a/third_party/googleapis/google/cloud/batch/v1alpha/batch_v1alpha.yaml b/third_party/googleapis/google/cloud/batch/v1alpha/batch_v1alpha.yaml
index b65ed302a..af92e184b 100644
--- a/third_party/googleapis/google/cloud/batch/v1alpha/batch_v1alpha.yaml
+++ b/third_party/googleapis/google/cloud/batch/v1alpha/batch_v1alpha.yaml
@@ -6,7 +6,6 @@ title: Batch API
apis:
- name: google.cloud.batch.v1alpha.BatchService
- name: google.cloud.location.Locations
-- name: google.iam.v1.IAMPolicy
- name: google.longrunning.Operations
types:
@@ -22,29 +21,6 @@ documentation:
- selector: google.cloud.location.Locations.ListLocations
description: Lists information about the supported locations for this service.
- - selector: google.iam.v1.IAMPolicy.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.
-
- - selector: google.iam.v1.IAMPolicy.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.
-
- - selector: google.iam.v1.IAMPolicy.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.
-
backend:
rules:
- selector: 'google.cloud.batch.v1alpha.BatchService.*'
@@ -53,8 +29,6 @@ backend:
deadline: 60.0
- selector: google.cloud.location.Locations.ListLocations
deadline: 60.0
- - selector: 'google.iam.v1.IAMPolicy.*'
- deadline: 60.0
- selector: 'google.longrunning.Operations.*'
deadline: 60.0
@@ -64,14 +38,6 @@ http:
get: '/v1alpha/{name=projects/*/locations/*}'
- selector: google.cloud.location.Locations.ListLocations
get: '/v1alpha/{name=projects/*}/locations'
- - selector: google.iam.v1.IAMPolicy.GetIamPolicy
- get: '/v1alpha/{resource=projects/*/locations/*/jobs/*}:getIamPolicy'
- - selector: google.iam.v1.IAMPolicy.SetIamPolicy
- post: '/v1alpha/{resource=projects/*/locations/*/jobs/*}:setIamPolicy'
- body: '*'
- - selector: google.iam.v1.IAMPolicy.TestIamPermissions
- post: '/v1alpha/{resource=projects/*/locations/*/jobs/*}:testIamPermissions'
- body: '*'
- selector: google.longrunning.Operations.CancelOperation
post: '/v1alpha/{name=projects/*/locations/*/operations/*}:cancel'
body: '*'
@@ -96,10 +62,6 @@ authentication:
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- - selector: 'google.iam.v1.IAMPolicy.*'
- oauth:
- canonical_scopes: |-
- https://www.googleapis.com/auth/cloud-platform
- selector: 'google.longrunning.Operations.*'
oauth:
canonical_scopes: |-
@@ -107,3 +69,10 @@ authentication:
publishing:
organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED
+ new_issue_uri: ''
+ documentation_uri: ''
+ api_short_name: ''
+ github_label: ''
+ doc_tag_prefix: ''
+ codeowner_github_teams:
+ library_settings:
diff --git a/third_party/googleapis/google/cloud/batch/v1alpha/job.proto b/third_party/googleapis/google/cloud/batch/v1alpha/job.proto
index 2271d33da..8edd462ea 100644
--- a/third_party/googleapis/google/cloud/batch/v1alpha/job.proto
+++ b/third_party/googleapis/google/cloud/batch/v1alpha/job.proto
@@ -23,7 +23,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Batch.V1Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/batch/v1alpha;batch";
+option go_package = "cloud.google.com/go/batch/apiv1alpha/batchpb;batchpb";
option java_multiple_files = true;
option java_outer_classname = "JobProto";
option java_package = "com.google.cloud.batch.v1alpha";
@@ -57,7 +57,8 @@ message Job {
string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Priority of the Job.
- // The valid value range is [0, 100).
+ // The valid value range is [0, 100). Default value is 0.
+ // Higher value indicates higher priority.
// A job with higher priority value is more likely to run earlier if all other
// requirements are satisfied.
int64 priority = 3;
@@ -96,10 +97,12 @@ message Job {
JobNotification notification = 10 [deprecated = true];
// Output only. When the Job was created.
- google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The last time the Job was updated.
- google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Log preservation policy for the Job.
LogsPolicy logs_policy = 13;
@@ -171,6 +174,9 @@ message JobStatus {
// The max number of tasks can be assigned to this instance type.
int64 task_pack = 3;
+
+ // The VM boot disk.
+ AllocationPolicy.Disk boot_disk = 4;
}
// Aggregated task status for a TaskGroup.
@@ -222,6 +228,15 @@ message JobStatus {
// The duration of time that the Job spent in status RUNNING.
google.protobuf.Duration run_duration = 5;
+
+ // The resource usage of the job.
+ ResourceUsage resource_usage = 6;
+}
+
+// ResourceUsage describes the resource usage of the job.
+message ResourceUsage {
+ // The CPU core hours that the job consumes.
+ double core_hours = 1;
}
// Notification configurations.
@@ -296,20 +311,37 @@ message AllocationPolicy {
// A data source from which a PD will be created.
oneof data_source {
// Name of a public or custom image used as the data source.
+ // For example, the following are all valid URLs:
+ // (1) Specify the image by its family name:
+ // projects/{project}/global/images/family/{image_family}
+ // (2) Specify the image version:
+ // projects/{project}/global/images/{image_version}
+ // You can also use Batch customized image in short names.
+ // The following image values are supported for a boot disk:
+ // "batch-debian": use Batch Debian images.
+ // "batch-centos": use Batch CentOS images.
+ // "batch-cos": use Batch Container-Optimized images.
string image = 4;
// Name of a snapshot used as the data source.
string snapshot = 5;
}
- // Disk type as shown in `gcloud compute disk-types list`
- // For example, "pd-ssd", "pd-standard", "pd-balanced", "local-ssd".
+ // Disk type as shown in `gcloud compute disk-types list`.
+ // For example, local SSD uses type "local-ssd".
+ // Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd"
+ // or "pd-standard".
string type = 1;
// Disk size in GB.
- // This field is ignored if `data_source` is `disk` or `image`.
- // If `type` is `local-ssd`, size_gb should be a multiple of 375GB,
+ // For persistent disk, this field is ignored if `data_source` is `image` or
+ // `snapshot`.
+ // For local SSD, size_gb should be a multiple of 375GB,
// otherwise, the final size will be the next greater multiple of 375 GB.
+ // For boot disk, Batch will calculate the boot disk size based on source
+ // image and task requirements if you do not speicify the size.
+ // If both this field and the boot_disk_mib field in task spec's
+ // compute_resource are defined, Batch will only honor this field.
int64 size_gb = 2;
// Local SSDs are available through both "SCSI" and "NVMe" interfaces.
@@ -402,10 +434,20 @@ message AllocationPolicy {
// A network interface.
message NetworkInterface {
- // The URL of the network resource.
+ // The URL of an existing network resource.
+ // 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/{network}
string network = 1;
- // The URL of the Subnetwork resource.
+ // The URL of an existing subnetwork resource in the network.
+ // You can specify the subnetwork as a full or partial URL.
+ // For example, the following are all valid URLs:
+ // https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}
+ // projects/{project}/regions/{region}/subnetworks/{subnetwork}
+ // regions/{region}/subnetworks/{subnetwork}
string subnetwork = 2;
// Default is false (with an external IP address). Required if
diff --git a/third_party/googleapis/google/cloud/batch/v1alpha/task.proto b/third_party/googleapis/google/cloud/batch/v1alpha/task.proto
index a28545ad4..389694974 100644
--- a/third_party/googleapis/google/cloud/batch/v1alpha/task.proto
+++ b/third_party/googleapis/google/cloud/batch/v1alpha/task.proto
@@ -22,7 +22,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Batch.V1Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/batch/v1alpha;batch";
+option go_package = "cloud.google.com/go/batch/apiv1alpha/batchpb;batchpb";
option java_multiple_files = true;
option java_outer_classname = "TaskProto";
option java_package = "com.google.cloud.batch.v1alpha";
@@ -60,6 +60,9 @@ message StatusEvent {
// Task Execution
TaskExecution task_execution = 4;
+
+ // Task State
+ TaskStatus.State task_state = 5;
}
// This Task Execution field includes detail information for
@@ -98,6 +101,16 @@ message TaskStatus {
// Detailed info about why the state is reached.
repeated StatusEvent status_events = 2;
+
+ // The resource usage of the task.
+ TaskResourceUsage resource_usage = 3;
+}
+
+// TaskResourceUsage describes the resource usage of the task.
+message TaskResourceUsage {
+ // The CPU core hours the task consumes based on task requirement and run
+ // time.
+ double core_hours = 1;
}
// Runnable describes instructions for executing a specific script or container
@@ -145,9 +158,23 @@ message Runnable {
message Script {
oneof command {
// Script file path on the host VM.
+ //
+ // To specify an interpreter, please add a `#!`(also known as
+ // [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
+ // first line of the file.(For example, to execute the script using bash,
+ // `#!/bin/bash` should be the first line of the file. To execute the
+ // script using`Python3`, `#!/usr/bin/env python3` should be the first
+ // line of the file.) Otherwise, the file will by default be excuted by
+ // `/bin/sh`.
string path = 1;
// Shell script text.
+ //
+ // To specify an interpreter, please add a `#!\n` at the
+ // beginning of the text.(For example, to execute the script using bash,
+ // `#!/bin/bash\n` should be added. To execute the script using`Python3`,
+ // `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
+ // by default be excuted by `/bin/sh`.
string text = 2;
}
}
@@ -228,13 +255,12 @@ message TaskSpec {
int32 max_retry_count = 5;
// Lifecycle management schema when any task in a task group is failed.
- // The valid size of lifecycle policies are [0, 10].
- // For each lifecycle policy, when the condition is met,
- // the action in that policy will execute.
- // If there are multiple policies that the task execution result matches,
- // we use the action from the first matched policy. If task execution result
- // does not meet with any of the defined lifecycle policy, we consider it as
- // the default policy. Default policy means if the exit code is 0, exit task.
+ // Currently we only support one lifecycle policy.
+ // When the lifecycle policy condition is met,
+ // the action in the policy will execute.
+ // If task execution result does not meet with the defined lifecycle
+ // policy, we consider it as the default policy.
+ // Default policy means if the exit code is 0, exit task.
// If task ends with non-zero exit code, retry the task with max_retry_count.
repeated LifecyclePolicy lifecycle_policies = 9;
@@ -273,6 +299,10 @@ message LifecyclePolicy {
}
// Action to execute when ActionCondition is true.
+ // When RETRY_TASK is specified, we will retry failed tasks
+ // if we notice any exit code match and fail tasks if no match is found.
+ // Likewise, when FAIL_TASK is specified, we will fail tasks
+ // if we notice any exit code match and retry tasks if no match is found.
Action action = 1;
// Conditions that decide why a task failure is dealt with a specific action.
diff --git a/third_party/googleapis/google/cloud/batch/v1alpha/volume.proto b/third_party/googleapis/google/cloud/batch/v1alpha/volume.proto
index 4112d2363..11ef3a8cf 100644
--- a/third_party/googleapis/google/cloud/batch/v1alpha/volume.proto
+++ b/third_party/googleapis/google/cloud/batch/v1alpha/volume.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.batch.v1alpha;
option csharp_namespace = "Google.Cloud.Batch.V1Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/batch/v1alpha;batch";
+option go_package = "cloud.google.com/go/batch/apiv1alpha/batchpb;batchpb";
option java_multiple_files = true;
option java_outer_classname = "VolumeProto";
option java_package = "com.google.cloud.batch.v1alpha";
diff --git a/third_party/googleapis/google/cloud/beyondcorp/appconnections/v1/BUILD.bazel b/third_party/googleapis/google/cloud/beyondcorp/appconnections/v1/BUILD.bazel
index f94cf2f51..81c00a9b7 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/appconnections/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/beyondcorp/appconnections/v1/BUILD.bazel
@@ -60,6 +60,7 @@ proto_library(
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
@@ -131,7 +132,7 @@ java_gapic_assembly_gradle_pkg(
go_proto_library(
name = "appconnections_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/beyondcorp/appconnections/v1",
+ importpath = "cloud.google.com/go/beyondcorp/appconnections/apiv1/appconnectionspb",
protos = [":appconnections_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -145,6 +146,7 @@ go_gapic_library(
grpc_service_config = "beyondcorp-appconnections_grpc_service_config.json",
importpath = "cloud.google.com/go/beyondcorp/appconnections/apiv1;appconnections",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "beyondcorp_v1.yaml",
deps = [
@@ -325,6 +327,7 @@ csharp_gapic_library(
grpc_service_config = "beyondcorp-appconnections_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "beyondcorp_v1.yaml",
+ transport = "grpc",
deps = [
":appconnections_csharp_grpc",
":appconnections_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/beyondcorp/appconnections/v1/app_connections_service.proto b/third_party/googleapis/google/cloud/beyondcorp/appconnections/v1/app_connections_service.proto
index 48143604a..c0db64fb5 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/appconnections/v1/app_connections_service.proto
+++ b/third_party/googleapis/google/cloud/beyondcorp/appconnections/v1/app_connections_service.proto
@@ -25,7 +25,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.BeyondCorp.AppConnections.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/beyondcorp/appconnections/v1;appconnections";
+option go_package = "cloud.google.com/go/beyondcorp/appconnections/apiv1/appconnectionspb;appconnectionspb";
option java_multiple_files = true;
option java_outer_classname = "AppConnectionsServiceProto";
option java_package = "com.google.cloud.beyondcorp.appconnections.v1";
diff --git a/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/BUILD.bazel b/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/BUILD.bazel
index f68b38aed..6e00d19b7 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/BUILD.bazel
@@ -63,6 +63,7 @@ proto_library(
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"@com_google_protobuf//:any_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
@@ -134,7 +135,7 @@ java_gapic_assembly_gradle_pkg(
go_proto_library(
name = "appconnectors_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/beyondcorp/appconnectors/v1",
+ importpath = "cloud.google.com/go/beyondcorp/appconnectors/apiv1/appconnectorspb",
protos = [":appconnectors_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -148,6 +149,7 @@ go_gapic_library(
grpc_service_config = "beyondcorp-appconnectors_grpc_service_config.json",
importpath = "cloud.google.com/go/beyondcorp/appconnectors/apiv1;appconnectors",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "beyondcorp_v1.yaml",
deps = [
@@ -329,6 +331,7 @@ csharp_gapic_library(
grpc_service_config = "beyondcorp-appconnectors_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "beyondcorp_v1.yaml",
+ transport = "grpc",
deps = [
":appconnectors_csharp_grpc",
":appconnectors_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/app_connector_instance_config.proto b/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/app_connector_instance_config.proto
index 7e183063f..21c910619 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/app_connector_instance_config.proto
+++ b/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/app_connector_instance_config.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/protobuf/any.proto";
option csharp_namespace = "Google.Cloud.BeyondCorp.AppConnectors.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/beyondcorp/appconnectors/v1;appconnectors";
+option go_package = "cloud.google.com/go/beyondcorp/appconnectors/apiv1/appconnectorspb;appconnectorspb";
option java_multiple_files = true;
option java_outer_classname = "AppConnectorInstanceConfigProto";
option java_package = "com.google.cloud.beyondcorp.appconnectors.v1";
diff --git a/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.proto b/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.proto
index 54634f867..152cccb7e 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.proto
+++ b/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.proto
@@ -27,7 +27,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.BeyondCorp.AppConnectors.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/beyondcorp/appconnectors/v1;appconnectors";
+option go_package = "cloud.google.com/go/beyondcorp/appconnectors/apiv1/appconnectorspb;appconnectorspb";
option java_multiple_files = true;
option java_outer_classname = "AppConnectorsServiceProto";
option java_package = "com.google.cloud.beyondcorp.appconnectors.v1";
diff --git a/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/resource_info.proto b/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/resource_info.proto
index d7f26d53c..0156412ad 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/resource_info.proto
+++ b/third_party/googleapis/google/cloud/beyondcorp/appconnectors/v1/resource_info.proto
@@ -21,7 +21,7 @@ import "google/protobuf/any.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.BeyondCorp.AppConnectors.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/beyondcorp/appconnectors/v1;appconnectors";
+option go_package = "cloud.google.com/go/beyondcorp/appconnectors/apiv1/appconnectorspb;appconnectorspb";
option java_multiple_files = true;
option java_outer_classname = "ResourceInfoProto";
option java_package = "com.google.cloud.beyondcorp.appconnectors.v1";
diff --git a/third_party/googleapis/google/cloud/beyondcorp/appgateways/v1/BUILD.bazel b/third_party/googleapis/google/cloud/beyondcorp/appgateways/v1/BUILD.bazel
index ecde6b52c..d8660cf38 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/appgateways/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/beyondcorp/appgateways/v1/BUILD.bazel
@@ -60,6 +60,7 @@ proto_library(
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:timestamp_proto",
],
)
@@ -130,7 +131,7 @@ java_gapic_assembly_gradle_pkg(
go_proto_library(
name = "appgateways_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/beyondcorp/appgateways/v1",
+ importpath = "cloud.google.com/go/beyondcorp/appgateways/apiv1/appgatewayspb",
protos = [":appgateways_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -144,6 +145,7 @@ go_gapic_library(
grpc_service_config = "beyondcorp-appgateways_grpc_service_config.json",
importpath = "cloud.google.com/go/beyondcorp/appgateways/apiv1;appgateways",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "beyondcorp_v1.yaml",
deps = [
@@ -324,6 +326,7 @@ csharp_gapic_library(
grpc_service_config = "beyondcorp-appgateways_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "beyondcorp_v1.yaml",
+ transport = "grpc",
deps = [
":appgateways_csharp_grpc",
":appgateways_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/beyondcorp/appgateways/v1/app_gateways_service.proto b/third_party/googleapis/google/cloud/beyondcorp/appgateways/v1/app_gateways_service.proto
index fa21383bf..6b122fab7 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/appgateways/v1/app_gateways_service.proto
+++ b/third_party/googleapis/google/cloud/beyondcorp/appgateways/v1/app_gateways_service.proto
@@ -24,7 +24,7 @@ import "google/longrunning/operations.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.BeyondCorp.AppGateways.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/beyondcorp/appgateways/v1;appgateways";
+option go_package = "cloud.google.com/go/beyondcorp/appgateways/apiv1/appgatewayspb;appgatewayspb";
option java_multiple_files = true;
option java_outer_classname = "AppGatewaysServiceProto";
option java_package = "com.google.cloud.beyondcorp.appgateways.v1";
diff --git a/third_party/googleapis/google/cloud/beyondcorp/clientconnectorservices/v1/BUILD.bazel b/third_party/googleapis/google/cloud/beyondcorp/clientconnectorservices/v1/BUILD.bazel
index 1c4df624d..d5154626f 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/clientconnectorservices/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/beyondcorp/clientconnectorservices/v1/BUILD.bazel
@@ -60,6 +60,7 @@ proto_library(
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
@@ -131,7 +132,7 @@ java_gapic_assembly_gradle_pkg(
go_proto_library(
name = "clientconnectorservices_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/beyondcorp/clientconnectorservices/v1",
+ importpath = "cloud.google.com/go/beyondcorp/clientconnectorservices/apiv1/clientconnectorservicespb",
protos = [":clientconnectorservices_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -145,6 +146,7 @@ go_gapic_library(
grpc_service_config = "beyondcorp-clientconnectorservices_grpc_service_config.json",
importpath = "cloud.google.com/go/beyondcorp/clientconnectorservices/apiv1;clientconnectorservices",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "beyondcorp_v1.yaml",
deps = [
@@ -325,6 +327,7 @@ csharp_gapic_library(
grpc_service_config = "beyondcorp-clientconnectorservices_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "beyondcorp_v1.yaml",
+ transport = "grpc",
deps = [
":clientconnectorservices_csharp_grpc",
":clientconnectorservices_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service.proto b/third_party/googleapis/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service.proto
index 87932f735..ffacd5ac1 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service.proto
+++ b/third_party/googleapis/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service.proto
@@ -25,7 +25,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.BeyondCorp.ClientConnectorServices.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/beyondcorp/clientconnectorservices/v1;clientconnectorservices";
+option go_package = "cloud.google.com/go/beyondcorp/clientconnectorservices/apiv1/clientconnectorservicespb;clientconnectorservicespb";
option java_multiple_files = true;
option java_outer_classname = "ClientConnectorServicesServiceProto";
option java_package = "com.google.cloud.beyondcorp.clientconnectorservices.v1";
diff --git a/third_party/googleapis/google/cloud/beyondcorp/clientgateways/v1/BUILD.bazel b/third_party/googleapis/google/cloud/beyondcorp/clientgateways/v1/BUILD.bazel
index 7944f2669..52e979f33 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/clientgateways/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/beyondcorp/clientgateways/v1/BUILD.bazel
@@ -60,6 +60,7 @@ proto_library(
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:timestamp_proto",
],
)
@@ -130,7 +131,7 @@ java_gapic_assembly_gradle_pkg(
go_proto_library(
name = "clientgateways_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/beyondcorp/clientgateways/v1",
+ importpath = "cloud.google.com/go/beyondcorp/clientgateways/apiv1/clientgatewayspb",
protos = [":clientgateways_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -144,6 +145,7 @@ go_gapic_library(
grpc_service_config = "beyondcorp-clientgateways_grpc_service_config.json",
importpath = "cloud.google.com/go/beyondcorp/clientgateways/apiv1;clientgateways",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "beyondcorp_v1.yaml",
deps = [
@@ -185,7 +187,7 @@ py_gapic_library(
],
rest_numeric_enums = True,
service_yaml = "beyondcorp_v1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -324,6 +326,7 @@ csharp_gapic_library(
grpc_service_config = "beyondcorp-clientgateways_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "beyondcorp_v1.yaml",
+ transport = "grpc",
deps = [
":clientgateways_csharp_grpc",
":clientgateways_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.proto b/third_party/googleapis/google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.proto
index 8ce25bb1e..23cf54ceb 100644
--- a/third_party/googleapis/google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.proto
+++ b/third_party/googleapis/google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.proto
@@ -24,7 +24,7 @@ import "google/longrunning/operations.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.BeyondCorp.ClientGateways.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/beyondcorp/clientgateways/v1;clientgateways";
+option go_package = "cloud.google.com/go/beyondcorp/clientgateways/apiv1/clientgatewayspb;clientgatewayspb";
option java_multiple_files = true;
option java_outer_classname = "ClientGatewaysServiceProto";
option java_package = "com.google.cloud.beyondcorp.clientgateways.v1";
diff --git a/third_party/googleapis/google/cloud/bigquery/analyticshub/v1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/analyticshub/v1/BUILD.bazel
index b734e7f4c..28ef70265 100644
--- a/third_party/googleapis/google/cloud/bigquery/analyticshub/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/analyticshub/v1/BUILD.bazel
@@ -122,7 +122,7 @@ load(
go_proto_library(
name = "analyticshub_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/analyticshub/v1",
+ importpath = "cloud.google.com/go/bigquery/analyticshub/apiv1/analyticshubpb",
protos = [":analyticshub_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -136,9 +136,10 @@ go_gapic_library(
grpc_service_config = "analyticshub_v1_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/analyticshub/apiv1;analyticshub",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = False,
service_yaml = "analyticshub_v1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
":analyticshub_go_proto",
"//google/iam/v1:iam_go_proto",
@@ -266,7 +267,7 @@ nodejs_gapic_library(
package = "google.cloud.bigquery.analyticshub.v1",
rest_numeric_enums = False,
service_yaml = "analyticshub_v1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
diff --git a/third_party/googleapis/google/cloud/bigquery/analyticshub/v1/analyticshub.proto b/third_party/googleapis/google/cloud/bigquery/analyticshub/v1/analyticshub.proto
index 7adf65844..bd1882a69 100644
--- a/third_party/googleapis/google/cloud/bigquery/analyticshub/v1/analyticshub.proto
+++ b/third_party/googleapis/google/cloud/bigquery/analyticshub/v1/analyticshub.proto
@@ -27,7 +27,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.BigQuery.AnalyticsHub.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/analyticshub/v1;analyticshub";
+option go_package = "cloud.google.com/go/bigquery/analyticshub/apiv1/analyticshubpb;analyticshubpb";
option java_multiple_files = true;
option java_outer_classname = "AnalyticsHubProto";
option java_package = "com.google.cloud.bigquery.analyticshub.v1";
diff --git a/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/BUILD.bazel
new file mode 100644
index 000000000..091949547
--- /dev/null
+++ b/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/BUILD.bazel
@@ -0,0 +1,384 @@
+# This file was automatically generated by BuildFileGenerator
+# https://github.com/googleapis/rules_gapic/tree/master/bazel
+
+# Most of the manual changes to this file will be overwritten.
+# It's **only** allowed to change the following rule attribute values:
+# - names of *_gapic_assembly_* rules
+# - certain parameters of *_gapic_library rules, including but not limited to:
+# * extra_protoc_parameters
+# * extra_protoc_file_parameters
+# The complete list of preserved parameters can be found in the source code.
+
+# This is an API workspace, having public visibility by default makes perfect sense.
+package(default_visibility = ["//visibility:public"])
+
+##############################################################################
+# Common
+##############################################################################
+load("@rules_proto//proto:defs.bzl", "proto_library")
+load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
+
+proto_library(
+ name = "biglake_proto",
+ srcs = [
+ "metastore.proto",
+ ],
+ deps = [
+ "//google/api:annotations_proto",
+ "//google/api:client_proto",
+ "//google/api:field_behavior_proto",
+ "//google/api:resource_proto",
+ "@com_google_protobuf//:empty_proto",
+ "@com_google_protobuf//:field_mask_proto",
+ "@com_google_protobuf//:timestamp_proto",
+ ],
+)
+
+proto_library_with_info(
+ name = "biglake_proto_with_info",
+ deps = [
+ ":biglake_proto",
+ "//google/cloud:common_resources_proto",
+ ],
+)
+
+##############################################################################
+# Java
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "java_gapic_assembly_gradle_pkg",
+ "java_gapic_library",
+ "java_gapic_test",
+ "java_grpc_library",
+ "java_proto_library",
+)
+
+java_proto_library(
+ name = "biglake_java_proto",
+ deps = [":biglake_proto"],
+)
+
+java_grpc_library(
+ name = "biglake_java_grpc",
+ srcs = [":biglake_proto"],
+ deps = [":biglake_java_proto"],
+)
+
+java_gapic_library(
+ name = "biglake_java_gapic",
+ srcs = [":biglake_proto_with_info"],
+ gapic_yaml = None,
+ grpc_service_config = "biglake_v1alpha1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "biglake_v1alpha1.yaml",
+ test_deps = [
+ ":biglake_java_grpc",
+ ],
+ transport = "grpc+rest",
+ deps = [
+ ":biglake_java_proto",
+ "//google/api:api_java_proto",
+ ],
+)
+
+java_gapic_test(
+ name = "biglake_java_gapic_test_suite",
+ test_classes = [
+ "com.google.cloud.bigquery.biglake.v1alpha1.MetastoreServiceClientHttpJsonTest",
+ "com.google.cloud.bigquery.biglake.v1alpha1.MetastoreServiceClientTest",
+ ],
+ runtime_deps = [":biglake_java_gapic_test"],
+)
+
+# Open Source Packages
+java_gapic_assembly_gradle_pkg(
+ name = "google-cloud-bigquery-biglake-v1alpha1-java",
+ include_samples = True,
+ transport = "grpc+rest",
+ deps = [
+ ":biglake_java_gapic",
+ ":biglake_java_grpc",
+ ":biglake_java_proto",
+ ":biglake_proto",
+ ],
+)
+
+##############################################################################
+# Go
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "go_gapic_assembly_pkg",
+ "go_gapic_library",
+ "go_proto_library",
+ "go_test",
+)
+
+go_proto_library(
+ name = "biglake_go_proto",
+ compilers = ["@io_bazel_rules_go//proto:go_grpc"],
+ importpath = "cloud.google.com/go/bigquery/biglake/apiv1alpha1/biglakepb",
+ protos = [":biglake_proto"],
+ deps = [
+ "//google/api:annotations_go_proto",
+ ],
+)
+
+go_gapic_library(
+ name = "biglake_go_gapic",
+ srcs = [":biglake_proto_with_info"],
+ grpc_service_config = "biglake_v1alpha1_grpc_service_config.json",
+ importpath = "cloud.google.com/go/bigquery/biglake/apiv1alpha1;biglake",
+ metadata = True,
+ release_level = "beta",
+ rest_numeric_enums = True,
+ service_yaml = "biglake_v1alpha1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":biglake_go_proto",
+ ],
+)
+
+go_test(
+ name = "biglake_go_gapic_test",
+ srcs = [":biglake_go_gapic_srcjar_test"],
+ embed = [":biglake_go_gapic"],
+ importpath = "cloud.google.com/go/bigquery/biglake/apiv1alpha1",
+)
+
+# Open Source Packages
+go_gapic_assembly_pkg(
+ name = "gapi-cloud-bigquery-biglake-v1alpha1-go",
+ deps = [
+ ":biglake_go_gapic",
+ ":biglake_go_gapic_srcjar-metadata.srcjar",
+ ":biglake_go_gapic_srcjar-test.srcjar",
+ ":biglake_go_proto",
+ ],
+)
+
+##############################################################################
+# Python
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "py_gapic_assembly_pkg",
+ "py_gapic_library",
+ "py_test",
+)
+
+py_gapic_library(
+ name = "biglake_py_gapic",
+ srcs = [":biglake_proto"],
+ grpc_service_config = "biglake_v1alpha1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "biglake_v1alpha1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ],
+)
+
+py_test(
+ name = "biglake_py_gapic_test",
+ srcs = [
+ "biglake_py_gapic_pytest.py",
+ "biglake_py_gapic_test.py",
+ ],
+ legacy_create_init = False,
+ deps = [":biglake_py_gapic"],
+)
+
+# Open Source Packages
+py_gapic_assembly_pkg(
+ name = "bigquery-biglake-v1alpha1-py",
+ deps = [
+ ":biglake_py_gapic",
+ ],
+)
+
+##############################################################################
+# PHP
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "php_gapic_assembly_pkg",
+ "php_gapic_library",
+ "php_grpc_library",
+ "php_proto_library",
+)
+
+php_proto_library(
+ name = "biglake_php_proto",
+ deps = [":biglake_proto"],
+)
+
+php_grpc_library(
+ name = "biglake_php_grpc",
+ srcs = [":biglake_proto"],
+ deps = [":biglake_php_proto"],
+)
+
+php_gapic_library(
+ name = "biglake_php_gapic",
+ srcs = [":biglake_proto_with_info"],
+ grpc_service_config = "biglake_v1alpha1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "biglake_v1alpha1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":biglake_php_grpc",
+ ":biglake_php_proto",
+ ],
+)
+
+# Open Source Packages
+php_gapic_assembly_pkg(
+ name = "google-cloud-bigquery-biglake-v1alpha1-php",
+ deps = [
+ ":biglake_php_gapic",
+ ":biglake_php_grpc",
+ ":biglake_php_proto",
+ ],
+)
+
+##############################################################################
+# Node.js
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "nodejs_gapic_assembly_pkg",
+ "nodejs_gapic_library",
+)
+
+nodejs_gapic_library(
+ name = "biglake_nodejs_gapic",
+ package_name = "@google-cloud/biglake",
+ src = ":biglake_proto_with_info",
+ extra_protoc_parameters = ["metadata"],
+ grpc_service_config = "biglake_v1alpha1_grpc_service_config.json",
+ package = "google.cloud.bigquery.biglake.v1alpha1",
+ rest_numeric_enums = True,
+ service_yaml = "biglake_v1alpha1.yaml",
+ transport = "grpc+rest",
+ deps = [],
+)
+
+nodejs_gapic_assembly_pkg(
+ name = "bigquery-biglake-v1alpha1-nodejs",
+ deps = [
+ ":biglake_nodejs_gapic",
+ ":biglake_proto",
+ ],
+)
+
+##############################################################################
+# Ruby
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "ruby_cloud_gapic_library",
+ "ruby_gapic_assembly_pkg",
+ "ruby_grpc_library",
+ "ruby_proto_library",
+)
+
+ruby_proto_library(
+ name = "biglake_ruby_proto",
+ deps = [":biglake_proto"],
+)
+
+ruby_grpc_library(
+ name = "biglake_ruby_grpc",
+ srcs = [":biglake_proto"],
+ deps = [":biglake_ruby_proto"],
+)
+
+ruby_cloud_gapic_library(
+ name = "biglake_ruby_gapic",
+ srcs = [":biglake_proto_with_info"],
+ extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-bigquery-biglake-v1alpha1"],
+ grpc_service_config = "biglake_v1alpha1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "biglake_v1alpha1.yaml",
+ deps = [
+ ":biglake_ruby_grpc",
+ ":biglake_ruby_proto",
+ ],
+)
+
+# Open Source Packages
+ruby_gapic_assembly_pkg(
+ name = "google-cloud-bigquery-biglake-v1alpha1-ruby",
+ deps = [
+ ":biglake_ruby_gapic",
+ ":biglake_ruby_grpc",
+ ":biglake_ruby_proto",
+ ],
+)
+
+##############################################################################
+# C#
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "csharp_gapic_assembly_pkg",
+ "csharp_gapic_library",
+ "csharp_grpc_library",
+ "csharp_proto_library",
+)
+
+csharp_proto_library(
+ name = "biglake_csharp_proto",
+ deps = [":biglake_proto"],
+)
+
+csharp_grpc_library(
+ name = "biglake_csharp_grpc",
+ srcs = [":biglake_proto"],
+ deps = [":biglake_csharp_proto"],
+)
+
+csharp_gapic_library(
+ name = "biglake_csharp_gapic",
+ srcs = [":biglake_proto_with_info"],
+ common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
+ grpc_service_config = "biglake_v1alpha1_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "biglake_v1alpha1.yaml",
+ deps = [
+ ":biglake_csharp_grpc",
+ ":biglake_csharp_proto",
+ ],
+)
+
+# Open Source Packages
+csharp_gapic_assembly_pkg(
+ name = "google-cloud-bigquery-biglake-v1alpha1-csharp",
+ deps = [
+ ":biglake_csharp_gapic",
+ ":biglake_csharp_grpc",
+ ":biglake_csharp_proto",
+ ],
+)
+
+##############################################################################
+# C++
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "cc_grpc_library",
+ "cc_proto_library",
+)
+
+cc_proto_library(
+ name = "biglake_cc_proto",
+ deps = [":biglake_proto"],
+)
+
+cc_grpc_library(
+ name = "biglake_cc_grpc",
+ srcs = [":biglake_proto"],
+ grpc_only = True,
+ deps = [":biglake_cc_proto"],
+)
diff --git a/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/biglake_v1alpha1.yaml b/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/biglake_v1alpha1.yaml
new file mode 100644
index 000000000..da0fbaba4
--- /dev/null
+++ b/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/biglake_v1alpha1.yaml
@@ -0,0 +1,26 @@
+type: google.api.Service
+config_version: 3
+name: biglake.googleapis.com
+title: BigLake API
+
+apis:
+- name: google.cloud.bigquery.biglake.v1alpha1.MetastoreService
+
+documentation:
+ summary: |-
+ The BigLake API provides access to BigLake Metastore, a serverless, fully
+ managed, and highly available metastore for open-source data that can be
+ used for querying Apache Iceberg tables in BigQuery.
+
+backend:
+ rules:
+ - selector: 'google.cloud.bigquery.biglake.v1alpha1.MetastoreService.*'
+ deadline: 60.0
+
+authentication:
+ rules:
+ - selector: 'google.cloud.bigquery.biglake.v1alpha1.MetastoreService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/bigquery,
+ https://www.googleapis.com/auth/cloud-platform
diff --git a/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/biglake_v1alpha1_grpc_service_config.json b/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/biglake_v1alpha1_grpc_service_config.json
new file mode 100644
index 000000000..10b0b501b
--- /dev/null
+++ b/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/biglake_v1alpha1_grpc_service_config.json
@@ -0,0 +1,22 @@
+{
+ "methodConfig": [
+ {
+ "name": [
+ {
+ "service": "google.cloud.bigquery.biglake.v1alpha1.MetastoreService"
+ }
+ ],
+ "timeout": "60s",
+ "retryPolicy": {
+ "maxAttempts": 5,
+ "initialBackoff": "1s",
+ "maxBackoff": "10s",
+ "backoffMultiplier": 1.3,
+ "retryableStatusCodes": [
+ "DEADLINE_EXCEEDED",
+ "UNAVAILABLE"
+ ]
+ }
+ }
+ ]
+}
diff --git a/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/metastore.proto b/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/metastore.proto
new file mode 100644
index 000000000..7f6b67596
--- /dev/null
+++ b/third_party/googleapis/google/cloud/bigquery/biglake/v1alpha1/metastore.proto
@@ -0,0 +1,782 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.bigquery.biglake.v1alpha1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "cloud.google.com/go/bigquery/biglake/apiv1alpha1/biglakepb;biglakepb";
+option java_multiple_files = true;
+option java_outer_classname = "MetastoreProto";
+option java_package = "com.google.cloud.bigquery.biglake.v1alpha1";
+
+// BigLake Metastore is a serverless, highly available, multi-tenant runtime
+// metastore for Google Cloud Data Analytics products.
+//
+// The BigLake Metastore API defines the following resource model:
+//
+// * A collection of Google Cloud projects: `/projects/*`
+// * Each project has a collection of available locations: `/locations/*`
+// * Each location has a collection of catalogs: `/catalogs/*`
+// * Each catalog has a collection of databases: `/databases/*`
+// * Each database has a collection of tables: `/tables/*`
+service MetastoreService {
+ option (google.api.default_host) = "biglake.googleapis.com";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/bigquery,"
+ "https://www.googleapis.com/auth/cloud-platform";
+
+ // Creates a new catalog.
+ rpc CreateCatalog(CreateCatalogRequest) returns (Catalog) {
+ option (google.api.http) = {
+ post: "/v1alpha1/{parent=projects/*/locations/*}/catalogs"
+ body: "catalog"
+ };
+ option (google.api.method_signature) = "parent,catalog,catalog_id";
+ }
+
+ // Deletes an existing catalog specified by the catalog ID.
+ rpc DeleteCatalog(DeleteCatalogRequest) returns (Catalog) {
+ option (google.api.http) = {
+ delete: "/v1alpha1/{name=projects/*/locations/*/catalogs/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Gets the catalog specified by the resource name.
+ rpc GetCatalog(GetCatalogRequest) returns (Catalog) {
+ option (google.api.http) = {
+ get: "/v1alpha1/{name=projects/*/locations/*/catalogs/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // List all catalogs in a specified project.
+ rpc ListCatalogs(ListCatalogsRequest) returns (ListCatalogsResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha1/{parent=projects/*/locations/*}/catalogs"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Creates a new database.
+ rpc CreateDatabase(CreateDatabaseRequest) returns (Database) {
+ option (google.api.http) = {
+ post: "/v1alpha1/{parent=projects/*/locations/*/catalogs/*}/databases"
+ body: "database"
+ };
+ option (google.api.method_signature) = "parent,database,database_id";
+ }
+
+ // Deletes an existing database specified by the database ID.
+ rpc DeleteDatabase(DeleteDatabaseRequest) returns (Database) {
+ option (google.api.http) = {
+ delete: "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Updates an existing database specified by the database ID.
+ rpc UpdateDatabase(UpdateDatabaseRequest) returns (Database) {
+ option (google.api.http) = {
+ patch: "/v1alpha1/{database.name=projects/*/locations/*/catalogs/*/databases/*}"
+ body: "database"
+ };
+ option (google.api.method_signature) = "database,update_mask";
+ }
+
+ // Gets the database specified by the resource name.
+ rpc GetDatabase(GetDatabaseRequest) returns (Database) {
+ option (google.api.http) = {
+ get: "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // List all databases in a specified catalog.
+ rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha1/{parent=projects/*/locations/*/catalogs/*}/databases"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Creates a new table.
+ rpc CreateTable(CreateTableRequest) returns (Table) {
+ option (google.api.http) = {
+ post: "/v1alpha1/{parent=projects/*/locations/*/catalogs/*/databases/*}/tables"
+ body: "table"
+ };
+ option (google.api.method_signature) = "parent,table,table_id";
+ }
+
+ // Deletes an existing table specified by the table ID.
+ rpc DeleteTable(DeleteTableRequest) returns (Table) {
+ option (google.api.http) = {
+ delete: "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*/tables/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Updates an existing table specified by the table ID.
+ rpc UpdateTable(UpdateTableRequest) returns (Table) {
+ option (google.api.http) = {
+ patch: "/v1alpha1/{table.name=projects/*/locations/*/catalogs/*/databases/*/tables/*}"
+ body: "table"
+ };
+ option (google.api.method_signature) = "table,update_mask";
+ }
+
+ // Gets the table specified by the resource name.
+ rpc GetTable(GetTableRequest) returns (Table) {
+ option (google.api.http) = {
+ get: "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*/tables/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // List all tables in a specified database.
+ rpc ListTables(ListTablesRequest) returns (ListTablesResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha1/{parent=projects/*/locations/*/catalogs/*/databases/*}/tables"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Creates a new lock.
+ rpc CreateLock(CreateLockRequest) returns (Lock) {
+ option (google.api.http) = {
+ post: "/v1alpha1/{parent=projects/*/locations/*/catalogs/*/databases/*}/locks"
+ body: "lock"
+ };
+ option (google.api.method_signature) = "parent,lock";
+ }
+
+ // Deletes an existing lock specified by the lock ID.
+ rpc DeleteLock(DeleteLockRequest) returns (google.protobuf.Empty) {
+ option (google.api.http) = {
+ delete: "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*/locks/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Checks the state of a lock specified by the lock ID.
+ rpc CheckLock(CheckLockRequest) returns (Lock) {
+ option (google.api.http) = {
+ post: "/v1alpha1/{name=projects/*/locations/*/catalogs/*/databases/*/locks/*}:check"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // List all locks in a specified database.
+ rpc ListLocks(ListLocksRequest) returns (ListLocksResponse) {
+ option (google.api.http) = {
+ get: "/v1alpha1/{parent=projects/*/locations/*/catalogs/*/databases/*}/locks"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+}
+
+// Catalog is the container of databases.
+message Catalog {
+ option (google.api.resource) = {
+ type: "biglake.googleapis.com/Catalog"
+ pattern: "projects/{project}/locations/{location}/catalogs/{catalog}"
+ };
+
+ // Output only. The resource name.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
+ string name = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = { type: "biglake.googleapis.com/Catalog" }
+ ];
+
+ // Output only. The creation time of the catalog.
+ google.protobuf.Timestamp create_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The last modification time of the catalog.
+ google.protobuf.Timestamp update_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The deletion time of the catalog. Only set after the catalog
+ // is deleted.
+ google.protobuf.Timestamp delete_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time when this catalog is considered expired. Only set
+ // after the catalog is deleted.
+ google.protobuf.Timestamp expire_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Database is the container of tables.
+message Database {
+ option (google.api.resource) = {
+ type: "biglake.googleapis.com/Database"
+ pattern: "projects/{project}/locations/{location}/catalogs/{catalog}/databases/{database}"
+ };
+
+ // The database type.
+ enum Type {
+ // The type is not specified.
+ TYPE_UNSPECIFIED = 0;
+
+ // Represents a database storing tables compatible with Hive Metastore
+ // tables.
+ HIVE = 1;
+ }
+
+ // Options specified for the database type.
+ oneof options {
+ // Options of a Hive database.
+ HiveDatabaseOptions hive_options = 7;
+ }
+
+ // Output only. The resource name.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
+ string name = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = {
+ type: "biglake.googleapis.com/Database"
+ }
+ ];
+
+ // Output only. The creation time of the database.
+ google.protobuf.Timestamp create_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The last modification time of the database.
+ google.protobuf.Timestamp update_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The deletion time of the database. Only set after the database
+ // is deleted.
+ google.protobuf.Timestamp delete_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time when this database is considered expired. Only set
+ // after the database is deleted.
+ google.protobuf.Timestamp expire_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The database type.
+ Type type = 6;
+}
+
+// Represents a table.
+message Table {
+ option (google.api.resource) = {
+ type: "biglake.googleapis.com/Table"
+ pattern: "projects/{project}/locations/{location}/catalogs/{catalog}/databases/{database}/tables/{table}"
+ };
+
+ // The table type.
+ enum Type {
+ // The type is not specified.
+ TYPE_UNSPECIFIED = 0;
+
+ // Represents a table compatible with Hive Metastore tables.
+ HIVE = 1;
+ }
+
+ // Options specified for the table type.
+ oneof options {
+ // Options of a Hive table.
+ HiveTableOptions hive_options = 7;
+ }
+
+ // Output only. The resource name.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
+ string name = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = { type: "biglake.googleapis.com/Table" }
+ ];
+
+ // Output only. The creation time of the table.
+ google.protobuf.Timestamp create_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The last modification time of the table.
+ google.protobuf.Timestamp update_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The deletion time of the table. Only set after the table is
+ // deleted.
+ google.protobuf.Timestamp delete_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time when this table is considered expired. Only set after
+ // the table is deleted.
+ google.protobuf.Timestamp expire_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The table type.
+ Type type = 6;
+}
+
+// Represents a lock.
+message Lock {
+ option (google.api.resource) = {
+ type: "biglake.googleapis.com/Lock"
+ pattern: "projects/{project}/locations/{location}/catalogs/{catalog}/databases/{database}/locks/{lock}"
+ };
+
+ // The lock type.
+ enum Type {
+ // The type is not specified.
+ TYPE_UNSPECIFIED = 0;
+
+ // An exclusive lock prevents another lock from being created on the same
+ // resource.
+ EXCLUSIVE = 1;
+ }
+
+ // The lock state.
+ enum State {
+ // The state is not specified.
+ STATE_UNSPECIFIED = 0;
+
+ // Waiting to acquire the lock.
+ WAITING = 1;
+
+ // The lock has been acquired.
+ ACQUIRED = 2;
+ }
+
+ // The resource that the lock will be created on.
+ oneof resources {
+ // The table ID (not fully qualified name) in the same database that the
+ // lock will be created on. The table must exist.
+ string table_id = 5;
+ }
+
+ // Output only. The resource name.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/locks/{lock_id}
+ string name = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.resource_reference) = { type: "biglake.googleapis.com/Lock" }
+ ];
+
+ // Output only. The creation time of the lock.
+ google.protobuf.Timestamp create_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The lock type.
+ Type type = 3;
+
+ // Output only. The lock state.
+ State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Request message for the CreateCatalog method.
+message CreateCatalogRequest {
+ // Required. The parent resource where this catalog will be created.
+ // Format: projects/{project_id_or_number}/locations/{location_id}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "locations.googleapis.com/Location"
+ }
+ ];
+
+ // Required. The catalog to create.
+ // The `name` field does not need to be provided.
+ Catalog catalog = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The ID to use for the catalog, which will become the final
+ // component of the catalog's resource name.
+ string catalog_id = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for the DeleteCatalog method.
+message DeleteCatalogRequest {
+ // Required. The name of the catalog to delete.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "biglake.googleapis.com/Catalog" }
+ ];
+}
+
+// Request message for the GetCatalog method.
+message GetCatalogRequest {
+ // Required. The name of the catalog to retrieve.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "biglake.googleapis.com/Catalog" }
+ ];
+}
+
+// Request message for the ListCatalogs method.
+message ListCatalogsRequest {
+ // Required. The parent, which owns this collection of catalogs.
+ // Format: projects/{project_id_or_number}/locations/{location_id}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "locations.googleapis.com/Location"
+ }
+ ];
+
+ // The maximum number of catalogs to return. The service may return fewer than
+ // this value.
+ // If unspecified, at most 50 catalogs will be returned.
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
+ int32 page_size = 2;
+
+ // A page token, received from a previous `ListCatalogs` call.
+ // Provide this to retrieve the subsequent page.
+ //
+ // When paginating, all other parameters provided to `ListCatalogs` must match
+ // the call that provided the page token.
+ string page_token = 3;
+}
+
+// Response message for the ListCatalogs method.
+message ListCatalogsResponse {
+ // The catalogs from the specified project.
+ repeated Catalog catalogs = 1;
+
+ // A token, which can be sent as `page_token` to retrieve the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
+}
+
+// Request message for the CreateDatabase method.
+message CreateDatabaseRequest {
+ // Required. The parent resource where this database will be created.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "biglake.googleapis.com/Catalog" }
+ ];
+
+ // Required. The database to create.
+ // The `name` field does not need to be provided.
+ Database database = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The ID to use for the database, which will become the final
+ // component of the database's resource name.
+ string database_id = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for the DeleteDatabase method.
+message DeleteDatabaseRequest {
+ // Required. The name of the database to delete.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "biglake.googleapis.com/Database"
+ }
+ ];
+}
+
+// Request message for the UpdateDatabase method.
+message UpdateDatabaseRequest {
+ // Required. The database to update.
+ //
+ // The database's `name` field is used to identify the database to update.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
+ Database database = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // The list of fields to update.
+ //
+ // For the `FieldMask` definition, see
+ // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
+ // If not set, defaults to all of the fields that are allowed to update.
+ google.protobuf.FieldMask update_mask = 2;
+}
+
+// Request message for the GetDatabase method.
+message GetDatabaseRequest {
+ // Required. The name of the database to retrieve.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "biglake.googleapis.com/Database"
+ }
+ ];
+}
+
+// Request message for the ListDatabases method.
+message ListDatabasesRequest {
+ // Required. The parent, which owns this collection of databases.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "biglake.googleapis.com/Catalog" }
+ ];
+
+ // The maximum number of databases to return. The service may return fewer
+ // than this value.
+ // If unspecified, at most 50 databases will be returned.
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
+ int32 page_size = 2;
+
+ // A page token, received from a previous `ListDatabases` call.
+ // Provide this to retrieve the subsequent page.
+ //
+ // When paginating, all other parameters provided to `ListDatabases` must
+ // match the call that provided the page token.
+ string page_token = 3;
+}
+
+// Response message for the ListDatabases method.
+message ListDatabasesResponse {
+ // The databases from the specified catalog.
+ repeated Database databases = 1;
+
+ // A token, which can be sent as `page_token` to retrieve the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
+}
+
+// Request message for the CreateTable method.
+message CreateTableRequest {
+ // Required. The parent resource where this table will be created.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "biglake.googleapis.com/Database"
+ }
+ ];
+
+ // Required. The table to create. The `name` field does not need to be
+ // provided for the table creation.
+ Table table = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. The ID to use for the table, which will become the final
+ // component of the table's resource name.
+ string table_id = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for the DeleteTable method.
+message DeleteTableRequest {
+ // Required. The name of the table to delete.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "biglake.googleapis.com/Table" }
+ ];
+}
+
+// Request message for the UpdateTable method.
+message UpdateTableRequest {
+ // Required. The table to update.
+ //
+ // The table's `name` field is used to identify the database to update.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
+ Table table = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // The list of fields to update.
+ //
+ // For the `FieldMask` definition, see
+ // https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
+ // If not set, defaults to all of the fields that are allowed to update.
+ google.protobuf.FieldMask update_mask = 2;
+}
+
+// Request message for the GetTable method.
+message GetTableRequest {
+ // Required. The name of the table to retrieve.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "biglake.googleapis.com/Table" }
+ ];
+}
+
+// Request message for the ListTables method.
+message ListTablesRequest {
+ // Required. The parent, which owns this collection of tables.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "biglake.googleapis.com/Database"
+ }
+ ];
+
+ // The maximum number of tables to return. The service may return fewer than
+ // this value.
+ // If unspecified, at most 50 tables will be returned.
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
+ int32 page_size = 2;
+
+ // A page token, received from a previous `ListTables` call.
+ // Provide this to retrieve the subsequent page.
+ //
+ // When paginating, all other parameters provided to `ListTables` must match
+ // the call that provided the page token.
+ string page_token = 3;
+}
+
+// Response message for the ListTables method.
+message ListTablesResponse {
+ // The tables from the specified database.
+ repeated Table tables = 1;
+
+ // A token, which can be sent as `page_token` to retrieve the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
+}
+
+// Request message for the CreateLock method.
+message CreateLockRequest {
+ // Required. The parent resource where this lock will be created.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "biglake.googleapis.com/Database"
+ }
+ ];
+
+ // Required. The lock to create. The `name` field does not need to be provided
+ // for the lock creation.
+ Lock lock = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for the DeleteLock method.
+message DeleteLockRequest {
+ // Required. The name of the lock to delete.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/locks/{lock_id}
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "biglake.googleapis.com/Lock" }
+ ];
+}
+
+// Request message for the CheckLock method.
+message CheckLockRequest {
+ // Required. The name of the lock to check.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/locks/{lock_id}
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "biglake.googleapis.com/Lock" }
+ ];
+}
+
+// Request message for the ListLocks method.
+message ListLocksRequest {
+ // Required. The parent, which owns this collection of locks.
+ // Format:
+ // projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "biglake.googleapis.com/Database"
+ }
+ ];
+
+ // The maximum number of locks to return. The service may return fewer than
+ // this value.
+ // If unspecified, at most 50 locks will be returned.
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
+ int32 page_size = 2;
+
+ // A page token, received from a previous `ListLocks` call.
+ // Provide this to retrieve the subsequent page.
+ //
+ // When paginating, all other parameters provided to `ListLocks` must match
+ // the call that provided the page token.
+ string page_token = 3;
+}
+
+// Response message for the ListLocks method.
+message ListLocksResponse {
+ // The locks from the specified database.
+ repeated Lock locks = 1;
+
+ // A token, which can be sent as `page_token` to retrieve the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
+}
+
+// Options of a Hive database.
+message HiveDatabaseOptions {
+ // Cloud Storage folder URI where the database data is stored, starting with
+ // "gs://".
+ string location_uri = 1;
+
+ // Stores user supplied Hive database parameters.
+ map parameters = 2;
+}
+
+// Options of a Hive table.
+message HiveTableOptions {
+ // Serializer and deserializer information.
+ message SerDeInfo {
+ // The fully qualified Java class name of the serialization library.
+ string serialization_lib = 1;
+ }
+
+ // Stores physical storage information of the data.
+ message StorageDescriptor {
+ // Cloud Storage folder URI where the table data is stored, starting with
+ // "gs://".
+ string location_uri = 1;
+
+ // The fully qualified Java class name of the input format.
+ string input_format = 2;
+
+ // The fully qualified Java class name of the output format.
+ string output_format = 3;
+
+ // Serializer and deserializer information.
+ SerDeInfo serde_info = 4;
+ }
+
+ // Stores user supplied Hive table parameters.
+ map parameters = 1;
+
+ // Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
+ string table_type = 2;
+
+ // Stores physical storage information of the data.
+ StorageDescriptor storage_descriptor = 3;
+}
diff --git a/third_party/googleapis/google/cloud/bigquery/connection/v1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/connection/v1/BUILD.bazel
index 95bac03b2..29d455ef7 100644
--- a/third_party/googleapis/google/cloud/bigquery/connection/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/connection/v1/BUILD.bazel
@@ -111,7 +111,7 @@ load(
go_proto_library(
name = "connection_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1",
+ importpath = "cloud.google.com/go/bigquery/connection/apiv1/connectionpb",
protos = [":connection_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -124,6 +124,8 @@ go_gapic_library(
srcs = [":connection_proto_with_info"],
grpc_service_config = "bigqueryconnection_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/connection/apiv1;connection",
+ metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "bigqueryconnection_v1.yaml",
transport = "grpc+rest",
@@ -169,7 +171,8 @@ py_gapic_library(
"python-gapic-name=bigquery_connection",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "bigqueryconnection_v1.yaml",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -220,6 +223,7 @@ php_gapic_library(
srcs = [":connection_proto_with_info"],
grpc_service_config = "bigqueryconnection_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "bigqueryconnection_v1.yaml",
transport = "grpc+rest",
deps = [
":connection_php_grpc",
@@ -304,6 +308,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "The BigQuery Connection API allows users to manage BigQuery connections to external data sources.",
ruby_cloud_title = "BigQuery Connection V1",
+ service_yaml = "bigqueryconnection_v1.yaml",
deps = [
":connection_ruby_grpc",
":connection_ruby_proto",
@@ -349,6 +354,7 @@ csharp_gapic_library(
grpc_service_config = "bigqueryconnection_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "bigqueryconnection_v1.yaml",
+ transport = "grpc+rest",
deps = [
":connection_csharp_grpc",
":connection_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/connection/v1/connection.proto b/third_party/googleapis/google/cloud/bigquery/connection/v1/connection.proto
index ee0dba14a..6ab5a8b54 100644
--- a/third_party/googleapis/google/cloud/bigquery/connection/v1/connection.proto
+++ b/third_party/googleapis/google/cloud/bigquery/connection/v1/connection.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Connection.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1;connection";
+option go_package = "cloud.google.com/go/bigquery/connection/apiv1/connectionpb;connectionpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.bigquery.connection.v1";
option php_namespace = "Google\\Cloud\\BigQuery\\Connection\\V1";
@@ -56,7 +56,8 @@ service ConnectionService {
}
// Returns a list of connections in the given project.
- rpc ListConnections(ListConnectionsRequest) returns (ListConnectionsResponse) {
+ rpc ListConnections(ListConnectionsRequest)
+ returns (ListConnectionsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/connections"
};
@@ -74,7 +75,8 @@ service ConnectionService {
}
// Deletes connection and associated credential.
- rpc DeleteConnection(DeleteConnectionRequest) returns (google.protobuf.Empty) {
+ rpc DeleteConnection(DeleteConnectionRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/connections/*}"
};
@@ -84,7 +86,8 @@ service ConnectionService {
// Gets the access control policy for a resource.
// Returns an empty policy if the resource exists and does not have a policy
// set.
- rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) {
+ rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
+ returns (google.iam.v1.Policy) {
option (google.api.http) = {
post: "/v1/{resource=projects/*/locations/*/connections/*}:getIamPolicy"
body: "*"
@@ -96,7 +99,8 @@ service ConnectionService {
// existing policy.
//
// Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
- rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) {
+ rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
+ returns (google.iam.v1.Policy) {
option (google.api.http) = {
post: "/v1/{resource=projects/*/locations/*/connections/*}:setIamPolicy"
body: "*"
@@ -111,7 +115,8 @@ service ConnectionService {
// 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.
- rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) {
+ rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
+ returns (google.iam.v1.TestIamPermissionsResponse) {
option (google.api.http) = {
post: "/v1/{resource=projects/*/locations/*/connections/*}:testIamPermissions"
body: "*"
@@ -120,7 +125,8 @@ service ConnectionService {
}
}
-// The request for [ConnectionService.CreateConnection][google.cloud.bigquery.connection.v1.ConnectionService.CreateConnection].
+// The request for
+// [ConnectionService.CreateConnection][google.cloud.bigquery.connection.v1.ConnectionService.CreateConnection].
message CreateConnectionRequest {
// Required. Parent resource name.
// Must be in the format `projects/{project_id}/locations/{location_id}`
@@ -138,7 +144,8 @@ message CreateConnectionRequest {
Connection connection = 3 [(google.api.field_behavior) = REQUIRED];
}
-// The request for [ConnectionService.GetConnection][google.cloud.bigquery.connection.v1.ConnectionService.GetConnection].
+// The request for
+// [ConnectionService.GetConnection][google.cloud.bigquery.connection.v1.ConnectionService.GetConnection].
message GetConnectionRequest {
// Required. Name of the requested connection, for example:
// `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
@@ -150,7 +157,8 @@ message GetConnectionRequest {
];
}
-// The request for [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1.ConnectionService.ListConnections].
+// The request for
+// [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1.ConnectionService.ListConnections].
message ListConnectionsRequest {
// Required. Parent resource name.
// Must be in the form: `projects/{project_id}/locations/{location_id}`
@@ -168,7 +176,8 @@ message ListConnectionsRequest {
string page_token = 3;
}
-// The response for [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1.ConnectionService.ListConnections].
+// The response for
+// [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1.ConnectionService.ListConnections].
message ListConnectionsResponse {
// Next page token.
string next_page_token = 1;
@@ -177,7 +186,8 @@ message ListConnectionsResponse {
repeated Connection connections = 2;
}
-// The request for [ConnectionService.UpdateConnection][google.cloud.bigquery.connection.v1.ConnectionService.UpdateConnection].
+// The request for
+// [ConnectionService.UpdateConnection][google.cloud.bigquery.connection.v1.ConnectionService.UpdateConnection].
message UpdateConnectionRequest {
// Required. Name of the connection to update, for example:
// `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
@@ -192,7 +202,8 @@ message UpdateConnectionRequest {
Connection connection = 2 [(google.api.field_behavior) = REQUIRED];
// Required. Update mask for the connection fields to be updated.
- google.protobuf.FieldMask update_mask = 3 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 3
+ [(google.api.field_behavior) = REQUIRED];
}
// The request for [ConnectionService.DeleteConnectionRequest][].
@@ -279,10 +290,11 @@ message CloudSqlProperties {
// Input only. Cloud SQL credential.
CloudSqlCredential credential = 4 [(google.api.field_behavior) = INPUT_ONLY];
- // Output only. The account ID of the service used for the purpose of this connection.
+ // Output only. The account ID of the service used for the purpose of this
+ // connection.
//
// When the connection is used in the context of an operation in
- // BigQuery, this service account will serve as identity being used for
+ // BigQuery, this service account will serve as the identity being used for
// connecting to the CloudSQL instance specified in this connection.
string service_account_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -303,6 +315,25 @@ message CloudSpannerProperties {
// If parallelism should be used when reading from Cloud Spanner
bool use_parallelism = 2;
+
+ // If the serverless analytics service should be used to read data from Cloud
+ // Spanner.
+ // Note: `use_parallelism` must be set when using serverless analytics.
+ bool use_serverless_analytics = 3;
+
+ // Optional. Cloud Spanner database role for fine-grained access control.
+ // A database role is a collection of fine-grained access privileges. Example:
+ // Admin predefines roles that provides user a set of permissions (SELECT,
+ // INSERT, ..). The user can then specify a predefined role on a connection to
+ // execute their Cloud Spanner query. The role is passthrough here. If the
+ // user is not authorized to use the specified role, they get an error. This
+ // validation happens on Cloud Spanner.
+ //
+ // See https://cloud.google.com/spanner/docs/fgac-about for more details.
+ //
+ // REQUIRES: database role name must start with uppercase/lowercase letter
+ // and only contain uppercase/lowercase letters, numbers, and underscores.
+ string database_role = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Connection properties specific to Amazon Web Services (AWS).
@@ -330,8 +361,9 @@ message AwsCrossAccountRole {
// Output only. Google-owned AWS IAM User for a Connection.
string iam_user_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A Google-generated id for representing Connection’s identity in AWS.
- // External Id is also used for preventing the Confused Deputy Problem. See
+ // Output only. A Google-generated id for representing Connection’s identity
+ // in AWS. External Id is also used for preventing the Confused Deputy
+ // Problem. See
// https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html
string external_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -366,20 +398,21 @@ message AzureProperties {
// setup.
string redirect_uri = 5;
- // The client id of the user's Azure Active Directory Application used for a
+ // The client ID of the user's Azure Active Directory Application used for a
// federated connection.
string federated_application_client_id = 6;
- // Output only. A unique Google-owned and Google-generated identity for the Connection.
- // This identity will be used to access the user's Azure Active Directory
- // Application.
+ // Output only. A unique Google-owned and Google-generated identity for the
+ // Connection. This identity will be used to access the user's Azure Active
+ // Directory Application.
string identity = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Container for connection properties for delegation of access to GCP
// resources.
message CloudResourceProperties {
- // Output only. The account ID of the service created for the purpose of this connection.
+ // Output only. The account ID of the service created for the purpose of this
+ // connection.
//
// The service account does not have any permissions associated with it
// when it is created. After creation, customers delegate permissions
diff --git a/third_party/googleapis/google/cloud/bigquery/connection/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/connection/v1beta1/BUILD.bazel
index f3245a650..143b51ece 100644
--- a/third_party/googleapis/google/cloud/bigquery/connection/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/connection/v1beta1/BUILD.bazel
@@ -110,7 +110,7 @@ load(
go_proto_library(
name = "connection_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1",
+ importpath = "cloud.google.com/go/bigquery/connection/apiv1beta1/connectionpb",
protos = [":connection_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -123,6 +123,8 @@ go_gapic_library(
srcs = [":connection_proto_with_info"],
grpc_service_config = "bigqueryconnection_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/connection/apiv1beta1;connection",
+ metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "bigqueryconnection_v1beta1.yaml",
transport = "grpc+rest",
@@ -163,7 +165,8 @@ py_gapic_library(
srcs = [":connection_proto"],
grpc_service_config = "bigqueryconnection_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "bigqueryconnection_v1beta1.yaml",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -214,6 +217,7 @@ php_gapic_library(
srcs = [":connection_proto_with_info"],
grpc_service_config = "bigqueryconnection_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "bigqueryconnection_v1beta1.yaml",
transport = "grpc+rest",
deps = [
":connection_php_grpc",
@@ -287,6 +291,7 @@ ruby_cloud_gapic_library(
srcs = [":connection_proto_with_info"],
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-connection-v1beta1"],
rest_numeric_enums = True,
+ service_yaml = "bigqueryconnection_v1beta1.yaml",
deps = [
":connection_ruby_grpc",
":connection_ruby_proto",
@@ -332,6 +337,7 @@ csharp_gapic_library(
grpc_service_config = "bigqueryconnection_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "bigqueryconnection_v1beta1.yaml",
+ transport = "grpc+rest",
deps = [
":connection_csharp_grpc",
":connection_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/connection/v1beta1/connection.proto b/third_party/googleapis/google/cloud/bigquery/connection/v1beta1/connection.proto
index eda714db7..0e8da4ff8 100644
--- a/third_party/googleapis/google/cloud/bigquery/connection/v1beta1/connection.proto
+++ b/third_party/googleapis/google/cloud/bigquery/connection/v1beta1/connection.proto
@@ -27,7 +27,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Connection.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/connection/v1beta1;connection";
+option go_package = "cloud.google.com/go/bigquery/connection/apiv1beta1/connectionpb;connectionpb";
option java_outer_classname = "ConnectionProto";
option java_package = "com.google.cloud.bigquery.connection.v1beta1";
option php_namespace = "Google\\Cloud\\BigQuery\\Connection\\V1beta1";
@@ -57,7 +57,8 @@ service ConnectionService {
}
// Returns a list of connections in the given project.
- rpc ListConnections(ListConnectionsRequest) returns (ListConnectionsResponse) {
+ rpc ListConnections(ListConnectionsRequest)
+ returns (ListConnectionsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/connections"
};
@@ -75,7 +76,8 @@ service ConnectionService {
}
// Sets the credential for the specified connection.
- rpc UpdateConnectionCredential(UpdateConnectionCredentialRequest) returns (google.protobuf.Empty) {
+ rpc UpdateConnectionCredential(UpdateConnectionCredentialRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
patch: "/v1beta1/{name=projects/*/locations/*/connections/*/credential}"
body: "credential"
@@ -84,7 +86,8 @@ service ConnectionService {
}
// Deletes connection and associated credential.
- rpc DeleteConnection(DeleteConnectionRequest) returns (google.protobuf.Empty) {
+ rpc DeleteConnection(DeleteConnectionRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/connections/*}"
};
@@ -94,7 +97,8 @@ service ConnectionService {
// Gets the access control policy for a resource.
// Returns an empty policy if the resource exists and does not have a policy
// set.
- rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) {
+ rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
+ returns (google.iam.v1.Policy) {
option (google.api.http) = {
post: "/v1beta1/{resource=projects/*/locations/*/connections/*}:getIamPolicy"
body: "*"
@@ -106,7 +110,8 @@ service ConnectionService {
// existing policy.
//
// Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
- rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) {
+ rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
+ returns (google.iam.v1.Policy) {
option (google.api.http) = {
post: "/v1beta1/{resource=projects/*/locations/*/connections/*}:setIamPolicy"
body: "*"
@@ -121,7 +126,8 @@ service ConnectionService {
// 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.
- rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) {
+ rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
+ returns (google.iam.v1.TestIamPermissionsResponse) {
option (google.api.http) = {
post: "/v1beta1/{resource=projects/*/locations/*/connections/*}:testIamPermissions"
body: "*"
@@ -130,7 +136,8 @@ service ConnectionService {
}
}
-// The request for [ConnectionService.CreateConnection][google.cloud.bigquery.connection.v1beta1.ConnectionService.CreateConnection].
+// The request for
+// [ConnectionService.CreateConnection][google.cloud.bigquery.connection.v1beta1.ConnectionService.CreateConnection].
message CreateConnectionRequest {
// Required. Parent resource name.
// Must be in the format `projects/{project_id}/locations/{location_id}`
@@ -148,7 +155,8 @@ message CreateConnectionRequest {
Connection connection = 3 [(google.api.field_behavior) = REQUIRED];
}
-// The request for [ConnectionService.GetConnection][google.cloud.bigquery.connection.v1beta1.ConnectionService.GetConnection].
+// The request for
+// [ConnectionService.GetConnection][google.cloud.bigquery.connection.v1beta1.ConnectionService.GetConnection].
message GetConnectionRequest {
// Required. Name of the requested connection, for example:
// `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
@@ -160,7 +168,8 @@ message GetConnectionRequest {
];
}
-// The request for [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1beta1.ConnectionService.ListConnections].
+// The request for
+// [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1beta1.ConnectionService.ListConnections].
message ListConnectionsRequest {
// Required. Parent resource name.
// Must be in the form: `projects/{project_id}/locations/{location_id}`
@@ -172,13 +181,15 @@ message ListConnectionsRequest {
];
// Required. Maximum number of results per page.
- google.protobuf.UInt32Value max_results = 2 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.UInt32Value max_results = 2
+ [(google.api.field_behavior) = REQUIRED];
// Page token.
string page_token = 3;
}
-// The response for [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1beta1.ConnectionService.ListConnections].
+// The response for
+// [ConnectionService.ListConnections][google.cloud.bigquery.connection.v1beta1.ConnectionService.ListConnections].
message ListConnectionsResponse {
// Next page token.
string next_page_token = 1;
@@ -187,7 +198,8 @@ message ListConnectionsResponse {
repeated Connection connections = 2;
}
-// The request for [ConnectionService.UpdateConnection][google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnection].
+// The request for
+// [ConnectionService.UpdateConnection][google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnection].
message UpdateConnectionRequest {
// Required. Name of the connection to update, for example:
// `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
@@ -202,10 +214,12 @@ message UpdateConnectionRequest {
Connection connection = 2 [(google.api.field_behavior) = REQUIRED];
// Required. Update mask for the connection fields to be updated.
- google.protobuf.FieldMask update_mask = 3 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 3
+ [(google.api.field_behavior) = REQUIRED];
}
-// The request for [ConnectionService.UpdateConnectionCredential][google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnectionCredential].
+// The request for
+// [ConnectionService.UpdateConnectionCredential][google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnectionCredential].
message UpdateConnectionCredentialRequest {
// Required. Name of the connection, for example:
// `projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential`
@@ -296,10 +310,11 @@ message CloudSqlProperties {
// Input only. Cloud SQL credential.
CloudSqlCredential credential = 4 [(google.api.field_behavior) = INPUT_ONLY];
- // Output only. The account ID of the service used for the purpose of this connection.
+ // Output only. The account ID of the service used for the purpose of this
+ // connection.
//
// When the connection is used in the context of an operation in
- // BigQuery, this service account will serve as identity being used for
+ // BigQuery, this service account will serve as the identity being used for
// connecting to the CloudSQL instance specified in this connection.
string service_account_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
}
diff --git a/third_party/googleapis/google/cloud/bigquery/dataexchange/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/dataexchange/v1beta1/BUILD.bazel
index 00c2b2724..0086e0d45 100644
--- a/third_party/googleapis/google/cloud/bigquery/dataexchange/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/dataexchange/v1beta1/BUILD.bazel
@@ -125,7 +125,7 @@ load(
go_proto_library(
name = "dataexchange_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/dataexchange/v1beta1",
+ importpath = "cloud.google.com/go/bigquery/dataexchange/apiv1beta1/dataexchangepb",
protos = [":dataexchange_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -139,6 +139,7 @@ go_gapic_library(
grpc_service_config = "analyticshub_v1beta1_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/dataexchange/apiv1beta1;dataexchange",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = False,
service_yaml = "analyticshub_v1beta1.yaml",
transport = "grpc+rest",
@@ -275,7 +276,7 @@ nodejs_gapic_library(
package = "google.cloud.bigquery.dataexchange.v1beta1",
rest_numeric_enums = False,
service_yaml = "analyticshub_v1beta1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
diff --git a/third_party/googleapis/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.proto b/third_party/googleapis/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.proto
index f18a0e49e..73bc87d1c 100644
--- a/third_party/googleapis/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.proto
+++ b/third_party/googleapis/google/cloud/bigquery/dataexchange/v1beta1/dataexchange.proto
@@ -27,7 +27,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.BigQuery.DataExchange.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/dataexchange/v1beta1;dataexchange";
+option go_package = "cloud.google.com/go/bigquery/dataexchange/apiv1beta1/dataexchangepb;dataexchangepb";
option java_multiple_files = true;
option java_outer_classname = "DataExchangeProto";
option java_package = "com.google.cloud.bigquery.dataexchange.v1beta1";
diff --git a/third_party/googleapis/google/cloud/bigquery/datapolicies/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/datapolicies/BUILD.bazel
index 5a01ce818..4a7f205d8 100644
--- a/third_party/googleapis/google/cloud/bigquery/datapolicies/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/datapolicies/BUILD.bazel
@@ -15,13 +15,13 @@ load(
# Generates a Ruby wrapper client for bigquerydatapolicy.
# Ruby wrapper clients are versionless, but are generated from source protos
-# for a particular service version, v1beta1 in this case.
+# for a particular service version, v1 in this case.
ruby_cloud_gapic_library(
name = "bigquerydatapolicy_ruby_wrapper",
- srcs = ["//google/cloud/bigquery/datapolicies/v1beta1:datapolicies_proto_with_info"],
+ srcs = ["//google/cloud/bigquery/datapolicies/v1:datapolicies_proto_with_info"],
extra_protoc_parameters = [
"ruby-cloud-gem-name=google-cloud-bigquery-data_policies",
- "ruby-cloud-wrapper-of=v1beta1:0.0",
+ "ruby-cloud-wrapper-of=v1:0.0;v1beta1:0.0",
"ruby-cloud-product-url=https://cloud.google.com/bigquery",
"ruby-cloud-api-id=bigquerydatapolicy.googleapis.com",
"ruby-cloud-api-shortname=bigquerydatapolicy",
diff --git a/third_party/googleapis/google/cloud/bigquery/datapolicies/v1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/datapolicies/v1/BUILD.bazel
index cae57e3ca..4f0819c19 100644
--- a/third_party/googleapis/google/cloud/bigquery/datapolicies/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/datapolicies/v1/BUILD.bazel
@@ -97,6 +97,7 @@ java_gapic_test(
# Open Source Packages
java_gapic_assembly_gradle_pkg(
name = "google-cloud-bigquery-datapolicies-v1-java",
+ include_samples = True,
transport = "grpc+rest",
deps = [
":datapolicies_java_gapic",
@@ -104,7 +105,6 @@ java_gapic_assembly_gradle_pkg(
":datapolicies_java_proto",
":datapolicies_proto",
],
- include_samples = True,
)
##############################################################################
@@ -121,7 +121,7 @@ load(
go_proto_library(
name = "datapolicies_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/datapolicies/v1",
+ importpath = "cloud.google.com/go/bigquery/datapolicies/apiv1/datapoliciespb",
protos = [":datapolicies_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -135,6 +135,7 @@ go_gapic_library(
grpc_service_config = "datapolicies_v1_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/datapolicies/apiv1;datapolicies",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "bigquerydatapolicy_v1.yaml",
transport = "grpc+rest",
@@ -156,8 +157,8 @@ go_gapic_assembly_pkg(
name = "gapi-cloud-bigquery-datapolicies-v1-go",
deps = [
":datapolicies_go_gapic",
- ":datapolicies_go_gapic_srcjar-test.srcjar",
":datapolicies_go_gapic_srcjar-metadata.srcjar",
+ ":datapolicies_go_gapic_srcjar-test.srcjar",
":datapolicies_go_proto",
],
)
@@ -282,8 +283,8 @@ nodejs_gapic_assembly_pkg(
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
- "ruby_gapic_assembly_pkg",
"ruby_cloud_gapic_library",
+ "ruby_gapic_assembly_pkg",
"ruby_grpc_library",
"ruby_proto_library",
)
@@ -303,10 +304,15 @@ ruby_cloud_gapic_library(
name = "datapolicies_ruby_gapic",
srcs = [":datapolicies_proto_with_info"],
extra_protoc_parameters = [
- "ruby-cloud-gem-name=google-cloud-bigquery-datapolicies-v1",
+ "ruby-cloud-api-id=bigquerydatapolicy.googleapis.com",
+ "ruby-cloud-api-shortname=bigquerydatapolicy",
+ "ruby-cloud-gem-name=google-cloud-bigquery-data_policies-v1",
+ "ruby-cloud-product-url=https://cloud.google.com/bigquery/docs",
],
grpc_service_config = "datapolicies_v1_grpc_service_config.json",
rest_numeric_enums = True,
+ ruby_cloud_description = "The Data Policy Service provides APIs for managing the BigQuery label-policy bindings.",
+ ruby_cloud_title = "BigQuery Data Policy Service V1",
service_yaml = "bigquerydatapolicy_v1.yaml",
deps = [
":datapolicies_ruby_grpc",
@@ -353,6 +359,7 @@ csharp_gapic_library(
grpc_service_config = "datapolicies_v1_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "bigquerydatapolicy_v1.yaml",
+ transport = "grpc+rest",
deps = [
":datapolicies_csharp_grpc",
":datapolicies_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/datapolicies/v1/datapolicy.proto b/third_party/googleapis/google/cloud/bigquery/datapolicies/v1/datapolicy.proto
index cd79acfba..1677e7eb7 100644
--- a/third_party/googleapis/google/cloud/bigquery/datapolicies/v1/datapolicy.proto
+++ b/third_party/googleapis/google/cloud/bigquery/datapolicies/v1/datapolicy.proto
@@ -26,7 +26,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.BigQuery.DataPolicies.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/datapolicies/v1;datapolicies";
+option go_package = "cloud.google.com/go/bigquery/datapolicies/apiv1/datapoliciespb;datapoliciespb";
option java_multiple_files = true;
option java_outer_classname = "DataPolicyProto";
option java_package = "com.google.cloud.bigquery.datapolicies.v1";
diff --git a/third_party/googleapis/google/cloud/bigquery/datapolicies/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/datapolicies/v1beta1/BUILD.bazel
index b824fd34f..821352bf3 100644
--- a/third_party/googleapis/google/cloud/bigquery/datapolicies/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/datapolicies/v1beta1/BUILD.bazel
@@ -121,7 +121,7 @@ load(
go_proto_library(
name = "datapolicies_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/datapolicies/v1beta1",
+ importpath = "cloud.google.com/go/bigquery/datapolicies/apiv1beta1/datapoliciespb",
protos = [":datapolicies_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -135,6 +135,7 @@ go_gapic_library(
grpc_service_config = "datapolicies_v1beta1_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/datapolicies/apiv1beta1;datapolicies",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = False,
service_yaml = "bigquerydatapolicy_v1beta1.yaml",
transport = "grpc+rest",
@@ -265,7 +266,7 @@ nodejs_gapic_library(
package = "google.cloud.bigquery.datapolicies.v1beta1",
rest_numeric_enums = False,
service_yaml = "bigquerydatapolicy_v1beta1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
diff --git a/third_party/googleapis/google/cloud/bigquery/datapolicies/v1beta1/datapolicy.proto b/third_party/googleapis/google/cloud/bigquery/datapolicies/v1beta1/datapolicy.proto
index 363f15c5c..b149fe475 100644
--- a/third_party/googleapis/google/cloud/bigquery/datapolicies/v1beta1/datapolicy.proto
+++ b/third_party/googleapis/google/cloud/bigquery/datapolicies/v1beta1/datapolicy.proto
@@ -26,7 +26,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.BigQuery.DataPolicies.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/datapolicies/v1beta1;datapolicies";
+option go_package = "cloud.google.com/go/bigquery/datapolicies/apiv1beta1/datapoliciespb;datapoliciespb";
option java_multiple_files = true;
option java_outer_classname = "DataPolicyProto";
option java_package = "com.google.cloud.bigquery.datapolicies.v1beta1";
diff --git a/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/BUILD.bazel
index fc86884a3..b77d3d37e 100644
--- a/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/BUILD.bazel
@@ -1,4 +1,13 @@
# This file was automatically generated by BuildFileGenerator
+# https://github.com/googleapis/rules_gapic/tree/master/bazel
+
+# Most of the manual changes to this file will be overwritten.
+# It's **only** allowed to change the following rule attribute values:
+# - names of *_gapic_assembly_* rules
+# - certain parameters of *_gapic_library rules, including but not limited to:
+# * extra_protoc_parameters
+# * extra_protoc_file_parameters
+# The complete list of preserved parameters can be found in the source code.
# This is an API workspace, having public visibility by default makes perfect sense.
package(default_visibility = ["//visibility:public"])
@@ -35,6 +44,7 @@ proto_library_with_info(
deps = [
":datatransfer_proto",
"//google/cloud:common_resources_proto",
+ "//google/cloud/location:location_proto",
],
)
@@ -64,14 +74,19 @@ java_grpc_library(
java_gapic_library(
name = "datatransfer_java_gapic",
srcs = [":datatransfer_proto_with_info"],
+ gapic_yaml = None,
grpc_service_config = "bigquerydatatransfer_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "bigquerydatatransfer_v1.yaml",
test_deps = [
":datatransfer_java_grpc",
+ "//google/cloud/location:location_java_grpc",
],
transport = "grpc+rest",
deps = [
":datatransfer_java_proto",
+ "//google/api:api_java_proto",
+ "//google/cloud/location:location_java_proto",
],
)
@@ -111,7 +126,7 @@ load(
go_proto_library(
name = "datatransfer_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1",
+ importpath = "cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb",
protos = [":datatransfer_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -124,11 +139,14 @@ go_gapic_library(
srcs = [":datatransfer_proto_with_info"],
grpc_service_config = "bigquerydatatransfer_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/datatransfer/apiv1;datatransfer",
+ metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "bigquerydatatransfer_v1.yaml",
transport = "grpc+rest",
deps = [
":datatransfer_go_proto",
+ "//google/cloud/location:location_go_proto",
"@io_bazel_rules_go//proto/wkt:duration_go_proto",
],
)
@@ -145,6 +163,7 @@ go_gapic_assembly_pkg(
name = "gapi-cloud-bigquery-datatransfer-v1-go",
deps = [
":datatransfer_go_gapic",
+ ":datatransfer_go_gapic_srcjar-metadata.srcjar",
":datatransfer_go_gapic_srcjar-test.srcjar",
":datatransfer_go_proto",
],
@@ -153,7 +172,6 @@ go_gapic_assembly_pkg(
##############################################################################
# Python
##############################################################################
-
load(
"@com_google_googleapis_imports//:imports.bzl",
"py_gapic_assembly_pkg",
@@ -166,11 +184,14 @@ py_gapic_library(
srcs = [":datatransfer_proto"],
grpc_service_config = "bigquerydatatransfer_grpc_service_config.json",
opt_args = [
- "python-gapic-namespace=google.cloud",
"python-gapic-name=bigquery_datatransfer",
+ "python-gapic-namespace=google.cloud",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "bigquerydatatransfer_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ],
)
py_test(
@@ -183,6 +204,7 @@ py_test(
deps = [":datatransfer_py_gapic"],
)
+# Open Source Packages
py_gapic_assembly_pkg(
name = "bigquery-datatransfer-v1-py",
deps = [
@@ -217,6 +239,7 @@ php_gapic_library(
srcs = [":datatransfer_proto_with_info"],
grpc_service_config = "bigquerydatatransfer_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "bigquerydatatransfer_v1.yaml",
transport = "grpc+rest",
deps = [
":datatransfer_php_grpc",
@@ -290,17 +313,18 @@ ruby_cloud_gapic_library(
name = "datatransfer_ruby_gapic",
srcs = [":datatransfer_proto_with_info"],
extra_protoc_parameters = [
- "ruby-cloud-gem-name=google-cloud-bigquery-data_transfer-v1",
- "ruby-cloud-env-prefix=DATA_TRANSFER",
- "ruby-cloud-yard-strict=false",
- "ruby-cloud-product-url=https://cloud.google.com/bigquery/transfer",
"ruby-cloud-api-id=bigquerydatatransfer.googleapis.com",
"ruby-cloud-api-shortname=bigquerydatatransfer",
+ "ruby-cloud-env-prefix=DATA_TRANSFER",
+ "ruby-cloud-gem-name=google-cloud-bigquery-data_transfer-v1",
+ "ruby-cloud-product-url=https://cloud.google.com/bigquery/transfer",
+ "ruby-cloud-yard-strict=false",
],
grpc_service_config = "bigquerydatatransfer_grpc_service_config.json",
rest_numeric_enums = True,
ruby_cloud_description = "Schedules queries and transfers external data from SaaS applications to Google BigQuery on a regular basis.",
ruby_cloud_title = "BigQuery Data Transfer Service V1",
+ service_yaml = "bigquerydatatransfer_v1.yaml",
deps = [
":datatransfer_ruby_grpc",
":datatransfer_ruby_proto",
@@ -346,6 +370,7 @@ csharp_gapic_library(
grpc_service_config = "bigquerydatatransfer_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "bigquerydatatransfer_v1.yaml",
+ transport = "grpc+rest",
deps = [
":datatransfer_csharp_grpc",
":datatransfer_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/bigquerydatatransfer_v1.yaml b/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/bigquerydatatransfer_v1.yaml
index 760757259..33fb99236 100644
--- a/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/bigquerydatatransfer_v1.yaml
+++ b/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/bigquerydatatransfer_v1.yaml
@@ -18,6 +18,13 @@ documentation:
- selector: google.cloud.location.Locations.ListLocations
description: Lists information about the supported locations for this service.
+http:
+ rules:
+ - selector: google.cloud.location.Locations.GetLocation
+ get: '/v1/{name=projects/*/locations/*}'
+ - selector: google.cloud.location.Locations.ListLocations
+ get: '/v1/{name=projects/*}/locations'
+
authentication:
rules:
- selector: 'google.cloud.bigquery.datatransfer.v1.DataTransferService.*'
diff --git a/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/datatransfer.proto b/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/datatransfer.proto
index 63ea08720..03bfb3b6d 100644
--- a/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/datatransfer.proto
+++ b/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/datatransfer.proto
@@ -28,7 +28,7 @@ import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
option csharp_namespace = "Google.Cloud.BigQuery.DataTransfer.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1;datatransfer";
+option go_package = "cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb;datatransferpb";
option java_multiple_files = true;
option java_outer_classname = "DataTransferProto";
option java_package = "com.google.cloud.bigquery.datatransfer.v1";
@@ -38,32 +38,31 @@ option ruby_package = "Google::Cloud::Bigquery::DataTransfer::V1";
// This API allows users to manage their data transfers into BigQuery.
service DataTransferService {
option (google.api.default_host) = "bigquerydatatransfer.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Retrieves a supported data source and returns its settings.
rpc GetDataSource(GetDataSourceRequest) returns (DataSource) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/dataSources/*}"
- additional_bindings {
- get: "/v1/{name=projects/*/dataSources/*}"
- }
+ additional_bindings { get: "/v1/{name=projects/*/dataSources/*}" }
};
option (google.api.method_signature) = "name";
}
// Lists supported data sources and returns their settings.
- rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse) {
+ rpc ListDataSources(ListDataSourcesRequest)
+ returns (ListDataSourcesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/dataSources"
- additional_bindings {
- get: "/v1/{parent=projects/*}/dataSources"
- }
+ additional_bindings { get: "/v1/{parent=projects/*}/dataSources" }
};
option (google.api.method_signature) = "parent";
}
// Creates a new data transfer configuration.
- rpc CreateTransferConfig(CreateTransferConfigRequest) returns (TransferConfig) {
+ rpc CreateTransferConfig(CreateTransferConfigRequest)
+ returns (TransferConfig) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/transferConfigs"
body: "transfer_config"
@@ -77,7 +76,8 @@ service DataTransferService {
// Updates a data transfer configuration.
// All fields must be set, even if they are not updated.
- rpc UpdateTransferConfig(UpdateTransferConfigRequest) returns (TransferConfig) {
+ rpc UpdateTransferConfig(UpdateTransferConfigRequest)
+ returns (TransferConfig) {
option (google.api.http) = {
patch: "/v1/{transfer_config.name=projects/*/locations/*/transferConfigs/*}"
body: "transfer_config"
@@ -91,12 +91,11 @@ service DataTransferService {
// Deletes a data transfer configuration, including any associated transfer
// runs and logs.
- rpc DeleteTransferConfig(DeleteTransferConfigRequest) returns (google.protobuf.Empty) {
+ rpc DeleteTransferConfig(DeleteTransferConfigRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/transferConfigs/*}"
- additional_bindings {
- delete: "/v1/{name=projects/*/transferConfigs/*}"
- }
+ additional_bindings { delete: "/v1/{name=projects/*/transferConfigs/*}" }
};
option (google.api.method_signature) = "name";
}
@@ -105,21 +104,18 @@ service DataTransferService {
rpc GetTransferConfig(GetTransferConfigRequest) returns (TransferConfig) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/transferConfigs/*}"
- additional_bindings {
- get: "/v1/{name=projects/*/transferConfigs/*}"
- }
+ additional_bindings { get: "/v1/{name=projects/*/transferConfigs/*}" }
};
option (google.api.method_signature) = "name";
}
// Returns information about all transfer configs owned by a project in the
// specified location.
- rpc ListTransferConfigs(ListTransferConfigsRequest) returns (ListTransferConfigsResponse) {
+ rpc ListTransferConfigs(ListTransferConfigsRequest)
+ returns (ListTransferConfigsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/transferConfigs"
- additional_bindings {
- get: "/v1/{parent=projects/*}/transferConfigs"
- }
+ additional_bindings { get: "/v1/{parent=projects/*}/transferConfigs" }
};
option (google.api.method_signature) = "parent";
}
@@ -129,7 +125,8 @@ service DataTransferService {
// range, one transfer run is created.
// Note that runs are created per UTC time in the time range.
// DEPRECATED: use StartManualTransferRuns instead.
- rpc ScheduleTransferRuns(ScheduleTransferRunsRequest) returns (ScheduleTransferRunsResponse) {
+ rpc ScheduleTransferRuns(ScheduleTransferRunsRequest)
+ returns (ScheduleTransferRunsResponse) {
option deprecated = true;
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/transferConfigs/*}:scheduleRuns"
@@ -146,7 +143,8 @@ service DataTransferService {
// current time. The transfer runs can be created for a time range where the
// run_time is between start_time (inclusive) and end_time (exclusive), or for
// a specific run_time.
- rpc StartManualTransferRuns(StartManualTransferRunsRequest) returns (StartManualTransferRunsResponse) {
+ rpc StartManualTransferRuns(StartManualTransferRunsRequest)
+ returns (StartManualTransferRunsResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/transferConfigs/*}:startManualRuns"
body: "*"
@@ -169,7 +167,8 @@ service DataTransferService {
}
// Deletes the specified transfer run.
- rpc DeleteTransferRun(DeleteTransferRunRequest) returns (google.protobuf.Empty) {
+ rpc DeleteTransferRun(DeleteTransferRunRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/transferConfigs/*/runs/*}"
additional_bindings {
@@ -180,7 +179,8 @@ service DataTransferService {
}
// Returns information about running and completed transfer runs.
- rpc ListTransferRuns(ListTransferRunsRequest) returns (ListTransferRunsResponse) {
+ rpc ListTransferRuns(ListTransferRunsRequest)
+ returns (ListTransferRunsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/transferConfigs/*}/runs"
additional_bindings {
@@ -191,7 +191,8 @@ service DataTransferService {
}
// Returns log messages for the transfer run.
- rpc ListTransferLogs(ListTransferLogsRequest) returns (ListTransferLogsResponse) {
+ rpc ListTransferLogs(ListTransferLogsRequest)
+ returns (ListTransferLogsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/transferConfigs/*/runs/*}/transferLogs"
additional_bindings {
@@ -203,7 +204,8 @@ service DataTransferService {
// Returns true if valid credentials exist for the given data source and
// requesting user.
- rpc CheckValidCreds(CheckValidCredsRequest) returns (CheckValidCredsResponse) {
+ rpc CheckValidCreds(CheckValidCredsRequest)
+ returns (CheckValidCredsResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/dataSources/*}:checkValidCreds"
body: "*"
@@ -223,7 +225,8 @@ service DataTransferService {
// [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and
// [Data Transfer
// Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
- rpc EnrollDataSources(EnrollDataSourcesRequest) returns (google.protobuf.Empty) {
+ rpc EnrollDataSources(EnrollDataSourcesRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*}:enrollDataSources"
body: "*"
@@ -425,8 +428,8 @@ message DataSource {
// A request to get data source info.
message GetDataSourceRequest {
- // Required. The field will contain name of the resource requested, for example:
- // `projects/{project_id}/dataSources/{data_source_id}` or
+ // Required. The field will contain name of the resource requested, for
+ // example: `projects/{project_id}/dataSources/{data_source_id}` or
// `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -438,8 +441,8 @@ message GetDataSourceRequest {
// Request to list supported data sources and their data transfer settings.
message ListDataSourcesRequest {
- // Required. The BigQuery project id for which data sources should be returned.
- // Must be in the form: `projects/{project_id}` or
+ // Required. The BigQuery project id for which data sources should be
+ // returned. Must be in the form: `projects/{project_id}` or
// `projects/{project_id}/locations/{location_id}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -478,10 +481,11 @@ message ListDataSourcesResponse {
// Otherwise, the transfer configuration will be associated with the calling
// user.
message CreateTransferConfigRequest {
- // Required. The BigQuery project id where the transfer configuration should be created.
- // Must be in the format projects/{project_id}/locations/{location_id} or
- // projects/{project_id}. If specified location and location of the
- // destination bigquery dataset do not match - the request will fail.
+ // Required. The BigQuery project id where the transfer configuration should
+ // be created. Must be in the format
+ // projects/{project_id}/locations/{location_id} or projects/{project_id}. If
+ // specified location and location of the destination bigquery dataset do not
+ // match - the request will fail.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -524,7 +528,7 @@ message CreateTransferConfigRequest {
// create the transfer config.
string version_info = 5;
- // Optional service account name. If this field is set, the transfer config
+ // Optional service account email. If this field is set, the transfer config
// will be created with this service account's credentials. It requires that
// the requesting user calling this API has permissions to act as this service
// account.
@@ -559,7 +563,8 @@ message UpdateTransferConfigRequest {
string authorization_code = 3;
// Required. Required list of fields to be updated in this request.
- google.protobuf.FieldMask update_mask = 4 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 4
+ [(google.api.field_behavior) = REQUIRED];
// Optional version info. This is required only if
// `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
@@ -577,7 +582,7 @@ message UpdateTransferConfigRequest {
// update the transfer config.
string version_info = 5;
- // Optional service account name. If this field is set, the transfer config
+ // Optional service account email. If this field is set, the transfer config
// will be created with this service account's credentials. It requires that
// the requesting user calling this API has permissions to act as this service
// account.
@@ -591,8 +596,8 @@ message UpdateTransferConfigRequest {
// A request to get data transfer information.
message GetTransferConfigRequest {
- // Required. The field will contain name of the resource requested, for example:
- // `projects/{project_id}/transferConfigs/{config_id}` or
+ // Required. The field will contain name of the resource requested, for
+ // example: `projects/{project_id}/transferConfigs/{config_id}` or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -605,8 +610,8 @@ message GetTransferConfigRequest {
// A request to delete data transfer information. All associated transfer runs
// and log messages will be deleted as well.
message DeleteTransferConfigRequest {
- // Required. The field will contain name of the resource requested, for example:
- // `projects/{project_id}/transferConfigs/{config_id}` or
+ // Required. The field will contain name of the resource requested, for
+ // example: `projects/{project_id}/transferConfigs/{config_id}` or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -618,8 +623,9 @@ message DeleteTransferConfigRequest {
// A request to get data transfer run information.
message GetTransferRunRequest {
- // Required. The field will contain name of the resource requested, for example:
- // `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
+ // Required. The field will contain name of the resource requested, for
+ // example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
+ // or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -631,8 +637,9 @@ message GetTransferRunRequest {
// A request to delete data transfer run information.
message DeleteTransferRunRequest {
- // Required. The field will contain name of the resource requested, for example:
- // `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
+ // Required. The field will contain name of the resource requested, for
+ // example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`
+ // or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
@@ -671,7 +678,8 @@ message ListTransferConfigsRequest {
// The returned list of pipelines in the project.
message ListTransferConfigsResponse {
// Output only. The stored pipeline transfer configurations.
- repeated TransferConfig transfer_configs = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated TransferConfig transfer_configs = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The next-pagination token. For multiple-page list results,
// this token can be used as the
@@ -691,8 +699,8 @@ message ListTransferRunsRequest {
LATEST = 1;
}
- // Required. Name of transfer configuration for which transfer runs should be retrieved.
- // Format of transfer configuration resource name is:
+ // Required. Name of transfer configuration for which transfer runs should be
+ // retrieved. Format of transfer configuration resource name is:
// `projects/{project_id}/transferConfigs/{config_id}` or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
string parent = 1 [
@@ -722,7 +730,8 @@ message ListTransferRunsRequest {
// The returned list of pipelines in the project.
message ListTransferRunsResponse {
// Output only. The stored pipeline transfer runs.
- repeated TransferRun transfer_runs = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated TransferRun transfer_runs = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The next-pagination token. For multiple-page list results,
// this token can be used as the
@@ -761,7 +770,8 @@ message ListTransferLogsRequest {
// The returned list transfer run messages.
message ListTransferLogsResponse {
// Output only. The stored pipeline transfer messages.
- repeated TransferMessage transfer_messages = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated TransferMessage transfer_messages = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The next-pagination token. For multiple-page list results,
// this token can be used as the
@@ -808,11 +818,13 @@ message ScheduleTransferRunsRequest {
// Required. Start time of the range of transfer runs. For example,
// `"2017-05-25T00:00:00+00:00"`.
- google.protobuf.Timestamp start_time = 2 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.Timestamp start_time = 2
+ [(google.api.field_behavior) = REQUIRED];
// Required. End time of the range of transfer runs. For example,
// `"2017-05-30T00:00:00+00:00"`.
- google.protobuf.Timestamp end_time = 3 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.Timestamp end_time = 3
+ [(google.api.field_behavior) = REQUIRED];
}
// A response to schedule transfer runs for a time range.
@@ -843,8 +855,8 @@ message StartManualTransferRunsRequest {
// `projects/{project_id}/transferConfigs/{config_id}` or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
string parent = 1 [(google.api.resource_reference) = {
- type: "bigquerydatatransfer.googleapis.com/TransferConfig"
- }];
+ type: "bigquerydatatransfer.googleapis.com/TransferConfig"
+ }];
// The requested time specification - this can be a time range or a specific
// run_time.
diff --git a/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/transfer.proto b/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/transfer.proto
index 97d163069..4c9eca8cf 100644
--- a/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/transfer.proto
+++ b/third_party/googleapis/google/cloud/bigquery/datatransfer/v1/transfer.proto
@@ -23,7 +23,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.BigQuery.DataTransfer.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/datatransfer/v1;datatransfer";
+option go_package = "cloud.google.com/go/bigquery/datatransfer/apiv1/datatransferpb;datatransferpb";
option java_multiple_files = true;
option java_outer_classname = "TransferProto";
option java_package = "com.google.cloud.bigquery.datatransfer.v1";
@@ -176,10 +176,12 @@ message TransferConfig {
bool disabled = 13;
// Output only. Data transfer modification time. Ignored by server on input.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Next time when data transfer will run.
- google.protobuf.Timestamp next_run_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp next_run_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. State of the most recently updated transfer run.
TransferState state = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -201,9 +203,9 @@ message TransferConfig {
// to the email address of the user who owns this transfer config.
EmailPreferences email_preferences = 18;
- // Output only. Information about the user whose credentials are used to transfer data.
- // Populated only for `transferConfigs.get` requests. In case the user
- // information is not available, this field will not be populated.
+ // Output only. Information about the user whose credentials are used to
+ // transfer data. Populated only for `transferConfigs.get` requests. In case
+ // the user information is not available, this field will not be populated.
optional UserInfo owner_info = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
}
@@ -233,25 +235,30 @@ message TransferRun {
// Output only. Time when transfer run was started.
// Parameter ignored by server for input requests.
- google.protobuf.Timestamp start_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when transfer run ended.
// Parameter ignored by server for input requests.
- google.protobuf.Timestamp end_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Last time the data transfer run state was updated.
- google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Parameters specific to each data source. For more information see the
- // bq tab in the 'Setting up a data transfer' section for each data source.
- // For example the parameters for Cloud Storage transfers are listed here:
+ // Output only. Parameters specific to each data source. For more information
+ // see the bq tab in the 'Setting up a data transfer' section for each data
+ // source. For example the parameters for Cloud Storage transfers are listed
+ // here:
// https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
google.protobuf.Struct params = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
// Data transfer destination.
oneof destination {
// Output only. The BigQuery target dataset id.
- string destination_dataset_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ string destination_dataset_id = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. Data source id.
@@ -275,12 +282,14 @@ message TransferRun {
//
// The format for specifying a pubsub topic is:
// `projects/{project}/topics/{topic}`
- string notification_pubsub_topic = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
+ string notification_pubsub_topic = 23
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Email notifications will be sent according to these
// preferences to the email address of the user who owns the transfer config
// this run was derived from.
- EmailPreferences email_preferences = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
+ EmailPreferences email_preferences = 25
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Represents a user facing message for a particular data transfer run.
diff --git a/third_party/googleapis/google/cloud/bigquery/logging/v1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/logging/v1/BUILD.bazel
index eb4276219..b5188a8cf 100644
--- a/third_party/googleapis/google/cloud/bigquery/logging/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/logging/v1/BUILD.bazel
@@ -53,7 +53,7 @@ load(
go_proto_library(
name = "logging_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/logging/v1",
+ importpath = "cloud.google.com/go/bigquery/logging/apiv1/loggingpb",
protos = [":logging_proto"],
deps = [
"//google/iam/v1:iam_go_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/logging/v1/audit_data.proto b/third_party/googleapis/google/cloud/bigquery/logging/v1/audit_data.proto
index 1529be725..e74e012dd 100644
--- a/third_party/googleapis/google/cloud/bigquery/logging/v1/audit_data.proto
+++ b/third_party/googleapis/google/cloud/bigquery/logging/v1/audit_data.proto
@@ -22,7 +22,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/logging/v1;logging";
+option go_package = "cloud.google.com/go/bigquery/logging/apiv1/loggingpb;loggingpb";
option java_multiple_files = true;
option java_outer_classname = "AuditDataProto";
option java_package = "com.google.cloud.bigquery.logging.v1";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/migration/v2/BUILD.bazel
index 642ee5ab1..d714f40b4 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2/BUILD.bazel
@@ -125,7 +125,7 @@ load(
go_proto_library(
name = "migration_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2",
+ importpath = "cloud.google.com/go/bigquery/migration/apiv2/migrationpb",
protos = [":migration_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -141,6 +141,7 @@ go_gapic_library(
grpc_service_config = "bigquerymigration_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/migration/apiv2;migration",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = False,
service_yaml = "bigquerymigration_v2.yaml",
transport = "grpc",
@@ -187,6 +188,7 @@ py_gapic_library(
"python-gapic-namespace=google.cloud",
],
rest_numeric_enums = False,
+ service_yaml = "bigquerymigration_v2.yaml",
transport = "grpc",
)
@@ -318,6 +320,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = False,
ruby_cloud_description = "The BigQuery Migration Service is a comprehensive solution for migrating your data warehouse to BigQuery.",
ruby_cloud_title = "BigQuery Migration V2",
+ service_yaml = "bigquerymigration_v2.yaml",
deps = [
":migration_ruby_grpc",
":migration_ruby_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_entities.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_entities.proto
index 7d77bae32..5cdf85a0c 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_entities.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_entities.proto
@@ -25,7 +25,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/error_details.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "MigrationEntitiesProto";
option java_package = "com.google.cloud.bigquery.migration.v2";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_error_details.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_error_details.proto
index 199e2db61..09f241f57 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_error_details.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_error_details.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/rpc/error_details.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "MigrationErrorDetailsProto";
option java_package = "com.google.cloud.bigquery.migration.v2";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_metrics.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_metrics.proto
index e52fead2f..0155740be 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_metrics.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_metrics.proto
@@ -22,7 +22,7 @@ import "google/api/metric.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "MigrationMetricsProto";
option java_package = "com.google.cloud.bigquery.migration.v2";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_service.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_service.proto
index 3c1a89ec2..27303e21b 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_service.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2/migration_service.proto
@@ -25,7 +25,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "MigrationServiceProto";
option java_package = "com.google.cloud.bigquery.migration.v2";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2/translation_config.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2/translation_config.proto
index 994140d13..946f48f39 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2/translation_config.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2/translation_config.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.bigquery.migration.v2;
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "TranslationConfigProto";
option java_package = "com.google.cloud.bigquery.migration.v2";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/BUILD.bazel
index 16ac7ca69..765a41d86 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/BUILD.bazel
@@ -26,6 +26,7 @@ proto_library(
"migration_error_details.proto",
"migration_metrics.proto",
"migration_service.proto",
+ "translation_service.proto",
"translation_task.proto",
],
deps = [
@@ -124,7 +125,7 @@ load(
go_proto_library(
name = "migration_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha",
+ importpath = "cloud.google.com/go/bigquery/migration/apiv2alpha/migrationpb",
protos = [":migration_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -140,6 +141,7 @@ go_gapic_library(
grpc_service_config = "bigquerymigration_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/migration/apiv2alpha;migration",
metadata = True,
+ release_level = "alpha",
rest_numeric_enums = False,
service_yaml = "bigquerymigration_v2alpha.yaml",
transport = "grpc+rest",
@@ -185,6 +187,7 @@ py_gapic_library(
"python-gapic-namespace=google.cloud",
],
rest_numeric_enums = False,
+ service_yaml = "bigquerymigration_v2alpha.yaml",
transport = "grpc",
)
@@ -269,7 +272,7 @@ nodejs_gapic_library(
package = "google.cloud.bigquery.migration.v2alpha",
rest_numeric_enums = False,
service_yaml = "bigquerymigration_v2alpha.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
@@ -311,6 +314,7 @@ ruby_cloud_gapic_library(
],
grpc_service_config = "bigquerymigration_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "bigquerymigration_v2alpha.yaml",
deps = [
":migration_ruby_grpc",
":migration_ruby_proto",
@@ -355,6 +359,7 @@ csharp_gapic_library(
common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
grpc_service_config = "bigquerymigration_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "bigquerymigration_v2alpha.yaml",
deps = [
":migration_csharp_grpc",
":migration_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/assessment_task.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/assessment_task.proto
index 0c6ea13eb..67680785f 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/assessment_task.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/assessment_task.proto
@@ -19,7 +19,7 @@ package google.cloud.bigquery.migration.v2alpha;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2alpha/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "AssessmentTaskProto";
option java_package = "com.google.cloud.bigquery.migration.v2alpha";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_entities.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_entities.proto
index 50d4c7570..728036e60 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_entities.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_entities.proto
@@ -27,7 +27,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/error_details.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2alpha/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "MigrationEntitiesProto";
option java_package = "com.google.cloud.bigquery.migration.v2alpha";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_error_details.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_error_details.proto
index 89dac5e62..88d561874 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_error_details.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_error_details.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/rpc/error_details.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2alpha/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "MigrationErrorDetailsProto";
option java_package = "com.google.cloud.bigquery.migration.v2alpha";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_metrics.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_metrics.proto
index ce60dd277..da7e9a803 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_metrics.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_metrics.proto
@@ -22,7 +22,7 @@ import "google/api/metric.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2alpha/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "MigrationMetricsProto";
option java_package = "com.google.cloud.bigquery.migration.v2alpha";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_service.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_service.proto
index 9a184a1e4..7651481bd 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_service.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/migration_service.proto
@@ -27,7 +27,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2alpha/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "MigrationServiceProto";
option java_package = "com.google.cloud.bigquery.migration.v2alpha";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/translation_service.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/translation_service.proto
index e81296608..59924506c 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/translation_service.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/translation_service.proto
@@ -22,7 +22,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2alpha/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "TranslationServiceProto";
option java_package = "com.google.cloud.bigquery.migration.v2alpha";
diff --git a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/translation_task.proto b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/translation_task.proto
index bf4b27ef5..86fb900d2 100644
--- a/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/translation_task.proto
+++ b/third_party/googleapis/google/cloud/bigquery/migration/v2alpha/translation_task.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.bigquery.migration.v2alpha;
option csharp_namespace = "Google.Cloud.BigQuery.Migration.V2Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/migration/v2alpha;migration";
+option go_package = "cloud.google.com/go/bigquery/migration/apiv2alpha/migrationpb;migrationpb";
option java_multiple_files = true;
option java_outer_classname = "TranslationTaskProto";
option java_package = "com.google.cloud.bigquery.migration.v2alpha";
diff --git a/third_party/googleapis/google/cloud/bigquery/reservation/v1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/reservation/v1/BUILD.bazel
index bbf46efd9..bcd1658f6 100644
--- a/third_party/googleapis/google/cloud/bigquery/reservation/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/reservation/v1/BUILD.bazel
@@ -119,7 +119,7 @@ load(
go_proto_library(
name = "reservation_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/reservation/v1",
+ importpath = "cloud.google.com/go/bigquery/reservation/apiv1/reservationpb",
protos = [":reservation_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -133,6 +133,7 @@ go_gapic_library(
grpc_service_config = "bigqueryreservation_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/reservation/apiv1;reservation",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "bigqueryreservation_v1.yaml",
transport = "grpc+rest",
@@ -178,7 +179,8 @@ py_gapic_library(
"python-gapic-namespace=google.cloud",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "bigqueryreservation_v1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -310,6 +312,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "The BigQuery Reservation API provides the mechanisms by which enterprise users can provision and manage dedicated resources such as slots and BigQuery BI Engine memory allocations.",
ruby_cloud_title = "BigQuery Reservation V1",
+ service_yaml = "bigqueryreservation_v1.yaml",
deps = [
":reservation_ruby_grpc",
":reservation_ruby_proto",
@@ -355,6 +358,7 @@ csharp_gapic_library(
grpc_service_config = "bigqueryreservation_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "bigqueryreservation_v1.yaml",
+ transport = "grpc+rest",
deps = [
":reservation_csharp_grpc",
":reservation_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/reservation/v1/reservation.proto b/third_party/googleapis/google/cloud/bigquery/reservation/v1/reservation.proto
index 7276c30b5..013095ef3 100644
--- a/third_party/googleapis/google/cloud/bigquery/reservation/v1/reservation.proto
+++ b/third_party/googleapis/google/cloud/bigquery/reservation/v1/reservation.proto
@@ -26,7 +26,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Reservation.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/reservation/v1;reservation";
+option go_package = "cloud.google.com/go/bigquery/reservation/apiv1/reservationpb;reservationpb";
option java_multiple_files = true;
option java_outer_classname = "ReservationProto";
option java_package = "com.google.cloud.bigquery.reservation.v1";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/storage/v1/BUILD.bazel
index 0fb59e177..f093d4b7c 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1/BUILD.bazel
@@ -119,7 +119,7 @@ java_gapic_assembly_gradle_pkg(
go_proto_library(
name = "storage_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1",
+ importpath = "cloud.google.com/go/bigquery/storage/apiv1/storagepb",
protos = [":storage_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -132,6 +132,8 @@ go_gapic_library(
srcs = [":storage_proto_with_info"],
grpc_service_config = "bigquerystorage_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/storage/apiv1;storage",
+ metadata = True,
+ release_level = "ga",
rest_numeric_enums = False,
service_yaml = "bigquerystorage_v1.yaml",
transport = "grpc",
@@ -170,6 +172,7 @@ py_gapic_library(
"python-gapic-name=bigquery_storage",
],
rest_numeric_enums = False,
+ service_yaml = "bigquerystorage_v1.yaml",
transport = "grpc",
)
@@ -206,6 +209,7 @@ php_gapic_library(
srcs = [":storage_proto_with_info"],
grpc_service_config = "bigquerystorage_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "bigquerystorage_v1.yaml",
transport = "grpc+rest",
deps = [
":storage_php_grpc",
@@ -273,6 +277,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = False,
ruby_cloud_description = "The BigQuery Storage API provides fast access to BigQuery managed storage.",
ruby_cloud_title = "BigQuery Storage V1",
+ service_yaml = "bigquerystorage_v1.yaml",
deps = [
":storage_ruby_grpc",
":storage_ruby_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1/annotations.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1/annotations.proto
index 1627fd12a..5ea5016df 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1/annotations.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1/annotations.proto
@@ -5,7 +5,7 @@ package google.cloud.bigquery.storage.v1;
import "google/protobuf/descriptor.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb";
option java_package = "com.google.cloud.bigquery.storage.v1";
option java_multiple_files = true;
option java_outer_classname = "AnnotationsProto";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1/arrow.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1/arrow.proto
index 6d3f6080b..4ac268c8b 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1/arrow.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1/arrow.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.bigquery.storage.v1;
option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "ArrowProto";
option java_package = "com.google.cloud.bigquery.storage.v1";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1/avro.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1/avro.proto
index e1ecb667b..52441e9fc 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1/avro.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1/avro.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.bigquery.storage.v1;
option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "AvroProto";
option java_package = "com.google.cloud.bigquery.storage.v1";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1/protobuf.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1/protobuf.proto
index b3754acf7..05ac778f0 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1/protobuf.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1/protobuf.proto
@@ -19,7 +19,7 @@ package google.cloud.bigquery.storage.v1;
import "google/protobuf/descriptor.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "ProtoBufProto";
option java_package = "com.google.cloud.bigquery.storage.v1";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1/storage.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1/storage.proto
index 85daf6dfa..e84a58df7 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1/storage.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1/storage.proto
@@ -30,7 +30,7 @@ import "google/protobuf/wrappers.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "StorageProto";
option java_package = "com.google.cloud.bigquery.storage.v1";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1/stream.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1/stream.proto
index ec137de19..85f6dd825 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1/stream.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1/stream.proto
@@ -24,7 +24,7 @@ import "google/cloud/bigquery/storage/v1/table.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "StreamProto";
option java_package = "com.google.cloud.bigquery.storage.v1";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1/table.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1/table.proto
index 57e793342..c9b62d793 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1/table.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1/table.proto
@@ -19,7 +19,7 @@ package google.cloud.bigquery.storage.v1;
import "google/api/field_behavior.proto";
option csharp_namespace = "Google.Cloud.BigQuery.Storage.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "TableProto";
option java_package = "com.google.cloud.bigquery.storage.v1";
@@ -164,4 +164,8 @@ message TableFieldSchema {
// Optional. See documentation for precision.
int64 scale = 9 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. A SQL expression to specify the [default value]
+ // (https://cloud.google.com/bigquery/docs/default-values) for this field.
+ string default_value_expression = 10 [(google.api.field_behavior) = OPTIONAL];
}
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/BUILD.bazel
index 0f8bda372..c45ae3cd5 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/BUILD.bazel
@@ -117,7 +117,7 @@ java_gapic_assembly_gradle_pkg(
go_proto_library(
name = "storage_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta1",
+ importpath = "cloud.google.com/go/bigquery/storage/apiv1beta1/storagepb",
protos = [":storage_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -129,6 +129,8 @@ go_gapic_library(
srcs = [":storage_proto_with_info"],
grpc_service_config = "bigquerystorage_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/storage/apiv1beta1;storage",
+ metadata = True,
+ release_level = "beta",
rest_numeric_enums = False,
service_yaml = "bigquerystorage_v1beta1.yaml",
transport = "grpc+rest",
@@ -159,6 +161,7 @@ py_gapic_library(
srcs = [":storage_proto"],
grpc_service_config = "bigquerystorage_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "bigquerystorage_v1beta1.yaml",
transport = "grpc",
)
@@ -195,6 +198,7 @@ php_gapic_library(
srcs = [":storage_proto_with_info"],
grpc_service_config = "bigquerystorage_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "bigquerystorage_v1beta1.yaml",
transport = "grpc+rest",
deps = [
":storage_php_grpc",
@@ -221,7 +225,7 @@ nodejs_gapic_library(
package = "google.cloud.bigquery.storage.v1beta1",
rest_numeric_enums = False,
service_yaml = "bigquerystorage_v1beta1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
@@ -249,6 +253,7 @@ ruby_cloud_gapic_library(
srcs = [":storage_proto_with_info"],
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-bigquery-storage-v1beta1"],
rest_numeric_enums = False,
+ service_yaml = "bigquerystorage_v1beta1.yaml",
deps = [
":storage_ruby_grpc",
":storage_ruby_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/arrow.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/arrow.proto
index f70c61c72..77dbfe3eb 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/arrow.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/arrow.proto
@@ -16,7 +16,7 @@ syntax = "proto3";
package google.cloud.bigquery.storage.v1beta1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1beta1/storagepb;storagepb";
option java_outer_classname = "ArrowProto";
option java_package = "com.google.cloud.bigquery.storage.v1beta1";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/avro.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/avro.proto
index 7d034a28a..222bdcc13 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/avro.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/avro.proto
@@ -16,7 +16,7 @@ syntax = "proto3";
package google.cloud.bigquery.storage.v1beta1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1beta1/storagepb;storagepb";
option java_outer_classname = "AvroProto";
option java_package = "com.google.cloud.bigquery.storage.v1beta1";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/read_options.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/read_options.proto
index 1ff8d8b5e..90fb7f3e4 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/read_options.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/read_options.proto
@@ -16,7 +16,7 @@ syntax = "proto3";
package google.cloud.bigquery.storage.v1beta1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1beta1/storagepb;storagepb";
option java_package = "com.google.cloud.bigquery.storage.v1beta1";
// Options dictating how we read a table.
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/storage.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/storage.proto
index 0d311418a..2bf2a2c09 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/storage.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/storage.proto
@@ -27,7 +27,7 @@ import "google/cloud/bigquery/storage/v1beta1/table_reference.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1beta1/storagepb;storagepb";
option java_package = "com.google.cloud.bigquery.storage.v1beta1";
// BigQuery storage API.
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/table_reference.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/table_reference.proto
index 22c940c0e..9f643cd65 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/table_reference.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta1/table_reference.proto
@@ -18,7 +18,7 @@ package google.cloud.bigquery.storage.v1beta1;
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta1;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1beta1/storagepb;storagepb";
option java_outer_classname = "TableReferenceProto";
option java_package = "com.google.cloud.bigquery.storage.v1beta1";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/BUILD.bazel
index c6e3c8670..7819880d7 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/BUILD.bazel
@@ -111,7 +111,7 @@ load(
go_proto_library(
name = "storage_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta2",
+ importpath = "cloud.google.com/go/bigquery/storage/apiv1beta2/storagepb",
protos = [":storage_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -124,6 +124,8 @@ go_gapic_library(
srcs = [":storage_proto_with_info"],
grpc_service_config = "bigquerystorage_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/storage/apiv1beta2;storage",
+ metadata = True,
+ release_level = "beta",
rest_numeric_enums = False,
service_yaml = "bigquerystorage_v1beta2.yaml",
transport = "grpc+rest",
@@ -168,6 +170,7 @@ py_gapic_library(
"python-gapic-name=bigquery_storage",
],
rest_numeric_enums = False,
+ service_yaml = "bigquerystorage_v1beta2.yaml",
transport = "grpc",
)
@@ -215,6 +218,7 @@ php_gapic_library(
srcs = [":storage_proto_with_info"],
grpc_service_config = "bigquerystorage_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "bigquerystorage_v1beta2.yaml",
transport = "grpc+rest",
deps = [
":storage_php_grpc",
@@ -249,7 +253,7 @@ nodejs_gapic_library(
package = "google.cloud.bigquery.storage.v1beta2",
rest_numeric_enums = False,
service_yaml = "bigquerystorage_v1beta2.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
@@ -287,6 +291,7 @@ nodejs_gapic_assembly_pkg(
# name = "storage_ruby_gapic",
# srcs = [":storage_proto_with_info",],
# extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-bigquery-storage-v1beta2"],
+# service_yaml = "bigquerystorage_v1beta2.yaml",
# deps = [
# ":storage_ruby_grpc",
# ":storage_ruby_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/arrow.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/arrow.proto
index 74fe927b7..8da53dc7b 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/arrow.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/arrow.proto
@@ -16,7 +16,7 @@ syntax = "proto3";
package google.cloud.bigquery.storage.v1beta2;
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta2;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1beta2/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "ArrowProto";
option java_package = "com.google.cloud.bigquery.storage.v1beta2";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/avro.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/avro.proto
index 495132ec1..702b34a8e 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/avro.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/avro.proto
@@ -16,7 +16,7 @@ syntax = "proto3";
package google.cloud.bigquery.storage.v1beta2;
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta2;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1beta2/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "AvroProto";
option java_package = "com.google.cloud.bigquery.storage.v1beta2";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/protobuf.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/protobuf.proto
index 11e851be4..359b8b7d1 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/protobuf.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/protobuf.proto
@@ -18,7 +18,7 @@ package google.cloud.bigquery.storage.v1beta2;
import "google/protobuf/descriptor.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta2;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1beta2/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "ProtoBufProto";
option java_package = "com.google.cloud.bigquery.storage.v1beta2";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/storage.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/storage.proto
index f7d2c341c..b8fca3af5 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/storage.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/storage.proto
@@ -29,7 +29,7 @@ import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
import "google/rpc/status.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta2;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1beta2/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "StorageProto";
option java_package = "com.google.cloud.bigquery.storage.v1beta2";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/stream.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/stream.proto
index d166e9875..e8191af84 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/stream.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/stream.proto
@@ -23,7 +23,7 @@ import "google/cloud/bigquery/storage/v1beta2/avro.proto";
import "google/cloud/bigquery/storage/v1beta2/table.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta2;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1beta2/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "StreamProto";
option java_package = "com.google.cloud.bigquery.storage.v1beta2";
diff --git a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/table.proto b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/table.proto
index 77ca829a4..4ef3360d5 100644
--- a/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/table.proto
+++ b/third_party/googleapis/google/cloud/bigquery/storage/v1beta2/table.proto
@@ -18,7 +18,7 @@ package google.cloud.bigquery.storage.v1beta2;
import "google/api/field_behavior.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/storage/v1beta2;storage";
+option go_package = "cloud.google.com/go/bigquery/storage/apiv1beta2/storagepb;storagepb";
option java_multiple_files = true;
option java_outer_classname = "TableProto";
option java_package = "com.google.cloud.bigquery.storage.v1beta2";
diff --git a/third_party/googleapis/google/cloud/bigquery/v2/BUILD.bazel b/third_party/googleapis/google/cloud/bigquery/v2/BUILD.bazel
index be0062c5e..4305bf479 100644
--- a/third_party/googleapis/google/cloud/bigquery/v2/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/bigquery/v2/BUILD.bazel
@@ -109,7 +109,7 @@ load(
go_proto_library(
name = "bigquery_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/bigquery/v2",
+ importpath = "cloud.google.com/go/bigquery/apiv2/bigquerypb",
protos = [":bigquery_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -121,6 +121,7 @@ go_gapic_library(
srcs = [":bigquery_proto_with_info"],
grpc_service_config = "bigquery_grpc_service_config.json",
importpath = "cloud.google.com/go/bigquery/apiv2;bigquery",
+ release_level = "ga",
rest_numeric_enums = False,
service_yaml = "bigquery_v2.yaml",
transport = "grpc",
@@ -161,6 +162,7 @@ py_gapic_library(
grpc_service_config = "bigquery_grpc_service_config.json",
opt_args = ["autogen-snippets=False"],
rest_numeric_enums = False,
+ service_yaml = "bigquery_v2.yaml",
transport = "grpc",
)
@@ -282,6 +284,7 @@ ruby_cloud_gapic_library(
srcs = [":bigquery_proto_with_info"],
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-bigquery-v2"],
rest_numeric_enums = False,
+ service_yaml = "bigquery_v2.yaml",
deps = [
":bigquery_ruby_grpc",
":bigquery_ruby_proto",
diff --git a/third_party/googleapis/google/cloud/bigquery/v2/encryption_config.proto b/third_party/googleapis/google/cloud/bigquery/v2/encryption_config.proto
index d5d61f2c4..dfbc21832 100644
--- a/third_party/googleapis/google/cloud/bigquery/v2/encryption_config.proto
+++ b/third_party/googleapis/google/cloud/bigquery/v2/encryption_config.proto
@@ -19,7 +19,7 @@ package google.cloud.bigquery.v2;
import "google/api/field_behavior.proto";
import "google/protobuf/wrappers.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/v2;bigquery";
+option go_package = "cloud.google.com/go/bigquery/apiv2/bigquerypb;bigquerypb";
option java_outer_classname = "EncryptionConfigProto";
option java_package = "com.google.cloud.bigquery.v2";
diff --git a/third_party/googleapis/google/cloud/bigquery/v2/model.proto b/third_party/googleapis/google/cloud/bigquery/v2/model.proto
index 27f50f04c..fddd2f5e3 100644
--- a/third_party/googleapis/google/cloud/bigquery/v2/model.proto
+++ b/third_party/googleapis/google/cloud/bigquery/v2/model.proto
@@ -27,7 +27,7 @@ import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
import "google/api/annotations.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/v2;bigquery";
+option go_package = "cloud.google.com/go/bigquery/apiv2/bigquerypb;bigquerypb";
option java_outer_classname = "ModelProto";
option java_package = "com.google.cloud.bigquery.v2";
diff --git a/third_party/googleapis/google/cloud/bigquery/v2/model_reference.proto b/third_party/googleapis/google/cloud/bigquery/v2/model_reference.proto
index 6a447e95d..e50943167 100644
--- a/third_party/googleapis/google/cloud/bigquery/v2/model_reference.proto
+++ b/third_party/googleapis/google/cloud/bigquery/v2/model_reference.proto
@@ -18,7 +18,7 @@ package google.cloud.bigquery.v2;
import "google/api/field_behavior.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/v2;bigquery";
+option go_package = "cloud.google.com/go/bigquery/apiv2/bigquerypb;bigquerypb";
option java_outer_classname = "ModelReferenceProto";
option java_package = "com.google.cloud.bigquery.v2";
diff --git a/third_party/googleapis/google/cloud/bigquery/v2/standard_sql.proto b/third_party/googleapis/google/cloud/bigquery/v2/standard_sql.proto
index f3cf2addd..c8d2c78e6 100644
--- a/third_party/googleapis/google/cloud/bigquery/v2/standard_sql.proto
+++ b/third_party/googleapis/google/cloud/bigquery/v2/standard_sql.proto
@@ -18,7 +18,7 @@ package google.cloud.bigquery.v2;
import "google/api/field_behavior.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/v2;bigquery";
+option go_package = "cloud.google.com/go/bigquery/apiv2/bigquerypb;bigquerypb";
option java_outer_classname = "StandardSqlProto";
option java_package = "com.google.cloud.bigquery.v2";
diff --git a/third_party/googleapis/google/cloud/bigquery/v2/table_reference.proto b/third_party/googleapis/google/cloud/bigquery/v2/table_reference.proto
index 0ccd7d4f7..708e6a602 100644
--- a/third_party/googleapis/google/cloud/bigquery/v2/table_reference.proto
+++ b/third_party/googleapis/google/cloud/bigquery/v2/table_reference.proto
@@ -18,7 +18,7 @@ package google.cloud.bigquery.v2;
import "google/api/field_behavior.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/bigquery/v2;bigquery";
+option go_package = "cloud.google.com/go/bigquery/apiv2/bigquerypb;bigquerypb";
option java_outer_classname = "TableReferenceProto";
option java_package = "com.google.cloud.bigquery.v2";
diff --git a/third_party/googleapis/google/cloud/billing/budgets/v1/BUILD.bazel b/third_party/googleapis/google/cloud/billing/budgets/v1/BUILD.bazel
index a4de198f1..89d1a0dc8 100644
--- a/third_party/googleapis/google/cloud/billing/budgets/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/billing/budgets/v1/BUILD.bazel
@@ -124,7 +124,7 @@ java_gapic_assembly_gradle_pkg(
go_proto_library(
name = "budgets_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/billing/budgets/v1",
+ importpath = "cloud.google.com/go/billing/budgets/apiv1/budgetspb",
protos = [":budgets_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -139,6 +139,7 @@ go_gapic_library(
grpc_service_config = "billingbudgets_grpc_service_config.json",
importpath = "cloud.google.com/go/billing/budgets/apiv1;budgets",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "billingbudgets.yaml",
transport = "grpc+rest",
@@ -170,7 +171,8 @@ py_gapic_library(
srcs = [":budgets_proto"],
grpc_service_config = "billingbudgets_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "billingbudgets.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -271,6 +273,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Provides methods to view, create, and manage Cloud Billing budgets programmatically at scale.",
ruby_cloud_title = "Billing Budgets V1",
+ service_yaml = "billingbudgets.yaml",
deps = [
":budgets_ruby_grpc",
":budgets_ruby_proto",
@@ -305,6 +308,7 @@ csharp_gapic_library(
grpc_service_config = "billingbudgets_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "billingbudgets.yaml",
+ transport = "grpc+rest",
deps = [
":budgets_csharp_grpc",
":budgets_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/billing/budgets/v1/budget_model.proto b/third_party/googleapis/google/cloud/billing/budgets/v1/budget_model.proto
index 6758f5ca9..6fd3f0b1a 100644
--- a/third_party/googleapis/google/cloud/billing/budgets/v1/budget_model.proto
+++ b/third_party/googleapis/google/cloud/billing/budgets/v1/budget_model.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/type/date.proto";
import "google/type/money.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/billing/budgets/v1;budgets";
+option go_package = "cloud.google.com/go/billing/budgets/apiv1/budgetspb;budgetspb";
option java_multiple_files = true;
option java_outer_classname = "BudgetModelProto";
option java_package = "com.google.cloud.billing.budgets.v1";
diff --git a/third_party/googleapis/google/cloud/billing/budgets/v1/budget_service.proto b/third_party/googleapis/google/cloud/billing/budgets/v1/budget_service.proto
index a4b512b8a..c5dd2f85c 100644
--- a/third_party/googleapis/google/cloud/billing/budgets/v1/budget_service.proto
+++ b/third_party/googleapis/google/cloud/billing/budgets/v1/budget_service.proto
@@ -24,7 +24,7 @@ import "google/cloud/billing/budgets/v1/budget_model.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/billing/budgets/v1;budgets";
+option go_package = "cloud.google.com/go/billing/budgets/apiv1/budgetspb;budgetspb";
option java_multiple_files = true;
option java_outer_classname = "BudgetServiceProto";
option java_package = "com.google.cloud.billing.budgets.v1";
diff --git a/third_party/googleapis/google/cloud/billing/budgets/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/billing/budgets/v1beta1/BUILD.bazel
index 4c6cf343c..c975c001a 100644
--- a/third_party/googleapis/google/cloud/billing/budgets/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/billing/budgets/v1beta1/BUILD.bazel
@@ -117,7 +117,7 @@ load(
go_proto_library(
name = "budgets_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/billing/budgets/v1beta1",
+ importpath = "cloud.google.com/go/billing/budgets/apiv1beta1/budgetspb",
protos = [":budgets_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -132,6 +132,7 @@ go_gapic_library(
grpc_service_config = "billingbudgets_grpc_service_config.json",
importpath = "cloud.google.com/go/billing/budgets/apiv1beta1;budgets",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "billingbudgets.yaml",
transport = "grpc+rest",
@@ -173,6 +174,7 @@ py_gapic_library(
srcs = [":budgets_proto"],
grpc_service_config = "billingbudgets_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "billingbudgets.yaml",
transport = "grpc",
)
@@ -221,6 +223,7 @@ php_gapic_library(
srcs = [":budgets_proto_with_info"],
grpc_service_config = "billingbudgets_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "billingbudgets.yaml",
transport = "grpc+rest",
deps = [
":budgets_php_grpc",
@@ -256,7 +259,7 @@ nodejs_gapic_library(
package = "google.cloud.billing.budgets.v1beta1",
rest_numeric_enums = True,
service_yaml = "billingbudgets.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
@@ -304,6 +307,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Provides methods to view, create, and manage Cloud Billing budgets programmatically at scale.",
ruby_cloud_title = "Billing Budgets V1beta1",
+ service_yaml = "billingbudgets.yaml",
deps = [
":budgets_ruby_grpc",
":budgets_ruby_proto",
@@ -349,6 +353,7 @@ csharp_gapic_library(
grpc_service_config = "billingbudgets_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "billingbudgets.yaml",
+ transport = "grpc",
deps = [
":budgets_csharp_grpc",
":budgets_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/billing/budgets/v1beta1/budget_model.proto b/third_party/googleapis/google/cloud/billing/budgets/v1beta1/budget_model.proto
index c269c8194..167e8e465 100644
--- a/third_party/googleapis/google/cloud/billing/budgets/v1beta1/budget_model.proto
+++ b/third_party/googleapis/google/cloud/billing/budgets/v1beta1/budget_model.proto
@@ -22,7 +22,7 @@ import "google/protobuf/struct.proto";
import "google/type/date.proto";
import "google/type/money.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/billing/budgets/v1beta1;budgets";
+option go_package = "cloud.google.com/go/billing/budgets/apiv1beta1/budgetspb;budgetspb";
option java_multiple_files = true;
option java_package = "com.google.cloud.billing.budgets.v1beta1";
diff --git a/third_party/googleapis/google/cloud/billing/budgets/v1beta1/budget_service.proto b/third_party/googleapis/google/cloud/billing/budgets/v1beta1/budget_service.proto
index e38c0aa35..3651785ea 100644
--- a/third_party/googleapis/google/cloud/billing/budgets/v1beta1/budget_service.proto
+++ b/third_party/googleapis/google/cloud/billing/budgets/v1beta1/budget_service.proto
@@ -24,7 +24,7 @@ import "google/cloud/billing/budgets/v1beta1/budget_model.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/billing/budgets/v1beta1;budgets";
+option go_package = "cloud.google.com/go/billing/budgets/apiv1beta1/budgetspb;budgetspb";
option java_multiple_files = true;
option java_package = "com.google.cloud.billing.budgets.v1beta1";
diff --git a/third_party/googleapis/google/cloud/billing/v1/BUILD.bazel b/third_party/googleapis/google/cloud/billing/v1/BUILD.bazel
index 436c3e520..65f2ab853 100644
--- a/third_party/googleapis/google/cloud/billing/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/billing/v1/BUILD.bazel
@@ -125,7 +125,7 @@ load(
go_proto_library(
name = "billing_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/billing/v1",
+ importpath = "cloud.google.com/go/billing/apiv1/billingpb",
protos = [":billing_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -140,6 +140,7 @@ go_gapic_library(
grpc_service_config = "cloud_billing_grpc_service_config.json",
importpath = "cloud.google.com/go/billing/apiv1;billing",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "cloudbilling_v1.yaml",
transport = "grpc+rest",
@@ -183,7 +184,7 @@ py_gapic_library(
grpc_service_config = "cloud_billing_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "cloudbilling_v1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -364,6 +365,7 @@ csharp_gapic_library(
grpc_service_config = "cloud_billing_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "cloudbilling_v1.yaml",
+ transport = "grpc+rest",
deps = [
":billing_csharp_grpc",
":billing_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/billing/v1/cloud_billing.proto b/third_party/googleapis/google/cloud/billing/v1/cloud_billing.proto
index b98f0fd7c..be9f94719 100644
--- a/third_party/googleapis/google/cloud/billing/v1/cloud_billing.proto
+++ b/third_party/googleapis/google/cloud/billing/v1/cloud_billing.proto
@@ -24,7 +24,7 @@ import "google/iam/v1/iam_policy.proto";
import "google/iam/v1/policy.proto";
import "google/protobuf/field_mask.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/billing/v1;billing";
+option go_package = "cloud.google.com/go/billing/apiv1/billingpb;billingpb";
option java_multiple_files = true;
option java_outer_classname = "CloudBillingProto";
option java_package = "com.google.cloud.billing.v1";
@@ -51,7 +51,8 @@ service CloudBilling {
// Lists the billing accounts that the current authenticated user has
// permission to
// [view](https://cloud.google.com/billing/docs/how-to/billing-access).
- rpc ListBillingAccounts(ListBillingAccountsRequest) returns (ListBillingAccountsResponse) {
+ rpc ListBillingAccounts(ListBillingAccountsRequest)
+ returns (ListBillingAccountsResponse) {
option (google.api.http) = {
get: "/v1/billingAccounts"
};
@@ -64,7 +65,8 @@ service CloudBilling {
// IAM permission, which is typically given to the
// [administrator](https://cloud.google.com/billing/docs/how-to/billing-access)
// of the billing account.
- rpc UpdateBillingAccount(UpdateBillingAccountRequest) returns (BillingAccount) {
+ rpc UpdateBillingAccount(UpdateBillingAccountRequest)
+ returns (BillingAccount) {
option (google.api.http) = {
patch: "/v1/{name=billingAccounts/*}"
body: "account"
@@ -87,7 +89,8 @@ service CloudBilling {
// [administrators](https://cloud.google.com/billing/docs/how-to/billing-access).
// This method will return an error if the parent account has not been
// provisioned as a reseller account.
- rpc CreateBillingAccount(CreateBillingAccountRequest) returns (BillingAccount) {
+ rpc CreateBillingAccount(CreateBillingAccountRequest)
+ returns (BillingAccount) {
option (google.api.http) = {
post: "/v1/billingAccounts"
body: "billing_account"
@@ -99,7 +102,8 @@ service CloudBilling {
// authenticated user must have the `billing.resourceAssociations.list` IAM
// permission, which is often given to billing account
// [viewers](https://cloud.google.com/billing/docs/how-to/billing-access).
- rpc ListProjectBillingInfo(ListProjectBillingInfoRequest) returns (ListProjectBillingInfoResponse) {
+ rpc ListProjectBillingInfo(ListProjectBillingInfoRequest)
+ returns (ListProjectBillingInfoResponse) {
option (google.api.http) = {
get: "/v1/{name=billingAccounts/*}/projects"
};
@@ -111,7 +115,8 @@ service CloudBilling {
// which can be granted by assigning the [Project
// Viewer](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles)
// role.
- rpc GetProjectBillingInfo(GetProjectBillingInfoRequest) returns (ProjectBillingInfo) {
+ rpc GetProjectBillingInfo(GetProjectBillingInfoRequest)
+ returns (ProjectBillingInfo) {
option (google.api.http) = {
get: "/v1/{name=projects/*}/billingInfo"
};
@@ -149,7 +154,8 @@ service CloudBilling {
// 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.
- rpc UpdateProjectBillingInfo(UpdateProjectBillingInfoRequest) returns (ProjectBillingInfo) {
+ rpc UpdateProjectBillingInfo(UpdateProjectBillingInfoRequest)
+ returns (ProjectBillingInfo) {
option (google.api.http) = {
put: "/v1/{name=projects/*}/billingInfo"
body: "project_billing_info"
@@ -161,7 +167,8 @@ service CloudBilling {
// The caller must have the `billing.accounts.getIamPolicy` permission on the
// account, which is often given to billing account
// [viewers](https://cloud.google.com/billing/docs/how-to/billing-access).
- rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) {
+ rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
+ returns (google.iam.v1.Policy) {
option (google.api.http) = {
get: "/v1/{resource=billingAccounts/*}:getIamPolicy"
};
@@ -173,7 +180,8 @@ service CloudBilling {
// The caller must have the `billing.accounts.setIamPolicy` permission on the
// account, which is often given to billing account
// [administrators](https://cloud.google.com/billing/docs/how-to/billing-access).
- rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) {
+ rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
+ returns (google.iam.v1.Policy) {
option (google.api.http) = {
post: "/v1/{resource=billingAccounts/*}:setIamPolicy"
body: "*"
@@ -184,7 +192,8 @@ service CloudBilling {
// Tests the access control policy for a billing account. This method takes
// the resource and a set of permissions as input and returns the subset of
// the input permissions that the caller is allowed for that resource.
- rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) {
+ rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
+ returns (google.iam.v1.TestIamPermissionsResponse) {
option (google.api.http) = {
post: "/v1/{resource=billingAccounts/*}:testIamPermissions"
body: "*"
@@ -197,8 +206,8 @@ service CloudBilling {
// [Google Cloud Console](https://console.cloud.google.com/). You can assign a
// billing account to one or more projects.
message BillingAccount {
- // Output only. The resource name of the billing account. The resource name has the form
- // `billingAccounts/{billing_account_id}`. For example,
+ // Output only. The resource name of the billing account. The resource name
+ // has the form `billingAccounts/{billing_account_id}`. For example,
// `billingAccounts/012345-567890-ABCDEF` would be the resource name for
// billing account `012345-567890-ABCDEF`.
string name = 1 [
@@ -208,9 +217,10 @@ message BillingAccount {
}
];
- // Output only. True if the billing account is open, and will therefore be charged for any
- // usage on associated projects. False if the billing account is closed, and
- // therefore projects associated with it will be unable to use paid services.
+ // Output only. True if the billing account is open, and will therefore be
+ // charged for any usage on associated projects. False if the billing account
+ // is closed, and therefore projects associated with it will be unable to use
+ // paid services.
bool open = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// The display name given to the billing account, such as `My Billing
@@ -253,8 +263,8 @@ message ProjectBillingInfo {
// Request message for `GetBillingAccount`.
message GetBillingAccountRequest {
- // Required. The resource name of the billing account to retrieve. For example,
- // `billingAccounts/012345-567890-ABCDEF`.
+ // Required. The resource name of the billing account to retrieve. For
+ // example, `billingAccounts/012345-567890-ABCDEF`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -313,7 +323,8 @@ message UpdateBillingAccountRequest {
}
];
- // Required. The billing account resource to replace the resource on the server.
+ // Required. The billing account resource to replace the resource on the
+ // server.
BillingAccount account = 2 [(google.api.field_behavior) = REQUIRED];
// The update mask applied to the resource.
@@ -323,8 +334,9 @@ message UpdateBillingAccountRequest {
// Request message for `ListProjectBillingInfo`.
message ListProjectBillingInfoRequest {
- // Required. The resource name of the billing account associated with the projects that
- // you want to list. For example, `billingAccounts/012345-567890-ABCDEF`.
+ // Required. The resource name of the billing account associated with the
+ // projects that you want to list. For example,
+ // `billingAccounts/012345-567890-ABCDEF`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -363,8 +375,9 @@ message GetProjectBillingInfoRequest {
// Request message for `UpdateProjectBillingInfo`.
message UpdateProjectBillingInfoRequest {
- // Required. The resource name of the project associated with the billing information
- // that you want to update. For example, `projects/tokyo-rain-123`.
+ // Required. The resource name of the project associated with the billing
+ // information that you want to update. For example,
+ // `projects/tokyo-rain-123`.
string name = 1 [(google.api.field_behavior) = REQUIRED];
// The new billing information for the project. Read-only fields are ignored;
diff --git a/third_party/googleapis/google/cloud/billing/v1/cloud_catalog.proto b/third_party/googleapis/google/cloud/billing/v1/cloud_catalog.proto
index f3d46e627..1cbb8c18a 100644
--- a/third_party/googleapis/google/cloud/billing/v1/cloud_catalog.proto
+++ b/third_party/googleapis/google/cloud/billing/v1/cloud_catalog.proto
@@ -24,7 +24,7 @@ import "google/protobuf/timestamp.proto";
import "google/type/money.proto";
option csharp_namespace = "Google.Cloud.Billing.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/billing/v1;billing";
+option go_package = "cloud.google.com/go/billing/apiv1/billingpb;billingpb";
option java_multiple_files = true;
option java_outer_classname = "CloudCatalogProto";
option java_package = "com.google.cloud.billing.v1";
diff --git a/third_party/googleapis/google/cloud/binaryauthorization/v1/BUILD.bazel b/third_party/googleapis/google/cloud/binaryauthorization/v1/BUILD.bazel
index 1f1adfa29..5963408fc 100644
--- a/third_party/googleapis/google/cloud/binaryauthorization/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/binaryauthorization/v1/BUILD.bazel
@@ -124,7 +124,7 @@ load(
go_proto_library(
name = "binaryauthorization_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/binaryauthorization/v1",
+ importpath = "cloud.google.com/go/binaryauthorization/apiv1/binaryauthorizationpb",
protos = [":binaryauthorization_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -138,6 +138,7 @@ go_gapic_library(
grpc_service_config = "binaryauthorization_grpc_service_config.json",
importpath = "cloud.google.com/go/binaryauthorization/apiv1;binaryauthorization",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "binaryauthorization_v1.yaml",
transport = "grpc+rest",
@@ -182,7 +183,8 @@ py_gapic_library(
"warehouse-package-name=google-cloud-binary-authorization",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "binaryauthorization_v1.yaml",
+ transport = "grpc+rest",
deps = [
"//grafeas/v1:grafeas_py_proto",
],
@@ -321,6 +323,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Binary Authorization is a service on Google Cloud that provides centralized software supply-chain security for applications that run on Google Kubernetes Engine (GKE) and GKE on-prem.",
ruby_cloud_title = "Binary Authorization V1",
+ service_yaml = "binaryauthorization_v1.yaml",
deps = [
":binaryauthorization_ruby_grpc",
":binaryauthorization_ruby_proto",
@@ -366,6 +369,7 @@ csharp_gapic_library(
grpc_service_config = "binaryauthorization_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "binaryauthorization_v1.yaml",
+ transport = "grpc+rest",
deps = [
":binaryauthorization_csharp_grpc",
":binaryauthorization_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/binaryauthorization/v1/resources.proto b/third_party/googleapis/google/cloud/binaryauthorization/v1/resources.proto
index 5df7f58bd..de81309f0 100644
--- a/third_party/googleapis/google/cloud/binaryauthorization/v1/resources.proto
+++ b/third_party/googleapis/google/cloud/binaryauthorization/v1/resources.proto
@@ -22,7 +22,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.BinaryAuthorization.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/binaryauthorization/v1;binaryauthorization";
+option go_package = "cloud.google.com/go/binaryauthorization/apiv1/binaryauthorizationpb;binaryauthorizationpb";
option java_multiple_files = false;
option java_package = "com.google.protos.google.cloud.binaryauthorization.v1";
option php_namespace = "Google\\Cloud\\BinaryAuthorization\\V1";
diff --git a/third_party/googleapis/google/cloud/binaryauthorization/v1/service.proto b/third_party/googleapis/google/cloud/binaryauthorization/v1/service.proto
index e063aacc0..7cbfbdc05 100644
--- a/third_party/googleapis/google/cloud/binaryauthorization/v1/service.proto
+++ b/third_party/googleapis/google/cloud/binaryauthorization/v1/service.proto
@@ -26,7 +26,7 @@ import "grafeas/v1/attestation.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.BinaryAuthorization.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/binaryauthorization/v1;binaryauthorization";
+option go_package = "cloud.google.com/go/binaryauthorization/apiv1/binaryauthorizationpb;binaryauthorizationpb";
option java_multiple_files = false;
option java_package = "com.google.protos.google.cloud.binaryauthorization.v1";
option php_namespace = "Google\\Cloud\\BinaryAuthorization\\V1";
diff --git a/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/BUILD.bazel
index f5ea9e154..37cdf4c09 100644
--- a/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/BUILD.bazel
@@ -116,7 +116,7 @@ load(
go_proto_library(
name = "binaryauthorization_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/binaryauthorization/v1beta1",
+ importpath = "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb",
protos = [":binaryauthorization_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -129,6 +129,7 @@ go_gapic_library(
grpc_service_config = "binaryauthorization_grpc_service_config.json",
importpath = "cloud.google.com/go/binaryauthorization/apiv1beta1;binaryauthorization",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "binaryauthorization_v1beta1.yaml",
transport = "grpc+rest",
@@ -173,7 +174,8 @@ py_gapic_library(
"warehouse-package-name=google-cloud-binary-authorization",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "binaryauthorization_v1beta1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -306,6 +308,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Binary Authorization is a service on Google Cloud that provides centralized software supply-chain security for applications that run on Google Kubernetes Engine (GKE) and GKE on-prem.",
ruby_cloud_title = "Binary Authorization V1beta1",
+ service_yaml = "binaryauthorization_v1beta1.yaml",
deps = [
":binaryauthorization_ruby_grpc",
":binaryauthorization_ruby_proto",
@@ -351,6 +354,7 @@ csharp_gapic_library(
grpc_service_config = "binaryauthorization_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "binaryauthorization_v1beta1.yaml",
+ transport = "grpc+rest",
deps = [
":binaryauthorization_csharp_grpc",
":binaryauthorization_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/continuous_validation_logging.proto b/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/continuous_validation_logging.proto
index 1666b5189..c4539f8c2 100644
--- a/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/continuous_validation_logging.proto
+++ b/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/continuous_validation_logging.proto
@@ -20,7 +20,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.BinaryAuthorization.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/binaryauthorization/v1beta1;binaryauthorization";
+option go_package = "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb;binaryauthorizationpb";
option java_multiple_files = true;
option java_outer_classname = "ContinuousValidationLoggingProto";
option java_package = "com.google.cloud.binaryauthorization.v1beta1";
diff --git a/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/resources.proto b/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/resources.proto
index 28c18f99a..5855bd7f7 100644
--- a/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/resources.proto
+++ b/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/resources.proto
@@ -22,7 +22,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.BinaryAuthorization.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/binaryauthorization/v1beta1;binaryauthorization";
+option go_package = "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb;binaryauthorizationpb";
option java_multiple_files = true;
option java_outer_classname = "BinaryAuthorizationResourcesProto";
option java_package = "com.google.cloud.binaryauthorization.v1beta1";
diff --git a/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/service.proto b/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/service.proto
index 90e63b4d4..c8502637f 100644
--- a/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/service.proto
+++ b/third_party/googleapis/google/cloud/binaryauthorization/v1beta1/service.proto
@@ -25,7 +25,7 @@ import "google/protobuf/empty.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.BinaryAuthorization.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/binaryauthorization/v1beta1;binaryauthorization";
+option go_package = "cloud.google.com/go/binaryauthorization/apiv1beta1/binaryauthorizationpb;binaryauthorizationpb";
option java_multiple_files = true;
option java_outer_classname = "BinaryAuthorizationServiceProto";
option java_package = "com.google.cloud.binaryauthorization.v1beta1";
diff --git a/third_party/googleapis/google/cloud/certificatemanager/logging/v1/BUILD.bazel b/third_party/googleapis/google/cloud/certificatemanager/logging/v1/BUILD.bazel
index 995388978..2d1b030a1 100644
--- a/third_party/googleapis/google/cloud/certificatemanager/logging/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/certificatemanager/logging/v1/BUILD.bazel
@@ -49,7 +49,7 @@ load(
go_proto_library(
name = "logging_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/certificatemanager/logging/v1",
+ importpath = "cloud.google.com/go/certificatemanager/logging/apiv1/loggingpb",
protos = [":logging_proto"],
deps = [
],
diff --git a/third_party/googleapis/google/cloud/certificatemanager/logging/v1/logs.proto b/third_party/googleapis/google/cloud/certificatemanager/logging/v1/logs.proto
index 625027755..6f3fe56fa 100644
--- a/third_party/googleapis/google/cloud/certificatemanager/logging/v1/logs.proto
+++ b/third_party/googleapis/google/cloud/certificatemanager/logging/v1/logs.proto
@@ -19,7 +19,7 @@ package google.cloud.certificatemanager.logging.v1;
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.CertificateManager.Logging.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/certificatemanager/logging/v1;logging";
+option go_package = "cloud.google.com/go/certificatemanager/logging/apiv1/loggingpb;loggingpb";
option java_multiple_files = true;
option java_outer_classname = "LogsProto";
option java_package = "com.google.cloud.certificatemanager.logging.v1";
diff --git a/third_party/googleapis/google/cloud/certificatemanager/v1/BUILD.bazel b/third_party/googleapis/google/cloud/certificatemanager/v1/BUILD.bazel
index d9e04a5f5..a9c8ef8bb 100644
--- a/third_party/googleapis/google/cloud/certificatemanager/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/certificatemanager/v1/BUILD.bazel
@@ -31,6 +31,7 @@ proto_library(
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"@com_google_protobuf//:duration_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
@@ -123,7 +124,7 @@ load(
go_proto_library(
name = "certificatemanager_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/certificatemanager/v1",
+ importpath = "cloud.google.com/go/certificatemanager/apiv1/certificatemanagerpb",
protos = [":certificatemanager_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -137,6 +138,7 @@ go_gapic_library(
grpc_service_config = "certificatemanager_grpc_service_config.json",
importpath = "cloud.google.com/go/certificatemanager/apiv1;certificatemanager",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "certificatemanager_v1.yaml",
transport = "grpc+rest",
@@ -189,7 +191,7 @@ py_gapic_library(
],
rest_numeric_enums = True,
service_yaml = "certificatemanager_v1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
],
)
@@ -368,6 +370,7 @@ csharp_gapic_library(
grpc_service_config = "certificatemanager_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "certificatemanager_v1.yaml",
+ transport = "grpc+rest",
deps = [
":certificatemanager_csharp_grpc",
":certificatemanager_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/certificatemanager/v1/certificate_issuance_config.proto b/third_party/googleapis/google/cloud/certificatemanager/v1/certificate_issuance_config.proto
index 629cb5944..3d20aa0b8 100644
--- a/third_party/googleapis/google/cloud/certificatemanager/v1/certificate_issuance_config.proto
+++ b/third_party/googleapis/google/cloud/certificatemanager/v1/certificate_issuance_config.proto
@@ -22,7 +22,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.CertificateManager.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/certificatemanager/v1;certificatemanager";
+option go_package = "cloud.google.com/go/certificatemanager/apiv1/certificatemanagerpb;certificatemanagerpb";
option java_multiple_files = true;
option java_outer_classname = "CertificateIssuanceConfigProto";
option java_package = "com.google.cloud.certificatemanager.v1";
diff --git a/third_party/googleapis/google/cloud/certificatemanager/v1/certificate_manager.proto b/third_party/googleapis/google/cloud/certificatemanager/v1/certificate_manager.proto
index 07b4c0859..6cfbf6ac0 100644
--- a/third_party/googleapis/google/cloud/certificatemanager/v1/certificate_manager.proto
+++ b/third_party/googleapis/google/cloud/certificatemanager/v1/certificate_manager.proto
@@ -22,11 +22,12 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/certificatemanager/v1/certificate_issuance_config.proto";
import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.CertificateManager.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/certificatemanager/v1;certificatemanager";
+option go_package = "cloud.google.com/go/certificatemanager/apiv1/certificatemanagerpb;certificatemanagerpb";
option java_multiple_files = true;
option java_outer_classname = "CertificateManagerProto";
option java_package = "com.google.cloud.certificatemanager.v1";
@@ -46,15 +47,15 @@ option ruby_package = "Google::Cloud::CertificateManager::V1";
//
// The Certificates Manager service exposes the following resources:
//
-// * `Certificate` which describes a single TLS certificate.
-// * `CertificateMap` which describes a collection of certificates that can be
+// * `Certificate` that describes a single TLS certificate.
+// * `CertificateMap` that describes a collection of certificates that can be
// attached to a target resource.
-// * `CertificateMapEntry` which describes a single configuration entry that
+// * `CertificateMapEntry` that describes a single configuration entry that
// consists of a SNI and a group of certificates. It's a subresource of
// CertificateMap.
//
// Certificate, CertificateMap and CertificateMapEntry IDs
-// have to match "^[a-z0-9-]{1,63}$" regexp, which means that
+// have to fully match the regexp `[a-z0-9-]{1,63}`. In other words,
// - only lower case letters, digits, and hyphen are allowed
// - length of the resource ID has to be in [1,63] range.
//
@@ -794,7 +795,9 @@ message Certificate {
// Certificate Manager provisions and renews Managed Certificates
// automatically, for as long as it's authorized to do so.
message ManagedCertificate {
+ // State of the managed certificate resource.
enum State {
+ // State is unspecified.
STATE_UNSPECIFIED = 0;
// Certificate Manager attempts to provision or renew the certificate.
@@ -815,7 +818,9 @@ message Certificate {
// Information about issues with provisioning a Managed Certificate.
message ProvisioningIssue {
+ // Reason for provisioning failures.
enum Reason {
+ // Reason is unspecified.
REASON_UNSPECIFIED = 0;
// Certificate provisioning failed due to an issue with one or more of
@@ -841,7 +846,9 @@ message Certificate {
// State of the latest attempt to authorize a domain for certificate
// issuance.
message AuthorizationAttemptInfo {
+ // State of the domain for managed certificate issuance.
enum State {
+ // State is unspecified.
STATE_UNSPECIFIED = 0;
// Certificate provisioning for this domain is under way. GCP will
@@ -857,7 +864,9 @@ message Certificate {
FAILED = 7;
}
+ // Reason for failure of the authorization attempt for the domain.
enum FailureReason {
+ // FailureReason is unspecified.
FAILURE_REASON_UNSPECIFIED = 0;
// There was a problem with the user's DNS or load balancer
@@ -904,7 +913,7 @@ message Certificate {
}
];
- // The resource name for a
+ // Immutable. The resource name for a
// [CertificateIssuanceConfig][google.cloud.certificatemanager.v1.CertificateIssuanceConfig]
// used to configure private PKI certificates in the format
// `projects/*/locations/*/certificateIssuanceConfigs/*`.
@@ -993,7 +1002,7 @@ message CertificateMap {
pattern: "projects/{project}/locations/{location}/certificateMaps/{certificate_map}"
};
- // Describes a Target Proxy which uses this Certificate Map.
+ // Describes a Target Proxy that uses this Certificate Map.
message GclbTarget {
// Defines IP configuration where this Certificate Map is serving.
message IpConfig {
@@ -1042,7 +1051,7 @@ message CertificateMap {
// Set of labels associated with a Certificate Map.
map labels = 3;
- // Output only. A list of GCLB targets which use this Certificate Map.
+ // Output only. A list of GCLB targets that use this Certificate Map.
// A Target Proxy is only present on this list if it's attached to a
// Forwarding Rule.
repeated GclbTarget gclb_targets = 4
@@ -1097,7 +1106,7 @@ message CertificateMapEntry {
}
// A set of Certificates defines for the given `hostname`. There can be
- // defined up to fifteen certificates in each Certificate Map Entry. Each
+ // defined up to four certificates in each Certificate Map Entry. Each
// certificate must match pattern `projects/*/locations/*/certificates/*`.
repeated string certificates = 7 [(google.api.resource_reference) = {
type: "certificatemanager.googleapis.com/Certificate"
@@ -1150,7 +1159,7 @@ message DnsAuthorization {
// One or more paragraphs of text description of a DnsAuthorization.
string description = 5;
- // Required. Immutable. A domain which is being authorized. A DnsAuthorization
+ // Required. Immutable. A domain that is being authorized. A DnsAuthorization
// resource covers a single domain and its wildcard, e.g. authorization for
// `example.com` can be used to issue certificates for `example.com` and
// `*.example.com`.
diff --git a/third_party/googleapis/google/cloud/channel/v1/BUILD.bazel b/third_party/googleapis/google/cloud/channel/v1/BUILD.bazel
index 3bd7a0614..4fb0faedb 100644
--- a/third_party/googleapis/google/cloud/channel/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/channel/v1/BUILD.bazel
@@ -135,7 +135,7 @@ load(
go_proto_library(
name = "channel_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/channel/v1",
+ importpath = "cloud.google.com/go/channel/apiv1/channelpb",
protos = [":channel_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -154,6 +154,7 @@ go_gapic_library(
grpc_service_config = "cloudchannel_grpc_service_config.json",
importpath = "cloud.google.com/go/channel/apiv1;channel",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "cloudchannel_v1.yaml",
transport = "grpc+rest",
@@ -332,6 +333,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "You can use Channel Services to manage your relationships with your partners and your customers. Channel Services include a console and APIs to view and provision links between distributors and resellers, customers and entitlements.",
ruby_cloud_title = "Cloud Channel V1",
+ service_yaml = "cloudchannel_v1.yaml",
deps = [
":channel_ruby_grpc",
":channel_ruby_proto",
@@ -377,6 +379,7 @@ csharp_gapic_library(
grpc_service_config = "cloudchannel_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "cloudchannel_v1.yaml",
+ transport = "grpc+rest",
deps = [
":channel_csharp_grpc",
":channel_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/channel/v1/channel_partner_links.proto b/third_party/googleapis/google/cloud/channel/v1/channel_partner_links.proto
index d0607af27..5f51b3f2e 100644
--- a/third_party/googleapis/google/cloud/channel/v1/channel_partner_links.proto
+++ b/third_party/googleapis/google/cloud/channel/v1/channel_partner_links.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/cloud/channel/v1/common.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
+option go_package = "cloud.google.com/go/channel/apiv1/channelpb;channelpb";
option java_multiple_files = true;
option java_outer_classname = "ChannelPartnerLinksProto";
option java_package = "com.google.cloud.channel.v1";
diff --git a/third_party/googleapis/google/cloud/channel/v1/common.proto b/third_party/googleapis/google/cloud/channel/v1/common.proto
index 2380722ac..9e899fd78 100644
--- a/third_party/googleapis/google/cloud/channel/v1/common.proto
+++ b/third_party/googleapis/google/cloud/channel/v1/common.proto
@@ -19,7 +19,7 @@ package google.cloud.channel.v1;
import "google/api/field_behavior.proto";
import "google/protobuf/any.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
+option go_package = "cloud.google.com/go/channel/apiv1/channelpb;channelpb";
option java_multiple_files = true;
option java_outer_classname = "CommonProto";
option java_package = "com.google.cloud.channel.v1";
diff --git a/third_party/googleapis/google/cloud/channel/v1/customers.proto b/third_party/googleapis/google/cloud/channel/v1/customers.proto
index 18bf1ad99..e355420c8 100644
--- a/third_party/googleapis/google/cloud/channel/v1/customers.proto
+++ b/third_party/googleapis/google/cloud/channel/v1/customers.proto
@@ -22,7 +22,7 @@ import "google/cloud/channel/v1/common.proto";
import "google/protobuf/timestamp.proto";
import "google/type/postal_address.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
+option go_package = "cloud.google.com/go/channel/apiv1/channelpb;channelpb";
option java_multiple_files = true;
option java_outer_classname = "CustomersProto";
option java_package = "com.google.cloud.channel.v1";
diff --git a/third_party/googleapis/google/cloud/channel/v1/entitlements.proto b/third_party/googleapis/google/cloud/channel/v1/entitlements.proto
index 8a6633b14..9fef42d0e 100644
--- a/third_party/googleapis/google/cloud/channel/v1/entitlements.proto
+++ b/third_party/googleapis/google/cloud/channel/v1/entitlements.proto
@@ -23,7 +23,7 @@ import "google/cloud/channel/v1/offers.proto";
import "google/cloud/channel/v1/products.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
+option go_package = "cloud.google.com/go/channel/apiv1/channelpb;channelpb";
option java_multiple_files = true;
option java_outer_classname = "EntitlementsProto";
option java_package = "com.google.cloud.channel.v1";
diff --git a/third_party/googleapis/google/cloud/channel/v1/offers.proto b/third_party/googleapis/google/cloud/channel/v1/offers.proto
index 3a5040453..eb24f871d 100644
--- a/third_party/googleapis/google/cloud/channel/v1/offers.proto
+++ b/third_party/googleapis/google/cloud/channel/v1/offers.proto
@@ -23,7 +23,7 @@ import "google/cloud/channel/v1/products.proto";
import "google/protobuf/timestamp.proto";
import "google/type/money.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
+option go_package = "cloud.google.com/go/channel/apiv1/channelpb;channelpb";
option java_multiple_files = true;
option java_outer_classname = "OffersProto";
option java_package = "com.google.cloud.channel.v1";
diff --git a/third_party/googleapis/google/cloud/channel/v1/operations.proto b/third_party/googleapis/google/cloud/channel/v1/operations.proto
index e9e190772..242ae3d8a 100644
--- a/third_party/googleapis/google/cloud/channel/v1/operations.proto
+++ b/third_party/googleapis/google/cloud/channel/v1/operations.proto
@@ -16,7 +16,7 @@ syntax = "proto3";
package google.cloud.channel.v1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
+option go_package = "cloud.google.com/go/channel/apiv1/channelpb;channelpb";
option java_multiple_files = true;
option java_outer_classname = "OperationsProto";
option java_package = "com.google.cloud.channel.v1";
diff --git a/third_party/googleapis/google/cloud/channel/v1/products.proto b/third_party/googleapis/google/cloud/channel/v1/products.proto
index 411e1698b..07c50c65d 100644
--- a/third_party/googleapis/google/cloud/channel/v1/products.proto
+++ b/third_party/googleapis/google/cloud/channel/v1/products.proto
@@ -18,7 +18,7 @@ package google.cloud.channel.v1;
import "google/api/resource.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
+option go_package = "cloud.google.com/go/channel/apiv1/channelpb;channelpb";
option java_multiple_files = true;
option java_outer_classname = "ProductsProto";
option java_package = "com.google.cloud.channel.v1";
diff --git a/third_party/googleapis/google/cloud/channel/v1/reports_service.proto b/third_party/googleapis/google/cloud/channel/v1/reports_service.proto
index 1cb87124c..ed3211bb2 100644
--- a/third_party/googleapis/google/cloud/channel/v1/reports_service.proto
+++ b/third_party/googleapis/google/cloud/channel/v1/reports_service.proto
@@ -27,7 +27,7 @@ import "google/type/datetime.proto";
import "google/type/decimal.proto";
import "google/type/money.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
+option go_package = "cloud.google.com/go/channel/apiv1/channelpb;channelpb";
option java_multiple_files = true;
option java_outer_classname = "ReportsServiceProto";
option java_package = "com.google.cloud.channel.v1";
diff --git a/third_party/googleapis/google/cloud/channel/v1/repricing.proto b/third_party/googleapis/google/cloud/channel/v1/repricing.proto
index 1a15067b3..9d0cfaf8c 100644
--- a/third_party/googleapis/google/cloud/channel/v1/repricing.proto
+++ b/third_party/googleapis/google/cloud/channel/v1/repricing.proto
@@ -22,7 +22,7 @@ import "google/protobuf/timestamp.proto";
import "google/type/date.proto";
import "google/type/decimal.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
+option go_package = "cloud.google.com/go/channel/apiv1/channelpb;channelpb";
option java_multiple_files = true;
option java_outer_classname = "RepricingProto";
option java_package = "com.google.cloud.channel.v1";
diff --git a/third_party/googleapis/google/cloud/channel/v1/service.proto b/third_party/googleapis/google/cloud/channel/v1/service.proto
index 93730e9ea..36627bf36 100644
--- a/third_party/googleapis/google/cloud/channel/v1/service.proto
+++ b/third_party/googleapis/google/cloud/channel/v1/service.proto
@@ -31,7 +31,7 @@ import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
+option go_package = "cloud.google.com/go/channel/apiv1/channelpb;channelpb";
option java_multiple_files = true;
option java_outer_classname = "ServiceProto";
option java_package = "com.google.cloud.channel.v1";
diff --git a/third_party/googleapis/google/cloud/channel/v1/subscriber_event.proto b/third_party/googleapis/google/cloud/channel/v1/subscriber_event.proto
index 0135c066f..57504ca45 100644
--- a/third_party/googleapis/google/cloud/channel/v1/subscriber_event.proto
+++ b/third_party/googleapis/google/cloud/channel/v1/subscriber_event.proto
@@ -18,7 +18,7 @@ package google.cloud.channel.v1;
import "google/api/resource.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
+option go_package = "cloud.google.com/go/channel/apiv1/channelpb;channelpb";
option java_multiple_files = true;
option java_outer_classname = "SubscriberEventProto";
option java_package = "com.google.cloud.channel.v1";
diff --git a/third_party/googleapis/google/cloud/clouddms/logging/v1/BUILD.bazel b/third_party/googleapis/google/cloud/clouddms/logging/v1/BUILD.bazel
index 13ec60c46..95d3a9030 100644
--- a/third_party/googleapis/google/cloud/clouddms/logging/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/clouddms/logging/v1/BUILD.bazel
@@ -52,7 +52,7 @@ load(
go_proto_library(
name = "logging_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/clouddms/logging/v1",
+ importpath = "cloud.google.com/go/clouddms/logging/apiv1/loggingpb",
protos = [":logging_proto"],
deps = [
"//google/api:annotations_go_proto",
diff --git a/third_party/googleapis/google/cloud/clouddms/logging/v1/clouddms_platform_logs.proto b/third_party/googleapis/google/cloud/clouddms/logging/v1/clouddms_platform_logs.proto
index 8d4f95e97..885448758 100644
--- a/third_party/googleapis/google/cloud/clouddms/logging/v1/clouddms_platform_logs.proto
+++ b/third_party/googleapis/google/cloud/clouddms/logging/v1/clouddms_platform_logs.proto
@@ -22,7 +22,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.CloudDms.Logging.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/clouddms/logging/v1;logging";
+option go_package = "cloud.google.com/go/clouddms/logging/apiv1/loggingpb;loggingpb";
option java_multiple_files = true;
option java_outer_classname = "ClouddmsPlatformLogsProto";
option java_package = "com.google.cloud.clouddms.logging.v1";
diff --git a/third_party/googleapis/google/cloud/clouddms/v1/BUILD.bazel b/third_party/googleapis/google/cloud/clouddms/v1/BUILD.bazel
index e0c04b5d7..fb1a38534 100644
--- a/third_party/googleapis/google/cloud/clouddms/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/clouddms/v1/BUILD.bazel
@@ -32,6 +32,7 @@ proto_library(
"//google/longrunning:operations_proto",
"//google/rpc:status_proto",
"@com_google_protobuf//:duration_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
"@com_google_protobuf//:wrappers_proto",
@@ -118,7 +119,7 @@ load(
go_proto_library(
name = "clouddms_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/clouddms/v1",
+ importpath = "cloud.google.com/go/clouddms/apiv1/clouddmspb",
protos = [":clouddms_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -133,6 +134,7 @@ go_gapic_library(
grpc_service_config = "library_grpc_service_config.json",
importpath = "cloud.google.com/go/clouddms/apiv1;clouddms",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "datamigration_v1.yaml",
transport = "grpc",
@@ -179,6 +181,7 @@ py_gapic_library(
grpc_service_config = "library_grpc_service_config.json",
opt_args = ["warehouse-package-name=google-cloud-dms"],
rest_numeric_enums = True,
+ service_yaml = "datamigration_v1.yaml",
transport = "grpc",
)
@@ -313,6 +316,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Database Migration Service makes it easier for you to migrate your data to Google Cloud. Database Migration Service helps you lift and shift your MySQL and PostgreSQL workloads into Cloud SQL. Database Migration Service streamlines networking workflow, manages the initial snapshot and ongoing replication, and provides a status of the migration operation.",
ruby_cloud_title = "Cloud Database Migration Service V1",
+ service_yaml = "datamigration_v1.yaml",
deps = [
":clouddms_ruby_grpc",
":clouddms_ruby_proto",
@@ -358,6 +362,7 @@ csharp_gapic_library(
grpc_service_config = "library_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "datamigration_v1.yaml",
+ transport = "grpc",
deps = [
":clouddms_csharp_grpc",
":clouddms_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/clouddms/v1/clouddms.proto b/third_party/googleapis/google/cloud/clouddms/v1/clouddms.proto
index a8e3e74c6..0126c9c3a 100644
--- a/third_party/googleapis/google/cloud/clouddms/v1/clouddms.proto
+++ b/third_party/googleapis/google/cloud/clouddms/v1/clouddms.proto
@@ -26,7 +26,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.CloudDms.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/clouddms/v1;clouddms";
+option go_package = "cloud.google.com/go/clouddms/apiv1/clouddmspb;clouddmspb";
option java_multiple_files = true;
option java_outer_classname = "ClouddmsProto";
option java_package = "com.google.cloud.clouddms.v1";
diff --git a/third_party/googleapis/google/cloud/clouddms/v1/clouddms_resources.proto b/third_party/googleapis/google/cloud/clouddms/v1/clouddms_resources.proto
index dd7731a6e..67a6356d2 100644
--- a/third_party/googleapis/google/cloud/clouddms/v1/clouddms_resources.proto
+++ b/third_party/googleapis/google/cloud/clouddms/v1/clouddms_resources.proto
@@ -24,7 +24,7 @@ import "google/protobuf/wrappers.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.CloudDms.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/clouddms/v1;clouddms";
+option go_package = "cloud.google.com/go/clouddms/apiv1/clouddmspb;clouddmspb";
option java_multiple_files = true;
option java_outer_classname = "ClouddmsResourcesProto";
option java_package = "com.google.cloud.clouddms.v1";
diff --git a/third_party/googleapis/google/cloud/cloudsetup/logging/v1/BUILD.bazel b/third_party/googleapis/google/cloud/cloudsetup/logging/v1/BUILD.bazel
index 4459693e3..780783845 100644
--- a/third_party/googleapis/google/cloud/cloudsetup/logging/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/cloudsetup/logging/v1/BUILD.bazel
@@ -50,7 +50,7 @@ load(
go_proto_library(
name = "logging_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/cloudsetup/logging/v1",
+ importpath = "cloud.google.com/go/cloudsetup/logging/apiv1/loggingpb",
protos = [":logging_proto"],
deps = [
"//google/api:annotations_go_proto",
diff --git a/third_party/googleapis/google/cloud/cloudsetup/logging/v1/complete_deployment.proto b/third_party/googleapis/google/cloud/cloudsetup/logging/v1/complete_deployment.proto
index 4b8ee1fe7..f7030ca95 100644
--- a/third_party/googleapis/google/cloud/cloudsetup/logging/v1/complete_deployment.proto
+++ b/third_party/googleapis/google/cloud/cloudsetup/logging/v1/complete_deployment.proto
@@ -19,7 +19,7 @@ package google.cloud.cloudsetup.logging.v1;
import "google/api/resource.proto";
import "google/rpc/status.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/cloudsetup/logging/v1;logging";
+option go_package = "cloud.google.com/go/cloudsetup/logging/apiv1/loggingpb;loggingpb";
option java_multiple_files = true;
option java_outer_classname = "CompleteDeploymentProto";
option java_package = "com.google.cloud.cloudsetup.logging.v1";
diff --git a/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/BUILD.bazel b/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/BUILD.bazel
index fbd392ecf..99a56d016 100644
--- a/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/BUILD.bazel
@@ -118,7 +118,7 @@ load(
go_proto_library(
name = "procurement_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/commerce/consumer/procurement/v1alpha1",
+ importpath = "cloud.google.com/go/commerce/consumer/procurement/apiv1alpha1/procurementpb",
protos = [":procurement_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -132,6 +132,7 @@ go_gapic_library(
grpc_service_config = "commerceconsumerprocurement_grpc_service_config.json",
importpath = "cloud.google.com/go/commerce/consumer/procurement/apiv1alpha1;procurement",
metadata = True,
+ release_level = "alpha",
rest_numeric_enums = True,
service_yaml = "cloudcommerceconsumerprocurement_v1alpha1.yaml",
transport = "grpc+rest",
@@ -177,7 +178,7 @@ py_gapic_library(
grpc_service_config = "commerceconsumerprocurement_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "cloudcommerceconsumerprocurement_v1alpha1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
)
py_test(
@@ -349,6 +350,7 @@ csharp_gapic_library(
grpc_service_config = "commerceconsumerprocurement_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "cloudcommerceconsumerprocurement_v1alpha1.yaml",
+ transport = "grpc+rest",
deps = [
":procurement_csharp_grpc",
":procurement_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/order.proto b/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/order.proto
index 2e6a69a4b..8f694d214 100644
--- a/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/order.proto
+++ b/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/order.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/commerce/consumer/procurement/v1alpha1;procurement";
+option go_package = "cloud.google.com/go/commerce/consumer/procurement/apiv1alpha1/procurementpb;procurementpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.commerce.consumer.procurement.v1alpha1";
option (google.api.resource_definition) = {
diff --git a/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/procurement_service.proto b/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/procurement_service.proto
index 0e4a071ab..6fae1e4c7 100644
--- a/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/procurement_service.proto
+++ b/third_party/googleapis/google/cloud/commerce/consumer/procurement/v1alpha1/procurement_service.proto
@@ -23,7 +23,7 @@ import "google/api/resource.proto";
import "google/cloud/commerce/consumer/procurement/v1alpha1/order.proto";
import "google/longrunning/operations.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/commerce/consumer/procurement/v1alpha1;procurement";
+option go_package = "cloud.google.com/go/commerce/consumer/procurement/apiv1alpha1/procurementpb;procurementpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.commerce.consumer.procurement.v1alpha1";
diff --git a/third_party/googleapis/google/cloud/compute/BUILD.bazel b/third_party/googleapis/google/cloud/compute/BUILD.bazel
index 1e1eb47e1..de076ab31 100644
--- a/third_party/googleapis/google/cloud/compute/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/compute/BUILD.bazel
@@ -21,7 +21,7 @@ ruby_cloud_gapic_library(
srcs = ["//google/cloud/compute/v1:compute_proto_with_info"],
extra_protoc_parameters = [
"ruby-cloud-gem-name=google-cloud-compute",
- "ruby-cloud-wrapper-of=v1:1.7",
+ "ruby-cloud-wrapper-of=v1:2.0",
"ruby-cloud-product-url=https://cloud.google.com/compute/",
"ruby-cloud-api-id=compute.googleapis.com",
"ruby-cloud-api-shortname=compute",
diff --git a/third_party/googleapis/google/cloud/compute/v1/BUILD.bazel b/third_party/googleapis/google/cloud/compute/v1/BUILD.bazel
index 6f166bf3e..ebb5f4e8b 100644
--- a/third_party/googleapis/google/cloud/compute/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/compute/v1/BUILD.bazel
@@ -393,6 +393,7 @@ csharp_gapic_library(
srcs = [":compute_proto_with_info"],
common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
grpc_service_config = ":compute_grpc_service_config.json",
+ service_yaml = "compute_v1.yaml",
transport = "rest",
deps = [
":compute_csharp_grpc",
diff --git a/third_party/googleapis/google/cloud/compute/v1/compute.proto b/third_party/googleapis/google/cloud/compute/v1/compute.proto
index 04d01834a..8a6341f34 100644
--- a/third_party/googleapis/google/cloud/compute/v1/compute.proto
+++ b/third_party/googleapis/google/cloud/compute/v1/compute.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
// Generated by the disco-to-proto3-converter. DO NOT EDIT!
// Source Discovery file: compute.v1.json
-// Source file revision: 20221126
+// Source file revision: 20230103
// API name: compute
// API version: v1
@@ -1930,6 +1930,18 @@ message AliasIpRange {
}
+//
+message AllocationResourceStatus {
+ optional AllocationResourceStatusSpecificSKUAllocation specific_sku_allocation = 196231151;
+
+}
+
+//
+message AllocationResourceStatusSpecificSKUAllocation {
+ optional string source_instance_template_id = 111196154;
+
+}
+
//
message AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk {
// Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
@@ -1985,6 +1997,9 @@ message AllocationSpecificSKUReservation {
// The instance properties for the reservation.
optional AllocationSpecificSKUAllocationReservedInstanceProperties instance_properties = 215355165;
+ // Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
+ optional string source_instance_template = 332423616;
+
}
//
@@ -7126,7 +7141,7 @@ message FirewallPolicyRule {
}
- // The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.
+ // The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
optional string action = 187661878;
// An optional description for this resource.
@@ -7422,7 +7437,7 @@ message ForwardingRule {
// This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
optional string subnetwork = 307827694;
- // The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs.
+ // The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.
optional string target = 192835985;
}
@@ -9306,6 +9321,8 @@ message GuestOsFeature {
SEV_CAPABLE = 87083793;
+ SEV_SNP_CAPABLE = 426919;
+
UEFI_COMPATIBLE = 195865408;
VIRTIO_SCSI_MULTIQUEUE = 201597069;
@@ -13181,7 +13198,7 @@ message Interconnect {
// 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.
optional string name = 3373707;
- // Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.
+ // Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.
optional string noc_contact_email = 14072832;
// [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
@@ -17949,6 +17966,9 @@ message NetworkInterface {
// 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
optional string network = 232872494;
+ // The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
+ optional string network_attachment = 224644052;
+
// An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
optional string network_i_p = 207181961;
@@ -22050,9 +22070,11 @@ message Reservation {
// The name of the resource, provided by the client when initially creating the resource. The resource 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.
optional string name = 3373707;
- // Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
map resource_policies = 22220385;
+ // [Output Only] Status information for Reservation resource.
+ optional AllocationResourceStatus resource_status = 249429315;
+
// [Output Only] Reserved for future use.
optional bool satisfies_pzs = 480964267;
@@ -26485,7 +26507,7 @@ message SourceDiskEncryptionKey {
// A specification of the parameters to use when creating the instance template from a source instance.
message SourceInstanceParams {
- // Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.
+ // Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, the source images for each disk will be used. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.
repeated DiskInstantiationConfig disk_configs = 235580623;
}
diff --git a/third_party/googleapis/google/cloud/compute/v1/compute.v1.json b/third_party/googleapis/google/cloud/compute/v1/compute.v1.json
index 1c7ef678c..c30c2e0c6 100644
--- a/third_party/googleapis/google/cloud/compute/v1/compute.v1.json
+++ b/third_party/googleapis/google/cloud/compute/v1/compute.v1.json
@@ -1,32099 +1,36878 @@
{
- "kind": "discovery#restDescription",
- "documentationLink": "https://cloud.google.com/compute/",
+ "title": "Compute Engine API",
+ "icons": {
+ "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
+ "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
+ },
+ "revision": "20230103",
"parameters": {
- "upload_protocol": {
+ "alt": {
"type": "string",
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "description": "Data format for response.",
+ "default": "json",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ]
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "userIp": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Legacy name for parameter that has been superseded by `quotaUser`."
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
+ "prettyPrint": {
+ "type": "boolean",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
"location": "query"
},
- "userIp": {
- "description": "Legacy name for parameter that has been superseded by `quotaUser`.",
- "location": "query",
- "type": "string"
- },
- "callback": {
+ "access_token": {
"location": "query",
- "description": "JSONP",
- "type": "string"
+ "type": "string",
+ "description": "OAuth access token."
},
"$.xgafv": {
- "location": "query",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
"description": "V1 error format.",
"enum": [
"1",
"2"
- ]
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
},
- "oauth_token": {
+ "uploadType": {
"type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query"
+ },
+ "fields": {
+ "type": "string",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query"
},
"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.",
"type": "string",
"location": "query"
},
- "quotaUser": {
- "location": "query",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
- "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"
},
- "access_token": {
+ "upload_protocol": {
"type": "string",
"location": "query",
- "description": "OAuth access token."
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "default": "json",
+ "callback": {
"location": "query",
- "description": "Data format for response."
+ "description": "JSONP",
+ "type": "string"
},
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
+ "quotaUser": {
+ "location": "query",
+ "type": "string",
+ "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."
}
},
- "name": "compute",
- "version": "v1",
- "icons": {
- "x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
- "x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
- },
"mtlsRootUrl": "https://compute.mtls.googleapis.com/",
- "batchPath": "batch/compute/v1",
- "ownerDomain": "google.com",
"baseUrl": "https://compute.googleapis.com/compute/v1/",
+ "basePath": "/compute/v1/",
+ "rootUrl": "https://compute.googleapis.com/",
+ "batchPath": "batch/compute/v1",
"servicePath": "compute/v1/",
- "discoveryVersion": "v1",
- "resources": {
- "machineTypes": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "MachineType"
+ "schemas": {
+ "PreservedState": {
+ "id": "PreservedState",
+ "type": "object",
+ "description": "Preserved state for a given instance.",
+ "properties": {
+ "metadata": {
+ "description": "Preserved metadata defined for this instance.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "disks": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "PreservedStatePreservedDisk"
},
- "description": "Returns the specified machine type. Gets a list of available machine types by making a list() request.",
- "parameters": {
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
- },
- "machineType": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "description": "Name of the machine type to return."
- },
- "zone": {
- "location": "path",
- "required": true,
- "description": "The name of the zone for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
+ "description": "Preserved disks defined for this instance. This map is keyed with the device names of the disks."
+ }
+ }
+ },
+ "SecurityPolicyRuleRateLimitOptionsThreshold": {
+ "id": "SecurityPolicyRuleRateLimitOptionsThreshold",
+ "properties": {
+ "count": {
+ "description": "Number of HTTP(S) requests for calculating the threshold.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "intervalSec": {
+ "description": "Interval over which the threshold is computed.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Binding": {
+ "properties": {
+ "members": {
+ "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "zone",
- "machineType"
- ],
- "path": "projects/{project}/zones/{zone}/machineTypes/{machineType}",
- "flatPath": "projects/{project}/zones/{zone}/machineTypes/{machineType}",
- "id": "compute.machineTypes.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "type": "array"
},
- "aggregatedList": {
- "id": "compute.machineTypes.aggregatedList",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "MachineTypeAggregatedList"
+ "role": {
+ "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
+ "type": "string"
+ },
+ "condition": {
+ "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).",
+ "$ref": "Expr"
+ },
+ "bindingId": {
+ "type": "string",
+ "description": "This is deprecated and has no effect. Do not use."
+ }
+ },
+ "type": "object",
+ "description": "Associates `members`, or principals, with a `role`.",
+ "id": "Binding"
+ },
+ "SslCertificateAggregatedList": {
+ "properties": {
+ "items": {
+ "additionalProperties": {
+ "description": "Name of the scope containing this set of SslCertificates.",
+ "$ref": "SslCertificatesScopedList"
},
- "description": "Retrieves an aggregated list of machine types.",
- "flatPath": "projects/{project}/aggregated/machineTypes",
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
- "path": "projects/{project}/aggregated/machineTypes",
- "parameters": {
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "maxResults": {
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "default": "500",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "includeAllScopes": {
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- }
- }
+ "type": "object",
+ "description": "A list of SslCertificatesScopedList resources."
},
- "list": {
- "path": "projects/{project}/zones/{zone}/machineTypes",
- "description": "Retrieves a list of machine types available to the specified project.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "zone"
- ],
- "httpMethod": "GET",
- "id": "compute.machineTypes.list",
- "parameters": {
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "format": "uint32",
- "location": "query",
- "minimum": "0",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.",
+ "default": "compute#sslCertificateAggregatedList",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "warning": {
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "zone": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "The name of the zone for this request."
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ }
},
- "project": {
- "description": "Project ID for this request.",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
},
- "response": {
- "$ref": "MachineTypeList"
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/zones/{zone}/machineTypes"
+ "type": "array",
+ "description": "[Output Only] Unreachable resources."
}
- }
+ },
+ "type": "object",
+ "id": "SslCertificateAggregatedList"
},
- "vpnTunnels": {
- "methods": {
- "delete": {
- "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- "parameterOrder": [
- "project",
- "region",
- "vpnTunnel"
- ],
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
+ "SubnetworkAggregatedList": {
+ "id": "SubnetworkAggregatedList",
+ "properties": {
+ "unreachables": {
+ "type": "array",
+ "description": "[Output Only] Unreachable resources.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "SubnetworksScopedList",
+ "description": "Name of the scope containing this set of Subnetworks."
+ },
+ "description": "A list of SubnetworksScopedList resources."
+ },
+ "warning": {
+ "properties": {
+ "message": {
"type": "string",
- "description": "Name of the region for this request."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "vpnTunnel": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Name of the VpnTunnel resource to delete."
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array"
},
- "project": {
- "location": "path",
+ "code": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "DELETE",
- "description": "Deletes the specified VpnTunnel resource.",
- "id": "compute.vpnTunnels.delete"
- },
- "list": {
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "VpnTunnelList"
- },
- "description": "Retrieves a list of VpnTunnel resources contained in the specified project and region.",
- "httpMethod": "GET",
- "flatPath": "projects/{project}/regions/{region}/vpnTunnels",
- "id": "compute.vpnTunnels.list",
- "path": "projects/{project}/regions/{region}/vpnTunnels",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the region for this request."
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "maxResults": {
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "default": "500"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
- }
+ },
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
},
- "get": {
- "httpMethod": "GET",
- "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- "parameterOrder": [
- "project",
- "region",
- "vpnTunnel"
- ],
- "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
- "response": {
- "$ref": "VpnTunnel"
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#subnetworkAggregatedList",
+ "description": "[Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SubnetworkSecondaryRange": {
+ "properties": {
+ "rangeName": {
+ "type": "string",
+ "description": "The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork."
+ },
+ "ipCidrRange": {
+ "type": "string",
+ "description": "The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. The range can be any range listed in the Valid ranges list."
+ }
+ },
+ "type": "object",
+ "id": "SubnetworkSecondaryRange",
+ "description": "Represents a secondary IP range of a subnetwork."
+ },
+ "BfdStatus": {
+ "description": "Next free: 15",
+ "type": "object",
+ "properties": {
+ "controlPacketIntervals": {
+ "items": {
+ "$ref": "PacketIntervals"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.vpnTunnels.get",
- "description": "Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.",
- "parameters": {
- "region": {
- "description": "Name of the region for this request.",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "vpnTunnel": {
- "type": "string",
- "description": "Name of the VpnTunnel resource to return.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- }
+ "type": "array",
+ "description": "Inter-packet time interval statistics for control packets."
},
- "setLabels": {
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "localState": {
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels",
- "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels",
- "id": "compute.vpnTunnels.setLabels",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880",
+ "enum": [
+ "ADMIN_DOWN",
+ "DOWN",
+ "INIT",
+ "STATE_UNSPECIFIED",
+ "UP"
],
- "request": {
- "$ref": "RegionSetLabelsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "description": "Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.",
- "parameters": {
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "type": "string",
- "description": "The region for this request.",
- "required": true
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string"
- },
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "type": "string"
- }
- }
+ "type": "string"
},
- "aggregatedList": {
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
+ "uptimeMs": {
+ "type": "string",
+ "format": "int64",
+ "description": "Session uptime in milliseconds. Value will be 0 if session is not up."
+ },
+ "configUpdateTimestampMicros": {
+ "format": "int64",
+ "description": "Unix timestamp of the most recent config update.",
+ "type": "string"
+ },
+ "localDiagnostic": {
+ "type": "string",
+ "description": "The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880",
+ "enum": [
+ "ADMINISTRATIVELY_DOWN",
+ "CONCATENATED_PATH_DOWN",
+ "CONTROL_DETECTION_TIME_EXPIRED",
+ "DIAGNOSTIC_UNSPECIFIED",
+ "ECHO_FUNCTION_FAILED",
+ "FORWARDING_PLANE_RESET",
+ "NEIGHBOR_SIGNALED_SESSION_DOWN",
+ "NO_DIAGNOSTIC",
+ "PATH_DOWN",
+ "REVERSE_CONCATENATED_PATH_DOWN"
],
- "response": {
- "$ref": "VpnTunnelAggregatedList"
- },
- "path": "projects/{project}/aggregated/vpnTunnels",
- "id": "compute.vpnTunnels.aggregatedList",
- "flatPath": "projects/{project}/aggregated/vpnTunnels",
- "parameters": {
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "includeAllScopes": {
- "type": "boolean",
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
- },
- "maxResults": {
- "location": "query",
- "type": "integer",
- "default": "500",
- "minimum": "0",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "description": "Retrieves an aggregated list of VPN tunnels.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
]
},
- "insert": {
- "flatPath": "projects/{project}/regions/{region}/vpnTunnels",
- "path": "projects/{project}/regions/{region}/vpnTunnels",
- "id": "compute.vpnTunnels.insert",
- "description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request.",
- "parameters": {
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "region": {
- "description": "Name of the region for this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
- },
- "request": {
- "$ref": "VpnTunnel"
- },
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "controlPacketCounts": {
+ "description": "Control packet counts for the current BFD session.",
+ "$ref": "BfdStatusPacketCounts"
+ },
+ "bfdSessionInitializationMode": {
+ "enum": [
+ "ACTIVE",
+ "DISABLED",
+ "PASSIVE"
],
- "parameterOrder": [
- "project",
- "region"
+ "enumDescriptions": [
+ "",
+ "",
+ ""
],
- "response": {
- "$ref": "Operation"
- }
+ "type": "string",
+ "description": "The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer."
+ },
+ "txPacket": {
+ "$ref": "BfdPacket",
+ "description": "The most recent Tx control packet for this BFD session."
+ },
+ "rxPacket": {
+ "description": "The most recent Rx control packet for this BFD session.",
+ "$ref": "BfdPacket"
+ },
+ "negotiatedLocalControlTxIntervalMs": {
+ "type": "integer",
+ "description": "Negotiated transmit interval for control packets.",
+ "format": "uint32"
}
- }
+ },
+ "id": "BfdStatus"
},
- "reservations": {
- "methods": {
- "update": {
- "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}",
- "httpMethod": "PATCH",
- "response": {
- "$ref": "Operation"
- },
- "description": "Update share settings of the reservation.",
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "zone": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "reservation": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Name of the reservation to update."
- },
- "paths": {
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "type": "string",
- "description": "Update_mask indicates fields to be updated as part of this request.",
- "location": "query"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
- }
+ "InstanceGroupsRemoveInstancesRequest": {
+ "type": "object",
+ "id": "InstanceGroupsRemoveInstancesRequest",
+ "properties": {
+ "instances": {
+ "items": {
+ "$ref": "InstanceReference"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "The list of instances to remove from the instance group.",
+ "type": "array"
+ }
+ }
+ },
+ "Project": {
+ "description": "Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy.",
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "defaultNetworkTier": {
+ "enum": [
+ "FIXED_STANDARD",
+ "PREMIUM",
+ "STANDARD",
+ "STANDARD_OVERRIDES_FIXED_STANDARD"
],
- "id": "compute.reservations.update",
- "parameterOrder": [
- "project",
- "zone",
- "reservation"
+ "enumDescriptions": [
+ "Public internet quality with fixed bandwidth.",
+ "High quality, Google-grade network tier, support for all networking products.",
+ "Public internet quality, only limited support for other networking products.",
+ "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured."
],
- "path": "projects/{project}/zones/{zone}/reservations/{reservation}",
- "request": {
- "$ref": "Reservation"
- }
+ "type": "string",
+ "description": "This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM."
},
- "resize": {
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/reservations/{reservation}/resize",
- "parameterOrder": [
- "project",
- "zone",
- "reservation"
- ],
- "id": "compute.reservations.resize",
- "request": {
- "$ref": "ReservationsResizeRequest"
- },
- "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/resize",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "reservation": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Name of the reservation to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "zone": {
- "location": "path",
- "type": "string",
- "description": "Name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
- }
- }
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
},
- "aggregatedList": {
- "response": {
- "$ref": "ReservationAggregatedList"
- },
- "parameterOrder": [
- "project"
+ "name": {
+ "type": "string",
+ "description": "The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine."
+ },
+ "vmDnsSetting": {
+ "description": "[Output Only] Default internal DNS setting used by VMs running in this project.",
+ "enum": [
+ "GLOBAL_DEFAULT",
+ "UNSPECIFIED_VM_DNS_SETTING",
+ "ZONAL_DEFAULT",
+ "ZONAL_ONLY"
],
- "id": "compute.reservations.aggregatedList",
- "path": "projects/{project}/aggregated/reservations",
- "parameters": {
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean",
- "location": "query"
- },
- "maxResults": {
- "minimum": "0",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "format": "uint32",
- "type": "integer"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "projects/{project}/aggregated/reservations",
- "description": "Retrieves an aggregated list of reservations.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
],
- "httpMethod": "GET"
+ "type": "string"
},
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server. This is *not* the project ID, and is just a unique ID used by Compute Engine to identify resources.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#project for projects.",
+ "default": "compute#project"
+ },
+ "defaultServiceAccount": {
+ "description": "[Output Only] Default service account used by VMs running in this project.",
+ "type": "string"
+ },
+ "xpnProjectStatus": {
+ "enum": [
+ "HOST",
+ "UNSPECIFIED_XPN_PROJECT_STATUS"
],
- "httpMethod": "DELETE",
- "id": "compute.reservations.delete",
- "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}",
- "description": "Deletes the specified reservation.",
- "parameters": {
- "zone": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the zone for this request."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true
- },
- "reservation": {
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the reservation to delete."
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
+ "type": "string",
+ "description": "[Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated.",
+ "enumDescriptions": [
+ "",
+ ""
+ ]
+ },
+ "enabledFeatures": {
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/zones/{zone}/reservations/{reservation}",
- "response": {
- "$ref": "Operation"
+ "description": "Restricted features enabled for use on this project.",
+ "type": "array"
+ },
+ "usageExportLocation": {
+ "description": "The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.",
+ "$ref": "UsageExportLocation"
+ },
+ "quotas": {
+ "items": {
+ "$ref": "Quota"
},
- "parameterOrder": [
- "project",
- "zone",
- "reservation"
- ]
+ "description": "[Output Only] Quotas assigned to this project.",
+ "type": "array"
},
- "get": {
- "response": {
- "$ref": "Reservation"
+ "description": {
+ "type": "string",
+ "description": "An optional textual description of the resource."
+ },
+ "commonInstanceMetadata": {
+ "description": "Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.",
+ "$ref": "Metadata"
+ }
+ },
+ "id": "Project"
+ },
+ "NetworkEndpointWithHealthStatus": {
+ "id": "NetworkEndpointWithHealthStatus",
+ "properties": {
+ "healths": {
+ "items": {
+ "$ref": "HealthStatusForNetworkEndpoint"
},
- "description": "Retrieves information about the specified reservation.",
- "path": "projects/{project}/zones/{zone}/reservations/{reservation}",
- "parameters": {
- "project": {
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "reservation": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "description": "Name of the reservation to retrieve.",
- "type": "string"
- },
- "zone": {
- "required": true,
- "location": "path",
- "description": "Name of the zone for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
+ "description": "[Output only] The health status of network endpoint;",
+ "type": "array"
+ },
+ "networkEndpoint": {
+ "$ref": "NetworkEndpoint",
+ "description": "[Output only] The network endpoint;"
+ }
+ },
+ "type": "object"
+ },
+ "InterconnectAttachmentPrivateInfo": {
+ "properties": {
+ "tag8021q": {
+ "format": "uint32",
+ "description": "[Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.",
+ "type": "integer"
+ }
+ },
+ "description": "Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.",
+ "id": "InterconnectAttachmentPrivateInfo",
+ "type": "object"
+ },
+ "InstanceProperties": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "An optional text description for the instances that are created from these properties.",
+ "type": "string"
+ },
+ "disks": {
+ "items": {
+ "$ref": "AttachedDisk"
},
- "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}",
- "parameterOrder": [
- "project",
- "zone",
- "reservation"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.reservations.get"
+ "type": "array",
+ "description": "An array of disks that are associated with the instances that are created from these properties."
},
- "list": {
- "id": "compute.reservations.list",
- "flatPath": "projects/{project}/zones/{zone}/reservations",
- "response": {
- "$ref": "ReservationList"
+ "minCpuPlatform": {
+ "description": "Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.",
+ "type": "string"
+ },
+ "machineType": {
+ "description": "The machine type to use for instances that are created from these properties.",
+ "annotations": {
+ "required": [
+ "compute.instanceTemplates.insert"
+ ]
},
- "path": "projects/{project}/zones/{zone}/reservations",
- "description": "A list of all the reservations that have been configured for the specified project in specified zone.",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "string"
+ },
+ "shieldedInstanceConfig": {
+ "description": "Note that for MachineImage, this is not supported yet.",
+ "$ref": "ShieldedInstanceConfig"
+ },
+ "metadata": {
+ "$ref": "Metadata",
+ "description": "The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information."
+ },
+ "advancedMachineFeatures": {
+ "$ref": "AdvancedMachineFeatures",
+ "description": "Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet."
+ },
+ "confidentialInstanceConfig": {
+ "description": "Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.",
+ "$ref": "ConfidentialInstanceConfig"
+ },
+ "reservationAffinity": {
+ "$ref": "ReservationAffinity",
+ "description": "Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet."
+ },
+ "privateIpv6GoogleAccess": {
+ "description": "The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.",
+ "type": "string",
+ "enum": [
+ "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
+ "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE",
+ "INHERIT_FROM_SUBNETWORK"
],
- "parameters": {
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "zone": {
- "required": true,
- "location": "path",
- "description": "Name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "default": "500",
- "minimum": "0",
- "type": "integer",
- "location": "query",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
+ "enumDescriptions": [
+ "Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.",
+ "Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.",
+ "Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork."
]
},
- "setIamPolicy": {
- "parameters": {
- "zone": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request."
- },
- "resource": {
- "location": "path",
- "description": "Name or id of the resource for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string"
- }
+ "guestAccelerators": {
+ "items": {
+ "$ref": "AcceleratorConfig"
},
- "request": {
- "$ref": "ZoneSetPolicyRequest"
+ "description": "A list of guest accelerator cards' type and count to use for instances created from these properties.",
+ "type": "array"
+ },
+ "resourcePolicies": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "zone",
- "resource"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "httpMethod": "POST",
- "response": {
- "$ref": "Policy"
+ "description": "Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet."
+ },
+ "canIpForward": {
+ "type": "boolean",
+ "description": "Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information."
+ },
+ "serviceAccounts": {
+ "items": {
+ "$ref": "ServiceAccount"
},
- "id": "compute.reservations.setIamPolicy",
- "path": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy"
+ "type": "array",
+ "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances."
},
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
},
- "id": "compute.reservations.getIamPolicy",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "parameterOrder": [
- "project",
- "zone",
- "resource"
- ],
- "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy",
- "path": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "parameters": {
- "zone": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "The name of the zone for this request."
- },
- "resource": {
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "optionsRequestedPolicyVersion": {
- "type": "integer",
- "location": "query",
- "description": "Requested IAM Policy version.",
- "format": "int32"
- }
- }
+ "description": "Labels to apply to instances that are created from these properties.",
+ "type": "object"
},
- "testIamPermissions": {
- "parameterOrder": [
- "project",
- "zone",
- "resource"
- ],
- "description": "Returns permissions that a caller has on the specified resource.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions",
- "parameters": {
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "type": "string"
- },
- "zone": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true,
- "description": "The name of the zone for this request."
- }
- },
- "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "request": {
- "$ref": "TestPermissionsRequest"
+ "networkInterfaces": {
+ "type": "array",
+ "items": {
+ "$ref": "NetworkInterface"
},
- "id": "compute.reservations.testIamPermissions"
+ "description": "An array of network access configurations for this interface."
},
- "insert": {
- "id": "compute.reservations.insert",
- "request": {
- "$ref": "Reservation"
- },
- "parameters": {
- "zone": {
- "location": "path",
- "description": "Name of the zone for this request.",
+ "tags": {
+ "$ref": "Tags",
+ "description": "A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035."
+ },
+ "networkPerformanceConfig": {
+ "description": "Note that for MachineImage, this is not supported yet.",
+ "$ref": "NetworkPerformanceConfig"
+ },
+ "scheduling": {
+ "$ref": "Scheduling",
+ "description": "Specifies the scheduling options for the instances that are created from these properties."
+ },
+ "keyRevocationActionType": {
+ "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "Indicates user chose no operation.",
+ "Indicates user chose to opt for VM shutdown on key revocation."
+ ],
+ "enum": [
+ "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED",
+ "NONE",
+ "STOP"
+ ]
+ },
+ "resourceManagerTags": {
+ "type": "object",
+ "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.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "InstanceProperties"
+ },
+ "AllocationResourceStatusSpecificSKUAllocation": {
+ "type": "object",
+ "properties": {
+ "sourceInstanceTemplateId": {
+ "type": "string"
+ }
+ },
+ "id": "AllocationResourceStatusSpecificSKUAllocation"
+ },
+ "HealthCheckServicesList": {
+ "type": "object",
+ "id": "HealthCheckServicesList",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "message": {
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
},
- "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).",
- "type": "string",
- "location": "query"
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string"
}
},
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "Operation"
+ "description": "[Output Only] Informational warning message."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of HealthCheckService resources.",
+ "items": {
+ "$ref": "HealthCheckService"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/reservations",
- "path": "projects/{project}/zones/{zone}/reservations",
- "description": "Creates a new reservation. For more information, read Reserving zonal resources."
+ "type": "array"
+ },
+ "kind": {
+ "default": "compute#healthCheckServicesList",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices."
}
}
},
- "httpsHealthChecks": {
- "methods": {
- "patch": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "project": {
+ "AutoscalingPolicyScalingSchedule": {
+ "type": "object",
+ "properties": {
+ "minRequiredReplicas": {
+ "type": "integer",
+ "description": "The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.",
+ "format": "int32"
+ },
+ "timeZone": {
+ "description": "The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of “UTC” if left empty.",
+ "type": "string"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "A boolean value that specifies whether a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect. This field is optional, and its value is false by default."
+ },
+ "description": {
+ "description": "A description of a scaling schedule.",
+ "type": "string"
+ },
+ "durationSec": {
+ "description": "The duration of time intervals, in seconds, for which this scaling schedule is to run. The minimum allowed value is 300. This field is required.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "schedule": {
+ "description": "The start timestamps of time intervals when this scaling schedule is to provide a scaling signal. This field uses the extended cron format (with an optional year field). The expression can describe a single timestamp if the optional year is set, in which case the scaling schedule runs once. The schedule is interpreted with respect to time_zone. This field is required. Note: These timestamps only describe when autoscaler starts providing the scaling signal. The VMs need additional time to become serving.",
+ "type": "string"
+ }
+ },
+ "id": "AutoscalingPolicyScalingSchedule",
+ "description": "Scaling based on user-defined schedule. The message describes a single scaling schedule. A scaling schedule changes the minimum number of VM instances an autoscaler can recommend, which can trigger scaling out."
+ },
+ "DiskTypesScopedList": {
+ "id": "DiskTypesScopedList",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "httpsHealthCheck": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "description": "Name of the HttpsHealthCheck resource to patch."
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "requestId": {
+ "message": {
"type": "string",
- "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"
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "request": {
- "$ref": "HttpsHealthCheck"
- },
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
- ],
- "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "id": "compute.httpsHealthChecks.patch",
- "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "PATCH",
- "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules."
+ "description": "[Output Only] Informational warning which replaces the list of disk types when the list is empty.",
+ "type": "object"
},
- "insert": {
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "POST",
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "flatPath": "projects/{project}/global/httpsHealthChecks",
- "description": "Creates a HttpsHealthCheck resource in the specified project using the data included in the request.",
- "request": {
- "$ref": "HttpsHealthCheck"
- },
- "id": "compute.httpsHealthChecks.insert",
- "path": "projects/{project}/global/httpsHealthChecks",
- "response": {
- "$ref": "Operation"
+ "diskTypes": {
+ "items": {
+ "$ref": "DiskType"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "description": "[Output Only] A list of disk types contained in this scope.",
+ "type": "array"
+ }
+ }
+ },
+ "LogConfigCounterOptionsCustomField": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "This is deprecated and has no effect. Do not use.",
+ "type": "string"
},
- "get": {
- "id": "compute.httpsHealthChecks.get",
- "parameters": {
- "httpsHealthCheck": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string",
- "description": "Name of the HttpsHealthCheck resource to return."
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
- }
- },
- "description": "Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.",
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "response": {
- "$ref": "HttpsHealthCheck"
- },
- "httpMethod": "GET",
- "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}"
+ "value": {
+ "type": "string",
+ "description": "This is deprecated and has no effect. Do not use."
+ }
+ },
+ "id": "LogConfigCounterOptionsCustomField",
+ "description": "This is deprecated and has no effect. Do not use."
+ },
+ "TargetInstanceAggregatedList": {
+ "id": "TargetInstanceAggregatedList",
+ "properties": {
+ "items": {
+ "type": "object",
+ "description": "A list of TargetInstance resources.",
+ "additionalProperties": {
+ "$ref": "TargetInstancesScopedList",
+ "description": "Name of the scope containing this set of target instances."
+ }
},
- "update": {
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.httpsHealthChecks.update",
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
- ],
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "request": {
- "$ref": "HttpsHealthCheck"
- },
- "parameters": {
- "httpsHealthCheck": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the HttpsHealthCheck resource to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "requestId": {
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "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"
- }
- },
- "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request."
- },
- "list": {
- "id": "compute.httpsHealthChecks.list",
- "path": "projects/{project}/global/httpsHealthChecks",
- "httpMethod": "GET",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "default": "500",
- "minimum": "0",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "type": "integer"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
+ }
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "unreachables": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "description": "Retrieves the list of HttpsHealthCheck resources available to the specified project.",
- "flatPath": "projects/{project}/global/httpsHealthChecks",
- "response": {
- "$ref": "HttpsHealthCheckList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "[Output Only] Unreachable resources."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#targetInstanceAggregatedList",
+ "description": "Type of resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GuestAttributesValue": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "GuestAttributesEntry"
+ }
+ }
+ },
+ "id": "GuestAttributesValue",
+ "description": "Array of guest attribute namespace/key/value tuples.",
+ "type": "object"
+ },
+ "Reservation": {
+ "description": "Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "enum": [
+ "CREATING",
+ "DELETING",
+ "INVALID",
+ "READY",
+ "UPDATING"
],
- "parameterOrder": [
- "project"
- ]
+ "description": "[Output Only] The status of the reservation.",
+ "enumDescriptions": [
+ "Resources are being allocated for the reservation.",
+ "Reservation is currently being deleted.",
+ "",
+ "Reservation has allocated all its resources.",
+ "Reservation is currently being resized."
+ ],
+ "type": "string"
},
- "delete": {
- "id": "compute.httpsHealthChecks.delete",
- "response": {
- "$ref": "Operation"
+ "resourceStatus": {
+ "$ref": "AllocationResourceStatus",
+ "description": "[Output Only] Status information for Reservation resource."
+ },
+ "shareSettings": {
+ "$ref": "ShareSettings",
+ "description": "Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation."
+ },
+ "commitment": {
+ "description": "[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.",
+ "type": "string"
+ },
+ "specificReservation": {
+ "description": "Reservation for instances with specific machine shapes.",
+ "$ref": "AllocationSpecificSKUReservation"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined fully-qualified URL for this resource."
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.instances.insert"
+ ]
},
- "description": "Deletes the specified HttpsHealthCheck resource.",
- "parameters": {
- "httpsHealthCheck": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the HttpsHealthCheck resource to delete.",
- "required": true,
- "type": "string"
- },
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request."
- },
- "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).",
- "location": "query",
- "type": "string"
- }
+ "description": "The name of the resource, provided by the client when initially creating the resource. The resource 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."
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.",
+ "default": "compute#reservation",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "specificReservationRequired": {
+ "type": "boolean",
+ "description": "Indicates whether the reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation."
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "satisfiesPzs": {
+ "description": "[Output Only] Reserved for future use.",
+ "type": "boolean"
+ },
+ "zone": {
+ "description": "Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.",
+ "type": "string"
+ }
+ },
+ "id": "Reservation"
+ },
+ "BulkInsertInstanceResourcePerInstanceProperties": {
+ "id": "BulkInsertInstanceResourcePerInstanceProperties",
+ "description": "Per-instance properties to be set on individual instances. To be extended in the future.",
+ "properties": {
+ "name": {
+ "description": "This field is only temporary. It will be removed. Do not use it.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Int64RangeMatch": {
+ "properties": {
+ "rangeEnd": {
+ "type": "string",
+ "description": "The end of the range (exclusive) in signed long integer format.",
+ "format": "int64"
+ },
+ "rangeStart": {
+ "format": "int64",
+ "type": "string",
+ "description": "The start of the range (inclusive) in signed long integer format."
+ }
+ },
+ "id": "Int64RangeMatch",
+ "type": "object",
+ "description": "HttpRouteRuleMatch criteria for field values that must stay within the specified integer range."
+ },
+ "QuotaExceededInfo": {
+ "properties": {
+ "dimensions": {
+ "description": "The map holding related quota dimensions.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "limitName": {
+ "type": "string",
+ "description": "The name of the quota limit."
+ },
+ "metricName": {
+ "type": "string",
+ "description": "The Compute Engine quota metric name."
+ },
+ "limit": {
+ "type": "number",
+ "description": "Current effective quota limit. The limit's unit depends on the quota type or metric.",
+ "format": "double"
+ }
+ },
+ "id": "QuotaExceededInfo",
+ "type": "object",
+ "description": "Additional details for quota exceeded error for resource quota."
+ },
+ "RegionInstanceGroupManagersCreateInstancesRequest": {
+ "id": "RegionInstanceGroupManagersCreateInstancesRequest",
+ "type": "object",
+ "description": "RegionInstanceGroupManagers.createInstances",
+ "properties": {
+ "instances": {
+ "items": {
+ "$ref": "PerInstanceConfig"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "DELETE",
- "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
- "parameterOrder": [
- "project",
- "httpsHealthCheck"
+ "description": "[Required] List of specifications of per-instance configs.",
+ "type": "array"
+ }
+ }
+ },
+ "HttpRedirectAction": {
+ "description": "Specifies settings for an HTTP redirect.",
+ "type": "object",
+ "id": "HttpRedirectAction",
+ "properties": {
+ "stripQuery": {
+ "type": "boolean",
+ "description": "If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. "
+ },
+ "redirectResponseCode": {
+ "enumDescriptions": [
+ "Http Status Code 302 - Found.",
+ "Http Status Code 301 - Moved Permanently.",
+ "Http Status Code 308 - Permanent Redirect maintaining HTTP method.",
+ "Http Status Code 303 - See Other.",
+ "Http Status Code 307 - Temporary Redirect maintaining HTTP method."
],
- "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}"
+ "type": "string",
+ "description": "The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained. ",
+ "enum": [
+ "FOUND",
+ "MOVED_PERMANENTLY_DEFAULT",
+ "PERMANENT_REDIRECT",
+ "SEE_OTHER",
+ "TEMPORARY_REDIRECT"
+ ]
+ },
+ "prefixRedirect": {
+ "description": "The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.",
+ "type": "string"
+ },
+ "pathRedirect": {
+ "description": "The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.",
+ "type": "string"
+ },
+ "hostRedirect": {
+ "description": "The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.",
+ "type": "string"
+ },
+ "httpsRedirect": {
+ "type": "boolean",
+ "description": "If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false."
}
}
},
- "interconnectAttachments": {
- "methods": {
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "PATCH",
- "description": "Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
- "parameters": {
- "region": {
- "description": "Name of the region scoping this request.",
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "interconnectAttachment": {
- "type": "string",
- "description": "Name of the interconnect attachment to patch.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string"
- }
+ "SecurityPoliciesWafConfig": {
+ "id": "SecurityPoliciesWafConfig",
+ "properties": {
+ "wafRules": {
+ "$ref": "PreconfiguredWafSet"
+ }
+ },
+ "type": "object"
+ },
+ "RegionInstanceGroupManagerPatchInstanceConfigReq": {
+ "properties": {
+ "perInstanceConfigs": {
+ "items": {
+ "$ref": "PerInstanceConfig"
},
- "parameterOrder": [
- "project",
- "region",
- "interconnectAttachment"
- ],
- "id": "compute.interconnectAttachments.patch",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
- "request": {
- "$ref": "InterconnectAttachment"
+ "description": "The list of per-instance configurations to insert or patch on this managed instance group.",
+ "type": "array"
+ }
+ },
+ "id": "RegionInstanceGroupManagerPatchInstanceConfigReq",
+ "description": "RegionInstanceGroupManagers.patchPerInstanceConfigs",
+ "type": "object"
+ },
+ "InstancesSetServiceAccountRequest": {
+ "properties": {
+ "scopes": {
+ "description": "The list of scopes to be made available for this service account.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
},
- "delete": {
- "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "interconnectAttachment"
+ "email": {
+ "description": "Email address of the service account.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "InstancesSetServiceAccountRequest"
+ },
+ "AliasIpRange": {
+ "description": "An alias IP range attached to an instance's network interface.",
+ "id": "AliasIpRange",
+ "type": "object",
+ "properties": {
+ "subnetworkRangeName": {
+ "description": "The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.",
+ "type": "string"
+ },
+ "ipCidrRange": {
+ "description": "The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).",
+ "type": "string"
+ }
+ }
+ },
+ "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig": {
+ "type": "object",
+ "properties": {
+ "ruleVisibility": {
+ "enumDescriptions": [
+ "",
+ ""
],
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "description": "Deletes the specified interconnect attachment.",
- "id": "compute.interconnectAttachments.delete",
- "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
- "parameters": {
- "interconnectAttachment": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name of the interconnect attachment to delete.",
- "location": "path"
- },
- "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).",
- "type": "string",
- "location": "query"
- },
- "region": {
- "description": "Name of the region for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string"
- },
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
- }
- }
+ "type": "string",
+ "description": "Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules.",
+ "enum": [
+ "PREMIUM",
+ "STANDARD"
+ ]
},
- "insert": {
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "Name of the region for this request.",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "validateOnly": {
- "location": "query",
- "description": "If true, the request will not be committed.",
- "type": "boolean"
- }
- },
- "id": "compute.interconnectAttachments.insert",
- "request": {
- "$ref": "InterconnectAttachment"
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enable": {
+ "description": "If set to true, enables CAAP for L7 DDoS detection.",
+ "type": "boolean"
+ }
+ },
+ "id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig",
+ "description": "Configuration options for L7 DDoS detection."
+ },
+ "FirewallPolicyAssociation": {
+ "properties": {
+ "attachmentTarget": {
+ "description": "The target that the firewall policy is attached to.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name for an association."
+ },
+ "shortName": {
+ "type": "string",
+ "description": "[Output Only] The short name of the firewall policy of the association."
+ },
+ "firewallPolicyId": {
+ "type": "string",
+ "description": "[Output Only] The firewall policy ID of the association."
+ }
+ },
+ "id": "FirewallPolicyAssociation",
+ "type": "object"
+ },
+ "ForwardingRule": {
+ "id": "ForwardingRule",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "networkTier": {
+ "enumDescriptions": [
+ "Public internet quality with fixed bandwidth.",
+ "High quality, Google-grade network tier, support for all networking products.",
+ "Public internet quality, only limited support for other networking products.",
+ "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured."
],
- "path": "projects/{project}/regions/{region}/interconnectAttachments",
- "flatPath": "projects/{project}/regions/{region}/interconnectAttachments",
- "response": {
- "$ref": "Operation"
- },
- "description": "Creates an InterconnectAttachment in the specified project using the data included in the request."
+ "description": "This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.",
+ "type": "string",
+ "enum": [
+ "FIXED_STANDARD",
+ "PREMIUM",
+ "STANDARD",
+ "STANDARD_OVERRIDES_FIXED_STANDARD"
+ ]
},
- "get": {
- "id": "compute.interconnectAttachments.get",
- "parameterOrder": [
- "project",
- "region",
- "interconnectAttachment"
+ "labelFingerprint": {
+ "description": "A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.",
+ "format": "byte",
+ "type": "string"
+ },
+ "region": {
+ "description": "[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. 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"
+ },
+ "fingerprint": {
+ "format": "byte",
+ "description": "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 ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.",
+ "type": "string"
+ },
+ "pscConnectionId": {
+ "description": "[Output Only] The PSC connection id of the PSC Forwarding Rule.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "IPProtocol": {
+ "enum": [
+ "AH",
+ "ESP",
+ "ICMP",
+ "L3_DEFAULT",
+ "SCTP",
+ "TCP",
+ "UDP"
],
- "httpMethod": "GET",
- "response": {
- "$ref": "InterconnectAttachment"
- },
- "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
- "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "required": true
- },
- "region": {
- "required": true,
- "description": "Name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path"
- },
- "interconnectAttachment": {
- "description": "Name of the interconnect attachment to return.",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- }
- },
- "description": "Returns the specified interconnect attachment."
+ "description": "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).",
+ "type": "string"
},
- "list": {
- "description": "Retrieves the list of interconnect attachments contained within the specified region.",
- "parameters": {
- "maxResults": {
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "default": "500",
- "location": "query",
- "format": "uint32"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request.",
- "type": "string",
- "location": "path",
- "required": true
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "region"
+ "IPAddress": {
+ "type": "string",
+ "description": "IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number."
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "pscConnectionStatus": {
+ "type": "string",
+ "enum": [
+ "ACCEPTED",
+ "CLOSED",
+ "NEEDS_ATTENTION",
+ "PENDING",
+ "REJECTED",
+ "STATUS_UNSPECIFIED"
],
- "flatPath": "projects/{project}/regions/{region}/interconnectAttachments",
- "path": "projects/{project}/regions/{region}/interconnectAttachments",
- "response": {
- "$ref": "InterconnectAttachmentList"
- },
- "id": "compute.interconnectAttachments.list",
- "httpMethod": "GET"
+ "enumDescriptions": [
+ "The connection has been accepted by the producer.",
+ "The connection has been closed by the producer and will not serve traffic going forward.",
+ "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.",
+ "The connection is pending acceptance by the producer.",
+ "The connection has been rejected by the producer.",
+ ""
+ ]
},
- "setLabels": {
- "request": {
- "$ref": "RegionSetLabelsRequest"
+ "labels": {
+ "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.",
+ "additionalProperties": {
+ "type": "string"
},
- "description": "Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "required": true
- },
- "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).",
- "type": "string",
- "location": "query"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The region for this request."
- },
- "resource": {
- "required": true,
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- }
+ "type": "object"
+ },
+ "allowGlobalAccess": {
+ "type": "boolean",
+ "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."
+ },
+ "name": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "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. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter."
+ },
+ "target": {
+ "type": "string",
+ "description": "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the \"Target\" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. "
+ },
+ "ports": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels",
- "response": {
- "$ref": "Operation"
+ "description": "This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\\\d+(?:-\\\\d+)?",
+ "type": "array"
+ },
+ "portRange": {
+ "description": "This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\\\d+(?:-\\\\d+)?",
+ "type": "string"
+ },
+ "serviceName": {
+ "type": "string",
+ "description": "[Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing."
+ },
+ "isMirroringCollector": {
+ "type": "boolean",
+ "description": "Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL."
+ },
+ "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"
+ },
+ "noAutomateDnsZone": {
+ "type": "boolean",
+ "description": "This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field."
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "metadataFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "MetadataFilter"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "description": "Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED."
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "ipVersion": {
+ "type": "string",
+ "description": "The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.",
+ "enum": [
+ "IPV4",
+ "IPV6",
+ "UNSPECIFIED_VERSION"
],
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels",
- "id": "compute.interconnectAttachments.setLabels"
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
},
- "aggregatedList": {
- "id": "compute.interconnectAttachments.aggregatedList",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "serviceDirectoryRegistrations": {
+ "type": "array",
+ "items": {
+ "$ref": "ForwardingRuleServiceDirectoryRegistration"
+ },
+ "description": "Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource."
+ },
+ "allPorts": {
+ "description": "This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive.",
+ "type": "boolean"
+ },
+ "loadBalancingScheme": {
+ "enum": [
+ "EXTERNAL",
+ "EXTERNAL_MANAGED",
+ "INTERNAL",
+ "INTERNAL_MANAGED",
+ "INTERNAL_SELF_MANAGED",
+ "INVALID"
],
- "httpMethod": "GET",
- "path": "projects/{project}/aggregated/interconnectAttachments",
- "parameterOrder": [
- "project"
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "response": {
- "$ref": "InterconnectAttachmentAggregatedList"
- },
- "parameters": {
- "includeAllScopes": {
- "location": "query",
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "maxResults": {
- "format": "uint32",
- "default": "500",
- "location": "query",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- }
- },
- "description": "Retrieves an aggregated list of interconnect attachments.",
- "flatPath": "projects/{project}/aggregated/interconnectAttachments"
+ "type": "string",
+ "description": "Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts."
+ },
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.",
+ "type": "string",
+ "default": "compute#forwardingRule"
+ },
+ "network": {
+ "type": "string",
+ "description": "This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided."
+ },
+ "serviceLabel": {
+ "type": "string",
+ "description": "An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label 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. This field is only used for internal load balancing.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "subnetwork": {
+ "type": "string",
+ "description": "This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6."
+ }
+ },
+ "type": "object",
+ "description": "Represents a Forwarding Rule resource. Forwarding rule resources in Google Cloud can be either regional or global in scope: * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules) A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding."
+ },
+ "SslPolicyReference": {
+ "id": "SslPolicyReference",
+ "type": "object",
+ "properties": {
+ "sslPolicy": {
+ "description": "URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.",
+ "type": "string"
}
}
},
- "targetPools": {
- "methods": {
- "aggregatedList": {
- "path": "projects/{project}/aggregated/targetPools",
- "httpMethod": "GET",
- "description": "Retrieves an aggregated list of target pools.",
- "id": "compute.targetPools.aggregatedList",
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/aggregated/targetPools",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "maxResults": {
- "default": "500",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "location": "query",
- "type": "integer"
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "includeAllScopes": {
- "location": "query",
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- }
- },
- "response": {
- "$ref": "TargetPoolAggregatedList"
- }
+ "ResourcePolicyResourceStatus": {
+ "description": "Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this \"status\" field should mimic the structure of ResourcePolicy proto specification.",
+ "type": "object",
+ "properties": {
+ "instanceSchedulePolicy": {
+ "$ref": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus",
+ "description": "[Output Only] Specifies a set of output values reffering to the instance_schedule_policy system status. This field should have the same name as corresponding policy field."
+ }
+ },
+ "id": "ResourcePolicyResourceStatus"
+ },
+ "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus": {
+ "id": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus",
+ "type": "object",
+ "properties": {
+ "nextRunStartTime": {
+ "type": "string",
+ "description": "[Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string."
},
- "insert": {
- "parameterOrder": [
- "project",
- "region"
- ],
- "parameters": {
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "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).",
- "type": "string",
- "location": "query"
- }
- },
- "id": "compute.targetPools.insert",
- "response": {
- "$ref": "Operation"
+ "lastRunStartTime": {
+ "description": "[Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.",
+ "type": "string"
+ }
+ }
+ },
+ "FirewallPolicy": {
+ "type": "object",
+ "description": "Represents a Firewall Policy resource.",
+ "id": "FirewallPolicy",
+ "properties": {
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ },
+ "name": {
+ "description": "Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. 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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "shortName": {
+ "description": "User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. 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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "rules": {
+ "type": "array",
+ "items": {
+ "$ref": "FirewallPolicyRule"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/targetPools",
- "flatPath": "projects/{project}/regions/{region}/targetPools",
- "httpMethod": "POST",
- "request": {
- "$ref": "TargetPool"
+ "description": "A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match \"*\"). If no rules are provided when creating a firewall policy, a default rule with action \"allow\" will be added."
+ },
+ "selfLinkWithId": {
+ "description": "[Output Only] Server-defined URL for this resource with the resource id.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies",
+ "default": "compute#firewallPolicy"
+ },
+ "ruleTupleCount": {
+ "format": "int32",
+ "description": "[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.",
+ "type": "integer"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "fingerprint": {
+ "format": "byte",
+ "type": "string",
+ "description": "Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy."
+ },
+ "parent": {
+ "type": "string",
+ "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies."
+ },
+ "associations": {
+ "description": "A list of associations that belong to this firewall policy.",
+ "items": {
+ "$ref": "FirewallPolicyAssociation"
},
- "description": "Creates a target pool in the specified project and region using the data included in the request."
+ "type": "array"
},
- "setBackup": {
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup",
- "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup",
- "request": {
- "$ref": "TargetReference"
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ }
+ }
+ },
+ "AutoscalerAggregatedList": {
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "id": "compute.targetPools.setBackup",
- "description": "Changes a backup target pool's configurations.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
+ "type": "array",
+ "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#autoscalerAggregatedList",
+ "description": "[Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "items": {
+ "additionalProperties": {
+ "$ref": "AutoscalersScopedList",
+ "description": "[Output Only] Name of the scope containing this set of autoscalers."
},
- "parameters": {
- "failoverRatio": {
- "description": "New failoverRatio value for the target pool.",
- "location": "query",
- "type": "number",
- "format": "float"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "description": "Name of the region scoping this request."
- },
- "targetPool": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the TargetPool resource to set a backup pool for."
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
- }
- }
+ "description": "A list of AutoscalersScopedList resources.",
+ "type": "object"
},
- "get": {
- "description": "Returns the specified target pool. Gets a list of available target pools by making a list() request.",
- "path": "projects/{project}/regions/{region}/targetPools/{targetPool}",
- "parameters": {
- "region": {
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string",
- "location": "path"
+ "warning": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "type": "array"
},
- "targetPool": {
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the TargetPool resource to return.",
- "required": true
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "type": "string"
},
- "project": {
- "required": true,
- "location": "path",
+ "message": {
"type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "response": {
- "$ref": "TargetPool"
- },
- "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}",
- "httpMethod": "GET",
- "id": "compute.targetPools.get",
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "description": "[Output Only] Informational warning message."
+ }
+ },
+ "type": "object",
+ "id": "AutoscalerAggregatedList"
+ },
+ "TargetSslProxyList": {
+ "id": "TargetSslProxyList",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
},
- "removeHealthCheck": {
- "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck",
- "request": {
- "$ref": "TargetPoolsRemoveHealthCheckRequest"
- },
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "project": {
- "description": "Project ID for this request.",
+ "warning": {
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "region": {
- "location": "path",
+ "message": {
"type": "string",
- "description": "Name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "targetPool": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the target pool to remove health checks from."
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
}
},
- "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck",
- "description": "Removes health check URL from a target pool.",
- "id": "compute.targetPools.removeHealthCheck",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
},
- "delete": {
- "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}",
- "path": "projects/{project}/regions/{region}/targetPools/{targetPool}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "targetPool": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "description": "Name of the TargetPool resource to delete."
- },
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "Name of the region scoping this request.",
- "type": "string"
- }
- },
- "id": "compute.targetPools.delete",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "description": "Deletes the specified target pool."
+ "kind": {
+ "description": "Type of resource.",
+ "default": "compute#targetSslProxyList",
+ "type": "string"
},
- "removeInstance": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance",
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "httpMethod": "POST",
- "id": "compute.targetPools.removeInstance",
- "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance",
- "response": {
- "$ref": "Operation"
- },
- "description": "Removes instance URL from a target pool.",
- "parameters": {
- "region": {
- "location": "path",
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "targetPool": {
- "description": "Name of the TargetPool resource to remove instances from.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- }
- },
- "request": {
- "$ref": "TargetPoolsRemoveInstanceRequest"
+ "items": {
+ "description": "A list of TargetSslProxy resources.",
+ "type": "array",
+ "items": {
+ "$ref": "TargetSslProxy"
}
},
- "list": {
- "flatPath": "projects/{project}/regions/{region}/targetPools",
- "httpMethod": "GET",
- "description": "Retrieves a list of target pools available to the specified project and region.",
- "response": {
- "$ref": "TargetPoolList"
- },
- "parameters": {
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "format": "uint32",
- "location": "query",
- "type": "integer",
- "default": "500"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "region": {
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "required": true
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "path": "projects/{project}/regions/{region}/targetPools",
- "id": "compute.targetPools.list",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
},
- "addHealthCheck": {
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck",
- "description": "Adds health check URLs to a target pool.",
- "parameters": {
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "type": "string",
- "location": "path",
- "required": true
- },
- "targetPool": {
- "type": "string",
- "description": "Name of the target pool to add a health check to.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- },
- "id": "compute.targetPools.addHealthCheck",
- "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck",
- "request": {
- "$ref": "TargetPoolsAddHealthCheckRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ },
+ "description": "Contains a list of TargetSslProxy resources.",
+ "type": "object"
+ },
+ "TargetPoolAggregatedList": {
+ "properties": {
+ "items": {
+ "type": "object",
+ "description": "A list of TargetPool resources.",
+ "additionalProperties": {
+ "$ref": "TargetPoolsScopedList",
+ "description": "Name of the scope containing this set of target pools."
}
},
- "addInstance": {
- "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance",
- "request": {
- "$ref": "TargetPoolsAddInstanceRequest"
- },
- "id": "compute.targetPools.addInstance",
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "kind": {
+ "default": "compute#targetPoolAggregatedList",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "unreachables": {
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "code": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
+ "data": {
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "targetPool": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the TargetPool resource to add instances to.",
- "required": true,
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
- },
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "httpMethod": "POST",
- "description": "Adds an instance to a target pool.",
- "response": {
- "$ref": "Operation"
+ }
+ }
+ },
+ "type": "object",
+ "id": "TargetPoolAggregatedList"
+ },
+ "InstanceAggregatedList": {
+ "type": "object",
+ "id": "InstanceAggregatedList",
+ "properties": {
+ "unreachables": {
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
},
- "getHealth": {
- "response": {
- "$ref": "TargetPoolInstanceHealth"
- },
- "parameters": {
- "project": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.",
+ "default": "compute#instanceAggregatedList"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "items": {
+ "description": "An object that contains a list of instances scoped by zone.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "[Output Only] Name of the scope containing this set of instances.",
+ "$ref": "InstancesScopedList"
+ }
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "warning": {
+ "properties": {
+ "code": {
"type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "targetPool": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the TargetPool resource to which the queried instance belongs."
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "region": {
- "description": "Name of the region scoping this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "type": "array"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "request": {
- "$ref": "InstanceReference"
- },
- "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth",
- "description": "Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.",
- "parameterOrder": [
- "project",
- "region",
- "targetPool"
- ],
- "httpMethod": "POST",
- "id": "compute.targetPools.getHealth",
- "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
}
}
},
- "targetHttpsProxies": {
- "methods": {
- "delete": {
- "id": "compute.targetHttpsProxies.delete",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Deletes the specified TargetHttpsProxy resource.",
- "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
+ "TargetTcpProxyAggregatedList": {
+ "type": "object",
+ "id": "TargetTcpProxyAggregatedList",
+ "properties": {
+ "warning": {
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "targetHttpsProxy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the TargetHttpsProxy resource to delete.",
- "location": "path",
- "required": true
+ "data": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "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).",
- "type": "string",
- "location": "query"
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string"
}
},
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "DELETE",
- "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ]
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
},
- "insert": {
- "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.",
- "id": "compute.targetHttpsProxies.insert",
- "flatPath": "projects/{project}/global/targetHttpsProxies",
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "Operation"
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/global/targetHttpsProxies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "TargetHttpsProxy"
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "additionalProperties": {
+ "description": "Name of the scope containing this set of TargetTcpProxies.",
+ "$ref": "TargetTcpProxiesScopedList"
},
- "httpMethod": "POST",
- "parameters": {
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- }
+ "description": "A list of TargetTcpProxiesScopedList resources.",
+ "type": "object"
},
- "get": {
- "httpMethod": "GET",
- "description": "Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.",
- "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#targetTcpProxyAggregatedList for lists of Target TCP Proxies.",
+ "default": "compute#targetTcpProxyAggregatedList",
+ "type": "string"
+ }
+ }
+ },
+ "ResourcePolicySnapshotSchedulePolicy": {
+ "id": "ResourcePolicySnapshotSchedulePolicy",
+ "description": "A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained.",
+ "type": "object",
+ "properties": {
+ "schedule": {
+ "$ref": "ResourcePolicySnapshotSchedulePolicySchedule",
+ "description": "A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy."
+ },
+ "snapshotProperties": {
+ "$ref": "ResourcePolicySnapshotSchedulePolicySnapshotProperties",
+ "description": "Properties with which snapshots are created such as labels, encryption keys."
+ },
+ "retentionPolicy": {
+ "description": "Retention policy applied to snapshots created by this resource policy.",
+ "$ref": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy"
+ }
+ }
+ },
+ "SecurityPolicyAdvancedOptionsConfig": {
+ "properties": {
+ "jsonCustomConfig": {
+ "$ref": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig",
+ "description": "Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD."
+ },
+ "jsonParsing": {
+ "enumDescriptions": [
+ "",
+ ""
],
- "parameters": {
- "targetHttpsProxy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
- "description": "Name of the TargetHttpsProxy resource to return.",
- "type": "string"
- },
- "project": {
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string"
- }
- },
- "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- "id": "compute.targetHttpsProxies.get",
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
+ "enum": [
+ "DISABLED",
+ "STANDARD"
],
- "response": {
- "$ref": "TargetHttpsProxy"
- }
+ "type": "string"
},
- "list": {
- "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.",
- "response": {
- "$ref": "TargetHttpsProxyList"
+ "logLevel": {
+ "type": "string",
+ "enum": [
+ "NORMAL",
+ "VERBOSE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ]
+ }
+ },
+ "id": "SecurityPolicyAdvancedOptionsConfig",
+ "type": "object"
+ },
+ "FirewallPolicyList": {
+ "id": "FirewallPolicyList",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "kind": {
+ "default": "compute#firewallPolicyList",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#firewallPolicyList for listsof FirewallPolicies"
+ },
+ "items": {
+ "items": {
+ "$ref": "FirewallPolicy"
},
- "parameters": {
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "maxResults": {
- "format": "uint32",
- "location": "query",
- "minimum": "0",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
+ "type": "array",
+ "description": "A list of FirewallPolicy resources."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "pageToken": {
- "location": "query",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
- "id": "compute.targetHttpsProxies.list",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/global/targetHttpsProxies",
- "path": "projects/{project}/global/targetHttpsProxies",
- "parameterOrder": [
- "project"
- ]
- },
- "setSslCertificates": {
- "description": "Replaces SslCertificates for TargetHttpsProxy.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "DistributionPolicyZoneConfiguration": {
+ "id": "DistributionPolicyZoneConfiguration",
+ "properties": {
+ "zone": {
+ "description": "The URL of the zone. The zone must exist in the region where the managed instance group is located.",
+ "annotations": {
+ "required": [
+ "compute.regionInstanceGroupManagers.insert"
+ ]
+ },
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PacketMirroringFilter": {
+ "id": "PacketMirroringFilter",
+ "type": "object",
+ "properties": {
+ "direction": {
+ "enumDescriptions": [
+ "Default, both directions are mirrored.",
+ "Only egress traffic is mirrored.",
+ "Only ingress traffic is mirrored."
],
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
+ "enum": [
+ "BOTH",
+ "EGRESS",
+ "INGRESS"
],
- "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
- "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
- "id": "compute.targetHttpsProxies.setSslCertificates",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST",
- "request": {
- "$ref": "TargetHttpsProxiesSetSslCertificatesRequest"
+ "description": "Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH. The default is BOTH.",
+ "type": "string"
+ },
+ "cidrRanges": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "parameters": {
- "targetHttpsProxy": {
- "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
- }
- }
+ "description": "IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored."
},
- "aggregatedList": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "TargetHttpsProxyAggregatedList"
+ "IPProtocols": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project"
- ],
- "id": "compute.targetHttpsProxies.aggregatedList",
- "flatPath": "projects/{project}/aggregated/targetHttpsProxies",
- "parameters": {
- "includeAllScopes": {
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "maxResults": {
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "type": "integer",
- "location": "query",
- "format": "uint32"
- },
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Name of the project scoping this request.",
- "location": "path"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
+ "description": "Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored."
+ }
+ }
+ },
+ "Operation": {
+ "type": "object",
+ "description": "Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.",
+ "id": "Operation",
+ "properties": {
+ "user": {
+ "description": "[Output Only] User who requested the operation, for example: `user@example.com`.",
+ "type": "string"
+ },
+ "httpErrorStatusCode": {
+ "format": "int32",
+ "description": "[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.",
+ "type": "integer"
+ },
+ "warnings": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
+ },
+ "code": {
+ "type": "string",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ },
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
+ }
}
},
- "httpMethod": "GET",
- "path": "projects/{project}/aggregated/targetHttpsProxies",
- "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project."
+ "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
+ "type": "array"
},
- "patch": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "httpMethod": "PATCH",
- "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- "id": "compute.targetHttpsProxies.patch",
- "request": {
- "$ref": "TargetHttpsProxy"
- },
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "targetHttpsProxy": {
- "location": "path",
- "description": "Name of the TargetHttpsProxy resource to patch.",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "operationGroupId": {
+ "description": "[Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "description": "[Deprecated] This field is deprecated.",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format.",
+ "type": "string"
+ },
+ "error": {
+ "properties": {
+ "errors": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "[Output Only] An optional, human-readable error message.",
+ "type": "string"
+ },
+ "code": {
+ "description": "[Output Only] The error type identifier for this error.",
+ "type": "string"
+ },
+ "errorDetails": {
+ "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "help": {
+ "$ref": "Help"
+ },
+ "errorInfo": {
+ "$ref": "ErrorInfo"
+ },
+ "localizedMessage": {
+ "$ref": "LocalizedMessage"
+ },
+ "quotaInfo": {
+ "$ref": "QuotaExceededInfo"
+ }
+ }
+ },
+ "type": "array"
+ },
+ "location": {
+ "type": "string",
+ "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional."
+ }
+ }
+ },
+ "description": "[Output Only] The array of errors encountered while processing this operation.",
+ "type": "array"
}
},
- "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
- "description": "Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
- "response": {
- "$ref": "Operation"
- }
+ "type": "object",
+ "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated."
},
- "setUrlMap": {
- "httpMethod": "POST",
- "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
- "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "zone": {
+ "description": "[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.",
+ "type": "string"
+ },
+ "region": {
+ "description": "[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "[Output Only] A textual description of the operation, which is set when the operation is created."
+ },
+ "operationType": {
+ "type": "string",
+ "description": "[Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on."
+ },
+ "progress": {
+ "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "clientOperationId": {
+ "description": "[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format.",
+ "type": "string"
+ },
+ "statusMessage": {
+ "type": "string",
+ "description": "[Output Only] An optional textual description of the current status of the operation."
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always `compute#operation` for Operation resources.",
+ "default": "compute#operation"
+ },
+ "targetId": {
+ "description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "startTime": {
+ "description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.",
+ "type": "string"
+ },
+ "name": {
+ "description": "[Output Only] Name of the operation.",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the operation. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "status": {
+ "description": "[Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
],
- "parameters": {
- "targetHttpsProxy": {
- "location": "path",
- "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- },
- "project": {
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "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).",
- "type": "string",
- "location": "query"
- }
- },
- "description": "Changes the URL map for TargetHttpsProxy.",
- "request": {
- "$ref": "UrlMapReference"
- },
- "id": "compute.targetHttpsProxies.setUrlMap",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
+ "type": "string",
+ "enum": [
+ "DONE",
+ "PENDING",
+ "RUNNING"
]
},
- "setCertificateMap": {
- "parameters": {
- "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).",
- "type": "string",
- "location": "query"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string"
- },
- "targetHttpsProxy": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035."
- }
+ "targetLink": {
+ "description": "[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.",
+ "type": "string"
+ },
+ "httpErrorMessage": {
+ "type": "string",
+ "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`."
+ }
+ }
+ },
+ "AddressAggregatedList": {
+ "id": "AddressAggregatedList",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "[Output Only] Name of the scope containing this set of addresses.",
+ "$ref": "AddressesScopedList"
},
- "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap",
- "description": "Changes the Certificate Map for TargetHttpsProxy.",
- "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "id": "compute.targetHttpsProxies.setCertificateMap",
- "response": {
- "$ref": "Operation"
+ "description": "A list of AddressesScopedList resources."
+ },
+ "unreachables": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "request": {
- "$ref": "TargetHttpsProxiesSetCertificateMapRequest"
- }
+ "description": "[Output Only] Unreachable resources."
},
- "setQuicOverride": {
- "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride",
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "parameters": {
- "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).",
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "message": {
"type": "string",
- "location": "query"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "type": "array"
},
- "targetHttpsProxy": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "description": "Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.",
- "location": "path",
- "required": true
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride",
- "description": "Sets the QUIC override policy for TargetHttpsProxy.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "request": {
- "$ref": "TargetHttpsProxiesSetQuicOverrideRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.targetHttpsProxies.setQuicOverride"
+ "type": "object"
},
- "setSslPolicy": {
- "parameterOrder": [
- "project",
- "targetHttpsProxy"
- ],
- "id": "compute.targetHttpsProxies.setSslPolicy",
- "parameters": {
- "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).",
- "type": "string",
- "location": "query"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
- },
- "targetHttpsProxy": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035."
- }
- },
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy",
- "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy",
- "request": {
- "$ref": "SslPolicyReference"
- }
+ "kind": {
+ "default": "compute#addressAggregatedList",
+ "description": "[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
}
- }
+ },
+ "type": "object"
},
- "regionSecurityPolicies": {
- "methods": {
- "list": {
- "path": "projects/{project}/regions/{region}/securityPolicies",
- "description": "List all the policies that have been configured for the specified project and region.",
- "parameters": {
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "maxResults": {
- "format": "uint32",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "minimum": "0",
- "type": "integer"
- },
- "region": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of the region scoping this request."
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- }
+ "Route": {
+ "id": "Route",
+ "type": "object",
+ "properties": {
+ "name": {
+ "annotations": {
+ "required": [
+ "compute.routes.insert"
+ ]
},
- "flatPath": "projects/{project}/regions/{region}/securityPolicies",
- "response": {
- "$ref": "SecurityPolicyList"
+ "type": "string",
+ "description": "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this field when you create the resource.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined fully-qualified URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "nextHopGateway": {
+ "description": "The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway",
+ "type": "string"
+ },
+ "asPaths": {
+ "description": "[Output Only] AS path.",
+ "items": {
+ "$ref": "RouteAsPath"
},
- "parameterOrder": [
- "project",
- "region"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.regionSecurityPolicies.list"
+ "type": "array"
},
- "delete": {
- "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.regionSecurityPolicies.delete",
- "response": {
- "$ref": "Operation"
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of this resource. Always compute#routes for Route resources.",
+ "default": "compute#route"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "priority": {
+ "annotations": {
+ "required": [
+ "compute.routes.insert"
+ ]
},
- "description": "Deletes the specified policy.",
- "parameterOrder": [
- "project",
- "region",
- "securityPolicy"
- ],
- "parameters": {
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
- },
- "securityPolicy": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the security policy to delete.",
- "type": "string"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the region scoping this request."
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
+ "description": "The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "nextHopIp": {
+ "type": "string",
+ "description": "The network IP address of an instance that should handle matching packets. Only IPv4 is supported."
+ },
+ "destRange": {
+ "description": "The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.",
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.routes.insert"
+ ]
+ }
+ },
+ "network": {
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.routes.insert"
+ ]
},
- "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
- "httpMethod": "DELETE"
+ "description": "Fully-qualified URL of the network that this route applies to."
},
- "patch": {
- "parameters": {
- "securityPolicy": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the security policy to update."
- },
- "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).",
- "type": "string",
- "location": "query"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "location": "path",
- "required": true,
- "type": "string"
- }
+ "nextHopPeering": {
+ "type": "string",
+ "description": "[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035."
+ },
+ "tags": {
+ "description": "A list of instance tags to which this route applies.",
+ "annotations": {
+ "required": [
+ "compute.routes.insert"
+ ]
},
- "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.",
- "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
- "parameterOrder": [
- "project",
- "region",
- "securityPolicy"
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "warnings": {
+ "type": "array",
+ "description": "[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.",
+ "items": {
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
+ },
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "nextHopInstance": {
+ "type": "string",
+ "description": "The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/"
+ },
+ "nextHopNetwork": {
+ "description": "The URL of the local network if it should handle matching packets.",
+ "type": "string"
+ },
+ "routeStatus": {
+ "enum": [
+ "ACTIVE",
+ "DROPPED",
+ "INACTIVE",
+ "PENDING"
],
- "id": "compute.regionSecurityPolicies.patch",
- "request": {
- "$ref": "SecurityPolicy"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "enumDescriptions": [
+ "This route is processed and active.",
+ "The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example",
+ "This route is processed but inactive due to failure from the backend. The backend may have rejected the route",
+ "This route is being processed internally. The status will change once processed."
],
- "httpMethod": "PATCH",
- "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}"
+ "description": "[Output only] The status of the route."
},
- "get": {
- "id": "compute.regionSecurityPolicies.get",
- "parameters": {
- "securityPolicy": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the security policy to get.",
- "location": "path"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "Name of the region scoping this request.",
- "type": "string",
- "location": "path"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "description": "List all of the ordered rules present in a single specified policy.",
- "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "region",
- "securityPolicy"
+ "nextHopIlb": {
+ "type": "string",
+ "description": "The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule "
+ },
+ "nextHopVpnTunnel": {
+ "description": "The URL to a VpnTunnel that should handle matching packets.",
+ "type": "string"
+ },
+ "routeType": {
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
],
- "response": {
- "$ref": "SecurityPolicy"
- },
- "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "string",
+ "description": "[Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route",
+ "enum": [
+ "BGP",
+ "STATIC",
+ "SUBNET",
+ "TRANSIT"
]
+ }
+ },
+ "description": "Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview."
+ },
+ "PublicDelegatedPrefixesScopedList": {
+ "properties": {
+ "publicDelegatedPrefixes": {
+ "type": "array",
+ "description": "[Output Only] A list of PublicDelegatedPrefixes contained in this scope.",
+ "items": {
+ "$ref": "PublicDelegatedPrefix"
+ }
},
- "insert": {
- "parameterOrder": [
- "project",
- "region"
- ],
- "flatPath": "projects/{project}/regions/{region}/securityPolicies",
- "request": {
- "$ref": "SecurityPolicy"
- },
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.regionSecurityPolicies.insert",
- "parameters": {
- "project": {
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "warning": {
+ "description": "[Output Only] Informational warning which replaces the list of public delegated prefixes when the list is empty.",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "region": {
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "validateOnly": {
- "location": "query",
- "description": "If true, the request will not be committed.",
- "type": "boolean"
- },
- "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).",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "location": "query"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "path": "projects/{project}/regions/{region}/securityPolicies",
- "response": {
- "$ref": "Operation"
- },
- "description": "Creates a new policy in the specified project using the data included in the request."
+ "type": "object"
+ }
+ },
+ "type": "object",
+ "id": "PublicDelegatedPrefixesScopedList"
+ },
+ "InterconnectDiagnosticsLinkOpticalPower": {
+ "type": "object",
+ "id": "InterconnectDiagnosticsLinkOpticalPower",
+ "properties": {
+ "state": {
+ "enum": [
+ "HIGH_ALARM",
+ "HIGH_WARNING",
+ "LOW_ALARM",
+ "LOW_WARNING",
+ "OK"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "The value has crossed above the high alarm threshold.",
+ "The value of the current optical power has crossed above the high warning threshold.",
+ "The value of the current optical power has crossed below the low alarm threshold.",
+ "The value of the current optical power has crossed below the low warning threshold.",
+ "The value of the current optical power has not crossed a warning threshold."
+ ],
+ "description": "The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. "
+ },
+ "value": {
+ "description": "Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.",
+ "type": "number",
+ "format": "float"
}
}
},
- "regions": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Region"
- },
- "path": "projects/{project}/regions/{region}",
- "flatPath": "projects/{project}/regions/{region}",
- "description": "Returns the specified Region resource. Gets a list of available regions by making a list() request. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.",
- "parameterOrder": [
- "project",
- "region"
+ "RouterBgpPeer": {
+ "type": "object",
+ "properties": {
+ "managementType": {
+ "type": "string",
+ "enum": [
+ "MANAGED_BY_ATTACHMENT",
+ "MANAGED_BY_USER"
],
- "parameters": {
- "region": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the region resource to return.",
- "required": true
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "httpMethod": "GET",
- "id": "compute.regions.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. ",
+ "enumDescriptions": [
+ "The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.",
+ "Default value, the BGP peer is manually created and managed by user."
]
},
- "list": {
- "description": "Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.",
- "id": "compute.regions.list",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "routerApplianceInstance": {
+ "description": "URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.",
+ "type": "string"
+ },
+ "ipAddress": {
+ "type": "string",
+ "description": "IP address of the interface inside Google Cloud Platform. Only IPv4 is supported."
+ },
+ "enable": {
+ "description": "The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.",
+ "enumDescriptions": [
+ "",
+ ""
],
- "httpMethod": "GET",
- "flatPath": "projects/{project}/regions",
- "response": {
- "$ref": "RegionList"
+ "enum": [
+ "FALSE",
+ "TRUE"
+ ],
+ "type": "string"
+ },
+ "enableIpv6": {
+ "type": "boolean",
+ "description": "Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default."
+ },
+ "ipv6NexthopAddress": {
+ "description": "IPv6 address of the interface inside Google Cloud Platform.",
+ "type": "string"
+ },
+ "peerAsn": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.",
+ "annotations": {
+ "required": [
+ "compute.routers.insert"
+ ]
+ }
+ },
+ "peerIpAddress": {
+ "description": "IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.",
+ "type": "string"
+ },
+ "advertisedGroups": {
+ "type": "array",
+ "description": "User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.",
+ "items": {
+ "type": "string",
+ "enumDescriptions": [
+ "Advertise all available subnets (including peer VPC subnets)."
+ ],
+ "enum": [
+ "ALL_SUBNETS"
+ ]
+ }
+ },
+ "bfd": {
+ "description": "BFD configuration for the BGP peering.",
+ "$ref": "RouterBgpPeerBfd"
+ },
+ "advertisedRoutePriority": {
+ "description": "The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "advertiseMode": {
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "enum": [
+ "CUSTOM",
+ "DEFAULT"
+ ],
+ "description": "User-specified flag to indicate which mode to use for advertisement."
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "annotations": {
+ "required": [
+ "compute.routers.insert"
+ ]
},
- "path": "projects/{project}/regions",
- "parameters": {
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
- },
- "maxResults": {
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "minimum": "0",
- "location": "query",
- "type": "integer"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- }
+ "description": "Name of this BGP peer. 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.",
+ "type": "string"
+ },
+ "interfaceName": {
+ "description": "Name of the interface the BGP peer is associated with.",
+ "type": "string"
+ },
+ "peerIpv6NexthopAddress": {
+ "description": "IPv6 address of the BGP interface outside Google Cloud Platform.",
+ "type": "string"
+ },
+ "advertisedIpRanges": {
+ "items": {
+ "$ref": "RouterAdvertisedIpRange"
},
- "parameterOrder": [
- "project"
- ]
+ "description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.",
+ "type": "array"
+ },
+ "md5AuthenticationKeyName": {
+ "description": "Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.",
+ "type": "string"
}
- }
+ },
+ "id": "RouterBgpPeer"
},
- "networkAttachments": {
- "methods": {
- "aggregatedList": {
- "path": "projects/{project}/aggregated/networkAttachments",
- "response": {
- "$ref": "NetworkAttachmentAggregatedList"
+ "SecurityPoliciesScopedList": {
+ "properties": {
+ "securityPolicies": {
+ "description": "A list of SecurityPolicies contained in this scope.",
+ "items": {
+ "$ref": "SecurityPolicy"
},
- "httpMethod": "GET",
- "description": "Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.",
- "id": "compute.networkAttachments.aggregatedList",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project"
- ],
- "parameters": {
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "array"
+ },
+ "warning": {
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string"
},
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "format": "uint32",
- "location": "query",
- "default": "500",
- "type": "integer"
- },
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean",
- "location": "query"
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ }
},
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
},
- "flatPath": "projects/{project}/aggregated/networkAttachments"
+ "description": "Informational warning which replaces the list of security policies when the list is empty.",
+ "type": "object"
+ }
+ },
+ "type": "object",
+ "id": "SecurityPoliciesScopedList"
+ },
+ "BackendBucket": {
+ "type": "object",
+ "properties": {
+ "enableCdn": {
+ "type": "boolean",
+ "description": "If true, enable Cloud CDN for this BackendBucket."
},
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "response": {
- "$ref": "Policy"
- },
- "flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy",
- "id": "compute.networkAttachments.getIamPolicy",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy",
- "parameters": {
- "optionsRequestedPolicyVersion": {
- "format": "int32",
- "description": "Requested IAM Policy version.",
- "type": "integer",
- "location": "query"
- },
- "resource": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "description": "Name or id of the resource for this request."
- },
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the region for this request.",
- "type": "string",
- "required": true
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- }
+ "customResponseHeaders": {
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ]
+ "description": "Headers that the HTTP/S load balancer should add to proxied responses.",
+ "type": "array"
},
- "setIamPolicy": {
- "path": "projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy",
- "parameters": {
- "resource": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name or id of the resource for this request.",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "required": true
- },
- "region": {
- "description": "The name of the region for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path"
- }
- },
- "httpMethod": "POST",
- "response": {
- "$ref": "Policy"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "kind": {
+ "type": "string",
+ "description": "Type of the resource.",
+ "default": "compute#backendBucket"
+ },
+ "edgeSecurityPolicy": {
+ "type": "string",
+ "description": "[Output Only] The resource URL for the edge security policy associated with this backend bucket."
+ },
+ "cdnPolicy": {
+ "$ref": "BackendBucketCdnPolicy",
+ "description": "Cloud CDN configuration for this BackendBucket."
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "id": {
+ "type": "string",
+ "format": "uint64",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "description": {
+ "description": "An optional textual description of the resource; provided by the client when the resource is created.",
+ "type": "string"
+ },
+ "bucketName": {
+ "type": "string",
+ "description": "Cloud Storage bucket name."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "compressionMode": {
+ "enum": [
+ "AUTOMATIC",
+ "DISABLED"
],
- "id": "compute.networkAttachments.setIamPolicy",
- "request": {
- "$ref": "RegionSetPolicyRequest"
- },
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "description": "Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.",
+ "enumDescriptions": [
+ "Automatically uses the best compression based on the Accept-Encoding header sent by the client.",
+ "Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients."
],
- "flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy"
+ "type": "string"
},
- "list": {
- "path": "projects/{project}/regions/{region}/networkAttachments",
- "description": "Lists the NetworkAttachments for a project in the given scope.",
- "id": "compute.networkAttachments.list",
- "parameterOrder": [
- "project",
- "region"
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "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."
+ }
+ },
+ "description": "Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.",
+ "id": "BackendBucket"
+ },
+ "PreservedStatePreservedDisk": {
+ "id": "PreservedStatePreservedDisk",
+ "properties": {
+ "source": {
+ "type": "string",
+ "description": "The URL of the disk resource that is stateful and should be attached to the VM instance."
+ },
+ "mode": {
+ "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.",
+ "enum": [
+ "READ_ONLY",
+ "READ_WRITE"
],
- "response": {
- "$ref": "NetworkAttachmentList"
- },
- "flatPath": "projects/{project}/regions/{region}/networkAttachments",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enumDescriptions": [
+ "Attaches this disk in read-only mode. Multiple VM instances can use a disk in READ_ONLY mode at a time.",
+ "*[Default]* Attaches this disk in READ_WRITE mode. Only one VM instance at a time can be attached to a disk in READ_WRITE mode."
],
- "httpMethod": "GET",
- "parameters": {
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "maxResults": {
- "default": "500",
- "format": "uint32",
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of the region of this request.",
- "location": "path"
- }
- }
+ "type": "string"
},
- "insert": {
- "request": {
- "$ref": "NetworkAttachment"
- },
- "httpMethod": "POST",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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"
+ "autoDelete": {
+ "enum": [
+ "NEVER",
+ "ON_PERMANENT_INSTANCE_DELETION"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "description": "These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted."
+ }
+ },
+ "type": "object"
+ },
+ "SslPolicy": {
+ "properties": {
+ "warnings": {
+ "items": {
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string",
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ },
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ }
},
- "region": {
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "Name of the region of this request."
- }
+ "type": "object"
},
- "flatPath": "projects/{project}/regions/{region}/networkAttachments",
- "parameterOrder": [
- "project",
- "region"
+ "type": "array",
+ "description": "[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages."
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies."
+ },
+ "minTlsVersion": {
+ "type": "string",
+ "enumDescriptions": [
+ "TLS 1.0",
+ "TLS 1.1",
+ "TLS 1.2"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.",
+ "enum": [
+ "TLS_1_0",
+ "TLS_1_1",
+ "TLS_1_2"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "profile": {
+ "enumDescriptions": [
+ "Compatible profile. Allows the broadset set of clients, even those which support only out-of-date SSL features to negotiate with the load balancer.",
+ "Custom profile. Allow only the set of allowed SSL features specified in the customFeatures field.",
+ "Modern profile. Supports a wide set of SSL features, allowing modern clients to negotiate SSL with the load balancer.",
+ "Restricted profile. Supports a reduced set of SSL features, intended to meet stricter compliance requirements."
],
- "path": "projects/{project}/regions/{region}/networkAttachments",
- "id": "compute.networkAttachments.insert",
- "response": {
- "$ref": "Operation"
+ "description": "Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.",
+ "enum": [
+ "COMPATIBLE",
+ "CUSTOM",
+ "MODERN",
+ "RESTRICTED"
+ ],
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.",
+ "default": "compute#sslPolicy"
+ },
+ "name": {
+ "description": "Name of the resource. 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.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "fingerprint": {
+ "type": "string",
+ "description": "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 SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.",
+ "format": "byte"
+ },
+ "customFeatures": {
+ "description": "A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.",
+ "items": {
+ "type": "string"
},
- "description": "Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request."
+ "type": "array"
},
- "testIamPermissions": {
- "response": {
- "$ref": "TestPermissionsResponse"
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "enabledFeatures": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "parameters": {
- "region": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path",
- "description": "The name of the region for this request."
- },
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "resource": {
- "description": "Name or id of the resource for this request.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- }
+ "description": "[Output Only] The list of features enabled in the SSL policy."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ }
+ },
+ "id": "SslPolicy",
+ "description": "Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts.",
+ "type": "object"
+ },
+ "UrlMapsValidateResponse": {
+ "type": "object",
+ "id": "UrlMapsValidateResponse",
+ "properties": {
+ "result": {
+ "$ref": "UrlMapValidationResult"
+ }
+ }
+ },
+ "SavedAttachedDisk": {
+ "description": "DEPRECATED: Please use compute#savedDisk instead. An instance-attached disk resource.",
+ "type": "object",
+ "properties": {
+ "storageBytes": {
+ "format": "int64",
+ "type": "string",
+ "description": "[Output Only] A size of the storage used by the disk's snapshot by this machine image."
+ },
+ "diskSizeGb": {
+ "type": "string",
+ "format": "int64",
+ "description": "The size of the disk in base-2 GB."
+ },
+ "diskEncryptionKey": {
+ "description": "The encryption key for the disk.",
+ "$ref": "CustomerEncryptionKey"
+ },
+ "licenses": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "httpMethod": "POST",
- "flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions",
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "description": "[Output Only] Any valid publicly visible licenses."
+ },
+ "mode": {
+ "enum": [
+ "READ_ONLY",
+ "READ_WRITE"
],
- "description": "Returns permissions that a caller has on the specified resource.",
- "path": "projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions",
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enumDescriptions": [
+ "Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.",
+ "*[Default]* Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode."
],
- "id": "compute.networkAttachments.testIamPermissions"
+ "description": "The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY.",
+ "type": "string"
},
- "get": {
- "description": "Returns the specified NetworkAttachment resource in the given scope.",
- "parameterOrder": [
- "project",
- "region",
- "networkAttachment"
+ "storageBytesStatus": {
+ "enum": [
+ "UPDATING",
+ "UP_TO_DATE"
],
- "path": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
- "flatPath": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
- "response": {
- "$ref": "NetworkAttachment"
- },
- "parameters": {
- "networkAttachment": {
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the NetworkAttachment resource to return.",
- "required": true
- },
- "region": {
- "required": true,
- "description": "Name of the region of this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "id": "compute.networkAttachments.get",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "string",
+ "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.",
+ "enumDescriptions": [
+ "",
+ ""
]
},
- "delete": {
- "httpMethod": "DELETE",
- "path": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
- "flatPath": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
- "id": "compute.networkAttachments.delete",
- "response": {
- "$ref": "Operation"
- },
- "description": "Deletes the specified NetworkAttachment in the given scope",
- "parameterOrder": [
- "project",
- "region",
- "networkAttachment"
+ "type": {
+ "description": "Specifies the type of the attached disk, either SCRATCH or PERSISTENT.",
+ "enumDescriptions": [
+ "",
+ ""
],
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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"
- },
- "networkAttachment": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "description": "Name of the NetworkAttachment resource to delete.",
- "type": "string"
- },
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "type": "string",
- "description": "Name of the region of this request."
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "firewallPolicies": {
- "methods": {
- "getAssociation": {
- "response": {
- "$ref": "FirewallPolicyAssociation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Gets an association with the specified name.",
- "parameterOrder": [
- "firewallPolicy"
+ "enum": [
+ "PERSISTENT",
+ "SCRATCH"
],
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getAssociation",
- "parameters": {
- "name": {
- "location": "query",
- "type": "string",
- "description": "The name of the association to get from the firewall policy."
- },
- "firewallPolicy": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the firewall policy to which the queried rule belongs.",
- "pattern": "(firewallPolicies/)?[0-9]{0,20}"
- }
- },
- "id": "compute.firewallPolicies.getAssociation",
- "path": "locations/global/firewallPolicies/{firewallPolicy}/getAssociation",
- "httpMethod": "GET"
+ "type": "string"
},
- "removeAssociation": {
- "path": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "firewallPolicy"
+ "deviceName": {
+ "type": "string",
+ "description": "Specifies the name of the disk attached to the source instance."
+ },
+ "source": {
+ "type": "string",
+ "description": "Specifies a URL of the disk attached to the source instance."
+ },
+ "interface": {
+ "enumDescriptions": [
+ "",
+ ""
],
- "id": "compute.firewallPolicies.removeAssociation",
- "response": {
- "$ref": "Operation"
+ "type": "string",
+ "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.",
+ "enum": [
+ "NVME",
+ "SCSI"
+ ]
+ },
+ "autoDelete": {
+ "type": "boolean",
+ "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance)."
+ },
+ "boot": {
+ "type": "boolean",
+ "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem."
+ },
+ "diskType": {
+ "type": "string",
+ "description": "[Output Only] URL of the disk type resource. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd"
+ },
+ "guestOsFeatures": {
+ "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.",
+ "items": {
+ "$ref": "GuestOsFeature"
},
- "httpMethod": "POST",
- "parameters": {
- "firewallPolicy": {
- "required": true,
- "description": "Name of the firewall policy to update.",
- "type": "string",
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "location": "path"
+ "type": "array"
+ },
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
+ "type": "string",
+ "default": "compute#savedAttachedDisk"
+ },
+ "index": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies zero-based index of the disk that is attached to the source instance."
+ }
+ },
+ "id": "SavedAttachedDisk"
+ },
+ "FirewallPoliciesListAssociationsResponse": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "default": "compute#firewallPoliciesListAssociationsResponse",
+ "description": "[Output Only] Type of firewallPolicy associations. Always compute#FirewallPoliciesListAssociations for lists of firewallPolicy associations."
+ },
+ "associations": {
+ "description": "A list of associations.",
+ "type": "array",
+ "items": {
+ "$ref": "FirewallPolicyAssociation"
+ }
+ }
+ },
+ "type": "object",
+ "id": "FirewallPoliciesListAssociationsResponse"
+ },
+ "Image": {
+ "description": "Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.",
+ "id": "Image",
+ "properties": {
+ "rawDisk": {
+ "properties": {
+ "sha1Checksum": {
+ "description": "[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.",
+ "pattern": "[a-f0-9]{40}",
+ "type": "string"
},
- "name": {
- "location": "query",
+ "containerType": {
"type": "string",
- "description": "Name for the attachment that will be removed."
+ "enum": [
+ "TAR"
+ ],
+ "description": "The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.",
+ "enumDescriptions": [
+ ""
+ ]
},
- "requestId": {
- "location": "query",
- "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).",
+ "source": {
+ "description": "The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ",
"type": "string"
}
},
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation",
- "description": "Removes an association for the specified firewall policy."
+ "type": "object",
+ "description": "The parameters of the raw disk image."
},
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "id": "compute.firewallPolicies.setIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "locations/global/firewallPolicies/{resource}/setIamPolicy",
- "flatPath": "locations/global/firewallPolicies/{resource}/setIamPolicy",
- "request": {
- "$ref": "GlobalOrganizationSetPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "parameters": {
- "resource": {
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "type": "string",
- "required": true
- }
+ "storageLocations": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "httpMethod": "POST"
+ "description": "Cloud Storage bucket storage location of the image (regional or multi-regional)."
},
- "testIamPermissions": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "resource"
- ],
- "id": "compute.firewallPolicies.testIamPermissions",
- "flatPath": "locations/global/firewallPolicies/{resource}/testIamPermissions",
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.",
- "path": "locations/global/firewallPolicies/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name or id of the resource for this request."
- }
- }
+ "sourceDiskEncryptionKey": {
+ "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.",
+ "$ref": "CustomerEncryptionKey"
},
- "delete": {
- "parameterOrder": [
- "firewallPolicy"
- ],
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}",
- "path": "locations/global/firewallPolicies/{firewallPolicy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "firewallPolicy": {
- "description": "Name of the firewall policy to delete.",
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "location": "path",
- "type": "string",
- "required": true
- }
- },
- "httpMethod": "DELETE",
- "id": "compute.firewallPolicies.delete",
- "description": "Deletes the specified policy."
+ "sourceImageId": {
+ "description": "[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.",
+ "type": "string"
},
- "getRule": {
- "description": "Gets a rule of the specified priority.",
- "httpMethod": "GET",
- "parameterOrder": [
- "firewallPolicy"
+ "archiveSizeBytes": {
+ "description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).",
+ "type": "string",
+ "format": "int64"
+ },
+ "labelFingerprint": {
+ "format": "byte",
+ "type": "string",
+ "description": "A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image."
+ },
+ "deprecated": {
+ "description": "The deprecation status associated with this image.",
+ "$ref": "DeprecationStatus"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "sourceSnapshotEncryptionKey": {
+ "$ref": "CustomerEncryptionKey",
+ "description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key."
+ },
+ "sourceType": {
+ "enum": [
+ "RAW"
],
- "id": "compute.firewallPolicies.getRule",
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getRule",
- "response": {
- "$ref": "FirewallPolicyRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enumDescriptions": [
+ ""
],
- "path": "locations/global/firewallPolicies/{firewallPolicy}/getRule",
- "parameters": {
- "priority": {
- "location": "query",
- "type": "integer",
- "description": "The priority of the rule to get from the firewall policy.",
- "format": "int32"
- },
- "firewallPolicy": {
- "description": "Name of the firewall policy to which the queried rule belongs.",
- "type": "string",
- "required": true,
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "location": "path"
- }
- }
+ "default": "RAW",
+ "description": "The type of the image used to create this disk. The default and only valid value is RAW.",
+ "type": "string"
},
- "list": {
- "parameters": {
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "parentId": {
- "description": "Parent ID for this request.",
- "type": "string",
- "location": "query"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "minimum": "0",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "format": "uint32",
- "default": "500"
- }
- },
- "path": "locations/global/firewallPolicies",
- "description": "Lists all the policies that have been configured for the specified folder or organization.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "id": "compute.firewallPolicies.list",
- "flatPath": "locations/global/firewallPolicies",
- "response": {
- "$ref": "FirewallPolicyList"
- }
+ "kind": {
+ "type": "string",
+ "default": "compute#image",
+ "description": "[Output Only] Type of the resource. Always compute#image for images."
},
- "listAssociations": {
- "id": "compute.firewallPolicies.listAssociations",
- "flatPath": "locations/global/firewallPolicies/listAssociations",
- "description": "Lists associations of a specified target, i.e., organization or folder.",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "locations/global/firewallPolicies/listAssociations",
- "parameters": {
- "targetResource": {
- "location": "query",
- "type": "string",
- "description": "The target resource to list associations. It is an organization, or a folder."
- }
+ "licenses": {
+ "items": {
+ "type": "string"
},
- "response": {
- "$ref": "FirewallPoliciesListAssociationsResponse"
+ "description": "Any applicable license URI.",
+ "type": "array"
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "licenseCodes": {
+ "description": "Integer license codes indicating which licenses are attached to this image.",
+ "type": "array",
+ "items": {
+ "format": "int64",
+ "type": "string"
}
},
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.firewallPolicies.get",
- "parameterOrder": [
- "firewallPolicy"
- ],
- "parameters": {
- "firewallPolicy": {
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "required": true,
- "type": "string",
- "description": "Name of the firewall policy to get.",
- "location": "path"
- }
- },
- "httpMethod": "GET",
- "description": "Returns the specified firewall policy.",
- "path": "locations/global/firewallPolicies/{firewallPolicy}",
- "response": {
- "$ref": "FirewallPolicy"
- },
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}"
+ "sourceSnapshotId": {
+ "description": "[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.",
+ "type": "string"
},
- "addRule": {
- "request": {
- "$ref": "FirewallPolicyRule"
- },
- "response": {
- "$ref": "Operation"
- },
- "description": "Inserts a rule into a firewall policy.",
- "httpMethod": "POST",
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addRule",
- "parameterOrder": [
- "firewallPolicy"
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "architecture": {
+ "enumDescriptions": [
+ "Default value indicating Architecture is not set.",
+ "Machines with architecture ARM64",
+ "Machines with architecture X86_64"
],
- "parameters": {
- "firewallPolicy": {
- "required": true,
- "description": "Name of the firewall policy to update.",
- "type": "string",
- "location": "path",
- "pattern": "(firewallPolicies/)?[0-9]{0,20}"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
- },
- "id": "compute.firewallPolicies.addRule",
- "path": "locations/global/firewallPolicies/{firewallPolicy}/addRule",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "description": "The architecture of the image. Valid values are ARM64 or X86_64.",
+ "enum": [
+ "ARCHITECTURE_UNSPECIFIED",
+ "ARM64",
+ "X86_64"
]
},
- "cloneRules": {
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules",
- "response": {
- "$ref": "Operation"
+ "name": {
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.images.insert"
+ ]
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules",
- "description": "Copies rules to the specified firewall policy.",
- "parameterOrder": [
- "firewallPolicy"
- ],
- "id": "compute.firewallPolicies.cloneRules",
- "httpMethod": "POST",
- "parameters": {
- "sourceFirewallPolicy": {
- "type": "string",
- "description": "The firewall policy from which to copy rules.",
- "location": "query"
- },
- "firewallPolicy": {
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "location": "path",
- "description": "Name of the firewall policy to update.",
- "type": "string",
- "required": true
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- }
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "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."
},
- "addAssociation": {
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "replaceExistingAssociation": {
- "description": "Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.",
- "location": "query",
- "type": "boolean"
- },
- "firewallPolicy": {
- "required": true,
- "location": "path",
- "description": "Name of the firewall policy to update.",
- "type": "string",
- "pattern": "(firewallPolicies/)?[0-9]{0,20}"
- },
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "path": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation",
- "parameterOrder": [
- "firewallPolicy"
- ],
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.firewallPolicies.addAssociation",
- "description": "Inserts an association for the specified firewall policy.",
- "request": {
- "$ref": "FirewallPolicyAssociation"
- }
+ "diskSizeGb": {
+ "type": "string",
+ "format": "int64",
+ "description": "Size of the image when restored onto a persistent disk (in GB)."
},
- "move": {
- "id": "compute.firewallPolicies.move",
- "parameterOrder": [
- "firewallPolicy"
- ],
- "parameters": {
- "requestId": {
- "type": "string",
- "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"
- },
- "parentId": {
- "location": "query",
- "description": "The new parent of the firewall policy.",
- "type": "string"
- },
- "firewallPolicy": {
- "location": "path",
- "description": "Name of the firewall policy to update.",
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "required": true,
- "type": "string"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/move",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "locations/global/firewallPolicies/{firewallPolicy}/move",
- "description": "Moves the specified firewall policy.",
- "httpMethod": "POST"
+ "sourceImageEncryptionKey": {
+ "$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."
},
- "patch": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "locations/global/firewallPolicies/{firewallPolicy}",
- "httpMethod": "PATCH",
- "description": "Patches the specified policy with the data included in the request.",
- "parameters": {
- "firewallPolicy": {
- "description": "Name of the firewall policy to update.",
- "location": "path",
- "type": "string",
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "required": true
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
+ "family": {
+ "type": "string",
+ "description": "The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035."
+ },
+ "sourceDiskId": {
+ "type": "string",
+ "description": "[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name."
+ },
+ "guestOsFeatures": {
+ "items": {
+ "$ref": "GuestOsFeature"
},
- "parameterOrder": [
- "firewallPolicy"
+ "type": "array",
+ "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter."
+ },
+ "imageEncryptionKey": {
+ "description": "Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.",
+ "$ref": "CustomerEncryptionKey"
+ },
+ "sourceDisk": {
+ "type": "string",
+ "description": "URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL "
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "shieldedInstanceInitialState": {
+ "$ref": "InitialStateConfig",
+ "description": "Set the secure boot keys of shielded instance."
+ },
+ "sourceSnapshot": {
+ "description": "URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ",
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.",
+ "enum": [
+ "DELETING",
+ "FAILED",
+ "PENDING",
+ "READY"
],
- "id": "compute.firewallPolicies.patch",
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}",
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "FirewallPolicy"
+ "enumDescriptions": [
+ "Image is deleting.",
+ "Image creation failed due to an error.",
+ "Image hasn't been created as yet.",
+ "Image has been successfully created."
+ ]
+ },
+ "sourceImage": {
+ "description": "URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ",
+ "type": "string"
+ },
+ "satisfiesPzs": {
+ "description": "[Output Only] Reserved for future use.",
+ "type": "boolean"
+ },
+ "labels": {
+ "type": "object",
+ "description": "Labels to apply to this image. These can be later modified by the setLabels method.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "HttpHealthCheckList": {
+ "description": "Contains a list of HttpHealthCheck resources.",
+ "properties": {
+ "items": {
+ "description": "A list of HttpHealthCheck resources.",
+ "type": "array",
+ "items": {
+ "$ref": "HttpHealthCheck"
}
},
- "removeRule": {
- "httpMethod": "POST",
- "parameterOrder": [
- "firewallPolicy"
- ],
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeRule",
- "parameters": {
- "firewallPolicy": {
- "description": "Name of the firewall policy to update.",
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "type": "string",
- "location": "path",
- "required": true
- },
- "priority": {
- "type": "integer",
- "format": "int32",
- "location": "query",
- "description": "The priority of the rule to remove from the firewall policy."
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
- },
- "id": "compute.firewallPolicies.removeRule",
- "description": "Deletes a rule of the specified priority.",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "locations/global/firewallPolicies/{firewallPolicy}/removeRule"
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
},
- "patchRule": {
- "parameters": {
- "priority": {
- "location": "query",
- "description": "The priority of the rule to patch.",
- "type": "integer",
- "format": "int32"
+ "kind": {
+ "description": "Type of resource.",
+ "default": "compute#httpHealthCheckList",
+ "type": "string"
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "type": "array"
},
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "firewallPolicy": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "required": true,
- "description": "Name of the firewall policy to update.",
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "location": "path"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "httpMethod": "POST",
- "parameterOrder": [
- "firewallPolicy"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "FirewallPolicyRule"
- },
- "description": "Patches a rule of the specified priority.",
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.firewallPolicies.patchRule",
- "path": "locations/global/firewallPolicies/{firewallPolicy}/patchRule",
- "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchRule"
+ "description": "[Output Only] Informational warning message."
},
- "getIamPolicy": {
- "path": "locations/global/firewallPolicies/{resource}/getIamPolicy",
- "parameters": {
- "resource": {
- "pattern": "(firewallPolicies/)?[0-9]{0,20}",
- "description": "Name or id of the resource for this request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "optionsRequestedPolicyVersion": {
- "description": "Requested IAM Policy version.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "Policy"
- },
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "flatPath": "locations/global/firewallPolicies/{resource}/getIamPolicy",
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "id": "compute.firewallPolicies.getIamPolicy"
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
},
- "insert": {
- "id": "compute.firewallPolicies.insert",
- "parameters": {
- "parentId": {
- "type": "string",
- "location": "query",
- "description": "Parent ID for this request. The ID can be either be \"folders/[FOLDER_ID]\" if the parent is a folder or \"organizations/[ORGANIZATION_ID]\" if the parent is an organization."
- },
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "id": "HttpHealthCheckList",
+ "type": "object"
+ },
+ "GRPCHealthCheck": {
+ "type": "object",
+ "id": "GRPCHealthCheck",
+ "properties": {
+ "portName": {
+ "type": "string",
+ "description": "Not supported."
+ },
+ "portSpecification": {
+ "type": "string",
+ "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.",
+ "enumDescriptions": [
+ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
+ "Not supported.",
+ "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
],
- "request": {
- "$ref": "FirewallPolicy"
- },
- "path": "locations/global/firewallPolicies",
- "description": "Creates a new policy in the specified project using the data included in the request.",
- "flatPath": "locations/global/firewallPolicies",
- "response": {
- "$ref": "Operation"
- }
+ "enum": [
+ "USE_FIXED_PORT",
+ "USE_NAMED_PORT",
+ "USE_SERVING_PORT"
+ ]
+ },
+ "grpcServiceName": {
+ "type": "string",
+ "description": "The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII."
+ },
+ "port": {
+ "type": "integer",
+ "description": "The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.",
+ "format": "int32"
}
}
},
- "licenses": {
- "methods": {
- "testIamPermissions": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "HTTPHealthCheck": {
+ "type": "object",
+ "properties": {
+ "port": {
+ "type": "integer",
+ "description": "The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.",
+ "format": "int32"
+ },
+ "portName": {
+ "type": "string",
+ "description": "Not supported."
+ },
+ "requestPath": {
+ "description": "The request path of the HTTP health check request. The default value is /.",
+ "type": "string"
+ },
+ "response": {
+ "type": "string",
+ "description": "Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http"
+ },
+ "proxyHeader": {
+ "enum": [
+ "NONE",
+ "PROXY_V1"
],
- "parameters": {
- "project": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "resource": {
- "type": "string",
- "required": true,
- "description": "Name or id of the resource for this request.",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
+ "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
+ ]
+ },
+ "host": {
+ "description": "The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest",
+ "type": "string"
+ },
+ "portSpecification": {
+ "enum": [
+ "USE_FIXED_PORT",
+ "USE_NAMED_PORT",
+ "USE_SERVING_PORT"
],
- "id": "compute.licenses.testIamPermissions",
- "flatPath": "projects/{project}/global/licenses/{resource}/testIamPermissions",
- "path": "projects/{project}/global/licenses/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "description": "Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. "
+ "type": "string",
+ "enumDescriptions": [
+ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
+ "Not supported.",
+ "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
+ ],
+ "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Also supported in legacy HTTP health checks for target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports."
+ }
+ },
+ "id": "HTTPHealthCheck"
+ },
+ "LocationPolicyLocationConstraints": {
+ "description": "Per-zone constraints on location policy for this zone.",
+ "id": "LocationPolicyLocationConstraints",
+ "properties": {
+ "maxCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Maximum number of items that are allowed to be placed in this zone. The value must be non-negative."
+ }
+ },
+ "type": "object"
+ },
+ "BackendServiceCdnPolicyBypassCacheOnRequestHeader": {
+ "properties": {
+ "headerName": {
+ "type": "string",
+ "description": "The header field name to match on when bypassing cache. Values are case-insensitive."
+ }
+ },
+ "description": "Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.",
+ "type": "object",
+ "id": "BackendServiceCdnPolicyBypassCacheOnRequestHeader"
+ },
+ "LicenseResourceRequirements": {
+ "type": "object",
+ "properties": {
+ "minMemoryMb": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Minimum memory required to use the Instance. Enforced at Instance creation and Instance start."
},
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "request": {
- "$ref": "GlobalSetPolicyRequest"
- },
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
- },
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name or id of the resource for this request.",
- "type": "string",
- "location": "path",
- "required": true
- }
- },
- "parameterOrder": [
- "project",
- "resource"
+ "minGuestCpuCount": {
+ "description": "Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "LicenseResourceRequirements"
+ },
+ "ServiceAttachmentConnectedEndpoint": {
+ "id": "ServiceAttachmentConnectedEndpoint",
+ "description": "[Output Only] A connection connected to this service attachment.",
+ "type": "object",
+ "properties": {
+ "pscConnectionId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "The PSC connection id of the connected endpoint."
+ },
+ "status": {
+ "type": "string",
+ "enumDescriptions": [
+ "The connection has been accepted by the producer.",
+ "The connection has been closed by the producer.",
+ "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.",
+ "The connection is pending acceptance by the producer.",
+ "The consumer is still connected but not using the connection.",
+ ""
],
- "id": "compute.licenses.setIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enum": [
+ "ACCEPTED",
+ "CLOSED",
+ "NEEDS_ATTENTION",
+ "PENDING",
+ "REJECTED",
+ "STATUS_UNSPECIFIED"
],
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
- "httpMethod": "POST",
- "path": "projects/{project}/global/licenses/{resource}/setIamPolicy",
- "flatPath": "projects/{project}/global/licenses/{resource}/setIamPolicy"
+ "description": "The status of a connected endpoint to this service attachment."
},
- "delete": {
- "description": "Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/licenses/{license}",
- "id": "compute.licenses.delete",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "endpoint": {
+ "description": "The url of a connected endpoint.",
+ "type": "string"
+ }
+ }
+ },
+ "PerInstanceConfig": {
+ "id": "PerInstanceConfig",
+ "type": "object",
+ "properties": {
+ "status": {
+ "enumDescriptions": [
+ "The per-instance configuration is being applied to the instance, but is not yet effective, possibly waiting for the instance to, for example, REFRESH.",
+ "The per-instance configuration deletion is being applied on the instance, possibly waiting for the instance to, for example, REFRESH.",
+ "The per-instance configuration is effective on the instance, meaning that all disks, ips and metadata specified in this configuration are attached or set on the instance.",
+ "*[Default]* The default status, when no per-instance configuration exists.",
+ "The per-instance configuration is set on an instance but not been applied yet.",
+ "The per-instance configuration has been deleted, but the deletion is not yet applied."
],
- "parameters": {
- "license": {
- "location": "path",
- "required": true,
- "description": "Name of the license resource to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "required": true
- }
- },
- "flatPath": "projects/{project}/global/licenses/{license}",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "project",
- "license"
- ]
+ "enum": [
+ "APPLYING",
+ "DELETING",
+ "EFFECTIVE",
+ "NONE",
+ "UNAPPLIED",
+ "UNAPPLIED_DELETION"
+ ],
+ "type": "string",
+ "description": "The status of applying this per-instance configuration on the corresponding managed instance."
},
- "list": {
- "id": "compute.licenses.list",
- "flatPath": "projects/{project}/global/licenses",
- "response": {
- "$ref": "LicensesListResponse"
- },
- "path": "projects/{project}/global/licenses",
- "parameters": {
- "orderBy": {
+ "name": {
+ "description": "The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configconfiguration for a VM instance that either doesn't exist or is not part of the group will result in an error.",
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset.",
+ "type": "string",
+ "format": "byte"
+ },
+ "preservedState": {
+ "description": "The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.",
+ "$ref": "PreservedState"
+ }
+ }
+ },
+ "InstanceTemplateList": {
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "kind": {
+ "description": "[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.",
+ "type": "string",
+ "default": "compute#instanceTemplateList"
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
+ "message": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "maxResults": {
- "default": "500",
- "minimum": "0",
- "type": "integer",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "httpMethod": "GET",
- "description": "Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project"
- ]
+ "description": "[Output Only] Informational warning message."
},
- "insert": {
- "request": {
- "$ref": "License"
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "InstanceTemplate"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/devstorage.full_control",
- "https://www.googleapis.com/auth/devstorage.read_only",
- "https://www.googleapis.com/auth/devstorage.read_write"
- ],
- "description": "Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
- "parameterOrder": [
- "project"
- ],
- "parameters": {
- "project": {
+ "description": "A list of InstanceTemplate resources."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ }
+ },
+ "type": "object",
+ "description": "A list of instance templates.",
+ "id": "InstanceTemplateList"
+ },
+ "SslCertificateList": {
+ "properties": {
+ "warning": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "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).",
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "message": {
"type": "string",
- "location": "query"
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "httpMethod": "POST",
- "path": "projects/{project}/global/licenses",
- "flatPath": "projects/{project}/global/licenses",
- "id": "compute.licenses.insert",
- "response": {
- "$ref": "Operation"
- }
+ "description": "[Output Only] Informational warning message."
},
- "getIamPolicy": {
- "path": "projects/{project}/global/licenses/{resource}/getIamPolicy",
- "id": "compute.licenses.getIamPolicy",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "resource"
- ],
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
- "response": {
- "$ref": "Policy"
- },
- "flatPath": "projects/{project}/global/licenses/{resource}/getIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "optionsRequestedPolicyVersion": {
- "description": "Requested IAM Policy version.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "project": {
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "resource": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name or id of the resource for this request.",
- "type": "string"
- }
- }
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
},
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "License"
+ "kind": {
+ "type": "string",
+ "default": "compute#sslCertificateList",
+ "description": "Type of resource."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of SslCertificate resources.",
+ "items": {
+ "$ref": "SslCertificate"
},
- "flatPath": "projects/{project}/global/licenses/{license}",
- "path": "projects/{project}/global/licenses/{license}",
- "parameterOrder": [
- "project",
- "license"
- ],
- "parameters": {
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "array"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "description": "Contains a list of SslCertificate resources.",
+ "type": "object",
+ "id": "SslCertificateList"
+ },
+ "ShieldedInstanceConfig": {
+ "description": "A set of Shielded Instance options.",
+ "properties": {
+ "enableIntegrityMonitoring": {
+ "description": "Defines whether the instance has integrity monitoring enabled. Enabled by default.",
+ "type": "boolean"
+ },
+ "enableVtpm": {
+ "description": "Defines whether the instance has the vTPM enabled. Enabled by default.",
+ "type": "boolean"
+ },
+ "enableSecureBoot": {
+ "type": "boolean",
+ "description": "Defines whether the instance has Secure Boot enabled. Disabled by default."
+ }
+ },
+ "type": "object",
+ "id": "ShieldedInstanceConfig"
+ },
+ "NodeTypeList": {
+ "description": "Contains a list of node types.",
+ "id": "NodeTypeList",
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource.Always compute#nodeTypeList for lists of node types.",
+ "default": "compute#nodeTypeList",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string"
},
- "license": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string",
- "description": "Name of the License resource to return.",
- "required": true
+ "data": {
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ },
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
},
- "description": "Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
- "httpMethod": "GET",
- "id": "compute.licenses.get"
+ "type": "object"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "description": "A list of NodeType resources.",
+ "type": "array",
+ "items": {
+ "$ref": "NodeType"
+ }
}
}
},
- "regionSslPolicies": {
- "methods": {
- "list": {
- "path": "projects/{project}/regions/{region}/sslPolicies",
- "httpMethod": "GET",
- "response": {
- "$ref": "SslPoliciesList"
+ "ResourcePolicySnapshotSchedulePolicySnapshotProperties": {
+ "description": "Specified snapshot properties for scheduled snapshots created by this policy.",
+ "properties": {
+ "chainName": {
+ "type": "string",
+ "description": "Chain name that the snapshot is created in."
+ },
+ "storageLocations": {
+ "type": "array",
+ "description": "Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).",
+ "items": {
+ "type": "string"
+ }
+ },
+ "guestFlush": {
+ "description": "Indication to perform a 'guest aware' snapshot.",
+ "type": "boolean"
+ },
+ "labels": {
+ "description": "Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty.",
+ "additionalProperties": {
+ "type": "string"
},
- "id": "compute.regionSslPolicies.list",
- "parameterOrder": [
- "project",
- "region"
- ],
- "description": "Lists all the SSL policies that have been configured for the specified project and region.",
- "flatPath": "projects/{project}/regions/{region}/sslPolicies",
- "parameters": {
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "format": "uint32",
- "location": "query",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
+ "type": "object"
+ }
+ },
+ "id": "ResourcePolicySnapshotSchedulePolicySnapshotProperties",
+ "type": "object"
+ },
+ "VpnGatewayVpnGatewayInterface": {
+ "description": "A VPN gateway interface.",
+ "type": "object",
+ "id": "VpnGatewayVpnGatewayInterface",
+ "properties": {
+ "interconnectAttachment": {
+ "description": "URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for HA VPN over Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource.",
+ "type": "string"
+ },
+ "ipAddress": {
+ "type": "string",
+ "description": "[Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For HA VPN over Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address."
+ },
+ "id": {
+ "description": "[Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ }
+ },
+ "PublicDelegatedPrefixAggregatedList": {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefixAggregatedList for aggregated lists of public delegated prefixes.",
+ "default": "compute#publicDelegatedPrefixAggregatedList",
+ "type": "string"
+ },
+ "unreachables": {
+ "type": "array",
+ "description": "[Output Only] Unreachable resources.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "items": {
+ "type": "object",
+ "description": "A list of PublicDelegatedPrefixesScopedList resources.",
+ "additionalProperties": {
+ "$ref": "PublicDelegatedPrefixesScopedList",
+ "description": "[Output Only] Name of the scope containing this set of PublicDelegatedPrefixes."
+ }
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "warning": {
+ "properties": {
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "pageToken": {
- "location": "query",
+ "message": {
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true,
- "description": "Name of the region scoping this request.",
- "location": "path"
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
},
- "get": {
- "parameterOrder": [
- "project",
- "region",
- "sslPolicy"
- ],
- "httpMethod": "GET",
- "id": "compute.regionSslPolicies.get",
- "parameters": {
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ }
+ },
+ "id": "PublicDelegatedPrefixAggregatedList"
+ },
+ "SubnetworksScopedList": {
+ "type": "object",
+ "properties": {
+ "warning": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "project": {
+ "message": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "sslPolicy": {
- "required": true,
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "location": "path",
- "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
},
- "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
- "description": "Lists all of the ordered rules present in a single specified policy.",
- "response": {
- "$ref": "SslPolicy"
- },
- "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "description": "An informational warning that appears when the list of addresses is empty."
},
- "listAvailableFeatures": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Lists all features that can be specified in the SSL policy when using custom profile.",
- "id": "compute.regionSslPolicies.listAvailableFeatures",
- "flatPath": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures",
- "response": {
- "$ref": "SslPoliciesListAvailableFeaturesResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "region"
- ],
- "path": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures",
- "parameters": {
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "default": "500",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "format": "uint32",
- "minimum": "0"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- }
- }
- },
- "delete": {
- "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
- "parameterOrder": [
- "project",
- "region",
- "sslPolicy"
- ],
- "id": "compute.regionSslPolicies.delete",
- "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
- "description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.",
- "response": {
- "$ref": "Operation"
+ "subnetworks": {
+ "type": "array",
+ "items": {
+ "$ref": "Subnetwork"
},
- "parameters": {
- "region": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
- },
- "sslPolicy": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035."
- },
- "requestId": {
- "type": "string",
- "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"
- }
+ "description": "A list of subnetworks contained in this scope."
+ }
+ },
+ "id": "SubnetworksScopedList"
+ },
+ "DisksRemoveResourcePoliciesRequest": {
+ "properties": {
+ "resourcePolicies": {
+ "description": "Resource policies to be removed from this disk.",
+ "items": {
+ "type": "string"
},
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "array"
+ }
+ },
+ "id": "DisksRemoveResourcePoliciesRequest",
+ "type": "object"
+ },
+ "RouterBgp": {
+ "type": "object",
+ "properties": {
+ "advertiseMode": {
+ "enum": [
+ "CUSTOM",
+ "DEFAULT"
+ ],
+ "description": "User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
]
},
- "patch": {
- "parameterOrder": [
- "project",
- "region",
- "sslPolicy"
- ],
- "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
- "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
- "httpMethod": "PATCH",
- "description": "Patches the specified SSL policy with the data included in the request.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "sslPolicy": {
- "location": "path",
- "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.",
- "type": "string",
- "required": true
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
- },
- "region": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "Name of the region scoping this request."
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
+ "keepaliveInterval": {
+ "description": "The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "advertisedIpRanges": {
+ "items": {
+ "$ref": "RouterAdvertisedIpRange"
},
- "response": {
- "$ref": "Operation"
+ "type": "array",
+ "description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges."
+ },
+ "asn": {
+ "format": "uint32",
+ "description": "Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.",
+ "type": "integer"
+ },
+ "advertisedGroups": {
+ "description": "User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "ALL_SUBNETS"
+ ],
+ "enumDescriptions": [
+ "Advertise all available subnets (including peer VPC subnets)."
+ ],
+ "type": "string"
+ }
+ }
+ },
+ "id": "RouterBgp"
+ },
+ "FirewallPolicyRuleMatcher": {
+ "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.",
+ "properties": {
+ "destIpRanges": {
+ "items": {
+ "type": "string"
},
- "id": "compute.regionSslPolicies.patch",
- "request": {
- "$ref": "SslPolicy"
+ "description": "CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.",
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "FirewallPolicyRuleSecureTag"
}
},
- "insert": {
- "request": {
- "$ref": "SslPolicy"
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "flatPath": "projects/{project}/regions/{region}/sslPolicies",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.regionSslPolicies.insert",
- "httpMethod": "POST",
- "description": "Creates a new policy in the specified project and region using the data included in the request.",
- "parameters": {
- "region": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "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).",
- "location": "query",
- "type": "string"
- }
+ "layer4Configs": {
+ "description": "Pairs of IP protocols and ports that the rule should match.",
+ "type": "array",
+ "items": {
+ "$ref": "FirewallPolicyRuleMatcherLayer4Config"
+ }
+ },
+ "srcIpRanges": {
+ "description": "CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "FirewallPolicyRuleMatcher",
+ "type": "object"
+ },
+ "ZoneSetLabelsRequest": {
+ "id": "ZoneSetLabelsRequest",
+ "properties": {
+ "labels": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
},
- "path": "projects/{project}/regions/{region}/sslPolicies"
+ "description": "The labels to set for this resource."
+ },
+ "labelFingerprint": {
+ "format": "byte",
+ "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ShieldedInstanceIntegrityPolicy": {
+ "id": "ShieldedInstanceIntegrityPolicy",
+ "type": "object",
+ "description": "The policy describes the baseline against which Instance boot integrity is measured.",
+ "properties": {
+ "updateAutoLearnPolicy": {
+ "description": "Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.",
+ "type": "boolean"
}
}
},
- "regionInstanceGroupManagers": {
- "methods": {
- "patch": {
- "parameters": {
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "instanceGroupManager": {
- "description": "The name of the instance group manager.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "requestId": {
- "type": "string",
- "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"
+ "MachineType": {
+ "properties": {
+ "scratchDisks": {
+ "description": "[Output Only] A list of extended scratch disks assigned to the instance.",
+ "type": "array",
+ "items": {
+ "properties": {
+ "diskGb": {
+ "type": "integer",
+ "description": "Size of the scratch disk, defined in GB.",
+ "format": "int32"
+ }
},
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- }
- },
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
- "request": {
- "$ref": "InstanceGroupManager"
- },
- "description": "Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.",
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.regionInstanceGroupManagers.patch",
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
- ],
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}"
+ "type": "object"
+ }
},
- "applyUpdatesToInstances": {
- "id": "compute.regionInstanceGroupManagers.applyUpdatesToInstances",
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "RegionInstanceGroupManagersApplyUpdatesRequest"
- },
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
- ],
- "parameters": {
- "instanceGroupManager": {
- "required": true,
- "location": "path",
- "description": "The name of the managed instance group, should conform to RFC1035.",
- "type": "string"
- },
- "region": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the region scoping this request, should conform to RFC1035."
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string"
- }
- },
- "description": "Apply updates to selected instances the managed instance group."
+ "id": {
+ "type": "string",
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
- "get": {
- "parameters": {
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
- "type": "string",
- "required": true
- },
- "instanceGroupManager": {
- "location": "path",
- "description": "Name of the managed instance group to return.",
- "type": "string",
- "required": true
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true
+ "isSharedCpu": {
+ "description": "[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.",
+ "type": "boolean"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "[Output Only] Name of the resource.",
+ "type": "string"
+ },
+ "maximumPersistentDisksSizeGb": {
+ "description": "[Output Only] Maximum total persistent disks size (GB) allowed.",
+ "format": "int64",
+ "type": "string"
+ },
+ "imageSpaceGb": {
+ "format": "int32",
+ "type": "integer",
+ "description": "[Deprecated] This property is deprecated and will never be populated with any relevant values."
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "kind": {
+ "description": "[Output Only] The type of the resource. Always compute#machineType for machine types.",
+ "default": "compute#machineType",
+ "type": "string"
+ },
+ "memoryMb": {
+ "type": "integer",
+ "format": "int32",
+ "description": "[Output Only] The amount of physical memory available to the instance, defined in MB."
+ },
+ "description": {
+ "description": "[Output Only] An optional textual description of the resource.",
+ "type": "string"
+ },
+ "accelerators": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "guestAcceleratorCount": {
+ "format": "int32",
+ "type": "integer",
+ "description": "Number of accelerator cards exposed to the guest."
+ },
+ "guestAcceleratorType": {
+ "type": "string",
+ "description": "The accelerator type resource name, not a full URL, e.g. 'nvidia-tesla-k80'."
+ }
}
},
- "description": "Returns all of the details about the specified managed instance group.",
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
- "httpMethod": "GET",
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "InstanceGroupManager"
- },
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
- ],
- "id": "compute.regionInstanceGroupManagers.get"
+ "description": "[Output Only] A list of accelerator configurations assigned to this machine type.",
+ "type": "array"
},
- "insert": {
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/instanceGroupManagers",
- "parameterOrder": [
- "project",
- "region"
- ],
- "id": "compute.regionInstanceGroupManagers.insert",
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers",
- "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances.",
- "parameters": {
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "region": {
- "required": true,
- "description": "Name of the region scoping this request.",
- "type": "string",
- "location": "path"
- },
- "requestId": {
- "type": "string",
- "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"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "InstanceGroupManager"
+ "zone": {
+ "description": "[Output Only] The name of the zone where the machine type resides, such as us-central1-a.",
+ "type": "string"
+ },
+ "guestCpus": {
+ "format": "int32",
+ "type": "integer",
+ "description": "[Output Only] The number of virtual CPUs that are available to the instance."
+ },
+ "deprecated": {
+ "description": "[Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable.",
+ "$ref": "DeprecationStatus"
+ },
+ "maximumPersistentDisks": {
+ "description": "[Output Only] Maximum persistent disks allowed.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object",
+ "description": "Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types.",
+ "id": "MachineType"
+ },
+ "NetworkEndpointGroupAppEngine": {
+ "properties": {
+ "service": {
+ "description": "Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: \"default\", \"my-service\".",
+ "type": "string"
+ },
+ "version": {
+ "description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: \"v1\", \"v2\".",
+ "type": "string"
+ },
+ "urlMask": {
+ "description": "A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs \"foo1-dot-appname.appspot.com/v1\" and \"foo1-dot-appname.appspot.com/v2\" can be backed by the same Serverless NEG with URL mask \"\u003cservice\u003e-dot-appname.appspot.com/\u003cversion\u003e\". The URL mask will parse them to { service = \"foo1\", version = \"v1\" } and { service = \"foo1\", version = \"v2\" } respectively.",
+ "type": "string"
+ }
+ },
+ "id": "NetworkEndpointGroupAppEngine",
+ "description": "Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.",
+ "type": "object"
+ },
+ "GlobalNetworkEndpointGroupsDetachEndpointsRequest": {
+ "type": "object",
+ "properties": {
+ "networkEndpoints": {
+ "type": "array",
+ "items": {
+ "$ref": "NetworkEndpoint"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "description": "The list of network endpoints to be detached."
+ }
+ },
+ "id": "GlobalNetworkEndpointGroupsDetachEndpointsRequest"
+ },
+ "InstanceGroupManagersListManagedInstancesResponse": {
+ "properties": {
+ "managedInstances": {
+ "type": "array",
+ "description": "[Output Only] The list of instances in the managed instance group.",
+ "items": {
+ "$ref": "ManagedInstance"
+ }
},
- "updatePerInstanceConfigs": {
- "parameters": {
- "region": {
- "description": "Name of the region scoping this request, should conform to RFC1035.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "instanceGroupManager": {
- "required": true,
- "description": "The name of the managed instance group. It should conform to RFC1035.",
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ }
+ },
+ "id": "InstanceGroupManagersListManagedInstancesResponse",
+ "type": "object"
+ },
+ "CustomerEncryptionKey": {
+ "type": "object",
+ "id": "CustomerEncryptionKey",
+ "properties": {
+ "kmsKeyServiceAccount": {
+ "description": "The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: \"kmsKeyServiceAccount\": \"name@project_id.iam.gserviceaccount.com/ ",
+ "type": "string"
+ },
+ "sha256": {
+ "type": "string",
+ "description": "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource."
+ },
+ "rsaEncryptedKey": {
+ "description": "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 ",
+ "type": "string"
+ },
+ "rawKey": {
+ "type": "string",
+ "description": "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: \"rawKey\": \"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\" "
+ },
+ "kmsKeyName": {
+ "description": "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 ",
+ "type": "string"
+ }
+ }
+ },
+ "AcceleratorTypeList": {
+ "properties": {
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "message": {
"type": "string",
- "location": "path"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "requestId": {
- "type": "string",
- "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"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array"
},
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "required": true,
- "description": "Project ID for this request."
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
- },
- "description": "Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.",
- "httpMethod": "POST",
- "request": {
- "$ref": "RegionInstanceGroupManagerUpdateInstanceConfigReq"
- },
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
- "id": "compute.regionInstanceGroupManagers.updatePerInstanceConfigs",
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
- ],
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
}
},
- "createInstances": {
- "id": "compute.regionInstanceGroupManagers.createInstances",
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
+ "items": {
+ "type": "array",
+ "description": "A list of AcceleratorType resources.",
+ "items": {
+ "$ref": "AcceleratorType"
+ }
+ },
+ "kind": {
+ "default": "compute#acceleratorTypeList",
+ "description": "[Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ },
+ "description": "Contains a list of accelerator types.",
+ "type": "object",
+ "id": "AcceleratorTypeList"
+ },
+ "SecurityPolicyReference": {
+ "id": "SecurityPolicyReference",
+ "type": "object",
+ "properties": {
+ "securityPolicy": {
+ "type": "string"
+ }
+ }
+ },
+ "InstancesRemoveResourcePoliciesRequest": {
+ "id": "InstancesRemoveResourcePoliciesRequest",
+ "properties": {
+ "resourcePolicies": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Resource policies to be removed from this instance."
+ }
+ },
+ "type": "object"
+ },
+ "FirewallLogConfig": {
+ "id": "FirewallLogConfig",
+ "description": "The available logging options for a firewall rule.",
+ "type": "object",
+ "properties": {
+ "enable": {
+ "description": "This field denotes whether to enable logging for a particular firewall rule.",
+ "type": "boolean"
+ },
+ "metadata": {
+ "description": "This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.",
+ "enumDescriptions": [
+ "",
+ ""
],
- "request": {
- "$ref": "RegionInstanceGroupManagersCreateInstancesRequest"
+ "type": "string",
+ "enum": [
+ "EXCLUDE_ALL_METADATA",
+ "INCLUDE_ALL_METADATA"
+ ]
+ }
+ }
+ },
+ "TargetSslProxy": {
+ "properties": {
+ "sslCertificates": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED."
+ },
+ "kind": {
+ "default": "compute#targetSslProxy",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies."
+ },
+ "service": {
+ "description": "URL to the BackendService resource.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "proxyHeader": {
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
],
- "description": "Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.",
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "instanceGroupManager": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "The name of the managed instance group. It should conform to RFC1035."
+ "enum": [
+ "NONE",
+ "PROXY_V1"
+ ],
+ "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "sslPolicy": {
+ "type": "string",
+ "description": "URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured."
+ },
+ "certificateMap": {
+ "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.",
+ "type": "string"
+ },
+ "name": {
+ "description": "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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ }
+ },
+ "description": "Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies.",
+ "type": "object",
+ "id": "TargetSslProxy"
+ },
+ "NetworkEndpointGroupList": {
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#networkEndpointGroupList",
+ "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists."
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "region": {
- "description": "The name of the region where the managed instance group is located. It should conform to RFC1035.",
- "required": true,
- "location": "path",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "requestId": {
- "location": "query",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
+ }
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "items": {
+ "items": {
+ "$ref": "NetworkEndpointGroup"
},
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST",
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances"
+ "description": "A list of NetworkEndpointGroup resources.",
+ "type": "array"
},
- "listPerInstanceConfigs": {
- "parameters": {
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request, should conform to RFC1035.",
- "location": "path",
- "required": true
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "maxResults": {
- "format": "uint32",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "default": "500",
- "minimum": "0"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "instanceGroupManager": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the managed instance group. It should conform to RFC1035."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "httpMethod": "POST",
- "id": "compute.regionInstanceGroupManagers.listPerInstanceConfigs",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "RegionInstanceGroupManagersListInstanceConfigsResp"
- },
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
- ],
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
- "description": "Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported."
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "NetworkEndpointGroupList"
+ },
+ "LogConfig": {
+ "type": "object",
+ "properties": {
+ "cloudAudit": {
+ "description": "This is deprecated and has no effect. Do not use.",
+ "$ref": "LogConfigCloudAuditOptions"
},
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Retrieves the list of managed instance groups that are contained within the specified region.",
- "id": "compute.regionInstanceGroupManagers.list",
- "path": "projects/{project}/regions/{region}/instanceGroupManagers",
- "parameterOrder": [
- "project",
- "region"
- ],
- "httpMethod": "GET",
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers",
- "response": {
- "$ref": "RegionInstanceGroupManagerList"
- },
- "parameters": {
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "default": "500"
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "region": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the region scoping this request."
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
+ "dataAccess": {
+ "$ref": "LogConfigDataAccessOptions",
+ "description": "This is deprecated and has no effect. Do not use."
+ },
+ "counter": {
+ "$ref": "LogConfigCounterOptions",
+ "description": "This is deprecated and has no effect. Do not use."
+ }
+ },
+ "description": "This is deprecated and has no effect. Do not use.",
+ "id": "LogConfig"
+ },
+ "ReservationList": {
+ "type": "object",
+ "properties": {
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "pageToken": {
+ "code": {
"type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
}
}
},
- "setInstanceTemplate": {
- "description": "Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.",
- "request": {
- "$ref": "RegionInstanceGroupManagersSetTemplateRequest"
- },
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
- ],
- "id": "compute.regionInstanceGroupManagers.setInstanceTemplate",
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "instanceGroupManager": {
- "required": true,
- "description": "The name of the managed instance group.",
- "type": "string",
- "location": "path"
- },
- "region": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Name of the region scoping this request."
- }
+ "kind": {
+ "default": "compute#reservationList",
+ "description": "[Output Only] Type of resource.Always compute#reservationsList for listsof reservations",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "description": "[Output Only] A list of Allocation resources.",
+ "type": "array",
+ "items": {
+ "$ref": "Reservation"
}
},
- "listManagedInstances": {
- "id": "compute.regionInstanceGroupManagers.listManagedInstances",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ }
+ },
+ "id": "ReservationList"
+ },
+ "TargetSslProxiesSetCertificateMapRequest": {
+ "properties": {
+ "certificateMap": {
+ "type": "string",
+ "description": "URL of the Certificate Map to associate with this TargetSslProxy."
+ }
+ },
+ "id": "TargetSslProxiesSetCertificateMapRequest",
+ "type": "object"
+ },
+ "HTTPSHealthCheck": {
+ "type": "object",
+ "properties": {
+ "proxyHeader": {
+ "enum": [
+ "NONE",
+ "PROXY_V1"
],
- "parameters": {
- "maxResults": {
- "default": "500",
- "format": "uint32",
- "location": "query",
- "type": "integer",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "region": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the region scoping this request."
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
- },
- "instanceGroupManager": {
- "required": true,
- "description": "The name of the managed instance group.",
- "type": "string",
- "location": "path"
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- }
- },
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
- "response": {
- "$ref": "RegionInstanceGroupManagersListInstancesResponse"
- },
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
- "description": "Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`."
+ "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
+ ]
},
- "deletePerInstanceConfigs": {
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs",
- "request": {
- "$ref": "RegionInstanceGroupManagerDeleteInstanceConfigReq"
- },
- "httpMethod": "POST",
- "parameters": {
- "region": {
- "required": true,
- "description": "Name of the region scoping this request, should conform to RFC1035.",
- "location": "path",
- "type": "string"
- },
- "instanceGroupManager": {
- "type": "string",
- "required": true,
- "description": "The name of the managed instance group. It should conform to RFC1035.",
- "location": "path"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "port": {
+ "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "response": {
+ "type": "string",
+ "description": "Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http"
+ },
+ "portName": {
+ "description": "Not supported.",
+ "type": "string"
+ },
+ "portSpecification": {
+ "enumDescriptions": [
+ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
+ "Not supported.",
+ "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
],
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.regionInstanceGroupManagers.deletePerInstanceConfigs",
- "description": "Deletes selected per-instance configurations for the managed instance group.",
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs",
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
- ]
+ "enum": [
+ "USE_FIXED_PORT",
+ "USE_NAMED_PORT",
+ "USE_SERVING_PORT"
+ ],
+ "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.",
+ "type": "string"
},
- "patchPerInstanceConfigs": {
- "response": {
- "$ref": "Operation"
+ "host": {
+ "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest",
+ "type": "string"
+ },
+ "requestPath": {
+ "description": "The request path of the HTTPS health check request. The default value is /.",
+ "type": "string"
+ }
+ },
+ "id": "HTTPSHealthCheck"
+ },
+ "NetworkEndpointGroupsDetachEndpointsRequest": {
+ "id": "NetworkEndpointGroupsDetachEndpointsRequest",
+ "type": "object",
+ "properties": {
+ "networkEndpoints": {
+ "type": "array",
+ "items": {
+ "$ref": "NetworkEndpoint"
},
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
+ "description": "The list of network endpoints to be detached."
+ }
+ }
+ },
+ "NodeGroupsAddNodesRequest": {
+ "id": "NodeGroupsAddNodesRequest",
+ "properties": {
+ "additionalNodeCount": {
+ "description": "Count of additional nodes to be added to the node group.",
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "type": "object"
+ },
+ "Snapshot": {
+ "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.",
+ "id": "Snapshot",
+ "type": "object",
+ "properties": {
+ "chainName": {
+ "description": "Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.",
+ "type": "string"
+ },
+ "snapshotEncryptionKey": {
+ "$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": {
+ "type": "string",
+ "enum": [
+ "ARCHIVE",
+ "STANDARD"
],
- "description": "Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.",
- "id": "compute.regionInstanceGroupManagers.patchPerInstanceConfigs",
- "httpMethod": "POST",
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "",
+ ""
],
- "request": {
- "$ref": "RegionInstanceGroupManagerPatchInstanceConfigReq"
+ "description": "Indicates the type of the snapshot."
+ },
+ "storageLocations": {
+ "items": {
+ "type": "string"
},
- "parameters": {
- "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).",
- "type": "string",
- "location": "query"
- },
- "instanceGroupManager": {
- "required": true,
- "description": "The name of the managed instance group. It should conform to RFC1035.",
- "type": "string",
- "location": "path"
- },
- "region": {
- "description": "Name of the region scoping this request, should conform to RFC1035.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
- }
+ "description": "Cloud Storage bucket storage location of the snapshot (regional or multi-regional).",
+ "type": "array"
+ },
+ "diskSizeGb": {
+ "type": "string",
+ "format": "int64",
+ "description": "[Output Only] Size of the source disk, specified in GB."
+ },
+ "licenseCodes": {
+ "type": "array",
+ "description": "[Output Only] Integer license codes indicating which licenses are attached to this snapshot.",
+ "items": {
+ "format": "int64",
+ "type": "string"
}
},
- "listErrors": {
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors",
- "response": {
- "$ref": "RegionInstanceGroupManagersListErrorsResponse"
+ "sourceSnapshotSchedulePolicyId": {
+ "description": "[Output Only] ID of the resource policy which created this scheduled snapshot.",
+ "type": "string"
+ },
+ "creationSizeBytes": {
+ "format": "int64",
+ "description": "[Output Only] Size in bytes of the snapshot at creation time.",
+ "type": "string"
+ },
+ "labelFingerprint": {
+ "type": "string",
+ "description": "A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot.",
+ "format": "byte"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "sourceSnapshotSchedulePolicy": {
+ "type": "string",
+ "description": "[Output Only] URL of the resource policy which created this scheduled snapshot."
+ },
+ "downloadBytes": {
+ "description": "[Output Only] Number of bytes downloaded to restore a snapshot to a disk.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sourceDiskEncryptionKey": {
+ "$ref": "CustomerEncryptionKey",
+ "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key."
+ },
+ "status": {
+ "enumDescriptions": [
+ "Snapshot creation is in progress.",
+ "Snapshot is currently being deleted.",
+ "Snapshot creation failed.",
+ "Snapshot has been created successfully.",
+ "Snapshot is being uploaded."
+ ],
+ "type": "string",
+ "description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.",
+ "enum": [
+ "CREATING",
+ "DELETING",
+ "FAILED",
+ "READY",
+ "UPLOADING"
+ ]
+ },
+ "locationHint": {
+ "description": "An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.",
+ "type": "string"
+ },
+ "storageBytes": {
+ "format": "int64",
+ "type": "string",
+ "description": "[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion."
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
},
- "parameters": {
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
- },
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.",
- "location": "path",
- "required": true
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "maxResults": {
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "default": "500",
- "location": "query",
- "format": "uint32"
- },
- "region": {
- "location": "path",
- "description": "Name of the region scoping this request. This should conform to RFC1035.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- }
+ "description": "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.",
+ "type": "object"
+ },
+ "sourceDisk": {
+ "description": "The source disk used to create this snapshot.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "satisfiesPzs": {
+ "description": "[Output Only] Reserved for future use.",
+ "type": "boolean"
+ },
+ "autoCreated": {
+ "description": "[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.",
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.snapshots.insert"
+ ]
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "kind": {
+ "default": "compute#snapshot",
+ "description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.",
+ "type": "string"
+ },
+ "sourceDiskId": {
+ "type": "string",
+ "description": "[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "architecture": {
+ "description": "[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.",
+ "enumDescriptions": [
+ "Default value indicating Architecture is not set.",
+ "Machines with architecture ARM64",
+ "Machines with architecture X86_64"
],
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
+ "type": "string",
+ "enum": [
+ "ARCHITECTURE_UNSPECIFIED",
+ "ARM64",
+ "X86_64"
+ ]
+ },
+ "licenses": {
+ "description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "storageBytesStatus": {
+ "enumDescriptions": [
+ "",
+ ""
],
- "description": "Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.",
- "id": "compute.regionInstanceGroupManagers.listErrors",
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors"
+ "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.",
+ "type": "string",
+ "enum": [
+ "UPDATING",
+ "UP_TO_DATE"
+ ]
},
- "deleteInstances": {
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "region": {
- "location": "path",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request."
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "instanceGroupManager": {
- "required": true,
- "type": "string",
- "description": "Name of the managed instance group.",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ }
+ }
+ },
+ "RouterStatusResponse": {
+ "id": "RouterStatusResponse",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "default": "compute#routerStatusResponse",
+ "description": "Type of resource."
+ },
+ "result": {
+ "$ref": "RouterStatus"
+ }
+ }
+ },
+ "PacketIntervals": {
+ "description": "Next free: 7",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "Only applies to Echo packets. This shows the intervals between sending and receiving the same packet.",
+ "Intervals between received packets.",
+ "Intervals between transmitted packets.",
+ ""
],
- "request": {
- "$ref": "RegionInstanceGroupManagersDeleteInstancesRequest"
- },
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
+ "enum": [
+ "LOOPBACK",
+ "RECEIVE",
+ "TRANSMIT",
+ "TYPE_UNSPECIFIED"
],
- "httpMethod": "POST",
- "description": "Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
- "id": "compute.regionInstanceGroupManagers.deleteInstances"
+ "description": "The type of packets for which inter-packet intervals were computed."
},
- "setTargetPools": {
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
+ "duration": {
+ "enum": [
+ "DURATION_UNSPECIFIED",
+ "HOUR",
+ "MAX",
+ "MINUTE"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "From how long ago in the past these intervals were observed.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ "From BfdSession object creation time.",
+ ""
+ ]
+ },
+ "numIntervals": {
+ "format": "int64",
+ "type": "string",
+ "description": "Number of inter-packet intervals from which these statistics were derived."
+ },
+ "avgMs": {
+ "format": "int64",
+ "type": "string",
+ "description": "Average observed inter-packet interval in milliseconds."
+ },
+ "maxMs": {
+ "format": "int64",
+ "type": "string",
+ "description": "Maximum observed inter-packet interval in milliseconds."
+ },
+ "minMs": {
+ "format": "int64",
+ "description": "Minimum observed inter-packet interval in milliseconds.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "PacketIntervals"
+ },
+ "InstanceGroupManagersUpdatePerInstanceConfigsReq": {
+ "description": "InstanceGroupManagers.updatePerInstanceConfigs",
+ "id": "InstanceGroupManagersUpdatePerInstanceConfigsReq",
+ "type": "object",
+ "properties": {
+ "perInstanceConfigs": {
+ "description": "The list of per-instance configurations to insert or patch on this managed instance group.",
+ "type": "array",
+ "items": {
+ "$ref": "PerInstanceConfig"
+ }
+ }
+ }
+ },
+ "BackendServiceConnectionTrackingPolicy": {
+ "description": "Connection Tracking configuration for this BackendService.",
+ "id": "BackendServiceConnectionTrackingPolicy",
+ "properties": {
+ "enableStrongAffinity": {
+ "description": "Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.",
+ "type": "boolean"
+ },
+ "trackingMode": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
],
- "id": "compute.regionInstanceGroupManagers.setTargetPools",
- "request": {
- "$ref": "RegionInstanceGroupManagersSetTargetPoolsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST",
- "description": "Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.",
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Name of the managed instance group."
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
+ "type": "string",
+ "enum": [
+ "INVALID_TRACKING_MODE",
+ "PER_CONNECTION",
+ "PER_SESSION"
+ ],
+ "description": "Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see [Tracking Mode for Network Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode) and [Tracking Mode for Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode)."
+ },
+ "connectionPersistenceOnUnhealthyBackends": {
+ "type": "string",
+ "enum": [
+ "ALWAYS_PERSIST",
+ "DEFAULT_FOR_PROTOCOL",
+ "NEVER_PERSIST"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "description": "Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see [Connection Persistence for Network Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence) and [Connection Persistence for Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence)."
+ },
+ "idleTimeoutSec": {
+ "format": "int32",
+ "type": "integer",
+ "description": "Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly."
+ }
+ },
+ "type": "object"
+ },
+ "ExternalVpnGatewayList": {
+ "type": "object",
+ "description": "Response to the list request, and contains a list of externalVpnGateways.",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
},
- "requestId": {
- "location": "query",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "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)."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "region": {
- "location": "path",
+ "message": {
"type": "string",
- "description": "Name of the region scoping this request.",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools"
+ "type": "object"
},
- "delete": {
- "parameters": {
- "instanceGroupManager": {
- "required": true,
- "description": "Name of the managed instance group to delete.",
- "type": "string",
- "location": "path"
- },
- "region": {
- "location": "path",
- "required": true,
- "description": "Name of the region scoping this request.",
- "type": "string"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "DELETE",
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
- "description": "Deletes the specified managed instance group and all of the instances in that group.",
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
- "response": {
- "$ref": "Operation"
+ "kind": {
+ "default": "compute#externalVpnGatewayList",
+ "description": "[Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways.",
+ "type": "string"
+ },
+ "etag": {
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "items": {
+ "items": {
+ "$ref": "ExternalVpnGateway"
},
- "id": "compute.regionInstanceGroupManagers.delete"
+ "type": "array",
+ "description": "A list of ExternalVpnGateway resources."
+ }
+ },
+ "id": "ExternalVpnGatewayList"
+ },
+ "PublicAdvertisedPrefixPublicDelegatedPrefix": {
+ "description": "Represents a CIDR range which can be used to assign addresses.",
+ "type": "object",
+ "id": "PublicAdvertisedPrefixPublicDelegatedPrefix",
+ "properties": {
+ "project": {
+ "type": "string",
+ "description": "The project number of the public delegated prefix"
},
- "recreateInstances": {
- "description": "Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
- "id": "compute.regionInstanceGroupManagers.recreateInstances",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "status": {
+ "description": "The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the public delegated prefix",
+ "type": "string"
+ },
+ "region": {
+ "description": "The region of the public delegated prefix if it is regional. If absent, the prefix is global.",
+ "type": "string"
+ },
+ "ipRange": {
+ "type": "string",
+ "description": "The IP address range of the public delegated prefix"
+ }
+ }
+ },
+ "TargetTcpProxiesSetProxyHeaderRequest": {
+ "type": "object",
+ "properties": {
+ "proxyHeader": {
+ "enum": [
+ "NONE",
+ "PROXY_V1"
],
- "request": {
- "$ref": "RegionInstanceGroupManagersRecreateRequest"
- },
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
+ "description": "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.",
+ "enumDescriptions": [
+ "",
+ ""
],
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "instanceGroupManager": {
- "description": "Name of the managed instance group.",
- "required": true,
- "type": "string",
- "location": "path"
- }
+ "type": "string"
+ }
+ },
+ "id": "TargetTcpProxiesSetProxyHeaderRequest"
+ },
+ "BackendServiceLogConfig": {
+ "description": "The available logging options for the load balancer traffic served by this backend service.",
+ "properties": {
+ "enable": {
+ "description": "Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.",
+ "type": "boolean"
+ },
+ "sampleRate": {
+ "description": "This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.",
+ "type": "number",
+ "format": "float"
+ }
+ },
+ "id": "BackendServiceLogConfig",
+ "type": "object"
+ },
+ "BackendServiceList": {
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "kind": {
+ "default": "compute#backendServiceList",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#backendServiceList for lists of backend services."
+ },
+ "items": {
+ "type": "array",
+ "description": "A list of BackendService resources.",
+ "items": {
+ "$ref": "BackendService"
}
},
- "abandonInstances": {
- "parameters": {
- "instanceGroupManager": {
- "location": "path",
- "type": "string",
- "description": "Name of the managed instance group.",
- "required": true
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "warning": {
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array"
},
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
+ "message": {
"type": "string",
- "required": true
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "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).",
- "location": "query",
- "type": "string"
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "type": "string",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
},
- "id": "compute.regionInstanceGroupManagers.abandonInstances",
- "response": {
- "$ref": "Operation"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ }
+ },
+ "id": "BackendServiceList",
+ "description": "Contains a list of BackendService resources."
+ },
+ "InstanceGroupManagersCreateInstancesRequest": {
+ "properties": {
+ "instances": {
+ "type": "array",
+ "items": {
+ "$ref": "PerInstanceConfig"
},
- "httpMethod": "POST",
- "request": {
- "$ref": "RegionInstanceGroupManagersAbandonInstancesRequest"
+ "description": "[Required] List of specifications of per-instance configs."
+ }
+ },
+ "description": "InstanceGroupManagers.createInstances",
+ "type": "object",
+ "id": "InstanceGroupManagersCreateInstancesRequest"
+ },
+ "DisplayDevice": {
+ "description": "A set of Display Device options",
+ "type": "object",
+ "properties": {
+ "enableDisplay": {
+ "type": "boolean",
+ "description": "Defines whether the instance has Display enabled."
+ }
+ },
+ "id": "DisplayDevice"
+ },
+ "InstanceGroupManagerList": {
+ "description": "[Output Only] A list of managed instance groups.",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "default": "compute#instanceGroupManagerList",
+ "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "InstanceGroupManager"
},
- "description": "Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances"
+ "description": "A list of InstanceGroupManager resources."
},
- "resize": {
- "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "region": {
- "location": "path",
- "description": "Name of the region scoping this request.",
- "required": true,
- "type": "string"
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
},
- "instanceGroupManager": {
- "description": "Name of the managed instance group.",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "location": "path",
- "required": true
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "project": {
- "required": true,
+ "message": {
"type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "size": {
- "type": "integer",
- "required": true,
- "location": "query",
- "description": "Number of instances that should exist in this instance group manager.",
- "format": "int32",
- "minimum": "0"
+ "description": "[Output Only] A human-readable description of the warning code."
}
- },
- "parameterOrder": [
- "project",
- "region",
- "instanceGroupManager",
- "size"
- ],
- "httpMethod": "POST",
- "id": "compute.regionInstanceGroupManagers.resize",
- "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize",
- "description": "Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. 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 removed or deleted.",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ }
}
- }
+ },
+ "id": "InstanceGroupManagerList",
+ "type": "object"
},
- "networkEndpointGroups": {
- "methods": {
- "list": {
- "parameters": {
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "default": "500",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "location": "query",
- "type": "integer"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "zone": {
- "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
- "location": "path",
- "type": "string",
- "required": true
- }
- },
- "description": "Retrieves the list of network endpoint groups that are located in the specified project and zone.",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "zone"
- ],
- "id": "compute.networkEndpointGroups.list",
- "response": {
- "$ref": "NetworkEndpointGroupList"
- },
- "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups",
- "path": "projects/{project}/zones/{zone}/networkEndpointGroups",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "Metadata": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "default": "compute#metadata",
+ "description": "[Output Only] Type of the resource. Always compute#metadata for metadata."
},
- "attachNetworkEndpoints": {
- "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
- "id": "compute.networkEndpointGroups.attachNetworkEndpoints",
- "httpMethod": "POST",
- "request": {
- "$ref": "NetworkEndpointGroupsAttachEndpointsRequest"
- },
- "description": "Attach a list of network endpoints to the specified network endpoint group.",
- "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "networkEndpointGroup"
- ],
- "parameters": {
- "zone": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035."
- },
- "networkEndpointGroup": {
- "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "requestId": {
- "type": "string",
- "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"
+ "items": {
+ "type": "array",
+ "description": "Array of key/value pairs. The total size of all keys and values must be less than 512 KB.",
+ "items": {
+ "description": "Metadata",
+ "properties": {
+ "key": {
+ "pattern": "[a-zA-Z0-9-_]{1,128}",
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.instances.insert",
+ "compute.projects.setCommonInstanceMetadata"
+ ]
+ },
+ "description": "Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project."
+ },
+ "value": {
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.instances.insert",
+ "compute.projects.setCommonInstanceMetadata"
+ ]
+ },
+ "description": "Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB)."
+ }
},
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "description": "Project ID for this request."
- }
+ "type": "object"
}
},
- "get": {
- "response": {
- "$ref": "NetworkEndpointGroup"
- },
- "id": "compute.networkEndpointGroups.get",
- "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "networkEndpointGroup": {
- "type": "string",
- "location": "path",
- "description": "The name of the network endpoint group. It should comply with RFC1035.",
- "required": true
- },
- "project": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "zone": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035."
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "networkEndpointGroup"
- ],
- "description": "Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.",
- "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}"
+ "fingerprint": {
+ "format": "byte",
+ "description": "Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "Metadata",
+ "description": "A metadata key/value entry."
+ },
+ "BfdStatusPacketCounts": {
+ "id": "BfdStatusPacketCounts",
+ "properties": {
+ "numRxRejected": {
+ "description": "Number of packets received that were rejected because of errors since the beginning of the current BFD session.",
+ "type": "integer",
+ "format": "uint32"
},
- "aggregatedList": {
- "id": "compute.networkEndpointGroups.aggregatedList",
- "flatPath": "projects/{project}/aggregated/networkEndpointGroups",
- "httpMethod": "GET",
- "path": "projects/{project}/aggregated/networkEndpointGroups",
- "parameterOrder": [
- "project"
- ],
- "description": "Retrieves the list of network endpoint groups and sorts them by zone.",
- "response": {
- "$ref": "NetworkEndpointGroupAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "includeAllScopes": {
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "maxResults": {
- "minimum": "0",
- "format": "uint32",
- "type": "integer",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query"
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- }
- }
+ "numTx": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "Number of packets transmitted since the beginning of the current BFD session."
},
- "delete": {
- "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}",
- "parameters": {
- "networkEndpointGroup": {
- "required": true,
- "description": "The name of the network endpoint group to delete. It should comply with RFC1035.",
- "type": "string",
- "location": "path"
- },
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "zone": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035."
- }
- },
- "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}",
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "networkEndpointGroup"
- ],
- "id": "compute.networkEndpointGroups.delete",
- "description": "Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.",
- "response": {
- "$ref": "Operation"
+ "numRxSuccessful": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "Number of packets received that were successfully processed since the beginning of the current BFD session."
+ },
+ "numRx": {
+ "description": "Number of packets received since the beginning of the current BFD session.",
+ "type": "integer",
+ "format": "uint32"
+ }
+ },
+ "type": "object"
+ },
+ "SecurityPolicyRule": {
+ "type": "object",
+ "description": "Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).",
+ "id": "SecurityPolicyRule",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "priority": {
+ "format": "int32",
+ "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.",
+ "type": "integer"
+ },
+ "kind": {
+ "description": "[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules",
+ "default": "compute#securityPolicyRule",
+ "type": "string"
+ },
+ "rateLimitOptions": {
+ "description": "Must be specified if the action is \"rate_based_ban\" or \"throttle\". Cannot be specified for any other actions.",
+ "$ref": "SecurityPolicyRuleRateLimitOptions"
+ },
+ "action": {
+ "description": "The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. ",
+ "type": "string"
+ },
+ "redirectOptions": {
+ "description": "Parameters defining the redirect action. Cannot be specified for any other actions.",
+ "$ref": "SecurityPolicyRuleRedirectOptions"
+ },
+ "preview": {
+ "description": "If set to true, the specified action is not enforced.",
+ "type": "boolean"
+ },
+ "match": {
+ "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.",
+ "$ref": "SecurityPolicyRuleMatcher"
+ },
+ "headerAction": {
+ "$ref": "SecurityPolicyRuleHttpHeaderAction",
+ "description": "Optional, additional actions that are performed on headers."
+ }
+ }
+ },
+ "InstanceConsumptionInfo": {
+ "type": "object",
+ "id": "InstanceConsumptionInfo",
+ "properties": {
+ "localSsdGb": {
+ "description": "The amount of local SSD storage available to the instance, defined in GiB.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "memoryMb": {
+ "type": "integer",
+ "description": "The amount of physical memory available to the instance, defined in MiB.",
+ "format": "int32"
+ },
+ "minNodeCpus": {
+ "format": "int32",
+ "description": "The minimal guaranteed number of virtual CPUs that are reserved.",
+ "type": "integer"
+ },
+ "guestCpus": {
+ "description": "The number of virtual CPUs that are available to the instance.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "NetworksRemovePeeringRequest": {
+ "id": "NetworksRemovePeeringRequest",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the peering, which should conform to RFC1035."
+ }
+ },
+ "type": "object"
+ },
+ "RouteList": {
+ "id": "RouteList",
+ "description": "Contains a list of Route resources.",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "kind": {
+ "default": "compute#routeList",
+ "type": "string",
+ "description": "Type of resource."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of Route resources.",
+ "type": "array",
+ "items": {
+ "$ref": "Route"
}
},
- "detachNetworkEndpoints": {
- "httpMethod": "POST",
- "id": "compute.networkEndpointGroups.detachNetworkEndpoints",
- "parameters": {
- "zone": {
- "location": "path",
- "required": true,
- "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
- "type": "string"
- },
- "networkEndpointGroup": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035."
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string"
},
- "requestId": {
- "location": "query",
- "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).",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
- "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
- "parameterOrder": [
- "project",
- "zone",
- "networkEndpointGroup"
- ],
- "request": {
- "$ref": "NetworkEndpointGroupsDetachEndpointsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "description": "Detach a list of network endpoints from the specified network endpoint group."
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "Quota": {
+ "properties": {
+ "owner": {
+ "type": "string",
+ "description": "[Output Only] Owning resource. This is the resource on which this quota is applied."
},
- "testIamPermissions": {
- "httpMethod": "POST",
- "description": "Returns permissions that a caller has on the specified resource.",
- "parameters": {
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "resource": {
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- },
- "project": {
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
- },
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions",
- "id": "compute.networkEndpointGroups.testIamPermissions",
- "parameterOrder": [
- "project",
- "zone",
- "resource"
- ],
- "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions"
- },
- "listNetworkEndpoints": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "networkEndpointGroup": {
- "type": "string",
- "location": "path",
- "description": "The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.",
- "required": true
- },
- "maxResults": {
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "minimum": "0",
- "type": "integer",
- "location": "query"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "type": "string",
- "location": "path",
- "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- }
- },
- "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
- "response": {
- "$ref": "NetworkEndpointGroupsListNetworkEndpoints"
- },
- "request": {
- "$ref": "NetworkEndpointGroupsListEndpointsRequest"
- },
- "parameterOrder": [
- "project",
- "zone",
- "networkEndpointGroup"
- ],
- "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
- "httpMethod": "POST",
- "description": "Lists the network endpoints in the specified network endpoint group.",
- "id": "compute.networkEndpointGroups.listNetworkEndpoints"
- },
- "insert": {
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.",
- "id": "compute.networkEndpointGroups.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "NetworkEndpointGroup"
- },
- "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups",
- "parameterOrder": [
- "project",
- "zone"
- ],
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "zone": {
- "description": "The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string"
- }
- },
- "path": "projects/{project}/zones/{zone}/networkEndpointGroups"
- }
- }
- },
- "regionDisks": {
- "methods": {
- "setLabels": {
- "request": {
- "$ref": "RegionSetLabelsRequest"
- },
- "id": "compute.regionDisks.setLabels",
- "parameters": {
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name or id of the resource for this request."
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true
- },
- "region": {
- "description": "The region for this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
- },
- "description": "Sets the labels on the target regional disk.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/regions/{region}/disks/{resource}/setLabels",
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/regions/{region}/disks/{resource}/setLabels",
- "httpMethod": "POST"
- },
- "createSnapshot": {
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.regionDisks.createSnapshot",
- "parameterOrder": [
- "project",
- "region",
- "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.",
- "request": {
- "$ref": "Snapshot"
- },
- "flatPath": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot",
- "httpMethod": "POST",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "disk": {
- "location": "path",
- "description": "Name of the regional persistent disk to snapshot.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- },
- "region": {
- "type": "string",
- "description": "Name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- }
- },
- "addResourcePolicies": {
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST",
- "flatPath": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies",
- "path": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies",
- "parameters": {
- "disk": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true,
- "description": "The disk name for this request.",
- "location": "path"
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request."
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "region": {
- "location": "path",
- "description": "The name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.",
- "id": "compute.regionDisks.addResourcePolicies",
- "parameterOrder": [
- "project",
- "region",
- "disk"
- ],
- "request": {
- "$ref": "RegionDisksAddResourcePoliciesRequest"
- }
- },
- "resize": {
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "region",
- "disk"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Resizes the specified regional persistent disk.",
- "request": {
- "$ref": "RegionDisksResizeRequest"
- },
- "flatPath": "projects/{project}/regions/{region}/disks/{disk}/resize",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "region": {
- "type": "string",
- "location": "path",
- "description": "Name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "disk": {
- "description": "Name of the regional persistent disk.",
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "The project ID for this request.",
- "type": "string",
- "location": "path"
- },
- "requestId": {
- "type": "string",
- "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"
- }
- },
- "path": "projects/{project}/regions/{region}/disks/{disk}/resize",
- "id": "compute.regionDisks.resize"
- },
- "setIamPolicy": {
- "request": {
- "$ref": "RegionSetPolicyRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Policy"
- },
- "httpMethod": "POST",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "path": "projects/{project}/regions/{region}/disks/{resource}/setIamPolicy",
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true
- },
- "resource": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "type": "string"
- },
- "region": {
- "required": true,
- "location": "path",
- "description": "The name of the region for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
- },
- "flatPath": "projects/{project}/regions/{region}/disks/{resource}/setIamPolicy",
- "id": "compute.regionDisks.setIamPolicy"
- },
- "insert": {
- "parameterOrder": [
- "project",
- "region"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/disks",
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Name of the region for this request."
- },
- "sourceImage": {
- "description": "Source image to restore onto a disk. This field is optional.",
- "location": "query",
- "type": "string"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "id": "compute.regionDisks.insert",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/disks",
- "description": "Creates a persistent regional disk in the specified project using the data included in the request.",
- "httpMethod": "POST",
- "request": {
- "$ref": "Disk"
- }
- },
- "testIamPermissions": {
- "path": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions",
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "flatPath": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions",
- "parameters": {
- "region": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "The name of the region for this request.",
- "location": "path"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "resource": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "description": "Returns permissions that a caller has on the specified resource.",
- "id": "compute.regionDisks.testIamPermissions",
- "httpMethod": "POST",
- "request": {
- "$ref": "TestPermissionsRequest"
- }
- },
- "get": {
- "id": "compute.regionDisks.get",
- "path": "projects/{project}/regions/{region}/disks/{disk}",
- "flatPath": "projects/{project}/regions/{region}/disks/{disk}",
- "parameterOrder": [
- "project",
- "region",
- "disk"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "parameters": {
- "region": {
- "location": "path",
- "required": true,
- "description": "Name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "project": {
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "disk": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the regional persistent disk to return.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "response": {
- "$ref": "Disk"
- },
- "description": "Returns a specified regional persistent disk."
- },
- "delete": {
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "disk": {
- "description": "Name of the regional persistent disk to delete.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "region": {
- "description": "Name of the region for this request.",
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/disks/{disk}",
- "description": "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.",
- "id": "compute.regionDisks.delete",
- "path": "projects/{project}/regions/{region}/disks/{disk}",
- "parameterOrder": [
- "project",
- "region",
- "disk"
- ]
- },
- "removeResourcePolicies": {
- "request": {
- "$ref": "RegionDisksRemoveResourcePoliciesRequest"
- },
- "path": "projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies",
- "parameters": {
- "region": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "The name of the region for this request."
- },
- "project": {
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request."
- },
- "disk": {
- "required": true,
- "description": "The disk name for this request.",
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "requestId": {
- "type": "string",
- "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"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "id": "compute.regionDisks.removeResourcePolicies",
- "flatPath": "projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies",
- "parameterOrder": [
- "project",
- "region",
- "disk"
- ],
- "description": "Removes resource policies from a regional disk."
- },
- "list": {
- "flatPath": "projects/{project}/regions/{region}/disks",
- "id": "compute.regionDisks.list",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/regions/{region}/disks",
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "maxResults": {
- "location": "query",
- "format": "uint32",
- "default": "500",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer"
- },
- "region": {
- "location": "path",
- "description": "Name of the region for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- }
- },
- "description": "Retrieves the list of persistent disks contained within the specified region.",
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "DiskList"
- }
- },
- "getIamPolicy": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "id": "compute.regionDisks.getIamPolicy",
- "path": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy",
- "parameters": {
- "resource": {
- "description": "Name or id of the resource for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "optionsRequestedPolicyVersion": {
- "description": "Requested IAM Policy version.",
- "type": "integer",
- "format": "int32",
- "location": "query"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "The name of the region for this request.",
- "type": "string",
- "required": true
- }
- },
- "response": {
- "$ref": "Policy"
- },
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "flatPath": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy"
- }
- }
- },
- "regionCommitments": {
- "methods": {
- "list": {
- "response": {
- "$ref": "CommitmentList"
- },
- "parameters": {
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "region": {
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "format": "uint32",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "minimum": "0",
- "default": "500"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- }
- },
- "path": "projects/{project}/regions/{region}/commitments",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Retrieves a list of commitments contained within the specified region.",
- "parameterOrder": [
- "project",
- "region"
- ],
- "id": "compute.regionCommitments.list",
- "httpMethod": "GET",
- "flatPath": "projects/{project}/regions/{region}/commitments"
- },
- "update": {
- "parameterOrder": [
- "project",
- "region",
- "commitment"
- ],
- "request": {
- "$ref": "Commitment"
- },
- "path": "projects/{project}/regions/{region}/commitments/{commitment}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}",
- "parameters": {
- "updateMask": {
- "type": "string",
- "description": "update_mask indicates fields to be updated as part of this request.",
- "location": "query",
- "format": "google-fieldmask"
- },
- "commitment": {
- "description": "Name of the commitment for which auto renew is being updated.",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "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).",
- "type": "string",
- "location": "query"
- },
- "paths": {
- "location": "query",
- "type": "string",
- "repeated": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "region": {
- "description": "Name of the region for this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "PATCH",
- "description": "Updates the specified commitment 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: auto_renew.",
- "id": "compute.regionCommitments.update"
- },
- "insert": {
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Name of the region for this request."
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "description": "Creates a commitment in the specified project using the data included in the request.",
- "id": "compute.regionCommitments.insert",
- "path": "projects/{project}/regions/{region}/commitments",
- "flatPath": "projects/{project}/regions/{region}/commitments",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "Commitment"
- },
- "parameterOrder": [
- "project",
- "region"
- ]
- },
- "aggregatedList": {
- "httpMethod": "GET",
- "response": {
- "$ref": "CommitmentAggregatedList"
- },
- "id": "compute.regionCommitments.aggregatedList",
- "parameters": {
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Project ID for this request."
- },
- "maxResults": {
- "minimum": "0",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "location": "query",
- "format": "uint32"
- },
- "includeAllScopes": {
- "location": "query",
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- }
- },
- "flatPath": "projects/{project}/aggregated/commitments",
- "parameterOrder": [
- "project"
- ],
- "path": "projects/{project}/aggregated/commitments",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Retrieves an aggregated list of commitments by region."
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "description": "Name of the region for this request.",
- "required": true
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request."
- },
- "commitment": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the commitment to return."
- }
- },
- "description": "Returns the specified commitment resource. Gets a list of available commitments by making a list() request.",
- "parameterOrder": [
- "project",
- "region",
- "commitment"
- ],
- "id": "compute.regionCommitments.get",
- "response": {
- "$ref": "Commitment"
- },
- "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}",
- "path": "projects/{project}/regions/{region}/commitments/{commitment}",
- "httpMethod": "GET"
- }
- }
- },
- "regionSslCertificates": {
- "methods": {
- "insert": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "parameters": {
- "requestId": {
- "type": "string",
- "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"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
- }
- },
- "id": "compute.regionSslCertificates.insert",
- "description": "Creates a SslCertificate resource in the specified project and region using the data included in the request",
- "flatPath": "projects/{project}/regions/{region}/sslCertificates",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/regions/{region}/sslCertificates",
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "SslCertificate"
- }
- },
- "get": {
- "description": "Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.",
- "response": {
- "$ref": "SslCertificate"
- },
- "id": "compute.regionSslCertificates.get",
- "parameters": {
- "region": {
- "location": "path",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "sslCertificate": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the SslCertificate resource to return."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}",
- "httpMethod": "GET",
- "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}",
- "parameterOrder": [
- "project",
- "region",
- "sslCertificate"
- ]
- },
- "delete": {
- "description": "Deletes the specified SslCertificate resource in the region.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}",
- "id": "compute.regionSslCertificates.delete",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}",
- "httpMethod": "DELETE",
- "parameters": {
- "sslCertificate": {
- "location": "path",
- "required": true,
- "description": "Name of the SslCertificate resource to delete.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "sslCertificate"
- ]
- },
- "list": {
- "flatPath": "projects/{project}/regions/{region}/sslCertificates",
- "description": "Retrieves the list of SslCertificate resources available to the specified project in the specified region.",
- "response": {
- "$ref": "SslCertificateList"
- },
- "path": "projects/{project}/regions/{region}/sslCertificates",
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "maxResults": {
- "location": "query",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "format": "uint32",
- "type": "integer"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request."
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- }
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.regionSslCertificates.list"
- }
- }
- },
- "networks": {
- "methods": {
- "switchToCustomMode": {
- "id": "compute.networks.switchToCustomMode",
- "httpMethod": "POST",
- "path": "projects/{project}/global/networks/{network}/switchToCustomMode",
- "flatPath": "projects/{project}/global/networks/{network}/switchToCustomMode",
- "description": "Switches the network mode from auto subnet mode to custom subnet mode.",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
- },
- "network": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the network to be updated.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "parameterOrder": [
- "project",
- "network"
- ]
- },
- "updatePeering": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "network": {
- "description": "Name of the network resource which the updated peering is belonging to.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "description": "Project ID for this request."
- }
- },
- "httpMethod": "PATCH",
- "id": "compute.networks.updatePeering",
- "parameterOrder": [
- "project",
- "network"
- ],
- "path": "projects/{project}/global/networks/{network}/updatePeering",
- "request": {
- "$ref": "NetworksUpdatePeeringRequest"
- },
- "flatPath": "projects/{project}/global/networks/{network}/updatePeering",
- "description": "Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field.",
- "response": {
- "$ref": "Operation"
- }
- },
- "list": {
- "parameterOrder": [
- "project"
- ],
- "id": "compute.networks.list",
- "httpMethod": "GET",
- "path": "projects/{project}/global/networks",
- "response": {
- "$ref": "NetworkList"
- },
- "flatPath": "projects/{project}/global/networks",
- "description": "Retrieves the list of networks available to the specified project.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- },
- "maxResults": {
- "type": "integer",
- "location": "query",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "format": "uint32"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- }
- }
- },
- "removePeering": {
- "id": "compute.networks.removePeering",
- "path": "projects/{project}/global/networks/{network}/removePeering",
- "response": {
- "$ref": "Operation"
- },
- "description": "Removes a peering from the specified network.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "network": {
- "description": "Name of the network resource to remove peering from.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "network"
- ],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/global/networks/{network}/removePeering",
- "request": {
- "$ref": "NetworksRemovePeeringRequest"
- }
- },
- "getEffectiveFirewalls": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "path": "projects/{project}/global/networks/{network}/getEffectiveFirewalls",
- "parameterOrder": [
- "project",
- "network"
- ],
- "id": "compute.networks.getEffectiveFirewalls",
- "response": {
- "$ref": "NetworksGetEffectiveFirewallsResponse"
- },
- "parameters": {
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "network": {
- "location": "path",
- "description": "Name of the network for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
- }
- },
- "description": "Returns the effective firewalls on a given network.",
- "flatPath": "projects/{project}/global/networks/{network}/getEffectiveFirewalls"
- },
- "insert": {
- "flatPath": "projects/{project}/global/networks",
- "id": "compute.networks.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Creates a network in the specified project using the data included in the request.",
- "path": "projects/{project}/global/networks",
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST",
- "request": {
- "$ref": "Network"
- },
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "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).",
- "type": "string",
- "location": "query"
- }
- }
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "requestId": {
- "type": "string",
- "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"
- },
- "network": {
- "description": "Name of the network to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string",
- "required": true
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "id": "compute.networks.delete",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/global/networks/{network}",
- "description": "Deletes the specified network.",
- "parameterOrder": [
- "project",
- "network"
- ],
- "flatPath": "projects/{project}/global/networks/{network}",
- "httpMethod": "DELETE"
- },
- "listPeeringRoutes": {
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "network": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the network for this request.",
- "type": "string"
- },
- "direction": {
- "type": "string",
- "enumDescriptions": [
- "For routes exported from peer network.",
- "For routes exported from local network."
- ],
- "enum": [
- "INCOMING",
- "OUTGOING"
- ],
- "location": "query",
- "description": "The direction of the exchanged routes."
- },
- "region": {
- "location": "query",
- "type": "string",
- "description": "The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region."
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "maxResults": {
- "type": "integer",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "minimum": "0",
- "location": "query"
- },
- "peeringName": {
- "description": "The response will show routes exchanged over the given peering connection.",
- "type": "string",
- "location": "query"
- }
- },
- "description": "Lists the peering routes exchanged over peering connection.",
- "flatPath": "projects/{project}/global/networks/{network}/listPeeringRoutes",
- "id": "compute.networks.listPeeringRoutes",
- "path": "projects/{project}/global/networks/{network}/listPeeringRoutes",
- "httpMethod": "GET",
- "response": {
- "$ref": "ExchangedPeeringRoutesList"
- },
- "parameterOrder": [
- "project",
- "network"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "patch": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "network"
- ],
- "httpMethod": "PATCH",
- "path": "projects/{project}/global/networks/{network}",
- "parameters": {
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "description": "Project ID for this request."
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "network": {
- "type": "string",
- "required": true,
- "description": "Name of the network to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- }
- },
- "description": "Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.",
- "request": {
- "$ref": "Network"
- },
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.networks.patch",
- "flatPath": "projects/{project}/global/networks/{network}"
- },
- "get": {
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "network": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "description": "Name of the network to return.",
- "location": "path"
- }
- },
- "id": "compute.networks.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "network"
- ],
- "flatPath": "projects/{project}/global/networks/{network}",
- "httpMethod": "GET",
- "response": {
- "$ref": "Network"
- },
- "description": "Returns the specified network. Gets a list of available networks by making a list() request.",
- "path": "projects/{project}/global/networks/{network}"
- },
- "addPeering": {
- "path": "projects/{project}/global/networks/{network}/addPeering",
- "parameterOrder": [
- "project",
- "network"
- ],
- "flatPath": "projects/{project}/global/networks/{network}/addPeering",
- "id": "compute.networks.addPeering",
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "description": "Adds a peering to the specified network.",
- "request": {
- "$ref": "NetworksAddPeeringRequest"
- },
- "parameters": {
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request."
- },
- "network": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
- "description": "Name of the network resource to add peering to.",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "httpHealthChecks": {
- "methods": {
- "update": {
- "httpMethod": "PUT",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request.",
- "id": "compute.httpHealthChecks.update",
- "request": {
- "$ref": "HttpHealthCheck"
- },
- "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
- "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "httpHealthCheck": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Name of the HttpHealthCheck resource to update."
- }
- }
- },
- "insert": {
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/global/httpHealthChecks",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "request": {
- "$ref": "HttpHealthCheck"
- },
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/global/httpHealthChecks",
- "description": "Creates a HttpHealthCheck resource in the specified project using the data included in the request.",
- "id": "compute.httpHealthChecks.insert"
- },
- "delete": {
- "id": "compute.httpHealthChecks.delete",
- "description": "Deletes the specified HttpHealthCheck resource.",
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "httpHealthCheck": {
- "description": "Name of the HttpHealthCheck resource to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path",
- "required": true
- },
- "requestId": {
- "type": "string",
- "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"
- }
- },
- "httpMethod": "DELETE",
- "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}"
- },
- "get": {
- "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
- "response": {
- "$ref": "HttpHealthCheck"
- },
- "id": "compute.httpHealthChecks.get",
- "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
- "parameters": {
- "httpHealthCheck": {
- "description": "Name of the HttpHealthCheck resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "httpMethod": "GET",
- "description": "Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request."
- },
- "patch": {
- "id": "compute.httpHealthChecks.patch",
- "request": {
- "$ref": "HttpHealthCheck"
- },
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "httpHealthCheck": {
- "description": "Name of the HttpHealthCheck resource to patch.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request."
- }
- },
- "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
- "httpMethod": "PATCH",
- "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
- "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "parameterOrder": [
- "project",
- "httpHealthCheck"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "list": {
- "id": "compute.httpHealthChecks.list",
- "parameters": {
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "maxResults": {
- "minimum": "0",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "type": "integer",
- "location": "query"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request."
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- }
- },
- "httpMethod": "GET",
- "response": {
- "$ref": "HttpHealthCheckList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/global/httpHealthChecks",
- "description": "Retrieves the list of HttpHealthCheck resources available to the specified project.",
- "path": "projects/{project}/global/httpHealthChecks"
- }
- }
- },
- "interconnectLocations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "InterconnectLocationList"
- },
- "description": "Retrieves the list of interconnect locations available to the specified project.",
- "flatPath": "projects/{project}/global/interconnectLocations",
- "parameterOrder": [
- "project"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/global/interconnectLocations",
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "maxResults": {
- "location": "query",
- "minimum": "0",
- "type": "integer",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "id": "compute.interconnectLocations.list"
- },
- "get": {
- "id": "compute.interconnectLocations.get",
- "flatPath": "projects/{project}/global/interconnectLocations/{interconnectLocation}",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "interconnectLocation"
- ],
- "parameters": {
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string"
- },
- "interconnectLocation": {
- "description": "Name of the interconnect location to return.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/global/interconnectLocations/{interconnectLocation}",
- "response": {
- "$ref": "InterconnectLocation"
- },
- "description": "Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request."
- }
- }
- },
- "interconnects": {
- "methods": {
- "setLabels": {
- "id": "compute.interconnects.setLabels",
- "flatPath": "projects/{project}/global/interconnects/{resource}/setLabels",
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "description": "Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "path": "projects/{project}/global/interconnects/{resource}/setLabels",
- "request": {
- "$ref": "GlobalSetLabelsRequest"
- }
- },
- "get": {
- "response": {
- "$ref": "Interconnect"
- },
- "flatPath": "projects/{project}/global/interconnects/{interconnect}",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "interconnect": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the interconnect to return.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.",
- "parameterOrder": [
- "project",
- "interconnect"
- ],
- "httpMethod": "GET",
- "id": "compute.interconnects.get",
- "path": "projects/{project}/global/interconnects/{interconnect}"
- },
- "list": {
- "parameters": {
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "maxResults": {
- "location": "query",
- "minimum": "0",
- "type": "integer",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- }
- },
- "description": "Retrieves the list of Interconnects available to the specified project.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/global/interconnects",
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "InterconnectList"
- },
- "httpMethod": "GET",
- "id": "compute.interconnects.list",
- "flatPath": "projects/{project}/global/interconnects"
- },
- "getDiagnostics": {
- "flatPath": "projects/{project}/global/interconnects/{interconnect}/getDiagnostics",
- "parameters": {
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
- },
- "interconnect": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Name of the interconnect resource to query.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "description": "Returns the interconnectDiagnostics for the specified Interconnect.",
- "parameterOrder": [
- "project",
- "interconnect"
- ],
- "httpMethod": "GET",
- "id": "compute.interconnects.getDiagnostics",
- "path": "projects/{project}/global/interconnects/{interconnect}/getDiagnostics",
- "response": {
- "$ref": "InterconnectsGetDiagnosticsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "path": "projects/{project}/global/interconnects",
- "httpMethod": "POST",
- "parameterOrder": [
- "project"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "Interconnect"
- },
- "id": "compute.interconnects.insert",
- "parameters": {
- "project": {
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- },
- "description": "Creates an Interconnect in the specified project using the data included in the request.",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/global/interconnects"
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/interconnects/{interconnect}",
- "parameters": {
- "interconnect": {
- "location": "path",
- "type": "string",
- "description": "Name of the interconnect to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path"
- }
- },
- "id": "compute.interconnects.delete",
- "flatPath": "projects/{project}/global/interconnects/{interconnect}",
- "description": "Deletes the specified Interconnect.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "interconnect"
- ],
- "httpMethod": "DELETE"
- },
- "patch": {
- "id": "compute.interconnects.patch",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "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).",
- "type": "string",
- "location": "query"
- },
- "interconnect": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the interconnect to update.",
- "type": "string",
- "required": true
- }
- },
- "description": "Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "path": "projects/{project}/global/interconnects/{interconnect}",
- "flatPath": "projects/{project}/global/interconnects/{interconnect}",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "project",
- "interconnect"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "Interconnect"
- }
- }
- }
- },
- "regionInstanceGroups": {
- "methods": {
- "get": {
- "id": "compute.regionInstanceGroups.get",
- "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "region",
- "instanceGroup"
- ],
- "description": "Returns the specified instance group resource.",
- "response": {
- "$ref": "InstanceGroup"
- },
- "parameters": {
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "instanceGroup": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the instance group resource to return."
- },
- "region": {
- "type": "string",
- "required": true,
- "description": "Name of the region scoping this request.",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}"
- },
- "setNamedPorts": {
- "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts",
- "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts",
- "request": {
- "$ref": "RegionInstanceGroupsSetNamedPortsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "region",
- "instanceGroup"
- ],
- "id": "compute.regionInstanceGroups.setNamedPorts",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "instanceGroup": {
- "description": "The name of the regional instance group where the named ports are updated.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "description": "Sets the named ports for the specified regional instance group."
- },
- "list": {
- "path": "projects/{project}/regions/{region}/instanceGroups",
- "flatPath": "projects/{project}/regions/{region}/instanceGroups",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "format": "uint32",
- "location": "query"
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "region": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the region scoping this request."
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "RegionInstanceGroupList"
- },
- "id": "compute.regionInstanceGroups.list",
- "description": "Retrieves the list of instance group resources contained within the specified region.",
- "parameterOrder": [
- "project",
- "region"
- ]
- },
- "listInstances": {
- "parameterOrder": [
- "project",
- "region",
- "instanceGroup"
- ],
- "id": "compute.regionInstanceGroups.listInstances",
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances",
- "request": {
- "$ref": "RegionInstanceGroupsListInstancesRequest"
- },
- "response": {
- "$ref": "RegionInstanceGroupsListInstances"
- },
- "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances",
- "description": "Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "region": {
- "location": "path",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "default": "500",
- "location": "query",
- "format": "uint32"
- },
- "instanceGroup": {
- "description": "Name of the regional instance group for which we want to list the instances.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- }
- }
- }
- }
- },
- "regionUrlMaps": {
- "methods": {
- "list": {
- "parameterOrder": [
- "project",
- "region"
- ],
- "id": "compute.regionUrlMaps.list",
- "flatPath": "projects/{project}/regions/{region}/urlMaps",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "type": "integer",
- "location": "query",
- "format": "uint32",
- "default": "500"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- }
- },
- "response": {
- "$ref": "UrlMapList"
- },
- "description": "Retrieves the list of UrlMap resources available to the specified project in the specified region.",
- "path": "projects/{project}/regions/{region}/urlMaps",
- "httpMethod": "GET"
- },
- "insert": {
- "path": "projects/{project}/regions/{region}/urlMaps",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "UrlMap"
- },
- "id": "compute.regionUrlMaps.insert",
- "flatPath": "projects/{project}/regions/{region}/urlMaps",
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency."
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "description": "Creates a UrlMap resource in the specified project using the data included in the request."
- },
- "get": {
- "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
- "httpMethod": "GET",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the UrlMap resource to return."
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "type": "string"
- }
- },
- "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
- "id": "compute.regionUrlMaps.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "UrlMap"
- },
- "parameterOrder": [
- "project",
- "region",
- "urlMap"
- ],
- "description": "Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request."
- },
- "validate": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate",
- "parameterOrder": [
- "project",
- "region",
- "urlMap"
- ],
- "id": "compute.regionUrlMaps.validate",
- "response": {
- "$ref": "UrlMapsValidateResponse"
- },
- "parameters": {
- "region": {
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "required": true
- },
- "urlMap": {
- "type": "string",
- "description": "Name of the UrlMap resource to be validated as.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "httpMethod": "POST",
- "request": {
- "$ref": "RegionUrlMapsValidateRequest"
- },
- "description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.",
- "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate"
- },
- "update": {
- "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
- "description": "Updates the specified UrlMap resource with the data included in the request.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "region",
- "urlMap"
- ],
- "httpMethod": "PUT",
- "id": "compute.regionUrlMaps.update",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency."
- },
- "region": {
- "required": true,
- "type": "string",
- "description": "Name of the region scoping this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "urlMap": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the UrlMap resource to update."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "UrlMap"
- },
- "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}"
- },
- "delete": {
- "parameters": {
- "requestId": {
- "type": "string",
- "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
- "location": "query"
- },
- "urlMap": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the UrlMap resource to delete.",
- "required": true
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
- "id": "compute.regionUrlMaps.delete",
- "description": "Deletes the specified UrlMap resource.",
- "parameterOrder": [
- "project",
- "region",
- "urlMap"
- ],
- "httpMethod": "DELETE"
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency."
- },
- "urlMap": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "description": "Name of the UrlMap resource to patch."
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
- "parameterOrder": [
- "project",
- "region",
- "urlMap"
- ],
- "id": "compute.regionUrlMaps.patch",
- "request": {
- "$ref": "UrlMap"
- },
- "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
- "description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules."
- }
- }
- },
- "projects": {
- "methods": {
- "setDefaultNetworkTier": {
- "id": "compute.projects.setDefaultNetworkTier",
- "request": {
- "$ref": "ProjectsSetDefaultNetworkTierRequest"
- },
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string"
- }
- },
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/setDefaultNetworkTier",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/setDefaultNetworkTier",
- "description": "Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field."
- },
- "moveInstance": {
- "path": "projects/{project}/moveInstance",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
- },
- "description": "Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).",
- "id": "compute.projects.moveInstance",
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/moveInstance",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "InstanceMoveRequest"
- }
- },
- "get": {
- "httpMethod": "GET",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "Project"
- },
- "flatPath": "projects/{project}",
- "parameterOrder": [
- "project"
- ],
- "id": "compute.projects.get",
- "path": "projects/{project}",
- "description": "Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request."
- },
- "getXpnResources": {
- "parameters": {
- "maxResults": {
- "location": "query",
- "minimum": "0",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "default": "500"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- }
- },
- "description": "Gets service resources (a.k.a service project) associated with this host project.",
- "response": {
- "$ref": "ProjectsGetXpnResources"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project"
- ],
- "path": "projects/{project}/getXpnResources",
- "id": "compute.projects.getXpnResources",
- "flatPath": "projects/{project}/getXpnResources",
- "httpMethod": "GET"
- },
- "disableXpnResource": {
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/disableXpnResource",
- "description": "Disable a service resource (also known as service project) associated with this host project.",
- "request": {
- "$ref": "ProjectsDisableXpnResourceRequest"
- },
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project"
- ],
- "path": "projects/{project}/disableXpnResource",
- "id": "compute.projects.disableXpnResource"
- },
- "enableXpnResource": {
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "ProjectsEnableXpnResourceRequest"
- },
- "description": "Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- },
- "flatPath": "projects/{project}/enableXpnResource",
- "path": "projects/{project}/enableXpnResource",
- "id": "compute.projects.enableXpnResource",
- "parameterOrder": [
- "project"
- ]
- },
- "listXpnHosts": {
- "id": "compute.projects.listXpnHosts",
- "path": "projects/{project}/listXpnHosts",
- "parameters": {
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "format": "uint32",
- "minimum": "0",
- "type": "integer",
- "default": "500"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "ProjectsListXpnHostsRequest"
- },
- "httpMethod": "POST",
- "response": {
- "$ref": "XpnHostList"
- },
- "description": "Lists all shared VPC host projects visible to the user in an organization.",
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/listXpnHosts"
- },
- "setUsageExportBucket": {
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
- }
- },
- "path": "projects/{project}/setUsageExportBucket",
- "response": {
- "$ref": "Operation"
- },
- "description": "Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.",
- "flatPath": "projects/{project}/setUsageExportBucket",
- "httpMethod": "POST",
- "parameterOrder": [
- "project"
- ],
- "id": "compute.projects.setUsageExportBucket",
- "request": {
- "$ref": "UsageExportLocation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/devstorage.full_control",
- "https://www.googleapis.com/auth/devstorage.read_only",
- "https://www.googleapis.com/auth/devstorage.read_write"
- ]
- },
- "getXpnHost": {
- "description": "Gets the shared VPC host project that this project links to. May be empty if no link exists.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "GET",
- "path": "projects/{project}/getXpnHost",
- "flatPath": "projects/{project}/getXpnHost",
- "id": "compute.projects.getXpnHost",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- }
- },
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [
- "project"
- ]
- },
- "disableXpnHost": {
- "flatPath": "projects/{project}/disableXpnHost",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "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).",
- "type": "string",
- "location": "query"
- }
- },
- "id": "compute.projects.disableXpnHost",
- "httpMethod": "POST",
- "parameterOrder": [
- "project"
- ],
- "description": "Disable this project as a shared VPC host project.",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/disableXpnHost"
- },
- "enableXpnHost": {
- "parameters": {
- "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).",
- "type": "string",
- "location": "query"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string"
- }
- },
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/enableXpnHost",
- "parameterOrder": [
- "project"
- ],
- "path": "projects/{project}/enableXpnHost",
- "id": "compute.projects.enableXpnHost",
- "description": "Enable this project as a shared VPC host project.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setCommonInstanceMetadata": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "description": "Sets metadata common to all instances within the specified project using the data included in the request.",
- "request": {
- "$ref": "Metadata"
- },
- "flatPath": "projects/{project}/setCommonInstanceMetadata",
- "id": "compute.projects.setCommonInstanceMetadata",
- "path": "projects/{project}/setCommonInstanceMetadata",
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "POST",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true
- },
- "requestId": {
- "type": "string",
- "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"
- }
- }
- },
- "moveDisk": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/moveDisk",
- "path": "projects/{project}/moveDisk",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
- },
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "DiskMoveRequest"
- },
- "id": "compute.projects.moveDisk",
- "parameterOrder": [
- "project"
- ],
- "description": "Moves a persistent disk from one zone to another."
- }
- }
- },
- "globalForwardingRules": {
- "methods": {
- "insert": {
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "ForwardingRule"
- },
- "description": "Creates a GlobalForwardingRule resource in the specified project using the data included in the request.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/global/forwardingRules",
- "id": "compute.globalForwardingRules.insert",
- "path": "projects/{project}/global/forwardingRules",
- "httpMethod": "POST",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
- }
- }
- },
- "get": {
- "httpMethod": "GET",
- "description": "Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}",
- "response": {
- "$ref": "ForwardingRule"
- },
- "path": "projects/{project}/global/forwardingRules/{forwardingRule}",
- "parameters": {
- "forwardingRule": {
- "location": "path",
- "description": "Name of the ForwardingRule resource to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "forwardingRule"
- ],
- "id": "compute.globalForwardingRules.get"
- },
- "patch": {
- "description": "Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.globalForwardingRules.patch",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
- },
- "forwardingRule": {
- "description": "Name of the ForwardingRule resource to patch.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- }
- },
- "httpMethod": "PATCH",
- "request": {
- "$ref": "ForwardingRule"
- },
- "parameterOrder": [
- "project",
- "forwardingRule"
- ],
- "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}",
- "path": "projects/{project}/global/forwardingRules/{forwardingRule}",
- "response": {
- "$ref": "Operation"
- }
- },
- "setTarget": {
- "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget",
- "description": "Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.",
- "id": "compute.globalForwardingRules.setTarget",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "forwardingRule": {
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the ForwardingRule resource in which target is to be set.",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string"
- }
- },
- "request": {
- "$ref": "TargetReference"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "forwardingRule"
- ]
- },
- "setLabels": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "resource"
- ],
- "flatPath": "projects/{project}/global/forwardingRules/{resource}/setLabels",
- "request": {
- "$ref": "GlobalSetLabelsRequest"
- },
- "id": "compute.globalForwardingRules.setLabels",
- "httpMethod": "POST",
- "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "resource": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name or id of the resource for this request.",
- "required": true
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/forwardingRules/{resource}/setLabels"
- },
- "list": {
- "parameters": {
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "type": "integer",
- "default": "500",
- "format": "uint32",
- "minimum": "0"
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- }
- },
- "flatPath": "projects/{project}/global/forwardingRules",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Retrieves a list of GlobalForwardingRule resources available to the specified project.",
- "parameterOrder": [
- "project"
- ],
- "path": "projects/{project}/global/forwardingRules",
- "httpMethod": "GET",
- "response": {
- "$ref": "ForwardingRuleList"
- },
- "id": "compute.globalForwardingRules.list"
- },
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}",
- "id": "compute.globalForwardingRules.delete",
- "description": "Deletes the specified GlobalForwardingRule resource.",
- "path": "projects/{project}/global/forwardingRules/{forwardingRule}",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "project",
- "forwardingRule"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "forwardingRule": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Name of the ForwardingRule resource to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "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"
- }
- }
- }
- }
- },
- "publicDelegatedPrefixes": {
- "methods": {
- "aggregatedList": {
- "httpMethod": "GET",
- "id": "compute.publicDelegatedPrefixes.aggregatedList",
- "description": "Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.",
- "path": "projects/{project}/aggregated/publicDelegatedPrefixes",
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "PublicDelegatedPrefixAggregatedList"
- },
- "flatPath": "projects/{project}/aggregated/publicDelegatedPrefixes",
- "parameters": {
- "maxResults": {
- "format": "uint32",
- "type": "integer",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "default": "500"
- },
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query",
- "type": "boolean"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "project": {
- "location": "path",
- "description": "Name of the project scoping this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "get": {
- "parameters": {
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "region": {
- "description": "Name of the region of this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "publicDelegatedPrefix": {
- "description": "Name of the PublicDelegatedPrefix resource to return.",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- }
- },
- "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "region",
- "publicDelegatedPrefix"
- ],
- "response": {
- "$ref": "PublicDelegatedPrefix"
- },
- "httpMethod": "GET",
- "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
- "id": "compute.publicDelegatedPrefixes.get",
- "description": "Returns the specified PublicDelegatedPrefix resource in the given region."
- },
- "insert": {
- "request": {
- "$ref": "PublicDelegatedPrefix"
- },
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.publicDelegatedPrefixes.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of the region of this request.",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes",
- "parameterOrder": [
- "project",
- "region"
- ],
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes",
- "description": "Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request."
- },
- "list": {
- "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes",
- "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes",
- "response": {
- "$ref": "PublicDelegatedPrefixList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "region"
- ],
- "parameters": {
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "maxResults": {
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "type": "integer"
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "region": {
- "type": "string",
- "description": "Name of the region of this request.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- }
- },
- "description": "Lists the PublicDelegatedPrefixes for a project in the given region.",
- "httpMethod": "GET",
- "id": "compute.publicDelegatedPrefixes.list"
- },
- "delete": {
- "httpMethod": "DELETE",
- "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
- "description": "Deletes the specified PublicDelegatedPrefix in the given region.",
- "id": "compute.publicDelegatedPrefixes.delete",
- "parameterOrder": [
- "project",
- "region",
- "publicDelegatedPrefix"
- ],
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "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).",
- "type": "string",
- "location": "query"
- },
- "publicDelegatedPrefix": {
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the PublicDelegatedPrefix resource to delete."
- },
- "region": {
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region of this request.",
- "required": true
- }
- }
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
- "parameterOrder": [
- "project",
- "region",
- "publicDelegatedPrefix"
- ],
- "httpMethod": "PATCH",
- "description": "Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
- "id": "compute.publicDelegatedPrefixes.patch",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "region": {
- "location": "path",
- "description": "Name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true
- },
- "publicDelegatedPrefix": {
- "location": "path",
- "description": "Name of the PublicDelegatedPrefix resource to patch.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true
- }
- },
- "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
- "request": {
- "$ref": "PublicDelegatedPrefix"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "regionBackendServices": {
- "methods": {
- "update": {
- "httpMethod": "PUT",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .",
- "parameterOrder": [
- "project",
- "region",
- "backendService"
- ],
- "parameters": {
- "region": {
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request."
- },
- "project": {
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "backendService": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the BackendService resource to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "path": "projects/{project}/regions/{region}/backendServices/{backendService}",
- "request": {
- "$ref": "BackendService"
- },
- "id": "compute.regionBackendServices.update"
- },
- "patch": {
- "httpMethod": "PATCH",
- "request": {
- "$ref": "BackendService"
- },
- "description": "Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.regionBackendServices.patch",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "region",
- "backendService"
- ],
- "path": "projects/{project}/regions/{region}/backendServices/{backendService}",
- "parameters": {
- "backendService": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the BackendService resource to patch.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "region": {
- "location": "path",
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- }
- }
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "region": {
- "location": "path",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "backendService": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the BackendService resource to delete."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.regionBackendServices.delete",
- "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}",
- "path": "projects/{project}/regions/{region}/backendServices/{backendService}",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "region",
- "backendService"
- ],
- "description": "Deletes the specified regional BackendService resource."
- },
- "getHealth": {
- "parameterOrder": [
- "project",
- "region",
- "backendService"
- ],
- "description": "Gets the most recent health check results for this regional BackendService.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/regions/{region}/backendServices/{backendService}/getHealth",
- "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}/getHealth",
- "response": {
- "$ref": "BackendServiceGroupHealth"
- },
- "request": {
- "$ref": "ResourceGroupReference"
- },
- "id": "compute.regionBackendServices.getHealth",
- "httpMethod": "POST",
- "parameters": {
- "backendService": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path",
- "description": "Name of the BackendService resource for which to get health."
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "region": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
- }
- },
- "list": {
- "parameterOrder": [
- "project",
- "region"
- ],
- "id": "compute.regionBackendServices.list",
- "parameters": {
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "region": {
- "location": "path",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "type": "integer",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "default": "500",
- "minimum": "0"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- }
- },
- "httpMethod": "GET",
- "path": "projects/{project}/regions/{region}/backendServices",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Retrieves the list of regional BackendService resources available to the specified project in the given region.",
- "flatPath": "projects/{project}/regions/{region}/backendServices",
- "response": {
- "$ref": "BackendServiceList"
- }
- },
- "setIamPolicy": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "path": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy",
- "response": {
- "$ref": "Policy"
- },
- "flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "id": "compute.regionBackendServices.setIamPolicy",
- "request": {
- "$ref": "RegionSetPolicyRequest"
- },
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path",
- "description": "Name or id of the resource for this request."
- },
- "project": {
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request."
- },
- "region": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the region for this request.",
- "required": true,
- "location": "path"
- }
- }
- },
- "getIamPolicy": {
- "path": "projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name or id of the resource for this request."
- },
- "region": {
- "type": "string",
- "required": true,
- "description": "The name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "optionsRequestedPolicyVersion": {
- "location": "query",
- "type": "integer",
- "description": "Requested IAM Policy version.",
- "format": "int32"
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy",
- "httpMethod": "GET",
- "response": {
- "$ref": "Policy"
- },
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "id": "compute.regionBackendServices.getIamPolicy",
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ]
- },
- "insert": {
- "path": "projects/{project}/regions/{region}/backendServices",
- "id": "compute.regionBackendServices.insert",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.",
- "flatPath": "projects/{project}/regions/{region}/backendServices",
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "region"
- ],
- "parameters": {
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true,
- "description": "Name of the region scoping this request."
- },
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
- },
- "request": {
- "$ref": "BackendService"
- }
- },
- "get": {
- "response": {
- "$ref": "BackendService"
- },
- "description": "Returns the specified regional BackendService resource.",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "region": {
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
- },
- "backendService": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the BackendService resource to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "backendService"
- ],
- "id": "compute.regionBackendServices.get",
- "path": "projects/{project}/regions/{region}/backendServices/{backendService}",
- "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}"
- }
- }
- },
- "networkFirewallPolicies": {
- "methods": {
- "get": {
- "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.networkFirewallPolicies.get",
- "parameterOrder": [
- "project",
- "firewallPolicy"
- ],
- "response": {
- "$ref": "FirewallPolicy"
- },
- "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
- "httpMethod": "GET",
- "parameters": {
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request."
- },
- "firewallPolicy": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path",
- "description": "Name of the firewall policy to get."
- }
- },
- "description": "Returns the specified network firewall policy."
- },
- "getAssociation": {
- "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation",
- "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation",
- "httpMethod": "GET",
- "parameters": {
- "firewallPolicy": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the firewall policy to which the queried association belongs.",
- "location": "path"
- },
- "name": {
- "description": "The name of the association to get from the firewall policy.",
- "location": "query",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "firewallPolicy"
- ],
- "description": "Gets an association with the specified name.",
- "response": {
- "$ref": "FirewallPolicyAssociation"
- },
- "id": "compute.networkFirewallPolicies.getAssociation"
- },
- "patchRule": {
- "request": {
- "$ref": "FirewallPolicyRule"
- },
- "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule",
- "id": "compute.networkFirewallPolicies.patchRule",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "firewallPolicy"
- ],
- "description": "Patches a rule of the specified priority.",
- "parameters": {
- "priority": {
- "format": "int32",
- "location": "query",
- "type": "integer",
- "description": "The priority of the rule to patch."
- },
- "firewallPolicy": {
- "type": "string",
- "description": "Name of the firewall policy to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true
- },
- "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).",
- "type": "string",
- "location": "query"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- }
- },
- "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule",
- "response": {
- "$ref": "Operation"
- }
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "firewallPolicy": {
- "description": "Name of the firewall policy to update.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path"
- }
- },
- "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
- "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "PATCH",
- "description": "Patches the specified policy with the data included in the request.",
- "request": {
- "$ref": "FirewallPolicy"
- },
- "parameterOrder": [
- "project",
- "firewallPolicy"
- ],
- "id": "compute.networkFirewallPolicies.patch"
- },
- "addRule": {
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "firewallPolicy"
- ],
- "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule",
- "id": "compute.networkFirewallPolicies.addRule",
- "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule",
- "description": "Inserts a rule into a firewall policy.",
- "request": {
- "$ref": "FirewallPolicyRule"
- },
- "parameters": {
- "maxPriority": {
- "location": "query",
- "type": "integer",
- "format": "int32",
- "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\u003e. This field is exclusive with rule.priority."
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "minPriority": {
- "location": "query",
- "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\u003e. This field is exclusive with rule.priority.",
- "format": "int32",
- "type": "integer"
- },
- "firewallPolicy": {
- "location": "path",
- "description": "Name of the firewall policy to update.",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "addAssociation": {
- "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation",
- "parameterOrder": [
- "project",
- "firewallPolicy"
- ],
- "description": "Inserts an association for the specified firewall policy.",
- "parameters": {
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "replaceExistingAssociation": {
- "type": "boolean",
- "location": "query",
- "description": "Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists."
- },
- "firewallPolicy": {
- "description": "Name of the firewall policy to update.",
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- }
- },
- "httpMethod": "POST",
- "id": "compute.networkFirewallPolicies.addAssociation",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation",
- "request": {
- "$ref": "FirewallPolicyAssociation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "insert": {
- "path": "projects/{project}/global/firewallPolicies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project"
- ],
- "id": "compute.networkFirewallPolicies.insert",
- "description": "Creates a new policy in the specified project using the data included in the request.",
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- },
- "request": {
- "$ref": "FirewallPolicy"
- },
- "flatPath": "projects/{project}/global/firewallPolicies"
- },
- "removeAssociation": {
- "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation",
- "id": "compute.networkFirewallPolicies.removeAssociation",
- "parameterOrder": [
- "project",
- "firewallPolicy"
- ],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "description": "Removes an association for the specified firewall policy.",
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "firewallPolicy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the firewall policy to update."
- },
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request."
- },
- "name": {
- "type": "string",
- "description": "Name for the attachment that will be removed.",
- "location": "query"
- }
- }
- },
- "cloneRules": {
- "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules",
- "parameterOrder": [
- "project",
- "firewallPolicy"
- ],
- "description": "Copies rules to the specified firewall policy.",
- "id": "compute.networkFirewallPolicies.cloneRules",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "parameters": {
- "firewallPolicy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the firewall policy to update."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true
- },
- "sourceFirewallPolicy": {
- "type": "string",
- "description": "The firewall policy from which to copy rules.",
- "location": "query"
- },
- "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).",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules"
- },
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "DELETE",
- "description": "Deletes the specified policy.",
- "parameterOrder": [
- "project",
- "firewallPolicy"
- ],
- "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.networkFirewallPolicies.delete",
- "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
- "parameters": {
- "firewallPolicy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string",
- "description": "Name of the firewall policy to delete.",
- "required": true
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "project": {
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- }
- },
- "getIamPolicy": {
- "path": "projects/{project}/global/firewallPolicies/{resource}/getIamPolicy",
- "httpMethod": "GET",
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "optionsRequestedPolicyVersion": {
- "location": "query",
- "description": "Requested IAM Policy version.",
- "type": "integer",
- "format": "int32"
- },
- "project": {
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "resource": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "description": "Name or id of the resource for this request."
- }
- },
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "id": "compute.networkFirewallPolicies.getIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "resource"
- ],
- "flatPath": "projects/{project}/global/firewallPolicies/{resource}/getIamPolicy"
- },
- "list": {
- "id": "compute.networkFirewallPolicies.list",
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "FirewallPolicyList"
- },
- "path": "projects/{project}/global/firewallPolicies",
- "httpMethod": "GET",
- "description": "Lists all the policies that have been configured for the specified project.",
- "parameters": {
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "default": "500"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/global/firewallPolicies"
- },
- "removeRule": {
- "httpMethod": "POST",
- "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule",
- "parameterOrder": [
- "project",
- "firewallPolicy"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule",
- "id": "compute.networkFirewallPolicies.removeRule",
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "priority": {
- "format": "int32",
- "description": "The priority of the rule to remove from the firewall policy.",
- "location": "query",
- "type": "integer"
- },
- "firewallPolicy": {
- "description": "Name of the firewall policy to update.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "required": true
- }
- },
- "description": "Deletes a rule of the specified priority.",
- "response": {
- "$ref": "Operation"
- }
- },
- "setIamPolicy": {
- "parameters": {
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Name or id of the resource for this request."
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path"
- }
- },
- "path": "projects/{project}/global/firewallPolicies/{resource}/setIamPolicy",
- "id": "compute.networkFirewallPolicies.setIamPolicy",
- "httpMethod": "POST",
- "request": {
- "$ref": "GlobalSetPolicyRequest"
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/global/firewallPolicies/{resource}/setIamPolicy",
- "response": {
- "$ref": "Policy"
- }
- },
- "getRule": {
- "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule",
- "parameterOrder": [
- "project",
- "firewallPolicy"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "FirewallPolicyRule"
- },
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request."
- },
- "priority": {
- "format": "int32",
- "description": "The priority of the rule to get from the firewall policy.",
- "type": "integer",
- "location": "query"
- },
- "firewallPolicy": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the firewall policy to which the queried rule belongs."
- }
- },
- "description": "Gets a rule of the specified priority.",
- "id": "compute.networkFirewallPolicies.getRule",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule"
- },
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "httpMethod": "POST",
- "flatPath": "projects/{project}/global/firewallPolicies/{resource}/testIamPermissions",
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "project": {
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string"
- }
- },
- "path": "projects/{project}/global/firewallPolicies/{resource}/testIamPermissions",
- "parameterOrder": [
- "project",
- "resource"
- ],
- "id": "compute.networkFirewallPolicies.testIamPermissions"
- }
- }
- },
- "zones": {
- "methods": {
- "get": {
- "parameters": {
- "zone": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the zone resource to return."
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "id": "compute.zones.get",
- "httpMethod": "GET",
- "description": "Returns the specified Zone resource. Gets a list of available zones by making a list() request.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "Zone"
- },
- "flatPath": "projects/{project}/zones/{zone}",
- "parameterOrder": [
- "project",
- "zone"
- ],
- "path": "projects/{project}/zones/{zone}"
- },
- "list": {
- "flatPath": "projects/{project}/zones",
- "path": "projects/{project}/zones",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
- "id": "compute.zones.list",
- "parameters": {
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "type": "integer",
- "default": "500",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- }
- },
- "description": "Retrieves the list of Zone resources available to the specified project.",
- "response": {
- "$ref": "ZoneList"
- }
- }
- }
- },
- "autoscalers": {
- "methods": {
- "update": {
- "path": "projects/{project}/zones/{zone}/autoscalers",
- "response": {
- "$ref": "Operation"
- },
- "description": "Updates an autoscaler in the specified project using the data included in the request.",
- "parameters": {
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Name of the zone for this request."
- },
- "autoscaler": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "query",
- "description": "Name of the autoscaler to update."
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "type": "string",
- "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"
- }
- },
- "httpMethod": "PUT",
- "flatPath": "projects/{project}/zones/{zone}/autoscalers",
- "parameterOrder": [
- "project",
- "zone"
- ],
- "id": "compute.autoscalers.update",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "Autoscaler"
- }
- },
- "patch": {
- "request": {
- "$ref": "Autoscaler"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "description": "Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "path": "projects/{project}/zones/{zone}/autoscalers",
- "id": "compute.autoscalers.patch",
- "flatPath": "projects/{project}/zones/{zone}/autoscalers",
- "parameterOrder": [
- "project",
- "zone"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Project ID for this request."
- },
- "zone": {
- "description": "Name of the zone for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path"
- },
- "autoscaler": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "query",
- "description": "Name of the autoscaler to patch."
- }
- }
- },
- "list": {
- "flatPath": "projects/{project}/zones/{zone}/autoscalers",
- "parameterOrder": [
- "project",
- "zone"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/zones/{zone}/autoscalers",
- "httpMethod": "GET",
- "description": "Retrieves a list of autoscalers contained within the specified zone.",
- "parameters": {
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "project": {
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "type": "string",
- "description": "Name of the zone for this request.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "maxResults": {
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "format": "uint32",
- "type": "integer",
- "location": "query"
- }
- },
- "response": {
- "$ref": "AutoscalerList"
- },
- "id": "compute.autoscalers.list"
- },
- "delete": {
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "description": "Deletes the specified autoscaler.",
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- "flatPath": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- "id": "compute.autoscalers.delete",
- "parameters": {
- "project": {
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "zone": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the zone for this request.",
- "type": "string",
- "location": "path"
- },
- "autoscaler": {
- "description": "Name of the autoscaler to delete.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
- },
- "response": {
- "$ref": "Operation"
- }
- },
- "get": {
- "parameterOrder": [
- "project",
- "zone",
- "autoscaler"
- ],
- "parameters": {
- "project": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "zone": {
- "required": true,
- "description": "Name of the zone for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "autoscaler": {
- "description": "Name of the autoscaler to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "Autoscaler"
- },
- "flatPath": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
- "id": "compute.autoscalers.get",
- "description": "Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "insert": {
- "httpMethod": "POST",
- "id": "compute.autoscalers.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Creates an autoscaler in the specified project using the data included in the request.",
- "path": "projects/{project}/zones/{zone}/autoscalers",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "flatPath": "projects/{project}/zones/{zone}/autoscalers",
- "request": {
- "$ref": "Autoscaler"
- },
- "parameters": {
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "Name of the zone for this request.",
- "type": "string",
- "location": "path"
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string"
- }
- }
- },
- "aggregatedList": {
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/aggregated/autoscalers",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "AutoscalerAggregatedList"
- },
- "id": "compute.autoscalers.aggregatedList",
- "httpMethod": "GET",
- "description": "Retrieves an aggregated list of autoscalers.",
- "path": "projects/{project}/aggregated/autoscalers",
- "parameters": {
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "maxResults": {
- "default": "500",
- "location": "query",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "minimum": "0"
- },
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query",
- "type": "boolean"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- }
- }
- }
- }
- },
- "nodeTemplates": {
- "methods": {
- "insert": {
- "response": {
- "$ref": "Operation"
- },
- "description": "Creates a NodeTemplate resource in the specified project using the data included in the request.",
- "flatPath": "projects/{project}/regions/{region}/nodeTemplates",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "region": {
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
- }
- },
- "request": {
- "$ref": "NodeTemplate"
- },
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/nodeTemplates",
- "id": "compute.nodeTemplates.insert",
- "parameterOrder": [
- "project",
- "region"
- ]
- },
- "delete": {
- "parameters": {
- "project": {
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request."
- },
- "nodeTemplate": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the NodeTemplate resource to delete."
- },
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the region for this request.",
- "type": "string",
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
- },
- "path": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
- "description": "Deletes the specified NodeTemplate resource.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
- "id": "compute.nodeTemplates.delete",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "DELETE",
- "parameterOrder": [
- "project",
- "region",
- "nodeTemplate"
- ]
- },
- "get": {
- "response": {
- "$ref": "NodeTemplate"
- },
- "parameters": {
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "description": "The name of the region for this request.",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string"
- },
- "nodeTemplate": {
- "location": "path",
- "required": true,
- "description": "Name of the node template to return.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "region",
- "nodeTemplate"
- ],
- "httpMethod": "GET",
- "path": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
- "id": "compute.nodeTemplates.get",
- "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
- "description": "Returns the specified node template. Gets a list of available node templates by making a list() request."
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "region"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Retrieves a list of node templates available to the specified project.",
- "path": "projects/{project}/regions/{region}/nodeTemplates",
- "flatPath": "projects/{project}/regions/{region}/nodeTemplates",
- "parameters": {
- "maxResults": {
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "minimum": "0",
- "type": "integer",
- "default": "500"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "region": {
- "location": "path",
- "description": "The name of the region for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
- }
- },
- "response": {
- "$ref": "NodeTemplateList"
- },
- "id": "compute.nodeTemplates.list"
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true
- },
- "resource": {
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "optionsRequestedPolicyVersion": {
- "location": "query",
- "format": "int32",
- "description": "Requested IAM Policy version.",
- "type": "integer"
- },
- "region": {
- "required": true,
- "description": "The name of the region for this request.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
- },
- "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy",
- "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy",
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "id": "compute.nodeTemplates.getIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET"
- },
- "aggregatedList": {
- "description": "Retrieves an aggregated list of node templates.",
- "flatPath": "projects/{project}/aggregated/nodeTemplates",
- "path": "projects/{project}/aggregated/nodeTemplates",
- "parameters": {
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query",
- "type": "boolean"
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "default": "500",
- "format": "uint32"
- },
- "project": {
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- }
- },
- "response": {
- "$ref": "NodeTemplateAggregatedList"
- },
- "parameterOrder": [
- "project"
- ],
- "id": "compute.nodeTemplates.aggregatedList",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "testIamPermissions": {
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "parameters": {
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
- "description": "Name or id of the resource for this request.",
- "type": "string"
- },
- "region": {
- "required": true,
- "location": "path",
- "description": "The name of the region for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Returns permissions that a caller has on the specified resource.",
- "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions",
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "id": "compute.nodeTemplates.testIamPermissions",
- "response": {
- "$ref": "TestPermissionsResponse"
- }
- },
- "setIamPolicy": {
- "id": "compute.nodeTemplates.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "request": {
- "$ref": "RegionSetPolicyRequest"
- },
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy",
- "parameters": {
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string",
- "description": "The name of the region for this request."
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
- },
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "required": true,
- "location": "path"
- }
- }
- }
- }
- },
- "instances": {
- "methods": {
- "getScreenshot": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "instance": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the instance scoping this request."
- },
- "zone": {
- "required": true,
- "description": "The name of the zone for this request.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
- },
- "response": {
- "$ref": "Screenshot"
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/screenshot",
- "description": "Returns the screenshot from the specified instance.",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "httpMethod": "GET",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/screenshot",
- "id": "compute.instances.getScreenshot"
- },
- "listReferrers": {
- "response": {
- "$ref": "InstanceListReferrers"
- },
- "httpMethod": "GET",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/referrers",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "path": "projects/{project}/zones/{zone}/instances/{instance}/referrers",
- "id": "compute.instances.listReferrers",
- "description": "Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "description": "Project ID for this request."
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "instance": {
- "required": true,
- "type": "string",
- "description": "Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.",
- "location": "path",
- "pattern": "-|[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "location": "query",
- "default": "500",
- "type": "integer",
- "format": "uint32"
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "zone": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "type": "string"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- }
- }
- },
- "update": {
- "path": "projects/{project}/zones/{zone}/instances/{instance}",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
- },
- "mostDisruptiveAllowedAction": {
- "enum": [
- "INVALID",
- "NO_EFFECT",
- "REFRESH",
- "RESTART"
- ],
- "type": "string",
- "enumDescriptions": [
- "",
- "No changes can be made to the instance.",
- "The instance will not restart.",
- "The instance will restart."
- ],
- "description": "Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.",
- "location": "query"
- },
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "description": "The name of the zone for this request.",
- "required": true
- },
- "minimalAction": {
- "location": "query",
- "enumDescriptions": [
- "",
- "No changes can be made to the instance.",
- "The instance will not restart.",
- "The instance will restart."
- ],
- "enum": [
- "INVALID",
- "NO_EFFECT",
- "REFRESH",
- "RESTART"
- ],
- "description": "Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require.",
- "type": "string"
- },
- "instance": {
- "required": true,
- "type": "string",
- "description": "Name of the instance resource to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}",
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "Instance"
- },
- "description": "Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.",
- "id": "compute.instances.update"
- },
- "setMinCpuPlatform": {
- "httpMethod": "POST",
- "id": "compute.instances.setMinCpuPlatform",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform",
- "parameters": {
- "instance": {
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the instance scoping this request."
- },
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string",
- "description": "The name of the zone for this request.",
- "location": "path"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "description": "Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "request": {
- "$ref": "InstancesSetMinCpuPlatformRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "setMachineResources": {
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "description": "Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.instances.setMachineResources",
- "parameters": {
- "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).",
- "type": "string",
- "location": "query"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "instance": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the instance scoping this request.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "zone": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources",
- "request": {
- "$ref": "InstancesSetMachineResourcesRequest"
- }
- },
- "sendDiagnosticInterrupt": {
- "path": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt",
- "id": "compute.instances.sendDiagnosticInterrupt",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt",
- "description": "Sends diagnostic interrupt to the instance.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "zone": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "type": "string"
- },
- "instance": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the instance scoping this request.",
- "type": "string"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "httpMethod": "POST"
- },
- "testIamPermissions": {
- "parameters": {
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request."
- },
- "zone": {
- "location": "path",
- "required": true,
- "description": "The name of the zone for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "resource": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name or id of the resource for this request.",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "resource"
- ],
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.",
- "id": "compute.instances.testIamPermissions",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "response": {
- "$ref": "TestPermissionsResponse"
- }
- },
- "removeResourcePolicies": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Removes resource policies from an instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies",
- "request": {
- "$ref": "InstancesRemoveResourcePoliciesRequest"
- },
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies",
- "parameters": {
- "zone": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "The name of the zone for this request."
- },
- "instance": {
- "location": "path",
- "description": "The instance name for this request.",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.instances.removeResourcePolicies",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ]
- },
- "getGuestAttributes": {
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes",
- "response": {
- "$ref": "GuestAttributes"
- },
- "description": "Returns the specified guest attributes entry.",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "zone": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "The name of the zone for this request."
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
- },
- "variableKey": {
- "location": "query",
- "type": "string",
- "description": "Specifies the key for the guest attributes entry."
- },
- "queryPath": {
- "location": "query",
- "type": "string",
- "description": "Specifies the guest attributes path to be queried."
- },
- "instance": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the instance scoping this request."
- }
- },
- "id": "compute.instances.getGuestAttributes"
- },
- "getIamPolicy": {
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request."
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path"
- },
- "resource": {
- "description": "Name or id of the resource for this request.",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "optionsRequestedPolicyVersion": {
- "type": "integer",
- "description": "Requested IAM Policy version.",
- "location": "query",
- "format": "int32"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "Policy"
- },
- "path": "projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy",
- "httpMethod": "GET",
- "id": "compute.instances.getIamPolicy",
- "parameterOrder": [
- "project",
- "zone",
- "resource"
- ]
- },
- "detachDisk": {
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk",
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "deviceName"
- ],
- "parameters": {
- "instance": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Instance name for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "zone": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "type": "string"
- },
- "deviceName": {
- "description": "The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.",
- "type": "string",
- "location": "query",
- "required": true
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "type": "string",
- "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"
- }
- },
- "description": "Detaches a disk from an instance.",
- "id": "compute.instances.detachDisk"
- },
- "setLabels": {
- "description": "Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setLabels",
- "request": {
- "$ref": "InstancesSetLabelsRequest"
- },
- "httpMethod": "POST",
- "parameters": {
- "instance": {
- "location": "path",
- "required": true,
- "description": "Name of the instance scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "zone": {
- "type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
- }
- },
- "id": "compute.instances.setLabels",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setLabels",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ]
- },
- "insert": {
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path"
- },
- "sourceMachineImage": {
- "description": "Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage ",
- "location": "query",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "sourceInstanceTemplate": {
- "description": "Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate ",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "The name of the zone for this request.",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "path": "projects/{project}/zones/{zone}/instances",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instances",
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "Instance"
- },
- "description": "Creates an instance resource in the specified project using the data included in the request.",
- "id": "compute.instances.insert"
- },
- "reset": {
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reset",
- "description": "Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/reset",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "instance": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the instance scoping this request."
- },
- "zone": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "location": "path"
- },
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "id": "compute.instances.reset"
- },
- "addResourcePolicies": {
- "request": {
- "$ref": "InstancesAddResourcePoliciesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.instances.addResourcePolicies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies",
- "httpMethod": "POST",
- "parameters": {
- "zone": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string",
- "description": "The name of the zone for this request."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "instance": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "The instance name for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ]
- },
- "suspend": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/suspend",
- "parameters": {
- "zone": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "description": "The name of the zone for this request."
- },
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "discardLocalSsd": {
- "location": "query",
- "type": "boolean",
- "description": "If true, discard the contents of any attached localSSD partitions. Default value is false."
- },
- "instance": {
- "description": "Name of the instance resource to suspend.",
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "id": "compute.instances.suspend",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/suspend",
- "description": "This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance."
- },
- "resume": {
- "parameters": {
- "zone": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path",
- "description": "The name of the zone for this request."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "instance": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the instance resource to resume.",
- "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).",
- "type": "string",
- "location": "query"
- }
- },
- "id": "compute.instances.resume",
- "description": "Resumes an instance that was suspended using the instances().suspend method.",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/resume",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/resume"
- },
- "startWithEncryptionKey": {
- "httpMethod": "POST",
- "id": "compute.instances.startWithEncryptionKey",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "InstancesStartWithEncryptionKeyRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey",
- "parameters": {
- "instance": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the instance resource to start."
- },
- "project": {
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request."
- },
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "location": "path",
- "required": true,
- "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).",
- "type": "string",
- "location": "query"
- }
- },
- "description": "Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance."
- },
- "setTags": {
- "parameters": {
- "instance": {
- "description": "Name of the instance scoping this request.",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "zone": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request."
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- },
- "description": "Sets network tags for the specified instance to the data included in the request.",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setTags",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "id": "compute.instances.setTags",
- "request": {
- "$ref": "Tags"
- },
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setTags",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "updateShieldedInstanceConfig": {
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "requestId": {
- "type": "string",
- "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"
- },
- "zone": {
- "description": "The name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "type": "string",
- "required": true
- },
- "instance": {
- "description": "Name or id of the instance scoping this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true
- }
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "PATCH",
- "request": {
- "$ref": "ShieldedInstanceConfig"
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "id": "compute.instances.updateShieldedInstanceConfig",
- "description": "Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules."
- },
- "delete": {
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request."
- },
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "The name of the zone for this request."
- },
- "instance": {
- "required": true,
- "description": "Name of the instance resource to delete.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "id": "compute.instances.delete",
- "description": "Deletes the specified Instance resource. For more information, see Deleting an instance.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "getEffectiveFirewalls": {
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "networkInterface"
- ],
- "response": {
- "$ref": "InstancesGetEffectiveFirewallsResponse"
- },
- "parameters": {
- "instance": {
- "type": "string",
- "description": "Name of the instance scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path"
- },
- "zone": {
- "required": true,
- "type": "string",
- "description": "The name of the zone for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "networkInterface": {
- "location": "query",
- "type": "string",
- "description": "The name of the network interface to get the effective firewalls.",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string"
- }
- },
- "httpMethod": "GET",
- "description": "Returns effective firewalls applied to an interface of the instance.",
- "id": "compute.instances.getEffectiveFirewalls",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls"
- },
- "setMetadata": {
- "id": "compute.instances.setMetadata",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "description": "Sets metadata for the specified instance to the data included in the request.",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata",
- "parameters": {
- "zone": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "The name of the zone for this request.",
- "type": "string"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "required": true
- },
- "instance": {
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the instance scoping this request."
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "Metadata"
- },
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata"
- },
- "simulateMaintenanceEvent": {
- "id": "compute.instances.simulateMaintenanceEvent",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent",
- "parameters": {
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string",
- "description": "The name of the zone for this request.",
- "location": "path"
- },
- "project": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "instance": {
- "description": "Name of the instance scoping this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "description": "Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "getSerialPortOutput": {
- "id": "compute.instances.getSerialPortOutput",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "httpMethod": "GET",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "start": {
- "type": "string",
- "location": "query",
- "description": "Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`. If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console.",
- "format": "int64"
- },
- "port": {
- "format": "int32",
- "default": "1",
- "minimum": "1",
- "description": "Specifies which COM or serial port to retrieve data from.",
- "location": "query",
- "type": "integer",
- "maximum": "4"
- },
- "instance": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the instance for this request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "The name of the zone for this request.",
- "type": "string"
- }
- },
- "response": {
- "$ref": "SerialPortOutput"
- },
- "description": "Returns the last 1 MB of serial port output from the specified instance.",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/serialPort",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/serialPort",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "setScheduling": {
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.instances.setScheduling",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "request": {
- "$ref": "Scheduling"
- },
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling",
- "parameters": {
- "instance": {
- "description": "Instance name for this request.",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string"
- },
- "zone": {
- "description": "The name of the zone for this request.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling",
- "description": "Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy."
+ "limit": {
+ "format": "double",
+ "description": "[Output Only] Quota limit for this metric.",
+ "type": "number"
},
- "deleteAccessConfig": {
- "description": "Deletes an access config from an instance's network interface.",
- "parameters": {
- "zone": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "The name of the zone for this request."
- },
- "instance": {
- "location": "path",
- "description": "The instance name for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- },
- "networkInterface": {
- "type": "string",
- "required": true,
- "description": "The name of the network interface.",
- "location": "query"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "accessConfig": {
- "type": "string",
- "description": "The name of the access config to delete.",
- "location": "query",
- "required": true
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "accessConfig",
- "networkInterface"
- ],
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
- "id": "compute.instances.deleteAccessConfig"
+ "usage": {
+ "description": "[Output Only] Current usage of this metric.",
+ "type": "number",
+ "format": "double"
},
- "list": {
- "parameters": {
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "type": "integer",
- "location": "query",
- "minimum": "0",
- "default": "500",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "zone": {
- "location": "path",
- "required": true,
- "description": "The name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- }
- },
- "description": "Retrieves the list of instances contained within the specified zone.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "metric": {
+ "description": "[Output Only] Name of the quota metric.",
+ "type": "string",
+ "enum": [
+ "A2_CPUS",
+ "AFFINITY_GROUPS",
+ "AUTOSCALERS",
+ "BACKEND_BUCKETS",
+ "BACKEND_SERVICES",
+ "C2D_CPUS",
+ "C2_CPUS",
+ "C3_CPUS",
+ "COMMITMENTS",
+ "COMMITTED_A2_CPUS",
+ "COMMITTED_C2D_CPUS",
+ "COMMITTED_C2_CPUS",
+ "COMMITTED_C3_CPUS",
+ "COMMITTED_CPUS",
+ "COMMITTED_E2_CPUS",
+ "COMMITTED_LICENSES",
+ "COMMITTED_LOCAL_SSD_TOTAL_GB",
+ "COMMITTED_M3_CPUS",
+ "COMMITTED_MEMORY_OPTIMIZED_CPUS",
+ "COMMITTED_N2A_CPUS",
+ "COMMITTED_N2D_CPUS",
+ "COMMITTED_N2_CPUS",
+ "COMMITTED_NVIDIA_A100_80GB_GPUS",
+ "COMMITTED_NVIDIA_A100_GPUS",
+ "COMMITTED_NVIDIA_K80_GPUS",
+ "COMMITTED_NVIDIA_P100_GPUS",
+ "COMMITTED_NVIDIA_P4_GPUS",
+ "COMMITTED_NVIDIA_T4_GPUS",
+ "COMMITTED_NVIDIA_V100_GPUS",
+ "COMMITTED_T2A_CPUS",
+ "COMMITTED_T2D_CPUS",
+ "CPUS",
+ "CPUS_ALL_REGIONS",
+ "DISKS_TOTAL_GB",
+ "E2_CPUS",
+ "EXTERNAL_MANAGED_FORWARDING_RULES",
+ "EXTERNAL_NETWORK_LB_FORWARDING_RULES",
+ "EXTERNAL_PROTOCOL_FORWARDING_RULES",
+ "EXTERNAL_VPN_GATEWAYS",
+ "FIREWALLS",
+ "FORWARDING_RULES",
+ "GLOBAL_EXTERNAL_MANAGED_BACKEND_SERVICES",
+ "GLOBAL_EXTERNAL_MANAGED_FORWARDING_RULES",
+ "GLOBAL_EXTERNAL_PROXY_LB_BACKEND_SERVICES",
+ "GLOBAL_INTERNAL_ADDRESSES",
+ "GLOBAL_INTERNAL_MANAGED_BACKEND_SERVICES",
+ "GLOBAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES",
+ "GPUS_ALL_REGIONS",
+ "HEALTH_CHECKS",
+ "IMAGES",
+ "INSTANCES",
+ "INSTANCE_GROUPS",
+ "INSTANCE_GROUP_MANAGERS",
+ "INSTANCE_TEMPLATES",
+ "INTERCONNECTS",
+ "INTERCONNECT_ATTACHMENTS_PER_REGION",
+ "INTERCONNECT_ATTACHMENTS_TOTAL_MBPS",
+ "INTERCONNECT_TOTAL_GBPS",
+ "INTERNAL_ADDRESSES",
+ "INTERNAL_TRAFFIC_DIRECTOR_FORWARDING_RULES",
+ "IN_PLACE_SNAPSHOTS",
+ "IN_USE_ADDRESSES",
+ "IN_USE_BACKUP_SCHEDULES",
+ "IN_USE_SNAPSHOT_SCHEDULES",
+ "LOCAL_SSD_TOTAL_GB",
+ "M1_CPUS",
+ "M2_CPUS",
+ "M3_CPUS",
+ "MACHINE_IMAGES",
+ "N2A_CPUS",
+ "N2D_CPUS",
+ "N2_CPUS",
+ "NETWORKS",
+ "NETWORK_ENDPOINT_GROUPS",
+ "NETWORK_FIREWALL_POLICIES",
+ "NODE_GROUPS",
+ "NODE_TEMPLATES",
+ "NVIDIA_A100_80GB_GPUS",
+ "NVIDIA_A100_GPUS",
+ "NVIDIA_K80_GPUS",
+ "NVIDIA_P100_GPUS",
+ "NVIDIA_P100_VWS_GPUS",
+ "NVIDIA_P4_GPUS",
+ "NVIDIA_P4_VWS_GPUS",
+ "NVIDIA_T4_GPUS",
+ "NVIDIA_T4_VWS_GPUS",
+ "NVIDIA_V100_GPUS",
+ "PACKET_MIRRORINGS",
+ "PD_EXTREME_TOTAL_PROVISIONED_IOPS",
+ "PREEMPTIBLE_CPUS",
+ "PREEMPTIBLE_LOCAL_SSD_GB",
+ "PREEMPTIBLE_NVIDIA_A100_80GB_GPUS",
+ "PREEMPTIBLE_NVIDIA_A100_GPUS",
+ "PREEMPTIBLE_NVIDIA_K80_GPUS",
+ "PREEMPTIBLE_NVIDIA_P100_GPUS",
+ "PREEMPTIBLE_NVIDIA_P100_VWS_GPUS",
+ "PREEMPTIBLE_NVIDIA_P4_GPUS",
+ "PREEMPTIBLE_NVIDIA_P4_VWS_GPUS",
+ "PREEMPTIBLE_NVIDIA_T4_GPUS",
+ "PREEMPTIBLE_NVIDIA_T4_VWS_GPUS",
+ "PREEMPTIBLE_NVIDIA_V100_GPUS",
+ "PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK",
+ "PSC_INTERNAL_LB_FORWARDING_RULES",
+ "PUBLIC_ADVERTISED_PREFIXES",
+ "PUBLIC_DELEGATED_PREFIXES",
+ "REGIONAL_AUTOSCALERS",
+ "REGIONAL_EXTERNAL_MANAGED_BACKEND_SERVICES",
+ "REGIONAL_EXTERNAL_NETWORK_LB_BACKEND_SERVICES",
+ "REGIONAL_INSTANCE_GROUP_MANAGERS",
+ "REGIONAL_INTERNAL_LB_BACKEND_SERVICES",
+ "REGIONAL_INTERNAL_MANAGED_BACKEND_SERVICES",
+ "RESERVATIONS",
+ "RESOURCE_POLICIES",
+ "ROUTERS",
+ "ROUTES",
+ "SECURITY_POLICIES",
+ "SECURITY_POLICIES_PER_REGION",
+ "SECURITY_POLICY_CEVAL_RULES",
+ "SECURITY_POLICY_RULES",
+ "SECURITY_POLICY_RULES_PER_REGION",
+ "SERVICE_ATTACHMENTS",
+ "SNAPSHOTS",
+ "SSD_TOTAL_GB",
+ "SSL_CERTIFICATES",
+ "STATIC_ADDRESSES",
+ "STATIC_BYOIP_ADDRESSES",
+ "STATIC_EXTERNAL_IPV6_ADDRESS_RANGES",
+ "SUBNETWORKS",
+ "T2A_CPUS",
+ "T2D_CPUS",
+ "TARGET_HTTPS_PROXIES",
+ "TARGET_HTTP_PROXIES",
+ "TARGET_INSTANCES",
+ "TARGET_POOLS",
+ "TARGET_SSL_PROXIES",
+ "TARGET_TCP_PROXIES",
+ "TARGET_VPN_GATEWAYS",
+ "URL_MAPS",
+ "VPN_GATEWAYS",
+ "VPN_TUNNELS",
+ "XPN_SERVICE_PROJECTS"
],
- "response": {
- "$ref": "InstanceList"
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "Guest CPUs",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "The total number of snapshots allowed for a single project.",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ]
+ }
+ },
+ "type": "object",
+ "id": "Quota",
+ "description": "A quotas entry."
+ },
+ "DistributionPolicy": {
+ "properties": {
+ "zones": {
+ "type": "array",
+ "items": {
+ "$ref": "DistributionPolicyZoneConfiguration"
},
- "parameterOrder": [
- "project",
- "zone"
- ],
- "httpMethod": "GET",
- "path": "projects/{project}/zones/{zone}/instances",
- "id": "compute.instances.list",
- "flatPath": "projects/{project}/zones/{zone}/instances"
+ "description": "Zones where the regional managed instance group will create and manage its instances."
},
- "setServiceAccount": {
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
+ "targetShape": {
+ "enum": [
+ "ANY",
+ "BALANCED",
+ "EVEN"
],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount",
- "id": "compute.instances.setServiceAccount",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).",
+ "enumDescriptions": [
+ "The group picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.",
+ "The group prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across selected zones to minimize the impact of zonal failure. Recommended for highly available serving workloads.",
+ "The group schedules VM instance creation and deletion to achieve and maintain an even number of managed instances across the selected zones. The distribution is even when the number of managed instances does not differ by more than 1 between any two zones. Recommended for highly available serving workloads."
],
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "zone": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "The name of the zone for this request."
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "instance": {
- "description": "Name of the instance resource to start.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "request": {
- "$ref": "InstancesSetServiceAccountRequest"
- },
- "description": "Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance."
- },
- "attachDisk": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "DistributionPolicy"
+ },
+ "RegionInstanceGroupManagersApplyUpdatesRequest": {
+ "description": "RegionInstanceGroupManagers.applyUpdatesToInstances",
+ "id": "RegionInstanceGroupManagersApplyUpdatesRequest",
+ "properties": {
+ "minimalAction": {
+ "enum": [
+ "NONE",
+ "REFRESH",
+ "REPLACE",
+ "RESTART"
],
- "parameters": {
- "instance": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "description": "The instance name for this request.",
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "forceAttach": {
- "location": "query",
- "type": "boolean",
- "description": "Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error."
- },
- "zone": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "description": "The name of the zone for this request."
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "required": true
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.instances.attachDisk",
- "description": "Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.",
- "request": {
- "$ref": "AttachedDisk"
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk",
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
+ "enumDescriptions": [
+ "Do not perform any action.",
+ "Updates applied in runtime, instances will not be disrupted.",
+ "Old instances will be deleted. New instances will be created from the target template.",
+ "Every instance will be restarted."
],
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk"
+ "type": "string",
+ "description": "The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update."
},
- "updateNetworkInterface": {
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface",
- "request": {
- "$ref": "NetworkInterface"
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface",
- "httpMethod": "PATCH",
- "parameters": {
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string"
- },
- "zone": {
- "required": true,
- "location": "path",
- "description": "The name of the zone for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "instance": {
- "location": "path",
- "required": true,
- "description": "The instance name for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- },
- "networkInterface": {
- "required": true,
- "type": "string",
- "location": "query",
- "description": "The name of the network interface to update."
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
- },
- "description": "Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "networkInterface"
+ "mostDisruptiveAllowedAction": {
+ "type": "string",
+ "description": "The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.",
+ "enum": [
+ "NONE",
+ "REFRESH",
+ "REPLACE",
+ "RESTART"
],
- "id": "compute.instances.updateNetworkInterface"
+ "enumDescriptions": [
+ "Do not perform any action.",
+ "Updates applied in runtime, instances will not be disrupted.",
+ "Old instances will be deleted. New instances will be created from the target template.",
+ "Every instance will be restarted."
+ ]
},
- "updateDisplayDevice": {
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "httpMethod": "PATCH",
- "description": "Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "id": "compute.instances.updateDisplayDevice",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice",
- "request": {
- "$ref": "DisplayDevice"
+ "allInstances": {
+ "description": "Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.",
+ "type": "boolean"
+ },
+ "instances": {
+ "items": {
+ "type": "string"
},
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "type": "array",
+ "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]."
+ }
+ },
+ "type": "object"
+ },
+ "ManagedInstanceVersion": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "[Output Only] Name of the version.",
+ "type": "string"
+ },
+ "instanceTemplate": {
+ "type": "string",
+ "description": "[Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }."
+ }
+ },
+ "id": "ManagedInstanceVersion"
+ },
+ "RegionList": {
+ "type": "object",
+ "id": "RegionList",
+ "description": "Contains a list of region resources.",
+ "properties": {
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#regionList",
+ "description": "[Output Only] Type of resource. Always compute#regionList for lists of regions."
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "type": "array"
},
- "instance": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
+ "message": {
"type": "string",
- "description": "Name of the instance scoping this request."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "zone": {
- "required": true,
- "location": "path",
- "description": "The name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string"
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request."
}
}
},
- "stop": {
- "path": "projects/{project}/zones/{zone}/instances/{instance}/stop",
- "httpMethod": "POST",
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "instance": {
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the instance resource to stop."
- },
- "discardLocalSsd": {
- "location": "query",
- "description": "If true, discard the contents of any attached localSSD partitions. Default value is false.",
- "type": "boolean"
- },
- "zone": {
- "description": "The name of the zone for this request.",
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
- }
- },
- "description": "Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "id": "compute.instances.stop",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/stop"
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
},
- "setMachineType": {
- "id": "compute.instances.setMachineType",
- "response": {
- "$ref": "Operation"
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "Region"
},
- "request": {
- "$ref": "InstancesSetMachineTypeRequest"
+ "description": "A list of Region resources."
+ }
+ }
+ },
+ "UrlMap": {
+ "description": "Represents a URL Map resource. Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.",
+ "id": "UrlMap",
+ "properties": {
+ "defaultUrlRedirect": {
+ "description": "When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.",
+ "$ref": "HttpRedirectAction"
+ },
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#urlMaps for url maps.",
+ "type": "string",
+ "default": "compute#urlMap"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "pathMatchers": {
+ "type": "array",
+ "description": "The list of named PathMatchers to use against the URL.",
+ "items": {
+ "$ref": "PathMatcher"
+ }
+ },
+ "defaultService": {
+ "description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.",
+ "type": "string"
+ },
+ "tests": {
+ "type": "array",
+ "description": "The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.",
+ "items": {
+ "$ref": "UrlMapTest"
+ }
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "name": {
+ "description": "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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "defaultRouteAction": {
+ "description": "defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.",
+ "$ref": "HttpRouteAction"
+ },
+ "hostRules": {
+ "description": "The list of host rules to use against the URL.",
+ "type": "array",
+ "items": {
+ "$ref": "HostRule"
+ }
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "fingerprint": {
+ "type": "string",
+ "format": "byte",
+ "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap."
+ },
+ "headerAction": {
+ "description": "Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.",
+ "$ref": "HttpHeaderAction"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ForwardingRulesScopedList": {
+ "type": "object",
+ "id": "ForwardingRulesScopedList",
+ "properties": {
+ "forwardingRules": {
+ "description": "A list of forwarding rules contained in this scope.",
+ "items": {
+ "$ref": "ForwardingRule"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType",
- "description": "Changes the machine type for a stopped instance to the machine type specified in the request.",
- "parameters": {
- "instance": {
+ "type": "array"
+ },
+ "warning": {
+ "properties": {
+ "code": {
"type": "string",
- "location": "path",
- "description": "Name of the instance scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "requestId": {
- "type": "string",
- "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"
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ }
},
- "project": {
- "location": "path",
+ "message": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
- },
- "zone": {
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "type": "string"
+ "description": "[Output Only] A human-readable description of the warning code."
}
- }
- },
- "setShieldedInstanceIntegrityPolicy": {
- "id": "compute.instances.setShieldedInstanceIntegrityPolicy",
- "description": "Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "httpMethod": "PATCH",
- "response": {
- "$ref": "Operation"
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request."
- },
- "zone": {
+ "type": "object",
+ "description": "Informational warning which replaces the list of forwarding rules when the list is empty."
+ }
+ }
+ },
+ "TargetPoolsRemoveInstanceRequest": {
+ "id": "TargetPoolsRemoveInstanceRequest",
+ "type": "object",
+ "properties": {
+ "instances": {
+ "description": "URLs of the instances to be removed from target pool.",
+ "items": {
+ "$ref": "InstanceReference"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "FirewallList": {
+ "properties": {
+ "items": {
+ "description": "A list of Firewall resources.",
+ "items": {
+ "$ref": "Firewall"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#firewallList",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#firewallList for lists of firewalls."
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
"type": "string",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "requestId": {
+ "message": {
"type": "string",
- "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"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "instance": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name or id of the instance scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
}
- },
- "request": {
- "$ref": "ShieldedInstanceIntegrityPolicy"
}
+ }
+ },
+ "id": "FirewallList",
+ "type": "object",
+ "description": "Contains a list of firewalls."
+ },
+ "NodeGroupsSetNodeTemplateRequest": {
+ "properties": {
+ "nodeTemplate": {
+ "type": "string",
+ "description": "Full or partial URL of the node template resource to be updated for this node group."
+ }
+ },
+ "type": "object",
+ "id": "NodeGroupsSetNodeTemplateRequest"
+ },
+ "InstanceListReferrers": {
+ "description": "Contains a list of instance referrers.",
+ "id": "InstanceListReferrers",
+ "properties": {
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
},
- "get": {
- "path": "projects/{project}/zones/{zone}/instances/{instance}",
- "parameters": {
- "instance": {
- "required": true,
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "Reference"
+ },
+ "description": "A list of Reference resources."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.",
+ "default": "compute#instanceListReferrers",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "message": {
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the instance resource to return.",
- "location": "path"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "project": {
- "required": true,
- "description": "Project ID for this request.",
+ "code": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "required": true,
- "description": "The name of the zone for this request."
+ "data": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
},
- "response": {
- "$ref": "Instance"
- },
- "description": "Returns the specified Instance resource. Gets a list of available instances by making a list() request.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}",
- "httpMethod": "GET",
- "id": "compute.instances.get"
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "ScalingScheduleStatus": {
+ "type": "object",
+ "properties": {
+ "lastStartTime": {
+ "type": "string",
+ "description": "[Output Only] The last time the scaling schedule became active. Note: this is a timestamp when a schedule actually became active, not when it was planned to do so. The timestamp is in RFC3339 text format."
},
- "setDiskAutoDelete": {
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "nextStartTime": {
+ "description": "[Output Only] The next time the scaling schedule is to become active. Note: this is a timestamp when a schedule is planned to run, but the actual time might be slightly different. The timestamp is in RFC3339 text format.",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "The current autoscaling recommendation is influenced by this scaling schedule.",
+ "This scaling schedule has been disabled by the user.",
+ "This scaling schedule will never become active again.",
+ "The current autoscaling recommendation is not influenced by this scaling schedule."
],
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "autoDelete",
- "deviceName"
+ "type": "string",
+ "description": "[Output Only] The current state of a scaling schedule.",
+ "enum": [
+ "ACTIVE",
+ "DISABLED",
+ "OBSOLETE",
+ "READY"
+ ]
+ }
+ },
+ "id": "ScalingScheduleStatus"
+ },
+ "SslPoliciesListAvailableFeaturesResponse": {
+ "id": "SslPoliciesListAvailableFeaturesResponse",
+ "type": "object",
+ "properties": {
+ "features": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "SecurityPolicy": {
+ "description": "Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.",
+ "type": "object",
+ "id": "SecurityPolicy",
+ "properties": {
+ "recaptchaOptionsConfig": {
+ "$ref": "SecurityPolicyRecaptchaOptionsConfig"
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.",
+ "type": "string",
+ "format": "byte"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "adaptiveProtectionConfig": {
+ "$ref": "SecurityPolicyAdaptiveProtectionConfig"
+ },
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
],
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
- "id": "compute.instances.setDiskAutoDelete",
- "parameters": {
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "instance": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "The instance name for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "deviceName": {
- "required": true,
- "pattern": "\\w[\\w.-]{0,254}",
- "type": "string",
- "location": "query",
- "description": "The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names."
- },
- "zone": {
- "description": "The name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "autoDelete": {
- "type": "boolean",
- "location": "query",
- "required": true,
- "description": "Whether to auto-delete the disk when the instance is deleted."
- }
+ "description": "The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. This field can be set only at resource creation time.",
+ "enum": [
+ "CLOUD_ARMOR",
+ "CLOUD_ARMOR_EDGE",
+ "CLOUD_ARMOR_NETWORK"
+ ]
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#securityPolicy",
+ "description": "[Output only] Type of the resource. Always compute#securityPolicyfor security policies"
+ },
+ "name": {
+ "description": "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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "ddosProtectionConfig": {
+ "$ref": "SecurityPolicyDdosProtectionConfig"
+ },
+ "region": {
+ "description": "[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.",
+ "type": "string"
+ },
+ "advancedOptionsConfig": {
+ "$ref": "SecurityPolicyAdvancedOptionsConfig"
+ },
+ "rules": {
+ "items": {
+ "$ref": "SecurityPolicyRule"
},
- "description": "Sets the auto-delete flag for a disk attached to an instance.",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete"
+ "description": "A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match \"*\" for srcIpRanges and for the networkMatch condition every field must be either match \"*\" or not set). If no rules are provided when creating a security policy, a default rule with action \"allow\" will be added.",
+ "type": "array"
},
- "setDeletionProtection": {
- "parameterOrder": [
- "project",
- "zone",
- "resource"
- ],
- "parameters": {
- "resource": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name or id of the resource for this request.",
- "required": true,
- "location": "path"
- },
- "zone": {
- "description": "The name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "deletionProtection": {
- "type": "boolean",
- "description": "Whether the resource should be protected against deletion.",
- "default": "true",
- "location": "query"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
- }
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ }
+ }
+ },
+ "DisksAddResourcePoliciesRequest": {
+ "type": "object",
+ "properties": {
+ "resourcePolicies": {
+ "items": {
+ "type": "string"
},
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection",
- "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection",
- "description": "Sets deletion protection on the instance.",
- "id": "compute.instances.setDeletionProtection",
- "response": {
- "$ref": "Operation"
+ "description": "Full or relative path to the resource policy to be added to this disk. You can only specify one resource policy.",
+ "type": "array"
+ }
+ },
+ "id": "DisksAddResourcePoliciesRequest"
+ },
+ "ResourceGroupReference": {
+ "type": "object",
+ "properties": {
+ "group": {
+ "description": "A URI referencing one of the instance groups or network endpoint groups listed in the backend service.",
+ "type": "string"
+ }
+ },
+ "id": "ResourceGroupReference"
+ },
+ "InterconnectOutageNotification": {
+ "type": "object",
+ "id": "InterconnectOutageNotification",
+ "description": "Description of a planned outage on this Interconnect.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "A description about the purpose of the outage."
+ },
+ "affectedCircuits": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.",
+ "type": "array"
+ },
+ "issueType": {
+ "enum": [
+ "IT_OUTAGE",
+ "IT_PARTIAL_OUTAGE",
+ "OUTAGE",
+ "PARTIAL_OUTAGE"
+ ],
+ "description": "Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with \"IT_\" have been deprecated in favor of the unprefixed values.",
+ "type": "string",
+ "enumDescriptions": [
+ "[Deprecated] The Interconnect may be completely out of service for some or all of the specified window.",
+ "[Deprecated] Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth.",
+ "The Interconnect may be completely out of service for some or all of the specified window.",
+ "Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth."
]
},
- "start": {
- "id": "compute.instances.start",
- "description": "Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "endTime": {
+ "description": "Scheduled end time for the outage (milliseconds since Unix epoch).",
+ "type": "string",
+ "format": "int64"
+ },
+ "name": {
+ "description": "Unique identifier for this outage notification.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "int64",
+ "description": "Scheduled start time for the outage (milliseconds since Unix epoch).",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with \"NS_\" have been deprecated in favor of the unprefixed values.",
+ "enum": [
+ "ACTIVE",
+ "CANCELLED",
+ "COMPLETED",
+ "NS_ACTIVE",
+ "NS_CANCELED"
],
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/start",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/start",
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
+ "enumDescriptions": [
+ "This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.",
+ "The outage associated with this notification was cancelled before the outage was due to start.",
+ "The outage associated with this notification is complete.",
+ "[Deprecated] This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.",
+ "[Deprecated] The outage associated with this notification was canceled before the outage was due to start."
],
- "parameters": {
- "zone": {
- "required": true,
- "location": "path",
- "description": "The name of the zone for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "instance": {
- "description": "Name of the instance resource to start.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string"
- }
+ "type": "string"
+ },
+ "source": {
+ "enum": [
+ "GOOGLE",
+ "NSRC_GOOGLE"
+ ],
+ "description": "The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.",
+ "type": "string",
+ "enumDescriptions": [
+ "This notification was generated by Google.",
+ "[Deprecated] This notification was generated by Google."
+ ]
+ }
+ }
+ },
+ "VpnTunnel": {
+ "properties": {
+ "peerIp": {
+ "description": "IP address of the peer VPN gateway. Only IPv4 is supported.",
+ "type": "string"
+ },
+ "targetVpnGateway": {
+ "description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
+ "default": "compute#vpnTunnel"
+ },
+ "peerExternalGatewayInterface": {
+ "format": "int32",
+ "type": "integer",
+ "description": "The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type."
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "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.",
+ "annotations": {
+ "required": [
+ "compute.vpnTunnels.insert"
+ ]
}
},
- "aggregatedList": {
- "description": "Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.",
- "flatPath": "projects/{project}/aggregated/instances",
- "response": {
- "$ref": "InstanceAggregatedList"
- },
- "id": "compute.instances.aggregatedList",
- "parameters": {
- "maxResults": {
- "minimum": "0",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "includeAllScopes": {
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean"
- }
+ "region": {
+ "description": "[Output Only] URL of the region where the VPN tunnel 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"
+ },
+ "remoteTrafficSelector": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/aggregated/instances",
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET"
+ "description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.",
+ "type": "array"
},
- "setIamPolicy": {
- "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy",
- "request": {
- "$ref": "ZoneSetPolicyRequest"
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "sharedSecret": {
+ "type": "string",
+ "description": "Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway."
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "router": {
+ "type": "string",
+ "description": "URL of the router resource to be used for dynamic routing."
+ },
+ "peerGcpGateway": {
+ "type": "string",
+ "description": "URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway."
+ },
+ "peerExternalGateway": {
+ "description": "URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.",
+ "type": "string"
+ },
+ "sharedSecretHash": {
+ "type": "string",
+ "description": "Hash of the shared secret."
+ },
+ "vpnGatewayInterface": {
+ "format": "int32",
+ "type": "integer",
+ "description": "The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`."
+ },
+ "localTrafficSelector": {
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "zone",
- "resource"
+ "type": "array",
+ "description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported."
+ },
+ "detailedStatus": {
+ "type": "string",
+ "description": "[Output Only] Detailed status message for the VPN tunnel."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "ikeVersion": {
+ "type": "integer",
+ "format": "int32",
+ "description": "IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2."
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "status": {
+ "enum": [
+ "ALLOCATING_RESOURCES",
+ "AUTHORIZATION_ERROR",
+ "DEPROVISIONING",
+ "ESTABLISHED",
+ "FAILED",
+ "FIRST_HANDSHAKE",
+ "NEGOTIATION_FAILURE",
+ "NETWORK_ERROR",
+ "NO_INCOMING_PACKETS",
+ "PROVISIONING",
+ "REJECTED",
+ "STOPPED",
+ "WAITING_FOR_FULL_CONFIG"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "Cloud VPN is in the process of allocating all required resources (specifically, a borg task).",
+ "Auth error (e.g. bad shared secret).",
+ "Resources is being deallocated for the VPN tunnel.",
+ "Secure session is successfully established with peer VPN.",
+ "Tunnel creation has failed and the tunnel is not ready to be used.",
+ "Successful first handshake with peer VPN.",
+ "Handshake failed.",
+ "Deprecated, replaced by NO_INCOMING_PACKETS",
+ "No incoming packets from peer",
+ "Resource is being allocated for the VPN tunnel.",
+ "Tunnel configuration was rejected, can be result of being denylisted.",
+ "Tunnel is stopped due to its Forwarding Rules being deleted.",
+ "Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel."
],
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy",
- "id": "compute.instances.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true
- },
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "The name of the zone for this request.",
- "type": "string",
- "location": "path"
- },
- "resource": {
- "required": true,
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- }
- },
- "response": {
- "$ref": "Policy"
+ "type": "string",
+ "description": "[Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. "
+ },
+ "vpnGateway": {
+ "description": "URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.",
+ "type": "string"
+ }
+ },
+ "id": "VpnTunnel",
+ "type": "object",
+ "description": "Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview."
+ },
+ "PacketMirroringForwardingRuleInfo": {
+ "id": "PacketMirroringForwardingRuleInfo",
+ "type": "object",
+ "properties": {
+ "canonicalUrl": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the forwarding rule; defined by the server."
+ },
+ "url": {
+ "description": "Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic.",
+ "type": "string"
+ }
+ }
+ },
+ "RouterStatusBgpPeerStatus": {
+ "id": "RouterStatusBgpPeerStatus",
+ "properties": {
+ "advertisedRoutes": {
+ "type": "array",
+ "description": "Routes that were advertised to the remote BGP peer",
+ "items": {
+ "$ref": "Route"
}
},
- "getShieldedInstanceIdentity": {
- "id": "compute.instances.getShieldedInstanceIdentity",
- "httpMethod": "GET",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity",
- "description": "Returns the Shielded Instance Identity of an instance",
- "response": {
- "$ref": "ShieldedInstanceIdentity"
- },
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "instance": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "description": "Name or id of the instance scoping this request.",
- "location": "path"
- },
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "type": "string",
- "required": true,
- "description": "The name of the zone for this request."
- }
- },
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
+ "bfdStatus": {
+ "$ref": "BfdStatus"
+ },
+ "linkedVpnTunnel": {
+ "description": "URL of the VPN tunnel that this BGP peer controls.",
+ "type": "string"
+ },
+ "numLearnedRoutes": {
+ "description": "Number of routes learned from the remote BGP Peer.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "uptime": {
+ "description": "Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds",
+ "type": "string"
+ },
+ "ipv6NexthopAddress": {
+ "type": "string",
+ "description": "IPv6 address of the local BGP interface."
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the BGP session. For a list of possible values for this field, see BGP session states."
+ },
+ "peerIpv6NexthopAddress": {
+ "description": "IPv6 address of the remote BGP interface.",
+ "type": "string"
+ },
+ "ipAddress": {
+ "type": "string",
+ "description": "IP address of the local BGP interface."
+ },
+ "status": {
+ "description": "Status of the BGP peer: {UP, DOWN}",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enum": [
+ "DOWN",
+ "UNKNOWN",
+ "UP"
]
},
- "bulkInsert": {
- "id": "compute.instances.bulkInsert",
- "path": "projects/{project}/zones/{zone}/instances/bulkInsert",
- "parameterOrder": [
- "project",
- "zone"
+ "md5AuthEnabled": {
+ "description": "Informs whether MD5 authentication is enabled on this BGP peer.",
+ "type": "boolean"
+ },
+ "routerApplianceInstance": {
+ "type": "string",
+ "description": "[Output only] URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance is the peer side of the BGP session."
+ },
+ "uptimeSeconds": {
+ "type": "string",
+ "description": "Time this session has been up, in seconds. Format: 145"
+ },
+ "name": {
+ "description": "Name of this BGP peer. Unique within the Routers resource.",
+ "type": "string"
+ },
+ "enableIpv6": {
+ "type": "boolean",
+ "description": "Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default."
+ },
+ "statusReason": {
+ "enum": [
+ "MD5_AUTH_INTERNAL_PROBLEM",
+ "STATUS_REASON_UNSPECIFIED"
],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/instances/bulkInsert",
- "request": {
- "$ref": "BulkInsertInstanceResource"
- },
- "description": "Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "Indicates why particular status was returned.",
+ "enumDescriptions": [
+ "Indicates internal problems with configuration of MD5 authentication. This particular reason can only be returned when md5AuthEnabled is true and status is DOWN.",
+ ""
],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "zone": {
- "location": "path",
- "description": "The name of the zone for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "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).",
- "location": "query",
- "type": "string"
- }
- }
+ "type": "string"
},
- "updateAccessConfig": {
- "description": "Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig",
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "networkInterface"
- ],
- "request": {
- "$ref": "AccessConfig"
+ "peerIpAddress": {
+ "type": "string",
+ "description": "IP address of the remote BGP interface."
+ }
+ },
+ "type": "object"
+ },
+ "SslPoliciesList": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "description": "A list of SslPolicy resources.",
+ "items": {
+ "$ref": "SslPolicy"
},
- "parameters": {
- "instance": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "The instance name for this request."
- },
- "zone": {
- "required": true,
- "description": "The name of the zone for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
+ "type": "array"
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "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).",
- "location": "query",
- "type": "string"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ }
},
- "networkInterface": {
- "location": "query",
- "description": "The name of the network interface where the access config is attached.",
+ "message": {
"type": "string",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.instances.updateAccessConfig",
- "httpMethod": "POST"
+ }
},
- "addAccessConfig": {
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig",
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "AccessConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "instance",
- "networkInterface"
- ],
- "description": "Adds an access config to an instance's network interface.",
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "zone": {
- "required": true,
- "description": "The name of the zone for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "instance": {
- "description": "The instance name for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path"
- },
- "networkInterface": {
- "required": true,
- "location": "query",
- "type": "string",
- "description": "The name of the network interface to add to this instance."
- }
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.",
+ "default": "compute#sslPoliciesList",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "id": "SslPoliciesList"
+ },
+ "ZoneSetPolicyRequest": {
+ "type": "object",
+ "id": "ZoneSetPolicyRequest",
+ "properties": {
+ "etag": {
+ "type": "string",
+ "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
+ "format": "byte"
+ },
+ "bindings": {
+ "items": {
+ "$ref": "Binding"
},
- "id": "compute.instances.addAccessConfig",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig"
+ "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.",
+ "type": "array"
+ },
+ "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 in general a valid policy but certain services (like Projects) might reject them.",
+ "$ref": "Policy"
}
}
},
- "globalPublicDelegatedPrefixes": {
- "methods": {
- "patch": {
- "id": "compute.globalPublicDelegatedPrefixes.patch",
- "request": {
- "$ref": "PublicDelegatedPrefix"
- },
- "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "PATCH",
- "description": "Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "publicDelegatedPrefix": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the PublicDelegatedPrefix resource to patch.",
- "required": true,
- "location": "path"
- },
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
- "parameterOrder": [
- "project",
- "publicDelegatedPrefix"
+ "ResourcePolicyGroupPlacementPolicy": {
+ "id": "ResourcePolicyGroupPlacementPolicy",
+ "description": "A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality",
+ "type": "object",
+ "properties": {
+ "availabilityDomainCount": {
+ "format": "int32",
+ "description": "The number of availability domains to spread instances across. If two instances are in different availability domain, they are not in the same low latency network.",
+ "type": "integer"
+ },
+ "collocation": {
+ "type": "string",
+ "description": "Specifies network collocation",
+ "enum": [
+ "COLLOCATED",
+ "UNSPECIFIED_COLLOCATION"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "",
+ ""
]
},
- "list": {
- "id": "compute.globalPublicDelegatedPrefixes.list",
- "path": "projects/{project}/global/publicDelegatedPrefixes",
- "description": "Lists the global PublicDelegatedPrefixes for a project.",
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "vmCount": {
+ "format": "int32",
+ "type": "integer",
+ "description": "Number of VMs in this placement group. Google does not recommend that you use this field unless you use a compact policy and you want your policy to work only if it contains this exact number of VMs."
+ }
+ }
+ },
+ "ServiceAttachmentList": {
+ "properties": {
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "maxResults": {
- "minimum": "0",
- "location": "query",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "format": "uint32"
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ }
},
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "response": {
- "$ref": "PublicDelegatedPrefixList"
- },
- "flatPath": "projects/{project}/global/publicDelegatedPrefixes",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project"
- ]
+ "type": "object"
},
- "get": {
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "publicDelegatedPrefix": {
- "location": "path",
- "description": "Name of the PublicDelegatedPrefix resource to return.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- }
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.",
+ "type": "string",
+ "default": "compute#serviceAttachmentList"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "ServiceAttachment"
},
- "response": {
- "$ref": "PublicDelegatedPrefix"
+ "description": "A list of ServiceAttachment resources."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ }
+ },
+ "type": "object",
+ "id": "ServiceAttachmentList"
+ },
+ "HttpRetryPolicy": {
+ "description": "The retry policy associates with HttpRouteRule",
+ "type": "object",
+ "properties": {
+ "numRetries": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "Specifies the allowed number retries. This number must be \u003e 0. If not specified, defaults to 1."
+ },
+ "perTryTimeout": {
+ "$ref": "Duration",
+ "description": "Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in the HttpRouteAction field. If timeout in the HttpRouteAction field is not set, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true."
+ },
+ "retryConditions": {
+ "items": {
+ "type": "string"
},
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "publicDelegatedPrefix"
- ],
- "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
- "id": "compute.globalPublicDelegatedPrefixes.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Returns the specified global PublicDelegatedPrefix resource.",
- "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}"
+ "description": "Specifies one or more conditions when this retry policy applies. Valid values are: - 5xx: retry is attempted if the instance or endpoint responds with any 5xx response code, or if the instance or endpoint does not respond at all. For example, disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - connect-failure: a retry is attempted on failures connecting to the instance or endpoint. For example, connection timeouts. - retriable-4xx: a retry is attempted if the instance or endpoint responds with a 4xx response code. The only error that you can retry is error code 409. - refused-stream: a retry is attempted if the instance or endpoint resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: a retry is attempted if the gRPC status code in the response header is set to cancelled. - deadline-exceeded: a retry is attempted if the gRPC status code in the response header is set to deadline-exceeded. - internal: a retry is attempted if the gRPC status code in the response header is set to internal. - resource-exhausted: a retry is attempted if the gRPC status code in the response header is set to resource-exhausted. - unavailable: a retry is attempted if the gRPC status code in the response header is set to unavailable. Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true. - cancelled - deadline-exceeded - internal - resource-exhausted - unavailable ",
+ "type": "array"
+ }
+ },
+ "id": "HttpRetryPolicy"
+ },
+ "HttpQueryParameterMatch": {
+ "properties": {
+ "regexMatch": {
+ "type": "string",
+ "description": "The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For more information about regular expression syntax, see Syntax. Only one of presentMatch, exactMatch, or regexMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. "
},
- "insert": {
- "parameterOrder": [
- "project"
- ],
- "description": "Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "requestId": {
+ "name": {
+ "description": "The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.",
+ "type": "string"
+ },
+ "exactMatch": {
+ "type": "string",
+ "description": "The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch, or regexMatch must be set. "
+ },
+ "presentMatch": {
+ "type": "boolean",
+ "description": "Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch, or regexMatch must be set. "
+ }
+ },
+ "description": "HttpRouteRuleMatch criteria for a request's query parameter.",
+ "id": "HttpQueryParameterMatch",
+ "type": "object"
+ },
+ "TargetTcpProxiesScopedList": {
+ "id": "TargetTcpProxiesScopedList",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "properties": {
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ },
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "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"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "project": {
+ "message": {
"type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "path": "projects/{project}/global/publicDelegatedPrefixes",
- "request": {
- "$ref": "PublicDelegatedPrefix"
- },
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/global/publicDelegatedPrefixes",
- "id": "compute.globalPublicDelegatedPrefixes.insert"
+ "description": "Informational warning which replaces the list of backend services when the list is empty.",
+ "type": "object"
},
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "targetTcpProxies": {
+ "type": "array",
+ "description": "A list of TargetTcpProxies contained in this scope.",
+ "items": {
+ "$ref": "TargetTcpProxy"
+ }
+ }
+ }
+ },
+ "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk": {
+ "type": "object",
+ "properties": {
+ "interface": {
+ "enum": [
+ "NVME",
+ "SCSI"
],
- "description": "Deletes the specified global PublicDelegatedPrefix.",
- "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
- "httpMethod": "DELETE",
- "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
- "parameters": {
- "publicDelegatedPrefix": {
- "required": true,
- "type": "string",
- "description": "Name of the PublicDelegatedPrefix resource to delete.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.globalPublicDelegatedPrefixes.delete",
- "parameterOrder": [
- "project",
- "publicDelegatedPrefix"
+ "type": "string",
+ "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.",
+ "enumDescriptions": [
+ "",
+ ""
]
+ },
+ "diskSizeGb": {
+ "type": "string",
+ "description": "Specifies the size of the disk in base-2 GB.",
+ "format": "int64"
+ }
+ },
+ "id": "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk"
+ },
+ "BackendServiceFailoverPolicy": {
+ "id": "BackendServiceFailoverPolicy",
+ "type": "object",
+ "properties": {
+ "dropTrafficIfUnhealthy": {
+ "type": "boolean",
+ "description": "If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false."
+ },
+ "failoverRatio": {
+ "type": "number",
+ "description": "The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).",
+ "format": "float"
+ },
+ "disableConnectionDrainOnFailover": {
+ "description": "This can be set to true only if the protocol is TCP. The default is false.",
+ "type": "boolean"
+ }
+ },
+ "description": "For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes)."
+ },
+ "ResourcePolicyInstanceSchedulePolicySchedule": {
+ "id": "ResourcePolicyInstanceSchedulePolicySchedule",
+ "properties": {
+ "schedule": {
+ "type": "string",
+ "description": "Specifies the frequency for the operation, using the unix-cron format."
+ }
+ },
+ "type": "object",
+ "description": "Schedule for an instance operation."
+ },
+ "BackendServiceReference": {
+ "id": "BackendServiceReference",
+ "type": "object",
+ "properties": {
+ "backendService": {
+ "type": "string"
}
}
},
- "targetTcpProxies": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
+ "PacketMirroringMirroredResourceInfoInstanceInfo": {
+ "id": "PacketMirroringMirroredResourceInfoInstanceInfo",
+ "type": "object",
+ "properties": {
+ "canonicalUrl": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the instance; defined by the server."
+ },
+ "url": {
+ "type": "string",
+ "description": "Resource URL to the virtual machine instance which is being mirrored."
+ }
+ }
+ },
+ "PacketMirroringsScopedList": {
+ "properties": {
+ "warning": {
+ "properties": {
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ }
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
+ "message": {
"type": "string",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "targetTcpProxy": {
+ "code": {
"type": "string",
- "description": "Name of the TargetTcpProxy resource to delete.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "response": {
- "$ref": "Operation"
- },
- "description": "Deletes the specified TargetTcpProxy resource.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "targetTcpProxy"
- ],
- "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}",
- "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}",
- "id": "compute.targetTcpProxies.delete"
+ "description": "Informational warning which replaces the list of packetMirrorings when the list is empty.",
+ "type": "object"
},
- "get": {
- "httpMethod": "GET",
- "description": "Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.",
- "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}",
- "parameterOrder": [
- "project",
- "targetTcpProxy"
- ],
- "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.targetTcpProxies.get",
- "response": {
- "$ref": "TargetTcpProxy"
+ "packetMirrorings": {
+ "type": "array",
+ "items": {
+ "$ref": "PacketMirroring"
},
- "parameters": {
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
- },
- "targetTcpProxy": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Name of the TargetTcpProxy resource to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- }
+ "description": "A list of packetMirrorings contained in this scope."
+ }
+ },
+ "id": "PacketMirroringsScopedList",
+ "type": "object"
+ },
+ "Region": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "[Output Only] Name of the resource.",
+ "type": "string"
},
- "aggregatedList": {
- "path": "projects/{project}/aggregated/targetTcpProxies",
- "flatPath": "projects/{project}/aggregated/targetTcpProxies",
- "parameterOrder": [
- "project"
- ],
- "id": "compute.targetTcpProxies.aggregatedList",
- "parameters": {
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "project": {
- "type": "string",
- "description": "Name of the project scoping this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "maxResults": {
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "minimum": "0",
- "type": "integer",
- "format": "uint32"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "includeAllScopes": {
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "TargetTcpProxyAggregatedList"
- },
- "description": "Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET"
+ "deprecated": {
+ "$ref": "DeprecationStatus",
+ "description": "[Output Only] The deprecation status associated with this region."
},
- "setProxyHeader": {
- "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "targetTcpProxy"
- ],
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "targetTcpProxy": {
- "description": "Name of the TargetTcpProxy resource whose ProxyHeader is to be set.",
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "requestId": {
- "type": "string",
- "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"
- }
- },
- "id": "compute.targetTcpProxies.setProxyHeader",
- "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader",
- "request": {
- "$ref": "TargetTcpProxiesSetProxyHeaderRequest"
+ "zones": {
+ "items": {
+ "type": "string"
},
- "description": "Changes the ProxyHeaderType for TargetTcpProxy.",
- "response": {
- "$ref": "Operation"
- }
+ "type": "array",
+ "description": "[Output Only] A list of zones available in this region, in the form of resource URLs."
},
- "list": {
- "id": "compute.targetTcpProxies.list",
- "httpMethod": "GET",
- "response": {
- "$ref": "TargetTcpProxyList"
+ "quotas": {
+ "items": {
+ "$ref": "Quota"
},
- "description": "Retrieves the list of TargetTcpProxy resources available to the specified project.",
- "path": "projects/{project}/global/targetTcpProxies",
- "flatPath": "projects/{project}/global/targetTcpProxies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project"
+ "description": "[Output Only] Quotas assigned to this region.",
+ "type": "array"
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "kind": {
+ "default": "compute#region",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#region for regions."
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "DOWN",
+ "UP"
],
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "format": "uint32",
- "default": "500",
- "minimum": "0",
- "type": "integer"
- }
- }
+ "description": "[Output Only] Status of the region, either UP or DOWN.",
+ "enumDescriptions": [
+ "",
+ ""
+ ]
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "description": {
+ "description": "[Output Only] Textual description of the resource.",
+ "type": "string"
+ },
+ "supportsPzs": {
+ "type": "boolean",
+ "description": "[Output Only] Reserved for future use."
},
- "insert": {
- "flatPath": "projects/{project}/global/targetTcpProxies",
- "path": "projects/{project}/global/targetTcpProxies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project"
- ],
- "id": "compute.targetTcpProxies.insert",
- "parameters": {
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ }
+ },
+ "id": "Region",
+ "description": "Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones."
+ },
+ "BackendServiceGroupHealth": {
+ "type": "object",
+ "id": "BackendServiceGroupHealth",
+ "properties": {
+ "kind": {
+ "default": "compute#backendServiceGroupHealth",
+ "description": "[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.",
+ "type": "string"
+ },
+ "annotations": {
+ "additionalProperties": {
+ "type": "string"
},
- "description": "Creates a TargetTcpProxy resource in the specified project using the data included in the request.",
- "httpMethod": "POST",
- "request": {
- "$ref": "TargetTcpProxy"
+ "type": "object",
+ "description": "Metadata defined as annotations on the network endpoint group."
+ },
+ "healthStatus": {
+ "type": "array",
+ "description": "Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks.",
+ "items": {
+ "$ref": "HealthStatus"
}
+ }
+ }
+ },
+ "Backend": {
+ "properties": {
+ "failover": {
+ "description": "This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.",
+ "type": "boolean"
},
- "setBackendService": {
- "id": "compute.targetTcpProxies.setBackendService",
- "request": {
- "$ref": "TargetTcpProxiesSetBackendServiceRequest"
- },
- "parameters": {
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "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).",
- "location": "query",
- "type": "string"
- },
- "targetTcpProxy": {
- "type": "string",
- "description": "Name of the TargetTcpProxy resource whose BackendService resource is to be set.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path"
- }
- },
- "description": "Changes the BackendService for TargetTcpProxy.",
- "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService",
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "targetTcpProxy"
+ "maxRate": {
+ "description": "Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "maxRatePerInstance": {
+ "description": "Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.",
+ "type": "number",
+ "format": "float"
+ },
+ "capacityScaler": {
+ "type": "number",
+ "description": "A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.",
+ "format": "float"
+ },
+ "maxConnections": {
+ "format": "int32",
+ "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.",
+ "type": "integer"
+ },
+ "group": {
+ "type": "string",
+ "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported."
+ },
+ "maxRatePerEndpoint": {
+ "format": "float",
+ "description": "Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.",
+ "type": "number"
+ },
+ "balancingMode": {
+ "description": "Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.",
+ "enum": [
+ "CONNECTION",
+ "RATE",
+ "UTILIZATION"
],
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "enumDescriptions": [
+ "Balance based on the number of simultaneous connections.",
+ "Balance based on requests per second (RPS).",
+ "Balance based on the backend utilization."
]
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "maxConnectionsPerInstance": {
+ "format": "int32",
+ "type": "integer",
+ "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE."
+ },
+ "maxConnectionsPerEndpoint": {
+ "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxUtilization": {
+ "type": "number",
+ "format": "float",
+ "description": "Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode."
}
- }
+ },
+ "type": "object",
+ "id": "Backend",
+ "description": "Message containing information of one individual backend."
},
- "regionHealthCheckServices": {
- "methods": {
- "insert": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "parameters": {
- "requestId": {
+ "VpnGatewaysGetStatusResponse": {
+ "id": "VpnGatewaysGetStatusResponse",
+ "properties": {
+ "result": {
+ "$ref": "VpnGatewayStatus"
+ }
+ },
+ "type": "object"
+ },
+ "InstancesScopedList": {
+ "id": "InstancesScopedList",
+ "properties": {
+ "warning": {
+ "description": "[Output Only] Informational warning which replaces the list of instances when the list is empty.",
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "location": "query",
- "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)."
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "type": "string",
- "location": "path"
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
}
},
- "flatPath": "projects/{project}/regions/{region}/healthCheckServices",
- "description": "Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.",
- "path": "projects/{project}/regions/{region}/healthCheckServices",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "id": "compute.regionHealthCheckServices.insert",
- "request": {
- "$ref": "HealthCheckService"
- }
+ "type": "object"
},
- "patch": {
- "id": "compute.regionHealthCheckServices.patch",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "project",
- "region",
- "healthCheckService"
- ],
- "request": {
- "$ref": "HealthCheckService"
+ "instances": {
+ "items": {
+ "$ref": "Instance"
},
- "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
- "response": {
- "$ref": "Operation"
+ "type": "array",
+ "description": "[Output Only] A list of instances contained in this scope."
+ }
+ },
+ "type": "object"
+ },
+ "Instance": {
+ "id": "Instance",
+ "properties": {
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "machineType": {
+ "annotations": {
+ "required": [
+ "compute.instances.insert"
+ ]
},
- "parameters": {
- "healthCheckService": {
- "description": "Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "region": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "Name of the region scoping this request."
- }
+ "description": "Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.",
+ "type": "string"
+ },
+ "networkPerformanceConfig": {
+ "$ref": "NetworkPerformanceConfig"
+ },
+ "serviceAccounts": {
+ "items": {
+ "$ref": "ServiceAccount"
},
- "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.",
+ "type": "array"
+ },
+ "params": {
+ "$ref": "InstanceParams",
+ "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload."
+ },
+ "shieldedInstanceConfig": {
+ "$ref": "ShieldedInstanceConfig"
+ },
+ "displayDevice": {
+ "$ref": "DisplayDevice",
+ "description": "Enables display device for the instance."
+ },
+ "labelFingerprint": {
+ "type": "string",
+ "description": "A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.",
+ "format": "byte"
+ },
+ "status": {
+ "description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.",
+ "enumDescriptions": [
+ "The Nanny is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.",
+ "Resources are being allocated for the instance.",
+ "The instance is in repair.",
+ "The instance is running.",
+ "All required resources have been allocated and the instance is being started.",
+ "The instance has stopped successfully.",
+ "The instance is currently stopping (either being deleted or killed).",
+ "The instance has suspended.",
+ "The instance is suspending.",
+ "The instance has stopped (either by explicit action or underlying failure)."
+ ],
+ "type": "string",
+ "enum": [
+ "DEPROVISIONING",
+ "PROVISIONING",
+ "REPAIRING",
+ "RUNNING",
+ "STAGING",
+ "STOPPED",
+ "STOPPING",
+ "SUSPENDED",
+ "SUSPENDING",
+ "TERMINATED"
+ ]
+ },
+ "tags": {
+ "description": "Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.",
+ "$ref": "Tags"
+ },
+ "confidentialInstanceConfig": {
+ "$ref": "ConfidentialInstanceConfig"
+ },
+ "statusMessage": {
+ "type": "string",
+ "description": "[Output Only] An optional, human-readable explanation of the status."
+ },
+ "lastStopTimestamp": {
+ "description": "[Output Only] Last stop timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "startRestricted": {
+ "description": "[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.",
+ "type": "boolean"
+ },
+ "advancedMachineFeatures": {
+ "description": "Controls for advanced machine-related behavior features.",
+ "$ref": "AdvancedMachineFeatures"
+ },
+ "zone": {
+ "type": "string",
+ "description": "[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "minCpuPlatform": {
+ "type": "string",
+ "description": "Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\"."
+ },
+ "satisfiesPzs": {
+ "description": "[Output Only] Reserved for future use.",
+ "type": "boolean"
+ },
+ "deletionProtection": {
+ "description": "Whether the resource should be protected against deletion.",
+ "type": "boolean"
+ },
+ "disks": {
+ "items": {
+ "$ref": "AttachedDisk"
+ },
+ "description": "Array of disks associated with this instance. Persistent disks must be created before you can assign them.",
+ "type": "array"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "fingerprint": {
+ "format": "byte",
+ "type": "string",
+ "description": "Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance."
+ },
+ "guestAccelerators": {
+ "description": "A list of the type and count of accelerator cards attached to the instance.",
+ "type": "array",
+ "items": {
+ "$ref": "AcceleratorConfig"
+ }
+ },
+ "lastStartTimestamp": {
+ "description": "[Output Only] Last start timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "resourcePolicies": {
+ "description": "Resource policies applied to this instance.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "reservationAffinity": {
+ "description": "Specifies the reservations that this instance can consume from.",
+ "$ref": "ReservationAffinity"
+ },
+ "metadata": {
+ "description": "The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.",
+ "$ref": "Metadata"
+ },
+ "cpuPlatform": {
+ "description": "[Output Only] The CPU platform used by this instance.",
+ "type": "string"
+ },
+ "shieldedInstanceIntegrityPolicy": {
+ "$ref": "ShieldedInstanceIntegrityPolicy"
+ },
+ "networkInterfaces": {
+ "type": "array",
+ "description": "An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.",
+ "items": {
+ "$ref": "NetworkInterface"
+ }
+ },
+ "labels": {
+ "description": "Labels to apply to this instance. These can be later modified by the setLabels method.",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "keyRevocationActionType": {
+ "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.",
+ "enum": [
+ "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED",
+ "NONE",
+ "STOP"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "Indicates user chose no operation.",
+ "Indicates user chose to opt for VM shutdown on key revocation."
],
- "description": "Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules."
+ "type": "string"
},
- "delete": {
- "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "Name of the region scoping this request.",
- "type": "string",
- "location": "path"
- },
- "healthCheckService": {
- "required": true,
- "description": "Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035.",
- "type": "string",
- "location": "path"
- }
- },
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
+ "scheduling": {
+ "$ref": "Scheduling",
+ "description": "Sets the scheduling options for this instance."
+ },
+ "hostname": {
+ "type": "string",
+ "description": "Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS."
+ },
+ "sourceMachineImageEncryptionKey": {
+ "$ref": "CustomerEncryptionKey",
+ "description": "Source machine image encryption key when creating an instance from a machine image."
+ },
+ "resourceStatus": {
+ "$ref": "ResourceStatus",
+ "description": "[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field."
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "annotations": {
+ "required": [
+ "compute.instances.insert"
+ ]
},
- "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
- "id": "compute.regionHealthCheckServices.delete",
- "parameterOrder": [
- "project",
- "region",
- "healthCheckService"
+ "description": "The name of the resource, provided by the client when initially creating the resource. The resource 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.",
+ "type": "string"
+ },
+ "sourceMachineImage": {
+ "description": "Source machine image",
+ "type": "string"
+ },
+ "lastSuspendedTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Last suspended timestamp in RFC3339 text format."
+ },
+ "canIpForward": {
+ "description": "Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .",
+ "type": "boolean"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#instance",
+ "description": "[Output Only] Type of the resource. Always compute#instance for instances."
+ },
+ "privateIpv6GoogleAccess": {
+ "enumDescriptions": [
+ "Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.",
+ "Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.",
+ "Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork."
],
- "description": "Deletes the specified regional HealthCheckService.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.",
+ "type": "string",
+ "enum": [
+ "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
+ "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE",
+ "INHERIT_FROM_SUBNETWORK"
]
+ }
+ },
+ "type": "object",
+ "description": "Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances."
+ },
+ "VpnGatewayStatusTunnel": {
+ "type": "object",
+ "id": "VpnGatewayStatusTunnel",
+ "description": "Contains some information about a VPN tunnel.",
+ "properties": {
+ "peerGatewayInterface": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway."
},
- "get": {
- "description": "Returns the specified regional HealthCheckService resource.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "HealthCheckService"
+ "localGatewayInterface": {
+ "description": "The VPN gateway interface this VPN tunnel is associated with.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "tunnelUrl": {
+ "description": "URL reference to the VPN tunnel.",
+ "type": "string"
+ }
+ }
+ },
+ "TestPermissionsResponse": {
+ "type": "object",
+ "id": "TestPermissionsResponse",
+ "properties": {
+ "permissions": {
+ "items": {
+ "type": "string"
},
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "array",
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed."
+ }
+ }
+ },
+ "AddressList": {
+ "type": "object",
+ "id": "AddressList",
+ "properties": {
+ "warning": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "healthCheckService": {
- "required": true,
- "location": "path",
+ "message": {
"type": "string",
- "description": "Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "region": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "location": "path"
+ "data": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
},
- "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
- "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
- "parameterOrder": [
- "project",
- "region",
- "healthCheckService"
- ],
- "id": "compute.regionHealthCheckServices.get",
- "httpMethod": "GET"
+ "description": "[Output Only] Informational warning message."
},
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "region"
- ],
- "id": "compute.regionHealthCheckServices.list",
- "parameters": {
- "maxResults": {
- "default": "500",
- "minimum": "0",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "format": "uint32"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "location": "path"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- }
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "items": {
+ "$ref": "Address"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "array",
+ "description": "A list of Address resources."
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#addressList for lists of addresses.",
+ "default": "compute#addressList",
+ "type": "string"
+ }
+ },
+ "description": "Contains a list of addresses."
+ },
+ "DeprecationStatus": {
+ "description": "Deprecation status for a public resource.",
+ "properties": {
+ "replacement": {
+ "type": "string",
+ "description": "The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource."
+ },
+ "deprecated": {
+ "type": "string",
+ "description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it."
+ },
+ "obsolete": {
+ "description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.",
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enum": [
+ "ACTIVE",
+ "DELETED",
+ "DEPRECATED",
+ "OBSOLETE"
],
- "flatPath": "projects/{project}/regions/{region}/healthCheckServices",
- "response": {
- "$ref": "HealthCheckServicesList"
- },
- "path": "projects/{project}/regions/{region}/healthCheckServices",
- "description": "Lists all the HealthCheckService resources that have been configured for the specified project in the given region."
+ "description": "The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ]
+ },
+ "deleted": {
+ "type": "string",
+ "description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it."
+ }
+ },
+ "id": "DeprecationStatus",
+ "type": "object"
+ },
+ "ConsistentHashLoadBalancerSettings": {
+ "description": "This message defines settings for a consistent hash style load balancer.",
+ "type": "object",
+ "id": "ConsistentHashLoadBalancerSettings",
+ "properties": {
+ "httpCookie": {
+ "description": "Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
+ "$ref": "ConsistentHashLoadBalancerSettingsHttpCookie"
+ },
+ "httpHeaderName": {
+ "description": "The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.",
+ "type": "string"
+ },
+ "minimumRingSize": {
+ "format": "int64",
+ "type": "string",
+ "description": "The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node."
}
}
},
- "addresses": {
- "methods": {
- "setLabels": {
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/addresses/{resource}/setLabels",
- "description": "Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.",
- "flatPath": "projects/{project}/regions/{region}/addresses/{resource}/setLabels",
- "response": {
- "$ref": "Operation"
+ "VmEndpointNatMappingsInterfaceNatMappings": {
+ "properties": {
+ "natIpPortRanges": {
+ "description": "A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].",
+ "items": {
+ "type": "string"
},
- "id": "compute.addresses.setLabels",
- "parameters": {
- "resource": {
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
- },
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "The region for this request.",
- "required": true
- },
- "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).",
- "location": "query",
- "type": "string"
- }
+ "type": "array"
+ },
+ "numTotalNatPorts": {
+ "description": "Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceVirtualIp": {
+ "description": "Primary IP of the VM for this NIC.",
+ "type": "string"
+ },
+ "numTotalDrainNatPorts": {
+ "type": "integer",
+ "description": "Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges.",
+ "format": "int32"
+ },
+ "drainNatIpPortRanges": {
+ "description": "List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].",
+ "items": {
+ "type": "string"
},
- "request": {
- "$ref": "RegionSetLabelsRequest"
+ "type": "array"
+ },
+ "ruleMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "description": "Information about mappings provided by rules in this NAT."
+ },
+ "sourceAliasIpRange": {
+ "type": "string",
+ "description": "Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: \"10.33.4.55/32\", or \"192.168.5.0/24\"."
+ }
+ },
+ "type": "object",
+ "id": "VmEndpointNatMappingsInterfaceNatMappings",
+ "description": "Contain information of Nat mapping for an interface of this endpoint."
+ },
+ "ForwardingRuleReference": {
+ "id": "ForwardingRuleReference",
+ "properties": {
+ "forwardingRule": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UrlMapsValidateRequest": {
+ "type": "object",
+ "properties": {
+ "loadBalancingSchemes": {
+ "type": "array",
+ "items": {
+ "enum": [
+ "EXTERNAL",
+ "EXTERNAL_MANAGED",
+ "LOAD_BALANCING_SCHEME_UNSPECIFIED"
+ ],
+ "enumDescriptions": [
+ "Signifies that this will be used for Classic L7 External Load Balancing.",
+ "Signifies that this will be used for Envoy-based L7 External Load Balancing.",
+ "If unspecified, the validation will try to infer the scheme from the backend service resources this Url map references. If the inferrence is not possible, EXTERNAL will be used as the default type."
+ ],
+ "type": "string"
+ },
+ "description": "Specifies the load balancer type(s) this validation request is for. Use EXTERNAL_MANAGED for HTTP/HTTPS External Global Load Balancer with Advanced Traffic Management. Use EXTERNAL for Classic HTTP/HTTPS External Global Load Balancer. Other load balancer types are not supported. For more information, refer to Choosing a load balancer. If unspecified, the load balancing scheme will be inferred from the backend service resources this URL map references. If that can not be inferred (for example, this URL map only references backend buckets, or this Url map is for rewrites and redirects only and doesn't reference any backends), EXTERNAL will be used as the default type. If specified, the scheme(s) must not conflict with the load balancing scheme of the backend service resources this Url map references."
+ },
+ "resource": {
+ "$ref": "UrlMap",
+ "description": "Content of the UrlMap to be validated."
+ }
+ },
+ "id": "UrlMapsValidateRequest"
+ },
+ "Interconnect": {
+ "description": "Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview.",
+ "properties": {
+ "interconnectType": {
+ "description": "Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.",
+ "type": "string",
+ "enum": [
+ "DEDICATED",
+ "IT_PRIVATE",
+ "PARTNER"
+ ],
+ "enumDescriptions": [
+ "A dedicated physical interconnection with the customer.",
+ "[Deprecated] A private, physical interconnection with the customer.",
+ "A partner-managed interconnection shared between customers via partner."
]
},
- "get": {
- "parameterOrder": [
- "project",
- "region",
- "address"
- ],
- "id": "compute.addresses.get",
- "description": "Returns the specified address resource.",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "required": true
- },
- "region": {
- "required": true,
- "description": "Name of the region for this request.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "address": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the address resource to return.",
- "location": "path",
- "required": true,
- "type": "string"
- }
+ "circuitInfos": {
+ "type": "array",
+ "items": {
+ "$ref": "InterconnectCircuitInfo"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "path": "projects/{project}/regions/{region}/addresses/{address}",
- "response": {
- "$ref": "Address"
+ "description": "[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "adminEnabled": {
+ "type": "boolean",
+ "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true."
+ },
+ "peerIpAddress": {
+ "description": "[Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.",
+ "type": "string"
+ },
+ "interconnectAttachments": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/regions/{region}/addresses/{address}"
+ "description": "[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect."
},
- "aggregatedList": {
- "parameters": {
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "maxResults": {
- "location": "query",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "default": "500",
- "format": "uint32"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query",
- "type": "boolean"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- }
+ "kind": {
+ "default": "compute#interconnect",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#interconnect for interconnects."
+ },
+ "nocContactEmail": {
+ "type": "string",
+ "description": "Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation."
+ },
+ "expectedOutages": {
+ "items": {
+ "$ref": "InterconnectOutageNotification"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "flatPath": "projects/{project}/aggregated/addresses",
- "parameterOrder": [
- "project"
- ],
- "description": "Retrieves an aggregated list of addresses.",
- "path": "projects/{project}/aggregated/addresses",
- "id": "compute.addresses.aggregatedList",
- "response": {
- "$ref": "AddressAggregatedList"
- }
+ "description": "[Output Only] A list of outages expected for this Interconnect.",
+ "type": "array"
},
- "delete": {
- "path": "projects/{project}/regions/{region}/addresses/{address}",
- "parameterOrder": [
- "project",
- "region",
- "address"
+ "customerName": {
+ "type": "string",
+ "description": "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect."
+ },
+ "satisfiesPzs": {
+ "type": "boolean",
+ "description": "[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."
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "location": {
+ "description": "URL of the InterconnectLocation object that represents where this connection is to be provisioned.",
+ "type": "string"
+ },
+ "linkType": {
+ "enumDescriptions": [
+ "100G Ethernet, LR Optics.",
+ "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];"
],
- "parameters": {
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
- },
- "region": {
- "type": "string",
- "description": "Name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path"
- },
- "address": {
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name of the address resource to delete."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "enum": [
+ "LINK_TYPE_ETHERNET_100G_LR",
+ "LINK_TYPE_ETHERNET_10G_LR"
],
- "description": "Deletes the specified address resource.",
- "flatPath": "projects/{project}/regions/{region}/addresses/{address}",
- "id": "compute.addresses.delete",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "DELETE"
+ "description": "Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle."
},
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "parameters": {
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "region": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "Name of the region for this request."
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "type": "integer",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- }
- },
- "parameterOrder": [
- "project",
- "region"
+ "requestedLinkCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Target number of physical links in the link bundle, as requested by the customer."
+ },
+ "provisionedLinkCount": {
+ "format": "int32",
+ "description": "[Output Only] Number of links actually provisioned in this interconnect.",
+ "type": "integer"
+ },
+ "operationalStatus": {
+ "type": "string",
+ "description": "[Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. ",
+ "enum": [
+ "OS_ACTIVE",
+ "OS_UNPROVISIONED"
],
- "path": "projects/{project}/regions/{region}/addresses",
- "response": {
- "$ref": "AddressList"
- },
- "flatPath": "projects/{project}/regions/{region}/addresses",
- "description": "Retrieves a list of addresses contained within the specified region.",
- "id": "compute.addresses.list"
+ "enumDescriptions": [
+ "The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.",
+ "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect."
+ ]
},
- "insert": {
- "flatPath": "projects/{project}/regions/{region}/addresses",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "region": {
- "description": "Name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path"
- }
- },
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "googleReferenceId": {
+ "description": "[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "state": {
+ "enumDescriptions": [
+ "The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.",
+ "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect."
],
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "region"
+ "type": "string",
+ "enum": [
+ "ACTIVE",
+ "UNPROVISIONED"
],
- "path": "projects/{project}/regions/{region}/addresses",
- "request": {
- "$ref": "Address"
+ "description": "[Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. "
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.interconnects.insert"
+ ]
},
- "description": "Creates an address resource in the specified project by using the data included in the request.",
- "id": "compute.addresses.insert"
+ "description": "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."
+ },
+ "googleIpAddress": {
+ "description": "[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.",
+ "type": "string"
+ }
+ },
+ "id": "Interconnect",
+ "type": "object"
+ },
+ "InstanceGroupsSetNamedPortsRequest": {
+ "id": "InstanceGroupsSetNamedPortsRequest",
+ "properties": {
+ "fingerprint": {
+ "format": "byte",
+ "type": "string",
+ "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet."
+ },
+ "namedPorts": {
+ "type": "array",
+ "description": "The list of named ports to set for this instance group.",
+ "items": {
+ "$ref": "NamedPort"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "RegionDisksAddResourcePoliciesRequest": {
+ "type": "object",
+ "id": "RegionDisksAddResourcePoliciesRequest",
+ "properties": {
+ "resourcePolicies": {
+ "type": "array",
+ "description": "Resource policies to be added to this disk.",
+ "items": {
+ "type": "string"
+ }
}
}
},
- "globalOrganizationOperations": {
- "methods": {
- "list": {
- "id": "compute.globalOrganizationOperations.list",
- "path": "locations/global/operations",
- "description": "Retrieves a list of Operation resources contained within the specified organization.",
- "flatPath": "locations/global/operations",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "OperationList"
- },
- "parameters": {
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "minimum": "0",
- "location": "query",
- "default": "500"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "parentId": {
- "type": "string",
- "location": "query",
- "description": "Parent ID for this request."
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- }
+ "InstanceGroupManagerStatusStatefulPerInstanceConfigs": {
+ "properties": {
+ "allEffective": {
+ "type": "boolean",
+ "description": "A bit indicating if all of the group's per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs."
+ }
+ },
+ "type": "object",
+ "id": "InstanceGroupManagerStatusStatefulPerInstanceConfigs"
+ },
+ "Help": {
+ "description": "Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.",
+ "id": "Help",
+ "properties": {
+ "links": {
+ "type": "array",
+ "items": {
+ "$ref": "HelpLink"
},
- "httpMethod": "GET"
+ "description": "URL(s) pointing to additional information on handling the current error."
+ }
+ },
+ "type": "object"
+ },
+ "RouterNatLogConfig": {
+ "properties": {
+ "enable": {
+ "description": "Indicates whether or not to export logs. This is false by default.",
+ "type": "boolean"
},
- "get": {
- "path": "locations/global/operations/{operation}",
- "description": "Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.",
- "parameters": {
- "operation": {
- "description": "Name of the Operations resource to return.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "parentId": {
- "location": "query",
- "description": "Parent ID for this request.",
- "type": "string"
- }
- },
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "operation"
+ "filter": {
+ "enumDescriptions": [
+ "Export logs for all (successful and unsuccessful) connections.",
+ "Export logs for connection failures only.",
+ "Export logs for successful connections only."
],
- "flatPath": "locations/global/operations/{operation}",
- "id": "compute.globalOrganizationOperations.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "enum": [
+ "ALL",
+ "ERRORS_ONLY",
+ "TRANSLATIONS_ONLY"
+ ],
+ "description": "Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful. ",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "description": "Configuration of logging on a NAT.",
+ "id": "RouterNatLogConfig"
+ },
+ "PublicDelegatedPrefixPublicDelegatedSubPrefix": {
+ "description": "Represents a sub PublicDelegatedPrefix.",
+ "properties": {
+ "region": {
+ "type": "string",
+ "description": "[Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global."
+ },
+ "isAddress": {
+ "type": "boolean",
+ "description": "Whether the sub prefix is delegated to create Address resources in the delegatee project."
+ },
+ "ipCidrRange": {
+ "type": "string",
+ "description": "The IPv4 address range, in CIDR format, represented by this sub public delegated prefix."
},
- "delete": {
- "id": "compute.globalOrganizationOperations.delete",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "delegateeProject": {
+ "type": "string",
+ "description": "Name of the project scoping this PublicDelegatedSubPrefix."
+ },
+ "status": {
+ "description": "[Output Only] The status of the sub public delegated prefix.",
+ "enumDescriptions": [
+ "",
+ ""
],
- "description": "Deletes the specified Operations resource.",
- "httpMethod": "DELETE",
- "parameters": {
- "parentId": {
- "type": "string",
- "location": "query",
- "description": "Parent ID for this request."
- },
- "operation": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Name of the Operations resource to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "flatPath": "locations/global/operations/{operation}",
- "path": "locations/global/operations/{operation}",
- "parameterOrder": [
- "operation"
+ "type": "string",
+ "enum": [
+ "ACTIVE",
+ "INACTIVE"
]
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the sub public delegated prefix."
}
- }
+ },
+ "type": "object",
+ "id": "PublicDelegatedPrefixPublicDelegatedSubPrefix"
},
- "regionInstances": {
- "methods": {
- "bulkInsert": {
- "id": "compute.regionInstances.bulkInsert",
- "httpMethod": "POST",
- "description": "Creates multiple instances in a given region. Count specifies the number of instances to create.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path"
- },
- "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).",
- "type": "string",
- "location": "query"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the region for this request.",
- "type": "string",
- "location": "path",
- "required": true
- }
+ "HelpLink": {
+ "description": "Describes a URL link.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "The URL of the link.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "Describes what the link offers."
+ }
+ },
+ "id": "HelpLink"
+ },
+ "Screenshot": {
+ "type": "object",
+ "id": "Screenshot",
+ "properties": {
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#screenshot for the screenshots.",
+ "type": "string",
+ "default": "compute#screenshot"
+ },
+ "contents": {
+ "type": "string",
+ "description": "[Output Only] The Base64-encoded screenshot data."
+ }
+ },
+ "description": "An instance's screenshot."
+ },
+ "NodeGroupNode": {
+ "properties": {
+ "disks": {
+ "type": "array",
+ "description": "Local disk configurations.",
+ "items": {
+ "$ref": "LocalDisk"
+ }
+ },
+ "cpuOvercommitType": {
+ "description": "CPU overcommit.",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "CPU_OVERCOMMIT_TYPE_UNSPECIFIED",
+ "ENABLED",
+ "NONE"
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the node.",
+ "type": "string"
+ },
+ "accelerators": {
+ "description": "Accelerators for this node.",
+ "items": {
+ "$ref": "AcceleratorConfig"
},
- "response": {
- "$ref": "Operation"
+ "type": "array"
+ },
+ "serverId": {
+ "description": "Server ID associated with this node.",
+ "type": "string"
+ },
+ "consumedResources": {
+ "description": "Node resources that are reserved by all instances.",
+ "$ref": "InstanceConsumptionInfo"
+ },
+ "instanceConsumptionData": {
+ "type": "array",
+ "items": {
+ "$ref": "InstanceConsumptionData"
},
- "path": "projects/{project}/regions/{region}/instances/bulkInsert",
- "parameterOrder": [
- "project",
- "region"
+ "description": "Instance data that shows consumed resources on the node."
+ },
+ "serverBinding": {
+ "description": "Binding properties for the physical server.",
+ "$ref": "ServerBinding"
+ },
+ "nodeType": {
+ "type": "string",
+ "description": "The type of this node."
+ },
+ "totalResources": {
+ "description": "Total amount of available resources on the node.",
+ "$ref": "InstanceConsumptionInfo"
+ },
+ "satisfiesPzs": {
+ "type": "boolean",
+ "description": "[Output Only] Reserved for future use."
+ },
+ "status": {
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "flatPath": "projects/{project}/regions/{region}/instances/bulkInsert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enum": [
+ "CREATING",
+ "DELETING",
+ "INVALID",
+ "READY",
+ "REPAIRING"
],
- "request": {
- "$ref": "BulkInsertInstanceResource"
+ "type": "string"
+ },
+ "instances": {
+ "description": "Instances scheduled on this node.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
}
- }
+ },
+ "id": "NodeGroupNode",
+ "type": "object"
},
- "routes": {
- "methods": {
- "insert": {
- "httpMethod": "POST",
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- }
+ "RouterStatusNatStatus": {
+ "type": "object",
+ "properties": {
+ "numVmEndpointsWithNatMappings": {
+ "description": "Number of VM endpoints (i.e., Nics) that can use NAT.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "userAllocatedNatIps": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
+ "type": "array",
+ "description": "A list of IPs user-allocated for NAT. They will be raw IP strings like \"179.12.26.133\"."
+ },
+ "userAllocatedNatIpResources": {
+ "items": {
+ "type": "string"
},
- "request": {
- "$ref": "Route"
+ "type": "array",
+ "description": "A list of fully qualified URLs of reserved IP address resources."
+ },
+ "ruleStatus": {
+ "description": "Status of rules in this NAT.",
+ "type": "array",
+ "items": {
+ "$ref": "RouterStatusNatStatusNatRuleStatus"
+ }
+ },
+ "name": {
+ "type": "string",
+ "description": "Unique name of this NAT."
+ },
+ "autoAllocatedNatIps": {
+ "type": "array",
+ "description": "A list of IPs auto-allocated for NAT. Example: [\"1.1.1.1\", \"129.2.16.89\"]",
+ "items": {
+ "type": "string"
+ }
+ },
+ "minExtraNatIpsNeeded": {
+ "format": "int32",
+ "type": "integer",
+ "description": "The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used."
+ },
+ "drainUserAllocatedNatIps": {
+ "description": "A list of IPs user-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "drainAutoAllocatedNatIps": {
+ "description": "A list of IPs auto-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].",
+ "items": {
+ "type": "string"
},
- "description": "Creates a Route resource in the specified project using the data included in the request.",
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/global/routes",
- "path": "projects/{project}/global/routes",
- "id": "compute.routes.insert"
+ "type": "array"
+ }
+ },
+ "id": "RouterStatusNatStatus",
+ "description": "Status of a NAT contained in this router."
+ },
+ "InterconnectDiagnosticsLinkStatus": {
+ "type": "object",
+ "id": "InterconnectDiagnosticsLinkStatus",
+ "properties": {
+ "circuitId": {
+ "description": "The unique ID for this link assigned during turn up by Google.",
+ "type": "string"
},
- "list": {
- "path": "projects/{project}/global/routes",
- "parameterOrder": [
- "project"
+ "googleDemarc": {
+ "description": "The Demarc address assigned by Google and provided in the LoA.",
+ "type": "string"
+ },
+ "transmittingOpticalPower": {
+ "$ref": "InterconnectDiagnosticsLinkOpticalPower",
+ "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level."
+ },
+ "operationalStatus": {
+ "type": "string",
+ "description": "The operational status of the link.",
+ "enumDescriptions": [
+ "The interface is unable to communicate with the remote end.",
+ "The interface has low level communication with the remote end."
],
- "httpMethod": "GET",
- "id": "compute.routes.list",
- "response": {
- "$ref": "RouteList"
- },
- "parameters": {
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "format": "uint32",
- "default": "500",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "projects/{project}/global/routes",
- "description": "Retrieves the list of Route resources available to the specified project.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enum": [
+ "LINK_OPERATIONAL_STATUS_DOWN",
+ "LINK_OPERATIONAL_STATUS_UP"
]
},
- "delete": {
- "httpMethod": "DELETE",
- "flatPath": "projects/{project}/global/routes/{route}",
- "description": "Deletes the specified Route resource.",
- "path": "projects/{project}/global/routes/{route}",
- "response": {
- "$ref": "Operation"
+ "receivingOpticalPower": {
+ "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level.",
+ "$ref": "InterconnectDiagnosticsLinkOpticalPower"
+ },
+ "arpCaches": {
+ "description": "A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled",
+ "items": {
+ "$ref": "InterconnectDiagnosticsARPEntry"
},
- "parameterOrder": [
- "project",
- "route"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "array"
+ },
+ "lacpStatus": {
+ "$ref": "InterconnectDiagnosticsLinkLACPStatus"
+ }
+ }
+ },
+ "Network": {
+ "description": "Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.",
+ "properties": {
+ "networkFirewallPolicyEnforcementOrder": {
+ "enum": [
+ "AFTER_CLASSIC_FIREWALL",
+ "BEFORE_CLASSIC_FIREWALL"
],
- "parameters": {
- "route": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Name of the Route resource to delete."
- },
- "project": {
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request."
- },
- "requestId": {
- "type": "string",
- "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"
- }
- },
- "id": "compute.routes.delete"
+ "description": "The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
+ ]
},
- "get": {
- "flatPath": "projects/{project}/global/routes/{route}",
- "response": {
- "$ref": "Route"
+ "autoCreateSubnetworks": {
+ "description": "Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.",
+ "type": "boolean"
+ },
+ "mtu": {
+ "description": "Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "firewallPolicy": {
+ "type": "string",
+ "description": "[Output Only] URL of the firewall policy the network is associated with."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "gatewayIPv4": {
+ "description": "[Output Only] The gateway address for default routing out of the network, selected by GCP.",
+ "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}",
+ "type": "string"
+ },
+ "selfLinkWithId": {
+ "description": "[Output Only] Server-defined URL for this resource with the resource id.",
+ "type": "string"
+ },
+ "subnetworks": {
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/global/routes/{route}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string"
- },
- "route": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the Route resource to return.",
- "location": "path"
- }
+ "description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.",
+ "type": "array"
+ },
+ "internalIpv6Range": {
+ "type": "string",
+ "description": "When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. ."
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this field when you create the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#network",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#network for networks."
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "annotations": {
+ "required": [
+ "compute.networks.insert"
+ ]
+ }
+ },
+ "peerings": {
+ "type": "array",
+ "description": "[Output Only] A list of network peerings for the resource.",
+ "items": {
+ "$ref": "NetworkPeering"
+ }
+ },
+ "routingConfig": {
+ "description": "The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.",
+ "$ref": "NetworkRoutingConfig"
+ },
+ "IPv4Range": {
+ "description": "Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.",
+ "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "enableUlaInternalIpv6": {
+ "type": "boolean",
+ "description": "Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. ."
+ }
+ },
+ "id": "Network",
+ "type": "object"
+ },
+ "InstanceGroupManagersDeletePerInstanceConfigsReq": {
+ "properties": {
+ "names": {
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "route"
- ],
- "httpMethod": "GET",
- "id": "compute.routes.get",
- "description": "Returns the specified Route resource. Gets a list of available routes by making a list() request."
+ "description": "The list of instance names for which we want to delete per-instance configs on this managed instance group.",
+ "type": "array"
+ }
+ },
+ "description": "InstanceGroupManagers.deletePerInstanceConfigs",
+ "type": "object",
+ "id": "InstanceGroupManagersDeletePerInstanceConfigsReq"
+ },
+ "UrlMapReference": {
+ "id": "UrlMapReference",
+ "type": "object",
+ "properties": {
+ "urlMap": {
+ "type": "string"
}
}
},
- "packetMirrorings": {
- "methods": {
- "aggregatedList": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "PacketMirroringAggregatedList"
- },
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/aggregated/packetMirrorings",
- "httpMethod": "GET",
- "path": "projects/{project}/aggregated/packetMirrorings",
- "description": "Retrieves an aggregated list of packetMirrorings.",
- "parameters": {
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "maxResults": {
- "location": "query",
- "default": "500",
- "type": "integer",
- "format": "uint32",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "includeAllScopes": {
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- }
- },
- "id": "compute.packetMirrorings.aggregatedList"
+ "AutoscalerStatusDetails": {
+ "properties": {
+ "message": {
+ "description": "The status message.",
+ "type": "string"
},
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "description": "Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
- "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
- "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "packetMirroring"
+ "type": {
+ "description": "The type of error, warning, or notice returned. Current set of possible values: - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. - MODE_ONLY_UP (WARNING): Autoscaling is in the \"Autoscale only out\" mode. The autoscaler can add instances but not remove any. - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.",
+ "type": "string",
+ "enum": [
+ "ALL_INSTANCES_UNHEALTHY",
+ "BACKEND_SERVICE_DOES_NOT_EXIST",
+ "CAPPED_AT_MAX_NUM_REPLICAS",
+ "CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE",
+ "CUSTOM_METRIC_INVALID",
+ "MIN_EQUALS_MAX",
+ "MISSING_CUSTOM_METRIC_DATA_POINTS",
+ "MISSING_LOAD_BALANCING_DATA_POINTS",
+ "MODE_OFF",
+ "MODE_ONLY_SCALE_OUT",
+ "MODE_ONLY_UP",
+ "MORE_THAN_ONE_BACKEND_SERVICE",
+ "NOT_ENOUGH_QUOTA_AVAILABLE",
+ "REGION_RESOURCE_STOCKOUT",
+ "SCALING_TARGET_DOES_NOT_EXIST",
+ "SCHEDULED_INSTANCES_GREATER_THAN_AUTOSCALER_MAX",
+ "SCHEDULED_INSTANCES_LESS_THAN_AUTOSCALER_MIN",
+ "UNKNOWN",
+ "UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION",
+ "ZONE_RESOURCE_STOCKOUT"
],
- "parameters": {
- "packetMirroring": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string",
- "description": "Name of the PacketMirroring resource to patch.",
- "required": true
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "region": {
- "description": "Name of the region for this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
- },
- "id": "compute.packetMirrorings.patch",
- "httpMethod": "PATCH",
- "request": {
- "$ref": "PacketMirroring"
+ "enumDescriptions": [
+ "All instances in the instance group are unhealthy (not in RUNNING state).",
+ "There is no backend service attached to the instance group.",
+ "Autoscaler recommends a size greater than maxNumReplicas.",
+ "The custom metric samples are not exported often enough to be a credible base for autoscaling.",
+ "The custom metric that was specified does not exist or does not have the necessary labels.",
+ "The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group.",
+ "The autoscaler did not receive any data from the custom metric configured for autoscaling.",
+ "The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer.",
+ "Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved.",
+ "Autoscaling is in the \"Autoscale only scale out\" mode. Instances in the group will be only added.",
+ "Autoscaling is in the \"Autoscale only out\" mode. Instances in the group will be only added.",
+ "The instance group cannot be autoscaled because it has more than one backend service attached to it.",
+ "There is insufficient quota for the necessary resources, such as CPU or number of instances.",
+ "Showed only for regional autoscalers: there is a resource stockout in the chosen region.",
+ "The target to be scaled does not exist.",
+ "For some scaling schedules minRequiredReplicas is greater than maxNumReplicas. Autoscaler always recommends at most maxNumReplicas instances.",
+ "For some scaling schedules minRequiredReplicas is less than minNumReplicas. Autoscaler always recommends at least minNumReplicas instances.",
+ "",
+ "Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate.",
+ "For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout."
+ ]
+ }
+ },
+ "type": "object",
+ "id": "AutoscalerStatusDetails"
+ },
+ "SourceDiskEncryptionKey": {
+ "properties": {
+ "diskEncryptionKey": {
+ "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.",
+ "$ref": "CustomerEncryptionKey"
+ },
+ "sourceDisk": {
+ "type": "string",
+ "description": "URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk "
+ }
+ },
+ "type": "object",
+ "id": "SourceDiskEncryptionKey"
+ },
+ "InstanceGroupManagersListErrorsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "items": {
+ "type": "array",
+ "description": "[Output Only] The list of errors of the managed instance group.",
+ "items": {
+ "$ref": "InstanceManagedByIgmError"
}
+ }
+ },
+ "id": "InstanceGroupManagersListErrorsResponse",
+ "type": "object"
+ },
+ "ServiceAccount": {
+ "properties": {
+ "email": {
+ "type": "string",
+ "description": "Email address of the service account."
},
- "insert": {
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "description": "Creates a PacketMirroring resource in the specified project and region using the data included in the request.",
- "flatPath": "projects/{project}/regions/{region}/packetMirrorings",
- "request": {
- "$ref": "PacketMirroring"
+ "scopes": {
+ "description": "The list of scopes to be made available for this service account.",
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "region"
- ],
- "id": "compute.packetMirrorings.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/packetMirrorings",
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "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).",
- "type": "string",
- "location": "query"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request.",
- "type": "string",
- "location": "path",
- "required": true
- }
+ "type": "array"
+ }
+ },
+ "description": "A service account.",
+ "type": "object",
+ "id": "ServiceAccount"
+ },
+ "RegionInstanceGroupManagersListErrorsResponse": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "description": "[Output Only] The list of errors of the managed instance group.",
+ "items": {
+ "$ref": "InstanceManagedByIgmError"
}
},
- "get": {
- "parameters": {
- "packetMirroring": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "description": "Name of the PacketMirroring resource to return."
- },
- "region": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request."
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "description": "Returns the specified PacketMirroring resource.",
- "response": {
- "$ref": "PacketMirroring"
- },
- "id": "compute.packetMirrorings.get",
- "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
- "parameterOrder": [
- "project",
- "region",
- "packetMirroring"
- ],
- "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET"
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ }
+ },
+ "id": "RegionInstanceGroupManagersListErrorsResponse",
+ "type": "object"
+ },
+ "BackendServiceCdnPolicyNegativeCachingPolicy": {
+ "properties": {
+ "code": {
+ "type": "integer",
+ "description": "The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.",
+ "format": "int32"
},
- "delete": {
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
- "description": "Deletes the specified PacketMirroring resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "region": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "packetMirroring": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "description": "Name of the PacketMirroring resource to delete.",
- "location": "path"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request."
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
- },
- "id": "compute.packetMirrorings.delete",
- "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
- "parameterOrder": [
- "project",
- "region",
- "packetMirroring"
- ]
+ "ttl": {
+ "type": "integer",
+ "description": "The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
+ "format": "int32"
+ }
+ },
+ "type": "object",
+ "description": "Specify CDN TTLs for response error codes.",
+ "id": "BackendServiceCdnPolicyNegativeCachingPolicy"
+ },
+ "ImageFamilyView": {
+ "type": "object",
+ "properties": {
+ "image": {
+ "description": "The latest image that is part of the specified image family in the requested location, and that is not deprecated.",
+ "$ref": "Image"
+ }
+ },
+ "id": "ImageFamilyView"
+ },
+ "PreconfiguredWafSet": {
+ "id": "PreconfiguredWafSet",
+ "properties": {
+ "expressionSets": {
+ "description": "List of entities that are currently supported for WAF rules.",
+ "type": "array",
+ "items": {
+ "$ref": "WafExpressionSet"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "DiskAggregatedList": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
},
- "testIamPermissions": {
- "response": {
- "$ref": "TestPermissionsResponse"
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.",
+ "default": "compute#diskAggregatedList",
+ "type": "string"
+ },
+ "items": {
+ "additionalProperties": {
+ "$ref": "DisksScopedList",
+ "description": "[Output Only] Name of the scope containing this set of disks."
},
- "description": "Returns permissions that a caller has on the specified resource.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "parameters": {
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "required": true
+ "description": "A list of DisksScopedList resources.",
+ "type": "object"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
},
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string"
},
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "description": "The name of the region for this request."
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
+ }
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions",
- "id": "compute.packetMirrorings.testIamPermissions",
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions",
- "request": {
- "$ref": "TestPermissionsRequest"
+ "type": "array",
+ "description": "[Output Only] Unreachable resources."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "id": "DiskAggregatedList",
+ "type": "object"
+ },
+ "NodeTemplatesScopedList": {
+ "properties": {
+ "nodeTemplates": {
+ "type": "array",
+ "description": "[Output Only] A list of node templates contained in this scope.",
+ "items": {
+ "$ref": "NodeTemplate"
}
},
- "list": {
- "parameters": {
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "region": {
- "required": true,
- "description": "Name of the region for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ "warning": {
+ "description": "[Output Only] An informational warning that appears when the node templates list is empty.",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "location": "query"
- },
- "maxResults": {
- "location": "query",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "minimum": "0",
- "type": "integer"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "project": {
+ "message": {
"type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "description": "Retrieves a list of PacketMirroring resources available to the specified project and region.",
- "path": "projects/{project}/regions/{region}/packetMirrorings",
- "flatPath": "projects/{project}/regions/{region}/packetMirrorings",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "id": "compute.packetMirrorings.list",
- "response": {
- "$ref": "PacketMirroringList"
- },
- "parameterOrder": [
- "project",
- "region"
- ]
+ "type": "object"
}
- }
+ },
+ "type": "object",
+ "id": "NodeTemplatesScopedList"
},
- "globalOperations": {
- "methods": {
- "wait": {
- "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ",
- "parameters": {
- "project": {
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "operation": {
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the Operations resource to return."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/global/operations/{operation}/wait",
- "id": "compute.globalOperations.wait",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "operation"
- ],
- "path": "projects/{project}/global/operations/{operation}/wait"
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "GET",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "operation": {
- "description": "Name of the Operations resource to return.",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- }
+ "MachineTypesScopedList": {
+ "type": "object",
+ "properties": {
+ "machineTypes": {
+ "items": {
+ "$ref": "MachineType"
},
- "id": "compute.globalOperations.get",
- "parameterOrder": [
- "project",
- "operation"
- ],
- "description": "Retrieves the specified Operations resource.",
- "flatPath": "projects/{project}/global/operations/{operation}",
- "path": "projects/{project}/global/operations/{operation}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "description": "[Output Only] A list of machine types contained in this scope.",
+ "type": "array"
},
- "list": {
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/global/operations",
- "description": "Retrieves a list of Operation resources contained within the specified project.",
- "response": {
- "$ref": "OperationList"
- },
- "path": "projects/{project}/global/operations",
- "parameterOrder": [
- "project"
- ],
- "id": "compute.globalOperations.list",
- "parameters": {
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "project": {
- "description": "Project ID for this request.",
+ "warning": {
+ "description": "[Output Only] An informational warning that appears when the machine types list is empty.",
+ "type": "object",
+ "properties": {
+ "message": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path"
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "location": "query",
- "default": "500",
- "minimum": "0",
- "format": "uint32"
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "type": "string"
}
}
- },
- "delete": {
- "flatPath": "projects/{project}/global/operations/{operation}",
- "parameters": {
- "operation": {
- "description": "Name of the Operations resource to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
+ }
+ },
+ "id": "MachineTypesScopedList"
+ },
+ "InstanceReference": {
+ "properties": {
+ "instance": {
+ "description": "The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances",
+ "type": "string"
+ }
+ },
+ "id": "InstanceReference",
+ "type": "object"
+ },
+ "TargetVpnGatewayList": {
+ "description": "Contains a list of TargetVpnGateway resources.",
+ "properties": {
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ },
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "required": true
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "parameterOrder": [
- "project",
- "operation"
- ],
- "id": "compute.globalOperations.delete",
- "description": "Deletes the specified Operations resource.",
- "httpMethod": "DELETE",
- "path": "projects/{project}/global/operations/{operation}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "type": "object"
},
- "aggregatedList": {
- "response": {
- "$ref": "OperationAggregatedList"
- },
- "description": "Retrieves an aggregated list of all operations.",
- "httpMethod": "GET",
- "parameters": {
- "includeAllScopes": {
- "type": "boolean",
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "location": "query",
- "minimum": "0",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "type": "integer"
- }
+ "kind": {
+ "type": "string",
+ "default": "compute#targetVpnGatewayList",
+ "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "items": {
+ "items": {
+ "$ref": "TargetVpnGateway"
},
- "id": "compute.globalOperations.aggregatedList",
- "flatPath": "projects/{project}/aggregated/operations",
- "path": "projects/{project}/aggregated/operations",
- "parameterOrder": [
- "project"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "type": "array",
+ "description": "A list of TargetVpnGateway resources."
}
- }
+ },
+ "id": "TargetVpnGatewayList",
+ "type": "object"
},
- "images": {
- "methods": {
- "deprecate": {
- "parameterOrder": [
- "project",
- "image"
+ "HealthCheckServiceReference": {
+ "description": "A full or valid partial URL to a health check service. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service - projects/project-id/regions/us-west1/healthCheckServices/health-check-service - regions/us-west1/healthCheckServices/health-check-service ",
+ "id": "HealthCheckServiceReference",
+ "properties": {
+ "healthCheckService": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SecurityPolicyRuleRedirectOptions": {
+ "id": "SecurityPolicyRuleRedirectOptions",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
],
- "path": "projects/{project}/global/images/{image}/deprecate",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/global/images/{image}/deprecate",
- "id": "compute.images.deprecate",
- "request": {
- "$ref": "DeprecationStatus"
- },
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enum": [
+ "EXTERNAL_302",
+ "GOOGLE_RECAPTCHA"
],
- "description": "Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.",
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "image": {
- "description": "Image name.",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- }
- }
+ "description": "Type of the redirect action."
},
- "testIamPermissions": {
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "parameters": {
- "resource": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name or id of the resource for this request.",
- "required": true
- },
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- }
+ "target": {
+ "description": "Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "HttpFaultDelay": {
+ "id": "HttpFaultDelay",
+ "properties": {
+ "fixedDelay": {
+ "$ref": "Duration",
+ "description": "Specifies the value of the fixed delay interval."
+ },
+ "percentage": {
+ "format": "double",
+ "type": "number",
+ "description": "The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive."
+ }
+ },
+ "description": "Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.",
+ "type": "object"
+ },
+ "InstanceParams": {
+ "type": "object",
+ "properties": {
+ "resourceManagerTags": {
+ "additionalProperties": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "object",
+ "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."
+ }
+ },
+ "id": "InstanceParams",
+ "description": "Additional instance params."
+ },
+ "LogConfigDataAccessOptions": {
+ "description": "This is deprecated and has no effect. Do not use.",
+ "id": "LogConfigDataAccessOptions",
+ "properties": {
+ "logMode": {
+ "description": "This is deprecated and has no effect. Do not use.",
+ "enum": [
+ "LOG_FAIL_CLOSED",
+ "LOG_MODE_UNSPECIFIED"
],
- "id": "compute.images.testIamPermissions",
- "flatPath": "projects/{project}/global/images/{resource}/testIamPermissions",
- "parameterOrder": [
- "project",
- "resource"
+ "enumDescriptions": [
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use."
],
- "httpMethod": "POST",
- "path": "projects/{project}/global/images/{resource}/testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource."
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SignedUrlKey": {
+ "type": "object",
+ "properties": {
+ "keyValue": {
+ "type": "string",
+ "description": "128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string."
},
- "patch": {
- "parameterOrder": [
- "project",
- "image"
- ],
- "httpMethod": "PATCH",
- "path": "projects/{project}/global/images/{image}",
- "description": "Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "keyName": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the key. 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."
+ }
+ },
+ "description": "Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs",
+ "id": "SignedUrlKey"
+ },
+ "ShareSettings": {
+ "type": "object",
+ "id": "ShareSettings",
+ "properties": {
+ "shareType": {
+ "type": "string",
+ "description": "Type of sharing for this shared-reservation",
+ "enum": [
+ "LOCAL",
+ "ORGANIZATION",
+ "SHARE_TYPE_UNSPECIFIED",
+ "SPECIFIC_PROJECTS"
],
- "flatPath": "projects/{project}/global/images/{image}",
- "request": {
- "$ref": "Image"
- },
- "parameters": {
- "image": {
- "location": "path",
- "description": "Name of the image resource to patch.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
- },
- "id": "compute.images.patch",
- "response": {
- "$ref": "Operation"
- }
+ "enumDescriptions": [
+ "Default value.",
+ "Shared-reservation is open to entire Organization",
+ "Default value. This value is unused.",
+ "Shared-reservation is open to specific projects"
+ ]
},
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
+ "projectMap": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "ShareSettingsProjectConfig"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/global/images/{resource}/getIamPolicy",
- "id": "compute.images.getIamPolicy",
- "httpMethod": "GET",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "parameters": {
- "resource": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name or id of the resource for this request.",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path"
- },
- "optionsRequestedPolicyVersion": {
- "location": "query",
- "description": "Requested IAM Policy version.",
- "type": "integer",
- "format": "int32"
- }
+ "description": "A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS."
+ }
+ },
+ "description": "The share setting for reservations and sole tenancy node groups."
+ },
+ "VpnTunnelsScopedList": {
+ "properties": {
+ "vpnTunnels": {
+ "description": "A list of VPN tunnels contained in this scope.",
+ "items": {
+ "$ref": "VpnTunnel"
},
- "flatPath": "projects/{project}/global/images/{resource}/getIamPolicy",
- "parameterOrder": [
- "project",
- "resource"
- ]
+ "type": "array"
},
- "getFromFamily": {
- "id": "compute.images.getFromFamily",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "family"
- ],
- "httpMethod": "GET",
- "parameters": {
- "family": {
- "description": "Name of the image family to search for.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "warning": {
+ "properties": {
+ "message": {
"type": "string",
- "location": "path",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "required": true
- }
- },
- "path": "projects/{project}/global/images/family/{family}",
- "flatPath": "projects/{project}/global/images/family/{family}",
- "description": "Returns the latest image that is part of an image family and is not deprecated.",
- "response": {
- "$ref": "Image"
- }
- },
- "setLabels": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/global/images/{resource}/setLabels",
- "id": "compute.images.setLabels",
- "parameterOrder": [
- "project",
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "description": "Name or id of the resource for this request."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
}
},
- "request": {
- "$ref": "GlobalSetLabelsRequest"
- },
- "response": {
- "$ref": "Operation"
+ "description": "Informational warning which replaces the list of addresses when the list is empty.",
+ "type": "object"
+ }
+ },
+ "id": "VpnTunnelsScopedList",
+ "type": "object"
+ },
+ "CacheKeyPolicy": {
+ "description": "Message containing what to include in the cache key for a request for Cloud CDN.",
+ "id": "CacheKeyPolicy",
+ "type": "object",
+ "properties": {
+ "queryStringWhitelist": {
+ "items": {
+ "type": "string"
},
- "description": "Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.",
- "path": "projects/{project}/global/images/{resource}/setLabels"
+ "type": "array",
+ "description": "Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters."
},
- "get": {
- "path": "projects/{project}/global/images/{image}",
- "httpMethod": "GET",
- "response": {
- "$ref": "Image"
+ "includeHost": {
+ "type": "boolean",
+ "description": "If true, requests to different hosts will be cached separately."
+ },
+ "includeQueryString": {
+ "type": "boolean",
+ "description": "If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely."
+ },
+ "includeProtocol": {
+ "description": "If true, http and https requests will be cached separately.",
+ "type": "boolean"
+ },
+ "includeNamedCookies": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/global/images/{image}",
- "id": "compute.images.get",
- "parameterOrder": [
- "project",
- "image"
+ "description": "Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.",
+ "type": "array"
+ },
+ "includeHttpHeaders": {
+ "description": "Allows HTTP request headers (by name) to be used in the cache key.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "queryStringBlacklist": {
+ "description": "Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ReservationAffinity": {
+ "properties": {
+ "consumeReservationType": {
+ "description": "Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.",
+ "type": "string",
+ "enum": [
+ "ANY_RESERVATION",
+ "NO_RESERVATION",
+ "SPECIFIC_RESERVATION",
+ "UNSPECIFIED"
],
- "parameters": {
- "image": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the image resource to return."
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- }
- },
- "description": "Returns the specified image. Gets a list of available images by making a list() request.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enumDescriptions": [
+ "Consume any allocation available.",
+ "Do not consume from any allocated capacity.",
+ "Must consume from a specific reservation. Must specify key value fields for specifying the reservations.",
+ ""
]
},
- "insert": {
- "id": "compute.images.insert",
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "POST",
- "description": "Creates an image in the specified project using the data included in the request.",
- "path": "projects/{project}/global/images",
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "forceCreate": {
- "type": "boolean",
- "location": "query",
- "description": "Force image creation if true."
- },
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request."
- }
+ "key": {
+ "description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.",
+ "type": "string"
+ },
+ "values": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/devstorage.full_control",
- "https://www.googleapis.com/auth/devstorage.read_only",
- "https://www.googleapis.com/auth/devstorage.read_write"
- ],
- "response": {
- "$ref": "Operation"
+ "description": "Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or \"projects/different-project/reservations/some-reservation-name\" to target a shared reservation in the same zone but in a different project.",
+ "type": "array"
+ }
+ },
+ "type": "object",
+ "description": "Specifies the reservations that this instance can consume from.",
+ "id": "ReservationAffinity"
+ },
+ "InstanceMoveRequest": {
+ "id": "InstanceMoveRequest",
+ "type": "object",
+ "properties": {
+ "targetInstance": {
+ "type": "string",
+ "description": "The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance "
+ },
+ "destinationZone": {
+ "type": "string",
+ "description": "The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone "
+ }
+ }
+ },
+ "AcceleratorTypeAggregatedList": {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types.",
+ "default": "compute#acceleratorTypeAggregatedList"
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "request": {
- "$ref": "Image"
+ "type": "array",
+ "description": "[Output Only] Unreachable resources."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "items": {
+ "additionalProperties": {
+ "description": "[Output Only] Name of the scope containing this set of accelerator types.",
+ "$ref": "AcceleratorTypesScopedList"
},
- "flatPath": "projects/{project}/global/images"
+ "type": "object",
+ "description": "A list of AcceleratorTypesScopedList resources."
},
- "delete": {
- "description": "Deletes the specified image.",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string"
- },
- "requestId": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "message": {
"type": "string",
- "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"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "image": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array"
+ },
+ "code": {
"type": "string",
- "description": "Name of the image resource to delete.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
},
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "object"
+ }
+ },
+ "id": "AcceleratorTypeAggregatedList"
+ },
+ "XpnResourceId": {
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "",
+ ""
],
- "flatPath": "projects/{project}/global/images/{image}",
- "parameterOrder": [
- "project",
- "image"
+ "type": "string",
+ "description": "The type of the service resource.",
+ "enum": [
+ "PROJECT",
+ "XPN_RESOURCE_TYPE_UNSPECIFIED"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678)."
+ }
+ },
+ "description": "Service resource (a.k.a service project) ID.",
+ "type": "object",
+ "id": "XpnResourceId"
+ },
+ "InstanceGroupManagerUpdatePolicy": {
+ "id": "InstanceGroupManagerUpdatePolicy",
+ "type": "object",
+ "properties": {
+ "minimalAction": {
+ "type": "string",
+ "enumDescriptions": [
+ "Do not perform any action.",
+ "Updates applied in runtime, instances will not be disrupted.",
+ "Old instances will be deleted. New instances will be created from the target template.",
+ "Every instance will be restarted."
],
- "id": "compute.images.delete",
- "path": "projects/{project}/global/images/{image}"
+ "description": "Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary. - To limit disruption as much as possible, set the minimal action to REFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to RESTART or REPLACE. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to RESTART in order to pick up metadata changes. ",
+ "enum": [
+ "NONE",
+ "REFRESH",
+ "REPLACE",
+ "RESTART"
+ ]
},
- "setIamPolicy": {
- "parameters": {
- "resource": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "required": true
- }
- },
- "path": "projects/{project}/global/images/{resource}/setIamPolicy",
- "parameterOrder": [
- "project",
- "resource"
+ "type": {
+ "description": "The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).",
+ "enum": [
+ "OPPORTUNISTIC",
+ "PROACTIVE"
],
- "flatPath": "projects/{project}/global/images/{resource}/setIamPolicy",
- "id": "compute.images.setIamPolicy",
- "response": {
- "$ref": "Policy"
- },
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "enumDescriptions": [
+ "No action is being proactively performed in order to bring this IGM to its target version distribution (regardless of whether this distribution is expressed using instanceTemplate or versions field).",
+ "This IGM will actively converge to its target version distribution (regardless of whether this distribution is expressed using instanceTemplate or versions field)."
+ ]
+ },
+ "replacementMethod": {
+ "type": "string",
+ "description": "What action should be used to replace instances. See minimal_action.REPLACE",
+ "enum": [
+ "RECREATE",
+ "SUBSTITUTE"
],
- "request": {
- "$ref": "GlobalSetPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy."
+ "enumDescriptions": [
+ "Instances will be recreated (with the same name)",
+ "Default option: instances will be deleted and created (with a new name)"
+ ]
},
- "list": {
- "path": "projects/{project}/global/images",
- "flatPath": "projects/{project}/global/images",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "maxUnavailable": {
+ "$ref": "FixedOrPercent",
+ "description": "The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable."
+ },
+ "instanceRedistributionType": {
+ "enum": [
+ "NONE",
+ "PROACTIVE"
],
- "id": "compute.images.list",
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
+ "type": "string",
+ "description": "The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. ",
+ "enumDescriptions": [
+ "No action is being proactively performed in order to bring this IGM to its target instance distribution.",
+ "This IGM will actively converge to its target instance distribution."
+ ]
+ },
+ "mostDisruptiveAllowedAction": {
+ "description": "Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.",
+ "enum": [
+ "NONE",
+ "REFRESH",
+ "REPLACE",
+ "RESTART"
],
- "description": "Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.",
- "response": {
- "$ref": "ImageList"
- },
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "filter": {
- "location": "query",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not perform any action.",
+ "Updates applied in runtime, instances will not be disrupted.",
+ "Old instances will be deleted. New instances will be created from the target template.",
+ "Every instance will be restarted."
+ ]
+ },
+ "maxSurge": {
+ "$ref": "FixedOrPercent",
+ "description": "The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge."
+ }
+ }
+ },
+ "TargetHttpsProxiesSetCertificateMapRequest": {
+ "id": "TargetHttpsProxiesSetCertificateMapRequest",
+ "properties": {
+ "certificateMap": {
+ "description": "URL of the Certificate Map to associate with this TargetHttpsProxy.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PublicDelegatedPrefixList": {
+ "id": "PublicDelegatedPrefixList",
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefixList for public delegated prefixes.",
+ "type": "string",
+ "default": "compute#publicDelegatedPrefixList"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "maxResults": {
- "format": "uint32",
- "default": "500",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "minimum": "0"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "orderBy": {
+ "message": {
"type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
+ },
+ "type": "object"
+ },
+ "items": {
+ "type": "array",
+ "description": "A list of PublicDelegatedPrefix resources.",
+ "items": {
+ "$ref": "PublicDelegatedPrefix"
}
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
}
}
},
- "imageFamilyViews": {
- "methods": {
- "get": {
- "parameters": {
- "zone": {
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request."
+ "SslCertificatesScopedList": {
+ "id": "SslCertificatesScopedList",
+ "properties": {
+ "warning": {
+ "description": "Informational warning which replaces the list of backend services when the list is empty.",
+ "properties": {
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "family": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the image family to search for.",
- "location": "path",
- "required": true,
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "type": "string"
}
},
- "id": "compute.imageFamilyViews.get",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "zone",
- "family"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/zones/{zone}/imageFamilyViews/{family}",
- "response": {
- "$ref": "ImageFamilyView"
- },
- "description": "Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.",
- "flatPath": "projects/{project}/zones/{zone}/imageFamilyViews/{family}"
+ "type": "object"
+ },
+ "sslCertificates": {
+ "type": "array",
+ "description": "List of SslCertificates contained in this scope.",
+ "items": {
+ "$ref": "SslCertificate"
+ }
}
- }
+ },
+ "type": "object"
},
- "securityPolicies": {
- "methods": {
- "setLabels": {
- "description": "Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.",
- "id": "compute.securityPolicies.setLabels",
- "flatPath": "projects/{project}/global/securityPolicies/{resource}/setLabels",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/securityPolicies/{resource}/setLabels",
- "parameterOrder": [
- "project",
- "resource"
- ],
- "request": {
- "$ref": "GlobalSetLabelsRequest"
- },
- "httpMethod": "POST",
- "parameters": {
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string"
+ "ForwardingRuleServiceDirectoryRegistration": {
+ "description": "Describes the auto-registration of the Forwarding Rule to Service Directory. The region and project of the Service Directory resource generated from this registration will be the same as this Forwarding Rule.",
+ "properties": {
+ "service": {
+ "type": "string",
+ "description": "Service Directory service to register the forwarding rule under."
+ },
+ "serviceDirectoryRegion": {
+ "description": "[Optional] Service Directory region to register this global forwarding rule under. Default to \"us-central1\". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.",
+ "type": "string"
+ },
+ "namespace": {
+ "description": "Service Directory namespace to register the forwarding rule under.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "ForwardingRuleServiceDirectoryRegistration"
+ },
+ "CommitmentsScopedList": {
+ "type": "object",
+ "id": "CommitmentsScopedList",
+ "properties": {
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning which replaces the list of commitments when the list is empty.",
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "type": "string",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "resource": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "message": {
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
- "description": "Name or id of the resource for this request."
+ "description": "[Output Only] A human-readable description of the warning code."
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ }
},
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
+ "commitments": {
+ "items": {
+ "$ref": "Commitment"
},
- "httpMethod": "DELETE",
- "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}",
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "securityPolicy": {
+ "type": "array",
+ "description": "[Output Only] A list of commitments contained in this scope."
+ }
+ }
+ },
+ "AdvancedMachineFeatures": {
+ "properties": {
+ "enableUefiNetworking": {
+ "type": "boolean",
+ "description": "Whether to enable UEFI networking for instance creation."
+ },
+ "visibleCoreCount": {
+ "type": "integer",
+ "description": "The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.",
+ "format": "int32"
+ },
+ "threadsPerCore": {
+ "format": "int32",
+ "description": "The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.",
+ "type": "integer"
+ },
+ "enableNestedVirtualization": {
+ "type": "boolean",
+ "description": "Whether to enable nested virtualization or not (default is false)."
+ }
+ },
+ "type": "object",
+ "description": "Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled).",
+ "id": "AdvancedMachineFeatures"
+ },
+ "NodeTemplateList": {
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "kind": {
+ "default": "compute#nodeTemplateList",
+ "type": "string",
+ "description": "[Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates."
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "message": {
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the security policy to delete.",
- "required": true,
- "location": "path"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "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).",
- "location": "query",
- "type": "string"
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "type": "string",
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
+ }
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "items": {
+ "items": {
+ "$ref": "NodeTemplate"
},
- "description": "Deletes the specified policy.",
- "path": "projects/{project}/global/securityPolicies/{securityPolicy}",
- "parameterOrder": [
- "project",
- "securityPolicy"
- ],
- "id": "compute.securityPolicies.delete"
+ "type": "array",
+ "description": "A list of NodeTemplate resources."
+ }
+ },
+ "id": "NodeTemplateList",
+ "description": "Contains a list of node templates."
+ },
+ "SerialPortOutput": {
+ "description": "An instance serial console output.",
+ "type": "object",
+ "properties": {
+ "start": {
+ "format": "int64",
+ "description": "The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request.",
+ "type": "string"
},
- "getRule": {
- "id": "compute.securityPolicies.getRule",
- "parameters": {
- "securityPolicy": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the security policy to which the queried rule belongs."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true
- },
- "priority": {
- "format": "int32",
- "description": "The priority of the rule to get from the security policy.",
- "location": "query",
- "type": "integer"
- }
+ "contents": {
+ "type": "string",
+ "description": "[Output Only] The contents of the console output."
+ },
+ "next": {
+ "format": "int64",
+ "description": "[Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#serialPortOutput",
+ "description": "[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output."
+ }
+ },
+ "id": "SerialPortOutput"
+ },
+ "SecurityPolicyRuleMatcherConfig": {
+ "properties": {
+ "srcIpRanges": {
+ "items": {
+ "type": "string"
},
- "description": "Gets a rule at the specified priority.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "SecurityPolicyRule"
+ "description": "CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.",
+ "type": "array"
+ }
+ },
+ "id": "SecurityPolicyRuleMatcherConfig",
+ "type": "object"
+ },
+ "AutoscalersScopedList": {
+ "properties": {
+ "autoscalers": {
+ "items": {
+ "$ref": "Autoscaler"
},
- "httpMethod": "GET",
- "path": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule",
- "parameterOrder": [
- "project",
- "securityPolicy"
- ],
- "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule"
+ "type": "array",
+ "description": "[Output Only] A list of autoscalers contained in this scope."
},
- "list": {
- "response": {
- "$ref": "SecurityPolicyList"
- },
- "parameterOrder": [
- "project"
- ],
- "path": "projects/{project}/global/securityPolicies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
+ "warning": {
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
},
- "pageToken": {
- "location": "query",
+ "message": {
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "maxResults": {
- "format": "uint32",
- "minimum": "0",
- "location": "query",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "project": {
- "location": "path",
- "required": true,
+ "code": {
"type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "httpMethod": "GET",
- "description": "List all the policies that have been configured for the specified project.",
- "id": "compute.securityPolicies.list",
- "flatPath": "projects/{project}/global/securityPolicies"
+ "description": "[Output Only] Informational warning which replaces the list of autoscalers when the list is empty.",
+ "type": "object"
+ }
+ },
+ "id": "AutoscalersScopedList",
+ "type": "object"
+ },
+ "VpnTunnelList": {
+ "type": "object",
+ "id": "VpnTunnelList",
+ "properties": {
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
},
- "addRule": {
- "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.securityPolicies.addRule",
- "path": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule",
- "parameterOrder": [
- "project",
- "securityPolicy"
- ],
- "parameters": {
- "securityPolicy": {
+ "warning": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "Name of the security policy to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "validateOnly": {
- "type": "boolean",
- "location": "query",
- "description": "If true, the request will not be committed."
+ "message": {
+ "type": "string",
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "SecurityPolicyRule"
+ "description": "[Output Only] Informational warning message."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "VpnTunnel"
},
- "description": "Inserts a rule into a security policy."
+ "description": "A list of VpnTunnel resources."
},
- "removeRule": {
- "id": "compute.securityPolicies.removeRule",
- "parameters": {
- "securityPolicy": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string",
- "description": "Name of the security policy to update."
- },
- "priority": {
- "location": "query",
- "description": "The priority of the rule to remove from the security policy.",
- "format": "int32",
- "type": "integer"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "description": "Project ID for this request."
- }
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
+ "default": "compute#vpnTunnelList"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ }
+ },
+ "description": "Contains a list of VpnTunnel resources."
+ },
+ "SslPoliciesAggregatedList": {
+ "properties": {
+ "unreachables": {
+ "description": "[Output Only] Unreachable resources.",
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/global/securityPolicies/{securityPolicy}/removeRule",
- "description": "Deletes a rule at the specified priority.",
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "securityPolicy"
- ],
- "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/removeRule",
- "response": {
- "$ref": "Operation"
- }
+ "type": "array"
},
- "insert": {
- "flatPath": "projects/{project}/global/securityPolicies",
- "path": "projects/{project}/global/securityPolicies",
- "id": "compute.securityPolicies.insert",
- "parameterOrder": [
- "project"
- ],
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "etag": {
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "required": true,
- "description": "Project ID for this request."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "validateOnly": {
- "type": "boolean",
- "description": "If true, the request will not be committed.",
- "location": "query"
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
},
- "request": {
- "$ref": "SecurityPolicy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Creates a new policy in the specified project using the data included in the request.",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST"
+ "type": "object"
},
- "get": {
- "path": "projects/{project}/global/securityPolicies/{securityPolicy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}",
- "id": "compute.securityPolicies.get",
- "parameterOrder": [
- "project",
- "securityPolicy"
- ],
- "description": "List all of the ordered rules present in a single specified policy.",
- "httpMethod": "GET",
- "response": {
- "$ref": "SecurityPolicy"
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Name of the scope containing this set of SSL policies.",
+ "$ref": "SslPoliciesScopedList"
},
- "parameters": {
- "securityPolicy": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the security policy to get.",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path"
- }
+ "description": "A list of SslPoliciesScopedList resources."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#sslPoliciesAggregatedList",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#sslPolicyAggregatedList for lists of SSL Policies."
+ }
+ },
+ "type": "object",
+ "id": "SslPoliciesAggregatedList"
+ },
+ "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig": {
+ "type": "object",
+ "properties": {
+ "contentTypes": {
+ "type": "array",
+ "description": "A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type \"/\" subtype *[\";\" parameter] When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.",
+ "items": {
+ "type": "string"
}
+ }
+ },
+ "id": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig"
+ },
+ "InstanceList": {
+ "type": "object",
+ "id": "InstanceList",
+ "description": "Contains a list of instances.",
+ "properties": {
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
},
- "patch": {
- "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.",
- "id": "compute.securityPolicies.patch",
- "request": {
- "$ref": "SecurityPolicy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "PATCH",
- "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}",
- "parameterOrder": [
- "project",
- "securityPolicy"
- ],
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/securityPolicies/{securityPolicy}",
- "parameters": {
- "securityPolicy": {
- "type": "string",
- "required": true,
- "description": "Name of the security policy to update.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "kind": {
+ "default": "compute#instanceList",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "warning": {
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "type": "array"
},
- "project": {
+ "message": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "requestId": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "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"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
- }
+ },
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
},
- "patchRule": {
- "parameters": {
- "securityPolicy": {
- "required": true,
- "description": "Name of the security policy to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "priority": {
- "type": "integer",
- "location": "query",
- "description": "The priority of the rule to patch.",
- "format": "int32"
- },
- "validateOnly": {
- "description": "If true, the request will not be committed.",
- "type": "boolean",
- "location": "query"
- }
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "type": "array",
+ "description": "A list of Instance resources.",
+ "items": {
+ "$ref": "Instance"
+ }
+ }
+ }
+ },
+ "HttpHeaderAction": {
+ "description": "The request and response header transformations that take effect before the request is passed along to the selected backendService.",
+ "id": "HttpHeaderAction",
+ "properties": {
+ "requestHeadersToAdd": {
+ "description": "Headers to add to a matching request before forwarding the request to the backendService.",
+ "items": {
+ "$ref": "HttpHeaderOption"
},
- "response": {
- "$ref": "Operation"
+ "type": "array"
+ },
+ "responseHeadersToAdd": {
+ "items": {
+ "$ref": "HttpHeaderOption"
},
- "id": "compute.securityPolicies.patchRule",
- "request": {
- "$ref": "SecurityPolicyRule"
+ "description": "Headers to add the response before sending the response back to the client.",
+ "type": "array"
+ },
+ "requestHeadersToRemove": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule",
- "description": "Patches a rule at the specified priority.",
- "parameterOrder": [
- "project",
- "securityPolicy"
- ],
- "path": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule",
- "httpMethod": "POST"
+ "type": "array",
+ "description": "A list of header names for headers that need to be removed from the request before forwarding the request to the backendService."
},
- "aggregatedList": {
- "httpMethod": "GET",
- "response": {
- "$ref": "SecurityPoliciesAggregatedList"
+ "responseHeadersToRemove": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Name of the project scoping this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "array",
+ "description": "A list of header names for headers that need to be removed from the response before sending the response back to the client."
+ }
+ },
+ "type": "object"
+ },
+ "RegionInstanceGroupsListInstances": {
+ "type": "object",
+ "id": "RegionInstanceGroupsListInstances",
+ "properties": {
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "pageToken": {
- "location": "query",
+ "code": {
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "includeAllScopes": {
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "maxResults": {
- "minimum": "0",
- "location": "query",
- "type": "integer",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ }
}
},
- "path": "projects/{project}/aggregated/securityPolicies",
- "parameterOrder": [
- "project"
+ "type": "object"
+ },
+ "items": {
+ "items": {
+ "$ref": "InstanceWithNamedPorts"
+ },
+ "description": "A list of InstanceWithNamedPorts resources.",
+ "type": "array"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "kind": {
+ "type": "string",
+ "description": "The resource type.",
+ "default": "compute#regionInstanceGroupsListInstances"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ }
+ },
+ "HttpFaultInjection": {
+ "id": "HttpFaultInjection",
+ "type": "object",
+ "properties": {
+ "abort": {
+ "$ref": "HttpFaultAbort",
+ "description": "The specification for how client requests are aborted as part of fault injection."
+ },
+ "delay": {
+ "$ref": "HttpFaultDelay",
+ "description": "The specification for how client requests are delayed as part of fault injection, before being sent to a backend service."
+ }
+ },
+ "description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests."
+ },
+ "FileContentBuffer": {
+ "properties": {
+ "fileType": {
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "description": "The file type of source file.",
+ "enum": [
+ "BIN",
+ "UNDEFINED",
+ "X509"
+ ]
+ },
+ "content": {
+ "type": "string",
+ "format": "byte",
+ "description": "The raw content in the secure keys file."
+ }
+ },
+ "type": "object",
+ "id": "FileContentBuffer"
+ },
+ "Tags": {
+ "type": "object",
+ "description": "A set of instance tags.",
+ "properties": {
+ "items": {
+ "description": "An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "fingerprint": {
+ "description": "Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance.",
+ "type": "string",
+ "format": "byte"
+ }
+ },
+ "id": "Tags"
+ },
+ "ProjectsSetDefaultNetworkTierRequest": {
+ "id": "ProjectsSetDefaultNetworkTierRequest",
+ "type": "object",
+ "properties": {
+ "networkTier": {
+ "type": "string",
+ "enumDescriptions": [
+ "Public internet quality with fixed bandwidth.",
+ "High quality, Google-grade network tier, support for all networking products.",
+ "Public internet quality, only limited support for other networking products.",
+ "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured."
],
- "description": "Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.",
- "flatPath": "projects/{project}/aggregated/securityPolicies",
- "id": "compute.securityPolicies.aggregatedList"
+ "description": "Default network tier to be set.",
+ "enum": [
+ "FIXED_STANDARD",
+ "PREMIUM",
+ "STANDARD",
+ "STANDARD_OVERRIDES_FIXED_STANDARD"
+ ]
+ }
+ }
+ },
+ "InstanceGroupManagerAggregatedList": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
},
- "listPreconfiguredExpressionSets": {
- "response": {
- "$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse"
+ "unreachables": {
+ "description": "[Output Only] Unreachable resources.",
+ "items": {
+ "type": "string"
},
- "httpMethod": "GET",
- "description": "Gets the current list of preconfigured Web Application Firewall (WAF) expressions.",
- "parameters": {
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "minimum": "0",
- "default": "500",
- "location": "query",
- "type": "integer"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ "type": "array"
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "filter": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.securityPolicies.listPreconfiguredExpressionSets",
- "flatPath": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets",
- "path": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets",
- "parameterOrder": [
- "project"
- ]
+ "description": "[Output Only] Informational warning message."
+ },
+ "items": {
+ "description": "A list of InstanceGroupManagersScopedList resources.",
+ "additionalProperties": {
+ "$ref": "InstanceGroupManagersScopedList",
+ "description": "[Output Only] The name of the scope that contains this set of managed instance groups."
+ },
+ "type": "object"
+ },
+ "kind": {
+ "default": "compute#instanceGroupManagerAggregatedList",
+ "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
}
- }
+ },
+ "id": "InstanceGroupManagerAggregatedList"
},
- "serviceAttachments": {
- "methods": {
- "aggregatedList": {
- "parameterOrder": [
- "project"
- ],
- "id": "compute.serviceAttachments.aggregatedList",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.",
- "response": {
- "$ref": "ServiceAttachmentAggregatedList"
+ "NetworkEdgeSecurityServicesScopedList": {
+ "type": "object",
+ "id": "NetworkEdgeSecurityServicesScopedList",
+ "properties": {
+ "networkEdgeSecurityServices": {
+ "items": {
+ "$ref": "NetworkEdgeSecurityService"
},
- "httpMethod": "GET",
- "path": "projects/{project}/aggregated/serviceAttachments",
- "parameters": {
- "includeAllScopes": {
- "location": "query",
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
- },
- "project": {
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Name of the project scoping this request."
- },
- "maxResults": {
- "default": "500",
- "format": "uint32",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "minimum": "0"
- },
- "filter": {
+ "description": "A list of NetworkEdgeSecurityServices contained in this scope.",
+ "type": "array"
+ },
+ "warning": {
+ "description": "Informational warning which replaces the list of security policies when the list is empty.",
+ "type": "object",
+ "properties": {
+ "code": {
"type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
+ "data": {
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "pageToken": {
+ "message": {
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
+ "description": "[Output Only] A human-readable description of the warning code."
}
- },
- "flatPath": "projects/{project}/aggregated/serviceAttachments"
+ }
+ }
+ }
+ },
+ "ResourcePolicySnapshotSchedulePolicyRetentionPolicy": {
+ "type": "object",
+ "properties": {
+ "maxRetentionDays": {
+ "format": "int32",
+ "description": "Maximum age of the snapshot that is allowed to be kept.",
+ "type": "integer"
},
- "insert": {
- "path": "projects/{project}/regions/{region}/serviceAttachments",
- "parameterOrder": [
- "project",
- "region"
+ "onSourceDiskDelete": {
+ "description": "Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.",
+ "type": "string",
+ "enum": [
+ "APPLY_RETENTION_POLICY",
+ "KEEP_AUTO_SNAPSHOTS",
+ "UNSPECIFIED_ON_SOURCE_DISK_DELETE"
],
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/serviceAttachments",
- "request": {
- "$ref": "ServiceAttachment"
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
+ }
+ },
+ "id": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy",
+ "description": "Policy for retention of scheduled snapshots."
+ },
+ "WafExpressionSet": {
+ "id": "WafExpressionSet",
+ "properties": {
+ "id": {
+ "description": "Google specified expression set ID. The format should be: - E.g. XSS-20170329 required",
+ "type": "string"
+ },
+ "aliases": {
+ "description": "A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like \"stable\" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "expressions": {
+ "type": "array",
+ "description": "List of available expressions.",
+ "items": {
+ "$ref": "WafExpressionSetExpression"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "NodeTypesScopedList": {
+ "properties": {
+ "nodeTypes": {
+ "items": {
+ "$ref": "NodeType"
},
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string"
- },
- "requestId": {
- "location": "query",
+ "description": "[Output Only] A list of node types contained in this scope.",
+ "type": "array"
+ },
+ "warning": {
+ "properties": {
+ "message": {
"type": "string",
- "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)."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "region": {
- "required": true,
- "location": "path",
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
+ },
+ "code": {
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region of this request."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "id": "compute.serviceAttachments.insert",
- "description": "Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request."
+ "type": "object",
+ "description": "[Output Only] An informational warning that appears when the node types list is empty."
+ }
+ },
+ "id": "NodeTypesScopedList",
+ "type": "object"
+ },
+ "ShieldedInstanceIdentityEntry": {
+ "description": "A Shielded Instance Identity Entry.",
+ "properties": {
+ "ekCert": {
+ "description": "A PEM-encoded X.509 certificate. This field can be empty.",
+ "type": "string"
},
- "delete": {
- "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "project": {
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "ekPub": {
+ "type": "string",
+ "description": "A PEM-encoded public key."
+ }
+ },
+ "id": "ShieldedInstanceIdentityEntry",
+ "type": "object"
+ },
+ "TargetPoolsScopedList": {
+ "id": "TargetPoolsScopedList",
+ "type": "object",
+ "properties": {
+ "targetPools": {
+ "items": {
+ "$ref": "TargetPool"
+ },
+ "type": "array",
+ "description": "A list of target pools contained in this scope."
+ },
+ "warning": {
+ "description": "Informational warning which replaces the list of addresses when the list is empty.",
+ "type": "object",
+ "properties": {
+ "message": {
"type": "string",
- "description": "Project ID for this request."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "serviceAttachment": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the ServiceAttachment resource to delete.",
- "required": true
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "Name of the region of this request.",
- "required": true,
- "type": "string"
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ }
}
- },
- "description": "Deletes the specified ServiceAttachment in the given scope",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "region",
- "serviceAttachment"
- ],
- "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ }
+ }
+ }
+ },
+ "ProjectsEnableXpnResourceRequest": {
+ "properties": {
+ "xpnResource": {
+ "description": "Service resource (a.k.a service project) ID.",
+ "$ref": "XpnResourceId"
+ }
+ },
+ "type": "object",
+ "id": "ProjectsEnableXpnResourceRequest"
+ },
+ "RouterBgpPeerBfd": {
+ "id": "RouterBgpPeerBfd",
+ "properties": {
+ "multiplier": {
+ "description": "The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "sessionInitializationMode": {
+ "description": "The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.",
+ "type": "string",
+ "enum": [
+ "ACTIVE",
+ "DISABLED",
+ "PASSIVE"
],
- "id": "compute.serviceAttachments.delete"
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
},
- "testIamPermissions": {
- "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name or id of the resource for this request."
+ "minReceiveInterval": {
+ "format": "uint32",
+ "description": "The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.",
+ "type": "integer"
+ },
+ "minTransmitInterval": {
+ "description": "The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.",
+ "type": "integer",
+ "format": "uint32"
+ }
+ },
+ "type": "object"
+ },
+ "PublicAdvertisedPrefixList": {
+ "id": "PublicAdvertisedPrefixList",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "description": "The name of the region for this request."
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path"
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
}
},
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of PublicAdvertisedPrefix resources.",
+ "type": "array",
+ "items": {
+ "$ref": "PublicAdvertisedPrefix"
+ }
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.",
+ "default": "compute#publicAdvertisedPrefixList"
+ }
+ }
+ },
+ "TargetSslProxiesSetProxyHeaderRequest": {
+ "type": "object",
+ "id": "TargetSslProxiesSetProxyHeaderRequest",
+ "properties": {
+ "proxyHeader": {
+ "enumDescriptions": [
+ "",
+ ""
],
- "id": "compute.serviceAttachments.testIamPermissions",
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "path": "projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource."
+ "description": "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.",
+ "type": "string",
+ "enum": [
+ "NONE",
+ "PROXY_V1"
+ ]
+ }
+ }
+ },
+ "InterconnectsGetDiagnosticsResponse": {
+ "type": "object",
+ "properties": {
+ "result": {
+ "$ref": "InterconnectDiagnostics"
+ }
+ },
+ "description": "Response for the InterconnectsGetDiagnosticsRequest.",
+ "id": "InterconnectsGetDiagnosticsResponse"
+ },
+ "GuestAttributes": {
+ "properties": {
+ "variableKey": {
+ "type": "string",
+ "description": "The key to search for."
},
- "patch": {
- "response": {
- "$ref": "Operation"
+ "queryPath": {
+ "description": "The path to be queried. This can be the default namespace ('') or a nested namespace ('\\/') or a specified key ('\\/\\').",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "kind": {
+ "default": "compute#guestAttributes",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry."
+ },
+ "queryValue": {
+ "$ref": "GuestAttributesValue",
+ "description": "[Output Only] The value of the requested queried path."
+ },
+ "variableValue": {
+ "type": "string",
+ "description": "[Output Only] The value found for the requested key."
+ }
+ },
+ "description": "A guest attributes entry.",
+ "id": "GuestAttributes",
+ "type": "object"
+ },
+ "SecurityPolicyList": {
+ "id": "SecurityPolicyList",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies",
+ "default": "compute#securityPolicyList"
+ },
+ "items": {
+ "description": "A list of SecurityPolicy resources.",
+ "items": {
+ "$ref": "SecurityPolicy"
},
- "httpMethod": "PATCH",
- "id": "compute.serviceAttachments.patch",
- "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
- "description": "Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
- "parameters": {
- "region": {
- "required": true,
- "type": "string",
- "description": "The region scoping this request and should conform to RFC1035.",
- "location": "path"
- },
- "serviceAttachment": {
+ "type": "array"
+ },
+ "warning": {
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "The resource id of the ServiceAttachment to patch. It should conform to RFC1035 resource name or be a string form on an unsigned long number.",
- "location": "path",
- "required": true
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path"
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "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).",
- "type": "string",
- "location": "query"
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
},
- "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "ServiceAttachment"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "ResourcePolicy": {
+ "properties": {
+ "instanceSchedulePolicy": {
+ "$ref": "ResourcePolicyInstanceSchedulePolicy",
+ "description": "Resource policy for scheduling instance operations."
+ },
+ "description": {
+ "type": "string"
+ },
+ "groupPlacementPolicy": {
+ "description": "Resource policy for instances for placement configuration.",
+ "$ref": "ResourcePolicyGroupPlacementPolicy"
+ },
+ "name": {
+ "description": "The name of the resource, provided by the client when initially creating the resource. The resource 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.",
+ "annotations": {
+ "required": [
+ "compute.instances.insert"
+ ]
},
- "parameterOrder": [
- "project",
- "region",
- "serviceAttachment"
- ]
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
},
- "get": {
- "parameterOrder": [
- "project",
- "region",
- "serviceAttachment"
+ "region": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "snapshotSchedulePolicy": {
+ "description": "Resource policy for persistent disks for creating snapshots.",
+ "$ref": "ResourcePolicySnapshotSchedulePolicy"
+ },
+ "resourceStatus": {
+ "description": "[Output Only] The system status of the resource policy.",
+ "$ref": "ResourcePolicyResourceStatus"
+ },
+ "status": {
+ "type": "string",
+ "enumDescriptions": [
+ "Resource policy is being created.",
+ "Resource policy is being deleted.",
+ "Resource policy is expired and will not run again.",
+ "",
+ "Resource policy is ready to be used."
],
- "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
- "parameters": {
- "project": {
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region of this request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "serviceAttachment": {
- "location": "path",
- "required": true,
- "description": "Name of the ServiceAttachment resource to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- }
- },
- "description": "Returns the specified ServiceAttachment resource in the given scope.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enum": [
+ "CREATING",
+ "DELETING",
+ "EXPIRED",
+ "INVALID",
+ "READY"
],
- "response": {
- "$ref": "ServiceAttachment"
- },
- "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
- "id": "compute.serviceAttachments.get",
- "httpMethod": "GET"
+ "description": "[Output Only] The status of resource policy creation."
},
- "setIamPolicy": {
- "request": {
- "$ref": "RegionSetPolicyRequest"
- },
- "parameters": {
- "resource": {
- "required": true,
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined fully-qualified URL for this resource."
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#resourcePolicy",
+ "description": "[Output Only] Type of the resource. Always compute#resource_policies for resource policies."
+ }
+ },
+ "description": "Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.",
+ "type": "object",
+ "id": "ResourcePolicy"
+ },
+ "ReservationsResizeRequest": {
+ "properties": {
+ "specificSkuCount": {
+ "description": "Number of allocated resources can be resized with minimum = 1 and maximum = 1000.",
+ "type": "string",
+ "format": "int64"
+ }
+ },
+ "id": "ReservationsResizeRequest",
+ "type": "object"
+ },
+ "InterconnectAttachmentAggregatedList": {
+ "id": "InterconnectAttachmentAggregatedList",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ }
},
- "region": {
- "location": "path",
- "description": "The name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string"
}
+ }
+ },
+ "kind": {
+ "default": "compute#interconnectAttachmentAggregatedList",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "items": {
+ "additionalProperties": {
+ "description": "Name of the scope containing this set of interconnect attachments.",
+ "$ref": "InterconnectAttachmentsScopedList"
},
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy",
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "id": "compute.serviceAttachments.setIamPolicy",
- "httpMethod": "POST",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy"
+ "type": "object",
+ "description": "A list of InterconnectAttachmentsScopedList resources."
},
- "list": {
- "description": "Lists the ServiceAttachments for a project in the given scope.",
- "response": {
- "$ref": "ServiceAttachmentList"
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/regions/{region}/serviceAttachments",
- "httpMethod": "GET",
- "id": "compute.serviceAttachments.list",
- "path": "projects/{project}/regions/{region}/serviceAttachments",
- "parameters": {
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "minimum": "0",
- "format": "uint32",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "region": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the region of this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- }
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array"
+ }
+ }
+ },
+ "HealthCheckService": {
+ "type": "object",
+ "id": "HealthCheckService",
+ "properties": {
+ "networkEndpointGroups": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "region"
- ]
+ "type": "array",
+ "description": "A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT."
},
- "getIamPolicy": {
- "httpMethod": "GET",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "response": {
- "$ref": "Policy"
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "fingerprint": {
+ "type": "string",
+ "description": "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 HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.",
+ "format": "byte"
+ },
+ "kind": {
+ "default": "compute#healthCheckService",
+ "type": "string",
+ "description": "[Output only] Type of the resource. Always compute#healthCheckServicefor health check services."
+ },
+ "name": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the resource. 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."
+ },
+ "healthChecks": {
+ "description": "A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "notificationEndpoints": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.",
+ "type": "array"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "healthStatusAggregationPolicy": {
+ "type": "string",
+ "enumDescriptions": [
+ "If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY.",
+ "An EndpointHealth message is returned for each backend in the health check service."
],
- "id": "compute.serviceAttachments.getIamPolicy",
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "description": "Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService.",
+ "enum": [
+ "AND",
+ "NO_AGGREGATION"
+ ]
+ }
+ },
+ "description": "Represents a Health-Check as a Service resource."
+ },
+ "InstanceGroupsListInstancesRequest": {
+ "id": "InstanceGroupsListInstancesRequest",
+ "properties": {
+ "instanceState": {
+ "enumDescriptions": [
+ "Includes all instances in the generated list regardless of their state.",
+ "Includes instances in the generated list only if they have a RUNNING state."
],
- "path": "projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy",
- "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy",
- "parameters": {
- "optionsRequestedPolicyVersion": {
- "format": "int32",
- "type": "integer",
- "location": "query",
- "description": "Requested IAM Policy version."
- },
- "resource": {
- "type": "string",
- "location": "path",
- "description": "Name or id of the resource for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- },
- "region": {
- "description": "The name of the region for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "required": true
- }
+ "description": "A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.",
+ "type": "string",
+ "enum": [
+ "ALL",
+ "RUNNING"
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "VmEndpointNatMappings": {
+ "description": "Contain information of Nat mapping for a VM endpoint (i.e., NIC).",
+ "id": "VmEndpointNatMappings",
+ "type": "object",
+ "properties": {
+ "interfaceNatMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "VmEndpointNatMappingsInterfaceNatMappings"
+ }
+ },
+ "instanceName": {
+ "description": "Name of the VM instance which the endpoint belongs to",
+ "type": "string"
+ }
+ }
+ },
+ "NetworksGetEffectiveFirewallsResponse": {
+ "properties": {
+ "firewalls": {
+ "type": "array",
+ "items": {
+ "$ref": "Firewall"
+ },
+ "description": "Effective firewalls on the network."
+ },
+ "firewallPolicys": {
+ "description": "Effective firewalls from firewall policy.",
+ "type": "array",
+ "items": {
+ "$ref": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
}
}
- }
+ },
+ "type": "object",
+ "id": "NetworksGetEffectiveFirewallsResponse"
},
- "regionDiskTypes": {
- "methods": {
- "list": {
- "path": "projects/{project}/regions/{region}/diskTypes",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "RegionDiskTypeList"
- },
- "httpMethod": "GET",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "maxResults": {
- "format": "uint32",
- "location": "query",
- "type": "integer",
- "minimum": "0",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
+ "BackendServiceAggregatedList": {
+ "id": "BackendServiceAggregatedList",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Type of resource.",
+ "default": "compute#backendServiceAggregatedList"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "type": "object",
+ "description": "A list of BackendServicesScopedList resources.",
+ "additionalProperties": {
+ "$ref": "BackendServicesScopedList",
+ "description": "Name of the scope containing this set of BackendServices."
+ }
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the region for this request.",
- "required": true,
+ "code": {
"type": "string",
- "location": "path"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "message": {
"type": "string",
- "location": "query"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "description": "Retrieves a list of regional disk types available to the specified project.",
- "id": "compute.regionDiskTypes.list",
- "parameterOrder": [
- "project",
- "region"
- ],
- "flatPath": "projects/{project}/regions/{region}/diskTypes"
+ "type": "object"
},
- "get": {
- "parameterOrder": [
- "project",
- "region",
- "diskType"
- ],
- "parameters": {
- "project": {
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "diskType": {
- "description": "Name of the disk type to return.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the region for this request."
- }
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "description": "Returns the specified regional disk type. Gets a list of available disk types by making a list() request.",
- "path": "projects/{project}/regions/{region}/diskTypes/{diskType}",
- "flatPath": "projects/{project}/regions/{region}/diskTypes/{diskType}",
- "id": "compute.regionDiskTypes.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "DiskType"
- }
+ "type": "array",
+ "description": "[Output Only] Unreachable resources."
}
- }
+ },
+ "type": "object",
+ "description": "Contains a list of BackendServicesScopedList."
},
- "publicAdvertisedPrefixes": {
- "methods": {
- "list": {
- "flatPath": "projects/{project}/global/publicAdvertisedPrefixes",
- "parameterOrder": [
- "project"
- ],
- "id": "compute.publicAdvertisedPrefixes.list",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "minimum": "0",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "location": "query"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
+ "PacketMirroringList": {
+ "id": "PacketMirroringList",
+ "description": "Contains a list of PacketMirroring resources.",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "properties": {
+ "code": {
"type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array"
},
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "message": {
"type": "string",
- "location": "query"
- },
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "httpMethod": "GET",
- "path": "projects/{project}/global/publicAdvertisedPrefixes",
- "description": "Lists the PublicAdvertisedPrefixes for a project.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "PublicAdvertisedPrefixList"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "items": {
+ "items": {
+ "$ref": "PacketMirroring"
+ },
+ "type": "array",
+ "description": "A list of PacketMirroring resources."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#packetMirroring for packetMirrorings.",
+ "default": "compute#packetMirroringList",
+ "type": "string"
+ }
+ }
+ },
+ "NetworkEndpointGroupCloudRun": {
+ "id": "NetworkEndpointGroupCloudRun",
+ "properties": {
+ "urlMask": {
+ "type": "string",
+ "description": "A template to parse \u003cservice\u003e and \u003ctag\u003e fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs \"foo1.domain.com/bar1\" and \"foo1.domain.com/bar2\" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask \"\u003ctag\u003e.domain.com/\u003cservice\u003e\". The URL mask will parse them to { service=\"bar1\", tag=\"foo1\" } and { service=\"bar2\", tag=\"foo2\" } respectively."
+ },
+ "tag": {
+ "type": "string",
+ "description": "Optional Cloud Run tag represents the \"named-revision\" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: \"revision-0010\"."
+ },
+ "service": {
+ "description": "Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: \"run-service\".",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "description": "Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG."
+ },
+ "BulkInsertInstanceResource": {
+ "properties": {
+ "sourceInstanceTemplate": {
+ "type": "string",
+ "description": "Specifies the instance template from which to create instances. You may combine sourceInstanceTemplate with instanceProperties to override specific values from an existing instance template. Bulk API follows the semantics of JSON Merge Patch described by RFC 7396. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate This field is optional."
+ },
+ "instanceProperties": {
+ "$ref": "InstanceProperties",
+ "description": "The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided."
+ },
+ "perInstanceProperties": {
+ "description": "Per-instance properties to be set on individual instances. Keys of this map specify requested instance names. Can be empty if name_pattern is used.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "BulkInsertInstanceResourcePerInstanceProperties"
}
},
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "locationPolicy": {
+ "$ref": "LocationPolicy",
+ "description": "Policy for chosing target zone. For more information, see Create VMs in bulk ."
+ },
+ "namePattern": {
+ "type": "string",
+ "description": "The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters."
+ },
+ "count": {
+ "format": "int64",
+ "description": "The maximum number of instances to create.",
+ "type": "string"
+ },
+ "minCount": {
+ "description": "The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted.",
+ "type": "string",
+ "format": "int64"
+ }
+ },
+ "type": "object",
+ "id": "BulkInsertInstanceResource",
+ "description": "A transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert . This resource is not persisted anywhere, it is used only for processing the requests."
+ },
+ "RouterInterface": {
+ "id": "RouterInterface",
+ "type": "object",
+ "properties": {
+ "managementType": {
+ "enum": [
+ "MANAGED_BY_ATTACHMENT",
+ "MANAGED_BY_USER"
],
- "response": {
- "$ref": "Operation"
+ "type": "string",
+ "description": "[Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. ",
+ "enumDescriptions": [
+ "The interface is automatically created for PARTNER type InterconnectAttachment, Google will automatically create/update/delete this interface when the PARTNER InterconnectAttachment is created/provisioned/deleted. This type of interface cannot be manually managed by user.",
+ "Default value, the interface is manually created and managed by user."
+ ]
+ },
+ "ipRange": {
+ "type": "string",
+ "description": "IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface."
+ },
+ "subnetwork": {
+ "type": "string",
+ "description": "The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here."
+ },
+ "linkedInterconnectAttachment": {
+ "type": "string",
+ "description": "URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance."
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "compute.routers.insert"
+ ]
},
- "httpMethod": "DELETE",
- "description": "Deletes the specified PublicAdvertisedPrefix",
- "parameterOrder": [
- "project",
- "publicAdvertisedPrefix"
- ],
- "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
- "id": "compute.publicAdvertisedPrefixes.delete",
- "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
- "parameters": {
- "publicAdvertisedPrefix": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
+ "type": "string",
+ "description": "Name of this interface entry. 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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "privateIpAddress": {
+ "description": "The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.",
+ "type": "string"
+ },
+ "linkedVpnTunnel": {
+ "type": "string",
+ "description": "URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance."
+ },
+ "redundantInterface": {
+ "type": "string",
+ "description": "Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface 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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ }
+ }
+ },
+ "TargetHttpsProxiesScopedList": {
+ "id": "TargetHttpsProxiesScopedList",
+ "properties": {
+ "targetHttpsProxies": {
+ "type": "array",
+ "items": {
+ "$ref": "TargetHttpsProxy"
+ },
+ "description": "A list of TargetHttpsProxies contained in this scope."
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "message": {
"type": "string",
- "description": "Name of the PublicAdvertisedPrefix resource to delete."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "requestId": {
+ "code": {
"type": "string",
- "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"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
}
+ },
+ "description": "Informational warning which replaces the list of backend services when the list is empty."
+ }
+ },
+ "type": "object"
+ },
+ "RegionInstanceGroupManagersDeleteInstancesRequest": {
+ "properties": {
+ "skipInstancesOnValidationError": {
+ "description": "Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.",
+ "type": "boolean"
+ },
+ "instances": {
+ "type": "array",
+ "description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
+ "items": {
+ "type": "string"
}
+ }
+ },
+ "type": "object",
+ "id": "RegionInstanceGroupManagersDeleteInstancesRequest"
+ },
+ "NetworkInterface": {
+ "type": "object",
+ "description": "A network interface resource attached to an instance.",
+ "properties": {
+ "ipv6AccessType": {
+ "type": "string",
+ "enumDescriptions": [
+ "This network interface can have external IPv6.",
+ "This network interface can have internal IPv6."
+ ],
+ "enum": [
+ "EXTERNAL",
+ "INTERNAL"
+ ],
+ "description": "[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."
},
- "patch": {
- "request": {
- "$ref": "PublicAdvertisedPrefix"
- },
- "httpMethod": "PATCH",
- "response": {
- "$ref": "Operation"
+ "queueCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users."
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.",
+ "default": "compute#networkInterface"
+ },
+ "ipv6Address": {
+ "type": "string",
+ "description": "An IPv6 internal network address for this network interface."
+ },
+ "internalIpv6PrefixLength": {
+ "description": "The prefix length of the primary internal IPv6 range.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkIP": {
+ "description": "An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.",
+ "type": "string"
+ },
+ "aliasIpRanges": {
+ "description": "An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.",
+ "items": {
+ "$ref": "AliasIpRange"
},
- "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
- "description": "Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
- "parameters": {
- "publicAdvertisedPrefix": {
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the PublicAdvertisedPrefix resource to patch.",
- "required": true
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- }
+ "type": "array"
+ },
+ "accessConfigs": {
+ "type": "array",
+ "items": {
+ "$ref": "AccessConfig"
},
- "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
- "id": "compute.publicAdvertisedPrefixes.patch",
- "parameterOrder": [
- "project",
- "publicAdvertisedPrefix"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "description": "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."
},
- "get": {
- "parameterOrder": [
- "project",
- "publicAdvertisedPrefix"
+ "stackType": {
+ "enumDescriptions": [
+ "The network interface can have both IPv4 and IPv6 addresses.",
+ "The network interface will be assigned IPv4 address."
],
- "response": {
- "$ref": "PublicAdvertisedPrefix"
- },
- "parameters": {
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
- },
- "publicAdvertisedPrefix": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the PublicAdvertisedPrefix resource to return.",
- "location": "path",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "string",
+ "enum": [
+ "IPV4_IPV6",
+ "IPV4_ONLY"
],
- "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
- "id": "compute.publicAdvertisedPrefixes.get",
- "description": "Returns the specified PublicAdvertisedPrefix resource.",
- "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
- "httpMethod": "GET"
+ "description": "The stack type for this network interface 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 instance creation and update network interface operations."
},
- "insert": {
- "request": {
- "$ref": "PublicAdvertisedPrefix"
+ "network": {
+ "description": "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 ",
+ "type": "string"
+ },
+ "subnetwork": {
+ "description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ",
+ "type": "string"
+ },
+ "networkAttachment": {
+ "type": "string",
+ "description": "The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}."
+ },
+ "fingerprint": {
+ "type": "string",
+ "format": "byte",
+ "description": "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": {
+ "items": {
+ "$ref": "AccessConfig"
},
- "path": "projects/{project}/global/publicAdvertisedPrefixes",
- "id": "compute.publicAdvertisedPrefixes.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "array",
+ "description": "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."
+ },
+ "name": {
+ "type": "string",
+ "description": "[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0."
+ },
+ "nicType": {
+ "enumDescriptions": [
+ "GVNIC",
+ "No type specified.",
+ "VIRTIO"
],
- "parameterOrder": [
- "project"
+ "enum": [
+ "GVNIC",
+ "UNSPECIFIED_NIC_TYPE",
+ "VIRTIO_NET"
],
- "flatPath": "projects/{project}/global/publicAdvertisedPrefixes",
- "description": "Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.",
- "parameters": {
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "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).",
- "location": "query",
- "type": "string"
- }
+ "type": "string",
+ "description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet."
+ }
+ },
+ "id": "NetworkInterface"
+ },
+ "SecurityPolicyRuleHttpHeaderAction": {
+ "type": "object",
+ "id": "SecurityPolicyRuleHttpHeaderAction",
+ "properties": {
+ "requestHeadersToAdds": {
+ "description": "The list of request headers to add or overwrite if they're already present.",
+ "items": {
+ "$ref": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption"
},
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- }
+ "type": "array"
}
}
},
- "targetInstances": {
- "methods": {
- "aggregatedList": {
- "id": "compute.targetInstances.aggregatedList",
- "flatPath": "projects/{project}/aggregated/targetInstances",
- "parameterOrder": [
- "project"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query",
- "type": "boolean"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "maxResults": {
- "format": "uint32",
- "minimum": "0",
- "location": "query",
- "type": "integer",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- }
- },
- "response": {
- "$ref": "TargetInstanceAggregatedList"
- },
- "description": "Retrieves an aggregated list of target instances.",
- "path": "projects/{project}/aggregated/targetInstances"
+ "NetworkAttachmentList": {
+ "id": "NetworkAttachmentList",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
},
- "get": {
- "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}",
- "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}",
- "id": "compute.targetInstances.get",
- "response": {
- "$ref": "TargetInstance"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "targetInstance": {
- "required": true,
- "type": "string",
- "description": "Name of the TargetInstance resource to return.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Name of the zone scoping this request."
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string"
- }
+ "items": {
+ "items": {
+ "$ref": "NetworkAttachment"
},
- "parameterOrder": [
- "project",
- "zone",
- "targetInstance"
- ],
- "description": "Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.",
- "httpMethod": "GET"
+ "type": "array",
+ "description": "A list of NetworkAttachment resources."
},
- "delete": {
- "parameters": {
- "zone": {
- "description": "Name of the zone scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path"
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "warning": {
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "location": "path"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "targetInstance": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true,
- "description": "Name of the TargetInstance resource to delete.",
- "location": "path"
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
},
- "httpMethod": "DELETE",
- "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#networkAttachmentList"
+ }
+ }
+ },
+ "InterconnectDiagnostics": {
+ "type": "object",
+ "properties": {
+ "arpCaches": {
+ "items": {
+ "$ref": "InterconnectDiagnosticsARPEntry"
+ },
+ "description": "A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled.",
+ "type": "array"
+ },
+ "macAddress": {
+ "type": "string",
+ "description": "The MAC address of the Interconnect's bundle interface."
+ },
+ "bundleAggregationType": {
+ "description": "The aggregation type of the bundle interface.",
+ "enum": [
+ "BUNDLE_AGGREGATION_TYPE_LACP",
+ "BUNDLE_AGGREGATION_TYPE_STATIC"
],
- "parameterOrder": [
- "project",
- "zone",
- "targetInstance"
+ "enumDescriptions": [
+ "LACP is enabled.",
+ "LACP is disabled."
],
- "id": "compute.targetInstances.delete",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}",
- "description": "Deletes the specified TargetInstance resource."
+ "type": "string"
},
- "list": {
- "parameterOrder": [
- "project",
- "zone"
+ "bundleOperationalStatus": {
+ "enumDescriptions": [
+ "If bundleAggregationType is LACP: LACP is not established and/or all links in the bundle have DOWN operational status. If bundleAggregationType is STATIC: one or more links in the bundle has DOWN operational status.",
+ "If bundleAggregationType is LACP: LACP is established and at least one link in the bundle has UP operational status. If bundleAggregationType is STATIC: all links in the bundle (typically just one) have UP operational status."
],
- "path": "projects/{project}/zones/{zone}/targetInstances",
- "httpMethod": "GET",
- "id": "compute.targetInstances.list",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "string",
+ "enum": [
+ "BUNDLE_OPERATIONAL_STATUS_DOWN",
+ "BUNDLE_OPERATIONAL_STATUS_UP"
],
- "response": {
- "$ref": "TargetInstanceList"
+ "description": "The operational status of the bundle interface."
+ },
+ "links": {
+ "description": "A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.",
+ "items": {
+ "$ref": "InterconnectDiagnosticsLinkStatus"
},
- "description": "Retrieves a list of TargetInstance resources available to the specified project and zone.",
- "parameters": {
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "maxResults": {
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "location": "query",
- "format": "uint32",
- "type": "integer"
+ "type": "array"
+ }
+ },
+ "id": "InterconnectDiagnostics",
+ "description": "Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection."
+ },
+ "AuthorizationLoggingOptions": {
+ "type": "object",
+ "description": "This is deprecated and has no effect. Do not use.",
+ "properties": {
+ "permissionType": {
+ "type": "string",
+ "enumDescriptions": [
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use."
+ ],
+ "description": "This is deprecated and has no effect. Do not use.",
+ "enum": [
+ "ADMIN_READ",
+ "ADMIN_WRITE",
+ "DATA_READ",
+ "DATA_WRITE",
+ "PERMISSION_TYPE_UNSPECIFIED"
+ ]
+ }
+ },
+ "id": "AuthorizationLoggingOptions"
+ },
+ "InterconnectList": {
+ "type": "object",
+ "id": "InterconnectList",
+ "description": "Response to the list request, and contains a list of interconnects.",
+ "properties": {
+ "kind": {
+ "default": "compute#interconnectList",
+ "description": "[Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
},
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "description": "Name of the zone scoping this request.",
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string"
}
},
- "flatPath": "projects/{project}/zones/{zone}/targetInstances"
+ "type": "object"
},
- "insert": {
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "id": "compute.targetInstances.insert",
- "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.",
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the zone scoping this request.",
- "required": true
- }
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "Interconnect"
},
- "flatPath": "projects/{project}/zones/{zone}/targetInstances",
- "path": "projects/{project}/zones/{zone}/targetInstances",
- "parameterOrder": [
- "project",
- "zone"
- ],
- "request": {
- "$ref": "TargetInstance"
- }
+ "description": "A list of Interconnect resources."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
}
}
},
- "regionNetworkEndpointGroups": {
- "methods": {
- "list": {
- "parameters": {
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "maxResults": {
- "default": "500",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "location": "query",
- "type": "integer"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ "InstanceManagedByIgmError": {
+ "type": "object",
+ "properties": {
+ "instanceActionDetails": {
+ "$ref": "InstanceManagedByIgmErrorInstanceActionDetails",
+ "description": "[Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional."
+ },
+ "timestamp": {
+ "type": "string",
+ "description": "[Output Only] The time that this error occurred. This value is in RFC3339 text format."
+ },
+ "error": {
+ "description": "[Output Only] Contents of the error.",
+ "$ref": "InstanceManagedByIgmErrorManagedInstanceError"
+ }
+ },
+ "id": "InstanceManagedByIgmError"
+ },
+ "RouterStatusNatStatusNatRuleStatus": {
+ "properties": {
+ "drainNatIps": {
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of IPs for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].",
+ "type": "array"
+ },
+ "minExtraIpsNeeded": {
+ "format": "int32",
+ "type": "integer",
+ "description": "The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT."
+ },
+ "ruleNumber": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Rule number of the rule."
+ },
+ "activeNatIps": {
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of active IPs for NAT. Example: [\"1.1.1.1\", \"179.12.26.133\"].",
+ "type": "array"
+ },
+ "numVmEndpointsWithNatMappings": {
+ "type": "integer",
+ "description": "Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.",
+ "format": "int32"
+ }
+ },
+ "type": "object",
+ "description": "Status of a NAT Rule contained in this NAT.",
+ "id": "RouterStatusNatStatusNatRuleStatus"
+ },
+ "ReservationsScopedList": {
+ "id": "ReservationsScopedList",
+ "properties": {
+ "reservations": {
+ "type": "array",
+ "description": "A list of reservations contained in this scope.",
+ "items": {
+ "$ref": "Reservation"
+ }
+ },
+ "warning": {
+ "description": "Informational warning which replaces the list of reservations when the list is empty.",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "project": {
+ "message": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "region": {
- "location": "path",
- "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035.",
+ "code": {
"type": "string",
- "required": true
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "RouterNatSubnetworkToNat": {
+ "properties": {
+ "secondaryIpRangeNames": {
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if \"LIST_OF_SECONDARY_IP_RANGES\" is one of the values in source_ip_ranges_to_nat.",
+ "type": "array"
+ },
+ "sourceIpRangesToNat": {
+ "type": "array",
+ "description": "Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: [\"PRIMARY_IP_RANGE\", \"LIST_OF_SECONDARY_IP_RANGES\"] Default: [ALL_IP_RANGES]",
+ "items": {
+ "type": "string",
+ "enumDescriptions": [
+ "The primary and all the secondary ranges are allowed to Nat.",
+ "A list of secondary ranges are allowed to Nat.",
+ "The primary range is allowed to Nat."
+ ],
+ "enum": [
+ "ALL_IP_RANGES",
+ "LIST_OF_SECONDARY_IP_RANGES",
+ "PRIMARY_IP_RANGE"
+ ]
+ }
+ },
+ "name": {
+ "type": "string",
+ "description": "URL for the subnetwork resource that will use NAT."
+ }
+ },
+ "id": "RouterNatSubnetworkToNat",
+ "type": "object",
+ "description": "Defines the IP ranges that want to use NAT for a subnetwork."
+ },
+ "SchedulingNodeAffinity": {
+ "id": "SchedulingNodeAffinity",
+ "type": "object",
+ "properties": {
+ "values": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Corresponds to the label values of Node resource."
+ },
+ "operator": {
+ "description": "Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.",
+ "enumDescriptions": [
+ "Requires Compute Engine to seek for matched nodes.",
+ "Requires Compute Engine to avoid certain nodes.",
+ ""
],
- "description": "Retrieves the list of regional network endpoint groups available to the specified project in the given region.",
- "id": "compute.regionNetworkEndpointGroups.list",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "region"
+ "enum": [
+ "IN",
+ "NOT_IN",
+ "OPERATOR_UNSPECIFIED"
],
- "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups",
- "path": "projects/{project}/regions/{region}/networkEndpointGroups",
- "response": {
- "$ref": "NetworkEndpointGroupList"
+ "type": "string"
+ },
+ "key": {
+ "description": "Corresponds to the label key of Node resource.",
+ "type": "string"
+ }
+ },
+ "description": "Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled."
+ },
+ "BackendServiceCdnPolicy": {
+ "id": "BackendServiceCdnPolicy",
+ "description": "Message containing Cloud CDN configuration for a backend service.",
+ "properties": {
+ "negativeCaching": {
+ "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.",
+ "type": "boolean"
+ },
+ "maxTtl": {
+ "format": "int32",
+ "description": "Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of \"0\" means \"always revalidate\". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
+ "type": "integer"
+ },
+ "signedUrlCacheMaxAgeSec": {
+ "format": "int64",
+ "type": "string",
+ "description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered."
+ },
+ "defaultTtl": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL."
+ },
+ "negativeCachingPolicy": {
+ "type": "array",
+ "description": "Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.",
+ "items": {
+ "$ref": "BackendServiceCdnPolicyNegativeCachingPolicy"
}
},
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}",
- "description": "Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.",
- "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "region": {
- "location": "path",
- "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035.",
- "type": "string",
- "required": true
- },
- "networkEndpointGroup": {
- "type": "string",
- "description": "The name of the network endpoint group to delete. It should comply with RFC1035.",
- "location": "path",
- "required": true
- },
- "project": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "id": "compute.regionNetworkEndpointGroups.delete",
- "parameterOrder": [
- "project",
- "region",
- "networkEndpointGroup"
- ]
+ "cacheKeyPolicy": {
+ "description": "The CacheKeyPolicy for this CdnPolicy.",
+ "$ref": "CacheKeyPolicy"
},
- "insert": {
- "response": {
- "$ref": "Operation"
+ "requestCoalescing": {
+ "description": "If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.",
+ "type": "boolean"
+ },
+ "signedUrlKeyNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.",
- "id": "compute.regionNetworkEndpointGroups.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "[Output Only] Names of the keys for signing request URLs."
+ },
+ "cacheMode": {
+ "type": "string",
+ "enum": [
+ "CACHE_ALL_STATIC",
+ "FORCE_CACHE_ALL",
+ "INVALID_CACHE_MODE",
+ "USE_ORIGIN_HEADERS"
],
- "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups",
- "request": {
- "$ref": "NetworkEndpointGroup"
+ "enumDescriptions": [
+ "Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.",
+ "Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.",
+ "",
+ "Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server."
+ ],
+ "description": "Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached."
+ },
+ "clientTtl": {
+ "description": "Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a \"public\" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a \"public\" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "bypassCacheOnRequestHeaders": {
+ "items": {
+ "$ref": "BackendServiceCdnPolicyBypassCacheOnRequestHeader"
},
- "httpMethod": "POST",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "region": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the region where you want to create the network endpoint group. It should comply with RFC1035."
- }
+ "type": "array",
+ "description": "Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings."
+ },
+ "serveWhileStale": {
+ "format": "int32",
+ "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "TargetPool": {
+ "type": "object",
+ "properties": {
+ "healthChecks": {
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/regions/{region}/networkEndpointGroups",
- "parameterOrder": [
- "project",
- "region"
- ]
+ "type": "array",
+ "description": "The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified."
},
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#targetPool",
+ "description": "[Output Only] Type of the resource. Always compute#targetPool for target pools.",
+ "type": "string"
+ },
+ "sessionAffinity": {
+ "enum": [
+ "CLIENT_IP",
+ "CLIENT_IP_NO_DESTINATION",
+ "CLIENT_IP_PORT_PROTO",
+ "CLIENT_IP_PROTO",
+ "GENERATED_COOKIE",
+ "HEADER_FIELD",
+ "HTTP_COOKIE",
+ "NONE"
],
- "parameterOrder": [
- "project",
- "region",
- "networkEndpointGroup"
+ "enumDescriptions": [
+ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.",
+ "1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.",
+ "5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.",
+ "3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.",
+ "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.",
+ "The hash is based on a user specified header field.",
+ "The hash is based on a user provided cookie.",
+ "No session affinity. Connections from the same client IP may go to any instance in the pool."
],
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string"
- },
- "networkEndpointGroup": {
- "location": "path",
- "description": "The name of the network endpoint group. It should comply with RFC1035.",
- "type": "string",
- "required": true
- },
- "region": {
- "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "NetworkEndpointGroup"
+ "description": "Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.",
+ "type": "string"
+ },
+ "name": {
+ "description": "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.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "instances": {
+ "items": {
+ "type": "string"
},
- "description": "Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.",
- "id": "compute.regionNetworkEndpointGroups.get",
- "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}",
- "httpMethod": "GET",
- "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}"
+ "type": "array",
+ "description": "A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool."
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the target pool resides."
+ },
+ "backupPool": {
+ "description": "The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "failoverRatio": {
+ "type": "number",
+ "description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.",
+ "format": "float"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
}
- }
+ },
+ "description": "Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools.",
+ "id": "TargetPool"
},
- "forwardingRules": {
- "methods": {
- "aggregatedList": {
- "description": "Retrieves an aggregated list of forwarding rules.",
- "response": {
- "$ref": "ForwardingRuleAggregatedList"
+ "FirewallPolicyRule": {
+ "type": "object",
+ "id": "FirewallPolicyRule",
+ "description": "Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).",
+ "properties": {
+ "targetSecureTags": {
+ "items": {
+ "$ref": "FirewallPolicyRuleSecureTag"
},
- "parameterOrder": [
- "project"
- ],
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "includeAllScopes": {
- "location": "query",
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "maxResults": {
- "minimum": "0",
- "default": "500",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "type": "integer"
- }
+ "type": "array",
+ "description": "A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256."
+ },
+ "priority": {
+ "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled."
+ },
+ "match": {
+ "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.",
+ "$ref": "FirewallPolicyRuleMatcher"
+ },
+ "ruleName": {
+ "type": "string",
+ "description": "An optional name for the rule. This field is not a unique identifier and can be updated."
+ },
+ "targetServiceAccounts": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "id": "compute.forwardingRules.aggregatedList",
- "path": "projects/{project}/aggregated/forwardingRules",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "flatPath": "projects/{project}/aggregated/forwardingRules"
+ "description": "A list of service accounts indicating the sets of instances that are applied with this rule."
},
- "list": {
- "parameterOrder": [
- "project",
- "region"
+ "enableLogging": {
+ "description": "Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules.",
+ "type": "boolean"
+ },
+ "direction": {
+ "description": "The direction in which this rule applies.",
+ "enumDescriptions": [
+ "",
+ ""
],
- "response": {
- "$ref": "ForwardingRuleList"
- },
- "flatPath": "projects/{project}/regions/{region}/forwardingRules",
- "parameters": {
- "maxResults": {
- "format": "uint32",
- "location": "query",
- "minimum": "0",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "required": true
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "region": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enum": [
+ "EGRESS",
+ "INGRESS"
],
- "description": "Retrieves a list of ForwardingRule resources available to the specified project and region.",
- "id": "compute.forwardingRules.list",
- "path": "projects/{project}/regions/{region}/forwardingRules",
- "httpMethod": "GET"
+ "type": "string"
},
- "patch": {
- "id": "compute.forwardingRules.patch",
- "description": "Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.",
- "request": {
- "$ref": "ForwardingRule"
+ "targetResources": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
- "parameters": {
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "description": "A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.",
+ "type": "array"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules",
+ "default": "compute#firewallPolicyRule"
+ },
+ "ruleTupleCount": {
+ "format": "int32",
+ "type": "integer",
+ "description": "[Output Only] Calculation of the complexity of a single firewall policy rule."
+ },
+ "action": {
+ "description": "The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\".",
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description for this resource.",
+ "type": "string"
+ }
+ }
+ },
+ "TargetHttpsProxyList": {
+ "description": "Contains a list of TargetHttpsProxy resources.",
+ "type": "object",
+ "id": "TargetHttpsProxyList",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
},
- "forwardingRule": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the ForwardingRule resource to patch.",
+ "message": {
"type": "string",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "region": {
- "description": "Name of the region scoping this request.",
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
- },
- "parameterOrder": [
- "project",
- "region",
- "forwardingRule"
- ],
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "PATCH",
- "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}"
+ }
},
- "insert": {
- "path": "projects/{project}/regions/{region}/forwardingRules",
- "request": {
- "$ref": "ForwardingRule"
- },
- "httpMethod": "POST",
- "id": "compute.forwardingRules.insert",
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "Operation"
+ "kind": {
+ "default": "compute#targetHttpsProxyList",
+ "description": "Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "type": "array",
+ "description": "A list of TargetHttpsProxy resources.",
+ "items": {
+ "$ref": "TargetHttpsProxy"
+ }
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ }
+ }
+ },
+ "ResourcePolicyAggregatedList": {
+ "id": "ResourcePolicyAggregatedList",
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Name of the scope containing this set of resourcePolicies.",
+ "$ref": "ResourcePoliciesScopedList"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
+ "description": "A list of ResourcePolicy resources."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#resourcePolicyAggregatedList",
+ "type": "string",
+ "description": "Type of resource."
+ },
+ "etag": {
+ "type": "string"
+ },
+ "unreachables": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/regions/{region}/forwardingRules",
- "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request."
+ "description": "[Output Only] Unreachable resources."
},
- "get": {
- "parameters": {
- "region": {
- "location": "path",
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
"type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "forwardingRule": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the ForwardingRule resource to return.",
- "required": true,
- "location": "path"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
+ "message": {
"type": "string",
- "location": "path"
+ "description": "[Output Only] A human-readable description of the warning code."
}
- },
- "httpMethod": "GET",
- "id": "compute.forwardingRules.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ }
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ },
+ "description": "Contains a list of resourcePolicies."
+ },
+ "InterconnectDiagnosticsLinkLACPStatus": {
+ "type": "object",
+ "properties": {
+ "neighborSystemId": {
+ "description": "System ID of the port on the neighbor's side of the LACP exchange.",
+ "type": "string"
+ },
+ "googleSystemId": {
+ "description": "System ID of the port on Google's side of the LACP exchange.",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "The link is configured and active within the bundle.",
+ "The link is not configured within the bundle, this means the rest of the object should be empty."
],
- "response": {
- "$ref": "ForwardingRule"
- },
- "parameterOrder": [
- "project",
- "region",
- "forwardingRule"
+ "enum": [
+ "ACTIVE",
+ "DETACHED"
],
- "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
- "description": "Returns the specified ForwardingRule resource.",
- "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}"
+ "type": "string",
+ "description": "The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. "
+ }
+ },
+ "id": "InterconnectDiagnosticsLinkLACPStatus"
+ },
+ "NodeGroupMaintenanceWindow": {
+ "description": "Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.",
+ "properties": {
+ "maintenanceDuration": {
+ "description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.",
+ "$ref": "Duration"
},
- "setTarget": {
- "description": "Changes target URL for forwarding rule. The new target should be of the same type as the old target.",
- "request": {
- "$ref": "TargetReference"
- },
- "parameterOrder": [
- "project",
- "region",
- "forwardingRule"
+ "startTime": {
+ "type": "string",
+ "description": "Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid."
+ }
+ },
+ "type": "object",
+ "id": "NodeGroupMaintenanceWindow"
+ },
+ "BackendServiceLocalityLoadBalancingPolicyConfigPolicy": {
+ "type": "object",
+ "description": "The configuration for a built-in load balancing policy.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "enum": [
+ "INVALID_LB_POLICY",
+ "LEAST_REQUEST",
+ "MAGLEV",
+ "ORIGINAL_DESTINATION",
+ "RANDOM",
+ "RING_HASH",
+ "ROUND_ROBIN"
],
- "httpMethod": "POST",
- "id": "compute.forwardingRules.setTarget",
- "response": {
- "$ref": "Operation"
+ "enumDescriptions": [
+ "",
+ "An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.",
+ "This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824",
+ "Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.",
+ "The load balancer selects a random healthy host.",
+ "The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.",
+ "This is a simple policy in which each healthy backend is selected in round robin order. This is the default."
+ ],
+ "description": "The name of a locality load balancer policy to be used. The value should be one of the predefined ones as supported by localityLbPolicy, although at the moment only ROUND_ROBIN is supported. This field should only be populated when the customPolicy field is not used. Note that specifying the same policy more than once for a backend is not a valid configuration and will be rejected."
+ }
+ },
+ "id": "BackendServiceLocalityLoadBalancingPolicyConfigPolicy"
+ },
+ "VpnGateway": {
+ "id": "VpnGateway",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "vpnInterfaces": {
+ "type": "array",
+ "description": "The list of VPN interfaces associated with this VPN gateway.",
+ "items": {
+ "$ref": "VpnGatewayVpnGatewayInterface"
+ }
+ },
+ "stackType": {
+ "type": "string",
+ "enum": [
+ "IPV4_IPV6",
+ "IPV4_ONLY"
+ ],
+ "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.",
+ "enumDescriptions": [
+ "Enable VPN gateway with both IPv4 and IPv6 protocols.",
+ "Enable VPN gateway with only IPv4 protocol."
+ ]
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "annotations": {
+ "required": [
+ "compute.vpnGateways.insert"
+ ]
+ }
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "network": {
+ "annotations": {
+ "required": [
+ "compute.vpnGateways.insert"
+ ]
},
- "parameters": {
- "forwardingRule": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the ForwardingRule resource in which target is to be set.",
- "location": "path"
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
+ "description": "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the VPN gateway resides."
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
},
- "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "object",
+ "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty."
+ },
+ "labelFingerprint": {
+ "type": "string",
+ "format": "byte",
+ "description": "A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an VpnGateway."
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#vpnGateway",
+ "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways."
+ }
+ },
+ "type": "object",
+ "description": "Represents a HA VPN gateway. HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies ."
+ },
+ "SslCertificateManagedSslCertificate": {
+ "type": "object",
+ "description": "Configuration and status of a managed SSL certificate.",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "ACTIVE",
+ "MANAGED_CERTIFICATE_STATUS_UNSPECIFIED",
+ "PROVISIONING",
+ "PROVISIONING_FAILED",
+ "PROVISIONING_FAILED_PERMANENTLY",
+ "RENEWAL_FAILED"
],
- "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget"
- },
- "delete": {
- "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "The certificate management is working, and a certificate has been provisioned.",
+ "",
+ "The certificate management is working. GCP will attempt to provision the first certificate.",
+ "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. For details of which domain failed, consult domain_status field.",
+ "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. It won't be retried. To try again delete and create a new managed SslCertificate resource. For details of which domain failed, consult domain_status field.",
+ "Renewal of the certificate has failed due to an issue with the DNS or load balancing configuration. The existing cert is still serving; however, it will expire shortly. To provision a renewed certificate, delete and create a new managed SslCertificate resource. For details on which domain failed, consult domain_status field."
],
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
+ "description": "[Output only] Status of the managed certificate resource."
+ },
+ "domainStatus": {
+ "description": "[Output only] Detailed statuses of the domains specified for managed certificate resource.",
+ "additionalProperties": {
+ "type": "string",
+ "enumDescriptions": [
+ "A managed certificate can be provisioned, no issues for this domain.",
+ "",
+ "Failed to check CAA records for the domain.",
+ "Certificate issuance forbidden by an explicit CAA record for the domain.",
+ "There seems to be problem with the user's DNS or load balancer configuration for this domain.",
+ "Reached rate-limit for certificates per top-level private domain.",
+ "Certificate provisioning for this domain is under way. GCP will attempt to provision the first certificate."
+ ],
+ "enum": [
+ "ACTIVE",
+ "DOMAIN_STATUS_UNSPECIFIED",
+ "FAILED_CAA_CHECKING",
+ "FAILED_CAA_FORBIDDEN",
+ "FAILED_NOT_VISIBLE",
+ "FAILED_RATE_LIMITED",
+ "PROVISIONING"
+ ]
},
- "parameterOrder": [
- "project",
- "region",
- "forwardingRule"
- ],
- "id": "compute.forwardingRules.delete",
- "parameters": {
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true,
- "description": "Name of the region scoping this request.",
- "location": "path"
- },
- "forwardingRule": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Name of the ForwardingRule resource to delete."
- },
- "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).",
- "type": "string",
- "location": "query"
- }
+ "type": "object"
+ },
+ "domains": {
+ "items": {
+ "type": "string"
},
- "description": "Deletes the specified ForwardingRule resource.",
- "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}"
+ "description": "The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).",
+ "type": "array"
+ }
+ },
+ "id": "SslCertificateManagedSslCertificate"
+ },
+ "AllocationSpecificSKUAllocationReservedInstanceProperties": {
+ "description": "Properties of the SKU instances being reserved. Next ID: 9",
+ "type": "object",
+ "properties": {
+ "guestAccelerators": {
+ "description": "Specifies accelerator type and count.",
+ "items": {
+ "$ref": "AcceleratorConfig"
+ },
+ "type": "array"
},
- "setLabels": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "response": {
- "$ref": "Operation"
+ "localSsds": {
+ "type": "array",
+ "items": {
+ "$ref": "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk"
},
- "request": {
- "$ref": "RegionSetLabelsRequest"
+ "description": "Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd."
+ },
+ "machineType": {
+ "description": "Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.",
+ "type": "string"
+ },
+ "minCpuPlatform": {
+ "type": "string",
+ "description": "Minimum cpu platform the reservation."
+ },
+ "locationHint": {
+ "description": "An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.",
+ "type": "string"
+ }
+ },
+ "id": "AllocationSpecificSKUAllocationReservedInstanceProperties"
+ },
+ "TargetTcpProxyList": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of TargetTcpProxy resources.",
+ "items": {
+ "$ref": "TargetTcpProxy"
},
- "flatPath": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels",
- "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.",
- "httpMethod": "POST",
- "parameters": {
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
- },
- "region": {
- "required": true,
- "description": "The region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "array"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "kind": {
+ "description": "Type of resource.",
+ "default": "compute#targetTcpProxyList",
+ "type": "string"
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "location": "path"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "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).",
+ "message": {
"type": "string",
- "location": "query"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Name or id of the resource for this request."
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
}
},
- "id": "compute.forwardingRules.setLabels",
- "path": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels"
+ "description": "[Output Only] Informational warning message."
+ }
+ },
+ "description": "Contains a list of TargetTcpProxy resources.",
+ "id": "TargetTcpProxyList"
+ },
+ "NetworksUpdatePeeringRequest": {
+ "id": "NetworksUpdatePeeringRequest",
+ "type": "object",
+ "properties": {
+ "networkPeering": {
+ "$ref": "NetworkPeering"
}
}
},
- "regionTargetTcpProxies": {
- "methods": {
- "list": {
- "flatPath": "projects/{project}/regions/{region}/targetTcpProxies",
- "path": "projects/{project}/regions/{region}/targetTcpProxies",
- "parameters": {
- "project": {
+ "Uint128": {
+ "type": "object",
+ "properties": {
+ "high": {
+ "format": "uint64",
+ "type": "string"
+ },
+ "low": {
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "id": "Uint128"
+ },
+ "RegionTargetHttpsProxiesSetSslCertificatesRequest": {
+ "type": "object",
+ "properties": {
+ "sslCertificates": {
+ "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "RegionTargetHttpsProxiesSetSslCertificatesRequest"
+ },
+ "RegionUrlMapsValidateRequest": {
+ "properties": {
+ "resource": {
+ "$ref": "UrlMap",
+ "description": "Content of the UrlMap to be validated."
+ }
+ },
+ "id": "RegionUrlMapsValidateRequest",
+ "type": "object"
+ },
+ "VpnGatewaysScopedList": {
+ "type": "object",
+ "properties": {
+ "vpnGateways": {
+ "type": "array",
+ "description": "[Output Only] A list of VPN gateways contained in this scope.",
+ "items": {
+ "$ref": "VpnGateway"
+ }
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "maxResults": {
- "type": "integer",
- "format": "uint32",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "minimum": "0"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Name of the region scoping this request."
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ }
+ },
+ "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty."
+ }
+ },
+ "id": "VpnGatewaysScopedList"
+ },
+ "ImageList": {
+ "properties": {
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "description": "A list of Image resources.",
+ "items": {
+ "$ref": "Image"
+ },
+ "type": "array"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "type": "string"
},
- "filter": {
+ "message": {
"type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
},
- "response": {
- "$ref": "TargetTcpProxyList"
- },
- "id": "compute.regionTargetTcpProxies.list",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "object"
+ },
+ "kind": {
+ "default": "compute#imageList",
+ "type": "string",
+ "description": "Type of resource."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "type": "object",
+ "description": "Contains a list of images.",
+ "id": "ImageList"
+ },
+ "NetworkPeering": {
+ "description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.",
+ "id": "NetworkPeering",
+ "type": "object",
+ "properties": {
+ "exportCustomRoutes": {
+ "description": "Whether to export the custom routes to peer network. The default value is false.",
+ "type": "boolean"
+ },
+ "importCustomRoutes": {
+ "description": "Whether to import the custom routes from peer network. The default value is false.",
+ "type": "boolean"
+ },
+ "peerMtu": {
+ "type": "integer",
+ "description": "Maximum Transmission Unit in bytes.",
+ "format": "int32"
+ },
+ "exchangeSubnetRoutes": {
+ "type": "boolean",
+ "description": "Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE."
+ },
+ "network": {
+ "description": "The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "Matching configuration exists on the peer.",
+ "There is no matching configuration on the peer, including the case when peer does not exist."
],
- "parameterOrder": [
- "project",
- "region"
+ "enum": [
+ "ACTIVE",
+ "INACTIVE"
],
- "description": "Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.",
- "httpMethod": "GET"
+ "description": "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.",
+ "type": "string"
},
- "insert": {
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "region"
- ],
- "id": "compute.regionTargetTcpProxies.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "name": {
+ "type": "string",
+ "description": "Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash."
+ },
+ "stateDetails": {
+ "type": "string",
+ "description": "[Output Only] Details about the current state of the peering."
+ },
+ "exportSubnetRoutesWithPublicIp": {
+ "type": "boolean",
+ "description": "Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field."
+ },
+ "importSubnetRoutesWithPublicIp": {
+ "description": "Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.",
+ "type": "boolean"
+ },
+ "autoCreateRoutes": {
+ "type": "boolean",
+ "description": "This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE."
+ },
+ "stackType": {
+ "enum": [
+ "IPV4_IPV6",
+ "IPV4_ONLY"
],
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
- },
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true,
- "description": "Name of the region scoping this request."
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "description": "Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.",
- "path": "projects/{project}/regions/{region}/targetTcpProxies",
- "request": {
- "$ref": "TargetTcpProxy"
+ "type": "string",
+ "description": "Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.",
+ "enumDescriptions": [
+ "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.",
+ "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6."
+ ]
+ }
+ }
+ },
+ "InstanceGroupManagersSetTargetPoolsRequest": {
+ "properties": {
+ "targetPools": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/regions/{region}/targetTcpProxies"
+ "type": "array",
+ "description": "The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings."
},
- "delete": {
- "parameters": {
- "region": {
- "location": "path",
- "required": true,
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path"
- },
- "targetTcpProxy": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the TargetTcpProxy resource to delete."
- },
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "httpMethod": "DELETE",
- "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}",
- "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}",
- "response": {
- "$ref": "Operation"
+ "fingerprint": {
+ "description": "The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "InstanceGroupManagersSetTargetPoolsRequest",
+ "type": "object"
+ },
+ "SslCertificateSelfManagedSslCertificate": {
+ "type": "object",
+ "id": "SslCertificateSelfManagedSslCertificate",
+ "description": "Configuration and status of a self-managed SSL certificate.",
+ "properties": {
+ "certificate": {
+ "description": "A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.",
+ "type": "string"
+ },
+ "privateKey": {
+ "description": "A write-only private key in PEM format. Only insert requests will include this field.",
+ "type": "string"
+ }
+ }
+ },
+ "Router": {
+ "description": "Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.",
+ "id": "Router",
+ "type": "object",
+ "properties": {
+ "nats": {
+ "type": "array",
+ "items": {
+ "$ref": "RouterNat"
},
- "id": "compute.regionTargetTcpProxies.delete",
- "description": "Deletes the specified TargetTcpProxy resource.",
- "parameterOrder": [
- "project",
- "region",
- "targetTcpProxy"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "description": "A list of NAT services created in this router."
},
- "get": {
- "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}",
- "parameters": {
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "location": "path",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string"
- },
- "targetTcpProxy": {
- "type": "string",
- "description": "Name of the TargetTcpProxy resource to return.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- }
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ },
+ "encryptedInterconnectRouter": {
+ "description": "Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).",
+ "type": "boolean"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "name": {
+ "description": "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.",
+ "annotations": {
+ "required": [
+ "compute.routers.insert"
+ ]
},
- "parameterOrder": [
- "project",
- "region",
- "targetTcpProxy"
- ],
- "response": {
- "$ref": "TargetTcpProxy"
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "md5AuthenticationKeys": {
+ "description": "Keys used for MD5 authentication.",
+ "items": {
+ "$ref": "RouterMd5AuthenticationKey"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.regionTargetTcpProxies.get",
- "description": "Returns the specified TargetTcpProxy resource.",
- "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}",
- "httpMethod": "GET"
+ "type": "array"
+ },
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "bgpPeers": {
+ "type": "array",
+ "description": "BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.",
+ "items": {
+ "$ref": "RouterBgpPeer"
+ }
+ },
+ "kind": {
+ "default": "compute#router",
+ "description": "[Output Only] Type of resource. Always compute#router for routers.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "interfaces": {
+ "type": "array",
+ "description": "Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.",
+ "items": {
+ "$ref": "RouterInterface"
+ }
+ },
+ "network": {
+ "description": "URI of the network to which this router belongs.",
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.routers.insert",
+ "compute.routers.update"
+ ]
+ }
+ },
+ "bgp": {
+ "$ref": "RouterBgp",
+ "description": "BGP information specific to this router."
}
}
},
- "acceleratorTypes": {
- "methods": {
- "get": {
- "description": "Returns the specified accelerator type.",
- "path": "projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}",
- "parameters": {
- "zone": {
- "description": "The name of the zone for this request.",
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "acceleratorType": {
- "required": true,
- "description": "Name of the accelerator type to return.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request."
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "acceleratorType"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "AcceleratorType"
+ "Reference": {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#reference for references.",
+ "type": "string",
+ "default": "compute#reference"
+ },
+ "referenceType": {
+ "description": "A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF ",
+ "type": "string"
+ },
+ "referrer": {
+ "type": "string",
+ "description": "URL of the resource which refers to the target."
+ },
+ "target": {
+ "description": "URL of the resource to which this reference points.",
+ "type": "string"
+ }
+ },
+ "description": "Represents a reference to a resource.",
+ "id": "Reference"
+ },
+ "ServiceAttachmentConsumerProjectLimit": {
+ "id": "ServiceAttachmentConsumerProjectLimit",
+ "type": "object",
+ "properties": {
+ "networkUrl": {
+ "type": "string",
+ "description": "The network URL for the network to set the limit for."
+ },
+ "connectionLimit": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The value of the limit to set."
+ },
+ "projectIdOrNum": {
+ "description": "The project id or number for the project to set the limit for.",
+ "type": "string"
+ }
+ }
+ },
+ "LocalizedMessage": {
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "The localized error message in the above locale."
+ },
+ "locale": {
+ "description": "The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: \"en-US\", \"fr-CH\", \"es-MX\"",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "LocalizedMessage",
+ "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error."
+ },
+ "NetworkAttachment": {
+ "description": "NetworkAttachments A network attachment resource ...",
+ "type": "object",
+ "properties": {
+ "subnetworks": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.acceleratorTypes.get",
- "flatPath": "projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}"
+ "description": "An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment."
},
- "list": {
- "flatPath": "projects/{project}/zones/{zone}/acceleratorTypes",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "zone"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "zone": {
- "required": true,
- "description": "The name of the zone for this request.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "maxResults": {
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "minimum": "0",
- "default": "500",
- "type": "integer"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "network": {
+ "description": "[Output Only] The URL of the network which the Network Attachment belongs to.",
+ "type": "string"
+ },
+ "producerAcceptLists": {
+ "description": "Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "producerRejectLists": {
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/zones/{zone}/acceleratorTypes",
- "description": "Retrieves a list of accelerator types that are available to the specified project.",
- "response": {
- "$ref": "AcceleratorTypeList"
+ "description": "Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.",
+ "type": "array"
+ },
+ "connectionEndpoints": {
+ "type": "array",
+ "items": {
+ "$ref": "NetworkAttachmentConnectedEndpoint"
},
- "id": "compute.acceleratorTypes.list"
+ "description": "[Output Only] An array of connections for all the producers connected to this network attachment."
},
- "aggregatedList": {
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
+ "fingerprint": {
+ "format": "byte",
+ "description": "[Output Only] Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.",
+ "type": "string"
+ },
+ "region": {
+ "description": "[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. 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"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#networkAttachment",
+ "description": "[Output Only] Type of the resource."
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "connectionPreference": {
+ "enum": [
+ "ACCEPT_AUTOMATIC",
+ "ACCEPT_MANUAL",
+ "INVALID"
],
- "description": "Retrieves an aggregated list of accelerator types.",
- "path": "projects/{project}/aggregated/acceleratorTypes",
- "flatPath": "projects/{project}/aggregated/acceleratorTypes",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
+ },
+ "name": {
+ "description": "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.",
+ "annotations": {
+ "required": [
+ "compute.networkAttachments.insert"
+ ]
+ },
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "selfLinkWithId": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource's resource id."
+ },
+ "id": {
+ "type": "string",
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier."
+ }
+ },
+ "id": "NetworkAttachment"
+ },
+ "LocationPolicy": {
+ "properties": {
+ "targetShape": {
+ "enum": [
+ "ANY",
+ "ANY_SINGLE_ZONE",
+ "BALANCED"
],
- "id": "compute.acceleratorTypes.aggregatedList",
- "response": {
- "$ref": "AcceleratorTypeAggregatedList"
+ "enumDescriptions": [
+ "GCE picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.",
+ "GCE always selects a single zone for all the VMs, optimizing for resource quotas, available reservations and general capacity. Recommended for batch workloads that cannot tollerate distribution over multiple zones. This the default shape in Bulk Insert and Capacity Advisor APIs.",
+ "GCE prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across allowed zones to minimize the impact of zonal failure. Recommended for highly available serving workloads."
+ ],
+ "type": "string",
+ "description": "Strategy for distributing VMs across zones in a region."
+ },
+ "locations": {
+ "additionalProperties": {
+ "$ref": "LocationPolicyLocation"
},
- "parameters": {
- "maxResults": {
- "default": "500",
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "object",
+ "description": "Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a."
+ }
+ },
+ "description": "Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).",
+ "id": "LocationPolicy",
+ "type": "object"
+ },
+ "NetworkEndpointGroupCloudFunction": {
+ "id": "NetworkEndpointGroupCloudFunction",
+ "description": "Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.",
+ "properties": {
+ "urlMask": {
+ "description": "A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs \" mydomain.com/function1\" and \"mydomain.com/function2\" can be backed by the same Serverless NEG with URL mask \"/\u003cfunction\u003e\". The URL mask will parse them to { function = \"function1\" } and { function = \"function2\" } respectively.",
+ "type": "string"
+ },
+ "function": {
+ "type": "string",
+ "description": "A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: \"func1\"."
+ }
+ },
+ "type": "object"
+ },
+ "RouterAdvertisedIpRange": {
+ "description": "Description-tagged IP ranges for the router to advertise.",
+ "properties": {
+ "range": {
+ "description": "The IP range to advertise. The value must be a CIDR-formatted string.",
+ "type": "string"
+ },
+ "description": {
+ "description": "User-specified description for the IP range.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "RouterAdvertisedIpRange"
+ },
+ "RegionInstanceGroupManagerList": {
+ "properties": {
+ "items": {
+ "type": "array",
+ "description": "A list of InstanceGroupManager resources.",
+ "items": {
+ "$ref": "InstanceGroupManager"
+ }
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.",
+ "default": "compute#regionInstanceGroupManagerList"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "project": {
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string"
},
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- },
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean",
- "location": "query"
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
}
}
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
}
- }
+ },
+ "id": "RegionInstanceGroupManagerList",
+ "description": "Contains a list of managed instance groups.",
+ "type": "object"
},
- "firewalls": {
- "methods": {
- "list": {
- "description": "Retrieves the list of firewall rules available to the specified project.",
- "response": {
- "$ref": "FirewallList"
- },
- "path": "projects/{project}/global/firewalls",
- "flatPath": "projects/{project}/global/firewalls",
- "parameters": {
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "project": {
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "maxResults": {
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "type": "integer",
- "location": "query",
- "minimum": "0"
- }
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
- ],
- "id": "compute.firewalls.list",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "TargetSslProxiesSetBackendServiceRequest": {
+ "properties": {
+ "service": {
+ "description": "The URL of the new BackendService resource for the targetSslProxy.",
+ "type": "string"
+ }
+ },
+ "id": "TargetSslProxiesSetBackendServiceRequest",
+ "type": "object"
+ },
+ "PacketMirroring": {
+ "properties": {
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
- "patch": {
- "description": "Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/global/firewalls/{firewall}",
- "parameters": {
- "firewall": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the firewall rule to patch.",
- "required": true
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.firewalls.patch",
- "parameterOrder": [
- "project",
- "firewall"
- ],
- "flatPath": "projects/{project}/global/firewalls/{firewall}",
- "request": {
- "$ref": "Firewall"
- }
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
},
- "insert": {
- "id": "compute.firewalls.insert",
- "httpMethod": "POST",
- "flatPath": "projects/{project}/global/firewalls",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
- }
- },
- "description": "Creates a firewall rule in the specified project using the data included in the request.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "priority": {
+ "description": "The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "filter": {
+ "$ref": "PacketMirroringFilter",
+ "description": "Filter for mirrored traffic. If unspecified, all traffic is mirrored."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "enable": {
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
],
- "path": "projects/{project}/global/firewalls",
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "Firewall"
- },
- "parameterOrder": [
- "project"
+ "description": "Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE.",
+ "enum": [
+ "FALSE",
+ "TRUE"
]
},
- "get": {
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "firewall": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name of the firewall rule to return.",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string"
- }
+ "collectorIlb": {
+ "$ref": "PacketMirroringForwardingRuleInfo",
+ "description": "The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true."
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#packetMirroring",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings."
+ },
+ "network": {
+ "$ref": "PacketMirroringNetworkInfo",
+ "annotations": {
+ "required": [
+ "compute.packetMirrorings.insert"
+ ]
},
- "id": "compute.firewalls.get",
- "response": {
- "$ref": "Firewall"
+ "description": "Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network."
+ },
+ "mirroredResources": {
+ "$ref": "PacketMirroringMirroredResourceInfo",
+ "description": "PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored."
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URI of the region where the packetMirroring resides."
+ },
+ "name": {
+ "description": "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.",
+ "annotations": {
+ "required": [
+ "compute.packetMirrorings.insert"
+ ]
},
- "flatPath": "projects/{project}/global/firewalls/{firewall}",
- "parameterOrder": [
- "project",
- "firewall"
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ }
+ },
+ "type": "object",
+ "description": "Represents a Packet Mirroring resource. Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring.",
+ "id": "PacketMirroring"
+ },
+ "Condition": {
+ "properties": {
+ "svc": {
+ "type": "string",
+ "description": "This is deprecated and has no effect. Do not use."
+ },
+ "sys": {
+ "enumDescriptions": [
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use."
],
- "path": "projects/{project}/global/firewalls/{firewall}",
- "description": "Returns the specified firewall."
+ "enum": [
+ "IP",
+ "NAME",
+ "NO_ATTR",
+ "REGION",
+ "SERVICE"
+ ],
+ "type": "string",
+ "description": "This is deprecated and has no effect. Do not use."
},
- "delete": {
- "id": "compute.firewalls.delete",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "firewall": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the firewall rule to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
+ "values": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/global/firewalls/{firewall}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/global/firewalls/{firewall}",
- "description": "Deletes the specified firewall.",
- "parameterOrder": [
- "project",
- "firewall"
+ "description": "This is deprecated and has no effect. Do not use.",
+ "type": "array"
+ },
+ "iam": {
+ "enum": [
+ "APPROVER",
+ "ATTRIBUTION",
+ "AUTHORITY",
+ "CREDENTIALS_TYPE",
+ "CREDS_ASSERTION",
+ "JUSTIFICATION_TYPE",
+ "NO_ATTR",
+ "SECURITY_REALM"
],
- "httpMethod": "DELETE"
+ "description": "This is deprecated and has no effect. Do not use.",
+ "type": "string",
+ "enumDescriptions": [
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use."
+ ]
},
- "update": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "op": {
+ "enumDescriptions": [
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use."
],
- "id": "compute.firewalls.update",
- "path": "projects/{project}/global/firewalls/{firewall}",
- "flatPath": "projects/{project}/global/firewalls/{firewall}",
- "parameters": {
- "firewall": {
- "type": "string",
- "description": "Name of the firewall rule to update.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- },
- "parameterOrder": [
- "project",
- "firewall"
+ "enum": [
+ "DISCHARGED",
+ "EQUALS",
+ "IN",
+ "NOT_EQUALS",
+ "NOT_IN",
+ "NO_OP"
],
- "request": {
- "$ref": "Firewall"
- },
- "httpMethod": "PUT",
- "response": {
- "$ref": "Operation"
- },
- "description": "Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead."
+ "description": "This is deprecated and has no effect. Do not use.",
+ "type": "string"
}
- }
+ },
+ "type": "object",
+ "id": "Condition",
+ "description": "This is deprecated and has no effect. Do not use."
},
- "sslCertificates": {
- "methods": {
- "get": {
- "path": "projects/{project}/global/sslCertificates/{sslCertificate}",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "sslCertificate": {
- "type": "string",
- "location": "path",
- "description": "Name of the SslCertificate resource to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.",
- "response": {
- "$ref": "SslCertificate"
+ "HttpsHealthCheckList": {
+ "id": "HttpsHealthCheckList",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "items": {
+ "$ref": "HttpsHealthCheck"
},
- "id": "compute.sslCertificates.get",
- "flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "sslCertificate"
- ]
+ "type": "array",
+ "description": "A list of HttpsHealthCheck resources."
},
- "aggregatedList": {
- "description": "Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.",
- "id": "compute.sslCertificates.aggregatedList",
- "parameterOrder": [
- "project"
- ],
- "path": "projects/{project}/aggregated/sslCertificates",
- "parameters": {
- "includeAllScopes": {
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
+ "kind": {
+ "type": "string",
+ "default": "compute#httpsHealthCheckList",
+ "description": "Type of resource."
+ },
+ "warning": {
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "pageToken": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "maxResults": {
- "default": "500",
- "minimum": "0",
- "format": "uint32",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "project": {
- "description": "Name of the project scoping this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
}
},
- "response": {
- "$ref": "SslCertificateAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ },
+ "description": "Contains a list of HttpsHealthCheck resources.",
+ "type": "object"
+ },
+ "PacketMirroringNetworkInfo": {
+ "properties": {
+ "canonicalUrl": {
+ "description": "[Output Only] Unique identifier for the network; defined by the server.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL of the network resource.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "PacketMirroringNetworkInfo"
+ },
+ "UsableSubnetwork": {
+ "properties": {
+ "externalIpv6Prefix": {
+ "type": "string",
+ "description": "[Output Only] The external IPv6 address range that is assigned to this subnetwork."
+ },
+ "network": {
+ "description": "Network URL.",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.",
+ "type": "string",
+ "enum": [
+ "INTERNAL_HTTPS_LOAD_BALANCER",
+ "PRIVATE",
+ "PRIVATE_RFC_1918",
+ "PRIVATE_SERVICE_CONNECT",
+ "REGIONAL_MANAGED_PROXY"
],
- "flatPath": "projects/{project}/aggregated/sslCertificates",
- "httpMethod": "GET"
+ "enumDescriptions": [
+ "Subnet reserved for Internal HTTP(S) Load Balancing.",
+ "Regular user created or automatically created subnet.",
+ "Regular user created or automatically created subnet.",
+ "Subnetworks created for Private Service Connect in the producer network.",
+ "Subnetwork used for Regional Internal/External HTTP(S) Load Balancing."
+ ]
},
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "project",
- "sslCertificate"
+ "stackType": {
+ "description": "The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.",
+ "enum": [
+ "IPV4_IPV6",
+ "IPV4_ONLY"
],
- "description": "Deletes the specified SslCertificate resource.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "enumDescriptions": [
+ "New VMs in this subnet can have both IPv4 and IPv6 addresses.",
+ "New VMs in this subnet will only be assigned IPv4 addresses."
+ ]
+ },
+ "role": {
+ "enum": [
+ "ACTIVE",
+ "BACKUP"
],
- "id": "compute.sslCertificates.delete",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "sslCertificate": {
- "description": "Name of the SslCertificate resource to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
- },
- "path": "projects/{project}/global/sslCertificates/{sslCertificate}"
+ "type": "string",
+ "description": "The role of subnetwork. Currently, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.",
+ "enumDescriptions": [
+ "The ACTIVE subnet that is currently used.",
+ "The BACKUP subnet that could be promoted to ACTIVE."
+ ]
},
- "insert": {
- "description": "Creates a SslCertificate resource in the specified project using the data included in the request.",
- "id": "compute.sslCertificates.insert",
- "httpMethod": "POST",
- "parameterOrder": [
- "project"
+ "internalIpv6Prefix": {
+ "description": "[Output Only] The internal IPv6 address range that is assigned to this subnetwork.",
+ "type": "string"
+ },
+ "ipCidrRange": {
+ "type": "string",
+ "description": "The range of internal addresses that are owned by this subnetwork."
+ },
+ "ipv6AccessType": {
+ "type": "string",
+ "description": "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.",
+ "enumDescriptions": [
+ "VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.",
+ "VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network."
],
- "path": "projects/{project}/global/sslCertificates",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request."
- }
- },
- "request": {
- "$ref": "SslCertificate"
+ "enum": [
+ "EXTERNAL",
+ "INTERNAL"
+ ]
+ },
+ "secondaryIpRanges": {
+ "items": {
+ "$ref": "UsableSubnetworkSecondaryRange"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/global/sslCertificates"
+ "description": "Secondary IP ranges.",
+ "type": "array"
+ },
+ "subnetwork": {
+ "description": "Subnetwork URL.",
+ "type": "string"
+ }
+ },
+ "id": "UsableSubnetwork",
+ "description": "Subnetwork which the current user has compute.subnetworks.use permission on.",
+ "type": "object"
+ },
+ "ProjectsGetXpnResources": {
+ "id": "ProjectsGetXpnResources",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "default": "compute#projectsGetXpnResources",
+ "description": "[Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects)",
+ "type": "string"
+ },
+ "resources": {
+ "description": "Service resources (a.k.a service projects) attached to this project as their shared VPC host.",
+ "type": "array",
+ "items": {
+ "$ref": "XpnResourceId"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ }
+ }
+ },
+ "PathRule": {
+ "description": "A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.",
+ "id": "PathRule",
+ "properties": {
+ "urlRedirect": {
+ "$ref": "HttpRedirectAction",
+ "description": "When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy."
},
- "list": {
- "id": "compute.sslCertificates.list",
- "response": {
- "$ref": "SslCertificateList"
- },
- "parameters": {
- "maxResults": {
- "location": "query",
- "format": "uint32",
- "type": "integer",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500"
- },
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- }
+ "paths": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here."
+ },
+ "service": {
+ "type": "string",
+ "description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set."
+ },
+ "routeAction": {
+ "description": "In response to a matching path, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path rule's routeAction.",
+ "$ref": "HttpRouteAction"
+ }
+ },
+ "type": "object"
+ },
+ "Subsetting": {
+ "description": "Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.",
+ "type": "object",
+ "id": "Subsetting",
+ "properties": {
+ "policy": {
+ "enum": [
+ "CONSISTENT_HASH_SUBSETTING",
+ "NONE"
],
- "path": "projects/{project}/global/sslCertificates",
- "httpMethod": "GET",
- "flatPath": "projects/{project}/global/sslCertificates",
- "parameterOrder": [
- "project"
+ "enumDescriptions": [
+ "Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the `subset_size` parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled.",
+ "No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends."
],
- "description": "Retrieves the list of SslCertificate resources available to the specified project."
+ "type": "string"
}
}
},
- "routers": {
- "methods": {
- "getNatMappingInfo": {
- "response": {
- "$ref": "VmEndpointNatMappingsList"
+ "ExternalVpnGateway": {
+ "id": "ExternalVpnGateway",
+ "properties": {
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.",
+ "type": "string",
+ "default": "compute#externalVpnGateway"
+ },
+ "name": {
+ "description": "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.",
+ "annotations": {
+ "required": [
+ "compute.externalVpnGateways.insert"
+ ]
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "region",
- "router"
- ],
- "path": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo",
- "flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo",
- "description": "Retrieves runtime Nat mapping information of VM endpoints.",
- "id": "compute.routers.getNatMappingInfo",
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "region": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
- },
- "router": {
- "type": "string",
- "location": "path",
- "description": "Name of the Router resource to query for Nat Mapping information of VM endpoints.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "format": "uint32",
- "minimum": "0",
- "type": "integer",
- "default": "500"
- }
- }
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
- "get": {
- "response": {
- "$ref": "Router"
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.",
+ "additionalProperties": {
+ "type": "string"
},
- "id": "compute.routers.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "parameters": {
- "router": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the Router resource to return.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "project": {
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "region": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request.",
- "location": "path"
- }
+ "type": "object"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "labelFingerprint": {
+ "description": "A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.",
+ "type": "string",
+ "format": "byte"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "interfaces": {
+ "description": "A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.",
+ "items": {
+ "$ref": "ExternalVpnGatewayInterface"
},
- "parameterOrder": [
- "project",
- "region",
- "router"
+ "type": "array"
+ },
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "redundancyType": {
+ "enumDescriptions": [
+ "The external VPN gateway has four public IP addresses; at the time of writing this API, the AWS virtual private gateway is an example which has four public IP addresses for high availability connections; there should be two VPN connections in the AWS virtual private gateway , each AWS VPN connection has two public IP addresses; please make sure to put two public IP addresses from one AWS VPN connection into interfaces 0 and 1 of this external VPN gateway, and put the other two public IP addresses from another AWS VPN connection into interfaces 2 and 3 of this external VPN gateway. When displaying highly available configuration status for the VPN tunnels connected to FOUR_IPS_REDUNDANCY external VPN gateway, Google will always detect whether interfaces 0 and 1 are connected on one interface of HA Cloud VPN gateway, and detect whether interfaces 2 and 3 are connected to another interface of the HA Cloud VPN gateway.",
+ "The external VPN gateway has only one public IP address which internally provide redundancy or failover.",
+ "The external VPN gateway has two public IP addresses which are redundant with each other, the following two types of setup on your on-premises side would have this type of redundancy: (1) Two separate on-premises gateways, each with one public IP address, the two on-premises gateways are redundant with each other. (2) A single on-premise gateway with two public IP addresses that are redundant with eatch other."
],
- "flatPath": "projects/{project}/regions/{region}/routers/{router}",
- "path": "projects/{project}/regions/{region}/routers/{router}",
- "description": "Returns the specified Router resource. Gets a list of available routers by making a list() request."
+ "description": "Indicates the user-supplied redundancy type of this external VPN gateway.",
+ "type": "string",
+ "enum": [
+ "FOUR_IPS_REDUNDANCY",
+ "SINGLE_IP_INTERNALLY_REDUNDANT",
+ "TWO_IPS_REDUNDANCY"
+ ]
+ }
+ },
+ "description": "Represents an external VPN gateway. External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway. For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN.",
+ "type": "object"
+ },
+ "InstanceGroupManagerVersion": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the version. Unique among all versions in the scope of this managed instance group."
},
- "list": {
- "httpMethod": "GET",
- "id": "compute.routers.list",
- "response": {
- "$ref": "RouterList"
+ "instanceTemplate": {
+ "type": "string",
+ "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached."
+ },
+ "targetSize": {
+ "$ref": "FixedOrPercent",
+ "description": "Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information."
+ }
+ },
+ "type": "object",
+ "id": "InstanceGroupManagerVersion"
+ },
+ "ErrorInfo": {
+ "type": "object",
+ "id": "ErrorInfo",
+ "description": "Describes the cause of the error with structured details. Example of an error when contacting the \"pubsub.googleapis.com\" API when it is not enabled: { \"reason\": \"API_DISABLED\" \"domain\": \"googleapis.com\" \"metadata\": { \"resource\": \"projects/123\", \"service\": \"pubsub.googleapis.com\" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { \"reason\": \"STOCKOUT\" \"domain\": \"spanner.googleapis.com\", \"metadata\": { \"availableRegions\": \"us-central1,us-east2\" } }",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE."
+ },
+ "metadatas": {
+ "description": "Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {\"instanceLimit\": \"100/request\"}, should be returned as, {\"instanceLimitPerRequest\": \"100\"}, if the client exceeds the number of instances that can be created in a single (batch) request.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "domain": {
+ "type": "string",
+ "description": "The logical grouping to which the \"reason\" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: \"pubsub.googleapis.com\". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is \"googleapis.com\"."
+ }
+ }
+ },
+ "MachineTypeList": {
+ "properties": {
+ "items": {
+ "description": "A list of MachineType resources.",
+ "items": {
+ "$ref": "MachineType"
},
- "parameterOrder": [
- "project",
- "region"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "default": "500"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "region": {
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "Name of the region for this request."
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
+ "type": "array"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#machineTypeList",
+ "description": "[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "warning": {
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ }
},
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "message": {
"type": "string",
- "location": "query"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "project": {
- "location": "path",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "path": "projects/{project}/regions/{region}/routers",
- "description": "Retrieves a list of Router resources available to the specified project.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/regions/{region}/routers"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
},
- "insert": {
- "id": "compute.routers.insert",
- "parameters": {
- "region": {
- "required": true,
- "type": "string",
- "description": "Name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ }
+ },
+ "id": "MachineTypeList",
+ "type": "object",
+ "description": "Contains a list of machine types."
+ },
+ "OperationsScopedList": {
+ "type": "object",
+ "id": "OperationsScopedList",
+ "properties": {
+ "warning": {
+ "properties": {
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "project": {
- "required": true,
- "description": "Project ID for this request.",
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "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).",
- "location": "query",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
- "description": "Creates a Router resource in the specified project and region using the data included in the request.",
- "request": {
- "$ref": "Router"
- },
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
+ "description": "[Output Only] Informational warning which replaces the list of operations when the list is empty.",
+ "type": "object"
+ },
+ "operations": {
+ "type": "array",
+ "items": {
"$ref": "Operation"
},
- "flatPath": "projects/{project}/regions/{region}/routers",
- "parameterOrder": [
- "project",
- "region"
+ "description": "[Output Only] A list of operations contained in this scope."
+ }
+ }
+ },
+ "FirewallPolicyRuleSecureTag": {
+ "id": "FirewallPolicyRuleSecureTag",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the secure tag, created with TagManager's TagValue API.",
+ "pattern": "tagValues/[0-9]+"
+ },
+ "state": {
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "enum": [
+ "EFFECTIVE",
+ "INEFFECTIVE"
],
- "path": "projects/{project}/regions/{region}/routers"
+ "description": "[Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted."
+ }
+ },
+ "type": "object"
+ },
+ "BackendService": {
+ "description": "Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) For more information, see Backend Services.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
},
- "delete": {
- "parameterOrder": [
- "project",
- "region",
- "router"
+ "securityPolicy": {
+ "type": "string",
+ "description": "[Output Only] The resource URL for the security policy associated with this backend service."
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "protocol": {
+ "type": "string",
+ "description": "The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.",
+ "enum": [
+ "GRPC",
+ "HTTP",
+ "HTTP2",
+ "HTTPS",
+ "SSL",
+ "TCP",
+ "UDP",
+ "UNSPECIFIED"
],
- "id": "compute.routers.delete",
- "description": "Deletes the specified Router resource.",
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "gRPC (available for Traffic Director).",
+ "",
+ "HTTP/2 with SSL.",
+ "",
+ "TCP proxying with SSL.",
+ "TCP proxying or TCP pass-through.",
+ "UDP.",
+ "If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules."
+ ]
+ },
+ "circuitBreakers": {
+ "$ref": "CircuitBreakers"
+ },
+ "localityLbPolicy": {
+ "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
+ "type": "string",
+ "enum": [
+ "INVALID_LB_POLICY",
+ "LEAST_REQUEST",
+ "MAGLEV",
+ "ORIGINAL_DESTINATION",
+ "RANDOM",
+ "RING_HASH",
+ "ROUND_ROBIN"
],
- "path": "projects/{project}/regions/{region}/routers/{router}",
- "parameters": {
- "router": {
- "description": "Name of the Router resource to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "region": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- }
+ "enumDescriptions": [
+ "",
+ "An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.",
+ "This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824",
+ "Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.",
+ "The load balancer selects a random healthy host.",
+ "The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.",
+ "This is a simple policy in which each healthy backend is selected in round robin order. This is the default."
+ ]
+ },
+ "port": {
+ "format": "int32",
+ "description": "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.",
+ "type": "integer"
+ },
+ "timeoutSec": {
+ "type": "integer",
+ "description": "The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.",
+ "format": "int32"
+ },
+ "loadBalancingScheme": {
+ "enum": [
+ "EXTERNAL",
+ "EXTERNAL_MANAGED",
+ "INTERNAL",
+ "INTERNAL_MANAGED",
+ "INTERNAL_SELF_MANAGED",
+ "INVALID_LOAD_BALANCING_SCHEME"
+ ],
+ "description": "Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.",
+ "type": "string",
+ "enumDescriptions": [
+ "Signifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing",
+ "Signifies that this will be used for External Managed HTTP(S) Load Balancing.",
+ "Signifies that this will be used for Internal TCP/UDP Load Balancing.",
+ "Signifies that this will be used for Internal HTTP(S) Load Balancing.",
+ "Signifies that this will be used by Traffic Director.",
+ ""
+ ]
+ },
+ "maxStreamDuration": {
+ "description": "Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.",
+ "$ref": "Duration"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "affinityCookieTtlSec": {
+ "description": "Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "consistentHash": {
+ "description": "Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. ",
+ "$ref": "ConsistentHashLoadBalancerSettings"
+ },
+ "serviceBindings": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/regions/{region}/routers/{router}",
- "response": {
- "$ref": "Operation"
- }
+ "type": "array",
+ "description": "URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty."
},
- "aggregatedList": {
- "id": "compute.routers.aggregatedList",
- "httpMethod": "GET",
- "path": "projects/{project}/aggregated/routers",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "sessionAffinity": {
+ "description": "Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).",
+ "type": "string",
+ "enum": [
+ "CLIENT_IP",
+ "CLIENT_IP_NO_DESTINATION",
+ "CLIENT_IP_PORT_PROTO",
+ "CLIENT_IP_PROTO",
+ "GENERATED_COOKIE",
+ "HEADER_FIELD",
+ "HTTP_COOKIE",
+ "NONE"
],
- "parameterOrder": [
- "project"
+ "enumDescriptions": [
+ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.",
+ "1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.",
+ "5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.",
+ "3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.",
+ "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.",
+ "The hash is based on a user specified header field.",
+ "The hash is based on a user provided cookie.",
+ "No session affinity. Connections from the same client IP may go to any instance in the pool."
+ ]
+ },
+ "portName": {
+ "type": "string",
+ "description": "A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name."
+ },
+ "compressionMode": {
+ "type": "string",
+ "description": "Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.",
+ "enumDescriptions": [
+ "Automatically uses the best compression based on the Accept-Encoding header sent by the client.",
+ "Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients."
],
- "parameters": {
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "format": "uint32",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "default": "500",
- "minimum": "0"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "includeAllScopes": {
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean"
- }
- },
- "description": "Retrieves an aggregated list of routers.",
- "flatPath": "projects/{project}/aggregated/routers",
- "response": {
- "$ref": "RouterAggregatedList"
- }
+ "enum": [
+ "AUTOMATIC",
+ "DISABLED"
+ ]
},
- "update": {
- "description": "Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.",
- "id": "compute.routers.update",
- "response": {
- "$ref": "Operation"
+ "outlierDetection": {
+ "description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. ",
+ "$ref": "OutlierDetection"
+ },
+ "localityLbPolicies": {
+ "items": {
+ "$ref": "BackendServiceLocalityLoadBalancingPolicyConfig"
},
- "request": {
- "$ref": "Router"
+ "type": "array",
+ "description": "A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true."
+ },
+ "failoverPolicy": {
+ "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).",
+ "$ref": "BackendServiceFailoverPolicy"
+ },
+ "customRequestHeaders": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of the region for this request.",
- "required": true
- },
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request."
- },
- "router": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "description": "Name of the Router resource to update."
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
+ "type": "array",
+ "description": "Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)."
+ },
+ "connectionTrackingPolicy": {
+ "$ref": "BackendServiceConnectionTrackingPolicy",
+ "description": "Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing."
+ },
+ "cdnPolicy": {
+ "$ref": "BackendServiceCdnPolicy",
+ "description": "Cloud CDN configuration for this BackendService. Only available for specified load balancer types."
+ },
+ "fingerprint": {
+ "description": "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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.",
+ "format": "byte",
+ "type": "string"
+ },
+ "healthChecks": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/regions/{region}/routers/{router}",
- "parameterOrder": [
- "project",
- "region",
- "router"
- ],
- "path": "projects/{project}/regions/{region}/routers/{router}"
+ "type": "array",
+ "description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check."
+ },
+ "connectionDraining": {
+ "$ref": "ConnectionDraining"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#backendService",
+ "description": "[Output Only] Type of resource. Always compute#backendService for backend services."
+ },
+ "customResponseHeaders": {
+ "type": "array",
+ "description": "Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).",
+ "items": {
+ "type": "string"
+ }
+ },
+ "iap": {
+ "$ref": "BackendServiceIAP",
+ "description": "The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing."
+ },
+ "logConfig": {
+ "$ref": "BackendServiceLogConfig",
+ "description": "This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver."
+ },
+ "edgeSecurityPolicy": {
+ "type": "string",
+ "description": "[Output Only] The resource URL for the edge security policy associated with this backend service."
+ },
+ "network": {
+ "type": "string",
+ "description": "The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL."
+ },
+ "securitySettings": {
+ "$ref": "SecuritySettings",
+ "description": "This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED."
+ },
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "name": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "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."
+ },
+ "subsetting": {
+ "$ref": "Subsetting"
+ },
+ "enableCDN": {
+ "type": "boolean",
+ "description": "If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer."
+ },
+ "backends": {
+ "type": "array",
+ "description": "The list of backends that serve this BackendService.",
+ "items": {
+ "$ref": "Backend"
+ }
+ }
+ },
+ "id": "BackendService",
+ "type": "object"
+ },
+ "ConfidentialInstanceConfig": {
+ "description": "A set of Confidential Instance options.",
+ "id": "ConfidentialInstanceConfig",
+ "properties": {
+ "enableConfidentialCompute": {
+ "type": "boolean",
+ "description": "Defines whether the instance should have confidential compute enabled."
+ }
+ },
+ "type": "object"
+ },
+ "InstanceGroupManagerStatus": {
+ "properties": {
+ "isStable": {
+ "description": "[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.",
+ "type": "boolean"
+ },
+ "stateful": {
+ "$ref": "InstanceGroupManagerStatusStateful",
+ "description": "[Output Only] Stateful status of the given Instance Group Manager."
+ },
+ "versionTarget": {
+ "$ref": "InstanceGroupManagerStatusVersionTarget",
+ "description": "[Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager."
+ },
+ "autoscaler": {
+ "description": "[Output Only] The URL of the Autoscaler that targets this instance group manager.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "InstanceGroupManagerStatus"
+ },
+ "DiskTypeAggregatedList": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "default": "compute#diskTypeAggregatedList",
+ "description": "[Output Only] Type of resource. Always compute#diskTypeAggregatedList."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
},
- "getRouterStatus": {
- "httpMethod": "GET",
- "flatPath": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus",
- "path": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus",
- "description": "Retrieves runtime information of the specified router.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "RouterStatusResponse"
- },
- "parameters": {
- "router": {
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the Router resource to query.",
- "required": true
- },
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "description": "Name of the region for this request."
- }
- },
- "id": "compute.routers.getRouterStatus",
- "parameterOrder": [
- "project",
- "region",
- "router"
- ]
+ "items": {
+ "description": "A list of DiskTypesScopedList resources.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "DiskTypesScopedList",
+ "description": "[Output Only] Name of the scope containing this set of disk types."
+ }
},
- "patch": {
- "request": {
- "$ref": "Router"
- },
- "path": "projects/{project}/regions/{region}/routers/{router}",
- "response": {
- "$ref": "Operation"
- },
- "description": "Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
- "httpMethod": "PATCH",
- "id": "compute.routers.patch",
- "parameters": {
- "router": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the Router resource to patch.",
- "type": "string"
- },
- "requestId": {
- "location": "query",
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "unreachables": {
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "warning": {
+ "properties": {
+ "message": {
"type": "string",
- "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)."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "project": {
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "description": "Project ID for this request."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "description": "Name of the region for this request."
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
},
- "parameterOrder": [
- "project",
- "region",
- "router"
- ],
- "flatPath": "projects/{project}/regions/{region}/routers/{router}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "preview": {
- "id": "compute.routers.preview",
- "request": {
- "$ref": "Router"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/routers/{router}/preview",
- "response": {
- "$ref": "RoutersPreviewResponse"
- },
- "parameterOrder": [
- "project",
- "region",
- "router"
- ],
- "flatPath": "projects/{project}/regions/{region}/routers/{router}/preview",
- "description": "Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.",
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "router": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "description": "Name of the Router resource to query."
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "Name of the region for this request.",
- "type": "string",
- "location": "path"
- }
- }
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
}
- }
+ },
+ "id": "DiskTypeAggregatedList",
+ "type": "object"
},
- "globalNetworkEndpointGroups": {
- "methods": {
- "listNetworkEndpoints": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.globalNetworkEndpointGroups.listNetworkEndpoints",
- "httpMethod": "POST",
- "parameters": {
- "networkEndpointGroup": {
- "description": "The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "default": "500",
- "minimum": "0",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- }
+ "BackendBucketCdnPolicyCacheKeyPolicy": {
+ "id": "BackendBucketCdnPolicyCacheKeyPolicy",
+ "properties": {
+ "includeHttpHeaders": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "response": {
- "$ref": "NetworkEndpointGroupsListNetworkEndpoints"
+ "description": "Allows HTTP request headers (by name) to be used in the cache key."
+ },
+ "queryStringWhitelist": {
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "networkEndpointGroup"
- ],
- "description": "Lists the network endpoints in the specified network endpoint group.",
- "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
- "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints"
+ "type": "array",
+ "description": "Names of query string parameters to include in cache keys. Default parameters are always included. '&' and '=' will be percent encoded and not treated as delimiters."
+ }
+ },
+ "description": "Message containing what to include in the cache key for a request for Cloud CDN.",
+ "type": "object"
+ },
+ "License": {
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
},
- "list": {
- "parameterOrder": [
- "project"
- ],
- "description": "Retrieves the list of network endpoint groups that are located in the specified project.",
- "parameters": {
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "maxResults": {
- "minimum": "0",
- "default": "500",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "format": "uint32"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "project": {
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
+ "resourceRequirements": {
+ "$ref": "LicenseResourceRequirements"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#license",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#license for licenses."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the resource. The name must be 1-63 characters long and comply with RFC1035.",
+ "annotations": {
+ "required": [
+ "compute.images.insert"
+ ]
},
- "path": "projects/{project}/global/networkEndpointGroups",
- "flatPath": "projects/{project}/global/networkEndpointGroups",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.globalNetworkEndpointGroups.list",
- "response": {
- "$ref": "NetworkEndpointGroupList"
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "chargesUseFee": {
+ "type": "boolean",
+ "description": "[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee."
+ },
+ "transferable": {
+ "type": "boolean",
+ "description": "If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk."
+ },
+ "licenseCode": {
+ "format": "uint64",
+ "description": "[Output Only] The unique code used to attach this license to images, snapshots, and disks.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "description": {
+ "description": "An optional textual description of the resource; provided by the client when the resource is created.",
+ "type": "string"
+ }
+ },
+ "id": "License",
+ "description": "Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. "
+ },
+ "LogConfigCounterOptions": {
+ "properties": {
+ "customFields": {
+ "type": "array",
+ "items": {
+ "$ref": "LogConfigCounterOptionsCustomField"
},
- "httpMethod": "GET"
+ "description": "This is deprecated and has no effect. Do not use."
},
- "detachNetworkEndpoints": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "metric": {
+ "description": "This is deprecated and has no effect. Do not use.",
+ "type": "string"
+ },
+ "field": {
+ "type": "string",
+ "description": "This is deprecated and has no effect. Do not use."
+ }
+ },
+ "type": "object",
+ "id": "LogConfigCounterOptions",
+ "description": "This is deprecated and has no effect. Do not use."
+ },
+ "LocationPolicyLocation": {
+ "properties": {
+ "preference": {
+ "description": "Preference for a given location. Set to either ALLOW or DENY.",
+ "enumDescriptions": [
+ "Location is allowed for use.",
+ "Location is prohibited.",
+ "Default value, unused."
],
- "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
- "response": {
- "$ref": "Operation"
- },
- "description": "Detach the network endpoint from the specified network endpoint group.",
- "id": "compute.globalNetworkEndpointGroups.detachNetworkEndpoints",
- "request": {
- "$ref": "GlobalNetworkEndpointGroupsDetachEndpointsRequest"
- },
- "parameterOrder": [
- "project",
- "networkEndpointGroup"
+ "enum": [
+ "ALLOW",
+ "DENY",
+ "PREFERENCE_UNSPECIFIED"
],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
- "parameters": {
- "requestId": {
- "type": "string",
- "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"
- },
- "networkEndpointGroup": {
- "location": "path",
- "required": true,
- "description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.",
- "type": "string"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
- }
- }
+ "type": "string"
},
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}",
- "httpMethod": "DELETE",
- "parameters": {
- "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).",
- "type": "string",
- "location": "query"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "description": "Project ID for this request."
- },
- "networkEndpointGroup": {
- "type": "string",
- "location": "path",
- "description": "The name of the network endpoint group to delete. It should comply with RFC1035.",
- "required": true
- }
- },
- "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}",
- "parameterOrder": [
- "project",
- "networkEndpointGroup"
+ "constraints": {
+ "description": "Constraints that the caller requires on the result distribution in this zone.",
+ "$ref": "LocationPolicyLocationConstraints"
+ }
+ },
+ "type": "object",
+ "id": "LocationPolicyLocation"
+ },
+ "AccessConfig": {
+ "id": "AccessConfig",
+ "properties": {
+ "externalIpv6PrefixLength": {
+ "format": "int32",
+ "description": "The prefix length of the external IPv6 range.",
+ "type": "integer"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#accessConfig",
+ "description": "[Output Only] Type of the resource. Always compute#accessConfig for access configs."
+ },
+ "setPublicPtr": {
+ "description": "Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.",
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string",
+ "description": "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."
+ },
+ "networkTier": {
+ "enumDescriptions": [
+ "Public internet quality with fixed bandwidth.",
+ "High quality, Google-grade network tier, support for all networking products.",
+ "Public internet quality, only limited support for other networking products.",
+ "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured."
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "enum": [
+ "FIXED_STANDARD",
+ "PREMIUM",
+ "STANDARD",
+ "STANDARD_OVERRIDES_FIXED_STANDARD"
],
- "id": "compute.globalNetworkEndpointGroups.delete",
- "description": "Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it."
+ "description": "This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP."
},
- "insert": {
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.",
- "parameters": {
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
- },
- "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).",
- "type": "string",
- "location": "query"
- }
- },
- "path": "projects/{project}/global/networkEndpointGroups",
- "flatPath": "projects/{project}/global/networkEndpointGroups",
- "id": "compute.globalNetworkEndpointGroups.insert",
- "request": {
- "$ref": "NetworkEndpointGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "publicPtrDomainName": {
+ "type": "string",
+ "description": "The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range."
+ },
+ "type": {
+ "enum": [
+ "DIRECT_IPV6",
+ "ONE_TO_ONE_NAT"
],
- "parameterOrder": [
- "project"
+ "default": "ONE_TO_ONE_NAT",
+ "description": "The type of configuration. The default and only option is ONE_TO_ONE_NAT.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
]
},
- "attachNetworkEndpoints": {
- "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request."
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "networkEndpointGroup": {
- "location": "path",
- "type": "string",
- "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.",
- "required": true
- }
- },
- "id": "compute.globalNetworkEndpointGroups.attachNetworkEndpoints",
- "request": {
- "$ref": "GlobalNetworkEndpointGroupsAttachEndpointsRequest"
- },
- "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
- "parameterOrder": [
- "project",
- "networkEndpointGroup"
- ],
- "response": {
- "$ref": "Operation"
- },
- "description": "Attach a network endpoint to the specified network endpoint group.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST"
+ "natIP": {
+ "type": "string",
+ "description": "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."
},
- "get": {
- "id": "compute.globalNetworkEndpointGroups.get",
- "parameterOrder": [
- "project",
- "networkEndpointGroup"
+ "externalIpv6": {
+ "type": "string",
+ "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."
+ }
+ },
+ "description": "An access configuration attached to an instance's network interface. Only one access config per instance is supported.",
+ "type": "object"
+ },
+ "NetworkEndpointGroup": {
+ "properties": {
+ "subnetwork": {
+ "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong.",
+ "type": "string"
+ },
+ "cloudFunction": {
+ "$ref": "NetworkEndpointGroupCloudFunction",
+ "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set."
+ },
+ "kind": {
+ "default": "compute#networkEndpointGroup",
+ "description": "[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "networkEndpointType": {
+ "description": "Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT.",
+ "enum": [
+ "GCE_VM_IP",
+ "GCE_VM_IP_PORT",
+ "INTERNET_FQDN_PORT",
+ "INTERNET_IP_PORT",
+ "NON_GCP_PRIVATE_IP_PORT",
+ "PRIVATE_SERVICE_CONNECT",
+ "SERVERLESS"
],
- "description": "Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.",
- "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enumDescriptions": [
+ "The network endpoint is represented by an IP address.",
+ "The network endpoint is represented by IP address and port pair.",
+ "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."
],
- "response": {
- "$ref": "NetworkEndpointGroup"
- },
- "parameters": {
- "networkEndpointGroup": {
- "description": "The name of the network endpoint group. It should comply with RFC1035.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- }
+ "type": "string"
+ },
+ "pscData": {
+ "$ref": "NetworkEndpointGroupPscData"
+ },
+ "cloudRun": {
+ "$ref": "NetworkEndpointGroupCloudRun",
+ "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set."
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "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."
+ },
+ "pscTargetService": {
+ "type": "string",
+ "description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: \"asia-northeast3-cloudkms.googleapis.com\""
+ },
+ "region": {
+ "description": "[Output Only] The URL of the region where the network endpoint group is located.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "[Output Only] The URL of the zone where the network endpoint group is located.",
+ "type": "string"
+ },
+ "annotations": {
+ "additionalProperties": {
+ "type": "string"
},
- "httpMethod": "GET",
- "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}"
+ "type": "object",
+ "description": "Metadata defined as annotations on the network endpoint group."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "network": {
+ "description": "The URL of the network to which all network endpoints in the NEG belong. Uses \"default\" project network if unspecified.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "size": {
+ "description": "[Output only] Number of network endpoints in the network endpoint group.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "defaultPort": {
+ "type": "integer",
+ "description": "The default port used if the port number is not specified in the network endpoint.",
+ "format": "int32"
+ },
+ "appEngine": {
+ "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set.",
+ "$ref": "NetworkEndpointGroupAppEngine"
+ }
+ },
+ "type": "object",
+ "id": "NetworkEndpointGroup",
+ "description": "Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless NEGs."
+ },
+ "StatefulPolicy": {
+ "id": "StatefulPolicy",
+ "type": "object",
+ "properties": {
+ "preservedState": {
+ "$ref": "StatefulPolicyPreservedState"
}
}
},
- "nodeGroups": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "description": "Deletes the specified NodeGroup resource.",
- "id": "compute.nodeGroups.delete",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "zone",
- "nodeGroup"
- ],
- "parameters": {
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "zone": {
- "description": "The name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "nodeGroup": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "description": "Name of the NodeGroup resource to delete.",
- "type": "string"
- }
- },
- "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}"
+ "HealthChecksAggregatedList": {
+ "properties": {
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
},
- "insert": {
- "request": {
- "$ref": "NodeGroup"
- },
- "description": "Creates a NodeGroup resource in the specified project using the data included in the request.",
- "httpMethod": "POST",
- "id": "compute.nodeGroups.insert",
- "parameters": {
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "warning": {
+ "properties": {
+ "message": {
"type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "description": "The name of the zone for this request.",
- "location": "path",
- "required": true
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "initialNodeCount": {
- "location": "query",
- "format": "int32",
- "type": "integer",
- "description": "Initial count of nodes in the node group.",
- "required": true
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
}
},
- "path": "projects/{project}/zones/{zone}/nodeGroups",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "initialNodeCount"
- ],
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups"
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
},
- "listNodes": {
- "response": {
- "$ref": "NodeGroupsListNodes"
+ "kind": {
+ "default": "compute#healthChecksAggregatedList",
+ "description": "Type of resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "HealthChecksScopedList",
+ "description": "Name of the scope containing this set of HealthChecks."
},
- "id": "compute.nodeGroups.listNodes",
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes",
- "parameters": {
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string",
- "description": "The name of the zone for this request.",
- "location": "path"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "maxResults": {
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "type": "integer",
- "minimum": "0",
- "format": "uint32"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "nodeGroup": {
- "description": "Name of the NodeGroup resource whose nodes you want to list.",
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
+ "description": "A list of HealthChecksScopedList resources."
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes",
- "parameterOrder": [
- "project",
- "zone",
- "nodeGroup"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Lists nodes in the node group."
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array"
},
- "addNodes": {
- "id": "compute.nodeGroups.addNodes",
- "parameters": {
- "zone": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "description": "The name of the zone for this request."
- },
- "nodeGroup": {
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "type": "object",
+ "id": "HealthChecksAggregatedList"
+ },
+ "NodeGroupList": {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "default": "compute#nodeGroupList",
+ "description": "[Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of NodeGroup resources.",
+ "items": {
+ "$ref": "NodeGroup"
+ },
+ "type": "array"
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the NodeGroup resource."
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "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).",
- "location": "query",
- "type": "string"
+ "data": {
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "project": {
+ "message": {
"type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
}
- },
- "parameterOrder": [
- "project",
- "zone",
- "nodeGroup"
- ],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes",
- "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes",
- "description": "Adds specified number of nodes to the node group.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "NodeGroupsAddNodesRequest"
}
},
- "deleteNodes": {
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "zone",
- "nodeGroup"
- ],
- "parameters": {
- "zone": {
- "description": "The name of the zone for this request.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "nodeGroup": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the NodeGroup resource whose nodes will be deleted."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes",
- "id": "compute.nodeGroups.deleteNodes",
- "description": "Deletes specified nodes from the node group.",
- "response": {
- "$ref": "Operation"
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ },
+ "id": "NodeGroupList",
+ "description": "Contains a list of nodeGroups."
+ },
+ "BackendServicesScopedList": {
+ "type": "object",
+ "id": "BackendServicesScopedList",
+ "properties": {
+ "backendServices": {
+ "items": {
+ "$ref": "BackendService"
},
- "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "NodeGroupsDeleteNodesRequest"
- }
+ "type": "array",
+ "description": "A list of BackendServices contained in this scope."
},
- "aggregatedList": {
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
- ],
- "parameters": {
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
+ "warning": {
+ "type": "object",
+ "description": "Informational warning which replaces the list of backend services when the list is empty.",
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string"
},
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "includeAllScopes": {
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
},
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "default": "500",
- "format": "uint32",
- "minimum": "0"
}
+ }
+ }
+ }
+ },
+ "HttpFaultAbort": {
+ "type": "object",
+ "id": "HttpFaultAbort",
+ "description": "Specification for how requests are aborted as part of fault injection.",
+ "properties": {
+ "httpStatus": {
+ "format": "uint32",
+ "description": "The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.",
+ "type": "integer"
+ },
+ "percentage": {
+ "format": "double",
+ "type": "number",
+ "description": "The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive."
+ }
+ }
+ },
+ "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy": {
+ "properties": {
+ "displayName": {
+ "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.",
+ "type": "string"
+ },
+ "rules": {
+ "items": {
+ "$ref": "FirewallPolicyRule"
},
- "response": {
- "$ref": "NodeGroupAggregatedList"
- },
- "description": "Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.nodeGroups.aggregatedList",
- "path": "projects/{project}/aggregated/nodeGroups",
- "flatPath": "projects/{project}/aggregated/nodeGroups"
+ "type": "array",
+ "description": "The rules that apply to the network."
},
- "setIamPolicy": {
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy",
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "zone",
- "resource"
+ "name": {
+ "description": "[Output Only] The name of the firewall policy.",
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "HIERARCHY",
+ "NETWORK",
+ "UNSPECIFIED"
],
- "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy",
- "response": {
- "$ref": "Policy"
- },
- "request": {
- "$ref": "ZoneSetPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "parameters": {
- "resource": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true,
- "description": "Name or id of the resource for this request."
- },
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "zone": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "The name of the zone for this request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "",
+ "",
+ ""
],
- "id": "compute.nodeGroups.setIamPolicy"
+ "description": "[Output Only] The type of the firewall policy.",
+ "type": "string"
+ },
+ "shortName": {
+ "description": "[Output Only] The short name of the firewall policy.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
+ },
+ "WeightedBackendService": {
+ "properties": {
+ "weight": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. The value must be from 0 to 1000."
+ },
+ "headerAction": {
+ "$ref": "HttpHeaderAction",
+ "description": "Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true."
+ },
+ "backendService": {
+ "type": "string",
+ "description": "The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight."
+ }
+ },
+ "description": "In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple backend services. The volume of traffic for each backend service is proportional to the weight specified in each WeightedBackendService",
+ "type": "object",
+ "id": "WeightedBackendService"
+ },
+ "TargetGrpcProxy": {
+ "properties": {
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.",
+ "type": "string",
+ "default": "compute#targetGrpcProxy"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "urlMap": {
+ "type": "string",
+ "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC."
+ },
+ "fingerprint": {
+ "type": "string",
+ "format": "byte",
+ "description": "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 TargetGrpcProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetGrpcProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetGrpcProxy."
+ },
+ "selfLinkWithId": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL with id for the resource."
+ },
+ "validateForProxyless": {
+ "type": "boolean",
+ "description": "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"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.",
+ "format": "uint64"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
},
- "testIamPermissions": {
- "request": {
- "$ref": "TestPermissionsRequest"
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "annotations": {
+ "required": [
+ "compute.targetGrpcProxies.insert"
+ ]
},
- "id": "compute.nodeGroups.testIamPermissions",
- "parameters": {
- "zone": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "location": "path"
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "id": "TargetGrpcProxy",
+ "type": "object",
+ "description": "Represents a Target gRPC Proxy resource. A target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Only global forwarding rules with load balancing scheme INTERNAL_SELF_MANAGED can reference a target gRPC proxy. The target gRPC Proxy references a URL map that specifies how traffic is routed to gRPC backend services."
+ },
+ "UrlMapsAggregatedList": {
+ "id": "UrlMapsAggregatedList",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "default": "compute#urlMapsAggregatedList",
+ "description": "Type of resource."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "items": {
+ "type": "object",
+ "description": "A list of UrlMapsScopedList resources.",
+ "additionalProperties": {
+ "$ref": "UrlMapsScopedList",
+ "description": "Name of the scope containing this set of UrlMaps."
+ }
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ }
},
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "required": true,
- "location": "path",
- "description": "Name or id of the resource for this request."
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
},
- "description": "Returns permissions that a caller has on the specified resource.",
- "response": {
- "$ref": "TestPermissionsResponse"
+ "description": "[Output Only] Informational warning message."
+ },
+ "unreachables": {
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "AuditConfig": {
+ "id": "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.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "items": {
+ "type": "string"
},
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "This is deprecated and has no effect. Do not use.",
+ "type": "array"
+ },
+ "service": {
+ "type": "string",
+ "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."
+ },
+ "auditLogConfigs": {
+ "type": "array",
+ "description": "The configuration for logging of each type of permission.",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
+ }
+ }
+ },
+ "InstanceGroupManagersApplyUpdatesRequest": {
+ "type": "object",
+ "description": "InstanceGroupManagers.applyUpdatesToInstances",
+ "properties": {
+ "allInstances": {
+ "description": "Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.",
+ "type": "boolean"
+ },
+ "minimalAction": {
+ "enumDescriptions": [
+ "Do not perform any action.",
+ "Updates applied in runtime, instances will not be disrupted.",
+ "Old instances will be deleted. New instances will be created from the target template.",
+ "Every instance will be restarted."
],
- "parameterOrder": [
- "project",
- "zone",
- "resource"
+ "enum": [
+ "NONE",
+ "REFRESH",
+ "REPLACE",
+ "RESTART"
],
- "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions",
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions"
+ "description": "The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.",
+ "type": "string"
},
- "get": {
- "response": {
- "$ref": "NodeGroup"
- },
- "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
- "id": "compute.nodeGroups.get",
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
- "parameters": {
- "nodeGroup": {
- "description": "Name of the node group to return.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "zone": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "The name of the zone for this request.",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "mostDisruptiveAllowedAction": {
+ "description": "The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.",
+ "enumDescriptions": [
+ "Do not perform any action.",
+ "Updates applied in runtime, instances will not be disrupted.",
+ "Old instances will be deleted. New instances will be created from the target template.",
+ "Every instance will be restarted."
],
- "httpMethod": "GET",
- "description": "Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the \"nodes\" field should not be used. Use nodeGroups.listNodes instead.",
- "parameterOrder": [
- "project",
- "zone",
- "nodeGroup"
+ "type": "string",
+ "enum": [
+ "NONE",
+ "REFRESH",
+ "REPLACE",
+ "RESTART"
]
},
- "patch": {
- "parameterOrder": [
- "project",
- "zone",
- "nodeGroup"
- ],
- "description": "Updates the specified node group.",
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
- "parameters": {
- "zone": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "instances": {
+ "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "InstanceGroupManagersApplyUpdatesRequest"
+ },
+ "ResourcePoliciesScopedList": {
+ "id": "ResourcePoliciesScopedList",
+ "type": "object",
+ "properties": {
+ "resourcePolicies": {
+ "description": "A list of resourcePolicies contained in this scope.",
+ "type": "array",
+ "items": {
+ "$ref": "ResourcePolicy"
+ }
+ },
+ "warning": {
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "description": "The name of the zone for this request."
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "nodeGroup": {
- "type": "string",
- "description": "Name of the NodeGroup resource to update.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- },
- "requestId": {
- "type": "string",
- "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"
+ "data": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
},
- "httpMethod": "PATCH",
- "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.nodeGroups.patch",
- "request": {
- "$ref": "NodeGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "description": "Informational warning which replaces the list of resourcePolicies when the list is empty.",
+ "type": "object"
+ }
+ }
+ },
+ "Expr": {
+ "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
+ "id": "Expr",
+ "properties": {
+ "description": {
+ "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
+ "type": "string"
},
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/zones/{zone}/nodeGroups",
- "response": {
- "$ref": "NodeGroupList"
- },
- "parameters": {
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "maxResults": {
- "location": "query",
- "default": "500",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "minimum": "0"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "zone": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "type": "string",
- "required": true
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- }
+ "title": {
+ "type": "string",
+ "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression."
+ },
+ "expression": {
+ "type": "string",
+ "description": "Textual representation of an expression in Common Expression Language syntax."
+ },
+ "location": {
+ "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MetadataFilter": {
+ "id": "MetadataFilter",
+ "properties": {
+ "filterLabels": {
+ "items": {
+ "$ref": "MetadataFilterLabelMatch"
},
- "id": "compute.nodeGroups.list",
- "httpMethod": "GET",
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups",
- "parameterOrder": [
- "project",
- "zone"
- ],
- "description": "Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group."
+ "description": "The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.",
+ "type": "array"
},
- "getIamPolicy": {
- "parameterOrder": [
- "project",
- "zone",
- "resource"
+ "filterMatchCriteria": {
+ "enum": [
+ "MATCH_ALL",
+ "MATCH_ANY",
+ "NOT_SET"
],
- "httpMethod": "GET",
- "id": "compute.nodeGroups.getIamPolicy",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata. ",
+ "enumDescriptions": [
+ "Specifies that all filterLabels must match for the metadataFilter to be considered a match.",
+ "Specifies that any filterLabel must match for the metadataFilter to be considered a match.",
+ "Indicates that the match criteria was not set. A metadataFilter must never be created with this value."
],
- "parameters": {
- "resource": {
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- },
- "zone": {
- "required": true,
- "description": "The name of the zone for this request.",
+ "type": "string"
+ }
+ },
+ "description": "Opaque filter criteria used by load balancers to restrict routing configuration to a limited set of load balancing proxies. Proxies and sidecars involved in load balancing would typically present metadata to the load balancers that need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if load balancing involves Envoys, they receive routing configuration when values in metadataFilters match values supplied in of their XDS requests to loadbalancers.",
+ "type": "object"
+ },
+ "InterconnectDiagnosticsARPEntry": {
+ "type": "object",
+ "id": "InterconnectDiagnosticsARPEntry",
+ "properties": {
+ "ipAddress": {
+ "type": "string",
+ "description": "The IP address of this ARP neighbor."
+ },
+ "macAddress": {
+ "description": "The MAC address of this ARP neighbor.",
+ "type": "string"
+ }
+ },
+ "description": "Describing the ARP neighbor entries seen on this link"
+ },
+ "SecurityPoliciesListPreconfiguredExpressionSetsResponse": {
+ "id": "SecurityPoliciesListPreconfiguredExpressionSetsResponse",
+ "properties": {
+ "preconfiguredExpressionSets": {
+ "$ref": "SecurityPoliciesWafConfig"
+ }
+ },
+ "type": "object"
+ },
+ "SslPoliciesScopedList": {
+ "type": "object",
+ "properties": {
+ "warning": {
+ "type": "object",
+ "description": "Informational warning which replaces the list of SSL policies when the list is empty.",
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "optionsRequestedPolicyVersion": {
- "format": "int32",
- "description": "Requested IAM Policy version.",
- "type": "integer",
- "location": "query"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
+ }
+ },
+ "sslPolicies": {
+ "items": {
+ "$ref": "SslPolicy"
},
- "response": {
- "$ref": "Policy"
- },
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy",
- "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy"
+ "type": "array",
+ "description": "A list of SslPolicies contained in this scope."
+ }
+ },
+ "id": "SslPoliciesScopedList"
+ },
+ "UrlMapTestHeader": {
+ "id": "UrlMapTestHeader",
+ "type": "object",
+ "description": "HTTP headers used in UrlMapTests.",
+ "properties": {
+ "value": {
+ "description": "Header value.",
+ "type": "string"
},
- "setNodeTemplate": {
- "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate",
- "description": "Updates the node template of the node group.",
- "response": {
- "$ref": "Operation"
+ "name": {
+ "type": "string",
+ "description": "Header name."
+ }
+ }
+ },
+ "RegionInstanceGroupManagersAbandonInstancesRequest": {
+ "type": "object",
+ "id": "RegionInstanceGroupManagersAbandonInstancesRequest",
+ "properties": {
+ "instances": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "zone",
- "nodeGroup"
- ],
- "httpMethod": "POST",
- "parameters": {
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "requestId": {
- "location": "query",
- "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).",
+ "description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]."
+ }
+ }
+ },
+ "NodeGroupsListNodes": {
+ "type": "object",
+ "properties": {
+ "items": {
+ "description": "A list of Node resources.",
+ "type": "array",
+ "items": {
+ "$ref": "NodeGroupNode"
+ }
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string"
},
- "zone": {
- "required": true,
+ "message": {
"type": "string",
- "description": "The name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "nodeGroup": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the NodeGroup resource to update.",
- "required": true,
- "type": "string",
- "location": "path"
+ "data": {
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
- },
- "request": {
- "$ref": "NodeGroupsSetNodeTemplateRequest"
- },
- "id": "compute.nodeGroups.setNodeTemplate"
+ }
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "[Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group.",
+ "default": "compute#nodeGroupsListNodes",
+ "type": "string"
}
- }
+ },
+ "id": "NodeGroupsListNodes"
},
- "licenseCodes": {
- "methods": {
- "testIamPermissions": {
- "parameterOrder": [
- "project",
- "resource"
+ "BfdPacket": {
+ "id": "BfdPacket",
+ "type": "object",
+ "properties": {
+ "multipoint": {
+ "type": "boolean",
+ "description": "The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880"
+ },
+ "length": {
+ "type": "integer",
+ "description": "The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880",
+ "format": "uint32"
+ },
+ "minEchoRxIntervalMs": {
+ "description": "The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "controlPlaneIndependent": {
+ "description": "The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880",
+ "type": "boolean"
+ },
+ "myDiscriminator": {
+ "description": "The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "state": {
+ "description": "The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "description": "Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "string",
+ "enum": [
+ "ADMIN_DOWN",
+ "DOWN",
+ "INIT",
+ "STATE_UNSPECIFIED",
+ "UP"
+ ]
+ },
+ "diagnostic": {
+ "description": "The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "parameters": {
- "resource": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
+ "type": "string",
+ "enum": [
+ "ADMINISTRATIVELY_DOWN",
+ "CONCATENATED_PATH_DOWN",
+ "CONTROL_DETECTION_TIME_EXPIRED",
+ "DIAGNOSTIC_UNSPECIFIED",
+ "ECHO_FUNCTION_FAILED",
+ "FORWARDING_PLANE_RESET",
+ "NEIGHBOR_SIGNALED_SESSION_DOWN",
+ "NO_DIAGNOSTIC",
+ "PATH_DOWN",
+ "REVERSE_CONCATENATED_PATH_DOWN"
+ ]
+ },
+ "authenticationPresent": {
+ "description": "The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880",
+ "type": "boolean"
+ },
+ "version": {
+ "description": "The version number of the BFD protocol, as specified in section 4.1 of RFC5880.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "yourDiscriminator": {
+ "format": "uint32",
+ "description": "The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880",
+ "type": "integer"
+ },
+ "minTxIntervalMs": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880"
+ },
+ "minRxIntervalMs": {
+ "type": "integer",
+ "description": "The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880",
+ "format": "uint32"
+ },
+ "demand": {
+ "description": "The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880",
+ "type": "boolean"
+ },
+ "poll": {
+ "type": "boolean",
+ "description": "The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880"
+ },
+ "final": {
+ "type": "boolean",
+ "description": "The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880"
+ },
+ "multiplier": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880"
+ }
+ }
+ },
+ "SecuritySettings": {
+ "description": "The authentication and authorization settings for a BackendService.",
+ "id": "SecuritySettings",
+ "properties": {
+ "subjectAltNames": {
+ "description": "Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode). Note: This field currently has no impact.",
+ "items": {
+ "type": "string"
},
- "request": {
- "$ref": "TestPermissionsRequest"
+ "type": "array"
+ },
+ "clientTlsPolicy": {
+ "description": "Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TargetVpnGatewayAggregatedList": {
+ "type": "object",
+ "id": "TargetVpnGatewayAggregatedList",
+ "properties": {
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "response": {
- "$ref": "TestPermissionsResponse"
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "kind": {
+ "default": "compute#targetVpnGatewayAggregatedList",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways."
+ },
+ "items": {
+ "additionalProperties": {
+ "description": "[Output Only] Name of the scope containing this set of target VPN gateways.",
+ "$ref": "TargetVpnGatewaysScopedList"
},
- "id": "compute.licenseCodes.testIamPermissions",
- "httpMethod": "POST",
- "path": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions",
- "flatPath": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions"
+ "description": "A list of TargetVpnGateway resources.",
+ "type": "object"
},
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "licenseCode"
- ],
- "path": "projects/{project}/global/licenseCodes/{licenseCode}",
- "description": "Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/global/licenseCodes/{licenseCode}",
- "id": "compute.licenseCodes.get",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "warning": {
+ "properties": {
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ },
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "licenseCode": {
- "description": "Number corresponding to the License code resource to return.",
- "location": "path",
- "pattern": "[0-9]{0,61}?",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "required": true
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "response": {
- "$ref": "LicenseCode"
- }
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
}
}
},
- "vpnGateways": {
- "methods": {
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}",
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.vpnGateways.delete",
- "parameterOrder": [
- "project",
- "region",
- "vpnGateway"
- ],
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "required": true
- },
- "vpnGateway": {
+ "NamedPort": {
+ "type": "object",
+ "properties": {
+ "port": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The port number, which can be a value between 1 and 65535."
+ },
+ "name": {
+ "description": "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.",
+ "type": "string"
+ }
+ },
+ "description": "The named port. For example: \u003c\"http\", 80\u003e.",
+ "id": "NamedPort"
+ },
+ "NetworkAttachmentAggregatedList": {
+ "id": "NetworkAttachmentAggregatedList",
+ "description": "Contains a list of NetworkAttachmentsScopedList.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "items": {
+ "type": "object",
+ "description": "A list of NetworkAttachmentsScopedList resources.",
+ "additionalProperties": {
+ "$ref": "NetworkAttachmentsScopedList",
+ "description": "Name of the scope containing this set of NetworkAttachments."
+ }
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "kind": {
+ "default": "compute#networkAttachmentAggregatedList",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "code": {
"type": "string",
- "description": "Name of the VPN gateway to delete.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "region": {
+ "message": {
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "description": "Name of the region for this request."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ }
}
- },
- "httpMethod": "DELETE",
- "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}",
- "description": "Deletes the specified VPN gateway."
+ }
},
- "setLabels": {
- "request": {
- "$ref": "RegionSetLabelsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.vpnGateways.setLabels",
- "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ }
+ }
+ },
+ "ServerBinding": {
+ "type": "object",
+ "id": "ServerBinding",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "Node may associate with any physical server over its lifetime.",
+ "Node may associate with minimal physical servers over its lifetime.",
+ ""
],
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "enum": [
+ "RESTART_NODE_ON_ANY_SERVER",
+ "RESTART_NODE_ON_MINIMAL_SERVERS",
+ "SERVER_BINDING_TYPE_UNSPECIFIED"
],
- "description": "Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.",
- "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels",
- "parameters": {
- "region": {
- "required": true,
- "location": "path",
- "description": "The region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ }
+ }
+ },
+ "RoutersScopedList": {
+ "id": "RoutersScopedList",
+ "properties": {
+ "warning": {
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "description": "Project ID for this request."
- },
- "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).",
- "location": "query",
- "type": "string"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "type": "array"
},
- "resource": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "required": true,
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
+ },
+ "type": "object",
+ "description": "Informational warning which replaces the list of routers when the list is empty."
+ },
+ "routers": {
+ "description": "A list of routers contained in this scope.",
+ "type": "array",
+ "items": {
+ "$ref": "Router"
}
+ }
+ },
+ "type": "object"
+ },
+ "BackendBucketCdnPolicyBypassCacheOnRequestHeader": {
+ "properties": {
+ "headerName": {
+ "type": "string",
+ "description": "The header field name to match on when bypassing cache. Values are case-insensitive."
+ }
+ },
+ "type": "object",
+ "id": "BackendBucketCdnPolicyBypassCacheOnRequestHeader",
+ "description": "Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting."
+ },
+ "BackendBucketCdnPolicyNegativeCachingPolicy": {
+ "type": "object",
+ "id": "BackendBucketCdnPolicyNegativeCachingPolicy",
+ "description": "Specify CDN TTLs for response error codes.",
+ "properties": {
+ "code": {
+ "description": "The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.",
+ "type": "integer",
+ "format": "int32"
},
- "getStatus": {
- "description": "Returns the status for the specified VPN gateway.",
- "id": "compute.vpnGateways.getStatus",
- "parameters": {
- "region": {
- "description": "Name of the region for this request.",
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
- },
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
- },
- "vpnGateway": {
- "required": true,
- "description": "Name of the VPN gateway to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path"
- }
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "ttl": {
+ "format": "int32",
+ "description": "The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
+ "type": "integer"
+ }
+ }
+ },
+ "AutoscalingPolicy": {
+ "description": "Cloud Autoscaler policy.",
+ "properties": {
+ "coolDownPeriodSec": {
+ "description": "The number of seconds that the autoscaler waits before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "scaleInControl": {
+ "$ref": "AutoscalingPolicyScaleInControl"
+ },
+ "scalingSchedules": {
+ "type": "object",
+ "description": "Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.",
+ "additionalProperties": {
+ "$ref": "AutoscalingPolicyScalingSchedule"
+ }
+ },
+ "maxNumReplicas": {
+ "type": "integer",
+ "description": "The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas.",
+ "format": "int32"
+ },
+ "mode": {
+ "enumDescriptions": [
+ "Do not automatically scale the MIG in or out. The recommended_size field contains the size of MIG that would be set if the actuation mode was enabled.",
+ "Automatically scale the MIG in and out according to the policy.",
+ "Automatically create VMs according to the policy, but do not scale the MIG in.",
+ "Automatically create VMs according to the policy, but do not scale the MIG in."
],
- "parameterOrder": [
- "project",
- "region",
- "vpnGateway"
+ "enum": [
+ "OFF",
+ "ON",
+ "ONLY_SCALE_OUT",
+ "ONLY_UP"
],
- "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus",
- "response": {
- "$ref": "VpnGatewaysGetStatusResponse"
- },
- "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus"
+ "description": "Defines operating mode for this policy.",
+ "type": "string"
},
- "insert": {
- "flatPath": "projects/{project}/regions/{region}/vpnGateways",
- "parameters": {
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "region": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request.",
- "location": "path"
- },
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
+ "customMetricUtilizations": {
+ "type": "array",
+ "items": {
+ "$ref": "AutoscalingPolicyCustomMetricUtilization"
},
- "description": "Creates a VPN gateway in the specified project and region using the data included in the request.",
- "parameterOrder": [
- "project",
- "region"
+ "description": "Configuration parameters of autoscaling based on a custom metric."
+ },
+ "cpuUtilization": {
+ "description": "Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.",
+ "$ref": "AutoscalingPolicyCpuUtilization"
+ },
+ "minNumReplicas": {
+ "description": "The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "loadBalancingUtilization": {
+ "$ref": "AutoscalingPolicyLoadBalancingUtilization",
+ "description": "Configuration parameters of autoscaling based on load balancer."
+ }
+ },
+ "id": "AutoscalingPolicy",
+ "type": "object"
+ },
+ "Scheduling": {
+ "properties": {
+ "minNodeCpus": {
+ "description": "The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "instanceTerminationAction": {
+ "type": "string",
+ "description": "Specifies the termination action for the instance.",
+ "enum": [
+ "DELETE",
+ "INSTANCE_TERMINATION_ACTION_UNSPECIFIED",
+ "STOP"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "Delete the VM.",
+ "Default value. This value is unused.",
+ "Stop the VM without storing in-memory content. default action."
+ ]
+ },
+ "provisioningModel": {
+ "enum": [
+ "SPOT",
+ "STANDARD"
],
- "request": {
- "$ref": "VpnGateway"
- },
- "id": "compute.vpnGateways.insert",
- "path": "projects/{project}/regions/{region}/vpnGateways"
+ "enumDescriptions": [
+ "Heavily discounted, no guaranteed runtime.",
+ "Standard provisioning with user controlled runtime, no discounts."
+ ],
+ "description": "Specifies the provisioning model of the instance.",
+ "type": "string"
},
- "list": {
- "response": {
- "$ref": "VpnGatewayList"
- },
- "parameters": {
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the region for this request."
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "type": "integer",
- "format": "uint32",
- "location": "query",
- "default": "500"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "project": {
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- }
+ "nodeAffinities": {
+ "items": {
+ "$ref": "SchedulingNodeAffinity"
},
- "flatPath": "projects/{project}/regions/{region}/vpnGateways",
- "id": "compute.vpnGateways.list",
- "path": "projects/{project}/regions/{region}/vpnGateways",
- "parameterOrder": [
- "project",
- "region"
+ "type": "array",
+ "description": "A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity."
+ },
+ "locationHint": {
+ "type": "string",
+ "description": "An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API."
+ },
+ "onHostMaintenance": {
+ "description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy.",
+ "enumDescriptions": [
+ "*[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.",
+ "Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events."
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "string",
+ "enum": [
+ "MIGRATE",
+ "TERMINATE"
+ ]
+ },
+ "preemptible": {
+ "description": "Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.",
+ "type": "boolean"
+ },
+ "automaticRestart": {
+ "type": "boolean",
+ "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine."
+ }
+ },
+ "type": "object",
+ "description": "Sets the scheduling options for an Instance.",
+ "id": "Scheduling"
+ },
+ "SubnetworkLogConfig": {
+ "description": "The available logging options for this subnetwork.",
+ "type": "object",
+ "id": "SubnetworkLogConfig",
+ "properties": {
+ "filterExpr": {
+ "type": "string",
+ "description": "Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging."
+ },
+ "metadata": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
],
- "description": "Retrieves a list of VPN gateways available to the specified project and region.",
- "httpMethod": "GET"
+ "type": "string",
+ "enum": [
+ "CUSTOM_METADATA",
+ "EXCLUDE_ALL_METADATA",
+ "INCLUDE_ALL_METADATA"
+ ],
+ "description": "Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA."
},
- "get": {
- "description": "Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.",
- "parameterOrder": [
- "project",
- "region",
- "vpnGateway"
+ "flowSampling": {
+ "format": "float",
+ "description": "Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported.",
+ "type": "number"
+ },
+ "enable": {
+ "description": "Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled.",
+ "type": "boolean"
+ },
+ "aggregationInterval": {
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}",
- "response": {
- "$ref": "VpnGateway"
+ "enum": [
+ "INTERVAL_10_MIN",
+ "INTERVAL_15_MIN",
+ "INTERVAL_1_MIN",
+ "INTERVAL_30_SEC",
+ "INTERVAL_5_MIN",
+ "INTERVAL_5_SEC"
+ ],
+ "description": "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.",
+ "type": "string"
+ },
+ "metadataFields": {
+ "description": "Can only be specified if VPC flow logs for this subnetwork is enabled and \"metadata\" was set to CUSTOM_METADATA.",
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}",
- "id": "compute.vpnGateways.get",
- "parameters": {
- "region": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "Name of the region for this request."
- },
- "vpnGateway": {
- "description": "Name of the VPN gateway to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string"
- }
+ "type": "array"
+ }
+ }
+ },
+ "RouterNat": {
+ "type": "object",
+ "properties": {
+ "subnetworks": {
+ "items": {
+ "$ref": "RouterNatSubnetworkToNat"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET"
+ "type": "array",
+ "description": "A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above."
},
- "testIamPermissions": {
- "id": "compute.vpnGateways.testIamPermissions",
- "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions",
- "parameters": {
- "resource": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name or id of the resource for this request."
- },
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "region": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the region for this request."
- }
+ "tcpTransitoryIdleTimeoutSec": {
+ "description": "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "tcpEstablishedIdleTimeoutSec": {
+ "type": "integer",
+ "description": "Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.",
+ "format": "int32"
+ },
+ "endpointTypes": {
+ "items": {
+ "enum": [
+ "ENDPOINT_TYPE_SWG",
+ "ENDPOINT_TYPE_VM"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "This is used for Secure Web Gateway endpoints.",
+ "This is the default."
+ ]
},
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "type": "array",
+ "description": "List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM"
+ },
+ "natIpAllocateOption": {
+ "enumDescriptions": [
+ "Nat IPs are allocated by GCP; customers can not specify any Nat IPs.",
+ "Only use Nat IPs provided by customers. When specified Nat IPs are not enough then the Nat service fails for new VMs."
],
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. ",
+ "enum": [
+ "AUTO_ONLY",
+ "MANUAL_ONLY"
],
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions"
+ "type": "string"
},
- "aggregatedList": {
- "id": "compute.vpnGateways.aggregatedList",
- "path": "projects/{project}/aggregated/vpnGateways",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "udpIdleTimeoutSec": {
+ "type": "integer",
+ "description": "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.",
+ "format": "int32"
+ },
+ "enableEndpointIndependentMapping": {
+ "type": "boolean"
+ },
+ "tcpTimeWaitTimeoutSec": {
+ "description": "Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "sourceSubnetworkIpRangesToNat": {
+ "enum": [
+ "ALL_SUBNETWORKS_ALL_IP_RANGES",
+ "ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES",
+ "LIST_OF_SUBNETWORKS"
],
- "flatPath": "projects/{project}/aggregated/vpnGateways",
- "description": "Retrieves an aggregated list of VPN gateways.",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "location": "query",
- "type": "integer",
- "minimum": "0",
- "format": "uint32"
- },
- "includeAllScopes": {
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean"
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- }
+ "description": "Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.",
+ "type": "string",
+ "enumDescriptions": [
+ "All the IP ranges in every Subnetwork are allowed to Nat.",
+ "All the primary IP ranges in every Subnetwork are allowed to Nat.",
+ "A list of Subnetworks are allowed to Nat (specified in the field subnetwork below)"
+ ]
+ },
+ "logConfig": {
+ "$ref": "RouterNatLogConfig",
+ "description": "Configure logging on this NAT."
+ },
+ "name": {
+ "type": "string",
+ "description": "Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "drainNatIps": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "response": {
- "$ref": "VpnGatewayAggregatedList"
+ "description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only."
+ },
+ "minPortsPerVm": {
+ "description": "Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "natIps": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project."
+ },
+ "enableDynamicPortAllocation": {
+ "type": "boolean",
+ "description": "Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config. "
+ },
+ "maxPortsPerVm": {
+ "type": "integer",
+ "description": "Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.",
+ "format": "int32"
+ },
+ "icmpIdleTimeoutSec": {
+ "description": "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rules": {
+ "type": "array",
+ "description": "A list of rules associated with this NAT.",
+ "items": {
+ "$ref": "RouterNatRule"
+ }
+ }
+ },
+ "id": "RouterNat",
+ "description": "Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided."
+ },
+ "ResourcePolicyWeeklyCycle": {
+ "type": "object",
+ "id": "ResourcePolicyWeeklyCycle",
+ "properties": {
+ "dayOfWeeks": {
+ "type": "array",
+ "items": {
+ "$ref": "ResourcePolicyWeeklyCycleDayOfWeek"
},
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
- ]
+ "description": "Up to 7 intervals/windows, one for each day of the week."
}
- }
+ },
+ "description": "Time window specified for weekly operations."
},
- "networkEdgeSecurityServices": {
- "methods": {
- "aggregatedList": {
- "parameterOrder": [
- "project"
- ],
- "description": "Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project.",
- "parameters": {
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "description": "Name of the project scoping this request.",
- "location": "path"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "includeAllScopes": {
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean"
- },
- "maxResults": {
- "location": "query",
- "format": "uint32",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "type": "integer"
- }
- },
- "response": {
- "$ref": "NetworkEdgeSecurityServiceAggregatedList"
+ "DisksResizeRequest": {
+ "id": "DisksResizeRequest",
+ "properties": {
+ "sizeGb": {
+ "description": "The new size of the persistent disk, which is specified in GB.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RegionInstanceGroupManagerUpdateInstanceConfigReq": {
+ "id": "RegionInstanceGroupManagerUpdateInstanceConfigReq",
+ "properties": {
+ "perInstanceConfigs": {
+ "items": {
+ "$ref": "PerInstanceConfig"
},
- "httpMethod": "GET",
- "path": "projects/{project}/aggregated/networkEdgeSecurityServices",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/aggregated/networkEdgeSecurityServices",
- "id": "compute.networkEdgeSecurityServices.aggregatedList"
+ "type": "array",
+ "description": "The list of per-instance configurations to insert or patch on this managed instance group."
+ }
+ },
+ "description": "RegionInstanceGroupManagers.updatePerInstanceConfigs",
+ "type": "object"
+ },
+ "UsableSubnetworksAggregatedList": {
+ "id": "UsableSubnetworksAggregatedList",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
},
- "delete": {
- "id": "compute.networkEdgeSecurityServices.delete",
- "parameters": {
- "region": {
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "type": "string"
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string"
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks.",
+ "type": "string",
+ "default": "compute#usableSubnetworksAggregatedList"
+ },
+ "warning": {
+ "properties": {
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "networkEdgeSecurityService": {
- "location": "path",
- "required": true,
+ "message": {
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the network edge security service to delete."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "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).",
- "location": "query",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string"
}
},
- "description": "Deletes the specified service.",
- "parameterOrder": [
- "project",
- "region",
- "networkEdgeSecurityService"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
- "httpMethod": "DELETE"
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
},
- "patch": {
- "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
- "httpMethod": "PATCH",
- "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
- "request": {
- "$ref": "NetworkEdgeSecurityService"
- },
- "response": {
- "$ref": "Operation"
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. In special cases listUsable may return 0 subnetworks and nextPageToken which still should be used to get the next page of results.",
+ "type": "string"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "UsableSubnetwork"
},
- "id": "compute.networkEdgeSecurityServices.patch",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Patches the specified policy with the data included in the request.",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "networkEdgeSecurityService": {
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the network edge security service to update."
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "location": "query",
- "description": "Indicates fields to be updated as part of this request.",
- "type": "string"
+ "description": "[Output] A list of usable subnetwork URLs."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ }
+ }
+ },
+ "TargetHttpProxiesScopedList": {
+ "type": "object",
+ "id": "TargetHttpProxiesScopedList",
+ "properties": {
+ "warning": {
+ "description": "Informational warning which replaces the list of backend services when the list is empty.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "type": "array"
},
- "region": {
- "required": true,
- "location": "path",
+ "message": {
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "paths": {
+ "code": {
"type": "string",
- "repeated": true,
- "location": "query"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
- },
- "parameterOrder": [
- "project",
- "region",
- "networkEdgeSecurityService"
- ]
+ }
},
- "get": {
- "parameterOrder": [
- "project",
- "region",
- "networkEdgeSecurityService"
+ "targetHttpProxies": {
+ "description": "A list of TargetHttpProxies contained in this scope.",
+ "type": "array",
+ "items": {
+ "$ref": "TargetHttpProxy"
+ }
+ }
+ }
+ },
+ "InstancesAddResourcePoliciesRequest": {
+ "properties": {
+ "resourcePolicies": {
+ "type": "array",
+ "description": "Resource policies to be added to this instance.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "InstancesAddResourcePoliciesRequest",
+ "type": "object"
+ },
+ "NodeGroupAutoscalingPolicy": {
+ "id": "NodeGroupAutoscalingPolicy",
+ "type": "object",
+ "properties": {
+ "minNodes": {
+ "description": "The minimum number of nodes that the group should have.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "mode": {
+ "enum": [
+ "MODE_UNSPECIFIED",
+ "OFF",
+ "ON",
+ "ONLY_SCALE_OUT"
],
- "id": "compute.networkEdgeSecurityServices.get",
- "parameters": {
- "networkEdgeSecurityService": {
- "location": "path",
- "description": "Name of the network edge security service to get.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "Autoscaling is disabled.",
+ "Autocaling is fully enabled.",
+ "Autoscaling will only scale out and will not remove nodes."
+ ]
+ },
+ "maxNodes": {
+ "format": "int32",
+ "description": "The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.",
+ "type": "integer"
+ }
+ }
+ },
+ "NetworkEdgeSecurityServiceAggregatedList": {
+ "id": "NetworkEdgeSecurityServiceAggregatedList",
+ "properties": {
+ "etag": {
+ "type": "string"
+ },
+ "items": {
+ "type": "object",
+ "description": "A list of NetworkEdgeSecurityServicesScopedList resources.",
+ "additionalProperties": {
+ "description": "Name of the scope containing this set of security policies.",
+ "$ref": "NetworkEdgeSecurityServicesScopedList"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "required": true
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string"
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
},
- "region": {
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
},
- "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
- "description": "Gets a specified NetworkEdgeSecurityService.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
- "response": {
- "$ref": "NetworkEdgeSecurityService"
- },
- "httpMethod": "GET"
+ "type": "object"
},
- "insert": {
- "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices",
- "request": {
- "$ref": "NetworkEdgeSecurityService"
- },
- "description": "Creates a new service in the specified project using the data included in the request.",
- "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices",
- "response": {
- "$ref": "Operation"
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#networkEdgeSecurityServiceAggregatedList for lists of Network Edge Security Services.",
+ "type": "string",
+ "default": "compute#networkEdgeSecurityServiceAggregatedList"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "parameters": {
- "region": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "Name of the region scoping this request."
- },
- "project": {
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "validateOnly": {
- "location": "query",
- "type": "boolean",
- "description": "If true, the request will not be committed."
- }
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LicenseCodeLicenseAlias": {
+ "id": "LicenseCodeLicenseAlias",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "[Output Only] Description of this License Code.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] URL of license corresponding to this License Code.",
+ "type": "string"
+ }
+ }
+ },
+ "TargetPoolInstanceHealth": {
+ "id": "TargetPoolInstanceHealth",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "default": "compute#targetPoolInstanceHealth",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance."
+ },
+ "healthStatus": {
+ "items": {
+ "$ref": "HealthStatus"
},
- "parameterOrder": [
- "project",
- "region"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.networkEdgeSecurityServices.insert",
- "httpMethod": "POST"
+ "type": "array"
}
}
},
- "urlMaps": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "HealthStatusForNetworkEndpoint": {
+ "id": "HealthStatusForNetworkEndpoint",
+ "type": "object",
+ "properties": {
+ "healthState": {
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
],
- "response": {
- "$ref": "UrlMap"
- },
- "id": "compute.urlMaps.get",
- "parameterOrder": [
- "project",
- "urlMap"
+ "enum": [
+ "DRAINING",
+ "HEALTHY",
+ "UNHEALTHY",
+ "UNKNOWN"
],
- "path": "projects/{project}/global/urlMaps/{urlMap}",
- "flatPath": "projects/{project}/global/urlMaps/{urlMap}",
- "description": "Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.",
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "urlMap": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the UrlMap resource to return."
- }
- }
+ "description": "Health state of the network endpoint determined based on the health checks configured."
},
- "patch": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "PATCH",
- "flatPath": "projects/{project}/global/urlMaps/{urlMap}",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request."
- },
- "urlMap": {
- "location": "path",
- "type": "string",
- "description": "Name of the UrlMap resource to patch.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "path": "projects/{project}/global/urlMaps/{urlMap}",
- "id": "compute.urlMaps.patch",
- "request": {
- "$ref": "UrlMap"
- },
- "parameterOrder": [
- "project",
- "urlMap"
- ]
+ "backendService": {
+ "$ref": "BackendServiceReference",
+ "description": "URL of the backend service associated with the health state of the network endpoint."
},
- "delete": {
- "httpMethod": "DELETE",
- "description": "Deletes the specified UrlMap resource.",
- "response": {
- "$ref": "Operation"
+ "healthCheck": {
+ "description": "URL of the health check associated with the health state of the network endpoint.",
+ "$ref": "HealthCheckReference"
+ },
+ "forwardingRule": {
+ "description": "URL of the forwarding rule associated with the health state of the network endpoint.",
+ "$ref": "ForwardingRuleReference"
+ },
+ "healthCheckService": {
+ "$ref": "HealthCheckServiceReference",
+ "description": "URL of the health check service associated with the health state of the network endpoint."
+ }
+ }
+ },
+ "CommitmentList": {
+ "description": "Contains a list of Commitment resources.",
+ "type": "object",
+ "id": "CommitmentList",
+ "properties": {
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#commitmentList for lists of commitments.",
+ "type": "string",
+ "default": "compute#commitmentList"
+ },
+ "items": {
+ "items": {
+ "$ref": "Commitment"
},
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "required": true
+ "description": "A list of Commitment resources.",
+ "type": "array"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "type": "array"
},
- "urlMap": {
- "description": "Name of the UrlMap resource to delete.",
+ "code": {
"type": "string",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
- },
- "flatPath": "projects/{project}/global/urlMaps/{urlMap}",
- "id": "compute.urlMaps.delete",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "path": "projects/{project}/global/urlMaps/{urlMap}"
- },
- "insert": {
- "description": "Creates a UrlMap resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
}
- },
- "httpMethod": "POST",
- "path": "projects/{project}/global/urlMaps",
- "id": "compute.urlMaps.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "UrlMap"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/global/urlMaps"
+ }
},
- "list": {
- "httpMethod": "GET",
- "flatPath": "projects/{project}/global/urlMaps",
- "response": {
- "$ref": "UrlMapList"
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ }
+ }
+ },
+ "TargetReference": {
+ "properties": {
+ "target": {
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "TargetReference"
+ },
+ "NotificationEndpointGrpcSettings": {
+ "type": "object",
+ "description": "Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint.",
+ "id": "NotificationEndpointGrpcSettings",
+ "properties": {
+ "retryDurationSec": {
+ "format": "uint32",
+ "description": "How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number.",
+ "type": "integer"
+ },
+ "resendInterval": {
+ "description": "Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. Can only be set for regional notification endpoints.",
+ "$ref": "Duration"
+ },
+ "payloadName": {
+ "type": "string",
+ "description": "Optional. If specified, this field is used to populate the \"name\" field in gRPC requests."
+ },
+ "authority": {
+ "description": "Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3",
+ "type": "string"
+ },
+ "endpoint": {
+ "type": "string",
+ "description": "Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name."
+ }
+ }
+ },
+ "NetworksAddPeeringRequest": {
+ "properties": {
+ "networkPeering": {
+ "description": "Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon.",
+ "$ref": "NetworkPeering"
+ },
+ "autoCreateRoutes": {
+ "description": "This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.",
+ "type": "boolean"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "compute.networks.addPeering"
+ ]
},
- "id": "compute.urlMaps.list",
- "parameterOrder": [
- "project"
- ],
- "path": "projects/{project}/global/urlMaps",
- "description": "Retrieves the list of UrlMap resources available to the specified project.",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "orderBy": {
+ "description": "Name of the peering, which should conform to RFC1035.",
+ "type": "string"
+ },
+ "peerNetwork": {
+ "description": "URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.",
+ "type": "string"
+ }
+ },
+ "id": "NetworksAddPeeringRequest",
+ "type": "object"
+ },
+ "NodeTypeAggregatedList": {
+ "properties": {
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "filter": {
+ "message": {
"type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "maxResults": {
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "type": "integer",
- "minimum": "0",
- "default": "500"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ }
}
+ }
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array"
},
- "invalidateCache": {
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "items": {
+ "type": "object",
+ "description": "A list of NodeTypesScopedList resources.",
+ "additionalProperties": {
+ "$ref": "NodeTypesScopedList",
+ "description": "[Output Only] Name of the scope containing this set of node types."
+ }
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#nodeTypeAggregatedList",
+ "type": "string",
+ "description": "[Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ }
+ },
+ "type": "object",
+ "id": "NodeTypeAggregatedList"
+ },
+ "ForwardingRuleAggregatedList": {
+ "properties": {
+ "warning": {
+ "properties": {
+ "code": {
"type": "string",
- "description": "Project ID for this request."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "urlMap": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the UrlMap scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
},
- "description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).",
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "response": {
- "$ref": "Operation"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "unreachables": {
+ "description": "[Output Only] Unreachable resources.",
+ "items": {
+ "type": "string"
},
- "request": {
- "$ref": "CacheInvalidationRule"
+ "type": "array"
+ },
+ "items": {
+ "additionalProperties": {
+ "description": "Name of the scope containing this set of addresses.",
+ "$ref": "ForwardingRulesScopedList"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache",
- "flatPath": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache",
- "id": "compute.urlMaps.invalidateCache",
- "httpMethod": "POST"
+ "type": "object",
+ "description": "A list of ForwardingRulesScopedList resources."
},
- "aggregatedList": {
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.",
+ "default": "compute#forwardingRuleAggregatedList",
+ "type": "string"
+ }
+ },
+ "id": "ForwardingRuleAggregatedList",
+ "type": "object"
+ },
+ "ManagedInstance": {
+ "type": "object",
+ "properties": {
+ "currentAction": {
+ "description": "[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. ",
+ "enumDescriptions": [
+ "The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.",
+ "The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.",
+ "The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.",
+ "The managed instance group is permanently deleting this instance.",
+ "The managed instance group has not scheduled any actions for this instance.",
+ "The managed instance group is recreating this instance.",
+ "The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.",
+ "The managed instance group is restarting this instance.",
+ "The managed instance group is resuming this instance.",
+ "The managed instance group is starting this instance.",
+ "The managed instance group is stopping this instance.",
+ "The managed instance group is suspending this instance.",
+ "The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions)."
],
- "id": "compute.urlMaps.aggregatedList",
- "path": "projects/{project}/aggregated/urlMaps",
- "flatPath": "projects/{project}/aggregated/urlMaps",
- "parameters": {
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "type": "integer",
- "minimum": "0",
- "default": "500",
- "format": "uint32"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query",
- "type": "boolean"
- },
- "project": {
- "required": true,
- "description": "Name of the project scoping this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enum": [
+ "ABANDONING",
+ "CREATING",
+ "CREATING_WITHOUT_RETRIES",
+ "DELETING",
+ "NONE",
+ "RECREATING",
+ "REFRESHING",
+ "RESTARTING",
+ "RESUMING",
+ "STARTING",
+ "STOPPING",
+ "SUSPENDING",
+ "VERIFYING"
],
- "response": {
- "$ref": "UrlMapsAggregatedList"
- },
- "description": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project."
+ "type": "string"
},
- "validate": {
- "id": "compute.urlMaps.validate",
- "path": "projects/{project}/global/urlMaps/{urlMap}/validate",
- "flatPath": "projects/{project}/global/urlMaps/{urlMap}/validate",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "UrlMapsValidateResponse"
+ "preservedStateFromPolicy": {
+ "description": "[Output Only] Preserved state generated based on stateful policy for this instance.",
+ "$ref": "PreservedState"
+ },
+ "instanceHealth": {
+ "type": "array",
+ "items": {
+ "$ref": "ManagedInstanceInstanceHealth"
},
- "parameterOrder": [
- "project",
- "urlMap"
+ "description": "[Output Only] Health state of the instance per health-check."
+ },
+ "lastAttempt": {
+ "$ref": "ManagedInstanceLastAttempt",
+ "description": "[Output Only] Information about the last attempt to create or delete the instance."
+ },
+ "instance": {
+ "description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.",
+ "type": "string"
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output only] The unique identifier for this resource. This field is empty when instance does not exist.",
+ "type": "string"
+ },
+ "preservedStateFromConfig": {
+ "$ref": "PreservedState",
+ "description": "[Output Only] Preserved state applied from per-instance config for this instance."
+ },
+ "instanceStatus": {
+ "enumDescriptions": [
+ "The Nanny is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.",
+ "Resources are being allocated for the instance.",
+ "The instance is in repair.",
+ "The instance is running.",
+ "All required resources have been allocated and the instance is being started.",
+ "The instance has stopped successfully.",
+ "The instance is currently stopping (either being deleted or killed).",
+ "The instance has suspended.",
+ "The instance is suspending.",
+ "The instance has stopped (either by explicit action or underlying failure)."
],
- "request": {
- "$ref": "UrlMapsValidateRequest"
- },
- "parameters": {
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
+ "type": "string",
+ "description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.",
+ "enum": [
+ "DEPROVISIONING",
+ "PROVISIONING",
+ "REPAIRING",
+ "RUNNING",
+ "STAGING",
+ "STOPPED",
+ "STOPPING",
+ "SUSPENDED",
+ "SUSPENDING",
+ "TERMINATED"
+ ]
+ },
+ "version": {
+ "$ref": "ManagedInstanceVersion",
+ "description": "[Output Only] Intended version of this instance."
+ }
+ },
+ "description": "A Managed Instance resource.",
+ "id": "ManagedInstance"
+ },
+ "InstanceGroupManagersListPerInstanceConfigsResp": {
+ "id": "InstanceGroupManagersListPerInstanceConfigsResp",
+ "properties": {
+ "warning": {
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
+ },
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string"
},
- "urlMap": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true,
- "description": "Name of the UrlMap resource to be validated as.",
- "location": "path"
+ "data": {
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
}
},
- "description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.",
- "httpMethod": "POST"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
},
- "update": {
- "path": "projects/{project}/global/urlMaps/{urlMap}",
- "flatPath": "projects/{project}/global/urlMaps/{urlMap}",
- "request": {
- "$ref": "UrlMap"
- },
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true
- },
- "urlMap": {
- "description": "Name of the UrlMap resource to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "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"
- }
- },
- "response": {
- "$ref": "Operation"
+ "items": {
+ "type": "array",
+ "description": "[Output Only] The list of PerInstanceConfig.",
+ "items": {
+ "$ref": "PerInstanceConfig"
+ }
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DiskParams": {
+ "description": "Additional disk params.",
+ "type": "object",
+ "id": "DiskParams",
+ "properties": {
+ "resourceManagerTags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "PUT",
- "id": "compute.urlMaps.update",
- "parameterOrder": [
- "project",
- "urlMap"
- ],
- "description": "Updates the specified UrlMap resource with the data included in the request."
+ "description": "Resource manager tags to be bound to the disk. 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."
}
}
},
- "regionTargetHttpsProxies": {
- "methods": {
- "patch": {
- "request": {
- "$ref": "TargetHttpsProxy"
- },
- "httpMethod": "PATCH",
- "id": "compute.regionTargetHttpsProxies.patch",
- "parameters": {
- "region": {
- "type": "string",
- "description": "Name of the region for this request.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "targetHttpsProxy": {
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the TargetHttpsProxy resource to patch."
- }
- },
- "description": "Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
- "parameterOrder": [
- "project",
- "region",
- "targetHttpsProxy"
+ "Address": {
+ "type": "object",
+ "properties": {
+ "ipVersion": {
+ "enum": [
+ "IPV4",
+ "IPV6",
+ "UNSPECIFIED_VERSION"
],
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
- "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
]
},
- "setUrlMap": {
- "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
- "parameters": {
- "region": {
- "location": "path",
- "required": true,
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "targetHttpsProxy": {
- "description": "Name of the TargetHttpsProxy to set a URL map for.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "id": "compute.regionTargetHttpsProxies.setUrlMap",
- "request": {
- "$ref": "UrlMapReference"
- },
- "description": "Changes the URL map for TargetHttpsProxy.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "targetHttpsProxy"
- ],
- "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST"
+ "address": {
+ "description": "The static IP address represented by this resource.",
+ "type": "string"
},
- "delete": {
- "description": "Deletes the specified TargetHttpsProxy resource.",
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.regionTargetHttpsProxies.delete",
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "targetHttpsProxy": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the TargetHttpsProxy resource to delete.",
- "location": "path"
- },
- "project": {
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "required": true
- }
- },
- "httpMethod": "DELETE",
- "parameterOrder": [
- "project",
- "region",
- "targetHttpsProxy"
+ "addressType": {
+ "enum": [
+ "EXTERNAL",
+ "INTERNAL",
+ "UNSPECIFIED_TYPE"
],
- "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "enumDescriptions": [
+ "A publicly visible external IP address.",
+ "A private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.",
+ ""
],
- "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}"
+ "description": "The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL."
},
- "setSslCertificates": {
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "region",
- "targetHttpsProxy"
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "networkTier": {
+ "enum": [
+ "FIXED_STANDARD",
+ "PREMIUM",
+ "STANDARD",
+ "STANDARD_OVERRIDES_FIXED_STANDARD"
],
- "parameters": {
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "location": "path",
- "type": "string",
- "required": true
- },
- "targetHttpsProxy": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.",
- "required": true,
- "location": "path"
- }
- },
- "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "Public internet quality with fixed bandwidth.",
+ "High quality, Google-grade network tier, support for all networking products.",
+ "Public internet quality, only limited support for other networking products.",
+ "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured."
],
- "description": "Replaces SslCertificates for TargetHttpsProxy.",
- "id": "compute.regionTargetHttpsProxies.setSslCertificates",
- "request": {
- "$ref": "RegionTargetHttpsProxiesSetSslCertificatesRequest"
- },
- "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
- "response": {
- "$ref": "Operation"
- }
+ "description": "This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.",
+ "type": "string"
},
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "ipv6EndpointType": {
+ "enum": [
+ "NETLB",
+ "VM"
],
- "response": {
- "$ref": "TargetHttpsProxy"
- },
- "parameters": {
- "region": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "type": "string",
- "description": "Name of the region scoping this request."
- },
- "targetHttpsProxy": {
- "type": "string",
- "location": "path",
- "description": "Name of the TargetHttpsProxy resource to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- },
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- }
- },
- "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
- "httpMethod": "GET",
- "id": "compute.regionTargetHttpsProxies.get",
- "description": "Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.",
- "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
- "parameterOrder": [
- "project",
- "region",
- "targetHttpsProxy"
+ "description": "The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Reserved IPv6 address can be used on network load balancer.",
+ "Reserved IPv6 address can be used on VM."
]
},
- "insert": {
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "TargetHttpsProxy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.",
- "path": "projects/{project}/regions/{region}/targetHttpsProxies",
- "parameterOrder": [
- "project",
- "region"
- ],
- "httpMethod": "POST",
- "parameters": {
- "region": {
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "Name of the region scoping this request."
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
- }
- },
- "id": "compute.regionTargetHttpsProxies.insert",
- "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies"
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
- "list": {
- "id": "compute.regionTargetHttpsProxies.list",
- "parameterOrder": [
- "project",
- "region"
+ "status": {
+ "type": "string",
+ "enum": [
+ "IN_USE",
+ "RESERVED",
+ "RESERVING"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.",
+ "enumDescriptions": [
+ "Address is being used by another resource and is not available.",
+ "Address is reserved and available to use.",
+ "Address is being reserved."
+ ]
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this field when you create the resource.",
+ "type": "string"
+ },
+ "prefixLength": {
+ "description": "The prefix length if the resource represents an IP range.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "network": {
+ "type": "string",
+ "description": "The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose."
+ },
+ "purpose": {
+ "enum": [
+ "DNS_RESOLVER",
+ "GCE_ENDPOINT",
+ "IPSEC_INTERCONNECT",
+ "NAT_AUTO",
+ "PRIVATE_SERVICE_CONNECT",
+ "SERVERLESS",
+ "SHARED_LOADBALANCER_VIP",
+ "VPC_PEERING"
],
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "region": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "minimum": "0",
- "location": "query",
- "format": "uint32"
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- }
- },
- "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies",
- "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.",
- "response": {
- "$ref": "TargetHttpsProxyList"
+ "type": "string",
+ "description": "The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. ",
+ "enumDescriptions": [
+ "DNS resolver address in the subnetwork.",
+ "VM internal/alias IP, Internal LB service IP, etc.",
+ "A regional internal IP address range reserved for the VLAN attachment that is used in HA VPN over Cloud Interconnect. This regional internal IP address range must not overlap with any IP address range of subnet/route in the VPC network and its peering networks. After the VLAN attachment is created with the reserved IP address range, when creating a new VPN gateway, its interface IP address is allocated from the associated VLAN attachment’s IP address range.",
+ "External IP automatically reserved for Cloud NAT.",
+ "A private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL",
+ "A regional internal IP address range reserved for Serverless.",
+ "A private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.",
+ "IP range for peer networks."
+ ]
+ },
+ "kind": {
+ "default": "compute#address",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#address for addresses."
+ },
+ "region": {
+ "description": "[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.*",
+ "type": "string"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "compute.addresses.insert"
+ ]
},
- "path": "projects/{project}/regions/{region}/targetHttpsProxies"
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit."
+ },
+ "subnetwork": {
+ "type": "string",
+ "description": "The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose."
+ },
+ "users": {
+ "description": "[Output Only] The URLs of the resources that are using this address.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
- }
+ },
+ "id": "Address",
+ "description": "Represents an IP Address resource. Google Compute Engine has two IP Address resources: * [Global (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/globalAddresses) * [Regional (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/addresses) For more information, see Reserving a static external IP address."
},
- "targetHttpProxies": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
- "parameters": {
- "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).",
- "type": "string",
- "location": "query"
- },
- "targetHttpProxy": {
- "location": "path",
- "type": "string",
- "description": "Name of the TargetHttpProxy resource to delete.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- }
+ "SourceInstanceProperties": {
+ "properties": {
+ "networkInterfaces": {
+ "type": "array",
+ "items": {
+ "$ref": "NetworkInterface"
},
- "httpMethod": "DELETE",
- "parameterOrder": [
- "project",
- "targetHttpProxy"
- ],
- "id": "compute.targetHttpProxies.delete",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
- "description": "Deletes the specified TargetHttpProxy resource."
+ "description": "An array of network access configurations for this interface."
},
- "get": {
- "id": "compute.targetHttpProxies.get",
- "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "targetHttpProxy"
- ],
- "response": {
- "$ref": "TargetHttpProxy"
+ "scheduling": {
+ "description": "Specifies the scheduling options for the instances that are created from this machine image.",
+ "$ref": "Scheduling"
+ },
+ "deletionProtection": {
+ "description": "Whether the instance created from this machine image should be protected against deletion.",
+ "type": "boolean"
+ },
+ "serviceAccounts": {
+ "type": "array",
+ "items": {
+ "$ref": "ServiceAccount"
},
- "parameters": {
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
- },
- "targetHttpProxy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the TargetHttpProxy resource to return.",
- "location": "path",
- "required": true,
- "type": "string"
- }
+ "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances."
+ },
+ "tags": {
+ "$ref": "Tags",
+ "description": "A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035."
+ },
+ "minCpuPlatform": {
+ "description": "Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.",
+ "type": "string"
+ },
+ "guestAccelerators": {
+ "items": {
+ "$ref": "AcceleratorConfig"
},
- "httpMethod": "GET",
- "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
- "description": "Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request."
+ "type": "array",
+ "description": "A list of guest accelerator cards' type and count to use for instances created from this machine image."
},
- "patch": {
- "httpMethod": "PATCH",
- "description": "Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
- "response": {
- "$ref": "Operation"
+ "disks": {
+ "items": {
+ "$ref": "SavedAttachedDisk"
},
- "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "array",
+ "description": "An array of disks that are associated with the instances that are created from this machine image."
+ },
+ "metadata": {
+ "$ref": "Metadata",
+ "description": "The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information."
+ },
+ "description": {
+ "description": "An optional text description for the instances that are created from this machine image.",
+ "type": "string"
+ },
+ "labels": {
+ "type": "object",
+ "description": "Labels to apply to instances that are created from this machine image.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "canIpForward": {
+ "description": "Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.",
+ "type": "boolean"
+ },
+ "machineType": {
+ "description": "The machine type to use for instances that are created from this machine image.",
+ "type": "string"
+ },
+ "keyRevocationActionType": {
+ "type": "string",
+ "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.",
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "Indicates user chose no operation.",
+ "Indicates user chose to opt for VM shutdown on key revocation."
],
- "id": "compute.targetHttpProxies.patch",
- "parameterOrder": [
- "project",
- "targetHttpProxy"
+ "enum": [
+ "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED",
+ "NONE",
+ "STOP"
+ ]
+ }
+ },
+ "description": "DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.",
+ "id": "SourceInstanceProperties",
+ "type": "object"
+ },
+ "BackendBucketCdnPolicy": {
+ "properties": {
+ "requestCoalescing": {
+ "description": "If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.",
+ "type": "boolean"
+ },
+ "signedUrlCacheMaxAgeSec": {
+ "format": "int64",
+ "type": "string",
+ "description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered."
+ },
+ "cacheMode": {
+ "description": "Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.",
+ "type": "string",
+ "enum": [
+ "CACHE_ALL_STATIC",
+ "FORCE_CACHE_ALL",
+ "INVALID_CACHE_MODE",
+ "USE_ORIGIN_HEADERS"
],
- "request": {
- "$ref": "TargetHttpProxy"
+ "enumDescriptions": [
+ "Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.",
+ "Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.",
+ "",
+ "Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server."
+ ]
+ },
+ "bypassCacheOnRequestHeaders": {
+ "items": {
+ "$ref": "BackendBucketCdnPolicyBypassCacheOnRequestHeader"
},
- "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
- "parameters": {
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string"
- },
- "targetHttpProxy": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the TargetHttpProxy resource to patch.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
+ "type": "array",
+ "description": "Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings."
+ },
+ "clientTtl": {
+ "format": "int32",
+ "description": "Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a \"public\" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a \"public\" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).",
+ "type": "integer"
+ },
+ "signedUrlKeyNames": {
+ "type": "array",
+ "description": "[Output Only] Names of the keys for signing request URLs.",
+ "items": {
+ "type": "string"
}
},
- "aggregatedList": {
- "response": {
- "$ref": "TargetHttpProxyAggregatedList"
+ "maxTtl": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of \"0\" means \"always revalidate\". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL."
+ },
+ "negativeCachingPolicy": {
+ "items": {
+ "$ref": "BackendBucketCdnPolicyNegativeCachingPolicy"
},
- "flatPath": "projects/{project}/aggregated/targetHttpProxies",
- "parameters": {
- "includeAllScopes": {
- "type": "boolean",
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "minimum": "0",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Name of the project scoping this request.",
- "required": true
- }
+ "type": "array",
+ "description": "Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists."
+ },
+ "cacheKeyPolicy": {
+ "$ref": "BackendBucketCdnPolicyCacheKeyPolicy",
+ "description": "The CacheKeyPolicy for this CdnPolicy."
+ },
+ "serveWhileStale": {
+ "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "negativeCaching": {
+ "type": "boolean",
+ "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy."
+ },
+ "defaultTtl": {
+ "format": "int32",
+ "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
+ "type": "integer"
+ }
+ },
+ "id": "BackendBucketCdnPolicy",
+ "description": "Message containing Cloud CDN configuration for a backend bucket.",
+ "type": "object"
+ },
+ "BackendServiceLocalityLoadBalancingPolicyConfig": {
+ "id": "BackendServiceLocalityLoadBalancingPolicyConfig",
+ "properties": {
+ "policy": {
+ "$ref": "BackendServiceLocalityLoadBalancingPolicyConfigPolicy"
+ },
+ "customPolicy": {
+ "$ref": "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy"
+ }
+ },
+ "type": "object",
+ "description": "Container for either a built-in LB policy supported by gRPC or Envoy or a custom one implemented by the end user."
+ },
+ "ResourceStatus": {
+ "id": "ResourceStatus",
+ "type": "object",
+ "description": "Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls.",
+ "properties": {
+ "physicalHost": {
+ "description": "[Output Only] An opaque ID of the host on which the VM is running.",
+ "type": "string"
+ }
+ }
+ },
+ "AttachedDisk": {
+ "id": "AttachedDisk",
+ "properties": {
+ "source": {
+ "type": "string",
+ "description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk."
+ },
+ "autoDelete": {
+ "type": "boolean",
+ "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance)."
+ },
+ "licenses": {
+ "items": {
+ "type": "string"
},
- "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.",
- "httpMethod": "GET",
- "path": "projects/{project}/aggregated/targetHttpProxies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "[Output Only] Any valid publicly visible licenses.",
+ "type": "array"
+ },
+ "shieldedInstanceInitialState": {
+ "description": "[Output Only] shielded vm initial state stored on disk",
+ "$ref": "InitialStateConfig"
+ },
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
+ "default": "compute#attachedDisk",
+ "type": "string"
+ },
+ "guestOsFeatures": {
+ "type": "array",
+ "items": {
+ "$ref": "GuestOsFeature"
+ },
+ "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options."
+ },
+ "initializeParams": {
+ "$ref": "AttachedDiskInitializeParams",
+ "description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both."
+ },
+ "mode": {
+ "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.",
+ "type": "string",
+ "enumDescriptions": [
+ "Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.",
+ "*[Default]* Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode."
],
- "parameterOrder": [
- "project"
+ "enum": [
+ "READ_ONLY",
+ "READ_WRITE"
+ ]
+ },
+ "type": {
+ "description": "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.",
+ "enumDescriptions": [
+ "",
+ ""
],
- "id": "compute.targetHttpProxies.aggregatedList"
+ "type": "string",
+ "enum": [
+ "PERSISTENT",
+ "SCRATCH"
+ ]
},
- "insert": {
- "flatPath": "projects/{project}/global/targetHttpProxies",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Project ID for this request."
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project"
+ "diskSizeGb": {
+ "description": "The size of the disk in GB.",
+ "format": "int64",
+ "type": "string"
+ },
+ "forceAttach": {
+ "type": "boolean",
+ "description": "[Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error."
+ },
+ "index": {
+ "type": "integer",
+ "format": "int32",
+ "description": "[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number."
+ },
+ "diskEncryptionKey": {
+ "$ref": "CustomerEncryptionKey",
+ "description": "Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group."
+ },
+ "architecture": {
+ "enum": [
+ "ARCHITECTURE_UNSPECIFIED",
+ "ARM64",
+ "X86_64"
],
- "path": "projects/{project}/global/targetHttpProxies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "Default value indicating Architecture is not set.",
+ "Machines with architecture ARM64",
+ "Machines with architecture X86_64"
],
- "id": "compute.targetHttpProxies.insert",
- "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.",
- "request": {
- "$ref": "TargetHttpProxy"
- },
- "httpMethod": "POST"
+ "type": "string",
+ "description": "[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64."
},
- "list": {
- "id": "compute.targetHttpProxies.list",
- "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
+ "deviceName": {
+ "description": "Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.",
+ "type": "string"
+ },
+ "boot": {
+ "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.",
+ "type": "boolean"
+ },
+ "interface": {
+ "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see About persistent disks.",
+ "enumDescriptions": [
+ "",
+ ""
],
- "flatPath": "projects/{project}/global/targetHttpProxies",
- "response": {
- "$ref": "TargetHttpProxyList"
+ "type": "string",
+ "enum": [
+ "NVME",
+ "SCSI"
+ ]
+ }
+ },
+ "type": "object",
+ "description": "An instance-attached disk resource."
+ },
+ "TargetHttpProxyList": {
+ "id": "TargetHttpProxyList",
+ "type": "object",
+ "properties": {
+ "items": {
+ "description": "A list of TargetHttpProxy resources.",
+ "items": {
+ "$ref": "TargetHttpProxy"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/global/targetHttpProxies",
- "parameters": {
- "pageToken": {
- "location": "query",
+ "type": "array"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#targetHttpProxyList",
+ "description": "Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "warning": {
+ "properties": {
+ "message": {
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "maxResults": {
- "default": "500",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "format": "uint32",
- "minimum": "0"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "filter": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
}
- }
+ },
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
},
- "setUrlMap": {
- "request": {
- "$ref": "UrlMapReference"
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ },
+ "description": "A list of TargetHttpProxy resources."
+ },
+ "TargetInstancesScopedList": {
+ "id": "TargetInstancesScopedList",
+ "type": "object",
+ "properties": {
+ "targetInstances": {
+ "type": "array",
+ "items": {
+ "$ref": "TargetInstance"
},
- "httpMethod": "POST",
- "parameters": {
- "targetHttpProxy": {
- "location": "path",
+ "description": "A list of target instances contained in this scope."
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the TargetHttpProxy to set a URL map for.",
- "required": true
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
+ "message": {
"type": "string",
- "description": "Project ID for this request.",
- "location": "path"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
},
- "parameterOrder": [
- "project",
- "targetHttpProxy"
- ],
- "path": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
- "description": "Changes the URL map for TargetHttpProxy.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "Informational warning which replaces the list of addresses when the list is empty."
+ }
+ }
+ },
+ "TargetTcpProxy": {
+ "type": "object",
+ "description": "Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview.",
+ "id": "TargetTcpProxy",
+ "properties": {
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy."
+ },
+ "service": {
+ "type": "string",
+ "description": "URL to the BackendService resource."
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "proxyBind": {
+ "description": "This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.",
+ "type": "boolean"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "kind": {
+ "default": "compute#targetTcpProxy",
+ "description": "[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "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."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "proxyHeader": {
+ "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
+ "type": "string",
+ "enum": [
+ "NONE",
+ "PROXY_V1"
],
- "flatPath": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
- "id": "compute.targetHttpProxies.setUrlMap",
- "response": {
- "$ref": "Operation"
- }
+ "enumDescriptions": [
+ "",
+ ""
+ ]
}
}
},
- "subnetworks": {
- "methods": {
- "get": {
- "parameters": {
- "region": {
- "location": "path",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
- },
- "subnetwork": {
- "location": "path",
- "type": "string",
- "description": "Name of the Subnetwork resource to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- }
- },
- "httpMethod": "GET",
- "response": {
- "$ref": "Subnetwork"
+ "OperationAggregatedList": {
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "unreachables": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "description": "Returns the specified subnetwork. Gets a list of available subnetworks list() request.",
- "id": "compute.subnetworks.get",
- "parameterOrder": [
- "project",
- "region",
- "subnetwork"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
- "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}"
+ "description": "[Output Only] Unreachable resources."
},
- "testIamPermissions": {
- "parameters": {
- "region": {
- "required": true,
+ "kind": {
+ "description": "[Output Only] Type of resource. Always `compute#operationAggregatedList` for aggregated lists of operations.",
+ "type": "string",
+ "default": "compute#operationAggregatedList"
+ },
+ "warning": {
+ "properties": {
+ "code": {
"type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the region for this request."
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "resource": {
- "description": "Name or id of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path"
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
},
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
},
- "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.",
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "path": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions",
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "id": "compute.subnetworks.testIamPermissions",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than `maxResults`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results."
+ },
+ "items": {
+ "type": "object",
+ "description": "[Output Only] A map of scoped operation lists.",
+ "additionalProperties": {
+ "description": "[Output Only] Name of the scope containing this set of operations.",
+ "$ref": "OperationsScopedList"
+ }
},
- "insert": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/subnetworks",
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/subnetworks",
- "id": "compute.subnetworks.insert",
- "description": "Creates a subnetwork in the specified project using the data included in the request.",
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ }
+ },
+ "id": "OperationAggregatedList"
+ },
+ "NotificationEndpointList": {
+ "type": "object",
+ "id": "NotificationEndpointList",
+ "properties": {
+ "warning": {
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array"
},
- "project": {
+ "message": {
"type": "string",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "region": {
- "required": true,
- "location": "path",
- "description": "Name of the region scoping this request.",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "parameterOrder": [
- "project",
- "region"
- ],
- "request": {
- "$ref": "Subnetwork"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of NotificationEndpoint resources.",
+ "type": "array",
+ "items": {
+ "$ref": "NotificationEndpoint"
}
},
- "setIamPolicy": {
- "path": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy",
- "request": {
- "$ref": "RegionSetPolicyRequest"
+ "kind": {
+ "default": "compute#notificationEndpointList",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ }
+ },
+ "HealthCheckLogConfig": {
+ "id": "HealthCheckLogConfig",
+ "properties": {
+ "enable": {
+ "description": "Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.",
+ "type": "boolean"
+ }
+ },
+ "description": "Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver.",
+ "type": "object"
+ },
+ "StatefulPolicyPreservedState": {
+ "id": "StatefulPolicyPreservedState",
+ "properties": {
+ "disks": {
+ "description": "Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.",
+ "additionalProperties": {
+ "$ref": "StatefulPolicyPreservedStateDiskDevice"
},
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true,
- "description": "Name or id of the resource for this request."
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string"
- },
- "region": {
- "location": "path",
- "type": "string",
- "description": "The name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
+ "type": "object"
+ }
+ },
+ "description": "Configuration of preserved resources.",
+ "type": "object"
+ },
+ "RouterMd5AuthenticationKey": {
+ "id": "RouterMd5AuthenticationKey",
+ "properties": {
+ "name": {
+ "description": "Name used to identify the key. Must be unique within a router. Must be referenced by at least one bgpPeer. Must comply with RFC1035.",
+ "annotations": {
+ "required": [
+ "compute.routers.insert",
+ "compute.routers.update"
+ ]
},
- "id": "compute.subnetworks.setIamPolicy",
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "response": {
- "$ref": "Policy"
+ "type": "string"
+ },
+ "key": {
+ "annotations": {
+ "required": [
+ "compute.routers.insert"
+ ]
},
- "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy"
+ "description": "[Input only] Value of the key. For patch and update calls, it can be skipped to copy the value from the previous configuration. This is allowed if the key with the same name existed before the operation. Maximum length is 80 characters. Can only contain printable ASCII characters.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NodeGroupAggregatedList": {
+ "id": "NodeGroupAggregatedList",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
},
- "delete": {
- "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of NodeGroupsScopedList resources.",
+ "additionalProperties": {
+ "description": "[Output Only] Name of the scope containing this set of node groups.",
+ "$ref": "NodeGroupsScopedList"
},
- "id": "compute.subnetworks.delete",
- "description": "Deletes the specified subnetwork.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "project",
- "region",
- "subnetwork"
- ],
- "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "location": "path",
- "required": true
+ "type": "object"
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true
+ "data": {
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "subnetwork": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "required": true,
- "description": "Name of the Subnetwork resource to delete."
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
+ },
+ "description": "[Output Only] Informational warning message."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "kind": {
+ "default": "compute#nodeGroupAggregatedList",
+ "description": "[Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups.",
+ "type": "string"
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
+ },
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array"
+ }
+ }
+ },
+ "InstancesStartWithEncryptionKeyRequest": {
+ "properties": {
+ "disks": {
+ "description": "Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified.",
+ "type": "array",
+ "items": {
+ "$ref": "CustomerEncryptionKeyProtectedDisk"
}
+ }
+ },
+ "type": "object",
+ "id": "InstancesStartWithEncryptionKeyRequest"
+ },
+ "TargetHttpsProxyAggregatedList": {
+ "properties": {
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
},
- "getIamPolicy": {
- "id": "compute.subnetworks.getIamPolicy",
- "parameters": {
- "region": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "description": "The name of the region for this request."
- },
- "resource": {
- "required": true,
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of TargetHttpsProxiesScopedList resources.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "TargetHttpsProxiesScopedList",
+ "description": "Name of the scope containing this set of TargetHttpsProxies."
+ }
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "project": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "optionsRequestedPolicyVersion": {
- "location": "query",
- "description": "Requested IAM Policy version.",
- "format": "int32",
- "type": "integer"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ }
}
+ }
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "type": "array",
+ "description": "[Output Only] Unreachable resources."
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies.",
+ "default": "compute#targetHttpsProxyAggregatedList",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "TargetHttpsProxyAggregatedList"
+ },
+ "PublicDelegatedPrefix": {
+ "type": "object",
+ "properties": {
+ "isLiveMigration": {
+ "description": "If true, the prefix will be live migrated.",
+ "type": "boolean"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ },
+ "status": {
+ "type": "string",
+ "enumDescriptions": [
+ "The public delegated prefix is active.",
+ "The public delegated prefix is being deprovsioned.",
+ "The public delegated prefix is being initialized and addresses cannot be created yet.",
+ "The public delegated prefix is currently withdrawn but ready to be announced."
],
- "httpMethod": "GET",
- "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enum": [
+ "ANNOUNCED",
+ "DELETING",
+ "INITIALIZING",
+ "READY_TO_ANNOUNCE"
],
- "response": {
- "$ref": "Policy"
- },
- "path": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists."
+ "description": "[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. "
},
- "patch": {
- "request": {
- "$ref": "Subnetwork"
- },
- "description": "Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "region",
- "subnetwork"
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "publicDelegatedSubPrefixs": {
+ "type": "array",
+ "description": "The list of sub public delegated prefixes that exist for this public delegated prefix.",
+ "items": {
+ "$ref": "PublicDelegatedPrefixPublicDelegatedSubPrefix"
+ }
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "name": {
+ "description": "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.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "annotations": {
+ "required": [
+ "compute.publicDelegatedPrefixes.insert"
+ ]
+ }
+ },
+ "parentPrefix": {
+ "description": "The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "fingerprint": {
+ "type": "string",
+ "description": "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 new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.",
+ "format": "byte"
+ },
+ "kind": {
+ "default": "compute#publicDelegatedPrefix",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes."
+ },
+ "ipCidrRange": {
+ "type": "string",
+ "description": "The IPv4 address range, in CIDR format, represented by this public delegated prefix."
+ }
+ },
+ "description": "A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.",
+ "id": "PublicDelegatedPrefix"
+ },
+ "AutoscalingPolicyCpuUtilization": {
+ "type": "object",
+ "properties": {
+ "predictiveMethod": {
+ "description": "Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are: * NONE (default). No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics. * OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand.",
+ "enumDescriptions": [
+ "No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics",
+ "Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand."
],
- "parameters": {
- "drainTimeoutSeconds": {
- "description": "The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.",
- "location": "query",
- "type": "integer",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "subnetwork": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the Subnetwork resource to patch.",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enum": [
+ "NONE",
+ "OPTIMIZE_AVAILABILITY"
],
- "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
- "id": "compute.subnetworks.patch",
- "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
- "httpMethod": "PATCH"
+ "type": "string"
},
- "setPrivateIpGoogleAccess": {
- "parameters": {
- "subnetwork": {
- "description": "Name of the Subnetwork resource.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
- },
- "request": {
- "$ref": "SubnetworksSetPrivateIpGoogleAccessRequest"
- },
- "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess",
- "httpMethod": "POST",
- "id": "compute.subnetworks.setPrivateIpGoogleAccess",
- "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess",
- "description": "Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.",
- "parameterOrder": [
- "project",
- "region",
- "subnetwork"
+ "utilizationTarget": {
+ "type": "number",
+ "format": "double",
+ "description": "The target CPU utilization that the autoscaler maintains. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales in the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales out until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization."
+ }
+ },
+ "id": "AutoscalingPolicyCpuUtilization",
+ "description": "CPU utilization policy."
+ },
+ "ConsistentHashLoadBalancerSettingsHttpCookie": {
+ "id": "ConsistentHashLoadBalancerSettingsHttpCookie",
+ "properties": {
+ "ttl": {
+ "$ref": "Duration",
+ "description": "Lifetime of the cookie."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the cookie."
+ },
+ "path": {
+ "description": "Path to set for the cookie.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "description": "The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash."
+ },
+ "RegionInstanceGroupsListInstancesRequest": {
+ "id": "RegionInstanceGroupsListInstancesRequest",
+ "properties": {
+ "instanceState": {
+ "enumDescriptions": [
+ "Matches any status of the instances, running, non-running and others.",
+ "Instance is in RUNNING state if it is running."
],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "description": "Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.",
+ "enum": [
+ "ALL",
+ "RUNNING"
]
},
- "aggregatedList": {
- "parameterOrder": [
- "project"
+ "portName": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances."
+ }
+ },
+ "type": "object"
+ },
+ "InstanceGroupManagerAutoHealingPolicy": {
+ "id": "InstanceGroupManagerAutoHealingPolicy",
+ "type": "object",
+ "properties": {
+ "initialDelaySec": {
+ "type": "integer",
+ "description": "The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].",
+ "format": "int32"
+ },
+ "healthCheck": {
+ "type": "string",
+ "description": "The URL for the health check that signals autohealing."
+ }
+ }
+ },
+ "Commitment": {
+ "type": "object",
+ "description": "Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.",
+ "properties": {
+ "autoRenew": {
+ "type": "boolean",
+ "description": "Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment."
+ },
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#commitment for commitments.",
+ "type": "string",
+ "default": "compute#commitment"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "plan": {
+ "description": "The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
],
- "httpMethod": "GET",
- "parameters": {
- "maxResults": {
- "default": "500",
- "format": "uint32",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "minimum": "0"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "project": {
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "includeAllScopes": {
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- }
- },
- "flatPath": "projects/{project}/aggregated/subnetworks",
- "response": {
- "$ref": "SubnetworkAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "string",
+ "enum": [
+ "INVALID",
+ "THIRTY_SIX_MONTH",
+ "TWELVE_MONTH"
+ ]
+ },
+ "status": {
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "id": "compute.subnetworks.aggregatedList",
- "path": "projects/{project}/aggregated/subnetworks",
- "description": "Retrieves an aggregated list of subnetworks."
+ "enum": [
+ "ACTIVE",
+ "CANCELLED",
+ "CREATING",
+ "EXPIRED",
+ "NOT_YET_ACTIVE"
+ ],
+ "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED."
},
- "listUsable": {
- "path": "projects/{project}/aggregated/subnetworks/listUsable",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "licenseResource": {
+ "description": "The license specification required as part of a license commitment.",
+ "$ref": "LicenseResourceCommitment"
+ },
+ "type": {
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "maxResults": {
- "location": "query",
- "type": "integer",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "minimum": "0"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- }
- },
- "id": "compute.subnetworks.listUsable",
- "response": {
- "$ref": "UsableSubnetworksAggregatedList"
- },
- "description": "Retrieves an aggregated list of all usable subnetworks in the project.",
- "parameterOrder": [
- "project"
+ "description": "The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.",
+ "enum": [
+ "ACCELERATOR_OPTIMIZED",
+ "COMPUTE_OPTIMIZED",
+ "COMPUTE_OPTIMIZED_C2D",
+ "GENERAL_PURPOSE",
+ "GENERAL_PURPOSE_E2",
+ "GENERAL_PURPOSE_N2",
+ "GENERAL_PURPOSE_N2D",
+ "GENERAL_PURPOSE_T2D",
+ "MEMORY_OPTIMIZED",
+ "MEMORY_OPTIMIZED_M3",
+ "TYPE_UNSPECIFIED"
],
- "httpMethod": "GET",
- "flatPath": "projects/{project}/aggregated/subnetworks/listUsable"
+ "type": "string"
},
- "expandIpCidrRange": {
- "parameterOrder": [
- "project",
- "region",
- "subnetwork"
+ "statusMessage": {
+ "description": "[Output Only] An optional, human-readable explanation of the status.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "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.",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where this commitment may be used."
+ },
+ "startTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Commitment start time in RFC3339 text format."
+ },
+ "category": {
+ "enum": [
+ "CATEGORY_UNSPECIFIED",
+ "LICENSE",
+ "MACHINE"
],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "",
+ "",
+ ""
],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange",
- "id": "compute.subnetworks.expandIpCidrRange",
- "description": "Expands the IP CIDR range of the subnetwork to a specified value.",
- "request": {
- "$ref": "SubnetworksExpandIpCidrRangeRequest"
+ "type": "string",
+ "description": "The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified."
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "reservations": {
+ "description": "List of reservations in this commitment.",
+ "items": {
+ "$ref": "Reservation"
},
- "parameters": {
- "subnetwork": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the Subnetwork resource to update.",
- "type": "string",
- "location": "path",
- "required": true
- },
- "region": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request."
- },
- "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).",
- "type": "string",
- "location": "query"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string"
- }
+ "type": "array"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "endTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Commitment end time in RFC3339 text format."
+ },
+ "resources": {
+ "description": "A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.",
+ "type": "array",
+ "items": {
+ "$ref": "ResourceCommitment"
+ }
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "mergeSourceCommitments": {
+ "description": "List of source commitments to be merged into a new commitment.",
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange"
+ "type": "array"
},
- "list": {
- "flatPath": "projects/{project}/regions/{region}/subnetworks",
- "description": "Retrieves a list of subnetworks available to the specified project.",
- "id": "compute.subnetworks.list",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/regions/{region}/subnetworks",
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "maxResults": {
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "type": "integer",
- "format": "uint32",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- }
+ "splitSourceCommitment": {
+ "type": "string",
+ "description": "Source commitment to be splitted into a new commitment."
+ }
+ },
+ "id": "Commitment"
+ },
+ "RegionInstanceGroupManagersListInstancesResponse": {
+ "id": "RegionInstanceGroupManagersListInstancesResponse",
+ "type": "object",
+ "properties": {
+ "managedInstances": {
+ "items": {
+ "$ref": "ManagedInstance"
},
- "parameterOrder": [
- "project",
- "region"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "SubnetworkList"
- }
+ "description": "A list of managed instances.",
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
}
}
},
- "healthChecks": {
- "methods": {
- "aggregatedList": {
- "httpMethod": "GET",
- "response": {
- "$ref": "HealthChecksAggregatedList"
- },
- "id": "compute.healthChecks.aggregatedList",
- "parameters": {
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Name of the project scoping this request."
- },
- "includeAllScopes": {
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean"
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "format": "uint32",
- "minimum": "0",
- "default": "500",
- "location": "query"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- }
- },
- "path": "projects/{project}/aggregated/healthChecks",
- "flatPath": "projects/{project}/aggregated/healthChecks",
- "parameterOrder": [
- "project"
+ "FixedOrPercent": {
+ "type": "object",
+ "properties": {
+ "fixed": {
+ "description": "Specifies a fixed number of VM instances. This must be a positive integer.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "calculated": {
+ "type": "integer",
+ "description": "[Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. ",
+ "format": "int32"
+ },
+ "percent": {
+ "format": "int32",
+ "description": "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.",
+ "type": "integer"
+ }
+ },
+ "description": "Encapsulates numeric value that can be either absolute or relative.",
+ "id": "FixedOrPercent"
+ },
+ "SSLHealthCheck": {
+ "properties": {
+ "portName": {
+ "type": "string",
+ "description": "Not supported."
+ },
+ "request": {
+ "description": "Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection and SSL handshake.",
+ "type": "string"
+ },
+ "proxyHeader": {
+ "type": "string",
+ "enum": [
+ "NONE",
+ "PROXY_V1"
],
- "description": "Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
+ "enumDescriptions": [
+ "",
+ ""
]
},
- "get": {
- "response": {
- "$ref": "HealthCheck"
- },
- "id": "compute.healthChecks.get",
- "flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "response": {
+ "type": "string",
+ "description": "Creates a content-based SSL health check. In addition to establishing a TCP connection and the TLS handshake, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp"
+ },
+ "port": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535."
+ },
+ "portSpecification": {
+ "enumDescriptions": [
+ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
+ "Not supported.",
+ "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
],
- "parameters": {
- "healthCheck": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the HealthCheck resource to return.",
- "location": "path"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path"
+ "enum": [
+ "USE_FIXED_PORT",
+ "USE_NAMED_PORT",
+ "USE_SERVING_PORT"
+ ],
+ "type": "string",
+ "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports."
+ }
+ },
+ "id": "SSLHealthCheck",
+ "type": "object"
+ },
+ "ManagedInstanceLastAttempt": {
+ "id": "ManagedInstanceLastAttempt",
+ "properties": {
+ "errors": {
+ "type": "object",
+ "description": "[Output Only] Encountered errors during the last attempt to create or delete the instance.",
+ "properties": {
+ "errors": {
+ "type": "array",
+ "description": "[Output Only] The array of errors encountered while processing this operation.",
+ "items": {
+ "properties": {
+ "code": {
+ "description": "[Output Only] The error type identifier for this error.",
+ "type": "string"
+ },
+ "errorDetails": {
+ "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.",
+ "type": "array",
+ "items": {
+ "properties": {
+ "errorInfo": {
+ "$ref": "ErrorInfo"
+ },
+ "quotaInfo": {
+ "$ref": "QuotaExceededInfo"
+ },
+ "help": {
+ "$ref": "Help"
+ },
+ "localizedMessage": {
+ "$ref": "LocalizedMessage"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "message": {
+ "description": "[Output Only] An optional, human-readable error message.",
+ "type": "string"
+ },
+ "location": {
+ "type": "string",
+ "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional."
+ }
+ },
+ "type": "object"
+ }
}
+ }
+ }
+ },
+ "type": "object"
+ },
+ "GuestAttributesEntry": {
+ "properties": {
+ "namespace": {
+ "description": "Namespace for the guest attribute entry.",
+ "type": "string"
+ },
+ "key": {
+ "description": "Key for the guest attribute entry.",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "Value for the guest attribute entry."
+ }
+ },
+ "id": "GuestAttributesEntry",
+ "description": "A guest attributes namespace/key/value entry.",
+ "type": "object"
+ },
+ "HealthStatus": {
+ "type": "object",
+ "properties": {
+ "annotations": {
+ "additionalProperties": {
+ "type": "string"
},
- "httpMethod": "GET",
- "description": "Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.",
- "parameterOrder": [
- "project",
- "healthCheck"
+ "description": "Metadata defined as annotations for network endpoint.",
+ "type": "object"
+ },
+ "ipAddress": {
+ "type": "string",
+ "description": "For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip."
+ },
+ "instance": {
+ "type": "string",
+ "description": "URL of the instance resource."
+ },
+ "port": {
+ "description": "The named port of the instance group, not necessarily the port that is health-checked.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "forwardingRuleIp": {
+ "description": "A forwarding rule IP address assigned to this instance.",
+ "type": "string"
+ },
+ "healthState": {
+ "type": "string",
+ "description": "Health state of the instance.",
+ "enumDescriptions": [
+ "",
+ ""
],
- "path": "projects/{project}/global/healthChecks/{healthCheck}"
+ "enum": [
+ "HEALTHY",
+ "UNHEALTHY"
+ ]
},
- "patch": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "forwardingRule": {
+ "description": "URL of the forwarding rule associated with the health status of the instance.",
+ "type": "string"
+ },
+ "weight": {
+ "type": "string"
+ },
+ "weightError": {
+ "enumDescriptions": [
+ "The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation).",
+ "The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight.",
+ "This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN.",
+ "This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight."
],
- "path": "projects/{project}/global/healthChecks/{healthCheck}",
- "parameters": {
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
+ "type": "string",
+ "enum": [
+ "INVALID_WEIGHT",
+ "MISSING_WEIGHT",
+ "UNAVAILABLE_WEIGHT",
+ "WEIGHT_NONE"
+ ]
+ }
+ },
+ "id": "HealthStatus"
+ },
+ "DisksScopedList": {
+ "type": "object",
+ "id": "DisksScopedList",
+ "properties": {
+ "warning": {
+ "properties": {
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "healthCheck": {
- "description": "Name of the HealthCheck resource to patch.",
- "location": "path",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "requestId": {
+ "message": {
"type": "string",
- "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"
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "parameterOrder": [
- "project",
- "healthCheck"
- ],
- "description": "Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
- "response": {
- "$ref": "Operation"
+ "description": "[Output Only] Informational warning which replaces the list of disks when the list is empty.",
+ "type": "object"
+ },
+ "disks": {
+ "description": "[Output Only] A list of disks contained in this scope.",
+ "items": {
+ "$ref": "Disk"
},
- "httpMethod": "PATCH",
- "id": "compute.healthChecks.patch",
- "request": {
- "$ref": "HealthCheck"
+ "type": "array"
+ }
+ }
+ },
+ "Subnetwork": {
+ "type": "object",
+ "id": "Subnetwork",
+ "description": "Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network.",
+ "properties": {
+ "ipCidrRange": {
+ "description": "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.",
+ "type": "string"
+ },
+ "gatewayAddress": {
+ "type": "string",
+ "description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork."
+ },
+ "fingerprint": {
+ "format": "byte",
+ "type": "string",
+ "description": "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 Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork."
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "secondaryIpRanges": {
+ "type": "array",
+ "description": "An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.",
+ "items": {
+ "$ref": "SubnetworkSecondaryRange"
}
},
- "insert": {
- "flatPath": "projects/{project}/global/healthChecks",
- "httpMethod": "POST",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "ipv6AccessType": {
+ "type": "string",
+ "enumDescriptions": [
+ "VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.",
+ "VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network."
],
- "description": "Creates a HealthCheck resource in the specified project using the data included in the request.",
- "id": "compute.healthChecks.insert",
- "request": {
- "$ref": "HealthCheck"
- },
- "path": "projects/{project}/global/healthChecks",
- "parameterOrder": [
- "project"
+ "enum": [
+ "EXTERNAL",
+ "INTERNAL"
],
- "response": {
- "$ref": "Operation"
- }
+ "description": "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."
},
- "update": {
- "id": "compute.healthChecks.update",
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "healthCheck": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the HealthCheck resource to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "privateIpv6GoogleAccess": {
+ "type": "string",
+ "description": "This field is for internal use. This field can be both set at resource creation time and updated using patch.",
+ "enum": [
+ "DISABLE_GOOGLE_ACCESS",
+ "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
+ "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE"
],
- "flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
- "description": "Updates a HealthCheck resource in the specified project using the data included in the request.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "project",
- "healthCheck"
+ "enumDescriptions": [
+ "Disable private IPv6 access to/from Google services.",
+ "Bidirectional private IPv6 access to/from Google services.",
+ "Outbound private IPv6 access from VMs in this subnet to Google services."
+ ]
+ },
+ "role": {
+ "description": "The role of subnetwork. Currently, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.",
+ "enumDescriptions": [
+ "The ACTIVE subnet that is currently used.",
+ "The BACKUP subnet that could be promoted to ACTIVE."
],
- "path": "projects/{project}/global/healthChecks/{healthCheck}",
- "request": {
- "$ref": "HealthCheck"
- }
+ "enum": [
+ "ACTIVE",
+ "BACKUP"
+ ],
+ "type": "string"
},
- "list": {
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "maxResults": {
- "minimum": "0",
- "location": "query",
- "format": "uint32",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer"
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "projects/{project}/global/healthChecks",
- "httpMethod": "GET",
- "flatPath": "projects/{project}/global/healthChecks",
- "response": {
- "$ref": "HealthCheckList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "region": {
+ "type": "string",
+ "description": "URL of the region where the Subnetwork resides. This field can be set only at resource creation time."
+ },
+ "privateIpGoogleAccess": {
+ "description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess.",
+ "type": "boolean"
+ },
+ "state": {
+ "enum": [
+ "DRAINING",
+ "READY"
],
- "id": "compute.healthChecks.list",
- "parameterOrder": [
- "project"
+ "description": "[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY",
+ "type": "string",
+ "enumDescriptions": [
+ "Subnetwork is being drained.",
+ "Subnetwork is ready for use."
+ ]
+ },
+ "enableFlowLogs": {
+ "description": "Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.",
+ "type": "boolean"
+ },
+ "externalIpv6Prefix": {
+ "type": "string",
+ "description": "The external IPv6 address range that is owned by this subnetwork."
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#subnetwork",
+ "description": "[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources."
+ },
+ "network": {
+ "type": "string",
+ "description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time."
+ },
+ "logConfig": {
+ "$ref": "SubnetworkLogConfig",
+ "description": "This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "stackType": {
+ "type": "string",
+ "description": "The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.",
+ "enumDescriptions": [
+ "New VMs in this subnet can have both IPv4 and IPv6 addresses.",
+ "New VMs in this subnet will only be assigned IPv4 addresses."
],
- "description": "Retrieves the list of HealthCheck resources available to the specified project."
+ "enum": [
+ "IPV4_IPV6",
+ "IPV4_ONLY"
+ ]
},
- "delete": {
- "id": "compute.healthChecks.delete",
- "parameters": {
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path"
- },
- "healthCheck": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the HealthCheck resource to delete.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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).",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "purpose": {
+ "description": "The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.",
+ "type": "string",
+ "enum": [
+ "INTERNAL_HTTPS_LOAD_BALANCER",
+ "PRIVATE",
+ "PRIVATE_RFC_1918",
+ "PRIVATE_SERVICE_CONNECT",
+ "REGIONAL_MANAGED_PROXY"
],
- "response": {
- "$ref": "Operation"
- },
- "description": "Deletes the specified HealthCheck resource.",
- "flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
- "httpMethod": "DELETE",
- "path": "projects/{project}/global/healthChecks/{healthCheck}",
- "parameterOrder": [
- "project",
- "healthCheck"
+ "enumDescriptions": [
+ "Subnet reserved for Internal HTTP(S) Load Balancing.",
+ "Regular user created or automatically created subnet.",
+ "Regular user created or automatically created subnet.",
+ "Subnetworks created for Private Service Connect in the producer network.",
+ "Subnetwork used for Regional Internal/External HTTP(S) Load Balancing."
]
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.",
+ "type": "string"
+ },
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "The name of the resource, provided by the client when initially creating the resource. 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."
+ },
+ "internalIpv6Prefix": {
+ "description": "[Output Only] The internal IPv6 address range that is assigned to this subnetwork.",
+ "type": "string"
+ },
+ "ipv6CidrRange": {
+ "type": "string",
+ "description": "[Output Only] This field is for internal use."
}
}
},
- "resourcePolicies": {
- "methods": {
- "list": {
- "description": "A list all the resource policies that have been configured for the specified project in specified region.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "region": {
- "description": "Name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "maxResults": {
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "default": "500",
- "minimum": "0",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- }
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "ResourcePolicyList"
+ "NetworkEndpointGroupAggregatedList": {
+ "id": "NetworkEndpointGroupAggregatedList",
+ "properties": {
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/regions/{region}/resourcePolicies",
- "path": "projects/{project}/regions/{region}/resourcePolicies",
- "id": "compute.resourcePolicies.list"
+ "type": "array",
+ "description": "[Output Only] Unreachable resources."
},
- "getIamPolicy": {
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "id": "compute.resourcePolicies.getIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "Policy"
- },
- "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy",
- "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy",
- "httpMethod": "GET",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "parameters": {
- "project": {
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "region": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "The name of the region for this request."
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "warning": {
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "resource": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "required": true
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "optionsRequestedPolicyVersion": {
- "type": "integer",
- "location": "query",
- "description": "Requested IAM Policy version.",
- "format": "int32"
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "type": "string"
}
- }
- },
- "testIamPermissions": {
- "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions",
- "request": {
- "$ref": "TestPermissionsRequest"
},
- "parameters": {
- "resource": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path",
- "description": "Name or id of the resource for this request."
- },
- "region": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the region for this request."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path"
- }
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "items": {
+ "additionalProperties": {
+ "description": "The name of the scope that contains this set of network endpoint groups.",
+ "$ref": "NetworkEndpointGroupsScopedList"
},
- "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions",
- "response": {
- "$ref": "TestPermissionsResponse"
+ "type": "object",
+ "description": "A list of NetworkEndpointGroupsScopedList resources."
+ },
+ "kind": {
+ "default": "compute#networkEndpointGroupAggregatedList",
+ "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "type": "object"
+ },
+ "HttpRouteAction": {
+ "id": "HttpRouteAction",
+ "type": "object",
+ "properties": {
+ "urlRewrite": {
+ "description": "The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.",
+ "$ref": "UrlRewrite"
+ },
+ "faultInjectionPolicy": {
+ "description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout and retry_policy is ignored by clients that are configured with a fault_injection_policy if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection. Fault injection is not supported with the global external HTTP(S) load balancer (classic). To see which load balancers support fault injection, see Load balancing: Routing and traffic management features.",
+ "$ref": "HttpFaultInjection"
+ },
+ "weightedBackendServices": {
+ "description": "A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number. After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.",
+ "items": {
+ "$ref": "WeightedBackendService"
},
- "description": "Returns permissions that a caller has on the specified resource.",
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "type": "array"
+ },
+ "requestMirrorPolicy": {
+ "$ref": "RequestMirrorPolicy",
+ "description": "Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true."
+ },
+ "corsPolicy": {
+ "$ref": "CorsPolicy",
+ "description": "The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy."
+ },
+ "maxStreamDuration": {
+ "description": "Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (known as *end-of-stream*), the duration in this field is computed from the beginning of the stream until the response has been processed, including all retries. A stream that does not complete in this duration is closed. If not specified, this field uses the maximum maxStreamDuration value among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.",
+ "$ref": "Duration"
+ },
+ "timeout": {
+ "description": "Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as *end-of-stream*) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.",
+ "$ref": "Duration"
+ },
+ "retryPolicy": {
+ "$ref": "HttpRetryPolicy",
+ "description": "Specifies the retry policy associated with this route."
+ }
+ }
+ },
+ "SavedDisk": {
+ "type": "object",
+ "id": "SavedDisk",
+ "properties": {
+ "kind": {
+ "default": "compute#savedDisk",
+ "description": "[Output Only] Type of the resource. Always compute#savedDisk for attached disks.",
+ "type": "string"
+ },
+ "storageBytes": {
+ "description": "[Output Only] Size of the individual disk snapshot used by this machine image.",
+ "type": "string",
+ "format": "int64"
+ },
+ "sourceDisk": {
+ "type": "string",
+ "description": "Specifies a URL of the disk attached to the source instance."
+ },
+ "architecture": {
+ "enumDescriptions": [
+ "Default value indicating Architecture is not set.",
+ "Machines with architecture ARM64",
+ "Machines with architecture X86_64"
],
- "httpMethod": "POST",
- "id": "compute.resourcePolicies.testIamPermissions",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "description": "[Output Only] The architecture of the attached disk.",
+ "enum": [
+ "ARCHITECTURE_UNSPECIFIED",
+ "ARM64",
+ "X86_64"
+ ],
+ "type": "string"
},
- "insert": {
- "parameterOrder": [
- "project",
- "region"
+ "storageBytesStatus": {
+ "type": "string",
+ "enum": [
+ "UPDATING",
+ "UP_TO_DATE"
],
- "response": {
- "$ref": "Operation"
- },
- "description": "Creates a new resource policy.",
- "httpMethod": "POST",
- "flatPath": "projects/{project}/regions/{region}/resourcePolicies",
- "request": {
- "$ref": "ResourcePolicy"
- },
- "path": "projects/{project}/regions/{region}/resourcePolicies",
- "id": "compute.resourcePolicies.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "",
+ ""
],
- "parameters": {
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "region": {
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request.",
- "location": "path"
- }
- }
+ "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date."
+ }
+ },
+ "description": "An instance-attached disk resource."
+ },
+ "NodeGroup": {
+ "properties": {
+ "kind": {
+ "default": "compute#nodeGroup",
+ "type": "string",
+ "description": "[Output Only] The type of the resource. Always compute#nodeGroup for node group."
},
- "delete": {
- "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
- "description": "Deletes the specified resource policy.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "zone": {
+ "type": "string",
+ "description": "[Output Only] The name of the zone where the node group resides, such as us-central1-a."
+ },
+ "fingerprint": {
+ "type": "string",
+ "format": "byte"
+ },
+ "locationHint": {
+ "description": "An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.",
+ "type": "string"
+ },
+ "autoscalingPolicy": {
+ "description": "Specifies how autoscaling should behave.",
+ "$ref": "NodeGroupAutoscalingPolicy"
+ },
+ "size": {
+ "description": "[Output Only] The total number of nodes in the node group.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the resource, provided by the client when initially creating the resource. The resource 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."
+ },
+ "maintenancePolicy": {
+ "description": "Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.",
+ "enum": [
+ "DEFAULT",
+ "MAINTENANCE_POLICY_UNSPECIFIED",
+ "MIGRATE_WITHIN_NODE_GROUP",
+ "RESTART_IN_PLACE"
],
- "parameterOrder": [
- "project",
- "region",
- "resourcePolicy"
+ "enumDescriptions": [
+ "Allow the node and corresponding instances to retain default maintenance behavior.",
+ "",
+ "When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.",
+ "Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true."
],
- "id": "compute.resourcePolicies.delete",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "resourcePolicy": {
- "description": "Name of the resource policy to delete.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path"
- },
- "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).",
- "location": "query",
- "type": "string"
- }
- },
- "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}"
+ "type": "string"
},
- "setIamPolicy": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "shareSettings": {
+ "$ref": "ShareSettings",
+ "description": "Share-settings for the node group"
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "nodeTemplate": {
+ "description": "URL of the node template to create the node group from.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "maintenanceWindow": {
+ "$ref": "NodeGroupMaintenanceWindow"
+ },
+ "status": {
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
],
- "id": "compute.resourcePolicies.setIamPolicy",
- "response": {
- "$ref": "Policy"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "request": {
- "$ref": "RegionSetPolicyRequest"
- },
- "parameters": {
- "region": {
- "description": "The name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "resource": {
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- },
- "project": {
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request."
- }
- },
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "enum": [
+ "CREATING",
+ "DELETING",
+ "INVALID",
+ "READY"
],
- "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy",
- "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy",
- "httpMethod": "POST"
+ "type": "string"
+ }
+ },
+ "description": "Represents a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.",
+ "type": "object",
+ "id": "NodeGroup"
+ },
+ "ResourcePolicyHourlyCycle": {
+ "id": "ResourcePolicyHourlyCycle",
+ "description": "Time window specified for hourly operations.",
+ "properties": {
+ "hoursInCycle": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle."
},
- "aggregatedList": {
- "flatPath": "projects/{project}/aggregated/resourcePolicies",
- "description": "Retrieves an aggregated list of resource policies.",
- "path": "projects/{project}/aggregated/resourcePolicies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "startTime": {
+ "description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.",
+ "type": "string"
+ },
+ "duration": {
+ "type": "string",
+ "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario."
+ }
+ },
+ "type": "object"
+ },
+ "InstancesSetMachineTypeRequest": {
+ "type": "object",
+ "id": "InstancesSetMachineTypeRequest",
+ "properties": {
+ "machineType": {
+ "description": "Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1",
+ "type": "string"
+ }
+ }
+ },
+ "TargetHttpsProxy": {
+ "id": "TargetHttpsProxy",
+ "properties": {
+ "authorizationPolicy": {
+ "type": "string",
+ "description": "Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact."
+ },
+ "region": {
+ "description": "[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "fingerprint": {
+ "type": "string",
+ "format": "byte",
+ "description": "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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy."
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#targetHttpsProxy",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies."
+ },
+ "sslCertificates": {
+ "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "quicOverride": {
+ "enumDescriptions": [
+ "The load balancer will not attempt to negotiate QUIC with clients.",
+ "The load balancer will attempt to negotiate QUIC with clients.",
+ "No overrides to the default QUIC policy. This option is implicit if no QUIC override has been specified in the request."
],
- "parameters": {
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query",
- "type": "boolean"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "maxResults": {
- "minimum": "0",
- "default": "500",
- "type": "integer",
- "location": "query",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- }
- },
- "httpMethod": "GET",
- "id": "compute.resourcePolicies.aggregatedList",
- "response": {
- "$ref": "ResourcePolicyAggregatedList"
- },
- "parameterOrder": [
- "project"
+ "description": "Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. ",
+ "type": "string",
+ "enum": [
+ "DISABLE",
+ "ENABLE",
+ "NONE"
]
},
- "get": {
- "parameterOrder": [
- "project",
- "region",
- "resourcePolicy"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "urlMap": {
+ "type": "string",
+ "description": "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 "
+ },
+ "proxyBind": {
+ "type": "boolean",
+ "description": "This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false."
+ },
+ "serverTlsPolicy": {
+ "type": "string",
+ "description": "Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact."
+ },
+ "name": {
+ "description": "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.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "sslPolicy": {
+ "description": "URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "certificateMap": {
+ "type": "string",
+ "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored."
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ }
+ },
+ "description": "Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.",
+ "type": "object"
+ },
+ "RouteAsPath": {
+ "id": "RouteAsPath",
+ "type": "object",
+ "properties": {
+ "pathSegmentType": {
+ "description": "[Output Only] The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed ",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
],
- "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
- "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
- "parameters": {
- "resourcePolicy": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name of the resource policy to retrieve.",
- "type": "string"
- },
- "region": {
- "type": "string",
- "required": true,
- "description": "Name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- },
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "response": {
- "$ref": "ResourcePolicy"
+ "type": "string",
+ "enum": [
+ "AS_CONFED_SEQUENCE",
+ "AS_CONFED_SET",
+ "AS_SEQUENCE",
+ "AS_SET"
+ ]
+ },
+ "asLists": {
+ "items": {
+ "format": "uint32",
+ "type": "integer"
},
- "description": "Retrieves all information of the specified resource policy.",
- "id": "compute.resourcePolicies.get",
- "httpMethod": "GET"
+ "description": "[Output Only] The AS numbers of the AS Path.",
+ "type": "array"
}
}
},
- "instanceTemplates": {
- "methods": {
- "testIamPermissions": {
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "flatPath": "projects/{project}/global/instanceTemplates/{resource}/testIamPermissions",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "POST",
- "description": "Returns permissions that a caller has on the specified resource.",
- "parameterOrder": [
- "project",
- "resource"
- ],
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "parameters": {
- "resource": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name or id of the resource for this request.",
- "location": "path"
- },
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "id": "compute.instanceTemplates.testIamPermissions",
- "path": "projects/{project}/global/instanceTemplates/{resource}/testIamPermissions"
+ "SnapshotList": {
+ "type": "object",
+ "id": "SnapshotList",
+ "properties": {
+ "items": {
+ "description": "A list of Snapshot resources.",
+ "type": "array",
+ "items": {
+ "$ref": "Snapshot"
+ }
},
- "insert": {
- "description": "Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.",
- "id": "compute.instanceTemplates.insert",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/global/instanceTemplates",
- "parameterOrder": [
- "project"
- ],
- "path": "projects/{project}/global/instanceTemplates",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
+ "kind": {
+ "default": "compute#snapshotList",
+ "type": "string",
+ "description": "Type of resource."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "message": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "requestId": {
+ "code": {
"type": "string",
- "location": "query",
- "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)."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ },
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ }
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "InstanceTemplate"
+ "description": "[Output Only] Informational warning message."
+ }
+ },
+ "description": "Contains a list of Snapshot resources."
+ },
+ "TargetSslProxiesSetSslCertificatesRequest": {
+ "type": "object",
+ "properties": {
+ "sslCertificates": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "httpMethod": "POST"
+ "description": "New set of URLs to SslCertificate resources to associate with this TargetSslProxy. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates."
+ }
+ },
+ "id": "TargetSslProxiesSetSslCertificatesRequest"
+ },
+ "HttpHealthCheck": {
+ "description": "Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "default": "compute#httpHealthCheck",
+ "description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks."
},
- "setIamPolicy": {
- "parameterOrder": [
- "project",
- "resource"
- ],
- "request": {
- "$ref": "GlobalSetPolicyRequest"
- },
- "parameters": {
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name or id of the resource for this request.",
- "type": "string",
- "required": true
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "requestPath": {
+ "description": "The request path of the HTTP health check request. The default value is /. This field does not support query parameters.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "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."
+ },
+ "unhealthyThreshold": {
+ "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "timeoutSec": {
+ "type": "integer",
+ "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.",
+ "format": "int32"
+ },
+ "checkIntervalSec": {
+ "description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "healthyThreshold": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2."
+ },
+ "host": {
+ "description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "port": {
+ "description": "The TCP port number for the HTTP health check request. The default value is 80.",
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "id": "HttpHealthCheck"
+ },
+ "AutoscalingPolicyCustomMetricUtilization": {
+ "description": "Custom utilization metric policy.",
+ "id": "AutoscalingPolicyCustomMetricUtilization",
+ "properties": {
+ "singleInstanceAssignment": {
+ "type": "number",
+ "format": "double",
+ "description": "If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler keeps the number of instances proportional to the value of this metric. The metric itself does not change value due to group resizing. A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead."
+ },
+ "metric": {
+ "type": "string",
+ "description": "The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE."
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. For the filter to be valid for autoscaling purposes, the following rules apply: - You can only use the AND operator for joining selectors. - You can only use direct equality comparison operator (=) without any functions for each selector. - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a *per-group metric* for the purpose of autoscaling. If not specified, the type defaults to gce_instance. Try to provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value."
+ },
+ "utilizationTarget": {
+ "description": "The target value of the metric that autoscaler maintains. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilization_target is https://www.googleapis.com/compute/v1/instance/network/received_bytes_count. The autoscaler works to keep this value constant for each of the instances.",
+ "type": "number",
+ "format": "double"
+ },
+ "utilizationTargetType": {
+ "enumDescriptions": [
+ "Sets the utilization target value for a cumulative or delta metric, expressed as the rate of growth per minute.",
+ "Sets the utilization target value for a cumulative or delta metric, expressed as the rate of growth per second.",
+ "Sets the utilization target value for a gauge metric. The autoscaler will collect the average utilization of the virtual machines from the last couple of minutes, and compare the value to the utilization target value to perform autoscaling."
],
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "flatPath": "projects/{project}/global/instanceTemplates/{resource}/setIamPolicy",
- "id": "compute.instanceTemplates.setIamPolicy",
- "path": "projects/{project}/global/instanceTemplates/{resource}/setIamPolicy",
- "httpMethod": "POST",
- "response": {
- "$ref": "Policy"
+ "type": "string",
+ "description": "Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.",
+ "enum": [
+ "DELTA_PER_MINUTE",
+ "DELTA_PER_SECOND",
+ "GAUGE"
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "HostRule": {
+ "type": "object",
+ "description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.",
+ "properties": {
+ "hosts": {
+ "description": "The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character, and if followed by anything, the immediate following character must be either - or .. * based matching is not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
},
- "list": {
- "flatPath": "projects/{project}/global/instanceTemplates",
- "httpMethod": "GET",
- "path": "projects/{project}/global/instanceTemplates",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "type": "integer",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "location": "query",
- "format": "uint32"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- }
- },
- "description": "Retrieves a list of instance templates that are contained within the specified project.",
- "id": "compute.instanceTemplates.list",
- "response": {
- "$ref": "InstanceTemplateList"
- },
- "parameterOrder": [
- "project"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "pathMatcher": {
+ "description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.",
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ }
+ },
+ "id": "HostRule"
+ },
+ "HttpsHealthCheck": {
+ "description": "Represents a legacy HTTPS Health Check resource. Legacy HTTPS health checks have been deprecated. If you are using a target pool-based network load balancer, you must use a legacy HTTP (not HTTPS) health check. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .",
+ "type": "object",
+ "properties": {
+ "timeoutSec": {
+ "type": "integer",
+ "format": "int32",
+ "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec."
+ },
+ "unhealthyThreshold": {
+ "format": "int32",
+ "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
+ "type": "integer"
+ },
+ "host": {
+ "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.",
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "healthyThreshold": {
+ "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "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.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#httpsHealthCheck",
+ "description": "Type of the resource."
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "requestPath": {
+ "description": "The request path of the HTTPS health check request. The default value is \"/\".",
+ "type": "string"
+ },
+ "checkIntervalSec": {
+ "description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "port": {
+ "description": "The TCP port number for the HTTPS health check request. The default value is 443.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ }
+ },
+ "id": "HttpsHealthCheck"
+ },
+ "TargetTcpProxiesSetBackendServiceRequest": {
+ "id": "TargetTcpProxiesSetBackendServiceRequest",
+ "properties": {
+ "service": {
+ "description": "The URL of the new BackendService resource for the targetTcpProxy.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "HealthCheck": {
+ "type": "object",
+ "description": "Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/v1/healthChecks) * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Traffic Director must use global health checks (`compute.v1.HealthChecks`). Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.HealthChecks`). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.HealthChecks`). Backend service-based network load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Target pool-based network load balancers must use legacy HTTP health checks (`compute.v1.httpHealthChecks`). For more information, see Health checks overview.",
+ "id": "HealthCheck",
+ "properties": {
+ "timeoutSec": {
+ "type": "integer",
+ "format": "int32",
+ "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec."
+ },
+ "logConfig": {
+ "$ref": "HealthCheckLogConfig",
+ "description": "Configure logging on this health check."
+ },
+ "healthyThreshold": {
+ "type": "integer",
+ "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
+ "format": "int32"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in 3339 text format.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Type of the resource.",
+ "default": "compute#healthCheck",
+ "type": "string"
+ },
+ "http2HealthCheck": {
+ "$ref": "HTTP2HealthCheck"
},
- "delete": {
- "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "instanceTemplate": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string",
- "description": "The name of the instance template to delete.",
- "required": true
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "projects/{project}/global/instanceTemplates/{instanceTemplate}",
- "description": "Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.",
- "id": "compute.instanceTemplates.delete",
- "parameterOrder": [
- "project",
- "instanceTemplate"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
},
- "get": {
- "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}",
- "description": "Returns the specified instance template. Gets a list of available instance templates by making a list() request.",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "httpHealthCheck": {
+ "$ref": "HTTPHealthCheck"
+ },
+ "unhealthyThreshold": {
+ "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] Region where the health check resides. Not applicable to global health checks."
+ },
+ "tcpHealthCheck": {
+ "$ref": "TCPHealthCheck"
+ },
+ "grpcHealthCheck": {
+ "$ref": "GRPCHealthCheck"
+ },
+ "type": {
+ "description": "Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "flatPath": "projects/{project}/global/instanceTemplates/{instanceTemplate}",
- "id": "compute.instanceTemplates.get",
- "response": {
- "$ref": "InstanceTemplate"
- },
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "instanceTemplate": {
- "required": true,
- "description": "The name of the instance template.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "instanceTemplate"
+ "type": "string",
+ "enum": [
+ "GRPC",
+ "HTTP",
+ "HTTP2",
+ "HTTPS",
+ "INVALID",
+ "SSL",
+ "TCP"
]
},
- "getIamPolicy": {
- "httpMethod": "GET",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path"
- },
- "optionsRequestedPolicyVersion": {
- "format": "int32",
- "description": "Requested IAM Policy version.",
- "type": "integer",
- "location": "query"
- },
- "resource": {
- "description": "Name or id of the resource for this request.",
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "id": "compute.instanceTemplates.getIamPolicy",
- "path": "projects/{project}/global/instanceTemplates/{resource}/getIamPolicy",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "project",
- "resource"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/global/instanceTemplates/{resource}/getIamPolicy"
+ "name": {
+ "description": "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. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "checkIntervalSec": {
+ "format": "int32",
+ "type": "integer",
+ "description": "How often (in seconds) to send a health check. The default value is 5 seconds."
+ },
+ "httpsHealthCheck": {
+ "$ref": "HTTPSHealthCheck"
+ },
+ "sslHealthCheck": {
+ "$ref": "SSLHealthCheck"
}
}
},
- "externalVpnGateways": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ExternalVpnGateway"
- },
- "description": "Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.",
- "parameters": {
- "externalVpnGateway": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the externalVpnGateway to return.",
- "required": true,
- "location": "path"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
- }
- },
- "path": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.externalVpnGateways.get",
- "parameterOrder": [
- "project",
- "externalVpnGateway"
- ],
- "flatPath": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}"
+ "InterconnectLocationRegionInfo": {
+ "id": "InterconnectLocationRegionInfo",
+ "properties": {
+ "expectedRttMs": {
+ "format": "int64",
+ "type": "string",
+ "description": "Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region."
},
- "setLabels": {
- "parameterOrder": [
- "project",
- "resource"
+ "region": {
+ "type": "string",
+ "description": "URL for the region of this location."
+ },
+ "locationPresence": {
+ "enumDescriptions": [
+ "This region is not in any common network presence with this InterconnectLocation.",
+ "This region shares the same regional network presence as this InterconnectLocation.",
+ "[Deprecated] This region is not in any common network presence with this InterconnectLocation.",
+ "[Deprecated] This region shares the same regional network presence as this InterconnectLocation."
],
- "flatPath": "projects/{project}/global/externalVpnGateways/{resource}/setLabels",
- "path": "projects/{project}/global/externalVpnGateways/{resource}/setLabels",
- "request": {
- "$ref": "GlobalSetLabelsRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "Identifies the network presence of this location.",
+ "enum": [
+ "GLOBAL",
+ "LOCAL_REGION",
+ "LP_GLOBAL",
+ "LP_LOCAL_REGION"
],
- "response": {
- "$ref": "Operation"
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "description": "Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region."
+ },
+ "DiskType": {
+ "description": "Represents a Disk Type resource. Google Compute Engine has two Disk Type resources: * [Regional](/compute/docs/reference/rest/v1/regionDiskTypes) * [Zonal](/compute/docs/reference/rest/v1/diskTypes) You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks.",
+ "properties": {
+ "description": {
+ "description": "[Output Only] An optional description of this resource.",
+ "type": "string"
+ },
+ "validDiskSize": {
+ "description": "[Output Only] An optional textual description of the valid disk size, such as \"10GB-10TB\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "[Output Only] Name of the resource.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "deprecated": {
+ "description": "[Output Only] The deprecation status associated with this disk type.",
+ "$ref": "DeprecationStatus"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#diskType",
+ "description": "[Output Only] Type of the resource. Always compute#diskType for disk types."
+ },
+ "region": {
+ "description": "[Output Only] URL of the region where the disk type resides. Only applicable for regional resources. 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"
+ },
+ "defaultDiskSizeGb": {
+ "type": "string",
+ "description": "[Output Only] Server-defined default disk size in GB.",
+ "format": "int64"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "zone": {
+ "type": "string",
+ "description": "[Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ }
+ },
+ "id": "DiskType",
+ "type": "object"
+ },
+ "RegionInstanceGroupManagersRecreateRequest": {
+ "id": "RegionInstanceGroupManagersRecreateRequest",
+ "type": "object",
+ "properties": {
+ "instances": {
+ "type": "array",
+ "description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "VpnGatewayAggregatedList": {
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "description": "Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.",
- "parameters": {
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "resource": {
- "location": "path",
- "description": "Name or id of the resource for this request.",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true
- }
+ "type": "array",
+ "description": "[Output Only] Unreachable resources."
+ },
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "[Output Only] Name of the scope containing this set of VPN gateways.",
+ "$ref": "VpnGatewaysScopedList"
},
- "id": "compute.externalVpnGateways.setLabels",
- "httpMethod": "POST"
+ "description": "A list of VpnGateway resources."
},
- "list": {
- "parameterOrder": [
- "project"
- ],
- "id": "compute.externalVpnGateways.list",
- "parameters": {
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "filter": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.",
+ "type": "string",
+ "default": "compute#vpnGatewayAggregatedList"
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "message": {
"type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "project": {
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "type": "string"
},
- "maxResults": {
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query"
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
}
},
- "httpMethod": "GET",
- "description": "Retrieves the list of ExternalVpnGateway available to the specified project.",
- "response": {
- "$ref": "ExternalVpnGatewayList"
- },
- "flatPath": "projects/{project}/global/externalVpnGateways",
- "path": "projects/{project}/global/externalVpnGateways",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "description": "[Output Only] Informational warning message."
},
- "testIamPermissions": {
- "id": "compute.externalVpnGateways.testIamPermissions",
- "flatPath": "projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions",
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "resource"
- ],
- "parameters": {
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ },
+ "id": "VpnGatewayAggregatedList"
+ },
+ "RegionAutoscalerList": {
+ "id": "RegionAutoscalerList",
+ "description": "Contains a list of autoscalers.",
+ "properties": {
+ "warning": {
+ "properties": {
+ "code": {
"type": "string",
- "description": "Name or id of the resource for this request.",
- "location": "path"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "project": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "message": {
"type": "string",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "request": {
- "$ref": "TestPermissionsRequest"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "items": {
+ "$ref": "Autoscaler"
},
- "response": {
- "$ref": "TestPermissionsResponse"
+ "type": "array",
+ "description": "A list of Autoscaler resources."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#regionAutoscalerList",
+ "type": "string",
+ "description": "Type of resource."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TargetPoolsRemoveHealthCheckRequest": {
+ "id": "TargetPoolsRemoveHealthCheckRequest",
+ "properties": {
+ "healthChecks": {
+ "type": "array",
+ "description": "Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project /global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check ",
+ "items": {
+ "$ref": "HealthCheckReference"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "Firewall": {
+ "properties": {
+ "sourceRanges": {
+ "description": "If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "sourceServiceAccounts": {
+ "description": "If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.",
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "array"
+ },
+ "direction": {
+ "description": "Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot specify the sourceTags fields.",
+ "type": "string",
+ "enumDescriptions": [
+ "Indicates that firewall should apply to outgoing traffic.",
+ "Indicates that firewall should apply to incoming traffic."
],
- "path": "projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource."
+ "enum": [
+ "EGRESS",
+ "INGRESS"
+ ]
},
- "delete": {
- "id": "compute.externalVpnGateways.delete",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}",
- "description": "Deletes the specified externalVpnGateway.",
- "parameters": {
- "externalVpnGateway": {
- "location": "path",
- "required": true,
- "description": "Name of the externalVpnGateways to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "project": {
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
+ "disabled": {
+ "description": "Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.",
+ "type": "boolean"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "denied": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "IPProtocol": {
+ "description": "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.",
+ "type": "string"
+ },
+ "ports": {
+ "description": "An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
}
},
- "flatPath": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}",
- "parameterOrder": [
- "project",
- "externalVpnGateway"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "DELETE"
+ "description": "The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection."
},
- "insert": {
- "flatPath": "projects/{project}/global/externalVpnGateways",
- "id": "compute.externalVpnGateways.insert",
- "request": {
- "$ref": "ExternalVpnGateway"
- },
- "parameterOrder": [
- "project"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Creates a ExternalVpnGateway in the specified project using the data included in the request.",
- "httpMethod": "POST",
- "path": "projects/{project}/global/externalVpnGateways",
- "parameters": {
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "type": "string"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
+ "network": {
+ "description": "URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, 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/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default ",
+ "type": "string"
+ },
+ "allowed": {
+ "type": "array",
+ "description": "The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "IPProtocol": {
+ "type": "string",
+ "description": "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."
+ },
+ "ports": {
+ "items": {
+ "type": "string"
+ },
+ "description": "An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].",
+ "type": "array"
+ }
}
- },
- "response": {
- "$ref": "Operation"
}
- }
- }
- },
- "diskTypes": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "flatPath": "projects/{project}/zones/{zone}/diskTypes/{diskType}",
- "description": "Returns the specified disk type. Gets a list of available disk types by making a list() request.",
- "response": {
- "$ref": "DiskType"
+ },
+ "priority": {
+ "description": "Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this field when you create the resource."
+ },
+ "name": {
+ "description": "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.",
+ "annotations": {
+ "required": [
+ "compute.firewalls.insert",
+ "compute.firewalls.patch"
+ ]
},
- "parameters": {
- "zone": {
- "required": true,
- "location": "path",
- "description": "The name of the zone for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "diskType": {
- "location": "path",
- "description": "Name of the disk type to return.",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string"
- }
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "logConfig": {
+ "$ref": "FirewallLogConfig",
+ "description": "This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging."
+ },
+ "targetTags": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "zone",
- "diskType"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/zones/{zone}/diskTypes/{diskType}",
- "id": "compute.diskTypes.get"
+ "description": "A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network."
},
- "aggregatedList": {
- "parameterOrder": [
- "project"
- ],
- "parameters": {
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "maxResults": {
- "default": "500",
- "type": "integer",
- "location": "query",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32"
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
- },
- "includeAllScopes": {
- "type": "boolean",
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
- }
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#firewall for firewall rules.",
+ "default": "compute#firewall"
+ },
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "sourceTags": {
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/aggregated/diskTypes",
- "response": {
- "$ref": "DiskTypeAggregatedList"
+ "type": "array",
+ "description": "If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply."
+ },
+ "targetServiceAccounts": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/aggregated/diskTypes",
- "description": "Retrieves an aggregated list of disk types.",
- "httpMethod": "GET",
- "id": "compute.diskTypes.aggregatedList",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "description": "A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network."
+ },
+ "destinationRanges": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported."
+ }
+ },
+ "type": "object",
+ "description": "Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.",
+ "id": "Firewall"
+ },
+ "InterconnectCircuitInfo": {
+ "type": "object",
+ "properties": {
+ "customerDemarcId": {
+ "type": "string",
+ "description": "Customer-side demarc ID for this circuit."
+ },
+ "googleCircuitId": {
+ "type": "string",
+ "description": "Google-assigned unique ID for this circuit. Assigned at circuit turn-up."
+ },
+ "googleDemarcId": {
+ "description": "Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.",
+ "type": "string"
+ }
+ },
+ "id": "InterconnectCircuitInfo",
+ "description": "Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only."
+ },
+ "DiskList": {
+ "description": "A list of Disk resources.",
+ "id": "DiskList",
+ "properties": {
+ "items": {
+ "items": {
+ "$ref": "Disk"
+ },
+ "type": "array",
+ "description": "A list of Disk resources."
},
- "list": {
- "path": "projects/{project}/zones/{zone}/diskTypes",
- "parameterOrder": [
- "project",
- "zone"
- ],
- "id": "compute.diskTypes.list",
- "parameters": {
- "zone": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "description": "The name of the zone for this request."
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "maxResults": {
- "type": "integer",
- "location": "query",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "default": "500"
+ "warning": {
+ "properties": {
+ "data": {
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "orderBy": {
+ "code": {
"type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- },
- "project": {
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "flatPath": "projects/{project}/zones/{zone}/diskTypes",
- "response": {
- "$ref": "DiskTypeList"
- },
- "description": "Retrieves a list of disk types available to the specified project."
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#diskList",
+ "description": "[Output Only] Type of resource. Always compute#diskList for lists of disks.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ }
+ },
+ "type": "object"
+ },
+ "AutoscalingPolicyLoadBalancingUtilization": {
+ "id": "AutoscalingPolicyLoadBalancingUtilization",
+ "properties": {
+ "utilizationTarget": {
+ "description": "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that the autoscaler maintains. Must be a positive float value. If not defined, the default is 0.8.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "description": "Configuration parameters of autoscaling based on load balancing.",
+ "type": "object"
+ },
+ "InstanceGroupManagerStatusVersionTarget": {
+ "id": "InstanceGroupManagerStatusVersionTarget",
+ "type": "object",
+ "properties": {
+ "isReached": {
+ "type": "boolean",
+ "description": "[Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager."
}
}
},
- "zoneOperations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Operation"
+ "Disk": {
+ "properties": {
+ "physicalBlockSizeBytes": {
+ "description": "Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.",
+ "type": "string",
+ "format": "int64"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined fully-qualified URL for this resource.",
+ "type": "string"
+ },
+ "sourceDiskId": {
+ "description": "[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.",
+ "type": "string"
+ },
+ "locationHint": {
+ "type": "string",
+ "description": "An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API."
+ },
+ "type": {
+ "type": "string",
+ "description": "URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types."
+ },
+ "users": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/zones/{zone}/operations/{operation}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance",
+ "type": "array"
+ },
+ "sourceDisk": {
+ "description": "The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk ",
+ "type": "string"
+ },
+ "licenseCodes": {
+ "description": "Integer license codes indicating which licenses are attached to this disk.",
+ "items": {
+ "type": "string",
+ "format": "int64"
+ },
+ "type": "array"
+ },
+ "provisionedIops": {
+ "type": "string",
+ "format": "int64",
+ "description": "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."
+ },
+ "sourceStorageObject": {
+ "description": "The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.",
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "CREATING",
+ "DELETING",
+ "FAILED",
+ "READY",
+ "RESTORING"
],
- "parameterOrder": [
- "project",
- "zone",
- "operation"
+ "enumDescriptions": [
+ "Disk is provisioning",
+ "Disk is deleting.",
+ "Disk creation failed.",
+ "Disk is ready for use.",
+ "Source data is being copied into the disk."
],
- "path": "projects/{project}/zones/{zone}/operations/{operation}",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "zone": {
- "type": "string",
- "location": "path",
- "description": "Name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
- },
- "operation": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "description": "Name of the Operations resource to return."
- }
+ "description": "[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. ",
+ "type": "string"
+ },
+ "lastDetachTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Last detach timestamp in RFC3339 text format."
+ },
+ "sourceImage": {
+ "description": "The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family ",
+ "type": "string"
+ },
+ "licenses": {
+ "type": "array",
+ "description": "A list of publicly visible licenses. Reserved for Google's use.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#disk for disks.",
+ "default": "compute#disk",
+ "type": "string"
+ },
+ "replicaZones": {
+ "type": "array",
+ "description": "URLs of the zones where the disk should be replicated to. Only applicable for regional resources.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "labelFingerprint": {
+ "type": "string",
+ "description": "A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.",
+ "format": "byte"
+ },
+ "diskEncryptionKey": {
+ "description": "Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key *version* name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: \"diskEncryptionKey.kmsKeyName\": \"projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.",
+ "$ref": "CustomerEncryptionKey"
+ },
+ "sizeGb": {
+ "format": "int64",
+ "type": "string",
+ "description": "Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive."
+ },
+ "zone": {
+ "description": "[Output Only] URL of the zone where the disk 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"
+ },
+ "architecture": {
+ "enumDescriptions": [
+ "Default value indicating Architecture is not set.",
+ "Machines with architecture ARM64",
+ "Machines with architecture X86_64"
+ ],
+ "type": "string",
+ "enum": [
+ "ARCHITECTURE_UNSPECIFIED",
+ "ARM64",
+ "X86_64"
+ ],
+ "description": "The architecture of the disk. Valid values are ARM64 or X86_64."
+ },
+ "lastAttachTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Last attach timestamp in RFC3339 text format."
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "params": {
+ "$ref": "DiskParams",
+ "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload."
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ },
+ "sourceSnapshotId": {
+ "type": "string",
+ "description": "[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used."
+ },
+ "labels": {
+ "description": "Labels to apply to this disk. These can be later modified by the setLabels method.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "sourceImageEncryptionKey": {
+ "description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.",
+ "$ref": "CustomerEncryptionKey"
+ },
+ "sourceSnapshot": {
+ "description": "The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot ",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.disks.insert"
+ ]
},
- "id": "compute.zoneOperations.get",
- "httpMethod": "GET",
- "description": "Retrieves the specified zone-specific Operations resource."
+ "description": "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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
- "delete": {
- "flatPath": "projects/{project}/zones/{zone}/operations/{operation}",
- "parameters": {
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the zone for this request."
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "resourcePolicies": {
+ "items": {
+ "type": "string"
+ },
+ "description": "Resource policies applied to this disk for automatic snapshot creations.",
+ "type": "array"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "options": {
+ "description": "Internal use only.",
+ "type": "string"
+ },
+ "guestOsFeatures": {
+ "type": "array",
+ "items": {
+ "$ref": "GuestOsFeature"
+ },
+ "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options."
+ },
+ "satisfiesPzs": {
+ "type": "boolean",
+ "description": "[Output Only] Reserved for future use."
+ },
+ "sourceSnapshotEncryptionKey": {
+ "description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.",
+ "$ref": "CustomerEncryptionKey"
+ },
+ "sourceImageId": {
+ "description": "[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "description": "Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * [Zonal](/compute/docs/reference/rest/v1/disks) * [Regional](/compute/docs/reference/rest/v1/regionDisks) Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.",
+ "id": "Disk"
+ },
+ "XpnHostList": {
+ "properties": {
+ "warning": {
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array"
},
- "operation": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
+ "message": {
"type": "string",
- "description": "Name of the Operations resource to delete."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "project": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
},
- "path": "projects/{project}/zones/{zone}/operations/{operation}",
- "id": "compute.zoneOperations.delete",
- "description": "Deletes the specified zone-specific Operations resource.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "operation"
- ],
- "httpMethod": "DELETE"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
},
- "wait": {
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Project ID for this request."
- },
- "operation": {
- "location": "path",
- "required": true,
- "description": "Name of the Operations resource to return.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "zone": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the zone for this request.",
- "location": "path"
- }
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "description": "[Output Only] A list of shared VPC host project URLs.",
+ "items": {
+ "$ref": "Project"
},
- "flatPath": "projects/{project}/zones/{zone}/operations/{operation}/wait",
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/operations/{operation}/wait",
- "parameterOrder": [
- "project",
- "zone",
- "operation"
- ],
- "response": {
+ "type": "array"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts.",
+ "default": "compute#xpnHostList"
+ }
+ },
+ "type": "object",
+ "id": "XpnHostList"
+ },
+ "TestPermissionsRequest": {
+ "type": "object",
+ "id": "TestPermissionsRequest",
+ "properties": {
+ "permissions": {
+ "type": "array",
+ "description": "The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "OperationList": {
+ "description": "Contains a list of Operation resources.",
+ "properties": {
+ "kind": {
+ "description": "[Output Only] Type of resource. Always `compute#operations` for Operations resource.",
+ "type": "string",
+ "default": "compute#operationList"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than `maxResults`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "items": {
+ "items": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ",
- "id": "compute.zoneOperations.wait"
+ "description": "[Output Only] A list of Operation resources.",
+ "type": "array"
},
- "list": {
- "response": {
- "$ref": "OperationList"
- },
- "flatPath": "projects/{project}/zones/{zone}/operations",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.zoneOperations.list",
- "parameterOrder": [
- "project",
- "zone"
- ],
- "httpMethod": "GET",
- "description": "Retrieves a list of Operation resources contained within the specified zone.",
- "path": "projects/{project}/zones/{zone}/operations",
- "parameters": {
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "maxResults": {
- "type": "integer",
- "minimum": "0",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "default": "500"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true
- },
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "Name of the zone for request.",
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "message": {
"type": "string",
- "required": true
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
},
- "filter": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
}
}
- }
+ },
+ "type": "object",
+ "id": "OperationList"
},
- "regionNetworkFirewallPolicies": {
- "methods": {
- "setIamPolicy": {
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "id": "compute.regionNetworkFirewallPolicies.setIamPolicy",
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy",
- "parameters": {
- "region": {
- "location": "path",
- "description": "The name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true
- },
- "resource": {
- "required": true,
- "description": "Name or id of the resource for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true
- }
+ "InstanceGroupManager": {
+ "properties": {
+ "region": {
+ "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources).",
+ "type": "string"
+ },
+ "updatePolicy": {
+ "description": "The update policy for this managed instance group.",
+ "$ref": "InstanceGroupManagerUpdatePolicy"
+ },
+ "currentActions": {
+ "$ref": "InstanceGroupManagerActionsSummary",
+ "description": "[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions."
+ },
+ "distributionPolicy": {
+ "$ref": "DistributionPolicy",
+ "description": "Policy specifying the intended distribution of managed instances across zones in a regional managed instance group."
+ },
+ "fingerprint": {
+ "format": "byte",
+ "description": "Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.",
+ "type": "string"
+ },
+ "instanceGroup": {
+ "description": "[Output Only] The URL of the Instance Group resource.",
+ "type": "string"
+ },
+ "zone": {
+ "type": "string",
+ "description": "[Output Only] The URL of a zone where the managed instance group is located (for zonal resources)."
+ },
+ "versions": {
+ "items": {
+ "$ref": "InstanceGroupManagerVersion"
},
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "request": {
- "$ref": "RegionSetPolicyRequest"
+ "description": "Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.",
+ "type": "array"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource."
+ },
+ "status": {
+ "$ref": "InstanceGroupManagerStatus",
+ "description": "[Output Only] The status of this managed instance group."
+ },
+ "baseInstanceName": {
+ "annotations": {
+ "required": [
+ "compute.instanceGroupManagers.insert"
+ ]
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "pattern": "[a-z][-a-z0-9]{0,57}",
+ "description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.",
+ "type": "string"
+ },
+ "targetPools": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group."
+ },
+ "autoHealingPolicies": {
+ "type": "array",
+ "items": {
+ "$ref": "InstanceGroupManagerAutoHealingPolicy"
+ },
+ "description": "The autohealing policy for this managed instance group. You can specify only one value."
+ },
+ "name": {
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.instanceGroupManagers.insert",
+ "compute.regionInstanceGroupManagers.insert"
+ ]
+ },
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035."
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#instanceGroupManager",
+ "description": "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] The URL for this managed instance group. The server defines this URL."
+ },
+ "listManagedInstancesResults": {
+ "description": "Pagination behavior of the listManagedInstances API method for this managed instance group.",
+ "type": "string",
+ "enum": [
+ "PAGELESS",
+ "PAGINATED"
],
- "response": {
- "$ref": "Policy"
- }
+ "enumDescriptions": [
+ "(Default) Pagination is disabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are ignored and all instances are returned in a single response.",
+ "Pagination is enabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are respected."
+ ]
},
- "patchRule": {
- "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule",
- "parameters": {
- "project": {
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "id": {
+ "type": "string",
+ "format": "uint64",
+ "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier."
+ },
+ "instanceTemplate": {
+ "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.",
+ "type": "string"
+ },
+ "namedPorts": {
+ "description": "Named ports configured for the Instance Groups complementary to this Instance Group Manager.",
+ "items": {
+ "$ref": "NamedPort"
+ },
+ "type": "array"
+ },
+ "targetSize": {
+ "annotations": {
+ "required": [
+ "compute.instanceGroupManagers.insert",
+ "compute.regionInstanceGroupManagers.insert"
+ ]
+ },
+ "description": "The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "statefulPolicy": {
+ "$ref": "StatefulPolicy",
+ "description": "Stateful configuration for this Instanced Group Manager"
+ }
+ },
+ "description": "Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource.",
+ "id": "InstanceGroupManager",
+ "type": "object"
+ },
+ "VpnTunnelAggregatedList": {
+ "properties": {
+ "warning": {
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string"
},
- "requestId": {
- "type": "string",
- "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"
- },
- "priority": {
- "description": "The priority of the rule to patch.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "firewallPolicy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name of the firewall policy to update.",
- "location": "path",
- "type": "string"
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "region": {
+ "message": {
"type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "Name of the region scoping this request."
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.regionNetworkFirewallPolicies.patchRule",
- "description": "Patches a rule of the specified priority.",
- "parameterOrder": [
- "project",
- "region",
- "firewallPolicy"
- ],
- "response": {
- "$ref": "Operation"
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
+ },
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "VpnTunnelsScopedList",
+ "description": "Name of the scope containing this set of VPN tunnels."
},
- "request": {
- "$ref": "FirewallPolicyRule"
+ "description": "A list of VpnTunnelsScopedList resources."
+ },
+ "unreachables": {
+ "description": "[Output Only] Unreachable resources.",
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule",
- "httpMethod": "POST"
+ "type": "array"
},
- "patch": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.regionNetworkFirewallPolicies.patch",
- "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
+ "default": "compute#vpnTunnelAggregatedList",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "VpnTunnelAggregatedList"
+ },
+ "NodeGroupsDeleteNodesRequest": {
+ "type": "object",
+ "properties": {
+ "nodes": {
+ "type": "array",
+ "description": "Names of the nodes to delete.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "NodeGroupsDeleteNodesRequest"
+ },
+ "NodeType": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] The type of the resource. Always compute#nodeType for node types.",
+ "default": "compute#nodeType"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "localSsdGb": {
+ "type": "integer",
+ "description": "[Output Only] Local SSD available to the node type, defined in GB.",
+ "format": "int32"
+ },
+ "memoryMb": {
+ "format": "int32",
+ "description": "[Output Only] The amount of physical memory available to the node type, defined in MB.",
+ "type": "integer"
+ },
+ "description": {
+ "description": "[Output Only] An optional textual description of the resource.",
+ "type": "string"
+ },
+ "cpuPlatform": {
+ "type": "string",
+ "description": "[Output Only] The CPU platform used by this node type."
+ },
+ "zone": {
+ "description": "[Output Only] The name of the zone where the node type resides, such as us-central1-a.",
+ "type": "string"
+ },
+ "guestCpus": {
+ "format": "int32",
+ "description": "[Output Only] The number of virtual CPUs that are available to the node type.",
+ "type": "integer"
+ },
+ "deprecated": {
+ "description": "[Output Only] The deprecation status associated with this node type.",
+ "$ref": "DeprecationStatus"
+ },
+ "name": {
+ "type": "string",
+ "description": "[Output Only] Name of the resource.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ }
+ },
+ "description": "Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types.",
+ "type": "object",
+ "id": "NodeType"
+ },
+ "AddressesScopedList": {
+ "type": "object",
+ "properties": {
+ "warning": {
+ "properties": {
+ "message": {
"type": "string",
- "description": "Name of the region scoping this request.",
- "location": "path"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "firewallPolicy": {
- "type": "string",
- "description": "Name of the firewall policy to update.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array"
},
- "requestId": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "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"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "description": "Patches the specified network firewall policy.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "region",
- "firewallPolicy"
- ],
- "httpMethod": "PATCH",
- "request": {
- "$ref": "FirewallPolicy"
- },
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}"
+ "type": "object",
+ "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty."
},
- "list": {
- "path": "projects/{project}/regions/{region}/firewallPolicies",
- "httpMethod": "GET",
- "description": "Lists all the network firewall policies that have been configured for the specified project in the given region.",
- "parameterOrder": [
- "project",
- "region"
- ],
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies",
- "parameters": {
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "maxResults": {
- "location": "query",
- "type": "integer",
- "default": "500",
- "format": "uint32",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "region": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "addresses": {
+ "type": "array",
+ "description": "[Output Only] A list of addresses contained in this scope.",
+ "items": {
+ "$ref": "Address"
+ }
+ }
+ },
+ "id": "AddressesScopedList"
+ },
+ "ManagedInstanceInstanceHealth": {
+ "properties": {
+ "detailedHealthState": {
+ "description": "[Output Only] The current detailed instance health state.",
+ "type": "string",
+ "enumDescriptions": [
+ "The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.",
+ "The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.",
+ "The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout.",
+ "The instance is reachable, but does not conform to the requirements defined by the health check.",
+ "The health checking system is aware of the instance but its health is not known at the moment."
],
- "response": {
- "$ref": "FirewallPolicyList"
- },
- "id": "compute.regionNetworkFirewallPolicies.list"
+ "enum": [
+ "DRAINING",
+ "HEALTHY",
+ "TIMEOUT",
+ "UNHEALTHY",
+ "UNKNOWN"
+ ]
},
- "getEffectiveFirewalls": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls",
- "id": "compute.regionNetworkFirewallPolicies.getEffectiveFirewalls",
- "parameterOrder": [
- "project",
- "region",
- "network"
- ],
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "network": {
- "location": "query",
- "type": "string",
- "description": "Network reference",
- "required": true
- },
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
- },
- "response": {
- "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse"
- },
- "description": "Returns the effective firewalls on a given network.",
- "httpMethod": "GET",
- "path": "projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls"
+ "healthCheck": {
+ "description": "[Output Only] The URL for the health check that verifies whether the instance is healthy.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "ManagedInstanceInstanceHealth"
+ },
+ "FirewallPolicyRuleMatcherLayer4Config": {
+ "id": "FirewallPolicyRuleMatcherLayer4Config",
+ "properties": {
+ "ports": {
+ "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "insert": {
- "description": "Creates a new network firewall policy in the specified project and region.",
- "httpMethod": "POST",
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies",
- "request": {
- "$ref": "FirewallPolicy"
- },
- "parameterOrder": [
- "project",
- "region"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.regionNetworkFirewallPolicies.insert",
- "response": {
- "$ref": "Operation"
+ "ipProtocol": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GlobalSetLabelsRequest": {
+ "id": "GlobalSetLabelsRequest",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
},
- "path": "projects/{project}/regions/{region}/firewallPolicies",
- "parameters": {
- "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).",
+ "type": "object",
+ "description": "A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\")."
+ },
+ "labelFingerprint": {
+ "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.",
+ "format": "byte",
+ "type": "string"
+ }
+ }
+ },
+ "InstanceGroupManagersAbandonInstancesRequest": {
+ "type": "object",
+ "id": "InstanceGroupManagersAbandonInstancesRequest",
+ "properties": {
+ "instances": {
+ "description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "TargetGrpcProxyList": {
+ "properties": {
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
"type": "string",
- "location": "query"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "project": {
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
+ "data": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
}
},
- "cloneRules": {
- "httpMethod": "POST",
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true
- },
- "firewallPolicy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the firewall policy to update.",
- "type": "string",
- "required": true
- },
- "sourceFirewallPolicy": {
- "type": "string",
- "location": "query",
- "description": "The firewall policy from which to copy rules."
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "firewallPolicy"
- ],
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules",
- "description": "Copies rules to the specified network firewall policy.",
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.regionNetworkFirewallPolicies.cloneRules",
- "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules"
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
},
- "addAssociation": {
- "httpMethod": "POST",
- "id": "compute.regionNetworkFirewallPolicies.addAssociation",
- "parameterOrder": [
- "project",
- "region",
- "firewallPolicy"
- ],
- "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation",
- "description": "Inserts an association for the specified network firewall policy.",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "description": "A list of TargetGrpcProxy resources.",
+ "type": "array",
+ "items": {
+ "$ref": "TargetGrpcProxy"
+ }
+ },
+ "kind": {
+ "default": "compute#targetGrpcProxyList",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies."
+ }
+ },
+ "id": "TargetGrpcProxyList",
+ "type": "object"
+ },
+ "AllocationResourceStatus": {
+ "id": "AllocationResourceStatus",
+ "properties": {
+ "specificSkuAllocation": {
+ "$ref": "AllocationResourceStatusSpecificSKUAllocation"
+ }
+ },
+ "type": "object"
+ },
+ "RegionDisksResizeRequest": {
+ "type": "object",
+ "properties": {
+ "sizeGb": {
+ "description": "The new size of the regional persistent disk, which is specified in GB.",
+ "type": "string",
+ "format": "int64"
+ }
+ },
+ "id": "RegionDisksResizeRequest"
+ },
+ "AcceleratorTypesScopedList": {
+ "properties": {
+ "warning": {
+ "description": "[Output Only] An informational warning that appears when the accelerator types list is empty.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "replaceExistingAssociation": {
- "description": "Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists.",
- "type": "boolean",
- "location": "query"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "type": "array"
},
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path",
- "description": "Name of the region scoping this request.",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string"
- },
- "firewallPolicy": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the firewall policy to update.",
- "required": true
}
- },
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "FirewallPolicyAssociation"
}
},
- "testIamPermissions": {
- "response": {
- "$ref": "TestPermissionsResponse"
+ "acceleratorTypes": {
+ "items": {
+ "$ref": "AcceleratorType"
},
- "description": "Returns permissions that a caller has on the specified resource.",
- "httpMethod": "POST",
- "id": "compute.regionNetworkFirewallPolicies.testIamPermissions",
- "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions",
- "request": {
- "$ref": "TestPermissionsRequest"
+ "description": "[Output Only] A list of accelerator types contained in this scope.",
+ "type": "array"
+ }
+ },
+ "id": "AcceleratorTypesScopedList",
+ "type": "object"
+ },
+ "SslCertificate": {
+ "description": "Represents an SSL Certificate resource. Google Compute Engine has two SSL Certificate resources: * [Global](/compute/docs/reference/rest/v1/sslCertificates) * [Regional](/compute/docs/reference/rest/v1/regionSslCertificates) The sslCertificates are used by: - external HTTPS load balancers - SSL proxy load balancers The regionSslCertificates are used by internal HTTPS load balancers. Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.",
+ "type": "object",
+ "properties": {
+ "managed": {
+ "description": "Configuration and status of a managed SSL certificate.",
+ "$ref": "SslCertificateManagedSslCertificate"
+ },
+ "selfManaged": {
+ "$ref": "SslCertificateSelfManagedSslCertificate",
+ "description": "Configuration and status of a self-managed SSL certificate."
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "certificate": {
+ "type": "string",
+ "description": "A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert."
+ },
+ "expireTime": {
+ "description": "[Output Only] Expire time of the certificate. RFC3339",
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "description": "(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.",
+ "enum": [
+ "MANAGED",
+ "SELF_MANAGED",
+ "TYPE_UNSPECIFIED"
+ ],
+ "enumDescriptions": [
+ "Google-managed SSLCertificate.",
+ "Certificate uploaded by user.",
+ ""
+ ]
+ },
+ "region": {
+ "description": "[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "subjectAlternativeNames": {
+ "description": "[Output Only] Domains associated with the certificate via Subject Alternative Name.",
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "array"
+ },
+ "privateKey": {
+ "type": "string",
+ "description": "A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field."
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "selfLink": {
+ "description": "[Output only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "name": {
+ "description": "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.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "kind": {
+ "default": "compute#sslCertificate",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates."
+ }
+ },
+ "id": "SslCertificate"
+ },
+ "VpnGatewayStatusHighAvailabilityRequirementState": {
+ "type": "object",
+ "description": "Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway.",
+ "id": "VpnGatewayStatusHighAvailabilityRequirementState",
+ "properties": {
+ "state": {
+ "enum": [
+ "CONNECTION_REDUNDANCY_MET",
+ "CONNECTION_REDUNDANCY_NOT_MET"
],
- "parameterOrder": [
- "project",
- "region",
- "resource"
+ "description": "Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.",
+ "type": "string",
+ "enumDescriptions": [
+ "VPN tunnels are configured with adequate redundancy from Cloud VPN gateway to the peer VPN gateway. For both GCP-to-non-GCP and GCP-to-GCP connections, the adequate redundancy is a pre-requirement for users to get 99.99% availability on GCP side; please note that for any connection, end-to-end 99.99% availability is subject to proper configuration on the peer VPN gateway.",
+ "VPN tunnels are not configured with adequate redundancy from the Cloud VPN gateway to the peer gateway"
+ ]
+ },
+ "unsatisfiedReason": {
+ "enum": [
+ "INCOMPLETE_TUNNELS_COVERAGE"
],
- "parameters": {
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
- },
- "region": {
- "description": "The name of the region for this request.",
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true,
- "description": "Name or id of the resource for this request.",
- "location": "path"
- }
+ "description": "Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE.",
+ "type": "string",
+ "enumDescriptions": [
+ ""
+ ]
+ }
+ }
+ },
+ "AuditLogConfig": {
+ "properties": {
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions"
+ "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members."
},
- "addRule": {
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "maxPriority": {
- "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\u003e. This field is exclusive with rule.priority.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "minPriority": {
- "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\u003e. This field is exclusive with rule.priority.",
- "location": "query",
- "format": "int32",
- "type": "integer"
- },
- "firewallPolicy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name of the firewall policy to update.",
- "location": "path",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "region": {
- "location": "path",
- "required": true,
- "description": "Name of the region scoping this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
+ "ignoreChildExemptions": {
+ "description": "This is deprecated and has no effect. Do not use.",
+ "type": "boolean"
+ },
+ "logType": {
+ "type": "string",
+ "enum": [
+ "ADMIN_READ",
+ "DATA_READ",
+ "DATA_WRITE",
+ "LOG_TYPE_UNSPECIFIED"
+ ],
+ "enumDescriptions": [
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data reads. Example: CloudSQL Users list",
+ "Data writes. Example: CloudSQL Users create",
+ "Default case. Should never be this."
+ ],
+ "description": "The log type that this config enables."
+ }
+ },
+ "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",
+ "type": "object"
+ },
+ "NetworkEndpointGroupPscData": {
+ "properties": {
+ "consumerPscAddress": {
+ "description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.",
+ "type": "string"
+ },
+ "pscConnectionId": {
+ "description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "pscConnectionStatus": {
+ "description": "[Output Only] The connection status of the PSC Forwarding Rule.",
+ "type": "string",
+ "enum": [
+ "ACCEPTED",
+ "CLOSED",
+ "NEEDS_ATTENTION",
+ "PENDING",
+ "REJECTED",
+ "STATUS_UNSPECIFIED"
+ ],
+ "enumDescriptions": [
+ "The connection has been accepted by the producer.",
+ "The connection has been closed by the producer and will not serve traffic going forward.",
+ "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.",
+ "The connection is pending acceptance by the producer.",
+ "The connection has been rejected by the producer.",
+ ""
+ ]
+ }
+ },
+ "description": "All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.",
+ "type": "object",
+ "id": "NetworkEndpointGroupPscData"
+ },
+ "ReservationAggregatedList": {
+ "type": "object",
+ "properties": {
+ "unreachables": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "region",
- "firewallPolicy"
- ],
- "httpMethod": "POST",
- "request": {
- "$ref": "FirewallPolicyRule"
+ "description": "[Output Only] Unreachable resources."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "description": "Type of resource.",
+ "default": "compute#reservationAggregatedList"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "description": "A list of Allocation resources.",
+ "additionalProperties": {
+ "$ref": "ReservationsScopedList",
+ "description": "Name of the scope containing this set of reservations."
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule",
- "description": "Inserts a rule into a network firewall policy.",
- "id": "compute.regionNetworkFirewallPolicies.addRule",
- "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule"
+ "type": "object"
},
- "get": {
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
- "parameterOrder": [
- "project",
- "region",
- "firewallPolicy"
- ],
- "parameters": {
- "region": {
- "location": "path",
- "description": "Name of the region scoping this request.",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ "warning": {
+ "properties": {
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
},
- "firewallPolicy": {
+ "code": {
"type": "string",
- "description": "Name of the firewall policy to get.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
},
- "id": "compute.regionNetworkFirewallPolicies.get",
- "response": {
- "$ref": "FirewallPolicy"
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "description": "Contains a list of reservations.",
+ "id": "ReservationAggregatedList"
+ },
+ "RegionInstanceGroupsSetNamedPortsRequest": {
+ "type": "object",
+ "properties": {
+ "namedPorts": {
+ "type": "array",
+ "items": {
+ "$ref": "NamedPort"
},
- "httpMethod": "GET",
- "description": "Returns the specified network firewall policy.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "The list of named ports to set for this instance group."
+ },
+ "fingerprint": {
+ "type": "string",
+ "format": "byte",
+ "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request."
+ }
+ },
+ "id": "RegionInstanceGroupsSetNamedPortsRequest"
+ },
+ "GuestOsFeature": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features.",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}"
+ "enum": [
+ "FEATURE_TYPE_UNSPECIFIED",
+ "GVNIC",
+ "MULTI_IP_SUBNET",
+ "SECURE_BOOT",
+ "SEV_CAPABLE",
+ "SEV_SNP_CAPABLE",
+ "UEFI_COMPATIBLE",
+ "VIRTIO_SCSI_MULTIQUEUE",
+ "WINDOWS"
+ ]
+ }
+ },
+ "description": "Guest OS features.",
+ "id": "GuestOsFeature"
+ },
+ "InstanceManagedByIgmErrorInstanceActionDetails": {
+ "id": "InstanceManagedByIgmErrorInstanceActionDetails",
+ "properties": {
+ "version": {
+ "description": "[Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created.",
+ "$ref": "ManagedInstanceVersion"
},
- "removeRule": {
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "firewallPolicy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Name of the firewall policy to update."
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "priority": {
- "type": "integer",
- "description": "The priority of the rule to remove from the firewall policy.",
- "format": "int32",
- "location": "query"
- },
- "region": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "description": "Name of the region scoping this request."
- },
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "instance": {
+ "type": "string",
+ "description": "[Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created."
+ },
+ "action": {
+ "enum": [
+ "ABANDONING",
+ "CREATING",
+ "CREATING_WITHOUT_RETRIES",
+ "DELETING",
+ "NONE",
+ "RECREATING",
+ "REFRESHING",
+ "RESTARTING",
+ "RESUMING",
+ "STARTING",
+ "STOPPING",
+ "SUSPENDING",
+ "VERIFYING"
],
- "id": "compute.regionNetworkFirewallPolicies.removeRule",
- "httpMethod": "POST",
- "description": "Deletes a rule of the specified priority.",
- "parameterOrder": [
- "project",
- "region",
- "firewallPolicy"
+ "type": "string",
+ "enumDescriptions": [
+ "The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.",
+ "The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.",
+ "The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.",
+ "The managed instance group is permanently deleting this instance.",
+ "The managed instance group has not scheduled any actions for this instance.",
+ "The managed instance group is recreating this instance.",
+ "The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.",
+ "The managed instance group is restarting this instance.",
+ "The managed instance group is resuming this instance.",
+ "The managed instance group is starting this instance.",
+ "The managed instance group is stopping this instance.",
+ "The managed instance group is suspending this instance.",
+ "The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions)."
],
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule",
- "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule"
+ "description": "[Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:"
+ }
+ },
+ "type": "object"
+ },
+ "PublicAdvertisedPrefix": {
+ "type": "object",
+ "id": "PublicAdvertisedPrefix",
+ "description": "A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
},
- "delete": {
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "region": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request."
- },
- "firewallPolicy": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string",
- "description": "Name of the firewall policy to delete."
- }
+ "sharedSecret": {
+ "description": "[Output Only] The shared secret to be used for reverse DNS verification.",
+ "type": "string"
+ },
+ "dnsVerificationIp": {
+ "description": "The IPv4 address to be used for reverse DNS verification.",
+ "type": "string"
+ },
+ "fingerprint": {
+ "type": "string",
+ "format": "byte",
+ "description": "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 new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix."
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "publicDelegatedPrefixs": {
+ "type": "array",
+ "items": {
+ "$ref": "PublicAdvertisedPrefixPublicDelegatedPrefix"
},
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
- "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
- "description": "Deletes the specified network firewall policy.",
- "id": "compute.regionNetworkFirewallPolicies.delete",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "firewallPolicy"
+ "description": "[Output Only] The list of public delegated prefixes that exist for this public advertised prefix."
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.",
+ "default": "compute#publicAdvertisedPrefix"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "status": {
+ "type": "string",
+ "description": "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. ",
+ "enumDescriptions": [
+ "RPKI validation is complete.",
+ "The prefix is fully configured.",
+ "The prefix is being configured.",
+ "The prefix is being removed.",
+ "User has configured the PTR.",
+ "Reverse DNS lookup failed.",
+ "Reverse DNS lookup is successful."
],
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- }
+ "enum": [
+ "INITIAL",
+ "PREFIX_CONFIGURATION_COMPLETE",
+ "PREFIX_CONFIGURATION_IN_PROGRESS",
+ "PREFIX_REMOVAL_IN_PROGRESS",
+ "PTR_CONFIGURED",
+ "REVERSE_DNS_LOOKUP_FAILED",
+ "VALIDATED"
+ ]
},
- "getAssociation": {
- "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation",
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "region": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path"
- },
- "name": {
- "description": "The name of the association to get from the firewall policy.",
- "location": "query",
+ "ipCidrRange": {
+ "description": "The IPv4 address range, in CIDR format, represented by this public advertised prefix.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.publicAdvertisedPrefixes.insert"
+ ]
+ },
+ "description": "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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ }
+ }
+ },
+ "NetworkEndpointGroupsListNetworkEndpoints": {
+ "type": "object",
+ "id": "NetworkEndpointGroupsListNetworkEndpoints",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.",
+ "default": "compute#networkEndpointGroupsListNetworkEndpoints"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string"
},
- "firewallPolicy": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the firewall policy to which the queried association belongs.",
- "location": "path",
- "required": true
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ }
+ },
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
- },
- "httpMethod": "GET",
- "id": "compute.regionNetworkFirewallPolicies.getAssociation",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Gets an association with the specified name.",
- "parameterOrder": [
- "project",
- "region",
- "firewallPolicy"
- ],
- "response": {
- "$ref": "FirewallPolicyAssociation"
}
},
- "getRule": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "region",
- "firewallPolicy"
- ],
- "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule",
- "description": "Gets a rule of the specified priority.",
- "httpMethod": "GET",
- "response": {
- "$ref": "FirewallPolicyRule"
- },
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule",
- "id": "compute.regionNetworkFirewallPolicies.getRule",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "firewallPolicy": {
- "required": true,
- "description": "Name of the firewall policy to which the queried rule belongs.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true
- },
- "priority": {
- "location": "query",
- "format": "int32",
- "description": "The priority of the rule to get from the firewall policy.",
- "type": "integer"
- }
+ "items": {
+ "type": "array",
+ "description": "A list of NetworkEndpointWithHealthStatus resources.",
+ "items": {
+ "$ref": "NetworkEndpointWithHealthStatus"
}
},
- "getIamPolicy": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.regionNetworkFirewallPolicies.getIamPolicy",
- "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy",
- "parameterOrder": [
- "project",
- "region",
- "resource"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Policy"
- },
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy",
- "parameters": {
- "resource": {
- "location": "path",
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "optionsRequestedPolicyVersion": {
- "format": "int32",
- "location": "query",
- "description": "Requested IAM Policy version.",
- "type": "integer"
- },
- "region": {
- "required": true,
- "type": "string",
- "description": "The name of the region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path"
- }
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ }
+ },
+ "UrlMapsScopedList": {
+ "id": "UrlMapsScopedList",
+ "type": "object",
+ "properties": {
+ "urlMaps": {
+ "description": "A list of UrlMaps contained in this scope.",
+ "type": "array",
+ "items": {
+ "$ref": "UrlMap"
}
},
- "removeAssociation": {
- "parameterOrder": [
- "project",
- "region",
- "firewallPolicy"
- ],
- "description": "Removes an association for the specified network firewall policy.",
- "id": "compute.regionNetworkFirewallPolicies.removeAssociation",
- "httpMethod": "POST",
- "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation",
- "parameters": {
- "region": {
- "required": true,
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path"
- },
- "project": {
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "firewallPolicy": {
- "description": "Name of the firewall policy to update.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path"
+ "warning": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "requestId": {
+ "code": {
"type": "string",
- "location": "query",
- "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)."
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "name": {
- "location": "query",
- "description": "Name for the association that will be removed.",
- "type": "string"
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "description": "Informational warning which replaces the list of backend services when the list is empty."
}
}
},
- "targetSslProxies": {
- "methods": {
- "setSslCertificates": {
- "parameterOrder": [
- "project",
- "targetSslProxy"
+ "HttpHeaderMatch": {
+ "id": "HttpHeaderMatch",
+ "description": "matchRule criteria for request header matches.",
+ "properties": {
+ "exactMatch": {
+ "description": "The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.",
+ "type": "string"
+ },
+ "regexMatch": {
+ "description": "The value of the header must match the regular expression specified in regexMatch. For more information about regular expression syntax, see Syntax. For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.",
+ "type": "string"
+ },
+ "headerName": {
+ "type": "string",
+ "description": "The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name \":authority\". For matching a request's method, use the headerName \":method\". When the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin`."
+ },
+ "presentMatch": {
+ "description": "A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.",
+ "type": "boolean"
+ },
+ "invertMatch": {
+ "type": "boolean",
+ "description": "If set to false, the headerMatch is considered a match if the preceding match criteria are met. If set to true, the headerMatch is considered a match if the preceding match criteria are NOT met. The default setting is false. "
+ },
+ "prefixMatch": {
+ "description": "The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.",
+ "type": "string"
+ },
+ "suffixMatch": {
+ "type": "string",
+ "description": "The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set."
+ },
+ "rangeMatch": {
+ "description": "The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch is not supported for load balancers that have loadBalancingScheme set to EXTERNAL.",
+ "$ref": "Int64RangeMatch"
+ }
+ },
+ "type": "object"
+ },
+ "InterconnectAttachmentPartnerMetadata": {
+ "type": "object",
+ "id": "InterconnectAttachmentPartnerMetadata",
+ "properties": {
+ "portalUrl": {
+ "type": "string",
+ "description": "URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values."
+ },
+ "interconnectName": {
+ "type": "string",
+ "description": "Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance \"Chicago 1\". This value may be validated to match approved Partner values."
+ },
+ "partnerName": {
+ "description": "Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.",
+ "type": "string"
+ }
+ },
+ "description": "Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments."
+ },
+ "ConnectionDraining": {
+ "properties": {
+ "drainingTimeoutSec": {
+ "type": "integer",
+ "description": "Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.",
+ "format": "int32"
+ }
+ },
+ "id": "ConnectionDraining",
+ "description": "Message containing connection draining configuration.",
+ "type": "object"
+ },
+ "TargetInstance": {
+ "id": "TargetInstance",
+ "description": "Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances.",
+ "properties": {
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "[Output Only] URL of the zone where the target instance 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"
+ },
+ "name": {
+ "type": "string",
+ "description": "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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "instance": {
+ "type": "string",
+ "description": "A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance "
+ },
+ "network": {
+ "description": "The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.",
+ "type": "string"
+ },
+ "natPolicy": {
+ "type": "string",
+ "enumDescriptions": [
+ "No NAT performed."
],
- "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates",
- "request": {
- "$ref": "TargetSslProxiesSetSslCertificatesRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enum": [
+ "NO_NAT"
],
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "targetSslProxy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the TargetSslProxy resource whose SslCertificate resource is to be set."
- }
- },
- "description": "Changes SslCertificates for TargetSslProxy.",
- "id": "compute.targetSslProxies.setSslCertificates",
- "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "POST"
+ "description": "Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance."
},
- "list": {
- "httpMethod": "GET",
- "parameters": {
- "maxResults": {
- "minimum": "0",
- "default": "500",
- "format": "uint32",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query"
- },
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- }
- },
- "flatPath": "projects/{project}/global/targetSslProxies",
- "path": "projects/{project}/global/targetSslProxies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.targetSslProxies.list",
- "description": "Retrieves the list of TargetSslProxy resources available to the specified project.",
- "response": {
- "$ref": "TargetSslProxyList"
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#targetInstance",
+ "description": "[Output Only] The type of the resource. Always compute#targetInstance for target instances.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ResourcePolicyInstanceSchedulePolicy": {
+ "properties": {
+ "startTime": {
+ "type": "string",
+ "description": "The start time of the schedule. The timestamp is an RFC3339 string."
+ },
+ "expirationTime": {
+ "description": "The expiration time of the schedule. The timestamp is an RFC3339 string.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database.",
+ "type": "string"
+ },
+ "vmStopSchedule": {
+ "description": "Specifies the schedule for stopping instances.",
+ "$ref": "ResourcePolicyInstanceSchedulePolicySchedule"
+ },
+ "vmStartSchedule": {
+ "description": "Specifies the schedule for starting instances.",
+ "$ref": "ResourcePolicyInstanceSchedulePolicySchedule"
+ }
+ },
+ "type": "object",
+ "id": "ResourcePolicyInstanceSchedulePolicy",
+ "description": "An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance."
+ },
+ "InstanceGroupManagersPatchPerInstanceConfigsReq": {
+ "id": "InstanceGroupManagersPatchPerInstanceConfigsReq",
+ "type": "object",
+ "properties": {
+ "perInstanceConfigs": {
+ "items": {
+ "$ref": "PerInstanceConfig"
},
- "parameterOrder": [
- "project"
- ]
+ "description": "The list of per-instance configurations to insert or patch on this managed instance group.",
+ "type": "array"
+ }
+ },
+ "description": "InstanceGroupManagers.patchPerInstanceConfigs"
+ },
+ "NetworkAttachmentConnectedEndpoint": {
+ "properties": {
+ "projectIdOrNum": {
+ "description": "The project id or number of the interface to which the IP was assigned.",
+ "type": "string"
},
- "insert": {
- "path": "projects/{project}/global/targetSslProxies",
- "request": {
- "$ref": "TargetSslProxy"
+ "ipAddress": {
+ "description": "The IP address assigned to the producer instance network interface. This value will be a range in case of Serverless.",
+ "type": "string"
+ },
+ "subnetwork": {
+ "type": "string",
+ "description": "The subnetwork used to assign the IP to the producer instance network interface."
+ },
+ "secondaryIpCidrRanges": {
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project"
+ "description": "Alias IP ranges from the same subnetwork",
+ "type": "array"
+ },
+ "status": {
+ "enum": [
+ "ACCEPTED",
+ "CLOSED",
+ "NEEDS_ATTENTION",
+ "PENDING",
+ "REJECTED",
+ "STATUS_UNSPECIFIED"
],
- "flatPath": "projects/{project}/global/targetSslProxies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "enumDescriptions": [
+ "The consumer allows traffic from the producer to reach its VPC.",
+ "The consumer network attachment no longer exists.",
+ "The consumer needs to take further action before traffic can be served.",
+ "The consumer neither allows nor prohibits traffic from the producer to reach its VPC.",
+ "The consumer prohibits traffic from the producer to reach its VPC.",
+ ""
],
- "id": "compute.targetSslProxies.insert",
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "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).",
- "type": "string",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "description": "Creates a TargetSslProxy resource in the specified project using the data included in the request.",
- "httpMethod": "POST"
- },
- "delete": {
- "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}",
- "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}",
- "description": "Deletes the specified TargetSslProxy resource.",
- "parameters": {
- "project": {
+ "description": "The status of a connected endpoint to this network attachment."
+ }
+ },
+ "type": "object",
+ "id": "NetworkAttachmentConnectedEndpoint",
+ "description": "[Output Only] A connection connected to this network attachment."
+ },
+ "NetworkList": {
+ "id": "NetworkList",
+ "description": "Contains a list of networks.",
+ "properties": {
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "message": {
"type": "string",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "type": "string"
},
- "targetSslProxy": {
- "type": "string",
- "required": true,
- "description": "Name of the TargetSslProxy resource to delete.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
}
},
- "parameterOrder": [
- "project",
- "targetSslProxy"
- ],
- "id": "compute.targetSslProxies.delete",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "DELETE"
+ "type": "object"
},
- "setProxyHeader": {
- "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader",
- "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "targetSslProxy"
- ],
- "httpMethod": "POST",
- "request": {
- "$ref": "TargetSslProxiesSetProxyHeaderRequest"
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "items": {
+ "items": {
+ "$ref": "Network"
},
- "description": "Changes the ProxyHeaderType for TargetSslProxy.",
- "parameters": {
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string"
+ "type": "array",
+ "description": "A list of Network resources."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#networkList",
+ "description": "[Output Only] Type of resource. Always compute#networkList for lists of networks."
+ }
+ },
+ "type": "object"
+ },
+ "InstanceGroupsListInstances": {
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "[Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.",
+ "default": "compute#instanceGroupsListInstances",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "targetSslProxy": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "Name of the TargetSslProxy resource whose ProxyHeader is to be set.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "requestId": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "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"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
},
- "id": "compute.targetSslProxies.setProxyHeader",
- "response": {
- "$ref": "Operation"
- }
+ "type": "object"
},
- "setCertificateMap": {
- "parameters": {
- "targetSslProxy": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035."
- },
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
- },
- "request": {
- "$ref": "TargetSslProxiesSetCertificateMapRequest"
+ "items": {
+ "items": {
+ "$ref": "InstanceWithNamedPorts"
},
- "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap",
- "httpMethod": "POST",
- "description": "Changes the Certificate Map for TargetSslProxy.",
- "id": "compute.targetSslProxies.setCertificateMap",
- "parameterOrder": [
- "project",
- "targetSslProxy"
- ],
- "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
+ "description": "A list of InstanceWithNamedPorts resources.",
+ "type": "array"
+ }
+ },
+ "type": "object",
+ "id": "InstanceGroupsListInstances"
+ },
+ "SubnetworkList": {
+ "type": "object",
+ "description": "Contains a list of Subnetwork resources.",
+ "id": "SubnetworkList",
+ "properties": {
+ "items": {
+ "description": "A list of Subnetwork resources.",
+ "type": "array",
+ "items": {
+ "$ref": "Subnetwork"
}
},
- "setBackendService": {
- "request": {
- "$ref": "TargetSslProxiesSetBackendServiceRequest"
- },
- "id": "compute.targetSslProxies.setBackendService",
- "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService",
- "parameterOrder": [
- "project",
- "targetSslProxy"
- ],
- "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "targetSslProxy": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "description": "Name of the TargetSslProxy resource whose BackendService resource is to be set."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string"
- }
- },
- "description": "Changes the BackendService for TargetSslProxy.",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
},
- "setSslPolicy": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "description": "Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends.",
- "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy",
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.targetSslProxies.setSslPolicy",
- "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy",
- "parameters": {
- "targetSslProxy": {
- "description": "Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "request": {
- "$ref": "SslPolicyReference"
- },
- "parameterOrder": [
- "project",
- "targetSslProxy"
- ]
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "kind": {
+ "default": "compute#subnetworkList",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
},
- "get": {
- "id": "compute.targetSslProxies.get",
- "description": "Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "parameters": {
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string"
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "targetSslProxy": {
- "description": "Name of the TargetSslProxy resource to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ },
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "location": "path",
- "required": true
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
},
- "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}",
- "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}",
- "response": {
- "$ref": "TargetSslProxy"
- },
- "parameterOrder": [
- "project",
- "targetSslProxy"
- ]
+ "type": "object"
}
}
},
- "targetGrpcProxies": {
- "methods": {
- "patch": {
- "description": "Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
- "parameterOrder": [
- "project",
- "targetGrpcProxy"
- ],
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string"
- },
- "targetGrpcProxy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the TargetGrpcProxy resource to patch.",
+ "ZoneList": {
+ "properties": {
+ "warning": {
+ "properties": {
+ "message": {
"type": "string",
- "location": "path",
- "required": true
- }
- },
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
- "request": {
- "$ref": "TargetGrpcProxy"
- },
- "id": "compute.targetGrpcProxies.patch"
- },
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.targetGrpcProxies.delete",
- "parameterOrder": [
- "project",
- "targetGrpcProxy"
- ],
- "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
- "description": "Deletes the specified TargetGrpcProxy in the given scope",
- "httpMethod": "DELETE",
- "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "targetGrpcProxy": {
- "location": "path",
- "required": true,
- "description": "Name of the TargetGrpcProxy resource to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ }
},
- "project": {
- "description": "Project ID for this request.",
- "required": true,
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "response": {
- "$ref": "Operation"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "kind": {
+ "description": "Type of resource.",
+ "default": "compute#zoneList",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "description": "A list of Zone resources.",
+ "type": "array",
+ "items": {
+ "$ref": "Zone"
}
+ }
+ },
+ "type": "object",
+ "description": "Contains a list of zone resources.",
+ "id": "ZoneList"
+ },
+ "AcceleratorConfig": {
+ "type": "object",
+ "description": "A specification of the type and number of accelerator cards attached to the instance.",
+ "id": "AcceleratorConfig",
+ "properties": {
+ "acceleratorType": {
+ "description": "Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.",
+ "type": "string"
},
- "insert": {
- "parameterOrder": [
- "project"
- ],
- "description": "Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.",
- "flatPath": "projects/{project}/global/targetGrpcProxies",
- "httpMethod": "POST",
- "parameters": {
- "project": {
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
- },
- "requestId": {
- "type": "string",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "TargetGrpcProxy"
- },
- "id": "compute.targetGrpcProxies.insert",
- "response": {
- "$ref": "Operation"
+ "acceleratorCount": {
+ "format": "int32",
+ "description": "The number of the guest accelerator cards exposed to this instance.",
+ "type": "integer"
+ }
+ }
+ },
+ "InitialStateConfig": {
+ "description": "Initial State for shielded instance, these are public keys which are safe to store in public",
+ "properties": {
+ "dbxs": {
+ "type": "array",
+ "description": "The forbidden key database (dbx).",
+ "items": {
+ "$ref": "FileContentBuffer"
+ }
+ },
+ "pk": {
+ "description": "The Platform Key (PK).",
+ "$ref": "FileContentBuffer"
+ },
+ "dbs": {
+ "type": "array",
+ "description": "The Key Database (db).",
+ "items": {
+ "$ref": "FileContentBuffer"
+ }
+ },
+ "keks": {
+ "description": "The Key Exchange Key (KEK).",
+ "items": {
+ "$ref": "FileContentBuffer"
},
- "path": "projects/{project}/global/targetGrpcProxies"
+ "type": "array"
+ }
+ },
+ "id": "InitialStateConfig",
+ "type": "object"
+ },
+ "InstanceGroupList": {
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
},
- "list": {
- "response": {
- "$ref": "TargetGrpcProxyList"
+ "kind": {
+ "description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.",
+ "default": "compute#instanceGroupList",
+ "type": "string"
+ },
+ "items": {
+ "items": {
+ "$ref": "InstanceGroup"
},
- "flatPath": "projects/{project}/global/targetGrpcProxies",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project"
- ],
- "parameters": {
- "maxResults": {
- "default": "500",
- "format": "uint32",
- "location": "query",
- "type": "integer",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "required": true
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ "type": "array",
+ "description": "A list of InstanceGroup resources."
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "location": "query"
- }
- },
- "id": "compute.targetGrpcProxies.list",
- "description": "Lists the TargetGrpcProxies for a project in the given scope.",
- "httpMethod": "GET",
- "path": "projects/{project}/global/targetGrpcProxies"
- },
- "get": {
- "httpMethod": "GET",
- "description": "Returns the specified TargetGrpcProxy resource in the given scope.",
- "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
- "id": "compute.targetGrpcProxies.get",
- "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
- "response": {
- "$ref": "TargetGrpcProxy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "targetGrpcProxy"
- ],
- "parameters": {
- "targetGrpcProxy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "description": "Name of the TargetGrpcProxy resource to return.",
- "type": "string"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "message": {
"type": "string",
- "location": "path",
- "required": true,
- "description": "Project ID for this request."
+ "description": "[Output Only] A human-readable description of the warning code."
}
}
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
}
- }
+ },
+ "id": "InstanceGroupList",
+ "description": "A list of InstanceGroup resources."
},
- "regionOperations": {
- "methods": {
- "list": {
- "parameters": {
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "project": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "region": {
- "location": "path",
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request."
- },
- "maxResults": {
- "default": "500",
- "minimum": "0",
- "format": "uint32",
- "type": "integer",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- }
- },
- "path": "projects/{project}/regions/{region}/operations",
- "description": "Retrieves a list of Operation resources contained within the specified region.",
- "response": {
- "$ref": "OperationList"
+ "InstanceGroup": {
+ "properties": {
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] The creation timestamp for this instance group in RFC3339 text format."
+ },
+ "selfLink": {
+ "description": "[Output Only] The URL for this instance group. The server generates this URL.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "name": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "annotations": {
+ "required": [
+ "compute.instanceGroups.insert"
+ ]
},
- "parameterOrder": [
- "project",
- "region"
- ],
- "httpMethod": "GET",
- "flatPath": "projects/{project}/regions/{region}/operations",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035."
+ },
+ "size": {
+ "description": "[Output Only] The total number of instances in the instance group.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "namedPorts": {
+ "description": " Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group. ",
+ "type": "array",
+ "items": {
+ "$ref": "NamedPort"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#instanceGroup",
+ "description": "[Output Only] The resource type, which is always compute#instanceGroup for instance groups."
+ },
+ "subnetwork": {
+ "type": "string",
+ "description": "[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0)."
+ },
+ "zone": {
+ "type": "string",
+ "description": "[Output Only] The URL of the zone where the instance group is located (for zonal resources)."
+ },
+ "network": {
+ "description": "[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] The URL of the region where the instance group is located (for regional resources)."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] A unique identifier for this instance group, generated by the server.",
+ "format": "uint64"
+ },
+ "fingerprint": {
+ "description": "[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "description": "Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups.",
+ "type": "object",
+ "id": "InstanceGroup"
+ },
+ "NetworkRoutingConfig": {
+ "properties": {
+ "routingMode": {
+ "enum": [
+ "GLOBAL",
+ "REGIONAL"
],
- "id": "compute.regionOperations.list"
+ "description": "The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
+ ]
+ }
+ },
+ "type": "object",
+ "description": "A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide.",
+ "id": "NetworkRoutingConfig"
+ },
+ "UsableSubnetworkSecondaryRange": {
+ "description": "Secondary IP range of a usable subnetwork.",
+ "id": "UsableSubnetworkSecondaryRange",
+ "properties": {
+ "rangeName": {
+ "type": "string",
+ "description": "The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork."
},
- "get": {
- "description": "Retrieves the specified region-specific Operations resource.",
- "parameters": {
- "operation": {
- "location": "path",
- "description": "Name of the Operations resource to return.",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
+ "ipCidrRange": {
+ "type": "string",
+ "description": "The range of IP addresses belonging to this subnetwork secondary range."
+ }
+ },
+ "type": "object"
+ },
+ "InstanceTemplate": {
+ "description": "Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates.",
+ "id": "InstanceTemplate",
+ "properties": {
+ "sourceInstanceParams": {
+ "$ref": "SourceInstanceParams",
+ "description": "The source instance params to use to create this instance template."
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "compute.instanceTemplates.insert"
+ ]
},
- "path": "projects/{project}/regions/{region}/operations/{operation}",
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "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."
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] The creation timestamp for this instance template in RFC3339 text format.",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] The URL for this instance template. The server defines this URL."
+ },
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] A unique identifier for this instance template. The server defines this identifier."
+ },
+ "sourceInstance": {
+ "type": "string",
+ "description": "The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance "
+ },
+ "properties": {
+ "$ref": "InstanceProperties",
+ "description": "The instance properties for this instance template."
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.",
+ "default": "compute#instanceTemplate"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "HealthChecksScopedList": {
+ "properties": {
+ "healthChecks": {
+ "description": "A list of HealthChecks contained in this scope.",
+ "items": {
+ "$ref": "HealthCheck"
},
- "parameterOrder": [
- "project",
- "region",
- "operation"
- ],
- "id": "compute.regionOperations.get",
- "flatPath": "projects/{project}/regions/{region}/operations/{operation}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
+ "type": "array"
},
- "delete": {
- "parameters": {
- "operation": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the Operations resource to delete."
+ "warning": {
+ "properties": {
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ }
},
- "region": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request.",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "project": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "id": "compute.regionOperations.delete",
- "path": "projects/{project}/regions/{region}/operations/{operation}",
- "description": "Deletes the specified region-specific Operations resource.",
- "parameterOrder": [
- "project",
- "region",
- "operation"
- ],
- "flatPath": "projects/{project}/regions/{region}/operations/{operation}",
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "description": "Informational warning which replaces the list of backend services when the list is empty.",
+ "type": "object"
+ }
+ },
+ "type": "object",
+ "id": "HealthChecksScopedList"
+ },
+ "SecurityPolicyRuleRateLimitOptions": {
+ "properties": {
+ "conformAction": {
+ "type": "string",
+ "description": "Action to take for requests that are under the configured rate limit threshold. Valid option is \"allow\" only."
},
- "wait": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "banDurationSec": {
+ "type": "integer",
+ "description": "Can only be specified if the action for the rule is \"rate_based_ban\". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.",
+ "format": "int32"
+ },
+ "exceedAction": {
+ "type": "string",
+ "description": "Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are \"deny(status)\", where valid values for status are 403, 404, 429, and 502, and \"redirect\" where the redirect parameters come from exceedRedirectOptions below."
+ },
+ "enforceOnKey": {
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "response": {
- "$ref": "Operation"
+ "description": "Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if \"enforceOnKey\" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. ",
+ "enum": [
+ "ALL",
+ "HTTP_COOKIE",
+ "HTTP_HEADER",
+ "HTTP_PATH",
+ "IP",
+ "REGION_CODE",
+ "SNI",
+ "XFF_IP"
+ ],
+ "type": "string"
+ },
+ "rateLimitThreshold": {
+ "$ref": "SecurityPolicyRuleRateLimitOptionsThreshold",
+ "description": "Threshold at which to begin ratelimiting."
+ },
+ "enforceOnKeyName": {
+ "type": "string",
+ "description": "Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value."
+ },
+ "banThreshold": {
+ "$ref": "SecurityPolicyRuleRateLimitOptionsThreshold",
+ "description": "Can only be specified if the action for the rule is \"rate_based_ban\". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'."
+ },
+ "exceedRedirectOptions": {
+ "$ref": "SecurityPolicyRuleRedirectOptions",
+ "description": "Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect."
+ }
+ },
+ "type": "object",
+ "id": "SecurityPolicyRuleRateLimitOptions"
+ },
+ "HttpRouteRuleMatch": {
+ "type": "object",
+ "description": "HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.",
+ "properties": {
+ "prefixMatch": {
+ "description": "For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.",
+ "type": "string"
+ },
+ "metadataFilters": {
+ "description": "Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.",
+ "type": "array",
+ "items": {
+ "$ref": "MetadataFilter"
+ }
+ },
+ "ignoreCase": {
+ "description": "Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to a target gRPC proxy.",
+ "type": "boolean"
+ },
+ "headerMatches": {
+ "type": "array",
+ "description": "Specifies a list of header match criteria, all of which must match corresponding headers in the request.",
+ "items": {
+ "$ref": "HttpHeaderMatch"
+ }
+ },
+ "regexMatch": {
+ "description": "For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For more information about regular expression syntax, see Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.",
+ "type": "string"
+ },
+ "queryParameterMatches": {
+ "description": "Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.",
+ "type": "array",
+ "items": {
+ "$ref": "HttpQueryParameterMatch"
+ }
+ },
+ "fullPathMatch": {
+ "description": "For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.",
+ "type": "string"
+ }
+ },
+ "id": "HttpRouteRuleMatch"
+ },
+ "CommitmentAggregatedList": {
+ "id": "CommitmentAggregatedList",
+ "properties": {
+ "items": {
+ "additionalProperties": {
+ "$ref": "CommitmentsScopedList",
+ "description": "[Output Only] Name of the scope containing this set of commitments."
},
- "parameterOrder": [
- "project",
- "region",
- "operation"
- ],
- "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ",
- "flatPath": "projects/{project}/regions/{region}/operations/{operation}/wait",
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/operations/{operation}/wait",
- "parameters": {
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region for this request.",
- "required": true,
- "type": "string",
- "location": "path"
+ "description": "A list of CommitmentsScopedList resources.",
+ "type": "object"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "kind": {
+ "default": "compute#commitmentAggregatedList",
+ "description": "[Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "type": "array"
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string"
},
- "operation": {
- "location": "path",
- "required": true,
- "description": "Name of the Operations resource to return.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
+ }
+ },
+ "unreachables": {
+ "description": "[Output Only] Unreachable resources.",
+ "items": {
+ "type": "string"
},
- "id": "compute.regionOperations.wait"
+ "type": "array"
}
- }
+ },
+ "type": "object"
},
- "snapshots": {
- "methods": {
- "get": {
- "flatPath": "projects/{project}/global/snapshots/{snapshot}",
- "description": "Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.",
- "id": "compute.snapshots.get",
- "parameterOrder": [
- "project",
- "snapshot"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "snapshot": {
- "description": "Name of the Snapshot resource to return.",
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "response": {
- "$ref": "Snapshot"
+ "VpnGatewayStatusVpnConnection": {
+ "id": "VpnGatewayStatusVpnConnection",
+ "type": "object",
+ "properties": {
+ "tunnels": {
+ "type": "array",
+ "items": {
+ "$ref": "VpnGatewayStatusTunnel"
},
- "path": "projects/{project}/global/snapshots/{snapshot}"
+ "description": "List of VPN tunnels that are in this VPN connection."
},
- "setLabels": {
- "parameterOrder": [
- "project",
- "resource"
- ],
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/global/snapshots/{resource}/setLabels",
- "path": "projects/{project}/global/snapshots/{resource}/setLabels",
- "request": {
- "$ref": "GlobalSetLabelsRequest"
- },
- "parameters": {
- "resource": {
- "description": "Name or id of the resource for this request.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path"
- }
+ "peerGcpGateway": {
+ "type": "string",
+ "description": "URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway."
+ },
+ "peerExternalGateway": {
+ "type": "string",
+ "description": "URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway."
+ },
+ "state": {
+ "description": "HighAvailabilityRequirementState for the VPN connection.",
+ "$ref": "VpnGatewayStatusHighAvailabilityRequirementState"
+ }
+ },
+ "description": "A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway."
+ },
+ "ServiceAttachment": {
+ "id": "ServiceAttachment",
+ "description": "Represents a ServiceAttachment resource. A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service. next tag = 20",
+ "type": "object",
+ "properties": {
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "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.",
+ "annotations": {
+ "required": [
+ "compute.serviceAttachments.insert"
+ ]
},
- "id": "compute.snapshots.setLabels",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation."
+ "type": "string"
},
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
+ "connectedEndpoints": {
+ "type": "array",
+ "items": {
+ "$ref": "ServiceAttachmentConnectedEndpoint"
},
- "id": "compute.snapshots.getIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/global/snapshots/{resource}/getIamPolicy",
- "flatPath": "projects/{project}/global/snapshots/{resource}/getIamPolicy",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "httpMethod": "GET",
- "parameters": {
- "resource": {
- "description": "Name or id of the resource for this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true
- },
- "optionsRequestedPolicyVersion": {
- "location": "query",
- "type": "integer",
- "description": "Requested IAM Policy version.",
- "format": "int32"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
+ "description": "[Output Only] An array of connections for all the consumers connected to this service attachment."
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.",
+ "format": "uint64"
+ },
+ "targetService": {
+ "type": "string",
+ "description": "The URL of a service serving the endpoint identified by this service attachment."
+ },
+ "producerForwardingRule": {
+ "description": "The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.",
+ "type": "string"
+ },
+ "consumerAcceptLists": {
+ "type": "array",
+ "items": {
+ "$ref": "ServiceAttachmentConsumerProjectLimit"
},
- "parameterOrder": [
- "project",
- "resource"
- ]
+ "description": "Projects that are allowed to connect to this service attachment."
},
- "delete": {
- "flatPath": "projects/{project}/global/snapshots/{snapshot}",
- "id": "compute.snapshots.delete",
- "parameterOrder": [
- "project",
- "snapshot"
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ },
+ "fingerprint": {
+ "description": "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.",
+ "format": "byte",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#serviceAttachment",
+ "description": "[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments."
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "pscServiceAttachmentId": {
+ "$ref": "Uint128",
+ "description": "[Output Only] An 128-bit global unique ID of the PSC service attachment."
+ },
+ "connectionPreference": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
],
- "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.",
- "path": "projects/{project}/global/snapshots/{snapshot}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "enum": [
+ "ACCEPT_AUTOMATIC",
+ "ACCEPT_MANUAL",
+ "CONNECTION_PREFERENCE_UNSPECIFIED"
],
- "httpMethod": "DELETE",
- "parameters": {
- "snapshot": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the Snapshot resource to delete.",
- "required": true,
- "location": "path"
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
+ "description": "The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules."
+ },
+ "consumerRejectLists": {
+ "items": {
+ "type": "string"
},
- "response": {
- "$ref": "Operation"
+ "description": "Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.",
+ "type": "array"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "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"
+ },
+ "natSubnets": {
+ "type": "array",
+ "description": "An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.",
+ "items": {
+ "type": "string"
}
+ }
+ }
+ },
+ "MachineImageList": {
+ "description": "A list of machine images.",
+ "id": "MachineImageList",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
},
- "testIamPermissions": {
- "request": {
- "$ref": "TestPermissionsRequest"
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "description": "A list of MachineImage resources.",
+ "items": {
+ "$ref": "MachineImage"
},
- "parameters": {
- "resource": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "array"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
"type": "string",
- "description": "Name or id of the resource for this request."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "project": {
+ "code": {
"type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
- },
- "id": "compute.snapshots.testIamPermissions",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/global/snapshots/{resource}/testIamPermissions",
- "flatPath": "projects/{project}/global/snapshots/{resource}/testIamPermissions",
- "parameterOrder": [
- "project",
- "resource"
- ],
- "httpMethod": "POST",
- "description": "Returns permissions that a caller has on the specified resource.",
- "response": {
- "$ref": "TestPermissionsResponse"
}
},
- "list": {
- "response": {
- "$ref": "SnapshotList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/global/snapshots",
- "id": "compute.snapshots.list",
- "httpMethod": "GET",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "default": "500",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ "kind": {
+ "default": "compute#machineImageList",
+ "type": "string",
+ "description": "[Output Only] The resource type, which is always compute#machineImagesListResponse for machine image lists."
+ }
+ }
+ },
+ "LicenseResourceCommitment": {
+ "properties": {
+ "amount": {
+ "description": "The number of licenses purchased.",
+ "type": "string",
+ "format": "int64"
+ },
+ "coresPerLicense": {
+ "type": "string",
+ "description": "Specifies the core range of the instance for which this license applies."
+ },
+ "license": {
+ "type": "string",
+ "description": "Any applicable license URI."
+ }
+ },
+ "type": "object",
+ "description": "Commitment for a particular license resource.",
+ "id": "LicenseResourceCommitment"
+ },
+ "InstanceGroupManagerStatusStateful": {
+ "type": "object",
+ "properties": {
+ "perInstanceConfigs": {
+ "$ref": "InstanceGroupManagerStatusStatefulPerInstanceConfigs",
+ "description": "[Output Only] Status of per-instance configurations on the instance."
+ },
+ "hasStatefulConfig": {
+ "type": "boolean",
+ "description": "[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions."
+ }
+ },
+ "id": "InstanceGroupManagerStatusStateful"
+ },
+ "RouterList": {
+ "description": "Contains a list of Router resources.",
+ "type": "object",
+ "id": "RouterList",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#router for routers.",
+ "default": "compute#routerList"
+ },
+ "warning": {
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
},
- "project": {
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "pageToken": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "path": "projects/{project}/global/snapshots",
- "description": "Retrieves the list of Snapshot resources contained within the specified project."
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
},
- "insert": {
- "path": "projects/{project}/global/snapshots",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Snapshot"
- },
- "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.",
- "id": "compute.snapshots.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "project": {
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
+ "items": {
+ "description": "A list of Router resources.",
+ "items": {
+ "$ref": "Router"
},
- "flatPath": "projects/{project}/global/snapshots",
- "httpMethod": "POST"
+ "type": "array"
},
- "setIamPolicy": {
- "parameters": {
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true
- },
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path",
- "description": "Name or id of the resource for this request.",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "id": "compute.snapshots.setIamPolicy",
- "httpMethod": "POST",
- "request": {
- "$ref": "GlobalSetPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "path": "projects/{project}/global/snapshots/{resource}/setIamPolicy",
- "parameterOrder": [
- "project",
- "resource"
- ],
- "flatPath": "projects/{project}/global/snapshots/{resource}/setIamPolicy"
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
}
}
},
- "nodeTypes": {
- "methods": {
- "get": {
- "parameters": {
- "nodeType": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "required": true,
- "description": "Name of the node type to return.",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "zone": {
- "description": "The name of the zone for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "id": "compute.nodeTypes.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "NetworkPerformanceConfig": {
+ "id": "NetworkPerformanceConfig",
+ "properties": {
+ "totalEgressBandwidthTier": {
+ "enum": [
+ "DEFAULT",
+ "TIER_1"
],
- "response": {
- "$ref": "NodeType"
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "NodeTemplate": {
+ "type": "object",
+ "id": "NodeTemplate",
+ "properties": {
+ "nodeTypeFlexibility": {
+ "description": "The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both.",
+ "$ref": "NodeTemplateNodeTypeFlexibility"
+ },
+ "accelerators": {
+ "items": {
+ "$ref": "AcceleratorConfig"
},
- "path": "projects/{project}/zones/{zone}/nodeTypes/{nodeType}",
- "description": "Returns the specified node type. Gets a list of available node types by making a list() request.",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "zone",
- "nodeType"
- ],
- "flatPath": "projects/{project}/zones/{zone}/nodeTypes/{nodeType}"
+ "type": "array"
},
- "aggregatedList": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Retrieves an aggregated list of node types.",
- "parameters": {
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "type": "boolean",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
- },
- "maxResults": {
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "minimum": "0",
- "type": "integer",
- "location": "query"
- }
+ "serverBinding": {
+ "description": "Sets the binding properties for the physical server. Valid values include: - *[Default]* RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information.",
+ "$ref": "ServerBinding"
+ },
+ "statusMessage": {
+ "description": "[Output Only] An optional, human-readable explanation of the status.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "nodeType": {
+ "description": "The node type to use for nodes group that are created from this template.",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] The name of the region where the node template resides, such as us-central1."
+ },
+ "kind": {
+ "description": "[Output Only] The type of the resource. Always compute#nodeTemplate for node templates.",
+ "type": "string",
+ "default": "compute#nodeTemplate"
+ },
+ "disks": {
+ "items": {
+ "$ref": "LocalDisk"
},
- "httpMethod": "GET",
- "response": {
- "$ref": "NodeTypeAggregatedList"
+ "type": "array"
+ },
+ "nodeAffinityLabels": {
+ "description": "Labels to use for node affinity, which will be used in instance scheduling.",
+ "additionalProperties": {
+ "type": "string"
},
- "parameterOrder": [
- "project"
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "enumDescriptions": [
+ "Resources are being allocated.",
+ "The node template is currently being deleted.",
+ "Invalid status.",
+ "The node template is ready."
],
- "id": "compute.nodeTypes.aggregatedList",
- "path": "projects/{project}/aggregated/nodeTypes",
- "flatPath": "projects/{project}/aggregated/nodeTypes"
+ "enum": [
+ "CREATING",
+ "DELETING",
+ "INVALID",
+ "READY"
+ ],
+ "description": "[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING."
},
- "list": {
- "flatPath": "projects/{project}/zones/{zone}/nodeTypes",
- "description": "Retrieves a list of node types available to the specified project.",
- "parameters": {
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "required": true,
- "location": "path",
- "type": "string"
+ "cpuOvercommitType": {
+ "type": "string",
+ "description": "CPU overcommit.",
+ "enum": [
+ "CPU_OVERCOMMIT_TYPE_UNSPECIFIED",
+ "ENABLED",
+ "NONE"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
+ },
+ "name": {
+ "description": "The name of the resource, provided by the client when initially creating the resource. The resource 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.",
+ "type": "string"
+ }
+ },
+ "description": "Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances."
+ },
+ "RegionInstanceGroupManagersListInstanceConfigsResp": {
+ "type": "object",
+ "id": "RegionInstanceGroupManagersListInstanceConfigsResp",
+ "properties": {
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "orderBy": {
+ "code": {
"type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "format": "uint32",
- "location": "query",
- "default": "500",
- "minimum": "0"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
},
- "path": "projects/{project}/zones/{zone}/nodeTypes",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "zone"
- ],
- "httpMethod": "GET",
- "id": "compute.nodeTypes.list",
- "response": {
- "$ref": "NodeTypeList"
- }
+ "type": "object"
+ },
+ "items": {
+ "items": {
+ "$ref": "PerInstanceConfig"
+ },
+ "description": "[Output Only] The list of PerInstanceConfig.",
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
}
}
},
- "backendBuckets": {
- "methods": {
- "addSignedUrlKey": {
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
+ "LicensesListResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "License"
},
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
+ "description": "A list of License resources."
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "location": "path"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ }
},
- "backendBucket": {
- "required": true,
+ "message": {
"type": "string",
- "description": "Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.",
- "location": "path"
+ "description": "[Output Only] A human-readable description of the warning code."
}
+ }
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ }
+ },
+ "id": "LicensesListResponse"
+ },
+ "UrlMapValidationResult": {
+ "description": "Message representing the validation result for a UrlMap.",
+ "id": "UrlMapValidationResult",
+ "type": "object",
+ "properties": {
+ "loadErrors": {
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Adds a key for validating requests with signed URLs for this backend bucket.",
- "id": "compute.backendBuckets.addSignedUrlKey",
- "path": "projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey",
- "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey",
- "request": {
- "$ref": "SignedUrlKey"
+ "type": "array"
+ },
+ "loadSucceeded": {
+ "description": "Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.",
+ "type": "boolean"
+ },
+ "testPassed": {
+ "description": "If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.",
+ "type": "boolean"
+ },
+ "testFailures": {
+ "items": {
+ "$ref": "TestFailure"
},
- "parameterOrder": [
- "project",
- "backendBucket"
- ]
+ "type": "array"
+ }
+ }
+ },
+ "LicenseCode": {
+ "type": "object",
+ "id": "LicenseCode",
+ "description": "Represents a License Code resource. A License Code is a unique identifier used to represent a license resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
+ "properties": {
+ "licenseAlias": {
+ "type": "array",
+ "items": {
+ "$ref": "LicenseCodeLicenseAlias"
+ },
+ "description": "[Output Only] URL and description aliases of Licenses with the same License Code."
},
- "delete": {
- "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "name": {
+ "description": "[Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.",
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.licenses.insert"
+ ]
+ },
+ "pattern": "[0-9]{0,20}?"
+ },
+ "description": {
+ "description": "[Output Only] Description of this License Code.",
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enumDescriptions": [
+ "Machines are not allowed to attach boot disks with this License Code. Requests to create new resources with this license will be rejected.",
+ "Use is allowed for anyone with USE_READ_ONLY access to this License Code.",
+ "Use of this license is limited to a project whitelist.",
+ "",
+ "Reserved state."
],
- "id": "compute.backendBuckets.delete",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "project",
- "backendBucket"
+ "description": "[Output Only] Current state of this License Code.",
+ "enum": [
+ "DISABLED",
+ "ENABLED",
+ "RESTRICTED",
+ "STATE_UNSPECIFIED",
+ "TERMINATED"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "transferable": {
+ "description": "[Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#licenseCode for licenses.",
+ "default": "compute#licenseCode",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ }
+ }
+ },
+ "CircuitBreakers": {
+ "id": "CircuitBreakers",
+ "description": "Settings controlling the volume of requests, connections and retries to this backend service.",
+ "type": "object",
+ "properties": {
+ "maxConnections": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true."
+ },
+ "maxRequests": {
+ "format": "int32",
+ "description": "The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.",
+ "type": "integer"
+ },
+ "maxRetries": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true."
+ },
+ "maxRequestsPerConnection": {
+ "format": "int32",
+ "type": "integer",
+ "description": "Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true."
+ },
+ "maxPendingRequests": {
+ "type": "integer",
+ "description": "The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
+ "format": "int32"
+ }
+ }
+ },
+ "ExchangedPeeringRoute": {
+ "properties": {
+ "imported": {
+ "type": "boolean",
+ "description": "True if the peering route has been imported from a peer. The actual import happens if the field networkPeering.importCustomRoutes is true for this network, and networkPeering.exportCustomRoutes is true for the peer network, and the import does not result in a route conflict."
+ },
+ "destRange": {
+ "description": "The destination range of the route.",
+ "type": "string"
+ },
+ "priority": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The priority of the peering route."
+ },
+ "nextHopRegion": {
+ "type": "string",
+ "description": "The region of peering route next hop, only applies to dynamic routes."
+ },
+ "type": {
+ "enumDescriptions": [
+ "For routes exported from local network.",
+ "The peering route.",
+ "The peering route corresponding to subnetwork range."
],
- "response": {
- "$ref": "Operation"
+ "description": "The type of the peering route.",
+ "type": "string",
+ "enum": [
+ "DYNAMIC_PEERING_ROUTE",
+ "STATIC_PEERING_ROUTE",
+ "SUBNET_PEERING_ROUTE"
+ ]
+ }
+ },
+ "id": "ExchangedPeeringRoute",
+ "type": "object"
+ },
+ "UrlMapTest": {
+ "id": "UrlMapTest",
+ "description": "Message for the expected URL mappings.",
+ "properties": {
+ "headers": {
+ "items": {
+ "$ref": "UrlMapTestHeader"
},
- "path": "projects/{project}/global/backendBuckets/{backendBucket}",
- "description": "Deletes the specified BackendBucket resource.",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "backendBucket": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name of the BackendBucket resource to delete.",
- "type": "string",
- "location": "path"
- }
+ "type": "array",
+ "description": "HTTP headers for this request. If headers contains a host header, then host must also match the header value."
+ },
+ "path": {
+ "type": "string",
+ "description": "Path portion of the URL."
+ },
+ "host": {
+ "type": "string",
+ "description": "Host portion of the URL. If headers contains a host header, then host must also match the header value."
+ },
+ "expectedOutputUrl": {
+ "type": "string",
+ "description": "The expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by the load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to HTTPS. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified."
+ },
+ "description": {
+ "description": "Description of this test case.",
+ "type": "string"
+ },
+ "expectedRedirectResponseCode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set."
+ },
+ "service": {
+ "description": "Expected BackendService or BackendBucket resource the given URL should be mapped to. The service field cannot be set if expectedRedirectResponseCode is set.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TargetInstanceList": {
+ "id": "TargetInstanceList",
+ "properties": {
+ "items": {
+ "description": "A list of TargetInstance resources.",
+ "type": "array",
+ "items": {
+ "$ref": "TargetInstance"
}
},
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/global/backendBuckets",
- "description": "Retrieves the list of BackendBucket resources available to the specified project.",
- "parameters": {
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "format": "uint32",
- "default": "500",
- "location": "query",
- "type": "integer"
- },
- "filter": {
- "location": "query",
+ "warning": {
+ "properties": {
+ "code": {
"type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
+ "data": {
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
- "response": {
- "$ref": "BackendBucketList"
- },
- "id": "compute.backendBuckets.list",
- "path": "projects/{project}/global/backendBuckets",
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
},
- "insert": {
- "id": "compute.backendBuckets.insert",
- "request": {
- "$ref": "BackendBucket"
- },
- "path": "projects/{project}/global/backendBuckets",
- "description": "Creates a BackendBucket resource in the specified project using the data included in the request.",
- "parameterOrder": [
- "project"
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Type of resource.",
+ "default": "compute#targetInstanceList",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "type": "object",
+ "description": "Contains a list of TargetInstance resources."
+ },
+ "TCPHealthCheck": {
+ "type": "object",
+ "id": "TCPHealthCheck",
+ "properties": {
+ "portName": {
+ "description": "Not supported.",
+ "type": "string"
+ },
+ "request": {
+ "type": "string",
+ "description": "Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection."
+ },
+ "portSpecification": {
+ "type": "string",
+ "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.",
+ "enum": [
+ "USE_FIXED_PORT",
+ "USE_NAMED_PORT",
+ "USE_SERVING_PORT"
],
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- }
- },
- "flatPath": "projects/{project}/global/backendBuckets",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
+ "Not supported.",
+ "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
]
},
- "get": {
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "backendBucket": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "location": "path",
- "description": "Name of the BackendBucket resource to return."
- }
- },
- "id": "compute.backendBuckets.get",
- "description": "Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.",
- "parameterOrder": [
- "project",
- "backendBucket"
+ "response": {
+ "description": "Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp",
+ "type": "string"
+ },
+ "port": {
+ "description": "The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "proxyHeader": {
+ "enum": [
+ "NONE",
+ "PROXY_V1"
],
- "response": {
- "$ref": "BackendBucket"
- },
- "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}",
- "path": "projects/{project}/global/backendBuckets/{backendBucket}",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ ""
]
+ }
+ }
+ },
+ "PacketMirroringMirroredResourceInfoSubnetInfo": {
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored."
},
- "deleteSignedUrlKey": {
- "description": "Deletes a key for validating requests with signed URLs for this backend bucket.",
- "path": "projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey",
- "parameters": {
- "keyName": {
- "description": "The name of the Signed URL Key to delete.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "backendBucket": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035."
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
+ "canonicalUrl": {
+ "description": "[Output Only] Unique identifier for the subnetwork; defined by the server.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "PacketMirroringMirroredResourceInfoSubnetInfo"
+ },
+ "NetworkEndpointGroupsScopedList": {
+ "type": "object",
+ "properties": {
+ "warning": {
+ "description": "[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "project",
- "backendBucket",
- "keyName"
- ],
- "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.backendBuckets.deleteSignedUrlKey",
- "httpMethod": "POST"
- },
- "patch": {
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "backendBucket": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the BackendBucket resource to patch.",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "required": true,
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
- },
- "path": "projects/{project}/global/backendBuckets/{backendBucket}",
- "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}",
- "description": "Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "parameterOrder": [
- "project",
- "backendBucket"
- ],
- "id": "compute.backendBuckets.patch",
- "request": {
- "$ref": "BackendBucket"
}
},
- "setEdgeSecurityPolicy": {
- "httpMethod": "POST",
- "parameters": {
- "requestId": {
- "type": "string",
- "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"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "description": "Project ID for this request."
- },
- "backendBucket": {
- "required": true,
- "description": "Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.",
- "type": "string",
- "location": "path"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "backendBucket"
- ],
- "id": "compute.backendBuckets.setEdgeSecurityPolicy",
- "request": {
- "$ref": "SecurityPolicyReference"
+ "networkEndpointGroups": {
+ "items": {
+ "$ref": "NetworkEndpointGroup"
},
- "description": "Sets the edge security policy for the specified backend bucket.",
- "path": "projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy",
- "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "type": "array",
+ "description": "[Output Only] The list of network endpoint groups that are contained in this scope."
+ }
+ },
+ "id": "NetworkEndpointGroupsScopedList"
+ },
+ "MachineImage": {
+ "description": "Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.",
+ "type": "object",
+ "properties": {
+ "sourceInstance": {
+ "type": "string",
+ "description": "The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance "
},
- "update": {
- "id": "compute.backendBuckets.update",
- "request": {
- "$ref": "BackendBucket"
- },
- "response": {
- "$ref": "Operation"
+ "machineImageEncryptionKey": {
+ "$ref": "CustomerEncryptionKey",
+ "description": "Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later."
+ },
+ "kind": {
+ "description": "[Output Only] The resource type, which is always compute#machineImage for machine image.",
+ "default": "compute#machineImage",
+ "type": "string"
+ },
+ "sourceDiskEncryptionKeys": {
+ "type": "array",
+ "items": {
+ "$ref": "SourceDiskEncryptionKey"
},
- "path": "projects/{project}/global/backendBuckets/{backendBucket}",
- "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}",
- "parameters": {
- "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).",
- "type": "string",
- "location": "query"
- },
- "backendBucket": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the BackendBucket resource to update.",
- "required": true,
- "location": "path"
- },
- "project": {
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- }
+ "description": "[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key."
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "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.",
+ "annotations": {
+ "required": [
+ "compute.machineImages.insert"
+ ]
+ }
+ },
+ "savedDisks": {
+ "description": "An array of Machine Image specific properties for disks attached to the source instance",
+ "items": {
+ "$ref": "SavedDisk"
},
- "parameterOrder": [
- "project",
- "backendBucket"
+ "type": "array"
+ },
+ "selfLink": {
+ "description": "[Output Only] The URL for this machine image. The server defines this URL.",
+ "type": "string"
+ },
+ "satisfiesPzs": {
+ "description": "[Output Only] Reserved for future use.",
+ "type": "boolean"
+ },
+ "totalStorageBytes": {
+ "type": "string",
+ "format": "int64",
+ "description": "[Output Only] Total size of the storage used by the machine image."
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "storageLocations": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "The regional or multi-regional Cloud Storage bucket location where the machine image is stored."
+ },
+ "instanceProperties": {
+ "description": "[Output Only] Properties of source instance",
+ "$ref": "InstanceProperties"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] A unique identifier for this machine image. The server defines this identifier.",
+ "format": "uint64"
+ },
+ "status": {
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "enum": [
+ "CREATING",
+ "DELETING",
+ "INVALID",
+ "READY",
+ "UPLOADING"
],
- "description": "Updates the specified BackendBucket resource with the data included in the request.",
- "httpMethod": "PUT"
+ "description": "[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING."
+ },
+ "guestFlush": {
+ "description": "[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.",
+ "type": "boolean"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] The creation timestamp for this machine image in RFC3339 text format."
+ },
+ "sourceInstanceProperties": {
+ "$ref": "SourceInstanceProperties",
+ "description": "[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field."
}
- }
+ },
+ "id": "MachineImage"
},
- "instanceGroups": {
- "methods": {
- "setNamedPorts": {
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "LogConfigCloudAuditOptions": {
+ "id": "LogConfigCloudAuditOptions",
+ "properties": {
+ "logName": {
+ "enum": [
+ "ADMIN_ACTIVITY",
+ "DATA_ACCESS",
+ "UNSPECIFIED_LOG_NAME"
],
- "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts",
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "zone": {
- "description": "The name of the zone where the instance group is located.",
- "location": "path",
- "type": "string",
- "required": true
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "instanceGroup": {
- "location": "path",
- "description": "The name of the instance group where the named ports are updated.",
- "required": true,
- "type": "string"
- }
- },
- "id": "compute.instanceGroups.setNamedPorts",
- "httpMethod": "POST",
- "description": "Sets the named ports for the specified instance group.",
- "request": {
- "$ref": "InstanceGroupsSetNamedPortsRequest"
- }
+ "type": "string",
+ "description": "This is deprecated and has no effect. Do not use.",
+ "enumDescriptions": [
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use."
+ ]
},
- "insert": {
- "request": {
- "$ref": "InstanceGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "zone": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the zone where you want to create the instance group."
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
- },
- "flatPath": "projects/{project}/zones/{zone}/instanceGroups",
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "zone"
+ "authorizationLoggingOptions": {
+ "$ref": "AuthorizationLoggingOptions",
+ "description": "This is deprecated and has no effect. Do not use."
+ }
+ },
+ "description": "This is deprecated and has no effect. Do not use.",
+ "type": "object"
+ },
+ "RouterNatRule": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "An optional description of this rule."
+ },
+ "ruleNumber": {
+ "description": "An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "action": {
+ "$ref": "RouterNatRuleAction",
+ "description": "The action to be enforced for traffic that matches this rule."
+ },
+ "match": {
+ "type": "string",
+ "description": "CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: \"inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')\" \"destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'\" The following example is a valid match expression for private NAT: \"nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'\""
+ }
+ },
+ "id": "RouterNatRule"
+ },
+ "AcceleratorType": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] The type of the resource. Always compute#acceleratorType for accelerator types.",
+ "default": "compute#acceleratorType"
+ },
+ "description": {
+ "type": "string",
+ "description": "[Output Only] An optional textual description of the resource."
+ },
+ "deprecated": {
+ "$ref": "DeprecationStatus",
+ "description": "[Output Only] The deprecation status associated with this accelerator type."
+ },
+ "maximumCardsPerInstance": {
+ "type": "integer",
+ "description": "[Output Only] Maximum number of accelerator cards allowed per instance.",
+ "format": "int32"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined, fully qualified URL for this resource."
+ },
+ "name": {
+ "type": "string",
+ "description": "[Output Only] Name of the resource.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "zone": {
+ "description": "[Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. 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"
+ },
+ "id": {
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ }
+ },
+ "description": "Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine.",
+ "id": "AcceleratorType",
+ "type": "object"
+ },
+ "InterconnectAttachment": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "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. ",
+ "enumDescriptions": [
+ "Attachment to a dedicated interconnect.",
+ "Attachment to a partner interconnect, created by the customer.",
+ "Attachment to a partner interconnect, created by the partner."
],
- "path": "projects/{project}/zones/{zone}/instanceGroups",
- "description": "Creates an instance group in the specified project using the parameters that are included in the request.",
- "id": "compute.instanceGroups.insert",
- "response": {
- "$ref": "Operation"
- }
+ "enum": [
+ "DEDICATED",
+ "PARTNER",
+ "PARTNER_PROVIDER"
+ ]
},
- "list": {
- "parameters": {
- "maxResults": {
- "default": "500",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "minimum": "0",
- "location": "query"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "zone": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "The name of the zone where the instance group is located."
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
- }
- },
- "description": "Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "satisfiesPzs": {
+ "type": "boolean",
+ "description": "[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."
+ },
+ "dataplaneVersion": {
+ "description": "[Output Only] 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",
+ "type": "integer"
+ },
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "edgeAvailabilityDomain": {
+ "enum": [
+ "AVAILABILITY_DOMAIN_1",
+ "AVAILABILITY_DOMAIN_2",
+ "AVAILABILITY_DOMAIN_ANY"
],
- "parameterOrder": [
- "project",
- "zone"
+ "enumDescriptions": [
+ "",
+ "",
+ ""
],
- "httpMethod": "GET",
- "response": {
- "$ref": "InstanceGroupList"
- },
- "flatPath": "projects/{project}/zones/{zone}/instanceGroups",
- "id": "compute.instanceGroups.list",
- "path": "projects/{project}/zones/{zone}/instanceGroups"
+ "description": "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.",
+ "type": "string"
},
- "listInstances": {
- "response": {
- "$ref": "InstanceGroupsListInstances"
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource."
+ },
+ "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": {
+ "type": "string"
},
- "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances",
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
+ "type": "array"
+ },
+ "mtu": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440."
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "router": {
+ "type": "string",
+ "description": "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."
+ },
+ "adminEnabled": {
+ "type": "boolean",
+ "description": "Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER."
+ },
+ "stackType": {
+ "type": "string",
+ "enumDescriptions": [
+ "The interconnect attachment can have both IPv4 and IPv6 addresses.",
+ "The interconnect attachment will only be assigned IPv4 addresses."
],
- "description": "Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use `eq` (equal) or `ne` (not equal) operators.",
- "request": {
- "$ref": "InstanceGroupsListInstancesRequest"
- },
- "parameters": {
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "location": "path",
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "required": true
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "instanceGroup": {
- "type": "string",
- "required": true,
- "description": "The name of the instance group from which you want to generate a list of included instances.",
- "location": "path"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query"
- },
- "maxResults": {
- "format": "uint32",
- "location": "query",
- "type": "integer",
- "minimum": "0",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- }
- },
- "id": "compute.instanceGroups.listInstances",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "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"
+ ]
+ },
+ "bandwidth": {
+ "enumDescriptions": [
+ "100 Mbit/s",
+ "10 Gbit/s",
+ "1 Gbit/s",
+ "200 Mbit/s",
+ "20 Gbit/s",
+ "2 Gbit/s",
+ "300 Mbit/s",
+ "400 Mbit/s",
+ "500 Mbit/s",
+ "50 Gbit/s",
+ "50 Mbit/s",
+ "5 Gbit/s"
],
- "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances"
+ "description": "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 ",
+ "type": "string",
+ "enum": [
+ "BPS_100M",
+ "BPS_10G",
+ "BPS_1G",
+ "BPS_200M",
+ "BPS_20G",
+ "BPS_2G",
+ "BPS_300M",
+ "BPS_400M",
+ "BPS_500M",
+ "BPS_50G",
+ "BPS_50M",
+ "BPS_5G"
+ ]
},
- "delete": {
- "description": "Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request."
- },
- "zone": {
- "required": true,
- "type": "string",
- "description": "The name of the zone where the instance group is located.",
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "instanceGroup": {
- "required": true,
- "type": "string",
- "description": "The name of the instance group to delete.",
- "location": "path"
- }
+ "cloudRouterIpv6Address": {
+ "description": "[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.",
+ "type": "string"
+ },
+ "customerRouterIpv6Address": {
+ "type": "string",
+ "description": "[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment."
+ },
+ "kind": {
+ "default": "compute#interconnectAttachment",
+ "description": "[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.",
+ "type": "string"
+ },
+ "name": {
+ "description": "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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "pairingKey": {
+ "type": "string",
+ "description": "[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form \"XXXXX/region/domain\""
+ },
+ "interconnect": {
+ "description": "URL of the underlying Interconnect object that this attachment's traffic will traverse through.",
+ "type": "string"
+ },
+ "ipsecInternalAddresses": {
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- "httpMethod": "DELETE",
- "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
+ "type": "array",
+ "description": "A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool. Not currently available publicly. "
+ },
+ "operationalStatus": {
+ "enumDescriptions": [
+ "Indicates that attachment has been turned up and is ready to use.",
+ "Indicates that attachment is not ready to use yet, because turnup is not complete."
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "string",
+ "enum": [
+ "OS_ACTIVE",
+ "OS_UNPROVISIONED"
],
- "id": "compute.instanceGroups.delete"
+ "description": "[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. "
},
- "addInstances": {
- "id": "compute.instanceGroups.addInstances",
- "parameters": {
- "zone": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "The name of the zone where the instance group is located."
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
- },
- "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).",
- "type": "string",
- "location": "query"
- },
- "instanceGroup": {
- "required": true,
- "description": "The name of the instance group where you are adding instances.",
- "location": "path",
- "type": "string"
- }
- },
- "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "privateInterconnectInfo": {
+ "$ref": "InterconnectAttachmentPrivateInfo",
+ "description": "[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED."
+ },
+ "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. ",
+ "enumDescriptions": [
+ "Indicates that attachment has been turned up and is ready to use.",
+ "The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was wiped out, or because the other side of a Partner attachment was deleted.",
+ "A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.",
+ "PARTNER or PARTNER_PROVIDER attachment that is waiting for the customer to activate.",
+ "A newly created PARTNER attachment that has not yet been configured on the Partner side.",
+ "",
+ "Indicates that attachment is not ready to use yet, because turnup is not complete."
],
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
+ "enum": [
+ "ACTIVE",
+ "DEFUNCT",
+ "PARTNER_REQUEST_RECEIVED",
+ "PENDING_CUSTOMER",
+ "PENDING_PARTNER",
+ "STATE_UNSPECIFIED",
+ "UNPROVISIONED"
],
- "description": "Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.",
- "httpMethod": "POST",
- "request": {
- "$ref": "InstanceGroupsAddInstancesRequest"
+ "type": "string"
+ },
+ "cloudRouterIpAddress": {
+ "description": "[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.",
+ "type": "string"
+ },
+ "region": {
+ "description": "[Output Only] URL of the region where the regional interconnect attachment 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"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "customerRouterIpv6InterfaceId": {
+ "type": "string",
+ "description": "This field is not available."
+ },
+ "partnerAsn": {
+ "description": "Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.",
+ "type": "string",
+ "format": "int64"
+ },
+ "cloudRouterIpv6InterfaceId": {
+ "description": "This field is not available.",
+ "type": "string"
+ },
+ "encryption": {
+ "enum": [
+ "IPSEC",
+ "NONE"
+ ],
+ "enumDescriptions": [
+ "The interconnect attachment will carry only encrypted traffic that is encrypted by an IPsec device such as HA VPN gateway; VMs cannot directly send traffic to or receive traffic from such an interconnect attachment. To use HA VPN over Cloud Interconnect, the interconnect attachment must be created with this option.",
+ "This is the default value, which means the Interconnect Attachment will carry unencrypted traffic. VMs will be able to send traffic to or receive traffic from such interconnect attachment."
+ ],
+ "description": "Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option. ",
+ "type": "string"
+ },
+ "googleReferenceId": {
+ "type": "string",
+ "description": "[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used."
+ },
+ "partnerMetadata": {
+ "$ref": "InterconnectAttachmentPartnerMetadata",
+ "description": "Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED."
+ },
+ "vlanTag8021q": {
+ "format": "int32",
+ "description": "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.",
+ "type": "integer"
+ },
+ "candidateIpv6Subnets": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances",
- "response": {
- "$ref": "Operation"
+ "type": "array",
+ "description": "This field is not available."
+ },
+ "customerRouterIpAddress": {
+ "type": "string",
+ "description": "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment."
+ }
+ },
+ "type": "object",
+ "description": "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.",
+ "id": "InterconnectAttachment"
+ },
+ "RouterAggregatedList": {
+ "id": "RouterAggregatedList",
+ "type": "object",
+ "description": "Contains a list of routers.",
+ "properties": {
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Type of resource.",
+ "default": "compute#routerAggregatedList",
+ "type": "string"
+ },
+ "unreachables": {
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
},
- "aggregatedList": {
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "maxResults": {
- "location": "query",
- "type": "integer",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "minimum": "0"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "additionalProperties": {
+ "$ref": "RoutersScopedList",
+ "description": "Name of the scope containing this set of routers."
+ },
+ "type": "object",
+ "description": "A list of Router resources."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "pageToken": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "includeAllScopes": {
- "type": "boolean",
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
}
},
- "httpMethod": "GET",
- "description": "Retrieves the list of instance groups and sorts them by zone.",
- "id": "compute.instanceGroups.aggregatedList",
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/aggregated/instanceGroups",
- "path": "projects/{project}/aggregated/instanceGroups",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "InstanceGroupAggregatedList"
+ "type": "object"
+ }
+ }
+ },
+ "HttpRouteRule": {
+ "id": "HttpRouteRule",
+ "type": "object",
+ "properties": {
+ "matchRules": {
+ "items": {
+ "$ref": "HttpRouteRuleMatch"
+ },
+ "type": "array",
+ "description": "The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule."
+ },
+ "headerAction": {
+ "$ref": "HttpHeaderAction",
+ "description": "Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true."
+ },
+ "description": {
+ "type": "string",
+ "description": "The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters."
+ },
+ "routeAction": {
+ "$ref": "HttpRouteAction",
+ "description": "In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction."
+ },
+ "service": {
+ "type": "string",
+ "description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set."
+ },
+ "priority": {
+ "description": "For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "urlRedirect": {
+ "description": "When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.",
+ "$ref": "HttpRedirectAction"
+ }
+ },
+ "description": "The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform."
+ },
+ "NetworkAttachmentsScopedList": {
+ "properties": {
+ "networkAttachments": {
+ "type": "array",
+ "description": "A list of NetworkAttachments contained in this scope.",
+ "items": {
+ "$ref": "NetworkAttachment"
}
},
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "InstanceGroup"
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "required": true,
- "description": "The name of the instance group.",
- "location": "path"
+ "warning": {
+ "type": "object",
+ "description": "Informational warning which replaces the list of network attachments when the list is empty.",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "zone": {
- "required": true,
- "description": "The name of the zone where the instance group is located.",
- "location": "path",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string"
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "required": true
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
+ }
+ }
+ },
+ "id": "NetworkAttachmentsScopedList",
+ "type": "object"
+ },
+ "TargetPoolList": {
+ "type": "object",
+ "id": "TargetPoolList",
+ "description": "Contains a list of TargetPool resources.",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "TargetPool"
},
- "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}",
- "id": "compute.instanceGroups.get",
- "description": "Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead."
+ "description": "A list of TargetPool resources."
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.",
+ "default": "compute#targetPoolList"
},
- "removeInstances": {
- "id": "compute.instanceGroups.removeInstances",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroup"
- ],
- "parameters": {
- "instanceGroup": {
- "type": "string",
- "location": "path",
- "description": "The name of the instance group where the specified instances will be removed.",
- "required": true
- },
- "zone": {
- "location": "path",
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
"type": "string",
- "required": true,
- "description": "The name of the zone where the instance group is located."
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "project": {
+ "message": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "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).",
- "location": "query",
- "type": "string"
+ "data": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
},
- "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
- "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
- "response": {
- "$ref": "Operation"
- },
- "description": "Removes one or more instances from the specified instance group, but does not delete those instances. 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 before the VM instance is removed or deleted.",
- "request": {
- "$ref": "InstanceGroupsRemoveInstancesRequest"
- }
+ "type": "object"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
}
}
},
- "regionAutoscalers": {
- "methods": {
- "insert": {
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "required": true,
- "description": "Name of the region scoping this request.",
- "type": "string"
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region"
- ],
- "path": "projects/{project}/regions/{region}/autoscalers",
- "request": {
- "$ref": "Autoscaler"
+ "NetworkEndpointGroupsAttachEndpointsRequest": {
+ "type": "object",
+ "properties": {
+ "networkEndpoints": {
+ "description": "The list of network endpoints to be attached.",
+ "items": {
+ "$ref": "NetworkEndpoint"
},
- "description": "Creates an autoscaler in the specified project using the data included in the request.",
- "flatPath": "projects/{project}/regions/{region}/autoscalers",
- "id": "compute.regionAutoscalers.insert",
- "httpMethod": "POST"
+ "type": "array"
+ }
+ },
+ "id": "NetworkEndpointGroupsAttachEndpointsRequest"
+ },
+ "InstanceGroupManagersDeleteInstancesRequest": {
+ "id": "InstanceGroupManagersDeleteInstancesRequest",
+ "type": "object",
+ "properties": {
+ "skipInstancesOnValidationError": {
+ "type": "boolean",
+ "description": "Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region."
},
- "list": {
- "parameterOrder": [
- "project",
- "region"
- ],
- "id": "compute.regionAutoscalers.list",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/regions/{region}/autoscalers",
- "response": {
- "$ref": "RegionAutoscalerList"
+ "instances": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "description": "Retrieves a list of autoscalers contained within the specified region.",
- "path": "projects/{project}/regions/{region}/autoscalers",
- "httpMethod": "GET",
- "parameters": {
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "maxResults": {
- "type": "integer",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "location": "query",
- "default": "500"
- },
- "region": {
- "location": "path",
- "required": true,
- "description": "Name of the region scoping this request.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]."
+ }
+ }
+ },
+ "VmEndpointNatMappingsList": {
+ "properties": {
+ "result": {
+ "description": "[Output Only] A list of Nat mapping information of VM endpoints.",
+ "type": "array",
+ "items": {
+ "$ref": "VmEndpointNatMappings"
+ }
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string"
},
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
- },
- "pageToken": {
+ "message": {
"type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
}
}
},
- "get": {
- "path": "projects/{project}/regions/{region}/autoscalers/{autoscaler}",
- "httpMethod": "GET",
- "parameters": {
- "region": {
- "description": "Name of the region scoping this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints.",
+ "default": "compute#vmEndpointNatMappingsList"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "id": "VmEndpointNatMappingsList",
+ "description": "Contains a list of VmEndpointNatMappings.",
+ "type": "object"
+ },
+ "ExchangedPeeringRoutesList": {
+ "type": "object",
+ "properties": {
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "message": {
"type": "string",
- "description": "Project ID for this request.",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "autoscaler": {
- "description": "Name of the autoscaler to return.",
- "location": "path",
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ }
+ },
+ "code": {
"type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "parameterOrder": [
- "project",
- "region",
- "autoscaler"
- ],
- "id": "compute.regionAutoscalers.get",
- "description": "Returns the specified autoscaler.",
- "flatPath": "projects/{project}/regions/{region}/autoscalers/{autoscaler}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "response": {
- "$ref": "Autoscaler"
+ "type": "object"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "type": "array",
+ "description": "A list of ExchangedPeeringRoute resources.",
+ "items": {
+ "$ref": "ExchangedPeeringRoute"
}
},
- "delete": {
- "parameters": {
- "region": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "location": "path"
- },
- "autoscaler": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the autoscaler to delete.",
- "location": "path",
- "type": "string",
- "required": true
- },
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists.",
+ "default": "compute#exchangedPeeringRoutesList",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ }
+ },
+ "id": "ExchangedPeeringRoutesList"
+ },
+ "CorsPolicy": {
+ "type": "object",
+ "id": "CorsPolicy",
+ "properties": {
+ "maxAge": {
+ "format": "int32",
+ "type": "integer",
+ "description": "Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header."
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect."
+ },
+ "allowOrigins": {
+ "items": {
+ "type": "string"
},
- "description": "Deletes the specified autoscaler.",
- "flatPath": "projects/{project}/regions/{region}/autoscalers/{autoscaler}",
- "httpMethod": "DELETE",
- "path": "projects/{project}/regions/{region}/autoscalers/{autoscaler}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "region",
- "autoscaler"
- ],
- "id": "compute.regionAutoscalers.delete",
- "response": {
- "$ref": "Operation"
+ "type": "array",
+ "description": "Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes."
+ },
+ "allowCredentials": {
+ "description": "In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false.",
+ "type": "boolean"
+ },
+ "allowMethods": {
+ "description": "Specifies the content for the Access-Control-Allow-Methods header.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
},
- "patch": {
- "flatPath": "projects/{project}/regions/{region}/autoscalers",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "autoscaler": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the autoscaler to patch.",
- "type": "string",
- "location": "query"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "region": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "request": {
- "$ref": "Autoscaler"
+ "allowHeaders": {
+ "description": "Specifies the content for the Access-Control-Allow-Headers header.",
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "parameterOrder": [
- "project",
- "region"
- ],
- "path": "projects/{project}/regions/{region}/autoscalers",
- "httpMethod": "PATCH",
- "id": "compute.regionAutoscalers.patch"
+ "type": "array"
},
- "update": {
- "response": {
- "$ref": "Operation"
+ "allowOriginRegexes": {
+ "type": "array",
+ "description": "Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "exposeHeaders": {
+ "items": {
+ "type": "string"
},
- "path": "projects/{project}/regions/{region}/autoscalers",
- "httpMethod": "PUT",
- "request": {
- "$ref": "Autoscaler"
+ "type": "array",
+ "description": "Specifies the content for the Access-Control-Expose-Headers header."
+ }
+ },
+ "description": "The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard."
+ },
+ "Duration": {
+ "description": "A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years.",
+ "id": "Duration",
+ "type": "object",
+ "properties": {
+ "seconds": {
+ "format": "int64",
+ "description": "Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years",
+ "type": "string"
+ },
+ "nanos": {
+ "format": "int32",
+ "description": "Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.",
+ "type": "integer"
+ }
+ }
+ },
+ "TargetHttpProxyAggregatedList": {
+ "properties": {
+ "unreachables": {
+ "type": "array",
+ "description": "[Output Only] Unreachable resources.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Name of the scope containing this set of TargetHttpProxies.",
+ "$ref": "TargetHttpProxiesScopedList"
},
- "id": "compute.regionAutoscalers.update",
- "description": "Updates an autoscaler in the specified project using the data included in the request.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "A list of TargetHttpProxiesScopedList resources."
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies.",
+ "default": "compute#targetHttpProxyAggregatedList",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ },
+ "id": "TargetHttpProxyAggregatedList",
+ "type": "object"
+ },
+ "NetworkEndpointGroupsListEndpointsRequest": {
+ "id": "NetworkEndpointGroupsListEndpointsRequest",
+ "type": "object",
+ "properties": {
+ "healthStatus": {
+ "description": "Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.",
+ "enum": [
+ "SHOW",
+ "SKIP"
],
- "parameterOrder": [
- "project",
- "region"
+ "enumDescriptions": [
+ "Show the health status for each network endpoint. Impacts latency of the call.",
+ "Health status for network endpoints will not be provided."
],
- "flatPath": "projects/{project}/regions/{region}/autoscalers",
- "parameters": {
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "autoscaler": {
- "type": "string",
- "description": "Name of the autoscaler to update.",
- "location": "query",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "type": "string",
- "location": "path",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Project ID for this request."
- }
- }
+ "type": "string"
}
}
},
- "regionHealthChecks": {
- "methods": {
- "delete": {
- "id": "compute.regionHealthChecks.delete",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
+ "RegionDiskTypeList": {
+ "id": "RegionDiskTypeList",
+ "type": "object",
+ "properties": {
+ "items": {
+ "items": {
+ "$ref": "DiskType"
},
- "parameterOrder": [
- "project",
- "region",
- "healthCheck"
- ],
- "description": "Deletes the specified HealthCheck resource.",
- "httpMethod": "DELETE",
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "type": "array",
+ "description": "A list of DiskType resources."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ }
},
- "region": {
- "location": "path",
- "description": "Name of the region scoping this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "healthCheck": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "Name of the HealthCheck resource to delete.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
},
- "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
- "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}"
+ "description": "[Output Only] Informational warning message."
},
- "list": {
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.",
+ "default": "compute#regionDiskTypeList",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ }
+ },
+ "ResourcePolicyWeeklyCycleDayOfWeek": {
+ "properties": {
+ "duration": {
+ "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.",
+ "type": "string"
+ },
+ "startTime": {
+ "type": "string",
+ "description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT."
+ },
+ "day": {
+ "enum": [
+ "FRIDAY",
+ "INVALID",
+ "MONDAY",
+ "SATURDAY",
+ "SUNDAY",
+ "THURSDAY",
+ "TUESDAY",
+ "WEDNESDAY"
],
- "parameterOrder": [
- "project",
- "region"
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
+ "type": "string",
+ "description": "Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY."
+ }
+ },
+ "type": "object",
+ "id": "ResourcePolicyWeeklyCycleDayOfWeek"
+ },
+ "VpnGatewayList": {
+ "id": "VpnGatewayList",
+ "description": "Contains a list of VpnGateway resources.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "warning": {
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array"
},
- "region": {
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
+ "code": {
"type": "string",
- "required": true
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "filter": {
- "location": "query",
+ "message": {
"type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "maxResults": {
- "minimum": "0",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "location": "query",
- "format": "uint32"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "path": "projects/{project}/regions/{region}/healthChecks",
- "id": "compute.regionHealthChecks.list",
- "response": {
- "$ref": "HealthCheckList"
- },
- "flatPath": "projects/{project}/regions/{region}/healthChecks",
- "description": "Retrieves the list of HealthCheck resources available to the specified project."
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
},
- "update": {
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "HealthCheck"
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "VpnGateway"
},
- "id": "compute.regionHealthChecks.update",
- "description": "Updates a HealthCheck resource in the specified project using the data included in the request.",
- "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
- "httpMethod": "PUT",
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "description": "A list of VpnGateway resources."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "kind": {
+ "default": "compute#vpnGatewayList",
+ "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ }
+ }
+ },
+ "LocalDisk": {
+ "type": "object",
+ "id": "LocalDisk",
+ "properties": {
+ "diskSizeGb": {
+ "description": "Specifies the size of the disk in base-2 GB.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "diskType": {
+ "description": "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.",
+ "type": "string"
+ },
+ "diskCount": {
+ "format": "int32",
+ "type": "integer",
+ "description": "Specifies the number of such disks."
+ }
+ }
+ },
+ "HttpHeaderOption": {
+ "id": "HttpHeaderOption",
+ "description": "Specification determining how headers are added to requests or responses.",
+ "properties": {
+ "headerName": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
+ "replace": {
+ "type": "boolean",
+ "description": "If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false. "
+ },
+ "headerValue": {
+ "type": "string",
+ "description": "The value of the header to add."
+ }
+ },
+ "type": "object"
+ },
+ "AutoscalerList": {
+ "id": "AutoscalerList",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.",
+ "default": "compute#autoscalerList"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "items": {
+ "description": "A list of Autoscaler resources.",
+ "type": "array",
+ "items": {
+ "$ref": "Autoscaler"
+ }
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "project": {
+ "message": {
"type": "string",
- "description": "Project ID for this request.",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "healthCheck": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name of the HealthCheck resource to update.",
- "location": "path",
- "type": "string"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "region": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "description": "Name of the region scoping this request."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
},
- "parameterOrder": [
- "project",
- "region",
- "healthCheck"
- ],
- "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "type": "object"
+ }
+ },
+ "type": "object",
+ "description": "Contains a list of Autoscaler resources."
+ },
+ "GlobalOrganizationSetPolicyRequest": {
+ "type": "object",
+ "id": "GlobalOrganizationSetPolicyRequest",
+ "properties": {
+ "etag": {
+ "type": "string",
+ "format": "byte",
+ "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag."
},
- "insert": {
- "request": {
- "$ref": "HealthCheck"
+ "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 in general a valid policy but certain services (like Projects) might reject them."
+ },
+ "bindings": {
+ "type": "array",
+ "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.",
+ "items": {
+ "$ref": "Binding"
+ }
+ }
+ }
+ },
+ "RegionSetLabelsRequest": {
+ "type": "object",
+ "id": "RegionSetLabelsRequest",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "region"
- ],
- "path": "projects/{project}/regions/{region}/healthChecks",
- "flatPath": "projects/{project}/regions/{region}/healthChecks",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "id": "compute.regionHealthChecks.insert",
- "description": "Creates a HealthCheck resource in the specified project using the data included in the request.",
- "parameters": {
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "description": "The labels to set for this resource.",
+ "type": "object"
+ },
+ "labelFingerprint": {
+ "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.",
+ "format": "byte",
+ "type": "string"
+ }
+ }
+ },
+ "HealthCheckReference": {
+ "type": "object",
+ "id": "HealthCheckReference",
+ "description": "A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check ",
+ "properties": {
+ "healthCheck": {
+ "type": "string"
+ }
+ }
+ },
+ "RegionInstanceGroupList": {
+ "id": "RegionInstanceGroupList",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "description": "The resource type.",
+ "type": "string",
+ "default": "compute#regionInstanceGroupList"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "region": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of the region scoping this request."
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "type": "string",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
- },
- "response": {
- "$ref": "Operation"
}
},
- "get": {
- "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
- "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "region",
- "healthCheck"
- ],
- "description": "Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.",
- "response": {
- "$ref": "HealthCheck"
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "items": {
+ "items": {
+ "$ref": "InstanceGroup"
},
- "id": "compute.regionHealthChecks.get",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request."
- },
- "region": {
- "description": "Name of the region scoping this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "healthCheck": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the HealthCheck resource to return.",
- "location": "path",
- "required": true
- }
+ "type": "array",
+ "description": "A list of InstanceGroup resources."
+ }
+ },
+ "description": "Contains a list of InstanceGroup resources."
+ },
+ "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption": {
+ "type": "object",
+ "id": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption",
+ "properties": {
+ "headerValue": {
+ "description": "The value to set the named header to.",
+ "type": "string"
+ },
+ "headerName": {
+ "type": "string",
+ "description": "The name of the header to set."
+ }
+ }
+ },
+ "NodeTemplateNodeTypeFlexibility": {
+ "type": "object",
+ "id": "NodeTemplateNodeTypeFlexibility",
+ "properties": {
+ "localSsd": {
+ "type": "string"
+ },
+ "cpus": {
+ "type": "string"
+ },
+ "memory": {
+ "type": "string"
+ }
+ }
+ },
+ "TargetHttpsProxiesSetSslCertificatesRequest": {
+ "type": "object",
+ "properties": {
+ "sslCertificates": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates."
+ }
+ },
+ "id": "TargetHttpsProxiesSetSslCertificatesRequest"
+ },
+ "BackendServiceIAP": {
+ "properties": {
+ "oauth2ClientSecretSha256": {
+ "description": "[Output Only] SHA256 hash value for the field oauth2_client_secret above.",
+ "type": "string"
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty."
+ },
+ "oauth2ClientSecret": {
+ "type": "string",
+ "description": "OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly"
+ },
+ "oauth2ClientId": {
+ "description": "OAuth2 client ID to use for the authentication flow.",
+ "type": "string"
+ }
+ },
+ "id": "BackendServiceIAP",
+ "description": "Identity-Aware Proxy",
+ "type": "object"
+ },
+ "ResourcePolicyList": {
+ "id": "ResourcePolicyList",
+ "properties": {
+ "items": {
+ "type": "array",
+ "description": "[Output Only] A list of ResourcePolicy resources.",
+ "items": {
+ "$ref": "ResourcePolicy"
}
},
- "patch": {
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "type": "string"
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "healthCheck": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the HealthCheck resource to patch.",
- "required": true,
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"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).",
- "type": "string",
- "location": "query"
- },
- "region": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "Name of the region scoping this request."
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
}
},
- "id": "compute.regionHealthChecks.patch",
- "response": {
- "$ref": "Operation"
- },
- "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
- "request": {
- "$ref": "HealthCheck"
- },
- "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
- "parameterOrder": [
- "project",
- "region",
- "healthCheck"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules."
+ "type": "object"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies",
+ "default": "compute#resourcePolicyList"
+ },
+ "etag": {
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
}
- }
+ },
+ "type": "object"
},
- "regionNotificationEndpoints": {
- "methods": {
- "insert": {
- "description": "Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.",
- "path": "projects/{project}/regions/{region}/notificationEndpoints",
- "request": {
- "$ref": "NotificationEndpoint"
+ "RouterStatus": {
+ "id": "RouterStatus",
+ "properties": {
+ "bgpPeerStatus": {
+ "items": {
+ "$ref": "RouterStatusBgpPeerStatus"
},
- "parameters": {
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "type": "string",
- "location": "path",
- "required": true
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
+ "type": "array"
+ },
+ "bestRoutesForRouter": {
+ "type": "array",
+ "items": {
+ "$ref": "Route"
},
- "parameterOrder": [
- "project",
- "region"
- ],
- "id": "compute.regionNotificationEndpoints.insert",
- "flatPath": "projects/{project}/regions/{region}/notificationEndpoints",
- "response": {
- "$ref": "Operation"
+ "description": "Best routes learned by this router."
+ },
+ "network": {
+ "description": "URI of the network to which this router belongs.",
+ "type": "string"
+ },
+ "natStatus": {
+ "items": {
+ "$ref": "RouterStatusNatStatus"
},
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "type": "array"
},
- "list": {
- "parameterOrder": [
- "project",
- "region"
- ],
- "id": "compute.regionNotificationEndpoints.list",
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "bestRoutes": {
+ "type": "array",
+ "description": "Best routes for this router's network.",
+ "items": {
+ "$ref": "Route"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "TargetHttpsProxiesSetQuicOverrideRequest": {
+ "properties": {
+ "quicOverride": {
+ "description": "QUIC policy for the TargetHttpsProxy resource.",
+ "enum": [
+ "DISABLE",
+ "ENABLE",
+ "NONE"
],
- "response": {
- "$ref": "NotificationEndpointList"
+ "type": "string",
+ "enumDescriptions": [
+ "The load balancer will not attempt to negotiate QUIC with clients.",
+ "The load balancer will attempt to negotiate QUIC with clients.",
+ "No overrides to the default QUIC policy. This option is implicit if no QUIC override has been specified in the request."
+ ]
+ }
+ },
+ "id": "TargetHttpsProxiesSetQuicOverrideRequest",
+ "type": "object"
+ },
+ "InterconnectAttachmentsScopedList": {
+ "id": "InterconnectAttachmentsScopedList",
+ "type": "object",
+ "properties": {
+ "interconnectAttachments": {
+ "type": "array",
+ "items": {
+ "$ref": "InterconnectAttachment"
},
- "flatPath": "projects/{project}/regions/{region}/notificationEndpoints",
- "path": "projects/{project}/regions/{region}/notificationEndpoints",
- "description": "Lists the NotificationEndpoints for a project in the given region.",
- "parameters": {
- "region": {
- "type": "string",
- "description": "Name of the region scoping this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "pageToken": {
+ "description": "A list of interconnect attachments contained in this scope."
+ },
+ "warning": {
+ "type": "object",
+ "description": "Informational warning which replaces the list of addresses when the list is empty.",
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "location": "path"
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "maxResults": {
- "location": "query",
- "type": "integer",
- "format": "uint32",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0"
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
}
+ }
+ }
+ },
+ "MachineTypeAggregatedList": {
+ "type": "object",
+ "id": "MachineTypeAggregatedList",
+ "properties": {
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
},
- "delete": {
- "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}",
- "parameterOrder": [
- "project",
- "region",
- "notificationEndpoint"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Deletes the specified NotificationEndpoint in the given region",
- "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}",
- "httpMethod": "DELETE",
- "id": "compute.regionNotificationEndpoints.delete",
- "response": {
- "$ref": "Operation"
+ "items": {
+ "additionalProperties": {
+ "description": "[Output Only] Name of the scope containing this set of machine types.",
+ "$ref": "MachineTypesScopedList"
},
- "parameters": {
- "notificationEndpoint": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the NotificationEndpoint resource to delete.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path"
- },
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "type": "string",
- "description": "Name of the region scoping this request.",
- "required": true
- },
- "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).",
- "type": "string",
- "location": "query"
- }
- }
+ "type": "object",
+ "description": "A list of MachineTypesScopedList resources."
},
- "get": {
- "httpMethod": "GET",
- "parameters": {
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "warning": {
+ "properties": {
+ "message": {
"type": "string",
- "location": "path",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request.",
+ "code": {
"type": "string",
- "required": true
- },
- "notificationEndpoint": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the NotificationEndpoint resource to return.",
- "type": "string"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "id": "compute.regionNotificationEndpoints.get",
- "description": "Returns the specified NotificationEndpoint resource in the given region.",
- "response": {
- "$ref": "NotificationEndpoint"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "region",
- "notificationEndpoint"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}",
- "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}"
+ "type": "array",
+ "description": "[Output Only] Unreachable resources."
+ },
+ "kind": {
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.",
+ "default": "compute#machineTypeAggregatedList"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
}
}
},
- "machineImages": {
- "methods": {
- "get": {
- "response": {
- "$ref": "MachineImage"
- },
- "parameterOrder": [
- "project",
- "machineImage"
- ],
- "description": "Returns the specified machine image. Gets a list of available machine images by making a list() request.",
- "id": "compute.machineImages.get",
- "path": "projects/{project}/global/machineImages/{machineImage}",
- "httpMethod": "GET",
- "flatPath": "projects/{project}/global/machineImages/{machineImage}",
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
+ "DiskTypeList": {
+ "id": "DiskTypeList",
+ "type": "object",
+ "description": "Contains a list of disk types.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#diskTypeList",
+ "description": "[Output Only] Type of resource. Always compute#diskTypeList for disk types."
+ },
+ "warning": {
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string"
},
- "machineImage": {
- "required": true,
- "location": "path",
- "description": "The name of the machine image.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "testIamPermissions": {
- "path": "projects/{project}/global/machineImages/{resource}/testIamPermissions",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "POST",
- "id": "compute.machineImages.testIamPermissions",
- "request": {
- "$ref": "TestPermissionsRequest"
- },
- "parameters": {
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name or id of the resource for this request.",
- "type": "string",
- "required": true,
- "location": "path"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ }
},
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
+ "message": {
+ "type": "string",
+ "description": "[Output Only] A human-readable description of the warning code."
}
},
- "flatPath": "projects/{project}/global/machineImages/{resource}/testIamPermissions",
- "parameterOrder": [
- "project",
- "resource"
- ],
- "response": {
- "$ref": "TestPermissionsResponse"
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "DiskType"
},
- "description": "Returns permissions that a caller has on the specified resource."
+ "description": "A list of DiskType resources."
},
- "insert": {
- "request": {
- "$ref": "MachineImage"
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ }
+ }
+ },
+ "RoutersPreviewResponse": {
+ "id": "RoutersPreviewResponse",
+ "type": "object",
+ "properties": {
+ "resource": {
+ "description": "Preview of given router.",
+ "$ref": "Router"
+ }
+ }
+ },
+ "UrlRewrite": {
+ "type": "object",
+ "id": "UrlRewrite",
+ "properties": {
+ "pathPrefixRewrite": {
+ "description": "Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.",
+ "type": "string"
+ },
+ "hostRewrite": {
+ "description": "Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.",
+ "type": "string"
+ }
+ },
+ "description": "The spec for modifying the path before sending the request to the matched backend service."
+ },
+ "ShareSettingsProjectConfig": {
+ "description": "Config for each project in the share settings.",
+ "properties": {
+ "projectId": {
+ "type": "string",
+ "description": "The project ID, should be same as the key of this project config in the parent map."
+ }
+ },
+ "type": "object",
+ "id": "ShareSettingsProjectConfig"
+ },
+ "Autoscaler": {
+ "type": "object",
+ "properties": {
+ "scalingScheduleStatus": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "ScalingScheduleStatus"
},
- "description": "Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "[Output Only] Status information of existing scaling schedules."
+ },
+ "region": {
+ "description": "[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).",
+ "type": "string"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Configuration is acknowledged to be effective",
+ "Configuration is being deleted",
+ "Configuration has errors. Actionable for users.",
+ "Autoscaler backend hasn't read new/updated configuration"
],
- "httpMethod": "POST",
- "flatPath": "projects/{project}/global/machineImages",
- "path": "projects/{project}/global/machineImages",
- "parameterOrder": [
- "project"
+ "enum": [
+ "ACTIVE",
+ "DELETING",
+ "ERROR",
+ "PENDING"
],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path"
- },
- "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).",
- "type": "string",
- "location": "query"
- },
- "sourceInstance": {
- "location": "query",
- "type": "string",
- "description": "Required. Source instance that is used to create the machine image from."
- }
+ "type": "string",
+ "description": "[Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future."
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "statusDetails": {
+ "description": "[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.",
+ "items": {
+ "$ref": "AutoscalerStatusDetails"
},
- "id": "compute.machineImages.insert"
+ "type": "array"
},
- "delete": {
- "id": "compute.machineImages.delete",
- "description": "Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "project",
- "machineImage"
- ],
- "path": "projects/{project}/global/machineImages/{machineImage}",
- "response": {
- "$ref": "Operation"
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "recommendedSize": {
+ "format": "int32",
+ "type": "integer",
+ "description": "[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction."
+ },
+ "zone": {
+ "type": "string",
+ "description": "[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope)."
+ },
+ "target": {
+ "description": "URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.",
+ "default": "compute#autoscaler",
+ "type": "string"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "compute.autoscalers.insert"
+ ]
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/global/machineImages/{machineImage}",
- "parameters": {
- "project": {
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "machineImage": {
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "The name of the machine image to delete.",
- "required": true
- }
- }
+ "description": "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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
},
- "setIamPolicy": {
- "httpMethod": "POST",
- "path": "projects/{project}/global/machineImages/{resource}/setIamPolicy",
- "response": {
- "$ref": "Policy"
+ "autoscalingPolicy": {
+ "$ref": "AutoscalingPolicy",
+ "description": "The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%."
+ }
+ },
+ "description": "Represents an Autoscaler resource. Google Compute Engine has two Autoscaler resources: * [Zonal](/compute/docs/reference/rest/v1/autoscalers) * [Regional](/compute/docs/reference/rest/v1/regionAutoscalers) Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource.",
+ "id": "Autoscaler"
+ },
+ "SourceInstanceParams": {
+ "description": "A specification of the parameters to use when creating the instance template from a source instance.",
+ "type": "object",
+ "properties": {
+ "diskConfigs": {
+ "type": "array",
+ "items": {
+ "$ref": "DiskInstantiationConfig"
+ },
+ "description": "Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, the source images for each disk will be used. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes."
+ }
+ },
+ "id": "SourceInstanceParams"
+ },
+ "InstancesSetMinCpuPlatformRequest": {
+ "id": "InstancesSetMinCpuPlatformRequest",
+ "type": "object",
+ "properties": {
+ "minCpuPlatform": {
+ "description": "Minimum cpu/platform this instance should be started at.",
+ "type": "string"
+ }
+ }
+ },
+ "SubnetworksExpandIpCidrRangeRequest": {
+ "id": "SubnetworksExpandIpCidrRangeRequest",
+ "properties": {
+ "ipCidrRange": {
+ "type": "string",
+ "description": "The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update."
+ }
+ },
+ "type": "object"
+ },
+ "RegionInstanceGroupManagersSetTemplateRequest": {
+ "properties": {
+ "instanceTemplate": {
+ "description": "URL of the InstanceTemplate resource from which all new instances will be created.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "RegionInstanceGroupManagersSetTemplateRequest"
+ },
+ "SecurityPolicyRecaptchaOptionsConfig": {
+ "id": "SecurityPolicyRecaptchaOptionsConfig",
+ "type": "object",
+ "properties": {
+ "redirectSiteKey": {
+ "type": "string",
+ "description": "An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used."
+ }
+ }
+ },
+ "Rule": {
+ "properties": {
+ "conditions": {
+ "type": "array",
+ "items": {
+ "$ref": "Condition"
},
- "request": {
- "$ref": "GlobalSetPolicyRequest"
+ "description": "This is deprecated and has no effect. Do not use."
+ },
+ "notIns": {
+ "description": "This is deprecated and has no effect. Do not use.",
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "resource"
+ "type": "array"
+ },
+ "action": {
+ "enumDescriptions": [
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use.",
+ "This is deprecated and has no effect. Do not use."
],
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
- },
- "resource": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name or id of the resource for this request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enum": [
+ "ALLOW",
+ "ALLOW_WITH_LOG",
+ "DENY",
+ "DENY_WITH_LOG",
+ "LOG",
+ "NO_ACTION"
],
- "id": "compute.machineImages.setIamPolicy",
- "flatPath": "projects/{project}/global/machineImages/{resource}/setIamPolicy"
+ "type": "string",
+ "description": "This is deprecated and has no effect. Do not use."
},
- "list": {
- "path": "projects/{project}/global/machineImages",
- "flatPath": "projects/{project}/global/machineImages",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Retrieves a list of machine images that are contained within the specified project.",
- "parameters": {
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- },
- "maxResults": {
- "location": "query",
- "default": "500",
- "format": "uint32",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
- }
+ "ins": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
- ],
- "id": "compute.machineImages.list",
- "response": {
- "$ref": "MachineImageList"
- }
+ "description": "This is deprecated and has no effect. Do not use."
},
- "getIamPolicy": {
- "parameters": {
- "optionsRequestedPolicyVersion": {
- "format": "int32",
- "description": "Requested IAM Policy version.",
- "type": "integer",
- "location": "query"
- },
- "resource": {
- "description": "Name or id of the resource for this request.",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- }
+ "permissions": {
+ "description": "This is deprecated and has no effect. Do not use.",
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "resource"
- ],
- "path": "projects/{project}/global/machineImages/{resource}/getIamPolicy",
- "response": {
- "$ref": "Policy"
+ "type": "array"
+ },
+ "logConfigs": {
+ "type": "array",
+ "items": {
+ "$ref": "LogConfig"
},
- "httpMethod": "GET",
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/global/machineImages/{resource}/getIamPolicy",
- "id": "compute.machineImages.getIamPolicy"
+ "description": "This is deprecated and has no effect. Do not use."
+ },
+ "description": {
+ "type": "string",
+ "description": "This is deprecated and has no effect. Do not use."
}
- }
+ },
+ "id": "Rule",
+ "type": "object",
+ "description": "This is deprecated and has no effect. Do not use."
},
- "instanceGroupManagers": {
- "methods": {
- "listPerInstanceConfigs": {
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
- "description": "Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.instanceGroupManagers.listPerInstanceConfigs",
- "response": {
- "$ref": "InstanceGroupManagersListPerInstanceConfigsResp"
- },
- "parameters": {
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "required": true,
- "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.",
- "type": "string",
- "location": "path"
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "ResourcePolicyDailyCycle": {
+ "description": "Time window specified for daily operations.",
+ "properties": {
+ "startTime": {
+ "description": "Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.",
+ "type": "string"
+ },
+ "duration": {
+ "type": "string",
+ "description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario."
+ },
+ "daysInCycle": {
+ "format": "int32",
+ "type": "integer",
+ "description": "Defines a schedule with units measured in days. The value determines how many days pass between the start of each cycle."
+ }
+ },
+ "type": "object",
+ "id": "ResourcePolicyDailyCycle"
+ },
+ "VpnGatewayStatus": {
+ "properties": {
+ "vpnConnections": {
+ "description": "List of VPN connection for this VpnGateway.",
+ "type": "array",
+ "items": {
+ "$ref": "VpnGatewayStatusVpnConnection"
+ }
+ }
+ },
+ "type": "object",
+ "id": "VpnGatewayStatus"
+ },
+ "AutoscalingPolicyScaleInControl": {
+ "properties": {
+ "timeWindowSec": {
+ "description": "How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "maxScaledInReplicas": {
+ "$ref": "FixedOrPercent",
+ "description": "Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step."
+ }
+ },
+ "id": "AutoscalingPolicyScaleInControl",
+ "type": "object",
+ "description": "Configuration that allows for slower scale in so that even if Autoscaler recommends an abrupt scale in of a MIG, it will be throttled as specified by the parameters below."
+ },
+ "ForwardingRuleList": {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "default": "compute#forwardingRuleList",
+ "type": "string",
+ "description": "Type of resource."
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "instanceGroupManager": {
- "required": true,
+ "message": {
"type": "string",
- "location": "path",
- "description": "The name of the managed instance group. It should conform to RFC1035."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string"
- },
- "maxResults": {
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "location": "query",
- "format": "uint32",
- "type": "integer"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string",
- "location": "query"
}
}
},
- "setTargetPools": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
- "description": "Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
- "response": {
- "$ref": "Operation"
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "items": {
+ "$ref": "ForwardingRule"
},
- "id": "compute.instanceGroupManagers.setTargetPools",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "parameters": {
- "instanceGroupManager": {
- "location": "path",
- "description": "The name of the managed instance group.",
- "required": true,
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "zone": {
- "location": "path",
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true
- }
+ "type": "array",
+ "description": "A list of ForwardingRule resources."
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "id": "ForwardingRuleList",
+ "description": "Contains a list of ForwardingRule resources."
+ },
+ "PathMatcher": {
+ "type": "object",
+ "properties": {
+ "pathRules": {
+ "items": {
+ "$ref": "PathRule"
},
- "httpMethod": "POST",
- "request": {
- "$ref": "InstanceGroupManagersSetTargetPoolsRequest"
+ "description": "The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.",
+ "type": "array"
+ },
+ "defaultRouteAction": {
+ "description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction.",
+ "$ref": "HttpRouteAction"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this resource. Provide this property when you create the resource."
+ },
+ "defaultService": {
+ "type": "string",
+ "description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use "
+ },
+ "defaultUrlRedirect": {
+ "$ref": "HttpRedirectAction",
+ "description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy."
+ },
+ "routeRules": {
+ "type": "array",
+ "description": "The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.",
+ "items": {
+ "$ref": "HttpRouteRule"
}
},
- "deleteInstances": {
- "parameters": {
- "zone": {
- "required": true,
- "location": "path",
- "description": "The name of the zone where the managed instance group is located.",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "instanceGroupManager": {
- "type": "string",
- "required": true,
- "description": "The name of the managed instance group.",
- "location": "path"
- },
- "project": {
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- }
- },
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
+ "name": {
+ "description": "The name to which this PathMatcher is referred by the HostRule.",
+ "type": "string"
+ },
+ "headerAction": {
+ "$ref": "HttpHeaderAction",
+ "description": "Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true."
+ }
+ },
+ "id": "PathMatcher",
+ "description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used."
+ },
+ "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": {
+ "properties": {
+ "name": {
+ "description": "[Output Only] The name of the firewall policy.",
+ "type": "string"
+ },
+ "shortName": {
+ "description": "[Output Only] The short name of the firewall policy.",
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "HIERARCHY",
+ "NETWORK",
+ "NETWORK_REGIONAL",
+ "UNSPECIFIED"
],
- "request": {
- "$ref": "InstanceGroupManagersDeleteInstancesRequest"
- },
- "description": "Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
- "id": "compute.instanceGroupManagers.deleteInstances",
- "response": {
- "$ref": "Operation"
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.",
+ "type": "string"
+ },
+ "rules": {
+ "items": {
+ "$ref": "FirewallPolicyRule"
},
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "description": "The rules that apply to the network.",
+ "type": "array"
},
- "deletePerInstanceConfigs": {
- "response": {
- "$ref": "Operation"
+ "displayName": {
+ "type": "string",
+ "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy."
+ }
+ },
+ "id": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy",
+ "type": "object"
+ },
+ "TargetHttpProxy": {
+ "description": "Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.",
+ "type": "object",
+ "id": "TargetHttpProxy",
+ "properties": {
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies."
+ },
+ "urlMap": {
+ "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.",
+ "type": "string",
+ "default": "compute#targetHttpProxy"
+ },
+ "fingerprint": {
+ "format": "byte",
+ "description": "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 TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.",
+ "type": "string"
+ },
+ "proxyBind": {
+ "description": "This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.",
+ "type": "boolean"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "name": {
+ "type": "string",
+ "description": "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.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ }
+ }
+ },
+ "InterconnectLocation": {
+ "description": "Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.",
+ "type": "object",
+ "id": "InterconnectLocation",
+ "properties": {
+ "regionInfos": {
+ "type": "array",
+ "items": {
+ "$ref": "InterconnectLocationRegionInfo"
},
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
+ "description": "[Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions."
+ },
+ "peeringdbFacilityId": {
+ "type": "string",
+ "description": "[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb)."
+ },
+ "continent": {
+ "enum": [
+ "AFRICA",
+ "ASIA_PAC",
+ "C_AFRICA",
+ "C_ASIA_PAC",
+ "C_EUROPE",
+ "C_NORTH_AMERICA",
+ "C_SOUTH_AMERICA",
+ "EUROPE",
+ "NORTH_AMERICA",
+ "SOUTH_AMERICA"
],
- "parameters": {
- "instanceGroupManager": {
- "required": true,
- "type": "string",
- "description": "The name of the managed instance group. It should conform to RFC1035.",
- "location": "path"
- },
- "zone": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035."
- },
- "project": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- }
- },
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs",
- "id": "compute.instanceGroupManagers.deletePerInstanceConfigs",
- "description": "Deletes selected per-instance configurations for the managed instance group.",
- "request": {
- "$ref": "InstanceGroupManagersDeletePerInstanceConfigsReq"
- },
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA ",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
]
},
- "recreateInstances": {
- "id": "compute.instanceGroupManagers.recreateInstances",
- "description": "Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "InstanceGroupManagersRecreateInstancesRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "required": true,
- "description": "The name of the managed instance group.",
- "location": "path"
- },
- "zone": {
- "description": "The name of the zone where the managed instance group is located.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Project ID for this request."
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- }
- }
+ "address": {
+ "description": "[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.",
+ "type": "string"
},
- "abandonInstances": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
- "description": "Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
- "id": "compute.instanceGroupManagers.abandonInstances",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
+ "name": {
+ "description": "[Output Only] Name of the resource.",
+ "type": "string"
+ },
+ "facilityProviderFacilityId": {
+ "type": "string",
+ "description": "[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1)."
+ },
+ "city": {
+ "description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\".",
+ "type": "string"
+ },
+ "supportsPzs": {
+ "type": "boolean",
+ "description": "[Output Only] Set to true for locations that support physical zone separation. Defaults to false if the field is not present."
+ },
+ "description": {
+ "type": "string",
+ "description": "[Output Only] An optional description of the resource."
+ },
+ "availabilityZone": {
+ "type": "string",
+ "description": "[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: \"zone1\" or \"zone2\"."
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#interconnectLocation",
+ "description": "[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "facilityProvider": {
+ "description": "[Output Only] The name of the provider for this facility (e.g., EQUINIX).",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "status": {
+ "description": "[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. ",
+ "enumDescriptions": [
+ "The InterconnectLocation is available for provisioning new Interconnects.",
+ "The InterconnectLocation is closed for provisioning new Interconnects."
],
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
- "httpMethod": "POST",
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "InstanceGroupManagersAbandonInstancesRequest"
+ "type": "string",
+ "enum": [
+ "AVAILABLE",
+ "CLOSED"
+ ]
+ }
+ }
+ },
+ "InstanceGroupsScopedList": {
+ "properties": {
+ "instanceGroups": {
+ "items": {
+ "$ref": "InstanceGroup"
},
- "parameters": {
- "zone": {
- "required": true,
- "location": "path",
- "description": "The name of the zone where the managed instance group is located.",
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
+ "description": "[Output Only] The list of instance groups that are contained in this scope.",
+ "type": "array"
+ },
+ "warning": {
+ "description": "[Output Only] An informational warning that replaces the list of instance groups when the list is empty.",
+ "properties": {
+ "message": {
"type": "string",
- "required": true
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "instanceGroupManager": {
- "required": true,
- "description": "The name of the managed instance group.",
- "location": "path",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string"
},
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
- }
- },
- "aggregatedList": {
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
- ],
- "description": "Retrieves the list of managed instance groups and groups them by zone.",
- "flatPath": "projects/{project}/aggregated/instanceGroupManagers",
- "response": {
- "$ref": "InstanceGroupManagerAggregatedList"
},
- "parameters": {
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "maxResults": {
- "default": "500",
- "location": "query",
- "format": "uint32",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0"
- },
- "filter": {
- "location": "query",
+ "type": "object"
+ }
+ },
+ "type": "object",
+ "id": "InstanceGroupsScopedList"
+ },
+ "ServiceAttachmentsScopedList": {
+ "type": "object",
+ "properties": {
+ "warning": {
+ "type": "object",
+ "description": "Informational warning which replaces the list of service attachments when the list is empty.",
+ "properties": {
+ "message": {
"type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query",
- "type": "boolean"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "project": {
+ "code": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
+ "data": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
+ }
+ },
+ "serviceAttachments": {
+ "items": {
+ "$ref": "ServiceAttachment"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "type": "array",
+ "description": "A list of ServiceAttachments contained in this scope."
+ }
+ },
+ "id": "ServiceAttachmentsScopedList"
+ },
+ "HTTP2HealthCheck": {
+ "properties": {
+ "portSpecification": {
+ "enumDescriptions": [
+ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
+ "Not supported.",
+ "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
+ ],
+ "enum": [
+ "USE_FIXED_PORT",
+ "USE_NAMED_PORT",
+ "USE_SERVING_PORT"
],
- "id": "compute.instanceGroupManagers.aggregatedList",
- "path": "projects/{project}/aggregated/instanceGroupManagers"
+ "type": "string",
+ "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports."
},
- "list": {
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "maxResults": {
- "location": "query",
- "format": "uint32",
- "minimum": "0",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "type": "integer"
- },
- "zone": {
- "required": true,
- "description": "The name of the zone where the managed instance group is located.",
- "location": "path",
- "type": "string"
- },
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string"
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
+ "response": {
+ "description": "Creates a content-based HTTP/2 health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http",
+ "type": "string"
+ },
+ "requestPath": {
+ "type": "string",
+ "description": "The request path of the HTTP/2 health check request. The default value is /."
+ },
+ "port": {
+ "format": "int32",
+ "type": "integer",
+ "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535."
+ },
+ "portName": {
+ "description": "Not supported.",
+ "type": "string"
+ },
+ "proxyHeader": {
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "enum": [
+ "NONE",
+ "PROXY_V1"
+ ],
+ "type": "string",
+ "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
+ },
+ "host": {
+ "description": "The value of the host header in the HTTP/2 health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest",
+ "type": "string"
+ }
+ },
+ "id": "HTTP2HealthCheck",
+ "type": "object"
+ },
+ "BackendBucketList": {
+ "description": "Contains a list of BackendBucket resources.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "orderBy": {
- "location": "query",
+ "message": {
"type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "pageToken": {
- "location": "query",
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "response": {
- "$ref": "InstanceGroupManagerList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers",
- "description": "Retrieves a list of managed instance groups that are contained within the specified project and zone.",
- "id": "compute.instanceGroupManagers.list",
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers",
- "parameterOrder": [
- "project",
- "zone"
- ]
+ "description": "[Output Only] Informational warning message."
},
- "insert": {
- "response": {
- "$ref": "Operation"
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "default": "compute#backendBucketList",
+ "description": "Type of resource."
+ },
+ "items": {
+ "type": "array",
+ "description": "A list of BackendBucket resources.",
+ "items": {
+ "$ref": "BackendBucket"
+ }
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ },
+ "id": "BackendBucketList"
+ },
+ "InstanceGroupAggregatedList": {
+ "properties": {
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "parameters": {
- "zone": {
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "kind": {
+ "description": "[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.",
+ "type": "string",
+ "default": "compute#instanceGroupAggregatedList"
+ },
+ "items": {
+ "type": "object",
+ "description": "A list of InstanceGroupsScopedList resources.",
+ "additionalProperties": {
+ "$ref": "InstanceGroupsScopedList",
+ "description": "The name of the scope that contains this set of instance groups."
+ }
+ },
+ "warning": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
"type": "string",
- "description": "The name of the zone where you want to create the managed instance group.",
- "required": true,
- "location": "path"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "project": {
- "type": "string",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
}
},
- "request": {
- "$ref": "InstanceGroupManager"
- },
- "parameterOrder": [
- "project",
- "zone"
- ],
- "httpMethod": "POST",
- "id": "compute.instanceGroupManagers.insert",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers",
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers"
+ "description": "[Output Only] Informational warning message."
+ }
+ },
+ "type": "object",
+ "id": "InstanceGroupAggregatedList"
+ },
+ "PacketMirroringAggregatedList": {
+ "description": "Contains a list of packetMirrorings.",
+ "properties": {
+ "kind": {
+ "default": "compute#packetMirroringAggregatedList",
+ "description": "Type of resource.",
+ "type": "string"
},
- "updatePerInstanceConfigs": {
- "response": {
- "$ref": "Operation"
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "items": {
+ "additionalProperties": {
+ "description": "Name of the scope containing this set of packetMirrorings.",
+ "$ref": "PacketMirroringsScopedList"
},
- "description": "Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
- "parameters": {
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "instanceGroupManager": {
- "location": "path",
+ "description": "A list of PacketMirroring resources.",
+ "type": "object"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "required": true,
- "description": "The name of the managed instance group. It should conform to RFC1035."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
},
- "zone": {
- "location": "path",
- "type": "string",
- "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.",
- "required": true
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array",
+ "items": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ }
},
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
}
},
- "id": "compute.instanceGroupManagers.updatePerInstanceConfigs",
- "request": {
- "$ref": "InstanceGroupManagersUpdatePerInstanceConfigsReq"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "type": "object"
},
- "patch": {
- "response": {
- "$ref": "Operation"
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "description": "Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.",
- "id": "compute.instanceGroupManagers.patch",
- "request": {
- "$ref": "InstanceGroupManager"
+ "type": "array",
+ "description": "[Output Only] Unreachable resources."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ },
+ "id": "PacketMirroringAggregatedList",
+ "type": "object"
+ },
+ "RouterNatRuleAction": {
+ "properties": {
+ "sourceNatDrainIps": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "parameters": {
- "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).",
- "type": "string",
- "location": "query"
- },
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true
- },
- "zone": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the zone where you want to create the managed instance group."
- },
- "instanceGroupManager": {
- "description": "The name of the instance group manager.",
- "required": true,
- "type": "string",
- "location": "path"
- }
+ "description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT."
+ },
+ "sourceNatActiveIps": {
+ "description": "A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT.",
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "array"
+ }
+ },
+ "id": "RouterNatRuleAction",
+ "type": "object"
+ },
+ "DiskInstantiationConfig": {
+ "id": "DiskInstantiationConfig",
+ "type": "object",
+ "description": "A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.",
+ "properties": {
+ "deviceName": {
+ "description": "Specifies the device name of the disk to which the configurations apply to.",
+ "type": "string"
+ },
+ "autoDelete": {
+ "type": "boolean",
+ "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance)."
+ },
+ "instantiateFrom": {
+ "enum": [
+ "ATTACH_READ_ONLY",
+ "BLANK",
+ "CUSTOM_IMAGE",
+ "DEFAULT",
+ "DO_NOT_INCLUDE",
+ "SOURCE_IMAGE",
+ "SOURCE_IMAGE_FAMILY"
],
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
+ "type": "string",
+ "enumDescriptions": [
+ "Attach the existing disk in read-only mode. The request will fail if the disk was attached in read-write mode on the source instance. Applicable to: read-only disks.",
+ "Create a blank disk. The disk will be created unformatted. Applicable to: additional read-write disks, local SSDs.",
+ "Use the custom image specified in the custom_image field. Applicable to: boot disk, additional read-write disks.",
+ "Use the default instantiation option for the corresponding type of disk. For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.",
+ "Do not include the disk in the instance template. Applicable to: additional read-write disks, local SSDs, read-only disks.",
+ "Use the same source image used for creation of the source instance's corresponding disk. The request will fail if the source VM's disk was created from a snapshot. Applicable to: boot disk, additional read-write disks.",
+ "Use the same source image family used for creation of the source instance's corresponding disk. The request will fail if the source image of the source disk does not belong to any image family. Applicable to: boot disk, additional read-write disks."
],
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- "httpMethod": "PATCH"
+ "description": "Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. "
},
- "setInstanceTemplate": {
- "response": {
- "$ref": "Operation"
- },
- "description": "Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.",
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "id": "compute.instanceGroupManagers.setInstanceTemplate",
- "request": {
- "$ref": "InstanceGroupManagersSetInstanceTemplateRequest"
+ "customImage": {
+ "type": "string",
+ "description": "The custom source image to be used to restore this disk when instantiating this instance template."
+ }
+ }
+ },
+ "RegionDisksRemoveResourcePoliciesRequest": {
+ "id": "RegionDisksRemoveResourcePoliciesRequest",
+ "type": "object",
+ "properties": {
+ "resourcePolicies": {
+ "type": "array",
+ "items": {
+ "type": "string"
},
- "parameters": {
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- },
- "requestId": {
- "type": "string",
- "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"
- },
- "instanceGroupManager": {
- "location": "path",
- "required": true,
- "description": "The name of the managed instance group.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the zone where the managed instance group is located.",
- "required": true,
- "location": "path",
- "type": "string"
- }
+ "description": "Resource policies to be removed from this disk."
+ }
+ }
+ },
+ "InstanceConsumptionData": {
+ "properties": {
+ "consumptionInfo": {
+ "$ref": "InstanceConsumptionInfo",
+ "description": "Resources consumed by the instance."
+ },
+ "instance": {
+ "type": "string",
+ "description": "Server-defined URL for the instance."
+ }
+ },
+ "id": "InstanceConsumptionData",
+ "type": "object"
+ },
+ "AttachedDiskInitializeParams": {
+ "description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "An optional description. Provide this property when creating the disk."
+ },
+ "sourceSnapshot": {
+ "type": "string",
+ "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."
+ },
+ "sourceImage": {
+ "description": "The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.",
+ "type": "string"
+ },
+ "resourceManagerTags": {
+ "description": "Resource manager tags to be bound to the disk. 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",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "licenses": {
+ "description": "A list of publicly visible licenses. Reserved for Google's use.",
+ "items": {
+ "type": "string"
},
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "httpMethod": "POST"
+ "type": "array"
},
- "delete": {
- "httpMethod": "DELETE",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- "id": "compute.instanceGroupManagers.delete",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
+ "architecture": {
+ "type": "string",
+ "enum": [
+ "ARCHITECTURE_UNSPECIFIED",
+ "ARM64",
+ "X86_64"
],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "enumDescriptions": [
+ "Default value indicating Architecture is not set.",
+ "Machines with architecture ARM64",
+ "Machines with architecture X86_64"
],
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group to delete.",
- "location": "path",
- "required": true
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true
- },
- "zone": {
- "type": "string",
- "required": true,
- "description": "The name of the zone where the managed instance group is located.",
- "location": "path"
- }
- },
- "description": "Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information."
+ "description": "The architecture of the attached disk. Valid values are arm64 or x86_64."
},
- "createInstances": {
- "parameters": {
- "instanceGroupManager": {
- "type": "string",
- "description": "The name of the managed instance group. It should conform to RFC1035.",
- "required": true,
- "location": "path"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
- },
- "zone": {
- "required": true,
- "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.",
- "type": "string",
- "location": "path"
- },
- "requestId": {
- "location": "query",
- "type": "string",
- "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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)."
- }
- },
- "description": "Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.",
- "request": {
- "$ref": "InstanceGroupManagersCreateInstancesRequest"
+ "resourcePolicies": {
+ "items": {
+ "type": "string"
},
- "id": "compute.instanceGroupManagers.createInstances",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances",
- "httpMethod": "POST",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
+ "type": "array",
+ "description": "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."
+ },
+ "provisionedIops": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "diskSizeGb": {
+ "format": "int64",
+ "type": "string",
+ "description": "Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB."
+ },
+ "diskType": {
+ "type": "string",
+ "description": "Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard."
+ },
+ "sourceImageEncryptionKey": {
+ "description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch 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.",
+ "$ref": "CustomerEncryptionKey"
+ },
+ "sourceSnapshotEncryptionKey": {
+ "description": "The customer-supplied encryption key of the source snapshot.",
+ "$ref": "CustomerEncryptionKey"
+ },
+ "diskName": {
+ "description": "Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.",
+ "type": "string"
+ },
+ "onUpdateAction": {
+ "enum": [
+ "RECREATE_DISK",
+ "RECREATE_DISK_IF_SOURCE_CHANGED",
+ "USE_EXISTING_DISK"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "description": "Specifies which action to take on instance update with this disk. Default is to use the existing disk.",
+ "enumDescriptions": [
+ "Always recreate the disk.",
+ "Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.",
+ "Use the existing disk, this is the default behaviour."
],
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances",
- "response": {
- "$ref": "Operation"
- }
+ "type": "string"
},
- "listManagedInstances": {
- "response": {
- "$ref": "InstanceGroupManagersListManagedInstancesResponse"
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
},
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "description": "Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.",
- "parameters": {
- "zone": {
- "location": "path",
- "type": "string",
- "description": "The name of the zone where the managed instance group is located.",
- "required": true
- },
- "maxResults": {
- "format": "uint32",
- "type": "integer",
- "default": "500",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "instanceGroupManager": {
- "location": "path",
- "required": true,
- "type": "string",
- "description": "The name of the managed instance group."
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
+ "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"
+ }
+ },
+ "id": "AttachedDiskInitializeParams",
+ "type": "object"
+ },
+ "InstanceManagedByIgmErrorManagedInstanceError": {
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "[Output Only] Error message."
+ },
+ "code": {
+ "type": "string",
+ "description": "[Output Only] Error code."
+ }
+ },
+ "type": "object",
+ "id": "InstanceManagedByIgmErrorManagedInstanceError"
+ },
+ "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "string",
+ "description": "An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation."
+ },
+ "name": {
+ "description": "Identifies the custom policy. The value should match the type the custom implementation is registered with on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (e.g. myorg.CustomLbPolicy). The maximum length is 256 characters. Note that specifying the same custom policy more than once for a backend is not a valid configuration and will be rejected.",
+ "type": "string"
+ }
+ },
+ "description": "The configuration for a custom policy implemented by the user and deployed with the client.",
+ "id": "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy"
+ },
+ "WafExpressionSetExpression": {
+ "id": "WafExpressionSetExpression",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. required",
+ "type": "string"
+ }
+ }
+ },
+ "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings": {
+ "properties": {
+ "natIpPortRanges": {
+ "description": "A list of all IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "numTotalNatPorts": {
+ "description": "Total number of ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field nat_ip_port_ranges.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "drainNatIpPortRanges": {
+ "description": "List of all drain IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "numTotalDrainNatPorts": {
+ "format": "int32",
+ "description": "Total number of drain ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field drain_nat_ip_port_ranges.",
+ "type": "integer"
+ },
+ "ruleNumber": {
+ "format": "int32",
+ "type": "integer",
+ "description": "Rule number of the NAT Rule."
+ }
+ },
+ "id": "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings",
+ "description": "Contains information of NAT Mappings provided by a NAT Rule.",
+ "type": "object"
+ },
+ "UrlMapList": {
+ "description": "Contains a list of UrlMap resources.",
+ "id": "UrlMapList",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#urlMapList",
+ "description": "Type of resource.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "data": {
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
},
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "project": {
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "type": "string"
}
},
- "id": "compute.instanceGroupManagers.listManagedInstances",
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances"
+ "type": "object"
},
- "get": {
- "parameters": {
- "instanceGroupManager": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "The name of the managed instance group."
+ "items": {
+ "type": "array",
+ "description": "A list of UrlMap resources.",
+ "items": {
+ "$ref": "UrlMap"
+ }
+ }
+ }
+ },
+ "InterconnectAttachmentList": {
+ "type": "object",
+ "description": "Response to the list request, and contains a list of interconnect attachments.",
+ "id": "InterconnectAttachmentList",
+ "properties": {
+ "items": {
+ "description": "A list of InterconnectAttachment resources.",
+ "type": "array",
+ "items": {
+ "$ref": "InterconnectAttachment"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "warning": {
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "project": {
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "data": {
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "zone": {
- "required": true,
- "location": "path",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "description": "The name of the zone where the managed instance group is located."
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
},
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.",
+ "type": "string",
+ "default": "compute#interconnectAttachmentList"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ }
+ }
+ },
+ "SecurityPolicyRuleMatcher": {
+ "type": "object",
+ "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.",
+ "id": "SecurityPolicyRuleMatcher",
+ "properties": {
+ "versionedExpr": {
+ "enum": [
+ "SRC_IPS_V1"
],
- "description": "Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.",
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
+ "enumDescriptions": [
+ "Matches the source IP address of a request to the IP ranges supplied in config."
],
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
- "response": {
- "$ref": "InstanceGroupManager"
- },
- "id": "compute.instanceGroupManagers.get"
+ "description": "Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.",
+ "type": "string"
},
- "resize": {
- "response": {
- "$ref": "Operation"
+ "config": {
+ "description": "The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.",
+ "$ref": "SecurityPolicyRuleMatcherConfig"
+ },
+ "expr": {
+ "$ref": "Expr",
+ "description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header."
+ }
+ }
+ },
+ "ProjectsListXpnHostsRequest": {
+ "id": "ProjectsListXpnHostsRequest",
+ "type": "object",
+ "properties": {
+ "organization": {
+ "description": "Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project.",
+ "type": "string"
+ }
+ }
+ },
+ "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": {
+ "type": "object",
+ "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse",
+ "properties": {
+ "firewallPolicys": {
+ "items": {
+ "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
},
- "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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 removed or deleted.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager",
- "size"
- ],
- "id": "compute.instanceGroupManagers.resize",
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
- "parameters": {
- "instanceGroupManager": {
- "location": "path",
- "type": "string",
- "required": true,
- "description": "The name of the managed instance group."
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true
- },
- "zone": {
- "description": "The name of the zone where the managed instance group is located.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "size": {
- "location": "query",
- "required": true,
- "format": "int32",
- "description": "The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.",
- "type": "integer"
- }
+ "description": "Effective firewalls from firewall policy.",
+ "type": "array"
+ },
+ "firewalls": {
+ "description": "Effective firewalls on the network.",
+ "type": "array",
+ "items": {
+ "$ref": "Firewall"
+ }
+ }
+ }
+ },
+ "TargetVpnGateway": {
+ "id": "TargetVpnGateway",
+ "properties": {
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#targetVpnGateway",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways."
+ },
+ "region": {
+ "description": "[Output Only] URL of the region where the target VPN gateway 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"
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "compute.targetVpnGateways.insert"
+ ]
},
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize"
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "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.",
+ "type": "string"
},
- "applyUpdatesToInstances": {
- "parameters": {
- "zone": {
- "description": "The name of the zone where the managed instance group is located. Should conform to RFC1035.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "instanceGroupManager": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the managed instance group, should conform to RFC1035."
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true
- }
+ "tunnels": {
+ "items": {
+ "type": "string"
},
- "request": {
- "$ref": "InstanceGroupManagersApplyUpdatesRequest"
+ "description": "[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.",
+ "type": "array"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "status": {
+ "description": "[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "CREATING",
+ "DELETING",
+ "FAILED",
+ "READY"
+ ]
+ },
+ "network": {
+ "description": "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.",
+ "type": "string",
+ "annotations": {
+ "required": [
+ "compute.targetVpnGateways.insert"
+ ]
+ }
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "forwardingRules": {
+ "type": "array",
+ "description": "[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "type": "object",
+ "description": "Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview."
+ },
+ "TestFailure": {
+ "id": "TestFailure",
+ "properties": {
+ "actualService": {
+ "type": "string",
+ "description": "BackendService or BackendBucket returned by load balancer."
+ },
+ "headers": {
+ "type": "array",
+ "description": "HTTP headers of the request.",
+ "items": {
+ "$ref": "UrlMapTestHeader"
+ }
+ },
+ "expectedRedirectResponseCode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Expected HTTP status code for rule with `urlRedirect` calculated by load balancer"
+ },
+ "actualRedirectResponseCode": {
+ "description": "Actual HTTP status code for rule with `urlRedirect` calculated by load balancer",
+ "format": "int32",
+ "type": "integer"
+ },
+ "path": {
+ "type": "string",
+ "description": "Path portion including query parameters in the URL."
+ },
+ "host": {
+ "description": "Host portion of the URL.",
+ "type": "string"
+ },
+ "actualOutputUrl": {
+ "description": "The actual output URL evaluated by a load balancer containing the scheme, host, path and query parameters.",
+ "type": "string"
+ },
+ "expectedService": {
+ "type": "string",
+ "description": "Expected BackendService or BackendBucket resource the given URL should be mapped to."
+ },
+ "expectedOutputUrl": {
+ "description": "The expected output URL evaluated by a load balancer containing the scheme, host, path and query parameters.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AllocationSpecificSKUReservation": {
+ "id": "AllocationSpecificSKUReservation",
+ "type": "object",
+ "description": "This reservation type allows to pre allocate specific instance configuration. Next ID: 6",
+ "properties": {
+ "inUseCount": {
+ "format": "int64",
+ "type": "string",
+ "description": "[Output Only] Indicates how many instances are in use."
+ },
+ "count": {
+ "description": "Specifies the number of resources that are allocated.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sourceInstanceTemplate": {
+ "description": "Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate ",
+ "type": "string"
+ },
+ "assuredCount": {
+ "format": "int64",
+ "type": "string",
+ "description": "[Output Only] Indicates how many instances are actually usable currently."
+ },
+ "instanceProperties": {
+ "$ref": "AllocationSpecificSKUAllocationReservedInstanceProperties",
+ "description": "The instance properties for the reservation."
+ }
+ }
+ },
+ "TargetPoolsAddInstanceRequest": {
+ "properties": {
+ "instances": {
+ "description": "A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone /instances/instance-name - projects/project-id/zones/zone/instances/instance-name - zones/zone/instances/instance-name ",
+ "type": "array",
+ "items": {
+ "$ref": "InstanceReference"
+ }
+ }
+ },
+ "id": "TargetPoolsAddInstanceRequest",
+ "type": "object"
+ },
+ "Policy": {
+ "properties": {
+ "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"
},
- "response": {
- "$ref": "Operation"
+ "type": "array"
+ },
+ "rules": {
+ "items": {
+ "$ref": "Rule"
},
- "description": "Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.",
- "id": "compute.instanceGroupManagers.applyUpdatesToInstances",
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "type": "array",
+ "description": "This is deprecated and has no effect. Do not use."
},
- "patchPerInstanceConfigs": {
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "id": "compute.instanceGroupManagers.patchPerInstanceConfigs",
- "description": "Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.",
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
- "response": {
- "$ref": "Operation"
+ "auditConfigs": {
+ "type": "array",
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
+ "version": {
+ "format": "int32",
+ "type": "integer",
+ "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)."
+ },
+ "etag": {
+ "type": "string",
+ "format": "byte",
+ "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."
+ }
+ },
+ "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 \u003c 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 \u003c 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/).",
+ "type": "object",
+ "id": "Policy"
+ },
+ "RegionInstanceGroupManagerDeleteInstanceConfigReq": {
+ "description": "RegionInstanceGroupManagers.deletePerInstanceConfigs",
+ "properties": {
+ "names": {
+ "description": "The list of instance names for which we want to delete per-instance configs on this managed instance group.",
+ "items": {
+ "type": "string"
},
- "httpMethod": "POST",
- "request": {
- "$ref": "InstanceGroupManagersPatchPerInstanceConfigsReq"
+ "type": "array"
+ }
+ },
+ "type": "object",
+ "id": "RegionInstanceGroupManagerDeleteInstanceConfigReq"
+ },
+ "RegionInstanceGroupManagersSetTargetPoolsRequest": {
+ "id": "RegionInstanceGroupManagersSetTargetPoolsRequest",
+ "properties": {
+ "targetPools": {
+ "description": "The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.",
+ "items": {
+ "type": "string"
},
- "parameters": {
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string"
+ "type": "array"
+ },
+ "fingerprint": {
+ "description": "Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RequestMirrorPolicy": {
+ "type": "object",
+ "id": "RequestMirrorPolicy",
+ "properties": {
+ "backendService": {
+ "description": "The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. ",
+ "type": "string"
+ }
+ },
+ "description": "A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow."
+ },
+ "NodeGroupsScopedList": {
+ "properties": {
+ "nodeGroups": {
+ "type": "array",
+ "description": "[Output Only] A list of node groups contained in this scope.",
+ "items": {
+ "$ref": "NodeGroup"
+ }
+ },
+ "warning": {
+ "type": "object",
+ "description": "[Output Only] An informational warning that appears when the nodeGroup list is empty.",
+ "properties": {
+ "data": {
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ }
+ },
+ "type": "object"
+ },
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "type": "array"
},
- "zone": {
+ "message": {
"type": "string",
- "required": true,
- "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.",
- "location": "path"
- },
- "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).",
- "location": "query",
- "type": "string"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "instanceGroupManager": {
- "location": "path",
- "description": "The name of the managed instance group. It should conform to RFC1035.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "listErrors": {
- "parameters": {
- "project": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "maxResults": {
- "minimum": "0",
- "location": "query",
- "type": "integer",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32"
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "instanceGroupManager": {
- "description": "The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.",
- "required": true,
- "location": "path",
- "type": "string"
- },
- "zone": {
- "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
- },
- "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors",
- "description": "Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors",
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "zone",
- "instanceGroupManager"
- ],
- "response": {
- "$ref": "InstanceGroupManagersListErrorsResponse"
- },
- "id": "compute.instanceGroupManagers.listErrors"
+ }
}
- }
+ },
+ "type": "object",
+ "id": "NodeGroupsScopedList"
},
- "disks": {
- "methods": {
- "setLabels": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "project",
- "zone",
- "resource"
- ],
- "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/setLabels",
- "description": "Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.",
- "httpMethod": "POST",
- "path": "projects/{project}/zones/{zone}/disks/{resource}/setLabels",
- "parameters": {
- "zone": {
- "description": "The name of the zone for this request.",
- "location": "path",
- "required": true,
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
+ "NetworkEdgeSecurityService": {
+ "properties": {
+ "name": {
+ "description": "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.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "kind": {
+ "description": "[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices",
+ "type": "string",
+ "default": "compute#networkEdgeSecurityService"
+ },
+ "selfLinkWithId": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource with the resource id."
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "fingerprint": {
+ "format": "byte",
+ "type": "string",
+ "description": "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 NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService."
+ },
+ "securityPolicy": {
+ "type": "string",
+ "description": "The resource URL for the network edge security service associated with this network edge security service."
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ }
+ },
+ "id": "NetworkEdgeSecurityService",
+ "type": "object",
+ "description": "Represents a Google Cloud Armor network edge security service resource."
+ },
+ "SecurityPolicyAdaptiveProtectionConfig": {
+ "properties": {
+ "layer7DdosDefenseConfig": {
+ "$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig",
+ "description": "If set to true, enables Cloud Armor Machine Learning."
+ }
+ },
+ "type": "object",
+ "description": "Configuration options for Cloud Armor Adaptive Protection (CAAP).",
+ "id": "SecurityPolicyAdaptiveProtectionConfig"
+ },
+ "UsageExportLocation": {
+ "description": "The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.",
+ "properties": {
+ "reportNamePrefix": {
+ "type": "string",
+ "description": "An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage_gce. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions."
+ },
+ "bucketName": {
+ "description": "The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.",
+ "type": "string"
+ }
+ },
+ "id": "UsageExportLocation",
+ "type": "object"
+ },
+ "SecurityPoliciesAggregatedList": {
+ "id": "SecurityPoliciesAggregatedList",
+ "properties": {
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "kind": {
+ "description": "[Output Only] Type of resource. Always compute#securityPolicyAggregatedList for lists of Security Policies.",
+ "default": "compute#securityPoliciesAggregatedList",
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string"
},
- "resource": {
- "location": "path",
+ "message": {
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name or id of the resource for this request."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "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).",
- "type": "string",
- "location": "query"
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array"
}
},
- "request": {
- "$ref": "ZoneSetLabelsRequest"
- },
- "id": "compute.disks.setLabels"
+ "type": "object"
},
- "createSnapshot": {
- "request": {
- "$ref": "Snapshot"
+ "items": {
+ "description": "A list of SecurityPoliciesScopedList resources.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "SecurityPoliciesScopedList",
+ "description": "Name of the scope containing this set of security policies."
+ }
+ },
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot",
- "httpMethod": "POST",
- "id": "compute.disks.createSnapshot",
- "parameters": {
- "zone": {
- "description": "The name of the zone for this request.",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "[Output Only] Unreachable resources.",
+ "type": "array"
+ },
+ "etag": {
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "type": "object"
+ },
+ "InstanceGroupManagersScopedList": {
+ "id": "InstanceGroupManagersScopedList",
+ "properties": {
+ "warning": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request.",
- "required": true
- },
- "guestFlush": {
- "location": "query",
- "description": "[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.",
- "type": "boolean"
- },
- "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).",
- "location": "query",
- "type": "string"
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ }
},
- "disk": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the persistent disk to snapshot.",
- "required": true,
- "location": "path",
- "type": "string"
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
}
},
- "response": {
- "$ref": "Operation"
+ "description": "[Output Only] The warning that replaces the list of managed instance groups when the list is empty."
+ },
+ "instanceGroupManagers": {
+ "items": {
+ "$ref": "InstanceGroupManager"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "array",
+ "description": "[Output Only] The list of managed instance groups that are contained in the specified project and zone."
+ }
+ },
+ "type": "object"
+ },
+ "InstanceWithNamedPorts": {
+ "type": "object",
+ "id": "InstanceWithNamedPorts",
+ "properties": {
+ "namedPorts": {
+ "description": "[Output Only] The named ports that belong to this instance group.",
+ "type": "array",
+ "items": {
+ "$ref": "NamedPort"
+ }
+ },
+ "status": {
+ "enum": [
+ "DEPROVISIONING",
+ "PROVISIONING",
+ "REPAIRING",
+ "RUNNING",
+ "STAGING",
+ "STOPPED",
+ "STOPPING",
+ "SUSPENDED",
+ "SUSPENDING",
+ "TERMINATED"
],
- "parameterOrder": [
- "project",
- "zone",
- "disk"
+ "enumDescriptions": [
+ "The Nanny is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.",
+ "Resources are being allocated for the instance.",
+ "The instance is in repair.",
+ "The instance is running.",
+ "All required resources have been allocated and the instance is being started.",
+ "The instance has stopped successfully.",
+ "The instance is currently stopping (either being deleted or killed).",
+ "The instance has suspended.",
+ "The instance is suspending.",
+ "The instance has stopped (either by explicit action or underlying failure)."
],
- "path": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot",
- "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."
+ "description": "[Output Only] The status of the instance.",
+ "type": "string"
},
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.",
- "path": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions",
- "parameters": {
- "resource": {
- "description": "Name or id of the resource for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "location": "path"
+ "instance": {
+ "type": "string",
+ "description": "[Output Only] The URL of the instance."
+ }
+ }
+ },
+ "SecurityPolicyDdosProtectionConfig": {
+ "type": "object",
+ "id": "SecurityPolicyDdosProtectionConfig",
+ "properties": {
+ "ddosProtection": {
+ "enum": [
+ "ADVANCED",
+ "STANDARD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ }
+ }
+ },
+ "MetadataFilterLabelMatch": {
+ "type": "object",
+ "id": "MetadataFilterLabelMatch",
+ "description": "MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the load balancer.",
+ "properties": {
+ "value": {
+ "description": "The value of the label must match the specified value. value can have a maximum length of 1024 characters.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long."
+ }
+ }
+ },
+ "HealthCheckList": {
+ "description": "Contains a list of HealthCheck resources.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ },
+ "items": {
+ "description": "A list of HealthCheck resources.",
+ "type": "array",
+ "items": {
+ "$ref": "HealthCheck"
+ }
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
},
- "project": {
+ "code": {
"type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "zone": {
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "The name of the zone for this request."
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
}
},
- "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions",
- "response": {
- "$ref": "TestPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.disks.testIamPermissions",
- "request": {
- "$ref": "TestPermissionsRequest"
+ "type": "object"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Type of resource.",
+ "type": "string",
+ "default": "compute#healthCheckList"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "id": "HealthCheckList",
+ "type": "object"
+ },
+ "CustomerEncryptionKeyProtectedDisk": {
+ "properties": {
+ "source": {
+ "description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. For example: \"source\": \"/compute/v1/projects/project_id/zones/zone/disks/ disk_name ",
+ "type": "string"
+ },
+ "diskEncryptionKey": {
+ "description": "Decrypts data associated with the disk with a customer-supplied encryption key.",
+ "$ref": "CustomerEncryptionKey"
+ }
+ },
+ "type": "object",
+ "id": "CustomerEncryptionKeyProtectedDisk"
+ },
+ "RegionSetPolicyRequest": {
+ "id": "RegionSetPolicyRequest",
+ "type": "object",
+ "properties": {
+ "bindings": {
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
},
- "parameterOrder": [
- "project",
- "zone",
- "resource"
+ "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings."
+ },
+ "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 in general a valid policy but certain services (like Projects) might reject them."
+ },
+ "etag": {
+ "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
+ "format": "byte",
+ "type": "string"
+ }
+ }
+ },
+ "CacheInvalidationRule": {
+ "type": "object",
+ "id": "CacheInvalidationRule",
+ "properties": {
+ "path": {
+ "type": "string"
+ },
+ "host": {
+ "type": "string",
+ "description": "If set, this invalidation rule will only apply to requests with a Host header matching host."
+ }
+ }
+ },
+ "ExternalVpnGatewayInterface": {
+ "type": "object",
+ "description": "The interface for the external VPN gateway.",
+ "id": "ExternalVpnGatewayInterface",
+ "properties": {
+ "ipAddress": {
+ "description": "IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.",
+ "type": "string"
+ },
+ "id": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3 "
+ }
+ }
+ },
+ "SubnetworksSetPrivateIpGoogleAccessRequest": {
+ "id": "SubnetworksSetPrivateIpGoogleAccessRequest",
+ "type": "object",
+ "properties": {
+ "privateIpGoogleAccess": {
+ "type": "boolean"
+ }
+ }
+ },
+ "Zone": {
+ "description": "Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones.",
+ "id": "Zone",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "[Output Only] Name of the resource."
+ },
+ "id": {
+ "type": "string",
+ "format": "uint64",
+ "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for the resource."
+ },
+ "supportsPzs": {
+ "type": "boolean",
+ "description": "[Output Only] Reserved for future use."
+ },
+ "region": {
+ "description": "[Output Only] Full URL reference to the region which hosts the zone.",
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "[Output Only] Status of the zone, either UP or DOWN.",
+ "enumDescriptions": [
+ "",
+ ""
],
- "httpMethod": "POST"
+ "enum": [
+ "DOWN",
+ "UP"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "description": "[Output Only] Textual description of the resource."
+ },
+ "availableCpuPlatforms": {
+ "type": "array",
+ "description": "[Output Only] Available cpu/platform selections for the zone.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "creationTimestamp": {
+ "description": "[Output Only] Creation timestamp in RFC3339 text format.",
+ "type": "string"
+ },
+ "deprecated": {
+ "$ref": "DeprecationStatus",
+ "description": "[Output Only] The deprecation status associated with this zone."
},
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project",
- "zone"
- ],
- "response": {
- "$ref": "DiskList"
- },
- "path": "projects/{project}/zones/{zone}/disks",
- "parameters": {
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "location": "query",
- "format": "uint32",
- "default": "500",
- "minimum": "0"
- },
- "returnPartialSuccess": {
- "location": "query",
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "zone": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "location": "path",
- "description": "The name of the zone for this request.",
- "required": true
- },
- "project": {
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "description": "Project ID for this request."
- },
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query",
- "type": "string"
- }
+ "kind": {
+ "default": "compute#zone",
+ "type": "string",
+ "description": "[Output Only] Type of the resource. Always compute#zone for zones."
+ }
+ }
+ },
+ "InstancesSetMachineResourcesRequest": {
+ "type": "object",
+ "properties": {
+ "guestAccelerators": {
+ "description": "A list of the type and count of accelerator cards attached to the instance.",
+ "items": {
+ "$ref": "AcceleratorConfig"
},
- "id": "compute.disks.list",
- "flatPath": "projects/{project}/zones/{zone}/disks",
- "description": "Retrieves a list of persistent disks contained within the specified zone.",
- "httpMethod": "GET"
+ "type": "array"
+ }
+ },
+ "id": "InstancesSetMachineResourcesRequest"
+ },
+ "TargetPoolsAddHealthCheckRequest": {
+ "properties": {
+ "healthChecks": {
+ "type": "array",
+ "description": "The HttpHealthCheck to add to the target pool.",
+ "items": {
+ "$ref": "HealthCheckReference"
+ }
+ }
+ },
+ "id": "TargetPoolsAddHealthCheckRequest",
+ "type": "object"
+ },
+ "ResourceCommitment": {
+ "description": "Commitment for a particular resource (a Commitment is composed of one or more of these).",
+ "properties": {
+ "acceleratorType": {
+ "type": "string",
+ "description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR."
},
- "aggregatedList": {
- "httpMethod": "GET",
- "id": "compute.disks.aggregatedList",
- "parameters": {
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "type": "boolean",
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "type": "integer",
- "location": "query",
- "default": "500",
- "minimum": "0"
- },
- "includeAllScopes": {
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
- "location": "query"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Project ID for this request."
- },
- "orderBy": {
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- }
- },
- "flatPath": "projects/{project}/aggregated/disks",
- "parameterOrder": [
- "project"
+ "type": {
+ "description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.",
+ "enum": [
+ "ACCELERATOR",
+ "LOCAL_SSD",
+ "MEMORY",
+ "UNSPECIFIED",
+ "VCPU"
],
- "response": {
- "$ref": "DiskAggregatedList"
- },
- "description": "Retrieves an aggregated list of persistent disks.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
],
- "path": "projects/{project}/aggregated/disks"
+ "type": "string"
},
- "addResourcePolicies": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "disk": {
- "description": "The disk name for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "type": "string",
- "description": "Project ID for this request."
- },
- "zone": {
- "type": "string",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request."
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- }
+ "amount": {
+ "type": "string",
+ "format": "int64",
+ "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU."
+ }
+ },
+ "id": "ResourceCommitment",
+ "type": "object"
+ },
+ "GlobalNetworkEndpointGroupsAttachEndpointsRequest": {
+ "properties": {
+ "networkEndpoints": {
+ "type": "array",
+ "items": {
+ "$ref": "NetworkEndpoint"
},
- "httpMethod": "POST",
- "id": "compute.disks.addResourcePolicies",
- "description": "Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.",
- "parameterOrder": [
- "project",
- "zone",
- "disk"
- ],
- "response": {
- "$ref": "Operation"
+ "description": "The list of network endpoints to be attached."
+ }
+ },
+ "type": "object",
+ "id": "GlobalNetworkEndpointGroupsAttachEndpointsRequest"
+ },
+ "InstanceGroupManagersSetInstanceTemplateRequest": {
+ "type": "object",
+ "properties": {
+ "instanceTemplate": {
+ "type": "string",
+ "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE."
+ }
+ },
+ "id": "InstanceGroupManagersSetInstanceTemplateRequest"
+ },
+ "InstancesGetEffectiveFirewallsResponse": {
+ "id": "InstancesGetEffectiveFirewallsResponse",
+ "properties": {
+ "firewalls": {
+ "items": {
+ "$ref": "Firewall"
},
- "request": {
- "$ref": "DisksAddResourcePoliciesRequest"
+ "type": "array",
+ "description": "Effective firewalls on the instance."
+ },
+ "firewallPolicys": {
+ "items": {
+ "$ref": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
},
- "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies",
- "path": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies"
+ "type": "array",
+ "description": "Effective firewalls from firewall policies."
+ }
+ },
+ "type": "object"
+ },
+ "ServiceAttachmentAggregatedList": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
},
- "get": {
- "parameters": {
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "warning": {
+ "properties": {
+ "code": {
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"type": "string",
- "location": "path",
- "description": "Project ID for this request."
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ]
},
- "zone": {
- "description": "The name of the zone for this request.",
+ "message": {
"type": "string",
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "disk": {
- "required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the persistent disk to return."
+ "data": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ }
+ }
+ },
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
},
- "response": {
- "$ref": "Disk"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "parameterOrder": [
- "project",
- "zone",
- "disk"
- ],
- "path": "projects/{project}/zones/{zone}/disks/{disk}",
- "flatPath": "projects/{project}/zones/{zone}/disks/{disk}",
- "id": "compute.disks.get",
- "description": "Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request."
+ "type": "object",
+ "description": "[Output Only] Informational warning message."
},
- "delete": {
- "id": "compute.disks.delete",
- "httpMethod": "DELETE",
- "flatPath": "projects/{project}/zones/{zone}/disks/{disk}",
- "parameterOrder": [
- "project",
- "zone",
- "disk"
- ],
- "path": "projects/{project}/zones/{zone}/disks/{disk}",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "description": "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.",
- "response": {
- "$ref": "Operation"
+ "unreachables": {
+ "items": {
+ "type": "string"
},
- "parameters": {
- "disk": {
- "required": true,
- "type": "string",
- "description": "Name of the persistent disk to delete.",
- "location": "path"
- },
- "project": {
- "location": "path",
- "type": "string",
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "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).",
- "location": "query",
- "type": "string"
- },
- "zone": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "The name of the zone for this request.",
- "location": "path"
- }
- }
+ "type": "array",
+ "description": "[Output Only] Unreachable resources."
},
- "resize": {
- "path": "projects/{project}/zones/{zone}/disks/{disk}/resize",
- "description": "Resizes the specified persistent disk. You can only increase the size of the disk.",
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/resize",
- "request": {
- "$ref": "DisksResizeRequest"
+ "nextPageToken": {
+ "type": "string",
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "items": {
+ "description": "A list of ServiceAttachmentsScopedList resources.",
+ "additionalProperties": {
+ "description": "Name of the scope containing this set of ServiceAttachments.",
+ "$ref": "ServiceAttachmentsScopedList"
},
- "parameterOrder": [
- "project",
- "zone",
- "disk"
- ],
- "parameters": {
- "requestId": {
+ "type": "object"
+ },
+ "kind": {
+ "description": "Type of resource.",
+ "default": "compute#serviceAttachmentAggregatedList",
+ "type": "string"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ }
+ },
+ "id": "ServiceAttachmentAggregatedList",
+ "description": "Contains a list of ServiceAttachmentsScopedList."
+ },
+ "TargetVpnGatewaysScopedList": {
+ "type": "object",
+ "properties": {
+ "warning": {
+ "type": "object",
+ "properties": {
+ "message": {
"type": "string",
- "location": "query",
- "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)."
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "zone": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "location": "path",
- "required": true,
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string"
},
- "project": {
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true
- },
- "disk": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "The name of the persistent disk.",
- "location": "path",
- "required": true
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
}
},
- "id": "compute.disks.resize",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty."
},
- "insert": {
- "id": "compute.disks.insert",
- "request": {
- "$ref": "Disk"
+ "targetVpnGateways": {
+ "type": "array",
+ "items": {
+ "$ref": "TargetVpnGateway"
},
- "path": "projects/{project}/zones/{zone}/disks",
- "response": {
- "$ref": "Operation"
+ "description": "[Output Only] A list of target VPN gateways contained in this scope."
+ }
+ },
+ "id": "TargetVpnGatewaysScopedList"
+ },
+ "InstanceGroupManagersRecreateInstancesRequest": {
+ "properties": {
+ "instances": {
+ "items": {
+ "type": "string"
},
- "description": "Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.",
- "httpMethod": "POST",
- "flatPath": "projects/{project}/zones/{zone}/disks",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": "array",
+ "description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]."
+ }
+ },
+ "id": "InstanceGroupManagersRecreateInstancesRequest",
+ "type": "object"
+ },
+ "InstanceGroupManagerActionsSummary": {
+ "id": "InstanceGroupManagerActionsSummary",
+ "properties": {
+ "creating": {
+ "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "suspending": {
+ "type": "integer",
+ "format": "int32",
+ "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended."
+ },
+ "none": {
+ "description": "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "refreshing": {
+ "description": "[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "resuming": {
+ "format": "int32",
+ "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.",
+ "type": "integer"
+ },
+ "verifying": {
+ "description": "[Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "stopping": {
+ "format": "int32",
+ "type": "integer",
+ "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped."
+ },
+ "abandoning": {
+ "type": "integer",
+ "format": "int32",
+ "description": "[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it."
+ },
+ "restarting": {
+ "format": "int32",
+ "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.",
+ "type": "integer"
+ },
+ "recreating": {
+ "type": "integer",
+ "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.",
+ "format": "int32"
+ },
+ "starting": {
+ "type": "integer",
+ "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.",
+ "format": "int32"
+ },
+ "creatingWithoutRetries": {
+ "format": "int32",
+ "type": "integer",
+ "description": "[Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly."
+ },
+ "deleting": {
+ "format": "int32",
+ "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "StatefulPolicyPreservedStateDiskDevice": {
+ "type": "object",
+ "id": "StatefulPolicyPreservedStateDiskDevice",
+ "properties": {
+ "autoDelete": {
+ "enum": [
+ "NEVER",
+ "ON_PERMANENT_INSTANCE_DELETION"
],
- "parameterOrder": [
- "project",
- "zone"
+ "enumDescriptions": [
+ "",
+ ""
],
- "parameters": {
- "sourceImage": {
- "location": "query",
- "description": "Source image to restore onto a disk. This field is optional.",
- "type": "string"
+ "type": "string",
+ "description": "These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted."
+ }
+ }
+ },
+ "InterconnectLocationList": {
+ "description": "Response to the list request, and contains a list of interconnect locations.",
+ "id": "InterconnectLocationList",
+ "properties": {
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "warning": {
+ "properties": {
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "requestId": {
- "location": "query",
- "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).",
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
},
- "zone": {
- "description": "The name of the zone for this request.",
- "type": "string",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "description": "Project ID for this request.",
+ "code": {
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
"type": "string",
- "location": "path"
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ]
}
- }
+ },
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
},
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
+ "selfLink": {
+ "type": "string",
+ "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "kind": {
+ "default": "compute#interconnectLocationList",
+ "type": "string",
+ "description": "[Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations."
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "items": {
+ "items": {
+ "$ref": "InterconnectLocation"
},
- "parameterOrder": [
- "project",
- "zone",
- "resource"
- ],
- "request": {
- "$ref": "ZoneSetPolicyRequest"
+ "description": "A list of InterconnectLocation resources.",
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OutlierDetection": {
+ "id": "OutlierDetection",
+ "description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.",
+ "properties": {
+ "enforcingConsecutiveErrors": {
+ "format": "int32",
+ "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
+ "type": "integer"
+ },
+ "consecutiveGatewayFailure": {
+ "format": "int32",
+ "description": "The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
+ "type": "integer"
+ },
+ "baseEjectionTime": {
+ "$ref": "Duration",
+ "description": "The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s."
+ },
+ "successRateMinimumHosts": {
+ "description": "The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "successRateStdevFactor": {
+ "description": "This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxEjectionPercent": {
+ "format": "int32",
+ "description": "Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.",
+ "type": "integer"
+ },
+ "interval": {
+ "description": "Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.",
+ "$ref": "Duration"
+ },
+ "enforcingConsecutiveGatewayFailure": {
+ "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "consecutiveErrors": {
+ "description": "Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "successRateRequestVolume": {
+ "type": "integer",
+ "description": "The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.",
+ "format": "int32"
+ },
+ "enforcingSuccessRate": {
+ "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.",
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "type": "object"
+ },
+ "InstanceGroupsAddInstancesRequest": {
+ "type": "object",
+ "id": "InstanceGroupsAddInstancesRequest",
+ "properties": {
+ "instances": {
+ "items": {
+ "$ref": "InstanceReference"
},
- "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "id": "compute.disks.setIamPolicy",
- "path": "projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy",
- "parameters": {
- "zone": {
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "location": "path",
- "description": "The name of the zone for this request."
- },
- "resource": {
- "location": "path",
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true
- }
+ "type": "array",
+ "description": "The list of instances to add to the instance group."
+ }
+ }
+ },
+ "NotificationEndpoint": {
+ "properties": {
+ "id": {
+ "format": "uint64",
+ "type": "string",
+ "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier."
+ },
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.",
+ "type": "string",
+ "default": "compute#notificationEndpoint"
+ },
+ "grpcSettings": {
+ "$ref": "NotificationEndpointGrpcSettings",
+ "description": "Settings of the gRPC notification endpoint including the endpoint URL and the retry duration."
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you create the resource.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "description": "[Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
+ },
+ "name": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "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.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "type": "string",
+ "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ }
+ },
+ "id": "NotificationEndpoint",
+ "description": "Represents a notification endpoint. A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. For more information, see Health checks overview.",
+ "type": "object"
+ },
+ "NetworkEndpoint": {
+ "type": "object",
+ "properties": {
+ "port": {
+ "description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "fqdn": {
+ "type": "string",
+ "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT."
+ },
+ "ipAddress": {
+ "description": "Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.",
+ "type": "string"
+ },
+ "instance": {
+ "type": "string",
+ "description": "The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035."
+ },
+ "annotations": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST"
+ "description": "Metadata defined as annotations on the network endpoint."
+ }
+ },
+ "id": "NetworkEndpoint",
+ "description": "The network endpoint."
+ },
+ "ShieldedInstanceIdentity": {
+ "description": "A Shielded Instance Identity.",
+ "properties": {
+ "signingKey": {
+ "description": "An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.",
+ "$ref": "ShieldedInstanceIdentityEntry"
},
- "getIamPolicy": {
- "httpMethod": "GET",
- "id": "compute.disks.getIamPolicy",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy",
- "parameters": {
- "zone": {
- "description": "The name of the zone for this request.",
+ "kind": {
+ "description": "[Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.",
+ "default": "compute#shieldedInstanceIdentity",
+ "type": "string"
+ },
+ "encryptionKey": {
+ "description": "An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.",
+ "$ref": "ShieldedInstanceIdentityEntry"
+ }
+ },
+ "id": "ShieldedInstanceIdentity",
+ "type": "object"
+ },
+ "ResourcePolicySnapshotSchedulePolicySchedule": {
+ "type": "object",
+ "properties": {
+ "hourlySchedule": {
+ "$ref": "ResourcePolicyHourlyCycle"
+ },
+ "weeklySchedule": {
+ "$ref": "ResourcePolicyWeeklyCycle"
+ },
+ "dailySchedule": {
+ "$ref": "ResourcePolicyDailyCycle"
+ }
+ },
+ "description": "A schedule for disks where the schedueled operations are performed.",
+ "id": "ResourcePolicySnapshotSchedulePolicySchedule"
+ },
+ "NodeTemplateAggregatedList": {
+ "properties": {
+ "warning": {
+ "properties": {
+ "code": {
"type": "string",
- "location": "path",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "optionsRequestedPolicyVersion": {
- "description": "Requested IAM Policy version.",
- "format": "int32",
- "location": "query",
- "type": "integer"
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed operation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as deprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as experimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden. Deprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the network.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite the mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "The user attempted to use a resource that requires a TOS they have not accepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted because they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
},
- "project": {
- "required": true,
+ "message": {
"type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path"
+ "description": "[Output Only] A human-readable description of the warning code."
},
- "resource": {
- "type": "string",
- "description": "Name or id of the resource for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "location": "path"
+ "data": {
+ "type": "array",
+ "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "[Output Only] A warning data value corresponding to the key."
+ }
+ },
+ "type": "object"
+ }
}
},
- "path": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy",
- "parameterOrder": [
- "project",
- "zone",
- "resource"
- ],
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "response": {
- "$ref": "Policy"
+ "description": "[Output Only] Informational warning message.",
+ "type": "object"
+ },
+ "items": {
+ "description": "A list of NodeTemplatesScopedList resources.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "[Output Only] Name of the scope containing this set of node templates.",
+ "$ref": "NodeTemplatesScopedList"
}
},
- "removeResourcePolicies": {
- "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies",
- "request": {
- "$ref": "DisksRemoveResourcePoliciesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "description": "Removes resource policies from a disk.",
- "path": "projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies",
- "httpMethod": "POST",
- "parameters": {
- "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).",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the zone for this request.",
- "location": "path"
- },
- "project": {
- "location": "path",
- "description": "Project ID for this request.",
- "required": true,
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
- },
- "disk": {
- "description": "The disk name for this request.",
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
+ "unreachables": {
+ "description": "[Output Only] Unreachable resources.",
+ "items": {
+ "type": "string"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameterOrder": [
- "project",
- "zone",
- "disk"
- ],
- "id": "compute.disks.removeResourcePolicies"
+ "type": "array"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#nodeTemplateAggregatedList",
+ "description": "[Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "[Output Only] Unique identifier for the resource; defined by the server."
}
- }
+ },
+ "id": "NodeTemplateAggregatedList",
+ "type": "object"
},
- "globalAddresses": {
- "methods": {
- "get": {
- "description": "Returns the specified address resource. Gets a list of available addresses by making a list() request.",
- "id": "compute.globalAddresses.get",
- "flatPath": "projects/{project}/global/addresses/{address}",
- "parameters": {
- "address": {
- "type": "string",
- "description": "Name of the address resource to return.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- },
- "project": {
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Address"
+ "PacketMirroringMirroredResourceInfo": {
+ "id": "PacketMirroringMirroredResourceInfo",
+ "properties": {
+ "instances": {
+ "items": {
+ "$ref": "PacketMirroringMirroredResourceInfoInstanceInfo"
},
- "path": "projects/{project}/global/addresses/{address}",
- "parameterOrder": [
- "project",
- "address"
- ]
+ "description": "A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring. Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring. You may specify a maximum of 50 Instances.",
+ "type": "array"
},
- "setLabels": {
- "parameterOrder": [
- "project",
- "resource"
- ],
- "flatPath": "projects/{project}/global/addresses/{resource}/setLabels",
- "path": "projects/{project}/global/addresses/{resource}/setLabels",
- "id": "compute.globalAddresses.setLabels",
- "parameters": {
- "project": {
- "type": "string",
- "location": "path",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- },
- "resource": {
- "type": "string",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name or id of the resource for this request.",
- "location": "path"
- }
- },
- "description": "Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "request": {
- "$ref": "GlobalSetLabelsRequest"
- },
- "response": {
- "$ref": "Operation"
+ "subnetworks": {
+ "items": {
+ "$ref": "PacketMirroringMirroredResourceInfoSubnetInfo"
},
- "httpMethod": "POST"
+ "type": "array",
+ "description": "A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring. You may specify a maximum of 5 subnetworks."
},
- "list": {
- "flatPath": "projects/{project}/global/addresses",
- "parameters": {
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "minimum": "0",
- "location": "query",
- "format": "uint32",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500",
- "type": "integer"
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "orderBy": {
- "location": "query",
- "type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- }
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "path": "projects/{project}/global/addresses",
- "description": "Retrieves a list of global addresses.",
- "id": "compute.globalAddresses.list",
- "response": {
- "$ref": "AddressList"
+ "tags": {
+ "type": "array",
+ "description": "A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored.",
+ "items": {
+ "type": "string"
}
+ }
+ },
+ "type": "object"
+ },
+ "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "[Output Only] The name of the firewall policy."
},
- "insert": {
- "httpMethod": "POST",
- "parameterOrder": [
- "project"
- ],
- "request": {
- "$ref": "Address"
- },
- "description": "Creates an address resource in the specified project by using the data included in the request.",
- "id": "compute.globalAddresses.insert",
- "path": "projects/{project}/global/addresses",
- "flatPath": "projects/{project}/global/addresses",
- "parameters": {
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "project": {
- "required": true,
- "location": "path",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
- }
- },
- "response": {
- "$ref": "Operation"
+ "rules": {
+ "description": "The rules that apply to the network.",
+ "items": {
+ "$ref": "FirewallPolicyRule"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "type": "array"
},
- "delete": {
- "parameters": {
- "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).",
- "type": "string",
- "location": "query"
- },
- "address": {
- "type": "string",
- "location": "path",
- "required": true,
- "description": "Name of the address resource to delete.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.globalAddresses.delete",
- "description": "Deletes the specified address resource.",
- "flatPath": "projects/{project}/global/addresses/{address}",
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "type": {
+ "enum": [
+ "HIERARCHY",
+ "NETWORK",
+ "NETWORK_REGIONAL",
+ "UNSPECIFIED"
],
- "parameterOrder": [
- "project",
- "address"
+ "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ ""
],
- "path": "projects/{project}/global/addresses/{address}"
+ "type": "string"
+ },
+ "displayName": {
+ "description": "[Output Only] The display name of the firewall policy.",
+ "type": "string"
}
- }
+ },
+ "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy",
+ "type": "object"
},
- "backendServices": {
- "methods": {
- "aggregatedList": {
- "description": "Retrieves the list of all BackendService resources, regional and global, available to the specified project.",
- "response": {
- "$ref": "BackendServiceAggregatedList"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameterOrder": [
- "project"
- ],
- "flatPath": "projects/{project}/aggregated/backendServices",
- "httpMethod": "GET",
- "path": "projects/{project}/aggregated/backendServices",
- "id": "compute.backendServices.aggregatedList",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "filter": {
- "location": "query",
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path",
- "description": "Name of the project scoping this request."
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
- "maxResults": {
- "format": "uint32",
- "default": "500",
- "type": "integer",
- "minimum": "0",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "includeAllScopes": {
- "type": "boolean",
- "location": "query",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
- }
+ "GlobalSetPolicyRequest": {
+ "type": "object",
+ "id": "GlobalSetPolicyRequest",
+ "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 in general a valid policy but certain services (like Projects) might reject them."
+ },
+ "etag": {
+ "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
+ "type": "string",
+ "format": "byte"
+ },
+ "bindings": {
+ "type": "array",
+ "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.",
+ "items": {
+ "$ref": "Binding"
}
+ }
+ }
+ },
+ "DiskMoveRequest": {
+ "properties": {
+ "targetDisk": {
+ "description": "The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk ",
+ "type": "string"
},
- "update": {
- "httpMethod": "PUT",
- "path": "projects/{project}/global/backendServices/{backendService}",
- "parameters": {
- "requestId": {
- "location": "query",
- "type": "string",
- "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)."
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "required": true,
- "description": "Project ID for this request.",
- "type": "string"
- },
- "backendService": {
- "location": "path",
- "type": "string",
- "description": "Name of the BackendService resource to update.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- }
- },
- "request": {
- "$ref": "BackendService"
- },
- "flatPath": "projects/{project}/global/backendServices/{backendService}",
- "id": "compute.backendServices.update",
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "response": {
- "$ref": "Operation"
+ "destinationZone": {
+ "type": "string",
+ "description": "The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone "
+ }
+ },
+ "type": "object",
+ "id": "DiskMoveRequest"
+ },
+ "ProjectsDisableXpnResourceRequest": {
+ "type": "object",
+ "id": "ProjectsDisableXpnResourceRequest",
+ "properties": {
+ "xpnResource": {
+ "description": "Service resource (a.k.a service project) ID.",
+ "$ref": "XpnResourceId"
+ }
+ }
+ },
+ "InstancesSetLabelsRequest": {
+ "type": "object",
+ "id": "InstancesSetLabelsRequest",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
},
- "description": "Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "type": "object"
},
+ "labelFingerprint": {
+ "type": "string",
+ "format": "byte",
+ "description": "Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels."
+ }
+ }
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "interconnectAttachments": {
+ "methods": {
"get": {
- "parameters": {
- "backendService": {
- "location": "path",
- "type": "string",
- "description": "Name of the BackendService resource to return.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true
- },
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path"
- }
- },
- "path": "projects/{project}/global/backendServices/{backendService}",
+ "id": "compute.interconnectAttachments.get",
"response": {
- "$ref": "BackendService"
+ "$ref": "InterconnectAttachment"
},
- "id": "compute.backendServices.get",
- "flatPath": "projects/{project}/global/backendServices/{backendService}",
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "description": "Returns the specified BackendService resource. Gets a list of available backend services.",
+ "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ]
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "id": "compute.backendServices.setIamPolicy",
- "parameterOrder": [
- "project",
- "resource"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Policy"
- },
+ "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
+ "description": "Returns the specified interconnect attachment.",
"parameters": {
- "resource": {
- "required": true,
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- },
- "project": {
+ "region": {
+ "description": "Name of the region for this request.",
"required": true,
- "description": "Project ID for this request.",
"location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string"
- }
- },
- "flatPath": "projects/{project}/global/backendServices/{resource}/setIamPolicy",
- "path": "projects/{project}/global/backendServices/{resource}/setIamPolicy",
- "request": {
- "$ref": "GlobalSetPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy."
- },
- "setSecurityPolicy": {
- "response": {
- "$ref": "Operation"
- },
- "request": {
- "$ref": "SecurityPolicyReference"
- },
- "parameters": {
- "project": {
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path"
- },
- "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).",
"type": "string",
- "location": "query"
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
- "backendService": {
- "location": "path",
- "required": true,
- "description": "Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.",
- "type": "string"
- }
- },
- "path": "projects/{project}/global/backendServices/{backendService}/setSecurityPolicy",
- "flatPath": "projects/{project}/global/backendServices/{backendService}/setSecurityPolicy",
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "description": "Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "httpMethod": "POST",
- "id": "compute.backendServices.setSecurityPolicy"
- },
- "deleteSignedUrlKey": {
- "parameters": {
- "backendService": {
- "type": "string",
- "description": "Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.",
+ "interconnectAttachment": {
"location": "path",
- "required": true
- },
- "keyName": {
- "location": "query",
- "description": "The name of the Signed URL Key to delete.",
"type": "string",
- "required": true
- },
- "project": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path"
+ "description": "Name of the interconnect attachment to return."
},
- "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).",
- "type": "string",
- "location": "query"
- }
- },
- "response": {
- "$ref": "Operation"
- },
- "description": "Deletes a key for validating requests with signed URLs for this backend service.",
- "parameterOrder": [
- "project",
- "backendService",
- "keyName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey",
- "id": "compute.backendServices.deleteSignedUrlKey",
- "httpMethod": "POST",
- "path": "projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey"
- },
- "list": {
- "path": "projects/{project}/global/backendServices",
- "id": "compute.backendServices.list",
- "description": "Retrieves the list of BackendService resources available to the specified project.",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "parameters": {
"project": {
- "required": true,
- "description": "Project ID for this request.",
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
- },
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "minimum": "0",
- "type": "integer",
- "default": "500",
- "format": "uint32"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- }
- },
- "flatPath": "projects/{project}/global/backendServices",
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "BackendServiceList"
- },
- "httpMethod": "GET"
- },
- "addSignedUrlKey": {
- "id": "compute.backendServices.addSignedUrlKey",
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "response": {
- "$ref": "Operation"
- },
- "description": "Adds a key for validating requests with signed URLs for this backend service.",
- "request": {
- "$ref": "SignedUrlKey"
- },
- "flatPath": "projects/{project}/global/backendServices/{backendService}/addSignedUrlKey",
- "parameters": {
- "backendService": {
- "required": true,
"type": "string",
"location": "path",
- "description": "Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035."
- },
- "requestId": {
- "location": "query",
- "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).",
- "type": "string"
- },
- "project": {
"description": "Project ID for this request.",
- "type": "string",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "location": "path"
+ "required": true
}
},
"parameterOrder": [
"project",
- "backendService"
+ "region",
+ "interconnectAttachment"
],
- "path": "projects/{project}/global/backendServices/{backendService}/addSignedUrlKey"
- },
- "getIamPolicy": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.backendServices.getIamPolicy",
- "httpMethod": "GET",
- "path": "projects/{project}/global/backendServices/{resource}/getIamPolicy",
- "flatPath": "projects/{project}/global/backendServices/{resource}/getIamPolicy",
- "parameters": {
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "location": "path",
- "description": "Project ID for this request."
- },
- "resource": {
- "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name or id of the resource for this request.",
- "required": true,
- "type": "string"
- },
- "optionsRequestedPolicyVersion": {
- "format": "int32",
- "type": "integer",
- "description": "Requested IAM Policy version.",
- "location": "query"
- }
- },
- "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
- "parameterOrder": [
- "project",
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- }
+ ]
},
- "setEdgeSecurityPolicy": {
- "request": {
- "$ref": "SecurityPolicyReference"
- },
- "description": "Sets the edge security policy for the specified backend service.",
- "flatPath": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy",
+ "setLabels": {
+ "httpMethod": "POST",
"parameterOrder": [
"project",
- "backendService"
+ "region",
+ "resource"
],
- "parameters": {
- "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).",
- "location": "query",
- "type": "string"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "type": "string",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
- },
- "backendService": {
- "location": "path",
- "description": "Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.",
- "type": "string",
- "required": true
- }
- },
- "httpMethod": "POST",
- "id": "compute.backendServices.setEdgeSecurityPolicy",
- "path": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy",
+ "path": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels",
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "patch": {
- "path": "projects/{project}/global/backendServices/{backendService}",
+ "id": "compute.interconnectAttachments.setLabels",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
],
+ "description": "Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.",
"request": {
- "$ref": "BackendService"
- },
- "flatPath": "projects/{project}/global/backendServices/{backendService}",
- "description": "Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
- "httpMethod": "PATCH",
- "response": {
- "$ref": "Operation"
+ "$ref": "RegionSetLabelsRequest"
},
"parameters": {
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "location": "path",
- "required": true
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "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)."
- },
- "backendService": {
+ "resource": {
"required": true,
+ "description": "Name or id of the resource for this request.",
"type": "string",
- "description": "Name of the BackendService resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
- }
- },
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "id": "compute.backendServices.patch"
- },
- "getHealth": {
- "parameterOrder": [
- "project",
- "backendService"
- ],
- "flatPath": "projects/{project}/global/backendServices/{backendService}/getHealth",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "request": {
- "$ref": "ResourceGroupReference"
- },
- "id": "compute.backendServices.getHealth",
- "parameters": {
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string"
},
- "backendService": {
+ "region": {
+ "description": "The region for this request.",
"required": true,
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "description": "Name of the BackendService resource to which the queried instance belongs.",
- "type": "string"
- }
- },
- "httpMethod": "POST",
- "description": "Gets the most recent health check results for this BackendService. Example request body: { \"group\": \"/zones/us-east1-b/instanceGroups/lb-backend-example\" }",
- "path": "projects/{project}/global/backendServices/{backendService}/getHealth",
- "response": {
- "$ref": "BackendServiceGroupHealth"
- }
- },
- "insert": {
- "httpMethod": "POST",
- "flatPath": "projects/{project}/global/backendServices",
- "id": "compute.backendServices.insert",
- "parameterOrder": [
- "project"
- ],
- "path": "projects/{project}/global/backendServices",
- "description": "Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview .",
- "parameters": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
"requestId": {
"location": "query",
"type": "string",
"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)."
},
"project": {
+ "required": true,
"description": "Project ID for this request.",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "location": "path",
- "required": true
+ "location": "path"
}
},
- "request": {
- "$ref": "BackendService"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels"
},
- "delete": {
+ "aggregatedList": {
+ "id": "compute.interconnectAttachments.aggregatedList",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "projects/{project}/global/backendServices/{backendService}",
- "parameterOrder": [
- "project",
- "backendService"
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "httpMethod": "DELETE",
+ "description": "Retrieves an aggregated list of interconnect attachments.",
+ "path": "projects/{project}/aggregated/interconnectAttachments",
"parameters": {
- "backendService": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "description": "Name of the BackendService resource to delete.",
- "type": "string"
+ "maxResults": {
+ "location": "query",
+ "default": "500",
+ "format": "uint32",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer"
},
- "requestId": {
+ "pageToken": {
"location": "query",
- "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).",
- "type": "string"
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
},
"project": {
- "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path",
"required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
"description": "Project ID for this request."
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
}
},
- "id": "compute.backendServices.delete",
"response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/global/backendServices/{backendService}",
- "description": "Deletes the specified BackendService resource."
- }
- }
- },
- "sslPolicies": {
- "methods": {
- "insert": {
- "flatPath": "projects/{project}/global/sslPolicies",
- "httpMethod": "POST",
- "request": {
- "$ref": "SslPolicy"
+ "$ref": "InterconnectAttachmentAggregatedList"
},
+ "flatPath": "projects/{project}/aggregated/interconnectAttachments",
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET"
+ },
+ "list": {
"response": {
- "$ref": "Operation"
+ "$ref": "InterconnectAttachmentList"
},
+ "path": "projects/{project}/regions/{region}/interconnectAttachments",
+ "id": "compute.interconnectAttachments.list",
+ "flatPath": "projects/{project}/regions/{region}/interconnectAttachments",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.",
- "id": "compute.sslPolicies.insert",
- "path": "projects/{project}/global/sslPolicies",
"parameters": {
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
"project": {
+ "required": true,
"location": "path",
- "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "description": "Project ID for this request."
},
- "requestId": {
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "filter": {
"type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "maxResults": {
"location": "query",
- "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)."
+ "minimum": "0",
+ "format": "uint32",
+ "type": "integer",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path",
+ "description": "Name of the region for this request.",
+ "required": true
}
},
- "parameterOrder": [
- "project"
- ]
- },
- "patch": {
- "httpMethod": "PATCH",
+ "description": "Retrieves the list of interconnect attachments contained within the specified region.",
"parameterOrder": [
"project",
- "sslPolicy"
+ "region"
],
- "id": "compute.sslPolicies.patch",
- "path": "projects/{project}/global/sslPolicies/{sslPolicy}",
- "description": "Patches the specified SSL policy with the data included in the request.",
+ "httpMethod": "GET"
+ },
+ "delete": {
+ "description": "Deletes the specified interconnect attachment.",
+ "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
"response": {
"$ref": "Operation"
},
- "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}",
- "request": {
- "$ref": "SslPolicy"
- },
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "interconnectAttachment"
+ ],
"parameters": {
- "sslPolicy": {
+ "interconnectAttachment": {
"type": "string",
- "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
"required": true,
- "location": "path"
+ "description": "Name of the interconnect attachment to delete."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true
},
"requestId": {
"location": "query",
"type": "string",
"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)."
},
- "project": {
- "type": "string",
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path",
"required": true,
- "description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "type": "string",
+ "description": "Name of the region for this request."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
+ "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
+ "id": "compute.interconnectAttachments.delete"
},
- "delete": {
+ "insert": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
],
- "id": "compute.sslPolicies.delete",
- "path": "projects/{project}/global/sslPolicies/{sslPolicy}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.",
+ "id": "compute.interconnectAttachments.insert",
"response": {
"$ref": "Operation"
},
- "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}",
- "parameterOrder": [
- "project",
- "sslPolicy"
- ],
"parameters": {
"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).",
"location": "query",
"type": "string"
},
- "sslPolicy": {
- "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.",
- "type": "string",
+ "region": {
+ "description": "Name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
"required": true,
- "location": "path"
+ "type": "string"
+ },
+ "validateOnly": {
+ "location": "query",
+ "description": "If true, the request will not be committed.",
+ "type": "boolean"
},
"project": {
- "type": "string",
- "description": "Project ID for this request.",
"required": true,
+ "description": "Project ID for this request.",
"location": "path",
+ "type": "string",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
}
- }
- },
- "get": {
- "path": "projects/{project}/global/sslPolicies/{sslPolicy}",
- "httpMethod": "GET",
- "response": {
- "$ref": "SslPolicy"
},
+ "request": {
+ "$ref": "InterconnectAttachment"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "description": "Creates an InterconnectAttachment in the specified project using the data included in the request.",
+ "flatPath": "projects/{project}/regions/{region}/interconnectAttachments",
+ "path": "projects/{project}/regions/{region}/interconnectAttachments"
+ },
+ "patch": {
+ "description": "Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
"parameters": {
"project": {
- "type": "string",
- "required": true,
"description": "Project ID for this request.",
+ "location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path"
+ "type": "string",
+ "required": true
},
- "sslPolicy": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "interconnectAttachment": {
+ "required": true,
"type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"location": "path",
+ "description": "Name of the interconnect attachment to patch."
+ },
+ "region": {
"required": true,
- "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035."
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "https://www.googleapis.com/auth/compute"
],
"parameterOrder": [
"project",
- "sslPolicy"
+ "region",
+ "interconnectAttachment"
],
- "id": "compute.sslPolicies.get",
- "description": "Lists all of the ordered rules present in a single specified policy.",
- "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}"
- },
- "aggregatedList": {
+ "request": {
+ "$ref": "InterconnectAttachment"
+ },
+ "id": "compute.interconnectAttachments.patch",
+ "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
+ "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
+ "httpMethod": "PATCH",
"response": {
- "$ref": "SslPoliciesAggregatedList"
+ "$ref": "Operation"
+ }
+ }
+ }
+ },
+ "globalNetworkEndpointGroups": {
+ "methods": {
+ "listNetworkEndpoints": {
+ "response": {
+ "$ref": "NetworkEndpointGroupsListNetworkEndpoints"
},
+ "parameterOrder": [
+ "project",
+ "networkEndpointGroup"
+ ],
+ "id": "compute.globalNetworkEndpointGroups.listNetworkEndpoints",
+ "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
+ "description": "Lists the network endpoints in the specified network endpoint group.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
],
- "httpMethod": "GET",
- "description": "Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
"parameters": {
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "location": "path",
- "type": "string",
- "required": true,
- "description": "Name of the project scoping this request."
- },
- "returnPartialSuccess": {
- "type": "boolean",
+ "pageToken": {
"location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
},
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
"location": "query",
"type": "string"
},
- "includeAllScopes": {
- "type": "boolean",
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
"location": "query"
},
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "returnPartialSuccess": {
"location": "query",
- "type": "string"
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
},
"maxResults": {
- "location": "query",
- "format": "uint32",
"default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"minimum": "0",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
"type": "integer"
},
- "orderBy": {
- "location": "query",
+ "networkEndpointGroup": {
"type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ "description": "The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.",
+ "required": true,
+ "location": "path"
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request."
}
- },
- "path": "projects/{project}/aggregated/sslPolicies",
- "flatPath": "projects/{project}/aggregated/sslPolicies",
- "parameterOrder": [
- "project"
- ],
- "id": "compute.sslPolicies.aggregatedList"
+ }
},
- "listAvailableFeatures": {
+ "list": {
"response": {
- "$ref": "SslPoliciesListAvailableFeaturesResponse"
+ "$ref": "NetworkEndpointGroupList"
},
- "description": "Lists all features that can be specified in the SSL policy when using custom profile.",
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
+ "flatPath": "projects/{project}/global/networkEndpointGroups",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
+ "path": "projects/{project}/global/networkEndpointGroups",
"parameters": {
"pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query"
},
"orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
"type": "string"
},
"returnPartialSuccess": {
+ "type": "boolean",
"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ "location": "query"
},
"maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
- "default": "500",
"minimum": "0",
"location": "query",
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
- },
- "project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "required": true,
- "location": "path"
+ "default": "500"
}
},
- "path": "projects/{project}/global/sslPolicies/listAvailableFeatures",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "httpMethod": "GET",
+ "description": "Retrieves the list of network endpoint groups that are located in the specified project.",
+ "parameterOrder": [
+ "project"
],
- "id": "compute.sslPolicies.listAvailableFeatures",
- "flatPath": "projects/{project}/global/sslPolicies/listAvailableFeatures"
+ "id": "compute.globalNetworkEndpointGroups.list"
},
- "list": {
- "description": "Lists all the SSL policies that have been configured for the specified project.",
- "id": "compute.sslPolicies.list",
- "path": "projects/{project}/global/sslPolicies",
+ "insert": {
+ "httpMethod": "POST",
"parameterOrder": [
"project"
],
+ "request": {
+ "$ref": "NetworkEndpointGroup"
+ },
+ "id": "compute.globalNetworkEndpointGroups.insert",
"response": {
- "$ref": "SslPoliciesList"
+ "$ref": "Operation"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/networkEndpointGroups",
+ "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.",
+ "flatPath": "projects/{project}/global/networkEndpointGroups",
"parameters": {
- "filter": {
- "type": "string",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "location": "query"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
- },
"project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
"description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"location": "path"
},
- "pageToken": {
+ "requestId": {
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "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"
+ }
+ }
+ },
+ "get": {
+ "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "NetworkEndpointGroup"
+ },
+ "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}",
+ "parameters": {
+ "networkEndpointGroup": {
+ "description": "The name of the network endpoint group. It should comply with RFC1035.",
+ "required": true,
+ "type": "string",
+ "location": "path"
},
- "maxResults": {
- "minimum": "0",
- "format": "uint32",
- "type": "integer",
- "location": "query",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "default": "500"
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
}
},
"scopes": [
@@ -32101,36816 +36880,32062 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
],
- "flatPath": "projects/{project}/global/sslPolicies",
- "httpMethod": "GET"
- }
- }
- },
- "regionTargetHttpProxies": {
- "methods": {
+ "parameterOrder": [
+ "project",
+ "networkEndpointGroup"
+ ],
+ "description": "Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.",
+ "id": "compute.globalNetworkEndpointGroups.get"
+ },
"delete": {
- "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}",
- "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}",
"httpMethod": "DELETE",
+ "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}",
+ "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}",
+ "parameterOrder": [
+ "project",
+ "networkEndpointGroup"
+ ],
+ "id": "compute.globalNetworkEndpointGroups.delete",
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "networkEndpointGroup": {
+ "location": "path",
+ "description": "The name of the network endpoint group to delete. It should comply with RFC1035.",
+ "type": "string",
+ "required": true
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
],
+ "description": "Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.",
+ "response": {
+ "$ref": "Operation"
+ }
+ },
+ "attachNetworkEndpoints": {
+ "request": {
+ "$ref": "GlobalNetworkEndpointGroupsAttachEndpointsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Attach a network endpoint to the specified network endpoint group.",
+ "id": "compute.globalNetworkEndpointGroups.attachNetworkEndpoints",
+ "httpMethod": "POST",
"parameters": {
"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).",
- "type": "string",
- "location": "query"
- },
- "region": {
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string",
- "description": "Name of the region scoping this request.",
- "required": true
+ "location": "query",
+ "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)."
},
- "targetHttpProxy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "project": {
"required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
"location": "path",
- "description": "Name of the TargetHttpProxy resource to delete.",
- "type": "string"
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "project": {
+ "networkEndpointGroup": {
"type": "string",
"required": true,
"location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request."
+ "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035."
}
},
+ "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
"parameterOrder": [
"project",
- "region",
- "targetHttpProxy"
+ "networkEndpointGroup"
],
- "response": {
- "$ref": "Operation"
- },
- "id": "compute.regionTargetHttpProxies.delete",
- "description": "Deletes the specified TargetHttpProxy resource."
- },
- "get": {
- "id": "compute.regionTargetHttpProxies.get",
- "response": {
- "$ref": "TargetHttpProxy"
- },
- "description": "Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.",
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "https://www.googleapis.com/auth/compute"
],
- "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}",
+ "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints"
+ },
+ "detachNetworkEndpoints": {
+ "parameterOrder": [
+ "project",
+ "networkEndpointGroup"
+ ],
+ "id": "compute.globalNetworkEndpointGroups.detachNetworkEndpoints",
+ "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
"parameters": {
"project": {
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
"description": "Project ID for this request.",
"required": true,
- "type": "string",
"location": "path"
},
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "location": "path",
- "description": "Name of the region scoping this request.",
+ "requestId": {
+ "location": "query",
+ "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).",
"type": "string"
},
- "targetHttpProxy": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "type": "string",
- "description": "Name of the TargetHttpProxy resource to return.",
+ "networkEndpointGroup": {
+ "location": "path",
"required": true,
- "location": "path"
+ "description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.",
+ "type": "string"
}
},
- "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}",
- "parameterOrder": [
- "project",
- "region",
- "targetHttpProxy"
- ]
- },
- "list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "https://www.googleapis.com/auth/compute"
],
"response": {
- "$ref": "TargetHttpProxyList"
+ "$ref": "Operation"
},
- "flatPath": "projects/{project}/regions/{region}/targetHttpProxies",
- "path": "projects/{project}/regions/{region}/targetHttpProxies",
+ "description": "Detach the network endpoint from the specified network endpoint group.",
+ "request": {
+ "$ref": "GlobalNetworkEndpointGroupsDetachEndpointsRequest"
+ }
+ }
+ }
+ },
+ "vpnTunnels": {
+ "methods": {
+ "aggregatedList": {
"parameterOrder": [
- "project",
- "region"
+ "project"
],
+ "response": {
+ "$ref": "VpnTunnelAggregatedList"
+ },
"httpMethod": "GET",
- "description": "Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.",
+ "description": "Retrieves an aggregated list of VPN tunnels.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/aggregated/vpnTunnels",
+ "id": "compute.vpnTunnels.aggregatedList",
"parameters": {
- "maxResults": {
- "format": "uint32",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
"location": "query",
- "minimum": "0",
- "type": "integer"
+ "type": "boolean"
},
- "returnPartialSuccess": {
- "type": "boolean",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query"
},
- "region": {
+ "project": {
+ "description": "Project ID for this request.",
"type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
"required": true
},
- "orderBy": {
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "type": "string",
- "location": "query"
+ "maxResults": {
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "minimum": "0",
+ "format": "uint32",
+ "default": "500"
},
- "pageToken": {
+ "filter": {
"type": "string",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
- "location": "query"
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
},
- "filter": {
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
"location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
+ "type": "boolean"
},
- "project": {
- "description": "Project ID for this request.",
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"type": "string",
- "required": true,
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ "location": "query"
}
},
- "id": "compute.regionTargetHttpProxies.list"
+ "flatPath": "projects/{project}/aggregated/vpnTunnels"
},
"insert": {
- "path": "projects/{project}/regions/{region}/targetHttpProxies",
- "id": "compute.regionTargetHttpProxies.insert",
+ "path": "projects/{project}/regions/{region}/vpnTunnels",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/vpnTunnels",
+ "description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request.",
"parameters": {
- "region": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the region scoping this request.",
- "required": true,
- "location": "path",
- "type": "string"
- },
"requestId": {
- "type": "string",
+ "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",
- "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)."
+ "type": "string"
},
"project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
"description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region for this request.",
"type": "string",
"location": "path",
"required": true
}
},
- "description": "Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.",
"request": {
- "$ref": "TargetHttpProxy"
+ "$ref": "VpnTunnel"
},
"response": {
"$ref": "Operation"
},
- "httpMethod": "POST",
- "flatPath": "projects/{project}/regions/{region}/targetHttpProxies",
- "parameterOrder": [
- "project",
- "region"
- ],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
- ]
+ ],
+ "id": "compute.vpnTunnels.insert"
},
- "setUrlMap": {
+ "setLabels": {
+ "request": {
+ "$ref": "RegionSetLabelsRequest"
+ },
+ "id": "compute.vpnTunnels.setLabels",
+ "description": "Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.",
"parameters": {
- "targetHttpProxy": {
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "required": true,
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string",
- "description": "Name of the TargetHttpProxy to set a URL map for."
+ "type": "string"
},
"requestId": {
"type": "string",
- "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"
- },
- "project": {
- "type": "string",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "required": true
+ "location": "query",
+ "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)."
},
"region": {
- "location": "path",
+ "description": "The region for this request.",
"required": true,
+ "type": "string",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
"type": "string",
- "description": "Name of the region scoping this request."
+ "description": "Project ID for this request."
}
},
- "httpMethod": "POST",
- "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
+ "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels",
"parameterOrder": [
"project",
"region",
- "targetHttpProxy"
+ "resource"
],
- "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
- "request": {
- "$ref": "UrlMapReference"
+ "response": {
+ "$ref": "Operation"
},
- "id": "compute.regionTargetHttpProxies.setUrlMap",
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
],
- "description": "Changes the URL map for TargetHttpProxy.",
- "response": {
- "$ref": "Operation"
- }
- }
- }
- },
- "targetVpnGateways": {
- "methods": {
- "setLabels": {
- "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels",
- "description": "Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation.",
- "httpMethod": "POST",
- "request": {
- "$ref": "RegionSetLabelsRequest"
- },
+ "path": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels"
+ },
+ "get": {
+ "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
+ "description": "Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.",
"parameters": {
- "resource": {
- "description": "Name or id of the resource for this request.",
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
"required": true,
"type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path"
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
"region": {
- "description": "The region for this request.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "requestId": {
+ "location": "path",
"type": "string",
- "location": "query",
- "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)."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region for this request.",
+ "required": true
},
- "project": {
- "type": "string",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
+ "vpnTunnel": {
"location": "path",
+ "description": "Name of the VpnTunnel resource to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
"required": true
}
},
- "id": "compute.targetVpnGateways.setLabels",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "VpnTunnel"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
+ "id": "compute.vpnTunnels.get",
+ "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
"parameterOrder": [
"project",
"region",
- "resource"
- ],
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels"
+ "vpnTunnel"
+ ]
},
- "insert": {
+ "list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "request": {
- "$ref": "TargetVpnGateway"
+ "httpMethod": "GET",
+ "path": "projects/{project}/regions/{region}/vpnTunnels",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "response": {
+ "$ref": "VpnTunnelList"
},
+ "flatPath": "projects/{project}/regions/{region}/vpnTunnels",
+ "id": "compute.vpnTunnels.list",
"parameters": {
"region": {
- "description": "Name of the region for this request.",
"location": "path",
- "required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string",
+ "description": "Name of the region for this request."
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
"type": "string"
},
"project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path",
+ "type": "string",
"description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "minimum": "0",
+ "format": "uint32",
+ "location": "query",
+ "default": "500"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
"type": "string"
},
- "requestId": {
+ "pageToken": {
"location": "query",
"type": "string",
- "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)."
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
}
},
- "parameterOrder": [
- "project",
- "region"
- ],
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/regions/{region}/targetVpnGateways",
- "flatPath": "projects/{project}/regions/{region}/targetVpnGateways",
- "httpMethod": "POST",
- "id": "compute.targetVpnGateways.insert",
- "description": "Creates a target VPN gateway in the specified project and region using the data included in the request."
+ "description": "Retrieves a list of VpnTunnel resources contained in the specified project and region."
},
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "id": "compute.targetVpnGateways.get",
- "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
+ "delete": {
+ "description": "Deletes the specified VpnTunnel resource.",
"parameters": {
- "project": {
- "required": true,
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "description": "Project ID for this request.",
- "type": "string",
- "location": "path"
- },
"region": {
- "location": "path",
- "description": "Name of the region for this request.",
"type": "string",
+ "description": "Name of the region for this request.",
+ "location": "path",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
- "targetVpnGateway": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
"type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "vpnTunnel": {
+ "required": true,
+ "description": "Name of the VpnTunnel resource to delete.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "location": "path",
- "description": "Name of the target VPN gateway to return.",
- "required": true
+ "type": "string",
+ "location": "path"
}
},
- "response": {
- "$ref": "TargetVpnGateway"
- },
- "description": "Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.",
- "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
"parameterOrder": [
"project",
"region",
- "targetVpnGateway"
+ "vpnTunnel"
],
- "httpMethod": "GET"
- },
- "list": {
+ "id": "compute.vpnTunnels.delete",
+ "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}"
+ }
+ }
+ },
+ "serviceAttachments": {
+ "methods": {
+ "patch": {
+ "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
+ "id": "compute.serviceAttachments.patch",
+ "description": "Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
"parameterOrder": [
"project",
- "region"
+ "region",
+ "serviceAttachment"
],
+ "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
+ "httpMethod": "PATCH",
"response": {
- "$ref": "TargetVpnGatewayList"
+ "$ref": "Operation"
},
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "https://www.googleapis.com/auth/compute"
],
- "flatPath": "projects/{project}/regions/{region}/targetVpnGateways",
- "description": "Retrieves a list of target VPN gateways available to the specified project and region.",
- "path": "projects/{project}/regions/{region}/targetVpnGateways",
- "id": "compute.targetVpnGateways.list",
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string"
},
- "filter": {
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "requestId": {
"location": "query",
+ "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).",
"type": "string"
},
- "orderBy": {
- "location": "query",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "serviceAttachment": {
+ "required": true,
+ "description": "The resource id of the ServiceAttachment to patch. It should conform to RFC1035 resource name or be a string form on an unsigned long number.",
+ "location": "path",
"type": "string"
},
- "maxResults": {
- "format": "uint32",
- "default": "500",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "type": "integer",
- "minimum": "0",
- "location": "query"
- },
"region": {
+ "location": "path",
+ "description": "The region scoping this request and should conform to RFC1035.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "request": {
+ "$ref": "ServiceAttachment"
+ }
+ },
+ "insert": {
+ "request": {
+ "$ref": "ServiceAttachment"
+ },
+ "description": "Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "id": "compute.serviceAttachments.insert",
+ "parameters": {
+ "region": {
+ "required": true,
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string",
- "required": true,
- "description": "Name of the region for this request."
- },
- "returnPartialSuccess": {
- "location": "query",
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean"
+ "description": "Name of the region of this request."
},
"project": {
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
"type": "string",
- "location": "path",
"description": "Project ID for this request.",
- "required": true
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
}
+ },
+ "path": "projects/{project}/regions/{region}/serviceAttachments",
+ "flatPath": "projects/{project}/regions/{region}/serviceAttachments",
+ "response": {
+ "$ref": "Operation"
}
},
- "delete": {
- "id": "compute.targetVpnGateways.delete",
- "description": "Deletes the specified target VPN gateway.",
+ "get": {
+ "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
+ "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
+ "httpMethod": "GET",
+ "description": "Returns the specified ServiceAttachment resource in the given scope.",
"parameters": {
"project": {
"required": true,
"description": "Project ID for this request.",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
+ "description": "Name of the region of this request.",
"location": "path",
"type": "string",
- "description": "Name of the region for this request.",
- "required": true,
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "requestId": {
- "type": "string",
- "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"
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
},
- "targetVpnGateway": {
- "description": "Name of the target VPN gateway to delete.",
+ "serviceAttachment": {
"location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
- "type": "string"
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "description": "Name of the ServiceAttachment resource to return."
}
},
- "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
- "response": {
- "$ref": "Operation"
- },
- "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
- "httpMethod": "DELETE",
+ "parameterOrder": [
+ "project",
+ "region",
+ "serviceAttachment"
+ ],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
+ "id": "compute.serviceAttachments.get",
+ "response": {
+ "$ref": "ServiceAttachment"
+ }
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"parameterOrder": [
"project",
"region",
- "targetVpnGateway"
- ]
- },
- "aggregatedList": {
- "path": "projects/{project}/aggregated/targetVpnGateways",
- "parameterOrder": [
- "project"
+ "resource"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
],
- "id": "compute.targetVpnGateways.aggregatedList",
- "description": "Retrieves an aggregated list of target VPN gateways.",
- "flatPath": "projects/{project}/aggregated/targetVpnGateways",
- "response": {
- "$ref": "TargetVpnGatewayAggregatedList"
- },
+ "id": "compute.serviceAttachments.getIamPolicy",
"httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy",
+ "path": "projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy",
"parameters": {
- "orderBy": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
"type": "string",
- "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
- "format": "uint32",
- "minimum": "0",
- "default": "500",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
- "type": "string"
- },
- "returnPartialSuccess": {
- "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
- "type": "boolean",
- "location": "query"
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request.",
"type": "string",
- "location": "query"
+ "required": true,
+ "location": "path"
},
- "includeAllScopes": {
- "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "optionsRequestedPolicyVersion": {
+ "description": "Requested IAM Policy version.",
"location": "query",
- "type": "boolean"
+ "type": "integer",
+ "format": "int32"
},
- "project": {
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "region": {
+ "description": "The name of the region for this request.",
"type": "string",
- "description": "Project ID for this request.",
- "required": true
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path"
}
- }
- }
- }
- }
- },
- "schemas": {
- "PreservedStatePreservedDisk": {
- "id": "PreservedStatePreservedDisk",
- "properties": {
- "autoDelete": {
- "type": "string",
- "description": "These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.",
- "enum": [
- "NEVER",
- "ON_PERMANENT_INSTANCE_DELETION"
- ],
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "source": {
- "type": "string",
- "description": "The URL of the disk resource that is stateful and should be attached to the VM instance."
- },
- "mode": {
- "enumDescriptions": [
- "Attaches this disk in read-only mode. Multiple VM instances can use a disk in READ_ONLY mode at a time.",
- "*[Default]* Attaches this disk in READ_WRITE mode. Only one VM instance at a time can be attached to a disk in READ_WRITE mode."
- ],
- "type": "string",
- "enum": [
- "READ_ONLY",
- "READ_WRITE"
- ],
- "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode."
- }
- },
- "type": "object"
- },
- "RouterBgp": {
- "properties": {
- "advertiseMode": {
- "type": "string",
- "enumDescriptions": [
- "",
- ""
- ],
- "description": "User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.",
- "enum": [
- "CUSTOM",
- "DEFAULT"
- ]
- },
- "advertisedGroups": {
- "items": {
- "enum": [
- "ALL_SUBNETS"
- ],
- "type": "string",
- "enumDescriptions": [
- "Advertise all available subnets (including peer VPC subnets)."
- ]
- },
- "type": "array",
- "description": "User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups."
- },
- "advertisedIpRanges": {
- "items": {
- "$ref": "RouterAdvertisedIpRange"
- },
- "type": "array",
- "description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges."
- },
- "keepaliveInterval": {
- "description": "The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.",
- "type": "integer",
- "format": "uint32"
- },
- "asn": {
- "type": "integer",
- "format": "uint32",
- "description": "Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN."
- }
- },
- "type": "object",
- "id": "RouterBgp"
- },
- "RouterMd5AuthenticationKey": {
- "id": "RouterMd5AuthenticationKey",
- "properties": {
- "key": {
- "annotations": {
- "required": [
- "compute.routers.insert"
- ]
},
- "description": "[Input only] Value of the key. For patch and update calls, it can be skipped to copy the value from the previous configuration. This is allowed if the key with the same name existed before the operation. Maximum length is 80 characters. Can only contain printable ASCII characters.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "Name used to identify the key. Must be unique within a router. Must be referenced by at least one bgpPeer. Must comply with RFC1035.",
- "annotations": {
- "required": [
- "compute.routers.insert",
- "compute.routers.update"
- ]
+ "response": {
+ "$ref": "Policy"
}
- }
- },
- "type": "object"
- },
- "TargetHttpsProxyAggregatedList": {
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
},
- "items": {
- "type": "object",
- "additionalProperties": {
- "$ref": "TargetHttpsProxiesScopedList",
- "description": "Name of the scope containing this set of TargetHttpsProxies."
+ "aggregatedList": {
+ "id": "compute.serviceAttachments.aggregatedList",
+ "flatPath": "projects/{project}/aggregated/serviceAttachments",
+ "response": {
+ "$ref": "ServiceAttachmentAggregatedList"
},
- "description": "A list of TargetHttpsProxiesScopedList resources."
- },
- "warning": {
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array"
- },
- "message": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "path": "projects/{project}/aggregated/serviceAttachments",
+ "description": "Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.",
+ "parameters": {
+ "orderBy": {
+ "location": "query",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "pageToken": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
- }
- },
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "default": "compute#targetHttpsProxyAggregatedList",
- "description": "[Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "unreachables": {
- "type": "array",
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TargetHttpsProxyAggregatedList",
- "type": "object"
- },
- "InstanceGroupManagerAutoHealingPolicy": {
- "type": "object",
- "properties": {
- "healthCheck": {
- "type": "string",
- "description": "The URL for the health check that signals autohealing."
- },
- "initialDelaySec": {
- "format": "int32",
- "description": "The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].",
- "type": "integer"
- }
- },
- "id": "InstanceGroupManagerAutoHealingPolicy"
- },
- "AutoscalersScopedList": {
- "type": "object",
- "id": "AutoscalersScopedList",
- "properties": {
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of autoscalers when the list is empty.",
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
},
- "message": {
+ "project": {
+ "description": "Name of the project scoping this request.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
},
- "code": {
- "type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "includeAllScopes": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "500",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "minimum": "0",
+ "format": "uint32"
}
}
},
- "autoscalers": {
- "type": "array",
- "description": "[Output Only] A list of autoscalers contained in this scope.",
- "items": {
- "$ref": "Autoscaler"
- }
- }
- }
- },
- "TargetSslProxiesSetProxyHeaderRequest": {
- "properties": {
- "proxyHeader": {
- "description": "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.",
- "type": "string",
- "enum": [
- "NONE",
- "PROXY_V1"
+ "delete": {
+ "description": "Deletes the specified ServiceAttachment in the given scope",
+ "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
+ "id": "compute.serviceAttachments.delete",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "serviceAttachment"
],
- "enumDescriptions": [
- "",
- ""
- ]
- }
- },
- "type": "object",
- "id": "TargetSslProxiesSetProxyHeaderRequest"
- },
- "HttpFaultInjection": {
- "id": "HttpFaultInjection",
- "properties": {
- "delay": {
- "description": "The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.",
- "$ref": "HttpFaultDelay"
- },
- "abort": {
- "$ref": "HttpFaultAbort",
- "description": "The specification for how client requests are aborted as part of fault injection."
- }
- },
- "type": "object",
- "description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests."
- },
- "UrlMapList": {
- "description": "Contains a list of UrlMap resources.",
- "type": "object",
- "id": "UrlMapList",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "type": "string",
- "default": "compute#urlMapList",
- "description": "Type of resource."
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "region": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Name of the region of this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "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).",
+ "location": "query",
"type": "string"
},
- "data": {
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "serviceAttachment": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the ServiceAttachment resource to delete."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ },
+ "setIamPolicy": {
+ "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "The name of the region for this request."
+ },
+ "resource": {
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string"
}
},
- "type": "object"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "items": {
- "items": {
- "$ref": "UrlMap"
+ "path": "projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy",
+ "id": "compute.serviceAttachments.setIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "RegionSetPolicyRequest"
},
- "type": "array",
- "description": "A list of UrlMap resources."
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy."
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- }
- }
- },
- "SourceInstanceParams": {
- "type": "object",
- "properties": {
- "diskConfigs": {
- "description": "Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.",
- "items": {
- "$ref": "DiskInstantiationConfig"
+ "testIamPermissions": {
+ "id": "compute.serviceAttachments.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "path": "projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions",
+ "request": {
+ "$ref": "TestPermissionsRequest"
},
- "type": "array"
- }
- },
- "description": "A specification of the parameters to use when creating the instance template from a source instance.",
- "id": "SourceInstanceParams"
- },
- "TargetSslProxiesSetSslCertificatesRequest": {
- "type": "object",
- "properties": {
- "sslCertificates": {
- "description": "New set of URLs to SslCertificate resources to associate with this TargetSslProxy. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TargetSslProxiesSetSslCertificatesRequest"
- },
- "PreconfiguredWafSet": {
- "properties": {
- "expressionSets": {
- "type": "array",
- "items": {
- "$ref": "WafExpressionSet"
+ "response": {
+ "$ref": "TestPermissionsResponse"
},
- "description": "List of entities that are currently supported for WAF rules."
- }
- },
- "type": "object",
- "id": "PreconfiguredWafSet"
- },
- "SecuritySettings": {
- "type": "object",
- "description": "The authentication and authorization settings for a BackendService.",
- "properties": {
- "subjectAltNames": {
- "description": "Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode). Note: This field currently has no impact.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "clientTlsPolicy": {
- "description": "Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact.",
- "type": "string"
- }
- },
- "id": "SecuritySettings"
- },
- "PublicAdvertisedPrefix": {
- "id": "PublicAdvertisedPrefix",
- "type": "object",
- "properties": {
- "sharedSecret": {
- "type": "string",
- "description": "[Output Only] The shared secret to be used for reverse DNS verification."
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "ipCidrRange": {
- "description": "The IPv4 address range, in CIDR format, represented by this public advertised prefix.",
- "type": "string"
- },
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "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.",
- "annotations": {
- "required": [
- "compute.publicAdvertisedPrefixes.insert"
- ]
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "description": "The name of the region for this request.",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
},
- "type": "string"
- },
- "fingerprint": {
- "description": "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 new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.",
- "format": "byte",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.",
- "default": "compute#publicAdvertisedPrefix"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "dnsVerificationIp": {
- "type": "string",
- "description": "The IPv4 address to be used for reverse DNS verification."
+ "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ]
},
- "status": {
- "enumDescriptions": [
- "RPKI validation is complete.",
- "The prefix is fully configured.",
- "The prefix is being configured.",
- "The prefix is being removed.",
- "User has configured the PTR.",
- "Reverse DNS lookup failed.",
- "Reverse DNS lookup is successful."
+ "list": {
+ "id": "compute.serviceAttachments.list",
+ "path": "projects/{project}/regions/{region}/serviceAttachments",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "INITIAL",
- "PREFIX_CONFIGURATION_COMPLETE",
- "PREFIX_CONFIGURATION_IN_PROGRESS",
- "PREFIX_REMOVAL_IN_PROGRESS",
- "PTR_CONFIGURED",
- "REVERSE_DNS_LOOKUP_FAILED",
- "VALIDATED"
+ "parameterOrder": [
+ "project",
+ "region"
],
- "type": "string",
- "description": "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. "
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.",
- "type": "string",
- "format": "uint64"
- },
- "publicDelegatedPrefixs": {
- "type": "array",
- "description": "[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.",
- "items": {
- "$ref": "PublicAdvertisedPrefixPublicDelegatedPrefix"
- }
- }
- },
- "description": "A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet."
- },
- "TestPermissionsRequest": {
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestPermissionsRequest"
- },
- "RouterStatusResponse": {
- "id": "RouterStatusResponse",
- "properties": {
- "kind": {
- "type": "string",
- "default": "compute#routerStatusResponse",
- "description": "Type of resource."
- },
- "result": {
- "$ref": "RouterStatus"
- }
- },
- "type": "object"
- },
- "ConfidentialInstanceConfig": {
- "id": "ConfidentialInstanceConfig",
- "type": "object",
- "properties": {
- "enableConfidentialCompute": {
- "type": "boolean",
- "description": "Defines whether the instance should have confidential compute enabled."
- }
- },
- "description": "A set of Confidential Instance options."
- },
- "BackendBucket": {
- "properties": {
- "name": {
- "description": "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.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "customResponseHeaders": {
- "description": "Headers that the HTTP/S load balancer should add to proxied responses.",
- "items": {
- "type": "string"
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ServiceAttachmentList"
+ },
+ "parameters": {
+ "region": {
+ "description": "Name of the region of this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "maxResults": {
+ "location": "query",
+ "minimum": "0",
+ "type": "integer",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ }
},
- "type": "array"
- },
- "enableCdn": {
- "type": "boolean",
- "description": "If true, enable Cloud CDN for this BackendBucket."
- },
- "edgeSecurityPolicy": {
- "description": "[Output Only] The resource URL for the edge security policy associated with this backend bucket.",
- "type": "string"
- },
- "compressionMode": {
- "description": "Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.",
- "type": "string",
- "enum": [
- "AUTOMATIC",
- "DISABLED"
- ],
- "enumDescriptions": [
- "Automatically uses the best compression based on the Accept-Encoding header sent by the client.",
- "Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients."
- ]
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "bucketName": {
- "type": "string",
- "description": "Cloud Storage bucket name."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string",
- "format": "uint64"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "kind": {
- "description": "Type of the resource.",
- "default": "compute#backendBucket",
- "type": "string"
- },
- "cdnPolicy": {
- "$ref": "BackendBucketCdnPolicy",
- "description": "Cloud CDN configuration for this BackendBucket."
- },
- "description": {
- "description": "An optional textual description of the resource; provided by the client when the resource is created.",
- "type": "string"
- }
- },
- "description": "Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.",
- "id": "BackendBucket",
- "type": "object"
- },
- "SecurityPoliciesListPreconfiguredExpressionSetsResponse": {
- "id": "SecurityPoliciesListPreconfiguredExpressionSetsResponse",
- "type": "object",
- "properties": {
- "preconfiguredExpressionSets": {
- "$ref": "SecurityPoliciesWafConfig"
+ "description": "Lists the ServiceAttachments for a project in the given scope.",
+ "flatPath": "projects/{project}/regions/{region}/serviceAttachments"
}
}
},
- "Interconnect": {
- "type": "object",
- "id": "Interconnect",
- "properties": {
- "adminEnabled": {
- "type": "boolean",
- "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true."
- },
- "linkType": {
- "description": "Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.",
- "enumDescriptions": [
- "100G Ethernet, LR Optics.",
- "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];"
+ "networkEndpointGroups": {
+ "methods": {
+ "detachNetworkEndpoints": {
+ "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "networkEndpointGroup"
],
- "type": "string",
- "enum": [
- "LINK_TYPE_ETHERNET_100G_LR",
- "LINK_TYPE_ETHERNET_10G_LR"
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "zone": {
+ "location": "path",
+ "required": true,
+ "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "networkEndpointGroup": {
+ "type": "string",
+ "description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
+ "request": {
+ "$ref": "NetworkEndpointGroupsDetachEndpointsRequest"
+ },
+ "description": "Detach a list of network endpoints from the specified network endpoint group.",
+ "id": "compute.networkEndpointGroups.detachNetworkEndpoints",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
},
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "operationalStatus": {
- "type": "string",
- "enumDescriptions": [
- "The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.",
- "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect."
+ "insert": {
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The name of the zone where you want to create the network endpoint group. It should comply with RFC1035."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "request": {
+ "$ref": "NetworkEndpointGroup"
+ },
+ "path": "projects/{project}/zones/{zone}/networkEndpointGroups",
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. ",
- "enum": [
- "OS_ACTIVE",
- "OS_UNPROVISIONED"
+ "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups",
+ "id": "compute.networkEndpointGroups.insert",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "zone"
]
},
- "circuitInfos": {
- "type": "array",
- "description": "[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.",
- "items": {
- "$ref": "InterconnectCircuitInfo"
- }
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "requestedLinkCount": {
- "type": "integer",
- "format": "int32",
- "description": "Target number of physical links in the link bundle, as requested by the customer."
- },
- "provisionedLinkCount": {
- "format": "int32",
- "description": "[Output Only] Number of links actually provisioned in this interconnect.",
- "type": "integer"
- },
- "kind": {
- "type": "string",
- "default": "compute#interconnect",
- "description": "[Output Only] Type of the resource. Always compute#interconnect for interconnects."
- },
- "nocContactEmail": {
- "type": "string",
- "description": "Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications."
- },
- "interconnectAttachments": {
- "description": "[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.",
- "type": "array",
- "items": {
- "type": "string"
+ "testIamPermissions": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.networkEndpointGroups.testIamPermissions",
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "httpMethod": "POST",
+ "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "description": "Name or id of the resource for this request."
+ },
+ "zone": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "required": true
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestPermissionsResponse"
}
},
- "customerName": {
- "description": "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.",
- "type": "string"
- },
- "location": {
- "type": "string",
- "description": "URL of the InterconnectLocation object that represents where this connection is to be provisioned."
+ "delete": {
+ "description": "Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.",
+ "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "networkEndpointGroup"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "networkEndpointGroup": {
+ "location": "path",
+ "required": true,
+ "description": "The name of the network endpoint group to delete. It should comply with RFC1035.",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "zone": {
+ "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ }
+ },
+ "id": "compute.networkEndpointGroups.delete"
},
- "state": {
- "enumDescriptions": [
- "The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.",
- "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect."
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "description": "[Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. ",
- "enum": [
- "ACTIVE",
- "UNPROVISIONED"
+ "response": {
+ "$ref": "NetworkEndpointGroupList"
+ },
+ "parameters": {
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "maxResults": {
+ "location": "query",
+ "default": "500",
+ "minimum": "0",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups",
+ "id": "compute.networkEndpointGroups.list",
+ "path": "projects/{project}/zones/{zone}/networkEndpointGroups",
+ "description": "Retrieves the list of network endpoint groups that are located in the specified project and zone.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project",
+ "zone"
]
},
- "googleReferenceId": {
- "type": "string",
- "description": "[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues."
+ "get": {
+ "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}",
+ "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}",
+ "description": "Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.",
+ "parameters": {
+ "zone": {
+ "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "networkEndpointGroup": {
+ "type": "string",
+ "location": "path",
+ "description": "The name of the network endpoint group. It should comply with RFC1035.",
+ "required": true
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "NetworkEndpointGroup"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "networkEndpointGroup"
+ ],
+ "id": "compute.networkEndpointGroups.get"
},
- "name": {
- "annotations": {
- "required": [
- "compute.interconnects.insert"
- ]
+ "aggregatedList": {
+ "parameters": {
+ "maxResults": {
+ "format": "uint32",
+ "type": "integer",
+ "minimum": "0",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500"
+ },
+ "includeAllScopes": {
+ "type": "boolean",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "NetworkEndpointGroupAggregatedList"
+ },
+ "httpMethod": "GET",
+ "description": "Retrieves the list of network endpoint groups and sorts them by zone.",
+ "id": "compute.networkEndpointGroups.aggregatedList",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/aggregated/networkEndpointGroups",
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/aggregated/networkEndpointGroups"
+ },
+ "listNetworkEndpoints": {
+ "description": "Lists the network endpoints in the specified network endpoint group.",
+ "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone",
+ "networkEndpointGroup"
+ ],
+ "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "networkEndpointGroup": {
+ "required": true,
+ "type": "string",
+ "description": "The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.",
+ "location": "path"
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "minimum": "0",
+ "location": "query",
+ "format": "uint32",
+ "default": "500"
+ },
+ "zone": {
+ "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ }
},
- "type": "string",
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "peerIpAddress": {
- "type": "string",
- "description": "[Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests."
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "expectedOutages": {
- "items": {
- "$ref": "InterconnectOutageNotification"
+ "response": {
+ "$ref": "NetworkEndpointGroupsListNetworkEndpoints"
},
- "description": "[Output Only] A list of outages expected for this Interconnect.",
- "type": "array"
+ "id": "compute.networkEndpointGroups.listNetworkEndpoints",
+ "request": {
+ "$ref": "NetworkEndpointGroupsListEndpointsRequest"
+ },
+ "httpMethod": "POST"
},
- "interconnectType": {
- "enum": [
- "DEDICATED",
- "IT_PRIVATE",
- "PARTNER"
+ "attachNetworkEndpoints": {
+ "parameters": {
+ "networkEndpointGroup": {
+ "required": true,
+ "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.",
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035."
+ }
+ },
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "A dedicated physical interconnection with the customer.",
- "[Deprecated] A private, physical interconnection with the customer.",
- "A partner-managed interconnection shared between customers via partner."
+ "parameterOrder": [
+ "project",
+ "zone",
+ "networkEndpointGroup"
],
- "type": "string",
- "description": "Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED."
- },
- "satisfiesPzs": {
- "type": "boolean",
- "description": "[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."
- },
- "googleIpAddress": {
- "description": "[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.",
- "type": "string"
+ "id": "compute.networkEndpointGroups.attachNetworkEndpoints",
+ "request": {
+ "$ref": "NetworkEndpointGroupsAttachEndpointsRequest"
+ },
+ "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
+ "description": "Attach a list of network endpoints to the specified network endpoint group.",
+ "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints"
}
- },
- "description": "Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview."
+ }
},
- "Instance": {
- "id": "Instance",
- "description": "Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.",
- "type": "object",
- "properties": {
- "serviceAccounts": {
- "description": "A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.",
- "type": "array",
- "items": {
- "$ref": "ServiceAccount"
- }
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable explanation of the status."
- },
- "zone": {
- "description": "[Output Only] URL of the zone where the instance 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": {
- "description": "[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.",
- "$ref": "ResourceStatus"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "startRestricted": {
- "description": "[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.",
- "type": "boolean"
- },
- "lastSuspendedTimestamp": {
- "description": "[Output Only] Last suspended timestamp in RFC3339 text format.",
- "type": "string"
- },
- "deletionProtection": {
- "type": "boolean",
- "description": "Whether the resource should be protected against deletion."
- },
- "reservationAffinity": {
- "description": "Specifies the reservations that this instance can consume from.",
- "$ref": "ReservationAffinity"
- },
- "sourceMachineImageEncryptionKey": {
- "description": "Source machine image encryption key when creating an instance from a machine image.",
- "$ref": "CustomerEncryptionKey"
- },
- "lastStartTimestamp": {
- "type": "string",
- "description": "[Output Only] Last start timestamp in RFC3339 text format."
- },
- "params": {
- "$ref": "InstanceParams",
- "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload."
- },
- "status": {
- "type": "string",
- "enum": [
- "DEPROVISIONING",
- "PROVISIONING",
- "REPAIRING",
- "RUNNING",
- "STAGING",
- "STOPPED",
- "STOPPING",
- "SUSPENDED",
- "SUSPENDING",
- "TERMINATED"
- ],
- "enumDescriptions": [
- "The Nanny is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.",
- "Resources are being allocated for the instance.",
- "The instance is in repair.",
- "The instance is running.",
- "All required resources have been allocated and the instance is being started.",
- "The instance has stopped successfully.",
- "The instance is currently stopping (either being deleted or killed).",
- "The instance has suspended.",
- "The instance is suspending.",
- "The instance has stopped (either by explicit action or underlying failure)."
+ "instanceGroups": {
+ "methods": {
+ "list": {
+ "description": "Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.",
+ "parameterOrder": [
+ "project",
+ "zone"
],
- "description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle."
- },
- "machineType": {
- "description": "Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.",
- "annotations": {
- "required": [
- "compute.instances.insert"
- ]
+ "path": "projects/{project}/zones/{zone}/instanceGroups",
+ "id": "compute.instanceGroups.list",
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroups",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "InstanceGroupList"
},
- "type": "string"
- },
- "hostname": {
- "type": "string",
- "description": "Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS."
- },
- "scheduling": {
- "$ref": "Scheduling",
- "description": "Sets the scheduling options for this instance."
- },
- "shieldedInstanceConfig": {
- "$ref": "ShieldedInstanceConfig"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "confidentialInstanceConfig": {
- "$ref": "ConfidentialInstanceConfig"
- },
- "kind": {
- "type": "string",
- "default": "compute#instance",
- "description": "[Output Only] Type of the resource. Always compute#instance for instances."
- },
- "displayDevice": {
- "$ref": "DisplayDevice",
- "description": "Enables display device for the instance."
- },
- "shieldedInstanceIntegrityPolicy": {
- "$ref": "ShieldedInstanceIntegrityPolicy"
- },
- "fingerprint": {
- "type": "string",
- "format": "byte",
- "description": "Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance."
- },
- "metadata": {
- "description": "The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.",
- "$ref": "Metadata"
- },
- "privateIpv6GoogleAccess": {
- "description": "The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.",
- "type": "string",
- "enum": [
- "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
- "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE",
- "INHERIT_FROM_SUBNETWORK"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enumDescriptions": [
- "Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.",
- "Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.",
- "Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork."
- ]
- },
- "networkInterfaces": {
- "type": "array",
- "items": {
- "$ref": "NetworkInterface"
- },
- "description": "An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance."
- },
- "cpuPlatform": {
- "description": "[Output Only] The CPU platform used by this instance.",
- "type": "string"
- },
- "minCpuPlatform": {
- "description": "Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\".",
- "type": "string"
- },
- "sourceMachineImage": {
- "description": "Source machine image",
- "type": "string"
- },
- "networkPerformanceConfig": {
- "$ref": "NetworkPerformanceConfig"
- },
- "id": {
- "format": "uint64",
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
- },
- "canIpForward": {
- "description": "Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .",
- "type": "boolean"
- },
- "tags": {
- "$ref": "Tags",
- "description": "Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field."
- },
- "advancedMachineFeatures": {
- "$ref": "AdvancedMachineFeatures",
- "description": "Controls for advanced machine-related behavior features."
+ "parameters": {
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ },
+ "maxResults": {
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "minimum": "0",
+ "format": "uint32",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone where the instance group is located.",
+ "required": true,
+ "location": "path"
+ }
+ }
},
- "disks": {
- "type": "array",
- "items": {
- "$ref": "AttachedDisk"
+ "delete": {
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}",
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.",
+ "id": "compute.instanceGroups.delete",
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "zone": {
+ "type": "string",
+ "required": true,
+ "description": "The name of the zone where the instance group is located.",
+ "location": "path"
+ },
+ "instanceGroup": {
+ "location": "path",
+ "description": "The name of the instance group to delete.",
+ "type": "string",
+ "required": true
+ }
},
- "description": "Array of disks associated with this instance. Persistent disks must be created before you can assign them."
- },
- "keyRevocationActionType": {
- "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.",
- "enumDescriptions": [
- "Default value. This value is unused.",
- "Indicates user chose no operation.",
- "Indicates user chose to opt for VM shutdown on key revocation."
+ "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroup"
],
- "enum": [
- "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED",
- "NONE",
- "STOP"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
- },
- "labelFingerprint": {
- "description": "A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.",
- "format": "byte",
- "type": "string"
- },
- "resourcePolicies": {
- "type": "array",
- "description": "Resource policies applied to this instance.",
- "items": {
- "type": "string"
+ "response": {
+ "$ref": "Operation"
}
},
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "The name of the resource, provided by the client when initially creating the resource. The resource 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.",
- "annotations": {
- "required": [
- "compute.instances.insert"
- ]
+ "addInstances": {
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances",
+ "request": {
+ "$ref": "InstanceGroupsAddInstancesRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.instanceGroups.addInstances",
+ "description": "Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroup"
+ ],
+ "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances",
+ "httpMethod": "POST",
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The name of the zone where the instance group is located."
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "instanceGroup": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "The name of the instance group where you are adding instances."
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
}
},
- "satisfiesPzs": {
- "description": "[Output Only] Reserved for future use.",
- "type": "boolean"
- },
- "guestAccelerators": {
- "items": {
- "$ref": "AcceleratorConfig"
+ "setNamedPorts": {
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts",
+ "id": "compute.instanceGroups.setNamedPorts",
+ "response": {
+ "$ref": "Operation"
},
- "description": "A list of the type and count of accelerator cards attached to the instance.",
- "type": "array"
- },
- "labels": {
- "description": "Labels to apply to this instance. These can be later modified by the setLabels method.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
+ "request": {
+ "$ref": "InstanceGroupsSetNamedPortsRequest"
+ },
+ "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroup"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Sets the named ports for the specified instance group.",
+ "parameters": {
+ "instanceGroup": {
+ "required": true,
+ "location": "path",
+ "description": "The name of the instance group where the named ports are updated.",
+ "type": "string"
+ },
+ "zone": {
+ "required": true,
+ "description": "The name of the zone where the instance group is located.",
+ "type": "string",
+ "location": "path"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
}
},
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "lastStopTimestamp": {
- "description": "[Output Only] Last stop timestamp in RFC3339 text format.",
- "type": "string"
- }
- }
- },
- "TargetInstance": {
- "description": "Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances.",
- "type": "object",
- "id": "TargetInstance",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64"
- },
- "natPolicy": {
- "description": "Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance.",
- "enumDescriptions": [
- "No NAT performed."
+ "listInstances": {
+ "parameters": {
+ "instanceGroup": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the instance group from which you want to generate a list of included instances."
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "description": "The name of the zone where the instance group is located.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "minimum": "0",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "type": "integer"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "compute.instanceGroups.listInstances",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances",
+ "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroup"
],
- "type": "string",
- "enum": [
- "NO_NAT"
+ "response": {
+ "$ref": "InstanceGroupsListInstances"
+ },
+ "description": "Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use `eq` (equal) or `ne` (not equal) operators.",
+ "request": {
+ "$ref": "InstanceGroupsListInstancesRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
]
},
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "instance": {
- "type": "string",
- "description": "A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance "
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "kind": {
- "type": "string",
- "default": "compute#targetInstance",
- "description": "[Output Only] The type of the resource. Always compute#targetInstance for target instances."
- },
- "name": {
- "type": "string",
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
- },
- "network": {
- "description": "The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.",
- "type": "string"
- }
- }
- },
- "SubnetworkSecondaryRange": {
- "description": "Represents a secondary IP range of a subnetwork.",
- "id": "SubnetworkSecondaryRange",
- "type": "object",
- "properties": {
- "ipCidrRange": {
- "description": "The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. The range can be any range listed in the Valid ranges list.",
- "type": "string"
- },
- "rangeName": {
- "type": "string",
- "description": "The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork."
- }
- }
- },
- "NodeGroupMaintenanceWindow": {
- "properties": {
- "maintenanceDuration": {
- "$ref": "Duration",
- "description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario."
- },
- "startTime": {
- "description": "Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.",
- "type": "string"
- }
- },
- "description": "Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.",
- "type": "object",
- "id": "NodeGroupMaintenanceWindow"
- },
- "LocationPolicyLocation": {
- "type": "object",
- "id": "LocationPolicyLocation",
- "properties": {
- "preference": {
- "type": "string",
- "enumDescriptions": [
- "Location is allowed for use.",
- "Location is prohibited.",
- "Default value, unused."
+ "get": {
+ "id": "compute.instanceGroups.get",
+ "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "InstanceGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "ALLOW",
- "DENY",
- "PREFERENCE_UNSPECIFIED"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroup"
],
- "description": "Preference for a given location. Set to either ALLOW or DENY."
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}",
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The name of the zone where the instance group is located."
+ },
+ "instanceGroup": {
+ "type": "string",
+ "description": "The name of the instance group.",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path"
+ }
+ },
+ "description": "Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead."
},
- "constraints": {
- "description": "Constraints that the caller requires on the result distribution in this zone.",
- "$ref": "LocationPolicyLocationConstraints"
- }
- }
- },
- "NetworksRemovePeeringRequest": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the peering, which should conform to RFC1035.",
- "type": "string"
- }
- },
- "id": "NetworksRemovePeeringRequest"
- },
- "Condition": {
- "id": "Condition",
- "type": "object",
- "description": "This is deprecated and has no effect. Do not use.",
- "properties": {
- "op": {
- "type": "string",
- "enumDescriptions": [
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use."
+ "removeInstances": {
+ "description": "Removes one or more instances from the specified instance group, but does not delete those instances. 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 before the VM instance is removed or deleted.",
+ "httpMethod": "POST",
+ "id": "compute.instanceGroups.removeInstances",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroup"
],
- "description": "This is deprecated and has no effect. Do not use.",
- "enum": [
- "DISCHARGED",
- "EQUALS",
- "IN",
- "NOT_EQUALS",
- "NOT_IN",
- "NO_OP"
- ]
- },
- "svc": {
- "description": "This is deprecated and has no effect. Do not use.",
- "type": "string"
+ "request": {
+ "$ref": "InstanceGroupsRemoveInstancesRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "instanceGroup": {
+ "description": "The name of the instance group where the specified instances will be removed.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "zone": {
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone where the instance group is located.",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances"
},
- "iam": {
- "enumDescriptions": [
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use."
+ "insert": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "APPROVER",
- "ATTRIBUTION",
- "AUTHORITY",
- "CREDENTIALS_TYPE",
- "CREDS_ASSERTION",
- "JUSTIFICATION_TYPE",
- "NO_ATTR",
- "SECURITY_REALM"
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "zone"
],
- "type": "string",
- "description": "This is deprecated and has no effect. Do not use."
+ "httpMethod": "POST",
+ "parameters": {
+ "zone": {
+ "description": "The name of the zone where you want to create the instance group.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
+ },
+ "id": "compute.instanceGroups.insert",
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroups",
+ "path": "projects/{project}/zones/{zone}/instanceGroups",
+ "description": "Creates an instance group in the specified project using the parameters that are included in the request.",
+ "request": {
+ "$ref": "InstanceGroup"
+ }
},
- "sys": {
- "enum": [
- "IP",
- "NAME",
- "NO_ATTR",
- "REGION",
- "SERVICE"
+ "aggregatedList": {
+ "flatPath": "projects/{project}/aggregated/instanceGroups",
+ "id": "compute.instanceGroups.aggregatedList",
+ "description": "Retrieves the list of instance groups and sorts them by zone.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enumDescriptions": [
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use."
+ "parameterOrder": [
+ "project"
],
- "description": "This is deprecated and has no effect. Do not use.",
- "type": "string"
- },
- "values": {
- "description": "This is deprecated and has no effect. Do not use.",
- "items": {
- "type": "string"
+ "httpMethod": "GET",
+ "parameters": {
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
},
- "type": "array"
+ "response": {
+ "$ref": "InstanceGroupAggregatedList"
+ },
+ "path": "projects/{project}/aggregated/instanceGroups"
}
}
},
- "AutoscalingPolicyScaleInControl": {
- "type": "object",
- "id": "AutoscalingPolicyScaleInControl",
- "properties": {
- "maxScaledInReplicas": {
- "description": "Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step.",
- "$ref": "FixedOrPercent"
+ "networkFirewallPolicies": {
+ "methods": {
+ "get": {
+ "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
+ "id": "compute.networkFirewallPolicies.get",
+ "parameterOrder": [
+ "project",
+ "firewallPolicy"
+ ],
+ "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
+ "response": {
+ "$ref": "FirewallPolicy"
+ },
+ "description": "Returns the specified network firewall policy.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "project": {
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "firewallPolicy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "description": "Name of the firewall policy to get.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "httpMethod": "GET"
},
- "timeWindowSec": {
- "description": "How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above.",
- "type": "integer",
- "format": "int32"
- }
- },
- "description": "Configuration that allows for slower scale in so that even if Autoscaler recommends an abrupt scale in of a MIG, it will be throttled as specified by the parameters below."
- },
- "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": {
- "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse",
- "type": "object",
- "properties": {
- "firewallPolicys": {
- "type": "array",
- "items": {
- "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
+ "list": {
+ "description": "Lists all the policies that have been configured for the specified project.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "default": "500",
+ "minimum": "0",
+ "location": "query",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ }
},
- "description": "Effective firewalls from firewall policy."
- },
- "firewalls": {
- "description": "Effective firewalls on the network.",
- "items": {
- "$ref": "Firewall"
+ "id": "compute.networkFirewallPolicies.list",
+ "response": {
+ "$ref": "FirewallPolicyList"
},
- "type": "array"
- }
- }
- },
- "NetworkEdgeSecurityServiceAggregatedList": {
- "id": "NetworkEdgeSecurityServiceAggregatedList",
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "flatPath": "projects/{project}/global/firewallPolicies",
+ "path": "projects/{project}/global/firewallPolicies",
+ "httpMethod": "GET"
},
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Name of the scope containing this set of security policies.",
- "$ref": "NetworkEdgeSecurityServicesScopedList"
+ "getRule": {
+ "parameters": {
+ "priority": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "The priority of the rule to get from the firewall policy."
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "firewallPolicy": {
+ "description": "Name of the firewall policy to which the queried rule belongs.",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ }
},
- "description": "A list of NetworkEdgeSecurityServicesScopedList resources."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "kind": {
- "default": "compute#networkEdgeSecurityServiceAggregatedList",
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#networkEdgeSecurityServiceAggregatedList for lists of Network Edge Security Services."
- },
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
+ "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule",
+ "id": "compute.networkFirewallPolicies.getRule",
+ "parameterOrder": [
+ "project",
+ "firewallPolicy"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule",
+ "description": "Gets a rule of the specified priority.",
+ "response": {
+ "$ref": "FirewallPolicyRule"
},
- "type": "array"
- },
- "etag": {
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "httpMethod": "GET"
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "message": {
+ "removeRule": {
+ "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule",
+ "description": "Deletes a rule of the specified priority.",
+ "parameters": {
+ "firewallPolicy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "path",
+ "description": "Name of the firewall policy to update."
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "priority": {
+ "description": "The priority of the rule to remove from the firewall policy.",
+ "type": "integer",
+ "location": "query",
+ "format": "int32"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
}
- }
- }
- },
- "type": "object"
- },
- "PacketMirroringList": {
- "id": "PacketMirroringList",
- "type": "object",
- "description": "Contains a list of PacketMirroring resources.",
- "properties": {
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#packetMirroring for packetMirrorings.",
- "default": "compute#packetMirroringList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "items": {
- "items": {
- "$ref": "PacketMirroring"
},
- "type": "array",
- "description": "A list of PacketMirroring resources."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule",
+ "parameterOrder": [
+ "project",
+ "firewallPolicy"
+ ],
+ "id": "compute.networkFirewallPolicies.removeRule"
},
- "warning": {
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "type": "string"
+ "removeAssociation": {
+ "parameters": {
+ "name": {
+ "type": "string",
+ "description": "Name for the attachment that will be removed.",
+ "location": "query"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "requestId": {
+ "type": "string",
+ "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"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "firewallPolicy": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the firewall policy to update."
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- }
- }
- },
- "NetworkAttachmentAggregatedList": {
- "type": "object",
- "properties": {
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "type": "object",
- "description": "A list of NetworkAttachmentsScopedList resources.",
- "additionalProperties": {
- "$ref": "NetworkAttachmentsScopedList",
- "description": "Name of the scope containing this set of NetworkAttachments."
- }
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "kind": {
- "default": "compute#networkAttachmentAggregatedList",
- "type": "string"
+ "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation",
+ "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Removes an association for the specified firewall policy.",
+ "id": "compute.networkFirewallPolicies.removeAssociation",
+ "parameterOrder": [
+ "project",
+ "firewallPolicy"
+ ]
},
- "warning": {
- "type": "object",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "getAssociation": {
+ "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "firewallPolicy"
+ ],
+ "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation",
+ "parameters": {
+ "firewallPolicy": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the firewall policy to which the queried association belongs.",
+ "required": true,
"type": "string"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
- },
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "name": {
+ "type": "string",
+ "location": "query",
+ "description": "The name of the association to get from the firewall policy."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "required": true
}
},
- "description": "[Output Only] Informational warning message."
- }
- },
- "description": "Contains a list of NetworkAttachmentsScopedList.",
- "id": "NetworkAttachmentAggregatedList"
- },
- "PacketMirroringForwardingRuleInfo": {
- "id": "PacketMirroringForwardingRuleInfo",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "description": "Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic."
- },
- "canonicalUrl": {
- "description": "[Output Only] Unique identifier for the forwarding rule; defined by the server.",
- "type": "string"
- }
- }
- },
- "LocalDisk": {
- "id": "LocalDisk",
- "type": "object",
- "properties": {
- "diskCount": {
- "type": "integer",
- "description": "Specifies the number of such disks.",
- "format": "int32"
- },
- "diskType": {
- "description": "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.",
- "type": "string"
- },
- "diskSizeGb": {
- "type": "integer",
- "format": "int32",
- "description": "Specifies the size of the disk in base-2 GB."
- }
- }
- },
- "NodeTypeList": {
- "type": "object",
- "description": "Contains a list of node types.",
- "id": "NodeTypeList",
- "properties": {
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "items": {
- "description": "A list of NodeType resources.",
- "type": "array",
- "items": {
- "$ref": "NodeType"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "kind": {
- "description": "[Output Only] Type of resource.Always compute#nodeTypeList for lists of node types.",
- "type": "string",
- "default": "compute#nodeTypeList"
+ "response": {
+ "$ref": "FirewallPolicyAssociation"
+ },
+ "httpMethod": "GET",
+ "description": "Gets an association with the specified name.",
+ "id": "compute.networkFirewallPolicies.getAssociation"
},
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ "addRule": {
+ "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule",
+ "id": "compute.networkFirewallPolicies.addRule",
+ "request": {
+ "$ref": "FirewallPolicyRule"
+ },
+ "parameterOrder": [
+ "project",
+ "firewallPolicy"
+ ],
+ "description": "Inserts a rule into a firewall policy.",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "minPriority": {
+ "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\u003e. This field is exclusive with rule.priority.",
+ "location": "query",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxPriority": {
+ "type": "integer",
+ "location": "query",
+ "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\u003e. This field is exclusive with rule.priority.",
+ "format": "int32"
+ },
+ "firewallPolicy": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "description": "Name of the firewall policy to update."
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "code": {
+ "delete": {
+ "parameters": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
},
- "message": {
+ "firewallPolicy": {
+ "description": "Name of the firewall policy to delete.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true
}
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
+ "description": "Deletes the specified policy.",
+ "httpMethod": "DELETE",
+ "id": "compute.networkFirewallPolicies.delete",
+ "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
+ "parameterOrder": [
+ "project",
+ "firewallPolicy"
+ ],
+ "response": {
+ "$ref": "Operation"
}
- }
- }
- },
- "NetworkEndpointWithHealthStatus": {
- "type": "object",
- "properties": {
- "networkEndpoint": {
- "$ref": "NetworkEndpoint",
- "description": "[Output only] The network endpoint;"
},
- "healths": {
- "description": "[Output only] The health status of network endpoint;",
- "items": {
- "$ref": "HealthStatusForNetworkEndpoint"
+ "insert": {
+ "flatPath": "projects/{project}/global/firewallPolicies",
+ "httpMethod": "POST",
+ "path": "projects/{project}/global/firewallPolicies",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- }
- },
- "id": "NetworkEndpointWithHealthStatus"
- },
- "WeightedBackendService": {
- "id": "WeightedBackendService",
- "type": "object",
- "properties": {
- "backendService": {
- "description": "The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.",
- "type": "string"
- },
- "weight": {
- "format": "uint32",
- "description": "Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. The value must be from 0 to 1000.",
- "type": "integer"
- },
- "headerAction": {
- "description": "Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.",
- "$ref": "HttpHeaderAction"
- }
- },
- "description": "In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple backend services. The volume of traffic for each backend service is proportional to the weight specified in each WeightedBackendService"
- },
- "AccessConfig": {
- "properties": {
- "networkTier": {
- "enum": [
- "FIXED_STANDARD",
- "PREMIUM",
- "STANDARD",
- "STANDARD_OVERRIDES_FIXED_STANDARD"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "Public internet quality with fixed bandwidth.",
- "High quality, Google-grade network tier, support for all networking products.",
- "Public internet quality, only limited support for other networking products.",
- "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured."
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
+ }
+ },
+ "request": {
+ "$ref": "FirewallPolicy"
+ },
+ "parameterOrder": [
+ "project"
],
- "description": "This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.",
- "type": "string"
- },
- "setPublicPtr": {
- "description": "Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.",
- "type": "boolean"
- },
- "externalIpv6": {
- "type": "string",
- "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."
+ "id": "compute.networkFirewallPolicies.insert",
+ "description": "Creates a new policy in the specified project using the data included in the request."
},
- "type": {
- "enumDescriptions": [
- "",
- ""
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "DIRECT_IPV6",
- "ONE_TO_ONE_NAT"
+ "httpMethod": "GET",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "resource": {
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name or id of the resource for this request."
+ },
+ "optionsRequestedPolicyVersion": {
+ "description": "Requested IAM Policy version.",
+ "location": "query",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "path": "projects/{project}/global/firewallPolicies/{resource}/getIamPolicy",
+ "flatPath": "projects/{project}/global/firewallPolicies/{resource}/getIamPolicy",
+ "parameterOrder": [
+ "project",
+ "resource"
],
- "type": "string",
- "default": "ONE_TO_ONE_NAT",
- "description": "The type of configuration. The default and only option is ONE_TO_ONE_NAT."
- },
- "name": {
- "description": "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.",
- "type": "string"
- },
- "kind": {
- "default": "compute#accessConfig",
- "description": "[Output Only] Type of the resource. Always compute#accessConfig for access configs.",
- "type": "string"
- },
- "publicPtrDomainName": {
- "type": "string",
- "description": "The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range."
+ "id": "compute.networkFirewallPolicies.getIamPolicy"
},
- "natIP": {
- "description": "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.",
- "type": "string"
+ "cloneRules": {
+ "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "firewallPolicy": {
+ "location": "path",
+ "type": "string",
+ "description": "Name of the firewall policy to update.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "sourceFirewallPolicy": {
+ "description": "The firewall policy from which to copy rules.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ }
+ },
+ "httpMethod": "POST",
+ "description": "Copies rules to the specified firewall policy.",
+ "id": "compute.networkFirewallPolicies.cloneRules",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules",
+ "parameterOrder": [
+ "project",
+ "firewallPolicy"
+ ]
},
- "externalIpv6PrefixLength": {
- "format": "int32",
- "type": "integer",
- "description": "The prefix length of the external IPv6 range."
- }
- },
- "id": "AccessConfig",
- "description": "An access configuration attached to an instance's network interface. Only one access config per instance is supported.",
- "type": "object"
- },
- "InstanceProperties": {
- "id": "InstanceProperties",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "description": "An optional text description for the instances that are created from these properties."
+ "addAssociation": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation",
+ "id": "compute.networkFirewallPolicies.addAssociation",
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "firewallPolicy": {
+ "description": "Name of the firewall policy to update.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "replaceExistingAssociation": {
+ "description": "Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "request": {
+ "$ref": "FirewallPolicyAssociation"
+ },
+ "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Inserts an association for the specified firewall policy.",
+ "parameterOrder": [
+ "project",
+ "firewallPolicy"
+ ]
},
- "networkInterfaces": {
- "type": "array",
- "items": {
- "$ref": "NetworkInterface"
+ "patch": {
+ "request": {
+ "$ref": "FirewallPolicy"
+ },
+ "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
+ "parameterOrder": [
+ "project",
+ "firewallPolicy"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
+ "id": "compute.networkFirewallPolicies.patch",
+ "description": "Patches the specified policy with the data included in the request.",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "firewallPolicy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string",
+ "description": "Name of the firewall policy to update.",
+ "required": true
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
},
- "description": "An array of network access configurations for this interface."
- },
- "networkPerformanceConfig": {
- "description": "Note that for MachineImage, this is not supported yet.",
- "$ref": "NetworkPerformanceConfig"
- },
- "labels": {
- "description": "Labels to apply to instances that are created from these properties.",
- "additionalProperties": {
- "type": "string"
+ "response": {
+ "$ref": "Operation"
},
- "type": "object"
+ "httpMethod": "PATCH"
},
- "machineType": {
- "annotations": {
- "required": [
- "compute.instanceTemplates.insert"
- ]
+ "patchRule": {
+ "request": {
+ "$ref": "FirewallPolicyRule"
},
- "type": "string",
- "description": "The machine type to use for instances that are created from these properties."
- },
- "disks": {
- "description": "An array of disks that are associated with the instances that are created from these properties.",
- "type": "array",
- "items": {
- "$ref": "AttachedDisk"
- }
- },
- "privateIpv6GoogleAccess": {
- "enum": [
- "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
- "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE",
- "INHERIT_FROM_SUBNETWORK"
- ],
- "enumDescriptions": [
- "Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.",
- "Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.",
- "Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork."
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule",
+ "parameters": {
+ "firewallPolicy": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "description": "Name of the firewall policy to update."
+ },
+ "priority": {
+ "type": "integer",
+ "description": "The priority of the rule to patch.",
+ "format": "int32",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "httpMethod": "POST",
+ "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule",
+ "description": "Patches a rule of the specified priority.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "description": "The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet."
- },
- "guestAccelerators": {
- "type": "array",
- "description": "A list of guest accelerator cards' type and count to use for instances created from these properties.",
- "items": {
- "$ref": "AcceleratorConfig"
- }
+ "id": "compute.networkFirewallPolicies.patchRule",
+ "parameterOrder": [
+ "project",
+ "firewallPolicy"
+ ]
},
- "resourcePolicies": {
- "items": {
- "type": "string"
+ "testIamPermissions": {
+ "id": "compute.networkFirewallPolicies.testIamPermissions",
+ "httpMethod": "POST",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "resource": {
+ "required": true,
+ "type": "string",
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ }
},
- "description": "Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.",
- "type": "array"
- },
- "shieldedInstanceConfig": {
- "$ref": "ShieldedInstanceConfig",
- "description": "Note that for MachineImage, this is not supported yet."
- },
- "reservationAffinity": {
- "$ref": "ReservationAffinity",
- "description": "Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet."
- },
- "resourceManagerTags": {
- "type": "object",
- "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.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "advancedMachineFeatures": {
- "description": "Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.",
- "$ref": "AdvancedMachineFeatures"
- },
- "scheduling": {
- "$ref": "Scheduling",
- "description": "Specifies the scheduling options for the instances that are created from these properties."
- },
- "minCpuPlatform": {
- "description": "Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.",
- "type": "string"
- },
- "keyRevocationActionType": {
- "type": "string",
- "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.",
- "enum": [
- "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED",
- "NONE",
- "STOP"
+ "path": "projects/{project}/global/firewallPolicies/{resource}/testIamPermissions",
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "Indicates user chose no operation.",
- "Indicates user chose to opt for VM shutdown on key revocation."
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "flatPath": "projects/{project}/global/firewallPolicies/{resource}/testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "parameterOrder": [
+ "project",
+ "resource"
]
},
- "canIpForward": {
- "description": "Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.",
- "type": "boolean"
- },
- "tags": {
- "description": "A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.",
- "$ref": "Tags"
- },
- "serviceAccounts": {
- "items": {
- "$ref": "ServiceAccount"
+ "setIamPolicy": {
+ "request": {
+ "$ref": "GlobalSetPolicyRequest"
},
- "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.",
- "type": "array"
- },
- "confidentialInstanceConfig": {
- "$ref": "ConfidentialInstanceConfig",
- "description": "Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet."
- },
- "metadata": {
- "$ref": "Metadata",
- "description": "The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information."
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "path": "projects/{project}/global/firewallPolicies/{resource}/setIamPolicy",
+ "id": "compute.networkFirewallPolicies.setIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "flatPath": "projects/{project}/global/firewallPolicies/{resource}/setIamPolicy",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ]
}
}
},
- "SubnetworkAggregatedList": {
- "type": "object",
- "id": "SubnetworkAggregatedList",
- "properties": {
- "items": {
- "description": "A list of SubnetworksScopedList resources.",
- "type": "object",
- "additionalProperties": {
- "description": "Name of the scope containing this set of Subnetworks.",
- "$ref": "SubnetworksScopedList"
- }
- },
- "unreachables": {
- "items": {
- "type": "string"
+ "backendServices": {
+ "methods": {
+ "addSignedUrlKey": {
+ "description": "Adds a key for validating requests with signed URLs for this backend service.",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "[Output Only] Unreachable resources."
- },
- "kind": {
- "type": "string",
- "default": "compute#subnetworkAggregatedList",
- "description": "[Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "warning": {
- "properties": {
- "message": {
+ "parameterOrder": [
+ "project",
+ "backendService"
+ ],
+ "parameters": {
+ "backendService": {
+ "description": "Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.",
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true
},
- "code": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "location": "path"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- },
- "type": "array"
+ "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).",
+ "type": "string",
+ "location": "query"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
+ "path": "projects/{project}/global/backendServices/{backendService}/addSignedUrlKey",
+ "id": "compute.backendServices.addSignedUrlKey",
+ "flatPath": "projects/{project}/global/backendServices/{backendService}/addSignedUrlKey",
+ "request": {
+ "$ref": "SignedUrlKey"
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "NodeTypeAggregatedList": {
- "type": "object",
- "properties": {
- "warning": {
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "setSecurityPolicy": {
+ "httpMethod": "POST",
+ "path": "projects/{project}/global/backendServices/{backendService}/setSecurityPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.backendServices.setSecurityPolicy",
+ "parameters": {
+ "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).",
+ "location": "query",
"type": "string"
},
- "code": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "backendService": {
+ "location": "path",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.",
+ "required": true
+ }
+ },
+ "request": {
+ "$ref": "SecurityPolicyReference"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "backendService"
+ ],
+ "flatPath": "projects/{project}/global/backendServices/{backendService}/setSecurityPolicy",
+ "description": "Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview"
+ },
+ "setEdgeSecurityPolicy": {
+ "id": "compute.backendServices.setEdgeSecurityPolicy",
+ "parameterOrder": [
+ "project",
+ "backendService"
+ ],
+ "path": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "backendService": {
+ "description": "Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request."
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "unreachables": {
- "type": "array",
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
+ "flatPath": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy",
+ "httpMethod": "POST",
+ "description": "Sets the edge security policy for the specified backend service.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "SecurityPolicyReference"
+ },
+ "response": {
+ "$ref": "Operation"
}
},
- "kind": {
- "default": "compute#nodeTypeAggregatedList",
- "description": "[Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "items": {
- "additionalProperties": {
- "description": "[Output Only] Name of the scope containing this set of node types.",
- "$ref": "NodeTypesScopedList"
+ "insert": {
+ "httpMethod": "POST",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ }
},
- "description": "A list of NodeTypesScopedList resources.",
- "type": "object"
- }
- },
- "id": "NodeTypeAggregatedList"
- },
- "NodeTemplateList": {
- "type": "object",
- "description": "Contains a list of node templates.",
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "NodeTemplate"
+ "description": "Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview .",
+ "path": "projects/{project}/global/backendServices",
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "description": "A list of NodeTemplate resources."
+ "request": {
+ "$ref": "BackendService"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.backendServices.insert",
+ "flatPath": "projects/{project}/global/backendServices"
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
+ "deleteSignedUrlKey": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey",
+ "parameterOrder": [
+ "project",
+ "backendService",
+ "keyName"
+ ],
+ "id": "compute.backendServices.deleteSignedUrlKey",
+ "flatPath": "projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey",
+ "parameters": {
+ "backendService": {
+ "description": "Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.",
+ "type": "string",
+ "required": true,
+ "location": "path"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request."
},
- "code": {
+ "keyName": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "description": "The name of the Signed URL Key to delete.",
+ "required": true,
+ "location": "query"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
}
- }
- },
- "kind": {
- "type": "string",
- "default": "compute#nodeTemplateList",
- "description": "[Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates."
- }
- },
- "id": "NodeTemplateList"
- },
- "SslPoliciesListAvailableFeaturesResponse": {
- "properties": {
- "features": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "type": "object",
- "id": "SslPoliciesListAvailableFeaturesResponse"
- },
- "InterconnectLocation": {
- "properties": {
- "kind": {
- "default": "compute#interconnectLocation",
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations."
- },
- "regionInfos": {
- "type": "array",
- "description": "[Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.",
- "items": {
- "$ref": "InterconnectLocationRegionInfo"
- }
- },
- "description": {
- "type": "string",
- "description": "[Output Only] An optional description of the resource."
- },
- "address": {
- "description": "[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.",
- "type": "string"
- },
- "city": {
- "type": "string",
- "description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\"."
- },
- "facilityProviderFacilityId": {
- "type": "string",
- "description": "[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1)."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "facilityProvider": {
- "type": "string",
- "description": "[Output Only] The name of the provider for this facility (e.g., EQUINIX)."
+ },
+ "description": "Deletes a key for validating requests with signed URLs for this backend service.",
+ "httpMethod": "POST"
},
- "status": {
- "enumDescriptions": [
- "The InterconnectLocation is available for provisioning new Interconnects.",
- "The InterconnectLocation is closed for provisioning new Interconnects."
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "path": "projects/{project}/global/backendServices/{resource}/setIamPolicy",
+ "request": {
+ "$ref": "GlobalSetPolicyRequest"
+ },
+ "parameters": {
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
],
- "type": "string",
- "enum": [
- "AVAILABLE",
- "CLOSED"
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. "
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "peeringdbFacilityId": {
- "description": "[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).",
- "type": "string"
+ "flatPath": "projects/{project}/global/backendServices/{resource}/setIamPolicy",
+ "id": "compute.backendServices.setIamPolicy"
},
- "continent": {
- "enum": [
- "AFRICA",
- "ASIA_PAC",
- "C_AFRICA",
- "C_ASIA_PAC",
- "C_EUROPE",
- "C_NORTH_AMERICA",
- "C_SOUTH_AMERICA",
- "EUROPE",
- "NORTH_AMERICA",
- "SOUTH_AMERICA"
+ "delete": {
+ "parameters": {
+ "backendService": {
+ "description": "Name of the BackendService resource to delete.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA ",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
+ "description": "Deletes the specified BackendService resource.",
+ "id": "compute.backendServices.delete",
+ "flatPath": "projects/{project}/global/backendServices/{backendService}",
+ "path": "projects/{project}/global/backendServices/{backendService}",
+ "parameterOrder": [
+ "project",
+ "backendService"
]
},
- "availabilityZone": {
- "type": "string",
- "description": "[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: \"zone1\" or \"zone2\"."
- },
- "supportsPzs": {
- "description": "[Output Only] Set to true for locations that support physical zone separation. Defaults to false if the field is not present.",
- "type": "boolean"
- },
- "name": {
- "description": "[Output Only] Name of the resource.",
- "type": "string"
- }
- },
- "id": "InterconnectLocation",
- "description": "Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.",
- "type": "object"
- },
- "PathMatcher": {
- "description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.",
- "properties": {
- "headerAction": {
- "description": "Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.",
- "$ref": "HttpHeaderAction"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "defaultRouteAction": {
- "$ref": "HttpRouteAction",
- "description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path matcher's defaultRouteAction."
- },
- "pathRules": {
- "description": "The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.",
- "items": {
- "$ref": "PathRule"
+ "patch": {
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "BackendService"
},
- "type": "array"
- },
- "defaultService": {
- "type": "string",
- "description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use "
- },
- "routeRules": {
- "type": "array",
- "items": {
- "$ref": "HttpRouteRule"
+ "id": "compute.backendServices.patch",
+ "parameterOrder": [
+ "project",
+ "backendService"
+ ],
+ "flatPath": "projects/{project}/global/backendServices/{backendService}",
+ "response": {
+ "$ref": "Operation"
},
- "description": "The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules."
- },
- "name": {
- "type": "string",
- "description": "The name to which this PathMatcher is referred by the HostRule."
- },
- "defaultUrlRedirect": {
- "$ref": "HttpRedirectAction",
- "description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy."
- }
- },
- "type": "object",
- "id": "PathMatcher"
- },
- "BackendServiceCdnPolicyBypassCacheOnRequestHeader": {
- "id": "BackendServiceCdnPolicyBypassCacheOnRequestHeader",
- "properties": {
- "headerName": {
- "description": "The header field name to match on when bypassing cache. Values are case-insensitive.",
- "type": "string"
- }
- },
- "type": "object",
- "description": "Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting."
- },
- "ImageFamilyView": {
- "properties": {
- "image": {
- "description": "The latest image that is part of the specified image family in the requested location, and that is not deprecated.",
- "$ref": "Image"
- }
- },
- "type": "object",
- "id": "ImageFamilyView"
- },
- "UrlMapsValidateRequest": {
- "id": "UrlMapsValidateRequest",
- "properties": {
- "resource": {
- "description": "Content of the UrlMap to be validated.",
- "$ref": "UrlMap"
- },
- "loadBalancingSchemes": {
- "items": {
- "enum": [
- "EXTERNAL",
- "EXTERNAL_MANAGED",
- "LOAD_BALANCING_SCHEME_UNSPECIFIED"
- ],
- "enumDescriptions": [
- "Signifies that this will be used for Classic L7 External Load Balancing.",
- "Signifies that this will be used for Envoy-based L7 External Load Balancing.",
- "If unspecified, the validation will try to infer the scheme from the backend service resources this Url map references. If the inferrence is not possible, EXTERNAL will be used as the default type."
- ],
- "type": "string"
+ "path": "projects/{project}/global/backendServices/{backendService}",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "backendService": {
+ "description": "Name of the BackendService resource to patch.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
},
- "type": "array",
- "description": "Specifies the load balancer type(s) this validation request is for. Use EXTERNAL_MANAGED for HTTP/HTTPS External Global Load Balancer with Advanced Traffic Management. Use EXTERNAL for Classic HTTP/HTTPS External Global Load Balancer. Other load balancer types are not supported. For more information, refer to Choosing a load balancer. If unspecified, the load balancing scheme will be inferred from the backend service resources this URL map references. If that can not be inferred (for example, this URL map only references backend buckets, or this Url map is for rewrites and redirects only and doesn't reference any backends), EXTERNAL will be used as the default type. If specified, the scheme(s) must not conflict with the load balancing scheme of the backend service resources this Url map references."
- }
- },
- "type": "object"
- },
- "NetworkEndpointGroupsListEndpointsRequest": {
- "type": "object",
- "id": "NetworkEndpointGroupsListEndpointsRequest",
- "properties": {
- "healthStatus": {
- "description": "Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.",
- "enum": [
- "SHOW",
- "SKIP"
- ],
- "enumDescriptions": [
- "Show the health status for each network endpoint. Impacts latency of the call.",
- "Health status for network endpoints will not be provided."
- ],
- "type": "string"
- }
- }
- },
- "TargetVpnGatewayAggregatedList": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "description": "Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules."
},
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
- },
- "message": {
+ "getHealth": {
+ "parameters": {
+ "backendService": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "path",
+ "description": "Name of the BackendService resource to which the queried instance belongs."
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "project": {
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
}
+ },
+ "parameterOrder": [
+ "project",
+ "backendService"
+ ],
+ "path": "projects/{project}/global/backendServices/{backendService}/getHealth",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/global/backendServices/{backendService}/getHealth",
+ "httpMethod": "POST",
+ "id": "compute.backendServices.getHealth",
+ "description": "Gets the most recent health check results for this BackendService. Example request body: { \"group\": \"/zones/us-east1-b/instanceGroups/lb-backend-example\" }",
+ "response": {
+ "$ref": "BackendServiceGroupHealth"
+ },
+ "request": {
+ "$ref": "ResourceGroupReference"
}
},
- "kind": {
- "type": "string",
- "default": "compute#targetVpnGatewayAggregatedList",
- "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "additionalProperties": {
- "$ref": "TargetVpnGatewaysScopedList",
- "description": "[Output Only] Name of the scope containing this set of target VPN gateways."
+ "update": {
+ "description": "Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.",
+ "parameterOrder": [
+ "project",
+ "backendService"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.backendServices.update",
+ "request": {
+ "$ref": "BackendService"
},
- "description": "A list of TargetVpnGateway resources.",
- "type": "object"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "unreachables": {
- "type": "array",
- "items": {
- "type": "string"
+ "flatPath": "projects/{project}/global/backendServices/{backendService}",
+ "response": {
+ "$ref": "Operation"
},
- "description": "[Output Only] Unreachable resources."
- }
- },
- "id": "TargetVpnGatewayAggregatedList"
- },
- "DisksScopedList": {
- "id": "DisksScopedList",
- "type": "object",
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "message": {
+ "httpMethod": "PUT",
+ "parameters": {
+ "backendService": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true,
+ "location": "path",
+ "description": "Name of the BackendService resource to update.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "requestId": {
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "location": "query",
+ "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)."
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- }
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path"
}
},
- "description": "[Output Only] Informational warning which replaces the list of disks when the list is empty."
+ "path": "projects/{project}/global/backendServices/{backendService}"
},
- "disks": {
- "type": "array",
- "items": {
- "$ref": "Disk"
+ "get": {
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "backendService": {
+ "description": "Name of the BackendService resource to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ }
},
- "description": "[Output Only] A list of disks contained in this scope."
- }
- }
- },
- "NodeGroupsAddNodesRequest": {
- "type": "object",
- "id": "NodeGroupsAddNodesRequest",
- "properties": {
- "additionalNodeCount": {
- "format": "int32",
- "description": "Count of additional nodes to be added to the node group.",
- "type": "integer"
- }
- }
- },
- "InstanceAggregatedList": {
- "type": "object",
- "id": "InstanceAggregatedList",
- "properties": {
- "items": {
- "additionalProperties": {
- "description": "[Output Only] Name of the scope containing this set of instances.",
- "$ref": "InstancesScopedList"
+ "parameterOrder": [
+ "project",
+ "backendService"
+ ],
+ "description": "Returns the specified BackendService resource. Gets a list of available backend services.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "BackendService"
},
- "type": "object",
- "description": "An object that contains a list of instances scoped by zone."
+ "flatPath": "projects/{project}/global/backendServices/{backendService}",
+ "httpMethod": "GET",
+ "path": "projects/{project}/global/backendServices/{backendService}",
+ "id": "compute.backendServices.get"
},
- "unreachables": {
- "items": {
- "type": "string"
+ "aggregatedList": {
+ "parameters": {
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "minimum": "0",
+ "type": "integer",
+ "location": "query",
+ "default": "500"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Name of the project scoping this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ }
},
- "description": "[Output Only] Unreachable resources.",
- "type": "array"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/aggregated/backendServices",
+ "httpMethod": "GET",
+ "id": "compute.backendServices.aggregatedList",
+ "flatPath": "projects/{project}/aggregated/backendServices",
+ "description": "Retrieves the list of all BackendService resources, regional and global, available to the specified project.",
+ "response": {
+ "$ref": "BackendServiceAggregatedList"
+ },
+ "parameterOrder": [
+ "project"
+ ]
},
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.",
- "default": "compute#instanceAggregatedList",
- "type": "string"
+ "list": {
+ "id": "compute.backendServices.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/global/backendServices",
+ "description": "Retrieves the list of BackendService resources available to the specified project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/global/backendServices",
+ "parameters": {
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "maxResults": {
+ "default": "500",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "BackendServiceList"
+ }
},
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "getIamPolicy": {
+ "path": "projects/{project}/global/backendServices/{resource}/getIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "id": "compute.backendServices.getIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path"
},
- "message": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Project ID for this request.",
+ "location": "path"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "type": "string"
+ "optionsRequestedPolicyVersion": {
+ "format": "int32",
+ "description": "Requested IAM Policy version.",
+ "location": "query",
+ "type": "integer"
}
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "flatPath": "projects/{project}/global/backendServices/{resource}/getIamPolicy",
+ "httpMethod": "GET",
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists."
}
}
},
- "ServiceAttachmentsScopedList": {
- "properties": {
- "serviceAttachments": {
- "type": "array",
- "items": {
- "$ref": "ServiceAttachment"
+ "regionSecurityPolicies": {
+ "methods": {
+ "patch": {
+ "request": {
+ "$ref": "SecurityPolicy"
},
- "description": "A list of ServiceAttachments contained in this scope."
- },
- "warning": {
- "type": "object",
- "description": "Informational warning which replaces the list of service attachments when the list is empty.",
- "properties": {
- "code": {
+ "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.regionSecurityPolicies.patch",
+ "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "securityPolicy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the security policy to update.",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "location": "path",
+ "required": true
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "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).",
+ "location": "query",
"type": "string"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path",
+ "required": true
}
- }
- }
- },
- "id": "ServiceAttachmentsScopedList",
- "type": "object"
- },
- "TargetPoolsAddInstanceRequest": {
- "type": "object",
- "properties": {
- "instances": {
- "items": {
- "$ref": "InstanceReference"
},
- "description": "A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone /instances/instance-name - projects/project-id/zones/zone/instances/instance-name - zones/zone/instances/instance-name ",
- "type": "array"
- }
- },
- "id": "TargetPoolsAddInstanceRequest"
- },
- "RouteList": {
- "description": "Contains a list of Route resources.",
- "type": "object",
- "properties": {
- "items": {
- "description": "A list of Route resources.",
- "items": {
- "$ref": "Route"
- },
- "type": "array"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#routeList"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "region",
+ "securityPolicy"
+ ],
+ "httpMethod": "PATCH",
+ "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead."
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- }
+ "insert": {
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Creates a new policy in the specified project using the data included in the request.",
+ "path": "projects/{project}/regions/{region}/securityPolicies",
+ "id": "compute.regionSecurityPolicies.insert",
+ "flatPath": "projects/{project}/regions/{region}/securityPolicies",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "request": {
+ "$ref": "SecurityPolicy"
+ },
+ "parameters": {
+ "validateOnly": {
+ "type": "boolean",
+ "location": "query",
+ "description": "If true, the request will not be committed."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "requestId": {
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "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"
+ },
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "location": "path"
}
}
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- },
- "id": "RouteList"
- },
- "GRPCHealthCheck": {
- "type": "object",
- "properties": {
- "portName": {
- "description": "Not supported.",
- "type": "string"
- },
- "portSpecification": {
- "type": "string",
- "enumDescriptions": [
- "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
- "Not supported.",
- "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
+ "get": {
+ "parameters": {
+ "region": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "required": true
+ },
+ "securityPolicy": {
+ "type": "string",
+ "description": "Name of the security policy to get.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ }
+ },
+ "description": "List all of the ordered rules present in a single specified policy.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.",
- "enum": [
- "USE_FIXED_PORT",
- "USE_NAMED_PORT",
- "USE_SERVING_PORT"
- ]
- },
- "grpcServiceName": {
- "description": "The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII.",
- "type": "string"
- },
- "port": {
- "type": "integer",
- "description": "The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.",
- "format": "int32"
- }
- },
- "id": "GRPCHealthCheck"
- },
- "LogConfig": {
- "id": "LogConfig",
- "description": "This is deprecated and has no effect. Do not use.",
- "type": "object",
- "properties": {
- "dataAccess": {
- "description": "This is deprecated and has no effect. Do not use.",
- "$ref": "LogConfigDataAccessOptions"
- },
- "cloudAudit": {
- "description": "This is deprecated and has no effect. Do not use.",
- "$ref": "LogConfigCloudAuditOptions"
- },
- "counter": {
- "description": "This is deprecated and has no effect. Do not use.",
- "$ref": "LogConfigCounterOptions"
- }
- }
- },
- "ZoneSetPolicyRequest": {
- "type": "object",
- "id": "ZoneSetPolicyRequest",
- "properties": {
- "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 in general a valid policy but certain services (like Projects) might reject them.",
- "$ref": "Policy"
+ "id": "compute.regionSecurityPolicies.get",
+ "parameterOrder": [
+ "project",
+ "region",
+ "securityPolicy"
+ ],
+ "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
+ "response": {
+ "$ref": "SecurityPolicy"
+ }
},
- "etag": {
- "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
- "type": "string",
- "format": "byte"
+ "list": {
+ "flatPath": "projects/{project}/regions/{region}/securityPolicies",
+ "description": "List all the policies that have been configured for the specified project and region.",
+ "path": "projects/{project}/regions/{region}/securityPolicies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.regionSecurityPolicies.list",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "region": {
+ "type": "string",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "maxResults": {
+ "type": "integer",
+ "location": "query",
+ "default": "500",
+ "format": "uint32",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ }
+ },
+ "response": {
+ "$ref": "SecurityPolicyList"
+ }
},
- "bindings": {
- "items": {
- "$ref": "Binding"
+ "delete": {
+ "response": {
+ "$ref": "Operation"
},
- "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.",
- "type": "array"
+ "parameterOrder": [
+ "project",
+ "region",
+ "securityPolicy"
+ ],
+ "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
+ "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
+ "id": "compute.regionSecurityPolicies.delete",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "securityPolicy": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the security policy to delete."
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "description": "Deletes the specified policy.",
+ "httpMethod": "DELETE"
}
}
},
- "InstanceGroupManagersScopedList": {
- "type": "object",
- "id": "InstanceGroupManagersScopedList",
- "properties": {
- "instanceGroupManagers": {
- "items": {
- "$ref": "InstanceGroupManager"
+ "packetMirrorings": {
+ "methods": {
+ "aggregatedList": {
+ "response": {
+ "$ref": "PacketMirroringAggregatedList"
},
- "type": "array",
- "description": "[Output Only] The list of managed instance groups that are contained in the specified project and zone."
+ "parameterOrder": [
+ "project"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.packetMirrorings.aggregatedList",
+ "description": "Retrieves an aggregated list of packetMirrorings.",
+ "parameters": {
+ "maxResults": {
+ "default": "500",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "type": "integer",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean"
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "flatPath": "projects/{project}/aggregated/packetMirrorings",
+ "httpMethod": "GET",
+ "path": "projects/{project}/aggregated/packetMirrorings"
},
- "warning": {
- "description": "[Output Only] The warning that replaces the list of managed instance groups when the list is empty.",
- "type": "object",
- "properties": {
- "code": {
+ "testIamPermissions": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "id": "compute.packetMirrorings.testIamPermissions",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "required": true,
+ "description": "Project ID for this request."
},
- "message": {
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "path"
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- }
+ "region": {
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the region for this request.",
+ "required": true
}
- }
- }
- }
- },
- "HTTPSHealthCheck": {
- "properties": {
- "proxyHeader": {
- "enumDescriptions": [
- "",
- ""
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "path": "projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
- "type": "string",
- "enum": [
- "NONE",
- "PROXY_V1"
- ]
- },
- "response": {
- "type": "string",
- "description": "Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http"
+ "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions",
+ "httpMethod": "POST"
},
- "portSpecification": {
- "enumDescriptions": [
- "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
- "Not supported.",
- "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
+ "delete": {
+ "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
+ "description": "Deletes the specified PacketMirroring resource.",
+ "id": "compute.packetMirrorings.delete",
+ "parameterOrder": [
+ "project",
+ "region",
+ "packetMirroring"
],
- "type": "string",
- "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.",
- "enum": [
- "USE_FIXED_PORT",
- "USE_NAMED_PORT",
- "USE_SERVING_PORT"
+ "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "location": "path",
+ "description": "Name of the region for this request.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "packetMirroring": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the PacketMirroring resource to delete.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
},
- "host": {
- "type": "string",
- "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest"
- },
- "port": {
- "format": "int32",
- "type": "integer",
- "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535."
- },
- "requestPath": {
- "type": "string",
- "description": "The request path of the HTTPS health check request. The default value is /."
- },
- "portName": {
- "type": "string",
- "description": "Not supported."
- }
- },
- "id": "HTTPSHealthCheck",
- "type": "object"
- },
- "AutoscalerList": {
- "properties": {
- "kind": {
- "type": "string",
- "default": "compute#autoscalerList",
- "description": "[Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "warning": {
- "properties": {
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- }
+ "patch": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "packetMirroring"
+ ],
+ "id": "compute.packetMirrorings.patch",
+ "request": {
+ "$ref": "PacketMirroring"
+ },
+ "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "project": {
+ "location": "path",
+ "required": true,
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "packetMirroring": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the PacketMirroring resource to patch.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "Name of the region for this request."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
+ "httpMethod": "PATCH"
+ },
+ "list": {
+ "flatPath": "projects/{project}/regions/{region}/packetMirrorings",
+ "id": "compute.packetMirrorings.list",
+ "parameters": {
+ "region": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
},
- "message": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
- }
- },
- "type": "object",
- "description": "[Output Only] Informational warning message."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "items": {
- "description": "A list of Autoscaler resources.",
- "type": "array",
- "items": {
- "$ref": "Autoscaler"
- }
- }
- },
- "type": "object",
- "description": "Contains a list of Autoscaler resources.",
- "id": "AutoscalerList"
- },
- "UrlMapsAggregatedList": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "description": "Type of resource.",
- "type": "string",
- "default": "compute#urlMapsAggregatedList"
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "required": true,
+ "location": "path"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "maxResults": {
+ "minimum": "0",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "type": "integer",
+ "default": "500"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
"type": "string"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- }
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
}
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "items": {
- "type": "object",
- "additionalProperties": {
- "$ref": "UrlMapsScopedList",
- "description": "Name of the scope containing this set of UrlMaps."
},
- "description": "A list of UrlMapsScopedList resources."
- }
- },
- "id": "UrlMapsAggregatedList"
- },
- "ManagedInstanceVersion": {
- "properties": {
- "instanceTemplate": {
- "type": "string",
- "description": "[Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }."
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the version."
- }
- },
- "id": "ManagedInstanceVersion",
- "type": "object"
- },
- "RegionDisksAddResourcePoliciesRequest": {
- "type": "object",
- "properties": {
- "resourcePolicies": {
- "description": "Resource policies to be added to this disk.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "RegionDisksAddResourcePoliciesRequest"
- },
- "WafExpressionSet": {
- "id": "WafExpressionSet",
- "properties": {
- "expressions": {
- "description": "List of available expressions.",
- "type": "array",
- "items": {
- "$ref": "WafExpressionSetExpression"
+ "path": "projects/{project}/regions/{region}/packetMirrorings",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves a list of PacketMirroring resources available to the specified project and region.",
+ "response": {
+ "$ref": "PacketMirroringList"
}
},
- "aliases": {
- "items": {
- "type": "string"
+ "insert": {
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like \"stable\" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set."
- },
- "id": {
- "description": "Google specified expression set ID. The format should be: - E.g. XSS-20170329 required",
- "type": "string"
- }
- },
- "type": "object"
- },
- "BackendServiceConnectionTrackingPolicy": {
- "id": "BackendServiceConnectionTrackingPolicy",
- "description": "Connection Tracking configuration for this BackendService.",
- "type": "object",
- "properties": {
- "connectionPersistenceOnUnhealthyBackends": {
- "description": "Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see [Connection Persistence for Network Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence) and [Connection Persistence for Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).",
- "enumDescriptions": [
- "",
- "",
- ""
+ "flatPath": "projects/{project}/regions/{region}/packetMirrorings",
+ "id": "compute.packetMirrorings.insert",
+ "httpMethod": "POST",
+ "description": "Creates a PacketMirroring resource in the specified project and region using the data included in the request.",
+ "request": {
+ "$ref": "PacketMirroring"
+ },
+ "parameters": {
+ "project": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region for this request."
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region"
],
- "enum": [
- "ALWAYS_PERSIST",
- "DEFAULT_FOR_PROTOCOL",
- "NEVER_PERSIST"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
- },
- "enableStrongAffinity": {
- "type": "boolean",
- "description": "Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly."
+ "path": "projects/{project}/regions/{region}/packetMirrorings"
},
- "trackingMode": {
- "enumDescriptions": [
- "",
- "",
- ""
+ "get": {
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
+ "id": "compute.packetMirrorings.get",
+ "parameterOrder": [
+ "project",
+ "region",
+ "packetMirroring"
],
- "enum": [
- "INVALID_TRACKING_MODE",
- "PER_CONNECTION",
- "PER_SESSION"
+ "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
+ "description": "Returns the specified PacketMirroring resource.",
+ "response": {
+ "$ref": "PacketMirroring"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see [Tracking Mode for Network Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode) and [Tracking Mode for Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).",
- "type": "string"
- },
- "idleTimeoutSec": {
- "description": "Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.",
- "type": "integer",
- "format": "int32"
+ "parameters": {
+ "region": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "packetMirroring": {
+ "required": true,
+ "type": "string",
+ "description": "Name of the PacketMirroring resource to return.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
+ }
}
}
},
- "HealthCheck": {
- "properties": {
- "checkIntervalSec": {
- "type": "integer",
- "description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
- "format": "int32"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "httpsHealthCheck": {
- "$ref": "HTTPSHealthCheck"
- },
- "logConfig": {
- "$ref": "HealthCheckLogConfig",
- "description": "Configure logging on this health check."
- },
- "grpcHealthCheck": {
- "$ref": "GRPCHealthCheck"
- },
- "id": {
- "format": "uint64",
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
- },
- "kind": {
- "description": "Type of the resource.",
- "default": "compute#healthCheck",
- "type": "string"
- },
- "sslHealthCheck": {
- "$ref": "SSLHealthCheck"
- },
- "unhealthyThreshold": {
- "type": "integer",
- "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
- "format": "int32"
- },
- "type": {
- "description": "Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.",
- "enum": [
- "GRPC",
- "HTTP",
- "HTTP2",
- "HTTPS",
- "INVALID",
- "SSL",
- "TCP"
+ "globalOperations": {
+ "methods": {
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "httpHealthCheck": {
- "$ref": "HTTPHealthCheck"
- },
- "timeoutSec": {
- "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.",
- "format": "int32",
- "type": "integer"
- },
- "region": {
- "description": "[Output Only] Region where the health check resides. Not applicable to global health checks.",
- "type": "string"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in 3339 text format.",
- "type": "string"
- },
- "healthyThreshold": {
- "format": "int32",
- "type": "integer",
- "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2."
- },
- "tcpHealthCheck": {
- "$ref": "TCPHealthCheck"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "name": {
- "type": "string",
- "description": "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. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "operation"
+ ],
+ "parameters": {
+ "operation": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the Operations resource to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "flatPath": "projects/{project}/global/operations/{operation}",
+ "id": "compute.globalOperations.get",
+ "httpMethod": "GET",
+ "description": "Retrieves the specified Operations resource.",
+ "path": "projects/{project}/global/operations/{operation}"
},
- "http2HealthCheck": {
- "$ref": "HTTP2HealthCheck"
- }
- },
- "id": "HealthCheck",
- "description": "Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/v1/healthChecks) * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Traffic Director must use global health checks (`compute.v1.HealthChecks`). Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.HealthChecks`). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.HealthChecks`). Backend service-based network load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Target pool-based network load balancers must use legacy HTTP health checks (`compute.v1.httpHealthChecks`). For more information, see Health checks overview.",
- "type": "object"
- },
- "TargetHttpsProxiesSetCertificateMapRequest": {
- "type": "object",
- "id": "TargetHttpsProxiesSetCertificateMapRequest",
- "properties": {
- "certificateMap": {
- "description": "URL of the Certificate Map to associate with this TargetHttpsProxy.",
- "type": "string"
- }
- }
- },
- "RegionInstanceGroupsSetNamedPortsRequest": {
- "id": "RegionInstanceGroupsSetNamedPortsRequest",
- "properties": {
- "namedPorts": {
- "description": "The list of named ports to set for this instance group.",
- "items": {
- "$ref": "NamedPort"
+ "aggregatedList": {
+ "flatPath": "projects/{project}/aggregated/operations",
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "OperationAggregatedList"
+ },
+ "description": "Retrieves an aggregated list of all operations.",
+ "httpMethod": "GET",
+ "id": "compute.globalOperations.aggregatedList",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "default": "500",
+ "minimum": "0",
+ "format": "uint32"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ }
},
- "type": "array"
- },
- "fingerprint": {
- "type": "string",
- "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.",
- "format": "byte"
- }
- },
- "type": "object"
- },
- "SslCertificateList": {
- "type": "object",
- "id": "SslCertificateList",
- "description": "Contains a list of SslCertificate resources.",
- "properties": {
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "path": "projects/{project}/aggregated/operations"
},
- "kind": {
- "description": "Type of resource.",
- "type": "string",
- "default": "compute#sslCertificateList"
- },
- "items": {
- "items": {
- "$ref": "SslCertificate"
+ "wait": {
+ "response": {
+ "$ref": "Operation"
},
- "description": "A list of SslCertificate resources.",
- "type": "array"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ "httpMethod": "POST",
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "operation": {
+ "description": "Name of the Operations resource to return.",
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "operation"
+ ],
+ "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ",
+ "path": "projects/{project}/global/operations/{operation}/wait",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/global/operations/{operation}/wait",
+ "id": "compute.globalOperations.wait"
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "list": {
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/global/operations",
+ "description": "Retrieves a list of Operation resources contained within the specified project.",
+ "response": {
+ "$ref": "OperationList"
+ },
+ "id": "compute.globalOperations.list",
+ "parameters": {
+ "maxResults": {
+ "minimum": "0",
+ "format": "uint32",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "type": "integer"
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
"type": "string"
},
- "message": {
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
}
},
- "type": "object"
- }
- }
- },
- "HttpHeaderMatch": {
- "properties": {
- "headerName": {
- "description": "The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name \":authority\". For matching a request's method, use the headerName \":method\". When the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin`.",
- "type": "string"
- },
- "suffixMatch": {
- "description": "The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.",
- "type": "string"
- },
- "presentMatch": {
- "description": "A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.",
- "type": "boolean"
- },
- "prefixMatch": {
- "description": "The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.",
- "type": "string"
- },
- "regexMatch": {
- "type": "string",
- "description": "The value of the header must match the regular expression specified in regexMatch. For more information about regular expression syntax, see Syntax. For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED."
- },
- "exactMatch": {
- "type": "string",
- "description": "The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set."
- },
- "rangeMatch": {
- "description": "The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch is not supported for load balancers that have loadBalancingScheme set to EXTERNAL.",
- "$ref": "Int64RangeMatch"
- },
- "invertMatch": {
- "description": "If set to false, the headerMatch is considered a match if the preceding match criteria are met. If set to true, the headerMatch is considered a match if the preceding match criteria are NOT met. The default setting is false. ",
- "type": "boolean"
- }
- },
- "id": "HttpHeaderMatch",
- "type": "object",
- "description": "matchRule criteria for request header matches."
- },
- "QuotaExceededInfo": {
- "type": "object",
- "properties": {
- "limitName": {
- "description": "The name of the quota limit.",
- "type": "string"
- },
- "metricName": {
- "description": "The Compute Engine quota metric name.",
- "type": "string"
- },
- "dimensions": {
- "description": "The map holding related quota dimensions.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "limit": {
- "format": "double",
- "type": "number",
- "description": "Current effective quota limit. The limit's unit depends on the quota type or metric."
- }
- },
- "id": "QuotaExceededInfo",
- "description": "Additional details for quota exceeded error for resource quota."
- },
- "RegionInstanceGroupManagersListErrorsResponse": {
- "id": "RegionInstanceGroupManagersListErrorsResponse",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "[Output Only] The list of errors of the managed instance group.",
- "items": {
- "$ref": "InstanceManagedByIgmError"
- }
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- }
- }
- },
- "MetadataFilter": {
- "id": "MetadataFilter",
- "description": "Opaque filter criteria used by load balancers to restrict routing configuration to a limited set of load balancing proxies. Proxies and sidecars involved in load balancing would typically present metadata to the load balancers that need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if load balancing involves Envoys, they receive routing configuration when values in metadataFilters match values supplied in of their XDS requests to loadbalancers.",
- "properties": {
- "filterLabels": {
- "description": "The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.",
- "type": "array",
- "items": {
- "$ref": "MetadataFilterLabelMatch"
- }
+ "flatPath": "projects/{project}/global/operations",
+ "parameterOrder": [
+ "project"
+ ]
},
- "filterMatchCriteria": {
- "description": "Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata. ",
- "enumDescriptions": [
- "Specifies that all filterLabels must match for the metadataFilter to be considered a match.",
- "Specifies that any filterLabel must match for the metadataFilter to be considered a match.",
- "Indicates that the match criteria was not set. A metadataFilter must never be created with this value."
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "project",
+ "operation"
],
- "type": "string",
- "enum": [
- "MATCH_ALL",
- "MATCH_ANY",
- "NOT_SET"
+ "description": "Deletes the specified Operations resource.",
+ "path": "projects/{project}/global/operations/{operation}",
+ "flatPath": "projects/{project}/global/operations/{operation}",
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "operation": {
+ "description": "Name of the Operations resource to delete.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
+ },
+ "id": "compute.globalOperations.delete",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
}
- },
- "type": "object"
- },
- "BackendServiceReference": {
- "id": "BackendServiceReference",
- "properties": {
- "backendService": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus": {
- "id": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus",
- "properties": {
- "nextRunStartTime": {
- "type": "string",
- "description": "[Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string."
- },
- "lastRunStartTime": {
- "description": "[Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReservationsResizeRequest": {
- "id": "ReservationsResizeRequest",
- "type": "object",
- "properties": {
- "specificSkuCount": {
- "format": "int64",
- "description": "Number of allocated resources can be resized with minimum = 1 and maximum = 1000.",
- "type": "string"
- }
}
},
- "ResourcePoliciesScopedList": {
- "id": "ResourcePoliciesScopedList",
- "properties": {
- "resourcePolicies": {
- "items": {
- "$ref": "ResourcePolicy"
+ "routers": {
+ "methods": {
+ "get": {
+ "flatPath": "projects/{project}/regions/{region}/routers/{router}",
+ "httpMethod": "GET",
+ "path": "projects/{project}/regions/{region}/routers/{router}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "router"
+ ],
+ "response": {
+ "$ref": "Router"
},
- "description": "A list of resourcePolicies contained in this scope.",
- "type": "array"
- },
- "warning": {
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "id": "compute.routers.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "router": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the Router resource to return.",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "required": true
},
- "data": {
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "region": {
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "Name of the region for this request."
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ }
+ },
+ "description": "Returns the specified Router resource. Gets a list of available routers by making a list() request."
+ },
+ "getRouterStatus": {
+ "id": "compute.routers.getRouterStatus",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "region": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "router": {
+ "required": true,
+ "description": "Name of the Router resource to query.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string"
}
},
- "type": "object",
- "description": "Informational warning which replaces the list of resourcePolicies when the list is empty."
- }
- },
- "type": "object"
- },
- "VpnGatewayStatusHighAvailabilityRequirementState": {
- "description": "Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway.",
- "id": "VpnGatewayStatusHighAvailabilityRequirementState",
- "type": "object",
- "properties": {
- "unsatisfiedReason": {
- "enumDescriptions": [
- ""
- ],
- "description": "Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE.",
- "type": "string",
- "enum": [
- "INCOMPLETE_TUNNELS_COVERAGE"
- ]
- },
- "state": {
- "enumDescriptions": [
- "VPN tunnels are configured with adequate redundancy from Cloud VPN gateway to the peer VPN gateway. For both GCP-to-non-GCP and GCP-to-GCP connections, the adequate redundancy is a pre-requirement for users to get 99.99% availability on GCP side; please note that for any connection, end-to-end 99.99% availability is subject to proper configuration on the peer VPN gateway.",
- "VPN tunnels are not configured with adequate redundancy from the Cloud VPN gateway to the peer gateway"
+ "parameterOrder": [
+ "project",
+ "region",
+ "router"
],
- "description": "Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.",
- "enum": [
- "CONNECTION_REDUNDANCY_MET",
- "CONNECTION_REDUNDANCY_NOT_MET"
+ "flatPath": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus",
+ "path": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string"
- }
- }
- },
- "BackendServiceCdnPolicy": {
- "type": "object",
- "properties": {
- "cacheKeyPolicy": {
- "description": "The CacheKeyPolicy for this CdnPolicy.",
- "$ref": "CacheKeyPolicy"
- },
- "bypassCacheOnRequestHeaders": {
- "type": "array",
- "items": {
- "$ref": "BackendServiceCdnPolicyBypassCacheOnRequestHeader"
+ "response": {
+ "$ref": "RouterStatusResponse"
},
- "description": "Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings."
+ "httpMethod": "GET",
+ "description": "Retrieves runtime information of the specified router."
},
- "cacheMode": {
- "enum": [
- "CACHE_ALL_STATIC",
- "FORCE_CACHE_ALL",
- "INVALID_CACHE_MODE",
- "USE_ORIGIN_HEADERS"
- ],
- "description": "Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.",
- "enumDescriptions": [
- "Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.",
- "Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.",
- "",
- "Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server."
+ "getNatMappingInfo": {
+ "id": "compute.routers.getNatMappingInfo",
+ "description": "Retrieves runtime Nat mapping information of VM endpoints.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "router"
],
- "type": "string"
- },
- "signedUrlKeyNames": {
- "items": {
- "type": "string"
+ "response": {
+ "$ref": "VmEndpointNatMappingsList"
},
- "type": "array",
- "description": "[Output Only] Names of the keys for signing request URLs."
- },
- "negativeCachingPolicy": {
- "type": "array",
- "items": {
- "$ref": "BackendServiceCdnPolicyNegativeCachingPolicy"
+ "flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo",
+ "httpMethod": "GET",
+ "parameters": {
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "router": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the Router resource to query for Nat Mapping information of VM endpoints."
+ },
+ "maxResults": {
+ "minimum": "0",
+ "type": "integer",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "format": "uint32"
+ },
+ "region": {
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ }
},
- "description": "Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists."
- },
- "defaultTtl": {
- "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
- "type": "integer",
- "format": "int32"
- },
- "clientTtl": {
- "type": "integer",
- "description": "Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a \"public\" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a \"public\" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).",
- "format": "int32"
- },
- "requestCoalescing": {
- "type": "boolean",
- "description": "If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin."
- },
- "signedUrlCacheMaxAgeSec": {
- "type": "string",
- "description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.",
- "format": "int64"
- },
- "negativeCaching": {
- "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.",
- "type": "boolean"
- },
- "serveWhileStale": {
- "format": "int32",
- "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.",
- "type": "integer"
+ "path": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "maxTtl": {
- "type": "integer",
- "description": "Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of \"0\" means \"always revalidate\". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
- "format": "int32"
- }
- },
- "description": "Message containing Cloud CDN configuration for a backend service.",
- "id": "BackendServiceCdnPolicy"
- },
- "RouterStatusNatStatus": {
- "description": "Status of a NAT contained in this router.",
- "type": "object",
- "id": "RouterStatusNatStatus",
- "properties": {
- "drainUserAllocatedNatIps": {
- "description": "A list of IPs user-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].",
- "items": {
- "type": "string"
+ "update": {
+ "request": {
+ "$ref": "Router"
},
- "type": "array"
- },
- "drainAutoAllocatedNatIps": {
- "items": {
- "type": "string"
+ "httpMethod": "PUT",
+ "flatPath": "projects/{project}/regions/{region}/routers/{router}",
+ "description": "Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.",
+ "path": "projects/{project}/regions/{region}/routers/{router}",
+ "response": {
+ "$ref": "Operation"
},
- "description": "A list of IPs auto-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].",
- "type": "array"
- },
- "numVmEndpointsWithNatMappings": {
- "type": "integer",
- "format": "int32",
- "description": "Number of VM endpoints (i.e., Nics) that can use NAT."
- },
- "name": {
- "type": "string",
- "description": "Unique name of this NAT."
- },
- "autoAllocatedNatIps": {
- "type": "array",
- "items": {
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "region": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true,
+ "description": "Name of the region for this request."
+ },
+ "router": {
+ "required": true,
+ "type": "string",
+ "description": "Name of the Router resource to update.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ }
},
- "description": "A list of IPs auto-allocated for NAT. Example: [\"1.1.1.1\", \"129.2.16.89\"]"
- },
- "minExtraNatIpsNeeded": {
- "description": "The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used.",
- "type": "integer",
- "format": "int32"
- },
- "userAllocatedNatIps": {
- "description": "A list of IPs user-allocated for NAT. They will be raw IP strings like \"179.12.26.133\".",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "parameterOrder": [
+ "project",
+ "region",
+ "router"
+ ],
+ "id": "compute.routers.update"
},
- "userAllocatedNatIpResources": {
- "items": {
- "type": "string"
+ "preview": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region",
+ "router"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/routers/{router}/preview",
+ "request": {
+ "$ref": "Router"
},
- "description": "A list of fully qualified URLs of reserved IP address resources.",
- "type": "array"
- },
- "ruleStatus": {
- "description": "Status of rules in this NAT.",
- "items": {
- "$ref": "RouterStatusNatStatusNatRuleStatus"
+ "id": "compute.routers.preview",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "RoutersPreviewResponse"
},
- "type": "array"
- }
- }
- },
- "HttpHealthCheckList": {
- "type": "object",
- "properties": {
- "kind": {
- "description": "Type of resource.",
- "default": "compute#httpHealthCheckList",
- "type": "string"
- },
- "warning": {
- "type": "object",
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "description": "Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.",
+ "parameters": {
+ "router": {
+ "description": "Name of the Router resource to query.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path",
"type": "string"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "region": {
+ "description": "Name of the region for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path"
}
},
- "description": "[Output Only] Informational warning message."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "path": "projects/{project}/regions/{region}/routers/{router}/preview"
},
- "items": {
- "type": "array",
- "items": {
- "$ref": "HttpHealthCheck"
+ "patch": {
+ "description": "Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
+ "id": "compute.routers.patch",
+ "request": {
+ "$ref": "Router"
},
- "description": "A list of HttpHealthCheck resources."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- }
- },
- "description": "Contains a list of HttpHealthCheck resources.",
- "id": "HttpHealthCheckList"
- },
- "Binding": {
- "properties": {
- "members": {
- "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "condition": {
- "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).",
- "$ref": "Expr"
- },
- "role": {
- "type": "string",
- "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`."
- },
- "bindingId": {
- "type": "string",
- "description": "This is deprecated and has no effect. Do not use."
- }
- },
- "type": "object",
- "id": "Binding",
- "description": "Associates `members`, or principals, with a `role`."
- },
- "RegionInstanceGroupManagersCreateInstancesRequest": {
- "type": "object",
- "description": "RegionInstanceGroupManagers.createInstances",
- "properties": {
- "instances": {
- "type": "array",
- "description": "[Required] List of specifications of per-instance configs.",
- "items": {
- "$ref": "PerInstanceConfig"
- }
- }
- },
- "id": "RegionInstanceGroupManagersCreateInstancesRequest"
- },
- "VpnGatewayAggregatedList": {
- "properties": {
- "items": {
- "description": "A list of VpnGateway resources.",
- "additionalProperties": {
- "description": "[Output Only] Name of the scope containing this set of VPN gateways.",
- "$ref": "VpnGatewaysScopedList"
+ "flatPath": "projects/{project}/regions/{region}/routers/{router}",
+ "parameters": {
+ "region": {
+ "required": true,
+ "type": "string",
+ "description": "Name of the region for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "router": {
+ "description": "Name of the Router resource to patch.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ }
},
- "type": "object"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.",
- "default": "compute#vpnGatewayAggregatedList",
- "type": "string"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "unreachables": {
- "type": "array",
- "items": {
- "type": "string"
+ "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Operation"
},
- "description": "[Output Only] Unreachable resources."
+ "parameterOrder": [
+ "project",
+ "region",
+ "router"
+ ],
+ "path": "projects/{project}/regions/{region}/routers/{router}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "message": {
+ "list": {
+ "path": "projects/{project}/regions/{region}/routers",
+ "flatPath": "projects/{project}/regions/{region}/routers",
+ "description": "Retrieves a list of Router resources available to the specified project.",
+ "parameters": {
+ "region": {
+ "description": "Name of the region for this request.",
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
"type": "string"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- }
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "location": "query",
+ "format": "uint32",
+ "type": "integer",
+ "minimum": "0"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
}
- }
- }
- },
- "type": "object",
- "id": "VpnGatewayAggregatedList"
- },
- "TestFailure": {
- "id": "TestFailure",
- "type": "object",
- "properties": {
- "expectedService": {
- "type": "string",
- "description": "Expected BackendService or BackendBucket resource the given URL should be mapped to."
- },
- "path": {
- "description": "Path portion including query parameters in the URL.",
- "type": "string"
- },
- "expectedRedirectResponseCode": {
- "format": "int32",
- "type": "integer",
- "description": "Expected HTTP status code for rule with `urlRedirect` calculated by load balancer"
- },
- "expectedOutputUrl": {
- "type": "string",
- "description": "The expected output URL evaluated by a load balancer containing the scheme, host, path and query parameters."
- },
- "headers": {
- "description": "HTTP headers of the request.",
- "items": {
- "$ref": "UrlMapTestHeader"
},
- "type": "array"
- },
- "actualService": {
- "description": "BackendService or BackendBucket returned by load balancer.",
- "type": "string"
- },
- "actualRedirectResponseCode": {
- "type": "integer",
- "format": "int32",
- "description": "Actual HTTP status code for rule with `urlRedirect` calculated by load balancer"
- },
- "actualOutputUrl": {
- "type": "string",
- "description": "The actual output URL evaluated by a load balancer containing the scheme, host, path and query parameters."
- },
- "host": {
- "description": "Host portion of the URL.",
- "type": "string"
- }
- }
- },
- "LicenseResourceCommitment": {
- "description": "Commitment for a particular license resource.",
- "type": "object",
- "properties": {
- "amount": {
- "type": "string",
- "format": "int64",
- "description": "The number of licenses purchased."
- },
- "coresPerLicense": {
- "type": "string",
- "description": "Specifies the core range of the instance for which this license applies."
- },
- "license": {
- "type": "string",
- "description": "Any applicable license URI."
- }
- },
- "id": "LicenseResourceCommitment"
- },
- "InterconnectList": {
- "type": "object",
- "description": "Response to the list request, and contains a list of interconnects.",
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "id": "compute.routers.list",
+ "response": {
+ "$ref": "RouterList"
+ },
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET"
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "data": {
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "insert": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/regions/{region}/routers",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
},
- "message": {
+ "region": {
+ "description": "Name of the region for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true
},
- "code": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
}
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "description": "A list of Interconnect resources.",
- "type": "array",
- "items": {
- "$ref": "Interconnect"
- }
+ },
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "Router"
+ },
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "path": "projects/{project}/regions/{region}/routers",
+ "id": "compute.routers.insert",
+ "description": "Creates a Router resource in the specified project and region using the data included in the request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.",
- "default": "compute#interconnectList"
- }
- },
- "id": "InterconnectList"
- },
- "MachineTypesScopedList": {
- "id": "MachineTypesScopedList",
- "properties": {
- "warning": {
- "description": "[Output Only] An informational warning that appears when the machine types list is empty.",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "delete": {
+ "description": "Deletes the specified Router resource.",
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/regions/{region}/routers/{router}",
+ "flatPath": "projects/{project}/regions/{region}/routers/{router}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "router"
+ ],
+ "id": "compute.routers.delete",
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region for this request.",
+ "location": "path",
"type": "string"
},
- "code": {
+ "requestId": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
- },
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- }
+ "location": "query",
+ "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)."
+ },
+ "router": {
+ "description": "Name of the Router resource to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
}
},
- "type": "object"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "machineTypes": {
- "type": "array",
- "description": "[Output Only] A list of machine types contained in this scope.",
- "items": {
- "$ref": "MachineType"
- }
- }
- },
- "type": "object"
- },
- "ProjectsSetDefaultNetworkTierRequest": {
- "type": "object",
- "id": "ProjectsSetDefaultNetworkTierRequest",
- "properties": {
- "networkTier": {
- "description": "Default network tier to be set.",
- "type": "string",
- "enum": [
- "FIXED_STANDARD",
- "PREMIUM",
- "STANDARD",
- "STANDARD_OVERRIDES_FIXED_STANDARD"
+ "aggregatedList": {
+ "description": "Retrieves an aggregated list of routers.",
+ "flatPath": "projects/{project}/aggregated/routers",
+ "id": "compute.routers.aggregatedList",
+ "parameterOrder": [
+ "project"
],
- "enumDescriptions": [
- "Public internet quality with fixed bandwidth.",
- "High quality, Google-grade network tier, support for all networking products.",
- "Public internet quality, only limited support for other networking products.",
- "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured."
+ "httpMethod": "GET",
+ "path": "projects/{project}/aggregated/routers",
+ "response": {
+ "$ref": "RouterAggregatedList"
+ },
+ "parameters": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "default": "500",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
- "SslCertificateSelfManagedSslCertificate": {
- "type": "object",
- "properties": {
- "certificate": {
- "description": "A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.",
- "type": "string"
+ "zones": {
+ "methods": {
+ "list": {
+ "flatPath": "projects/{project}/zones",
+ "id": "compute.zones.list",
+ "response": {
+ "$ref": "ZoneList"
+ },
+ "description": "Retrieves the list of Zone resources available to the specified project.",
+ "path": "projects/{project}/zones",
+ "parameters": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "location": "query",
+ "format": "uint32",
+ "minimum": "0",
+ "default": "500",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET"
},
- "privateKey": {
- "description": "A write-only private key in PEM format. Only insert requests will include this field.",
- "type": "string"
+ "get": {
+ "response": {
+ "$ref": "Zone"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the zone resource to return.",
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request."
+ }
+ },
+ "id": "compute.zones.get",
+ "flatPath": "projects/{project}/zones/{zone}",
+ "description": "Returns the specified Zone resource. Gets a list of available zones by making a list() request.",
+ "path": "projects/{project}/zones/{zone}",
+ "httpMethod": "GET"
}
- },
- "id": "SslCertificateSelfManagedSslCertificate",
- "description": "Configuration and status of a self-managed SSL certificate."
+ }
},
- "SslPolicy": {
- "description": "Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts.",
- "type": "object",
- "properties": {
- "warnings": {
- "description": "[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "type": "string"
- },
- "message": {
- "type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
- },
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- }
- }
+ "httpsHealthChecks": {
+ "methods": {
+ "get": {
+ "description": "Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.",
+ "httpMethod": "GET",
+ "id": "compute.httpsHealthChecks.get",
+ "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
+ "parameterOrder": [
+ "project",
+ "httpsHealthCheck"
+ ],
+ "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "HttpsHealthCheck"
+ },
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "httpsHealthCheck": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Name of the HttpsHealthCheck resource to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
}
}
},
- "fingerprint": {
- "type": "string",
- "format": "byte",
- "description": "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 SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy."
+ "insert": {
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/global/httpsHealthChecks",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "HttpsHealthCheck"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "flatPath": "projects/{project}/global/httpsHealthChecks",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Creates a HttpsHealthCheck resource in the specified project using the data included in the request.",
+ "id": "compute.httpsHealthChecks.insert"
},
- "customFeatures": {
- "type": "array",
- "description": "A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.",
- "items": {
- "type": "string"
+ "update": {
+ "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request.",
+ "parameterOrder": [
+ "project",
+ "httpsHealthCheck"
+ ],
+ "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "httpsHealthCheck": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the HttpsHealthCheck resource to update.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
+ }
+ },
+ "id": "compute.httpsHealthChecks.update",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "HttpsHealthCheck"
+ },
+ "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
+ "httpMethod": "PUT",
+ "response": {
+ "$ref": "Operation"
}
},
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "kind": {
- "description": "[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.",
- "type": "string",
- "default": "compute#sslPolicy"
- },
- "minTlsVersion": {
- "enumDescriptions": [
- "TLS 1.0",
- "TLS 1.1",
- "TLS 1.2"
+ "list": {
+ "flatPath": "projects/{project}/global/httpsHealthChecks",
+ "parameterOrder": [
+ "project"
],
- "description": "The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.",
- "type": "string",
- "enum": [
- "TLS_1_0",
- "TLS_1_1",
- "TLS_1_2"
- ]
- },
- "id": {
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. 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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies."
+ "parameters": {
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "location": "query",
+ "type": "integer",
+ "format": "uint32",
+ "default": "500"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves the list of HttpsHealthCheck resources available to the specified project.",
+ "response": {
+ "$ref": "HttpsHealthCheckList"
+ },
+ "id": "compute.httpsHealthChecks.list",
+ "httpMethod": "GET",
+ "path": "projects/{project}/global/httpsHealthChecks"
},
- "profile": {
- "description": "Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.",
- "type": "string",
- "enum": [
- "COMPATIBLE",
- "CUSTOM",
- "MODERN",
- "RESTRICTED"
+ "delete": {
+ "parameters": {
+ "httpsHealthCheck": {
+ "description": "Name of the HttpsHealthCheck resource to delete.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
+ "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "Compatible profile. Allows the broadset set of clients, even those which support only out-of-date SSL features to negotiate with the load balancer.",
- "Custom profile. Allow only the set of allowed SSL features specified in the customFeatures field.",
- "Modern profile. Supports a wide set of SSL features, allowing modern clients to negotiate SSL with the load balancer.",
- "Restricted profile. Supports a reduced set of SSL features, intended to meet stricter compliance requirements."
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified HttpsHealthCheck resource.",
+ "id": "compute.httpsHealthChecks.delete",
+ "parameterOrder": [
+ "project",
+ "httpsHealthCheck"
]
},
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "enabledFeatures": {
- "items": {
- "type": "string"
+ "patch": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "HttpsHealthCheck"
},
- "description": "[Output Only] The list of features enabled in the SSL policy.",
- "type": "array"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- }
- },
- "id": "SslPolicy"
- },
- "NodeGroupAggregatedList": {
- "id": "NodeGroupAggregatedList",
- "type": "object",
- "properties": {
- "warning": {
- "properties": {
- "message": {
+ "id": "compute.httpsHealthChecks.patch",
+ "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
+ "parameterOrder": [
+ "project",
+ "httpsHealthCheck"
+ ],
+ "parameters": {
+ "httpsHealthCheck": {
+ "location": "path",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the HttpsHealthCheck resource to patch."
},
- "code": {
+ "project": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "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).",
+ "type": "string",
+ "location": "query"
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- },
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "kind": {
- "description": "[Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups.",
- "default": "compute#nodeGroupAggregatedList",
- "type": "string"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "[Output Only] Name of the scope containing this set of node groups.",
- "$ref": "NodeGroupsScopedList"
- },
- "description": "A list of NodeGroupsScopedList resources."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}"
}
}
},
- "MachineType": {
- "properties": {
- "memoryMb": {
- "description": "[Output Only] The amount of physical memory available to the instance, defined in MB.",
- "type": "integer",
- "format": "int32"
- },
- "zone": {
- "description": "[Output Only] The name of the zone where the machine type resides, such as us-central1-a.",
- "type": "string"
- },
- "accelerators": {
- "type": "array",
- "description": "[Output Only] A list of accelerator configurations assigned to this machine type.",
- "items": {
- "properties": {
- "guestAcceleratorCount": {
- "description": "Number of accelerator cards exposed to the guest.",
- "format": "int32",
- "type": "integer"
- },
- "guestAcceleratorType": {
- "type": "string",
- "description": "The accelerator type resource name, not a full URL, e.g. 'nvidia-tesla-k80'."
- }
+ "subnetworks": {
+ "methods": {
+ "delete": {
+ "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
+ "description": "Deletes the specified subnetwork.",
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string",
+ "required": true
},
- "type": "object"
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "subnetwork": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Name of the Subnetwork resource to delete."
+ }
+ },
+ "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.subnetworks.delete",
+ "parameterOrder": [
+ "project",
+ "region",
+ "subnetwork"
+ ],
+ "response": {
+ "$ref": "Operation"
}
},
- "name": {
- "description": "[Output Only] Name of the resource.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "maximumPersistentDisksSizeGb": {
- "type": "string",
- "description": "[Output Only] Maximum total persistent disks size (GB) allowed.",
- "format": "int64"
- },
- "kind": {
- "description": "[Output Only] The type of the resource. Always compute#machineType for machine types.",
- "type": "string",
- "default": "compute#machineType"
- },
- "isSharedCpu": {
- "type": "boolean",
- "description": "[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information."
- },
- "scratchDisks": {
- "type": "array",
- "description": "[Output Only] A list of extended scratch disks assigned to the instance.",
- "items": {
- "type": "object",
- "properties": {
- "diskGb": {
- "format": "int32",
- "type": "integer",
- "description": "Size of the scratch disk, defined in GB."
- }
+ "listUsable": {
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/aggregated/subnetworks/listUsable",
+ "id": "compute.subnetworks.listUsable",
+ "parameterOrder": [
+ "project"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/aggregated/subnetworks/listUsable",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "type": "integer",
+ "default": "500",
+ "format": "uint32"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string"
}
+ },
+ "description": "Retrieves an aggregated list of all usable subnetworks in the project.",
+ "response": {
+ "$ref": "UsableSubnetworksAggregatedList"
}
},
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "maximumPersistentDisks": {
- "type": "integer",
- "description": "[Output Only] Maximum persistent disks allowed.",
- "format": "int32"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable."
- },
- "guestCpus": {
- "type": "integer",
- "format": "int32",
- "description": "[Output Only] The number of virtual CPUs that are available to the instance."
- },
- "description": {
- "description": "[Output Only] An optional textual description of the resource.",
- "type": "string"
+ "insert": {
+ "request": {
+ "$ref": "Subnetwork"
+ },
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.subnetworks.insert",
+ "description": "Creates a subnetwork in the specified project using the data included in the request.",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/regions/{region}/subnetworks",
+ "flatPath": "projects/{project}/regions/{region}/subnetworks",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ }
+ }
},
- "imageSpaceGb": {
- "type": "integer",
- "description": "[Deprecated] This property is deprecated and will never be populated with any relevant values.",
- "format": "int32"
- }
- },
- "description": "Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types.",
- "type": "object",
- "id": "MachineType"
- },
- "InterconnectDiagnosticsLinkStatus": {
- "type": "object",
- "properties": {
- "circuitId": {
- "type": "string",
- "description": "The unique ID for this link assigned during turn up by Google."
+ "get": {
+ "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
+ "id": "compute.subnetworks.get",
+ "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
+ "httpMethod": "GET",
+ "description": "Returns the specified subnetwork. Gets a list of available subnetworks list() request.",
+ "response": {
+ "$ref": "Subnetwork"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "subnetwork": {
+ "description": "Name of the Subnetwork resource to return.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "region": {
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "subnetwork"
+ ]
},
- "operationalStatus": {
- "type": "string",
- "enumDescriptions": [
- "The interface is unable to communicate with the remote end.",
- "The interface has low level communication with the remote end."
+ "list": {
+ "description": "Retrieves a list of subnetworks available to the specified project.",
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "location": "path"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "type": "integer",
+ "location": "query",
+ "default": "500",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ }
+ },
+ "flatPath": "projects/{project}/regions/{region}/subnetworks",
+ "id": "compute.subnetworks.list",
+ "path": "projects/{project}/regions/{region}/subnetworks",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "The operational status of the link.",
- "enum": [
- "LINK_OPERATIONAL_STATUS_DOWN",
- "LINK_OPERATIONAL_STATUS_UP"
+ "response": {
+ "$ref": "SubnetworkList"
+ },
+ "parameterOrder": [
+ "project",
+ "region"
]
},
- "googleDemarc": {
- "type": "string",
- "description": "The Demarc address assigned by Google and provided in the LoA."
- },
- "lacpStatus": {
- "$ref": "InterconnectDiagnosticsLinkLACPStatus"
- },
- "arpCaches": {
- "type": "array",
- "items": {
- "$ref": "InterconnectDiagnosticsARPEntry"
+ "getIamPolicy": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.subnetworks.getIamPolicy",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
},
- "description": "A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled"
- },
- "receivingOpticalPower": {
- "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level.",
- "$ref": "InterconnectDiagnosticsLinkOpticalPower"
- },
- "transmittingOpticalPower": {
- "$ref": "InterconnectDiagnosticsLinkOpticalPower",
- "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level."
- }
- },
- "id": "InterconnectDiagnosticsLinkStatus"
- },
- "AcceleratorConfig": {
- "id": "AcceleratorConfig",
- "type": "object",
- "properties": {
- "acceleratorType": {
- "description": "Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.",
- "type": "string"
+ "parameters": {
+ "optionsRequestedPolicyVersion": {
+ "description": "Requested IAM Policy version.",
+ "type": "integer",
+ "location": "query",
+ "format": "int32"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the region for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string",
+ "required": true
+ }
+ },
+ "path": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy",
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists."
},
- "acceleratorCount": {
- "format": "int32",
- "type": "integer",
- "description": "The number of the guest accelerator cards exposed to this instance."
- }
- },
- "description": "A specification of the type and number of accelerator cards attached to the instance."
- },
- "AuthorizationLoggingOptions": {
- "type": "object",
- "properties": {
- "permissionType": {
- "enumDescriptions": [
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use."
+ "patch": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "This is deprecated and has no effect. Do not use.",
- "enum": [
- "ADMIN_READ",
- "ADMIN_WRITE",
- "DATA_READ",
- "DATA_WRITE",
- "PERMISSION_TYPE_UNSPECIFIED"
+ "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
+ "httpMethod": "PATCH",
+ "id": "compute.subnetworks.patch",
+ "parameters": {
+ "subnetwork": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the Subnetwork resource to patch.",
+ "type": "string",
+ "location": "path"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "type": "string"
+ },
+ "drainTimeoutSeconds": {
+ "format": "int32",
+ "description": "The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.",
+ "type": "integer",
+ "location": "query"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "subnetwork"
],
- "type": "string"
- }
- },
- "description": "This is deprecated and has no effect. Do not use.",
- "id": "AuthorizationLoggingOptions"
- },
- "InstanceGroupManagerActionsSummary": {
- "properties": {
- "abandoning": {
- "type": "integer",
- "format": "int32",
- "description": "[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it."
- },
- "suspending": {
- "format": "int32",
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended."
- },
- "verifying": {
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.",
- "format": "int32"
- },
- "creating": {
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.",
- "type": "integer",
- "format": "int32"
- },
- "none": {
- "format": "int32",
- "description": "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.",
- "type": "integer"
- },
- "creatingWithoutRetries": {
- "format": "int32",
- "description": "[Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.",
- "type": "integer"
- },
- "resuming": {
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.",
- "type": "integer",
- "format": "int32"
- },
- "starting": {
- "format": "int32",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.",
- "type": "integer"
- },
- "recreating": {
- "format": "int32",
- "type": "integer",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template."
- },
- "deleting": {
- "format": "int32",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.",
- "type": "integer"
- },
- "restarting": {
- "type": "integer",
- "format": "int32",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted."
- },
- "refreshing": {
- "type": "integer",
- "format": "int32",
- "description": "[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance."
- },
- "stopping": {
- "format": "int32",
- "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.",
- "type": "integer"
- }
- },
- "id": "InstanceGroupManagerActionsSummary",
- "type": "object"
- },
- "ResourcePolicyResourceStatus": {
- "properties": {
- "instanceSchedulePolicy": {
- "$ref": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus",
- "description": "[Output Only] Specifies a set of output values reffering to the instance_schedule_policy system status. This field should have the same name as corresponding policy field."
- }
- },
- "description": "Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this \"status\" field should mimic the structure of ResourcePolicy proto specification.",
- "id": "ResourcePolicyResourceStatus",
- "type": "object"
- },
- "InstancesSetMachineTypeRequest": {
- "properties": {
- "machineType": {
- "description": "Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1",
- "type": "string"
- }
- },
- "id": "InstancesSetMachineTypeRequest",
- "type": "object"
- },
- "HelpLink": {
- "properties": {
- "url": {
- "type": "string",
- "description": "The URL of the link."
- },
- "description": {
- "description": "Describes what the link offers.",
- "type": "string"
- }
- },
- "type": "object",
- "description": "Describes a URL link.",
- "id": "HelpLink"
- },
- "HttpHealthCheck": {
- "type": "object",
- "description": "Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .",
- "id": "HttpHealthCheck",
- "properties": {
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "checkIntervalSec": {
- "type": "integer",
- "description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
- "format": "int32"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "name": {
- "description": "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.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "unhealthyThreshold": {
- "format": "int32",
- "type": "integer",
- "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2."
- },
- "requestPath": {
- "type": "string",
- "description": "The request path of the HTTP health check request. The default value is /. This field does not support query parameters."
- },
- "kind": {
- "type": "string",
- "default": "compute#httpHealthCheck",
- "description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks."
- },
- "healthyThreshold": {
- "type": "integer",
- "format": "int32",
- "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2."
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
+ "request": {
+ "$ref": "Subnetwork"
+ },
+ "description": "Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched."
},
- "timeoutSec": {
- "format": "int32",
- "type": "integer",
- "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec."
+ "setPrivateIpGoogleAccess": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "subnetwork"
+ ],
+ "description": "Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.",
+ "request": {
+ "$ref": "SubnetworksSetPrivateIpGoogleAccessRequest"
+ },
+ "id": "compute.subnetworks.setPrivateIpGoogleAccess",
+ "parameters": {
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string"
+ },
+ "subnetwork": {
+ "required": true,
+ "description": "Name of the Subnetwork resource.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string"
+ }
+ }
},
- "host": {
- "type": "string",
- "description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used."
+ "expandIpCidrRange": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "subnetwork"
+ ],
+ "id": "compute.subnetworks.expandIpCidrRange",
+ "httpMethod": "POST",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region scoping this request."
+ },
+ "subnetwork": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Name of the Subnetwork resource to update."
+ }
+ },
+ "description": "Expands the IP CIDR range of the subnetwork to a specified value.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange",
+ "request": {
+ "$ref": "SubnetworksExpandIpCidrRangeRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange"
},
- "port": {
- "type": "integer",
- "description": "The TCP port number for the HTTP health check request. The default value is 80.",
- "format": "int32"
- }
- }
- },
- "InstanceParams": {
- "properties": {
- "resourceManagerTags": {
- "additionalProperties": {
- "type": "string"
+ "aggregatedList": {
+ "parameters": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "default": "500",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "format": "uint32",
+ "minimum": "0"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "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"
- }
- },
- "id": "InstanceParams",
- "type": "object",
- "description": "Additional instance params."
- },
- "NetworkEdgeSecurityServicesScopedList": {
- "id": "NetworkEdgeSecurityServicesScopedList",
- "type": "object",
- "properties": {
- "warning": {
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- }
+ "path": "projects/{project}/aggregated/subnetworks",
+ "response": {
+ "$ref": "SubnetworkAggregatedList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/aggregated/subnetworks",
+ "id": "compute.subnetworks.aggregatedList",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project"
+ ],
+ "description": "Retrieves an aggregated list of subnetworks."
+ },
+ "testIamPermissions": {
+ "id": "compute.subnetworks.testIamPermissions",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions",
+ "parameters": {
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "location": "path"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Project ID for this request."
},
- "message": {
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true,
+ "description": "The name of the region for this request."
}
},
- "type": "object",
- "description": "Informational warning which replaces the list of security policies when the list is empty."
- },
- "networkEdgeSecurityServices": {
- "description": "A list of NetworkEdgeSecurityServices contained in this scope.",
- "items": {
- "$ref": "NetworkEdgeSecurityService"
+ "request": {
+ "$ref": "TestPermissionsRequest"
},
- "type": "array"
- }
- }
- },
- "ResourcePolicyInstanceSchedulePolicySchedule": {
- "description": "Schedule for an instance operation.",
- "id": "ResourcePolicyInstanceSchedulePolicySchedule",
- "properties": {
- "schedule": {
- "description": "Specifies the frequency for the operation, using the unix-cron format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "SslPoliciesScopedList": {
- "id": "SslPoliciesScopedList",
- "type": "object",
- "properties": {
- "sslPolicies": {
- "type": "array",
- "description": "A list of SslPolicies contained in this scope.",
- "items": {
- "$ref": "SslPolicy"
- }
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions"
},
- "warning": {
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "setIamPolicy": {
+ "path": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
"type": "string"
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "resource": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request.",
+ "required": true
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- }
+ "region": {
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "The name of the region for this request."
}
},
- "type": "object",
- "description": "Informational warning which replaces the list of SSL policies when the list is empty."
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy",
+ "id": "compute.subnetworks.setIamPolicy",
+ "request": {
+ "$ref": "RegionSetPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
}
}
},
- "ExchangedPeeringRoutesList": {
- "type": "object",
- "properties": {
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "items": {
- "items": {
- "$ref": "ExchangedPeeringRoute"
- },
- "description": "A list of ExchangedPeeringRoute resources.",
- "type": "array"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "warning": {
- "type": "object",
- "properties": {
- "data": {
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "regionDisks": {
+ "methods": {
+ "setLabels": {
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/disks/{resource}/setLabels",
+ "id": "compute.regionDisks.setLabels",
+ "description": "Sets the labels on the target regional disk.",
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path",
+ "description": "Name or id of the resource for this request."
},
- "message": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "The region for this request.",
+ "location": "path"
},
- "code": {
+ "requestId": {
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "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"
}
},
- "description": "[Output Only] Informational warning message."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists.",
- "default": "compute#exchangedPeeringRoutesList",
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "RegionSetLabelsRequest"
+ },
+ "path": "projects/{project}/regions/{region}/disks/{resource}/setLabels"
},
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- }
- },
- "id": "ExchangedPeeringRoutesList"
- },
- "NetworkAttachmentsScopedList": {
- "id": "NetworkAttachmentsScopedList",
- "type": "object",
- "properties": {
- "warning": {
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- }
- },
- "code": {
- "type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "getIamPolicy": {
+ "httpMethod": "GET",
+ "path": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.regionDisks.getIamPolicy",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request.",
+ "required": true
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "optionsRequestedPolicyVersion": {
+ "format": "int32",
+ "type": "integer",
+ "description": "Requested IAM Policy version.",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "description": "The name of the region for this request.",
"type": "string"
}
},
- "description": "Informational warning which replaces the list of network attachments when the list is empty.",
- "type": "object"
+ "flatPath": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy",
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists."
},
- "networkAttachments": {
- "description": "A list of NetworkAttachments contained in this scope.",
- "type": "array",
- "items": {
- "$ref": "NetworkAttachment"
- }
- }
- }
- },
- "NetworkEndpointGroupPscData": {
- "properties": {
- "consumerPscAddress": {
- "description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.",
- "type": "string"
+ "removeResourcePolicies": {
+ "flatPath": "projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies",
+ "id": "compute.regionDisks.removeResourcePolicies",
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "disk": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "The disk name for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "The name of the region for this request."
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "RegionDisksRemoveResourcePoliciesRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Removes resource policies from a regional disk.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "disk"
+ ]
},
- "pscConnectionStatus": {
- "description": "[Output Only] The connection status of the PSC Forwarding Rule.",
- "enum": [
- "ACCEPTED",
- "CLOSED",
- "NEEDS_ATTENTION",
- "PENDING",
- "REJECTED",
- "STATUS_UNSPECIFIED"
+ "createSnapshot": {
+ "request": {
+ "$ref": "Snapshot"
+ },
+ "path": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot",
+ "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",
+ "parameterOrder": [
+ "project",
+ "region",
+ "disk"
],
- "enumDescriptions": [
- "The connection has been accepted by the producer.",
- "The connection has been closed by the producer and will not serve traffic going forward.",
- "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.",
- "The connection is pending acceptance by the producer.",
- "The connection has been rejected by the producer.",
- ""
+ "id": "compute.regionDisks.createSnapshot",
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region for this request.",
+ "required": true
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "disk": {
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the regional persistent disk to snapshot."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ }
},
- "pscConnectionId": {
- "description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.",
- "type": "string",
- "format": "uint64"
- }
- },
- "type": "object",
- "id": "NetworkEndpointGroupPscData",
- "description": "All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT."
- },
- "TCPHealthCheck": {
- "id": "TCPHealthCheck",
- "properties": {
- "response": {
- "type": "string",
- "description": "Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp"
+ "resize": {
+ "flatPath": "projects/{project}/regions/{region}/disks/{disk}/resize",
+ "httpMethod": "POST",
+ "id": "compute.regionDisks.resize",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "The project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Name of the region for this request."
+ },
+ "disk": {
+ "required": true,
+ "description": "Name of the regional persistent disk.",
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
+ },
+ "description": "Resizes the specified regional persistent disk.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "disk"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/regions/{region}/disks/{disk}/resize",
+ "request": {
+ "$ref": "RegionDisksResizeRequest"
+ }
},
- "portSpecification": {
- "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.",
- "enum": [
- "USE_FIXED_PORT",
- "USE_NAMED_PORT",
- "USE_SERVING_PORT"
+ "list": {
+ "response": {
+ "$ref": "DiskList"
+ },
+ "parameters": {
+ "maxResults": {
+ "minimum": "0",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "format": "uint32",
+ "default": "500"
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "Name of the region for this request."
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ }
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enumDescriptions": [
- "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
- "Not supported.",
- "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
+ "parameterOrder": [
+ "project",
+ "region"
],
- "type": "string"
+ "description": "Retrieves the list of persistent disks contained within the specified region.",
+ "path": "projects/{project}/regions/{region}/disks",
+ "flatPath": "projects/{project}/regions/{region}/disks",
+ "id": "compute.regionDisks.list"
},
- "proxyHeader": {
- "enum": [
- "NONE",
- "PROXY_V1"
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
- "enumDescriptions": [
- "",
- ""
+ "id": "compute.regionDisks.delete",
+ "flatPath": "projects/{project}/regions/{region}/disks/{disk}",
+ "description": "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.",
+ "parameters": {
+ "disk": {
+ "required": true,
+ "description": "Name of the regional persistent disk to delete.",
+ "location": "path",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "description": "Name of the region for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ }
+ },
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/regions/{region}/disks/{disk}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "disk"
]
},
- "request": {
- "description": "Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.",
- "type": "string"
- },
- "portName": {
- "type": "string",
- "description": "Not supported."
- },
- "port": {
- "type": "integer",
- "description": "The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.",
- "format": "int32"
- }
- },
- "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.",
- "properties": {
- "service": {
- "type": "string",
- "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."
- },
- "exemptedMembers": {
- "type": "array",
- "items": {
- "type": "string"
+ "testIamPermissions": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "path": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions",
+ "flatPath": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ },
+ "region": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the region for this request.",
+ "required": true,
+ "location": "path"
+ }
},
- "description": "This is deprecated and has no effect. Do not use."
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- }
- },
- "id": "AuditConfig",
- "type": "object"
- },
- "InstanceGroupManagersRecreateInstancesRequest": {
- "properties": {
- "instances": {
- "items": {
- "type": "string"
+ "id": "compute.regionDisks.testIamPermissions",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "response": {
+ "$ref": "TestPermissionsResponse"
},
- "description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
- "type": "array"
- }
- },
- "type": "object",
- "id": "InstanceGroupManagersRecreateInstancesRequest"
- },
- "SubnetworksSetPrivateIpGoogleAccessRequest": {
- "type": "object",
- "id": "SubnetworksSetPrivateIpGoogleAccessRequest",
- "properties": {
- "privateIpGoogleAccess": {
- "type": "boolean"
- }
- }
- },
- "InstanceGroupManagersUpdatePerInstanceConfigsReq": {
- "type": "object",
- "id": "InstanceGroupManagersUpdatePerInstanceConfigsReq",
- "description": "InstanceGroupManagers.updatePerInstanceConfigs",
- "properties": {
- "perInstanceConfigs": {
- "type": "array",
- "description": "The list of per-instance configurations to insert or patch on this managed instance group.",
- "items": {
- "$ref": "PerInstanceConfig"
- }
- }
- }
- },
- "Router": {
- "description": "Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.",
- "id": "Router",
- "properties": {
- "encryptedInterconnectRouter": {
- "description": "Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).",
- "type": "boolean"
- },
- "bgpPeers": {
- "description": "BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.",
- "type": "array",
- "items": {
- "$ref": "RouterBgpPeer"
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "TestPermissionsRequest"
}
},
- "nats": {
- "type": "array",
- "items": {
- "$ref": "RouterNat"
+ "addResourcePolicies": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
},
- "description": "A list of NAT services created in this router."
- },
- "md5AuthenticationKeys": {
- "items": {
- "$ref": "RouterMd5AuthenticationKey"
+ "parameterOrder": [
+ "project",
+ "region",
+ "disk"
+ ],
+ "request": {
+ "$ref": "RegionDisksAddResourcePoliciesRequest"
+ },
+ "parameters": {
+ "disk": {
+ "type": "string",
+ "location": "path",
+ "description": "The disk name for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "The name of the region for this request."
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ }
},
- "description": "Keys used for MD5 authentication.",
- "type": "array"
+ "path": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies",
+ "id": "compute.regionDisks.addResourcePolicies",
+ "flatPath": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation."
},
- "name": {
- "type": "string",
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.routers.insert"
- ]
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project",
+ "region",
+ "disk"
+ ],
+ "path": "projects/{project}/regions/{region}/disks/{disk}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/disks/{disk}",
+ "response": {
+ "$ref": "Disk"
+ },
+ "id": "compute.regionDisks.get",
+ "description": "Returns a specified regional persistent disk.",
+ "parameters": {
+ "disk": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the regional persistent disk to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "description": "Name of the region for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
}
},
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#router for routers.",
- "default": "compute#router",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "interfaces": {
- "items": {
- "$ref": "RouterInterface"
+ "insert": {
+ "httpMethod": "POST",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
+ },
+ "region": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "sourceImage": {
+ "type": "string",
+ "description": "Source image to restore onto a disk. This field is optional.",
+ "location": "query"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
},
- "type": "array",
- "description": "Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "bgp": {
- "description": "BGP information specific to this router.",
- "$ref": "RouterBgp"
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- },
- "region": {
- "description": "[Output Only] URI of the region where the router 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"
+ "flatPath": "projects/{project}/regions/{region}/disks",
+ "request": {
+ "$ref": "Disk"
+ },
+ "id": "compute.regionDisks.insert",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Creates a persistent regional disk in the specified project using the data included in the request.",
+ "path": "projects/{project}/regions/{region}/disks"
},
- "network": {
- "annotations": {
- "required": [
- "compute.routers.insert",
- "compute.routers.update"
- ]
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "path": "projects/{project}/regions/{region}/disks/{resource}/setIamPolicy",
+ "parameters": {
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the region for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ }
},
- "description": "URI of the network to which this router belongs.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "GuestAttributesValue": {
- "properties": {
- "items": {
- "items": {
- "$ref": "GuestAttributesEntry"
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.regionDisks.setIamPolicy",
+ "response": {
+ "$ref": "Policy"
},
- "type": "array"
- }
- },
- "id": "GuestAttributesValue",
- "type": "object",
- "description": "Array of guest attribute namespace/key/value tuples."
- },
- "RouterNatSubnetworkToNat": {
- "id": "RouterNatSubnetworkToNat",
- "type": "object",
- "properties": {
- "sourceIpRangesToNat": {
- "items": {
- "enumDescriptions": [
- "The primary and all the secondary ranges are allowed to Nat.",
- "A list of secondary ranges are allowed to Nat.",
- "The primary range is allowed to Nat."
- ],
- "type": "string",
- "enum": [
- "ALL_IP_RANGES",
- "LIST_OF_SECONDARY_IP_RANGES",
- "PRIMARY_IP_RANGE"
- ]
+ "request": {
+ "$ref": "RegionSetPolicyRequest"
},
- "description": "Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: [\"PRIMARY_IP_RANGE\", \"LIST_OF_SECONDARY_IP_RANGES\"] Default: [ALL_IP_RANGES]",
- "type": "array"
- },
- "secondaryIpRangeNames": {
- "description": "A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if \"LIST_OF_SECONDARY_IP_RANGES\" is one of the values in source_ip_ranges_to_nat.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "description": "URL for the subnetwork resource that will use NAT.",
- "type": "string"
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/disks/{resource}/setIamPolicy"
}
- },
- "description": "Defines the IP ranges that want to use NAT for a subnetwork."
+ }
},
- "Image": {
- "description": "Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.",
- "type": "object",
- "properties": {
- "shieldedInstanceInitialState": {
- "description": "Set the secure boot keys of shielded instance.",
- "$ref": "InitialStateConfig"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "sourceSnapshot": {
- "description": "URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ",
- "type": "string"
- },
- "guestOsFeatures": {
- "items": {
- "$ref": "GuestOsFeature"
+ "regionTargetHttpProxies": {
+ "methods": {
+ "get": {
+ "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "TargetHttpProxy"
},
- "type": "array",
- "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter."
- },
- "name": {
- "type": "string",
- "annotations": {
- "required": [
- "compute.images.insert"
- ]
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetHttpProxy"
+ ],
+ "id": "compute.regionTargetHttpProxies.get",
+ "httpMethod": "GET",
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "targetHttpProxy": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the TargetHttpProxy resource to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
+ }
},
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ "description": "Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.",
+ "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}"
},
- "architecture": {
- "description": "The architecture of the image. Valid values are ARM64 or X86_64.",
- "type": "string",
- "enum": [
- "ARCHITECTURE_UNSPECIFIED",
- "ARM64",
- "X86_64"
+ "delete": {
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetHttpProxy"
],
- "enumDescriptions": [
- "Default value indicating Architecture is not set.",
- "Machines with architecture ARM64",
- "Machines with architecture X86_64"
- ]
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "targetHttpProxy": {
+ "description": "Name of the TargetHttpProxy resource to delete.",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "location": "path"
+ }
},
- "description": "Labels to apply to this image. These can be later modified by the setLabels method.",
- "type": "object"
- },
- "sourceImageId": {
- "type": "string",
- "description": "[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name."
- },
- "sourceSnapshotEncryptionKey": {
- "description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.",
- "$ref": "CustomerEncryptionKey"
- },
- "imageEncryptionKey": {
- "description": "Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.",
- "$ref": "CustomerEncryptionKey"
- },
- "status": {
- "enumDescriptions": [
- "Image is deleting.",
- "Image creation failed due to an error.",
- "Image hasn't been created as yet.",
- "Image has been successfully created."
+ "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}",
+ "id": "compute.regionTargetHttpProxies.delete",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "description": "[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.",
- "enum": [
- "DELETING",
- "FAILED",
- "PENDING",
- "READY"
- ]
- },
- "labelFingerprint": {
- "description": "A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image.",
- "type": "string",
- "format": "byte"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ "description": "Deletes the specified TargetHttpProxy resource."
},
- "id": {
- "format": "uint64",
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ "insert": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "request": {
+ "$ref": "TargetHttpProxy"
+ },
+ "httpMethod": "POST",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "region": {
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ }
+ },
+ "description": "Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.",
+ "path": "projects/{project}/regions/{region}/targetHttpProxies",
+ "flatPath": "projects/{project}/regions/{region}/targetHttpProxies",
+ "id": "compute.regionTargetHttpProxies.insert"
},
- "sourceType": {
- "type": "string",
- "description": "The type of the image used to create this disk. The default and only valid value is RAW.",
- "enumDescriptions": [
- ""
+ "list": {
+ "response": {
+ "$ref": "TargetHttpProxyList"
+ },
+ "path": "projects/{project}/regions/{region}/targetHttpProxies",
+ "parameters": {
+ "region": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "format": "uint32",
+ "default": "500",
+ "type": "integer"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ }
+ },
+ "id": "compute.regionTargetHttpProxies.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "RAW"
+ "description": "Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "default": "RAW"
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/targetHttpProxies"
},
- "rawDisk": {
- "description": "The parameters of the raw disk image.",
- "properties": {
- "containerType": {
+ "setUrlMap": {
+ "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
+ "httpMethod": "POST",
+ "parameters": {
+ "targetHttpProxy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the TargetHttpProxy to set a URL map for."
+ },
+ "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).",
"type": "string",
- "enum": [
- "TAR"
- ],
- "enumDescriptions": [
- ""
- ],
- "description": "The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created."
+ "location": "query"
},
- "source": {
- "description": "The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ",
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
"type": "string"
},
- "sha1Checksum": {
+ "region": {
"type": "string",
- "pattern": "[a-f0-9]{40}",
- "description": "[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created."
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
}
},
- "type": "object"
- },
- "sourceDiskId": {
- "type": "string",
- "description": "[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name."
- },
- "archiveSizeBytes": {
- "type": "string",
- "description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).",
- "format": "int64"
- },
- "sourceImageEncryptionKey": {
- "$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."
- },
- "sourceDiskEncryptionKey": {
- "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.",
- "$ref": "CustomerEncryptionKey"
- },
- "sourceSnapshotId": {
- "description": "[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.",
- "type": "string"
- },
- "storageLocations": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Cloud Storage bucket storage location of the image (regional or multi-regional)."
- },
- "diskSizeGb": {
- "type": "string",
- "description": "Size of the image when restored onto a persistent disk (in GB).",
- "format": "int64"
- },
- "sourceImage": {
- "type": "string",
- "description": "URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL "
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "licenses": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Any applicable license URI."
- },
- "kind": {
- "default": "compute#image",
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#image for images."
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "The deprecation status associated with this image."
- },
- "satisfiesPzs": {
- "description": "[Output Only] Reserved for future use.",
- "type": "boolean"
- },
- "licenseCodes": {
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
+ "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
+ "id": "compute.regionTargetHttpProxies.setUrlMap",
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetHttpProxy"
+ ],
+ "description": "Changes the URL map for TargetHttpProxy.",
+ "request": {
+ "$ref": "UrlMapReference"
},
- "description": "Integer license codes indicating which licenses are attached to this image."
- },
- "family": {
- "type": "string",
- "description": "The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035."
- },
- "sourceDisk": {
- "description": "URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ",
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ }
}
- },
- "id": "Image"
+ }
},
- "RegionDisksRemoveResourcePoliciesRequest": {
- "properties": {
- "resourcePolicies": {
- "items": {
- "type": "string"
+ "regions": {
+ "methods": {
+ "get": {
+ "flatPath": "projects/{project}/regions/{region}",
+ "response": {
+ "$ref": "Region"
},
- "type": "array",
- "description": "Resource policies to be removed from this disk."
- }
- },
- "id": "RegionDisksRemoveResourcePoliciesRequest",
- "type": "object"
- },
- "MachineImageList": {
- "description": "A list of machine images.",
- "id": "MachineImageList",
- "properties": {
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "type": "string"
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- }
+ "path": "projects/{project}/regions/{region}",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "id": "compute.regions.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Returns the specified Region resource. Gets a list of available regions by making a list() request. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.",
+ "parameters": {
+ "region": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the region resource to return.",
+ "type": "string",
+ "required": true
},
- "message": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Project ID for this request."
}
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "items": {
- "items": {
- "$ref": "MachineImage"
},
- "description": "A list of MachineImage resources.",
- "type": "array"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "httpMethod": "GET"
},
- "kind": {
- "description": "[Output Only] The resource type, which is always compute#machineImagesListResponse for machine image lists.",
- "type": "string",
- "default": "compute#machineImageList"
- }
- },
- "type": "object"
- },
- "NetworkPeering": {
- "properties": {
- "stackType": {
- "enum": [
- "IPV4_IPV6",
- "IPV4_ONLY"
- ],
- "type": "string",
- "enumDescriptions": [
- "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.",
- "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6."
+ "list": {
+ "parameterOrder": [
+ "project"
],
- "description": "Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY."
- },
- "stateDetails": {
- "description": "[Output Only] Details about the current state of the peering.",
- "type": "string"
- },
- "network": {
- "type": "string",
- "description": "The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network."
- },
- "importSubnetRoutesWithPublicIp": {
- "type": "boolean",
- "description": "Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field."
- },
- "name": {
- "description": "Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
- "type": "string"
- },
- "importCustomRoutes": {
- "description": "Whether to import the custom routes from peer network. The default value is false.",
- "type": "boolean"
- },
- "exchangeSubnetRoutes": {
- "description": "Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.",
- "type": "boolean"
- },
- "state": {
- "type": "string",
- "description": "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.",
- "enumDescriptions": [
- "Matching configuration exists on the peer.",
- "There is no matching configuration on the peer, including the case when peer does not exist."
+ "description": "Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "maxResults": {
+ "default": "500",
+ "minimum": "0",
+ "type": "integer",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ }
+ },
+ "httpMethod": "GET",
+ "id": "compute.regions.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "ACTIVE",
- "INACTIVE"
- ]
- },
- "exportSubnetRoutesWithPublicIp": {
- "description": "Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.",
- "type": "boolean"
- },
- "peerMtu": {
- "format": "int32",
- "description": "Maximum Transmission Unit in bytes.",
- "type": "integer"
- },
- "exportCustomRoutes": {
- "description": "Whether to export the custom routes to peer network. The default value is false.",
- "type": "boolean"
- },
- "autoCreateRoutes": {
- "type": "boolean",
- "description": "This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE."
- }
- },
- "id": "NetworkPeering",
- "description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.",
- "type": "object"
- },
- "FirewallPolicy": {
- "type": "object",
- "id": "FirewallPolicy",
- "description": "Represents a Firewall Policy resource.",
- "properties": {
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "parent": {
- "type": "string",
- "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies."
- },
- "associations": {
- "description": "A list of associations that belong to this firewall policy.",
- "type": "array",
- "items": {
- "$ref": "FirewallPolicyAssociation"
- }
- },
- "selfLinkWithId": {
- "description": "[Output Only] Server-defined URL for this resource with the resource id.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "displayName": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. 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.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy."
- },
- "fingerprint": {
- "type": "string",
- "format": "byte",
- "description": "Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64"
- },
- "ruleTupleCount": {
- "type": "integer",
- "description": "[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.",
- "format": "int32"
- },
- "rules": {
- "type": "array",
- "description": "A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match \"*\"). If no rules are provided when creating a firewall policy, a default rule with action \"allow\" will be added.",
- "items": {
- "$ref": "FirewallPolicyRule"
- }
- },
- "region": {
- "description": "[Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. 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"
- },
- "shortName": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. 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."
- },
- "kind": {
- "default": "compute#firewallPolicy",
- "type": "string",
- "description": "[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies"
+ "response": {
+ "$ref": "RegionList"
+ },
+ "flatPath": "projects/{project}/regions",
+ "path": "projects/{project}/regions"
}
}
},
- "MetadataFilterLabelMatch": {
- "id": "MetadataFilterLabelMatch",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long."
- },
- "value": {
- "description": "The value of the label must match the specified value. value can have a maximum length of 1024 characters.",
- "type": "string"
- }
- },
- "description": "MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the load balancer."
- },
- "InterconnectAttachmentAggregatedList": {
- "type": "object",
- "id": "InterconnectAttachmentAggregatedList",
- "properties": {
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Name of the scope containing this set of interconnect attachments.",
- "$ref": "InterconnectAttachmentsScopedList"
+ "images": {
+ "methods": {
+ "getFromFamily": {
+ "flatPath": "projects/{project}/global/images/family/{family}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "family": {
+ "description": "Name of the image family to search for.",
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "family"
+ ],
+ "httpMethod": "GET",
+ "path": "projects/{project}/global/images/family/{family}",
+ "description": "Returns the latest image that is part of an image family and is not deprecated.",
+ "response": {
+ "$ref": "Image"
},
- "description": "A list of InterconnectAttachmentsScopedList resources."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "kind": {
- "default": "compute#interconnectAttachmentAggregatedList",
- "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "id": "compute.images.getFromFamily"
},
- "unreachables": {
- "items": {
- "type": "string"
+ "patch": {
+ "parameterOrder": [
+ "project",
+ "image"
+ ],
+ "path": "projects/{project}/global/images/{image}",
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "Image"
},
- "type": "array",
- "description": "[Output Only] Unreachable resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "warning": {
- "properties": {
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "location": "path"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "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).",
+ "location": "query",
"type": "string"
},
- "code": {
+ "image": {
+ "description": "Name of the image resource to patch.",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path"
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- }
- }
- },
- "InstanceGroup": {
- "type": "object",
- "properties": {
- "network": {
- "description": "[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).",
- "type": "string"
- },
- "size": {
- "format": "int32",
- "type": "integer",
- "description": "[Output Only] The total number of instances in the instance group."
- },
- "kind": {
- "description": "[Output Only] The resource type, which is always compute#instanceGroup for instance groups.",
- "default": "compute#instanceGroup",
- "type": "string"
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] A unique identifier for this instance group, generated by the server.",
- "type": "string"
- },
- "zone": {
- "description": "[Output Only] The URL of the zone where the instance group is located (for zonal resources).",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "selfLink": {
- "description": "[Output Only] The URL for this instance group. The server generates this URL.",
- "type": "string"
+ "id": "compute.images.patch",
+ "flatPath": "projects/{project}/global/images/{image}"
},
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.",
- "annotations": {
- "required": [
- "compute.instanceGroups.insert"
- ]
+ "delete": {
+ "response": {
+ "$ref": "Operation"
},
- "type": "string"
- },
- "subnetwork": {
- "type": "string",
- "description": "[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0)."
- },
- "fingerprint": {
- "description": "[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.",
- "format": "byte",
- "type": "string"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] The creation timestamp for this instance group in RFC3339 text format."
+ "httpMethod": "DELETE",
+ "flatPath": "projects/{project}/global/images/{image}",
+ "path": "projects/{project}/global/images/{image}",
+ "parameters": {
+ "image": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "description": "Name of the image resource to delete."
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string"
+ }
+ },
+ "description": "Deletes the specified image.",
+ "parameterOrder": [
+ "project",
+ "image"
+ ],
+ "id": "compute.images.delete",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "region": {
- "description": "[Output Only] The URL of the region where the instance group is located (for regional resources).",
- "type": "string"
+ "get": {
+ "description": "Returns the specified image. Gets a list of available images by making a list() request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "image"
+ ],
+ "parameters": {
+ "image": {
+ "description": "Name of the image resource to return.",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ }
+ },
+ "response": {
+ "$ref": "Image"
+ },
+ "id": "compute.images.get",
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/global/images/{image}",
+ "path": "projects/{project}/global/images/{image}"
},
- "namedPorts": {
- "description": " Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group. ",
- "type": "array",
- "items": {
- "$ref": "NamedPort"
+ "setIamPolicy": {
+ "path": "projects/{project}/global/images/{resource}/setIamPolicy",
+ "id": "compute.images.setIamPolicy",
+ "flatPath": "projects/{project}/global/images/{resource}/setIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "resource": {
+ "type": "string",
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ }
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "request": {
+ "$ref": "GlobalSetPolicyRequest"
}
- }
- },
- "id": "InstanceGroup",
- "description": "Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups."
- },
- "NodeType": {
- "type": "object",
- "properties": {
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "[Output Only] Name of the resource.",
- "type": "string"
- },
- "memoryMb": {
- "description": "[Output Only] The amount of physical memory available to the node type, defined in MB.",
- "type": "integer",
- "format": "int32"
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] The type of the resource. Always compute#nodeType for node types.",
- "default": "compute#nodeType",
- "type": "string"
- },
- "localSsdGb": {
- "type": "integer",
- "format": "int32",
- "description": "[Output Only] Local SSD available to the node type, defined in GB."
},
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
+ "insert": {
+ "flatPath": "projects/{project}/global/images",
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "forceCreate": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Force image creation if true."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request."
+ }
+ },
+ "path": "projects/{project}/global/images",
+ "parameterOrder": [
+ "project"
+ ],
+ "description": "Creates an image in the specified project using the data included in the request.",
+ "id": "compute.images.insert",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/devstorage.full_control",
+ "https://www.googleapis.com/auth/devstorage.read_only",
+ "https://www.googleapis.com/auth/devstorage.read_write"
+ ],
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "Image"
+ },
+ "response": {
+ "$ref": "Operation"
+ }
},
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this node type."
+ "testIamPermissions": {
+ "path": "projects/{project}/global/images/{resource}/testIamPermissions",
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "resource": {
+ "location": "path",
+ "type": "string",
+ "description": "Name or id of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
+ },
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/global/images/{resource}/testIamPermissions",
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "id": "compute.images.testIamPermissions"
},
- "cpuPlatform": {
- "description": "[Output Only] The CPU platform used by this node type.",
- "type": "string"
+ "getIamPolicy": {
+ "flatPath": "projects/{project}/global/images/{resource}/getIamPolicy",
+ "parameters": {
+ "optionsRequestedPolicyVersion": {
+ "format": "int32",
+ "location": "query",
+ "type": "integer",
+ "description": "Requested IAM Policy version."
+ },
+ "resource": {
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ }
+ },
+ "id": "compute.images.getIamPolicy",
+ "path": "projects/{project}/global/images/{resource}/getIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "httpMethod": "GET"
},
- "zone": {
- "description": "[Output Only] The name of the zone where the node type resides, such as us-central1-a.",
- "type": "string"
+ "deprecate": {
+ "flatPath": "projects/{project}/global/images/{image}/deprecate",
+ "httpMethod": "POST",
+ "description": "Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.",
+ "id": "compute.images.deprecate",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "DeprecationStatus"
+ },
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "image": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Image name."
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "image"
+ ],
+ "path": "projects/{project}/global/images/{image}/deprecate",
+ "response": {
+ "$ref": "Operation"
+ }
},
- "guestCpus": {
- "format": "int32",
- "type": "integer",
- "description": "[Output Only] The number of virtual CPUs that are available to the node type."
+ "setLabels": {
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "resource": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "GlobalSetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.images.setLabels",
+ "flatPath": "projects/{project}/global/images/{resource}/setLabels",
+ "httpMethod": "POST",
+ "description": "Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.",
+ "path": "projects/{project}/global/images/{resource}/setLabels",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ]
},
- "description": {
- "description": "[Output Only] An optional textual description of the resource.",
- "type": "string"
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project"
+ ],
+ "id": "compute.images.list",
+ "response": {
+ "$ref": "ImageList"
+ },
+ "path": "projects/{project}/global/images",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/global/images",
+ "parameters": {
+ "maxResults": {
+ "default": "500",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "format": "uint32",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "description": "Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud."
}
- },
- "description": "Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types.",
- "id": "NodeType"
+ }
},
- "RouterBgpPeer": {
- "id": "RouterBgpPeer",
- "properties": {
- "enable": {
- "type": "string",
- "enum": [
- "FALSE",
- "TRUE"
+ "regionSslPolicies": {
+ "methods": {
+ "insert": {
+ "id": "compute.regionSslPolicies.insert",
+ "request": {
+ "$ref": "SslPolicy"
+ },
+ "path": "projects/{project}/regions/{region}/sslPolicies",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region"
],
- "enumDescriptions": [
- "",
- ""
+ "flatPath": "projects/{project}/regions/{region}/sslPolicies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE."
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Creates a new policy in the specified project and region using the data included in the request."
},
- "managementType": {
- "description": "[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. ",
- "enum": [
- "MANAGED_BY_ATTACHMENT",
- "MANAGED_BY_USER"
+ "delete": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "sslPolicy"
],
- "type": "string",
- "enumDescriptions": [
- "The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.",
- "Default value, the BGP peer is manually created and managed by user."
- ]
- },
- "routerApplianceInstance": {
- "description": "URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.",
- "type": "string"
- },
- "advertisedGroups": {
- "items": {
- "enum": [
- "ALL_SUBNETS"
- ],
- "enumDescriptions": [
- "Advertise all available subnets (including peer VPC subnets)."
- ],
- "type": "string"
+ "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request."
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "sslPolicy": {
+ "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ }
},
- "type": "array",
- "description": "User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups."
- },
- "ipAddress": {
- "type": "string",
- "description": "IP address of the interface inside Google Cloud Platform. Only IPv4 is supported."
- },
- "peerIpAddress": {
- "description": "IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.",
- "type": "string"
- },
- "advertisedIpRanges": {
- "type": "array",
- "description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.",
- "items": {
- "$ref": "RouterAdvertisedIpRange"
+ "description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.",
+ "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.regionSslPolicies.delete",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
}
},
- "advertiseMode": {
- "enum": [
- "CUSTOM",
- "DEFAULT"
+ "list": {
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "maxResults": {
+ "location": "query",
+ "default": "500",
+ "type": "integer",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0"
+ }
+ },
+ "httpMethod": "GET",
+ "description": "Lists all the SSL policies that have been configured for the specified project and region.",
+ "flatPath": "projects/{project}/regions/{region}/sslPolicies",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "enumDescriptions": [
- "",
- ""
+ "path": "projects/{project}/regions/{region}/sslPolicies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "User-specified flag to indicate which mode to use for advertisement.",
- "type": "string"
- },
- "enableIpv6": {
- "type": "boolean",
- "description": "Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default."
- },
- "peerIpv6NexthopAddress": {
- "description": "IPv6 address of the BGP interface outside Google Cloud Platform.",
- "type": "string"
- },
- "advertisedRoutePriority": {
- "description": "The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.",
- "type": "integer",
- "format": "uint32"
- },
- "bfd": {
- "description": "BFD configuration for the BGP peering.",
- "$ref": "RouterBgpPeerBfd"
- },
- "interfaceName": {
- "description": "Name of the interface the BGP peer is associated with.",
- "type": "string"
- },
- "peerAsn": {
- "annotations": {
- "required": [
- "compute.routers.insert"
- ]
- },
- "format": "uint32",
- "description": "Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.",
- "type": "integer"
- },
- "md5AuthenticationKeyName": {
- "type": "string",
- "description": "Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035."
- },
- "name": {
- "description": "Name of this BGP peer. 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.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.routers.insert"
- ]
+ "id": "compute.regionSslPolicies.list",
+ "response": {
+ "$ref": "SslPoliciesList"
}
},
- "ipv6NexthopAddress": {
- "type": "string",
- "description": "IPv6 address of the interface inside Google Cloud Platform."
- }
- },
- "type": "object"
- },
- "InstanceGroupManagerStatus": {
- "properties": {
- "isStable": {
- "description": "[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.",
- "type": "boolean"
- },
- "autoscaler": {
- "description": "[Output Only] The URL of the Autoscaler that targets this instance group manager.",
- "type": "string"
- },
- "versionTarget": {
- "description": "[Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.",
- "$ref": "InstanceGroupManagerStatusVersionTarget"
- },
- "stateful": {
- "description": "[Output Only] Stateful status of the given Instance Group Manager.",
- "$ref": "InstanceGroupManagerStatusStateful"
- }
- },
- "id": "InstanceGroupManagerStatus",
- "type": "object"
- },
- "FirewallPoliciesListAssociationsResponse": {
- "properties": {
- "associations": {
- "items": {
- "$ref": "FirewallPolicyAssociation"
+ "get": {
+ "description": "Lists all of the ordered rules present in a single specified policy.",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "region": {
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "Name of the region scoping this request."
+ },
+ "sslPolicy": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.",
+ "type": "string"
+ }
},
- "description": "A list of associations.",
- "type": "array"
- },
- "kind": {
- "default": "compute#firewallPoliciesListAssociationsResponse",
- "type": "string",
- "description": "[Output Only] Type of firewallPolicy associations. Always compute#FirewallPoliciesListAssociations for lists of firewallPolicy associations."
- }
- },
- "type": "object",
- "id": "FirewallPoliciesListAssociationsResponse"
- },
- "UrlMapsScopedList": {
- "id": "UrlMapsScopedList",
- "type": "object",
- "properties": {
- "urlMaps": {
- "items": {
- "$ref": "UrlMap"
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "SslPolicy"
},
- "description": "A list of UrlMaps contained in this scope.",
- "type": "array"
+ "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
+ "id": "compute.regionSslPolicies.get",
+ "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "sslPolicy"
+ ]
},
- "warning": {
- "properties": {
- "code": {
+ "patch": {
+ "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
+ "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
+ "request": {
+ "$ref": "SslPolicy"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "sslPolicy"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.regionSslPolicies.patch",
+ "parameters": {
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Name of the region scoping this request.",
+ "location": "path"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
"type": "string"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "sslPolicy": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035."
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
}
},
- "type": "object",
- "description": "Informational warning which replaces the list of backend services when the list is empty."
- }
- }
- },
- "DiskMoveRequest": {
- "type": "object",
- "properties": {
- "targetDisk": {
- "description": "The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk ",
- "type": "string"
+ "description": "Patches the specified SSL policy with the data included in the request.",
+ "httpMethod": "PATCH"
},
- "destinationZone": {
- "description": "The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone ",
- "type": "string"
- }
- },
- "id": "DiskMoveRequest"
- },
- "NetworkPerformanceConfig": {
- "id": "NetworkPerformanceConfig",
- "type": "object",
- "properties": {
- "totalEgressBandwidthTier": {
- "enumDescriptions": [
- "",
- ""
+ "listAvailableFeatures": {
+ "parameters": {
+ "maxResults": {
+ "minimum": "0",
+ "type": "integer",
+ "default": "500",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "region": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request."
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "DEFAULT",
- "TIER_1"
+ "description": "Lists all features that can be specified in the SSL policy when using custom profile.",
+ "flatPath": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures",
+ "response": {
+ "$ref": "SslPoliciesListAvailableFeaturesResponse"
+ },
+ "id": "compute.regionSslPolicies.listAvailableFeatures",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "type": "string"
+ "path": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures"
}
}
},
- "Firewall": {
- "properties": {
- "priority": {
- "type": "integer",
- "format": "int32",
- "description": "Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`."
- },
- "direction": {
- "type": "string",
- "enumDescriptions": [
- "Indicates that firewall should apply to outgoing traffic.",
- "Indicates that firewall should apply to incoming traffic."
+ "nodeGroups": {
+ "methods": {
+ "addNodes": {
+ "parameters": {
+ "zone": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "nodeGroup": {
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the NodeGroup resource.",
+ "type": "string"
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Adds specified number of nodes to the node group.",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "NodeGroupsAddNodesRequest"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "nodeGroup"
],
- "enum": [
- "EGRESS",
- "INGRESS"
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot specify the sourceTags fields."
- },
- "kind": {
- "type": "string",
- "default": "compute#firewall",
- "description": "[Output Only] Type of the resource. Always compute#firewall for firewall rules."
+ "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes",
+ "id": "compute.nodeGroups.addNodes"
},
- "destinationRanges": {
- "description": "If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.",
- "items": {
- "type": "string"
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "response": {
+ "$ref": "TestPermissionsResponse"
},
- "type": "array"
- },
- "targetTags": {
- "description": "A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.",
- "items": {
- "type": "string"
+ "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions",
+ "request": {
+ "$ref": "TestPermissionsRequest"
},
- "type": "array"
- },
- "network": {
- "type": "string",
- "description": "URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, 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/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default "
- },
- "sourceTags": {
- "items": {
- "type": "string"
+ "id": "compute.nodeGroups.testIamPermissions",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions",
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "zone": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "resource": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request."
+ }
},
- "type": "array",
- "description": "If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ]
},
- "disabled": {
- "description": "Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.",
- "type": "boolean"
+ "get": {
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
+ "response": {
+ "$ref": "NodeGroup"
+ },
+ "parameters": {
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path"
+ },
+ "nodeGroup": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the node group to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "description": "Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the \"nodes\" field should not be used. Use nodeGroups.listNodes instead.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone",
+ "nodeGroup"
+ ],
+ "httpMethod": "GET",
+ "id": "compute.nodeGroups.get",
+ "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}"
},
- "sourceServiceAccounts": {
- "items": {
- "type": "string"
+ "getIamPolicy": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.nodeGroups.getIamPolicy",
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "optionsRequestedPolicyVersion": {
+ "format": "int32",
+ "type": "integer",
+ "description": "Requested IAM Policy version.",
+ "location": "query"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
+ }
},
- "description": "If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.",
- "type": "array"
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy"
},
- "sourceRanges": {
- "type": "array",
- "description": "If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.",
- "items": {
- "type": "string"
+ "deleteNodes": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "description": "Deletes specified nodes from the node group.",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "nodeGroup"
+ ],
+ "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes",
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes",
+ "id": "compute.nodeGroups.deleteNodes",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request."
+ },
+ "nodeGroup": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the NodeGroup resource whose nodes will be deleted."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "NodeGroupsDeleteNodesRequest"
}
},
- "logConfig": {
- "$ref": "FirewallLogConfig",
- "description": "This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging."
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this field when you create the resource."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "allowed": {
- "description": "The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.",
- "type": "array",
- "items": {
- "properties": {
- "ports": {
- "description": "An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "IPProtocol": {
- "type": "string",
- "description": "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."
- }
+ "insert": {
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "NodeGroup"
+ },
+ "path": "projects/{project}/zones/{zone}/nodeGroups",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request."
},
- "type": "object"
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "initialNodeCount": {
+ "description": "Initial count of nodes in the node group.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer",
+ "required": true
+ }
+ },
+ "id": "compute.nodeGroups.insert",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "initialNodeCount"
+ ],
+ "description": "Creates a NodeGroup resource in the specified project using the data included in the request.",
+ "response": {
+ "$ref": "Operation"
}
},
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "targetServiceAccounts": {
- "items": {
- "type": "string"
+ "listNodes": {
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "NodeGroupsListNodes"
+ },
+ "description": "Lists nodes in the node group.",
+ "parameters": {
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "maxResults": {
+ "default": "500",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "nodeGroup": {
+ "required": true,
+ "description": "Name of the NodeGroup resource whose nodes you want to list.",
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
},
- "description": "A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.",
- "type": "array"
- },
- "id": {
- "type": "string",
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ "parameterOrder": [
+ "project",
+ "zone",
+ "nodeGroup"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes",
+ "id": "compute.nodeGroups.listNodes"
},
- "name": {
- "annotations": {
- "required": [
- "compute.firewalls.insert",
- "compute.firewalls.patch"
- ]
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Policy"
},
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.",
- "type": "string"
- },
- "denied": {
- "items": {
- "type": "object",
- "properties": {
- "ports": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"]."
- },
- "IPProtocol": {
- "type": "string",
- "description": "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."
- }
+ "parameters": {
+ "zone": {
+ "type": "string",
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "resource": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
}
},
- "description": "The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.",
- "type": "array"
- }
- },
- "type": "object",
- "description": "Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.",
- "id": "Firewall"
- },
- "Metadata": {
- "description": "A metadata key/value entry.",
- "type": "object",
- "properties": {
- "items": {
- "items": {
- "type": "object",
- "description": "Metadata",
- "properties": {
- "value": {
- "description": "Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).",
- "type": "string",
- "annotations": {
- "required": [
- "compute.instances.insert",
- "compute.projects.setCommonInstanceMetadata"
- ]
- }
- },
- "key": {
- "pattern": "[a-zA-Z0-9-_]{1,128}",
- "description": "Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.",
- "type": "string",
- "annotations": {
- "required": [
- "compute.instances.insert",
- "compute.projects.setCommonInstanceMetadata"
- ]
- }
- }
- }
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy",
+ "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "request": {
+ "$ref": "ZoneSetPolicyRequest"
},
- "type": "array",
- "description": "Array of key/value pairs. The total size of all keys and values must be less than 512 KB."
- },
- "fingerprint": {
- "description": "Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.",
- "format": "byte",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#metadata for metadata.",
- "default": "compute#metadata"
- }
- },
- "id": "Metadata"
- },
- "VpnGatewayStatusTunnel": {
- "type": "object",
- "description": "Contains some information about a VPN tunnel.",
- "properties": {
- "localGatewayInterface": {
- "type": "integer",
- "format": "uint32",
- "description": "The VPN gateway interface this VPN tunnel is associated with."
- },
- "tunnelUrl": {
- "type": "string",
- "description": "URL reference to the VPN tunnel."
- },
- "peerGatewayInterface": {
- "format": "uint32",
- "description": "The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway.",
- "type": "integer"
- }
- },
- "id": "VpnGatewayStatusTunnel"
- },
- "FirewallList": {
- "properties": {
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.nodeGroups.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy."
},
- "items": {
- "type": "array",
- "items": {
- "$ref": "Firewall"
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "NodeGroupList"
},
- "description": "A list of Firewall resources."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "id": "compute.nodeGroups.list",
+ "httpMethod": "GET",
+ "path": "projects/{project}/zones/{zone}/nodeGroups",
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "description": "Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.",
+ "parameters": {
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "location": "query",
+ "format": "uint32"
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ }
+ },
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups"
},
- "kind": {
- "default": "compute#firewallList",
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#firewallList for lists of firewalls."
+ "patch": {
+ "httpMethod": "PATCH",
+ "request": {
+ "$ref": "NodeGroup"
+ },
+ "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "nodeGroup"
+ ],
+ "id": "compute.nodeGroups.patch",
+ "description": "Updates the specified node group.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "nodeGroup": {
+ "location": "path",
+ "description": "Name of the NodeGroup resource to update.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ }
+ }
},
- "warning": {
- "properties": {
- "message": {
+ "delete": {
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "The name of the zone for this request.",
+ "location": "path"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
},
- "code": {
+ "nodeGroup": {
+ "description": "Name of the NodeGroup resource to delete.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "required": true
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.nodeGroups.delete",
+ "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
+ "description": "Deletes the specified NodeGroup resource.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "nodeGroup"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- }
- },
- "type": "object",
- "description": "Contains a list of firewalls.",
- "id": "FirewallList"
- },
- "ForwardingRulesScopedList": {
- "id": "ForwardingRulesScopedList",
- "properties": {
- "warning": {
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
+ "aggregatedList": {
+ "parameterOrder": [
+ "project"
+ ],
+ "flatPath": "projects/{project}/aggregated/nodeGroups",
+ "httpMethod": "GET",
+ "parameters": {
+ "orderBy": {
+ "location": "query",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "maxResults": {
+ "minimum": "0",
+ "location": "query",
+ "format": "uint32",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer"
+ },
+ "includeAllScopes": {
+ "type": "boolean",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
"type": "string"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
}
},
- "type": "object",
- "description": "Informational warning which replaces the list of forwarding rules when the list is empty."
+ "description": "Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "NodeGroupAggregatedList"
+ },
+ "id": "compute.nodeGroups.aggregatedList",
+ "path": "projects/{project}/aggregated/nodeGroups"
},
- "forwardingRules": {
- "items": {
- "$ref": "ForwardingRule"
+ "setNodeTemplate": {
+ "request": {
+ "$ref": "NodeGroupsSetNodeTemplateRequest"
},
- "description": "A list of forwarding rules contained in this scope.",
- "type": "array"
- }
- },
- "type": "object"
- },
- "DiskParams": {
- "type": "object",
- "id": "DiskParams",
- "description": "Additional disk params.",
- "properties": {
- "resourceManagerTags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
+ "response": {
+ "$ref": "Operation"
},
- "description": "Resource manager tags to be bound to the disk. 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."
- }
- }
- },
- "BackendServiceLocalityLoadBalancingPolicyConfigPolicy": {
- "description": "The configuration for a built-in load balancing policy.",
- "id": "BackendServiceLocalityLoadBalancingPolicyConfigPolicy",
- "type": "object",
- "properties": {
- "name": {
- "enum": [
- "INVALID_LB_POLICY",
- "LEAST_REQUEST",
- "MAGLEV",
- "ORIGINAL_DESTINATION",
- "RANDOM",
- "RING_HASH",
- "ROUND_ROBIN"
- ],
- "description": "The name of a locality load balancer policy to be used. The value should be one of the predefined ones as supported by localityLbPolicy, although at the moment only ROUND_ROBIN is supported. This field should only be populated when the customPolicy field is not used. Note that specifying the same policy more than once for a backend is not a valid configuration and will be rejected.",
- "enumDescriptions": [
- "",
- "An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.",
- "This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824",
- "Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.",
- "The load balancer selects a random healthy host.",
- "The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.",
- "This is a simple policy in which each healthy backend is selected in round robin order. This is the default."
+ "description": "Updates the node template of the node group.",
+ "httpMethod": "POST",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "nodeGroup": {
+ "description": "Name of the NodeGroup resource to update.",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "nodeGroup"
],
- "type": "string"
+ "id": "compute.nodeGroups.setNodeTemplate",
+ "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate",
+ "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
}
}
},
- "BackendServiceCdnPolicyNegativeCachingPolicy": {
- "properties": {
- "ttl": {
- "type": "integer",
- "description": "The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
- "format": "int32"
- },
- "code": {
- "description": "The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.",
- "type": "integer",
- "format": "int32"
- }
- },
- "description": "Specify CDN TTLs for response error codes.",
- "type": "object",
- "id": "BackendServiceCdnPolicyNegativeCachingPolicy"
- },
- "InstanceGroupManagersSetTargetPoolsRequest": {
- "properties": {
- "targetPools": {
- "items": {
- "type": "string"
- },
- "description": "The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.",
- "type": "array"
- },
- "fingerprint": {
- "format": "byte",
- "description": "The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.",
- "type": "string"
- }
- },
- "id": "InstanceGroupManagersSetTargetPoolsRequest",
- "type": "object"
- },
- "BackendServiceAggregatedList": {
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#backendServiceAggregatedList"
- },
- "warning": {
- "properties": {
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "externalVpnGateways": {
+ "methods": {
+ "list": {
+ "description": "Retrieves the list of ExternalVpnGateway available to the specified project.",
+ "httpMethod": "GET",
+ "parameters": {
+ "maxResults": {
+ "type": "integer",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "minimum": "0",
+ "format": "uint32"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "type": "string"
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true
},
- "message": {
+ "orderBy": {
+ "location": "query",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Name of the scope containing this set of BackendServices.",
- "$ref": "BackendServicesScopedList"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.externalVpnGateways.list",
+ "response": {
+ "$ref": "ExternalVpnGatewayList"
},
- "description": "A list of BackendServicesScopedList resources."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "parameterOrder": [
+ "project"
+ ],
+ "flatPath": "projects/{project}/global/externalVpnGateways",
+ "path": "projects/{project}/global/externalVpnGateways"
},
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "DELETE",
+ "id": "compute.externalVpnGateways.delete",
+ "path": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}",
+ "description": "Deletes the specified externalVpnGateway.",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "externalVpnGateway": {
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "Name of the externalVpnGateways to delete."
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
},
- "type": "array"
- }
- },
- "id": "BackendServiceAggregatedList",
- "description": "Contains a list of BackendServicesScopedList."
- },
- "InstanceGroupManagersListManagedInstancesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "managedInstances": {
- "items": {
- "$ref": "ManagedInstance"
+ "parameterOrder": [
+ "project",
+ "externalVpnGateway"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "[Output Only] The list of instances in the managed instance group."
- }
- },
- "type": "object",
- "id": "InstanceGroupManagersListManagedInstancesResponse"
- },
- "PacketMirroringMirroredResourceInfoInstanceInfo": {
- "type": "object",
- "properties": {
- "canonicalUrl": {
- "description": "[Output Only] Unique identifier for the instance; defined by the server.",
- "type": "string"
+ "flatPath": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}"
},
- "url": {
- "type": "string",
- "description": "Resource URL to the virtual machine instance which is being mirrored."
- }
- },
- "id": "PacketMirroringMirroredResourceInfoInstanceInfo"
- },
- "NetworkEndpointGroup": {
- "id": "NetworkEndpointGroup",
- "properties": {
- "annotations": {
- "additionalProperties": {
- "type": "string"
+ "setLabels": {
+ "path": "projects/{project}/global/externalVpnGateways/{resource}/setLabels",
+ "request": {
+ "$ref": "GlobalSetLabelsRequest"
},
- "description": "Metadata defined as annotations on the network endpoint group.",
- "type": "object"
- },
- "network": {
- "description": "The URL of the network to which all network endpoints in the NEG belong. Uses \"default\" project network if unspecified.",
- "type": "string"
- },
- "size": {
- "description": "[Output only] Number of network endpoints in the network endpoint group.",
- "format": "int32",
- "type": "integer"
- },
- "kind": {
- "default": "compute#networkEndpointGroup",
- "description": "[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.",
- "type": "string"
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "pscTargetService": {
- "type": "string",
- "description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: \"asia-northeast3-cloudkms.googleapis.com\""
- },
- "networkEndpointType": {
- "type": "string",
- "description": "Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT.",
- "enum": [
- "GCE_VM_IP",
- "GCE_VM_IP_PORT",
- "INTERNET_FQDN_PORT",
- "INTERNET_IP_PORT",
- "NON_GCP_PRIVATE_IP_PORT",
- "PRIVATE_SERVICE_CONNECT",
- "SERVERLESS"
- ],
- "enumDescriptions": [
- "The network endpoint is represented by an IP address.",
- "The network endpoint is represented by IP address and port pair.",
- "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."
- ]
- },
- "subnetwork": {
- "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "appEngine": {
- "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set.",
- "$ref": "NetworkEndpointGroupAppEngine"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "cloudFunction": {
- "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set.",
- "$ref": "NetworkEndpointGroupCloudFunction"
- },
- "defaultPort": {
- "description": "The default port used if the port number is not specified in the network endpoint.",
- "type": "integer",
- "format": "int32"
- },
- "region": {
- "description": "[Output Only] The URL of the region where the network endpoint group is located.",
- "type": "string"
- },
- "cloudRun": {
- "description": "Only valid when networkEndpointType is \"SERVERLESS\". Only one of cloudRun, appEngine or cloudFunction may be set.",
- "$ref": "NetworkEndpointGroupCloudRun"
- },
- "pscData": {
- "$ref": "NetworkEndpointGroupPscData"
- },
- "name": {
- "description": "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.",
- "type": "string"
- },
- "zone": {
- "description": "[Output Only] The URL of the zone where the network endpoint group is located.",
- "type": "string"
- }
- },
- "description": "Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless NEGs.",
- "type": "object"
- },
- "InterconnectDiagnostics": {
- "type": "object",
- "description": "Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection.",
- "properties": {
- "macAddress": {
- "description": "The MAC address of the Interconnect's bundle interface.",
- "type": "string"
- },
- "bundleAggregationType": {
- "enumDescriptions": [
- "LACP is enabled.",
- "LACP is disabled."
+ "flatPath": "projects/{project}/global/externalVpnGateways/{resource}/setLabels",
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name or id of the resource for this request."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request."
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "The aggregation type of the bundle interface.",
- "enum": [
- "BUNDLE_AGGREGATION_TYPE_LACP",
- "BUNDLE_AGGREGATION_TYPE_STATIC"
+ "id": "compute.externalVpnGateways.setLabels",
+ "parameterOrder": [
+ "project",
+ "resource"
],
- "type": "string"
+ "description": "Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation."
},
- "links": {
- "description": "A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.",
- "items": {
- "$ref": "InterconnectDiagnosticsLinkStatus"
+ "insert": {
+ "flatPath": "projects/{project}/global/externalVpnGateways",
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
+ "description": "Creates a ExternalVpnGateway in the specified project using the data included in the request.",
+ "path": "projects/{project}/global/externalVpnGateways",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "request": {
+ "$ref": "ExternalVpnGateway"
+ },
+ "id": "compute.externalVpnGateways.insert"
},
- "bundleOperationalStatus": {
- "type": "string",
- "enumDescriptions": [
- "If bundleAggregationType is LACP: LACP is not established and/or all links in the bundle have DOWN operational status. If bundleAggregationType is STATIC: one or more links in the bundle has DOWN operational status.",
- "If bundleAggregationType is LACP: LACP is established and at least one link in the bundle has UP operational status. If bundleAggregationType is STATIC: all links in the bundle (typically just one) have UP operational status."
+ "get": {
+ "parameterOrder": [
+ "project",
+ "externalVpnGateway"
],
- "enum": [
- "BUNDLE_OPERATIONAL_STATUS_DOWN",
- "BUNDLE_OPERATIONAL_STATUS_UP"
+ "id": "compute.externalVpnGateways.get",
+ "flatPath": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}",
+ "response": {
+ "$ref": "ExternalVpnGateway"
+ },
+ "description": "Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "externalVpnGateway": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "Name of the externalVpnGateway to return.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "The operational status of the bundle interface."
- },
- "arpCaches": {
- "description": "A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled.",
- "type": "array",
- "items": {
- "$ref": "InterconnectDiagnosticsARPEntry"
- }
- }
- },
- "id": "InterconnectDiagnostics"
- },
- "InstanceConsumptionInfo": {
- "properties": {
- "localSsdGb": {
- "description": "The amount of local SSD storage available to the instance, defined in GiB.",
- "format": "int32",
- "type": "integer"
- },
- "minNodeCpus": {
- "format": "int32",
- "type": "integer",
- "description": "The minimal guaranteed number of virtual CPUs that are reserved."
- },
- "guestCpus": {
- "description": "The number of virtual CPUs that are available to the instance.",
- "type": "integer",
- "format": "int32"
- },
- "memoryMb": {
- "type": "integer",
- "description": "The amount of physical memory available to the instance, defined in MiB.",
- "format": "int32"
- }
- },
- "id": "InstanceConsumptionInfo",
- "type": "object"
- },
- "BackendServiceLogConfig": {
- "properties": {
- "sampleRate": {
- "format": "float",
- "description": "This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.",
- "type": "number"
+ "path": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}",
+ "httpMethod": "GET"
},
- "enable": {
- "type": "boolean",
- "description": "Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false."
- }
- },
- "type": "object",
- "id": "BackendServiceLogConfig",
- "description": "The available logging options for the load balancer traffic served by this backend service."
- },
- "TargetPoolsRemoveInstanceRequest": {
- "type": "object",
- "id": "TargetPoolsRemoveInstanceRequest",
- "properties": {
- "instances": {
- "items": {
- "$ref": "InstanceReference"
+ "testIamPermissions": {
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "id": "compute.externalVpnGateways.testIamPermissions",
+ "flatPath": "projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "path": "projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "request": {
+ "$ref": "TestPermissionsRequest"
},
- "type": "array",
- "description": "URLs of the instances to be removed from target pool."
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "parameters": {
+ "project": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "resource": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
- "InterconnectsGetDiagnosticsResponse": {
- "properties": {
- "result": {
- "$ref": "InterconnectDiagnostics"
- }
- },
- "id": "InterconnectsGetDiagnosticsResponse",
- "type": "object",
- "description": "Response for the InterconnectsGetDiagnosticsRequest."
- },
- "SavedAttachedDisk": {
- "description": "DEPRECATED: Please use compute#savedDisk instead. An instance-attached disk resource.",
- "type": "object",
- "id": "SavedAttachedDisk",
- "properties": {
- "mode": {
- "description": "The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY.",
- "enumDescriptions": [
- "Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.",
- "*[Default]* Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode."
+ "targetHttpProxies": {
+ "methods": {
+ "patch": {
+ "request": {
+ "$ref": "TargetHttpProxy"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
+ "id": "compute.targetHttpProxies.patch",
+ "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
+ "parameterOrder": [
+ "project",
+ "targetHttpProxy"
],
- "enum": [
- "READ_ONLY",
- "READ_WRITE"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
+ "httpMethod": "PATCH",
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "targetHttpProxy": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Name of the TargetHttpProxy resource to patch.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}"
},
- "diskSizeGb": {
- "type": "string",
- "description": "The size of the disk in base-2 GB.",
- "format": "int64"
+ "get": {
+ "id": "compute.targetHttpProxies.get",
+ "parameterOrder": [
+ "project",
+ "targetHttpProxy"
+ ],
+ "parameters": {
+ "targetHttpProxy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the TargetHttpProxy resource to return."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request."
+ }
+ },
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "TargetHttpProxy"
+ },
+ "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
+ "description": "Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request."
},
- "guestOsFeatures": {
- "type": "array",
- "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.",
- "items": {
- "$ref": "GuestOsFeature"
+ "list": {
+ "description": "Retrieves the list of TargetHttpProxy resources available to the specified project.",
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "TargetHttpProxyList"
+ },
+ "flatPath": "projects/{project}/global/targetHttpProxies",
+ "path": "projects/{project}/global/targetHttpProxies",
+ "id": "compute.targetHttpProxies.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "maxResults": {
+ "default": "500",
+ "minimum": "0",
+ "type": "integer",
+ "format": "uint32",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
}
},
- "licenses": {
- "items": {
- "type": "string"
+ "insert": {
+ "request": {
+ "$ref": "TargetHttpProxy"
},
- "type": "array",
- "description": "[Output Only] Any valid publicly visible licenses."
- },
- "diskEncryptionKey": {
- "description": "The encryption key for the disk.",
- "$ref": "CustomerEncryptionKey"
- },
- "boot": {
- "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.",
- "type": "boolean"
- },
- "storageBytes": {
- "format": "int64",
- "description": "[Output Only] A size of the storage used by the disk's snapshot by this machine image.",
- "type": "string"
- },
- "diskType": {
- "description": "[Output Only] URL of the disk type resource. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd",
- "type": "string"
- },
- "interface": {
- "enumDescriptions": [
- "",
- ""
+ "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.",
+ "httpMethod": "POST",
+ "id": "compute.targetHttpProxies.insert",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/targetHttpProxies",
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/targetHttpProxies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.",
- "type": "string",
- "enum": [
- "NVME",
- "SCSI"
+ "parameterOrder": [
+ "project"
]
},
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
- "default": "compute#savedAttachedDisk"
- },
- "autoDelete": {
- "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).",
- "type": "boolean"
+ "setUrlMap": {
+ "id": "compute.targetHttpProxies.setUrlMap",
+ "flatPath": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "targetHttpProxy": {
+ "description": "Name of the TargetHttpProxy to set a URL map for.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
+ "request": {
+ "$ref": "UrlMapReference"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "description": "Changes the URL map for TargetHttpProxy.",
+ "parameterOrder": [
+ "project",
+ "targetHttpProxy"
+ ]
},
- "type": {
- "type": "string",
- "description": "Specifies the type of the attached disk, either SCRATCH or PERSISTENT.",
- "enumDescriptions": [
- "",
- ""
+ "aggregatedList": {
+ "flatPath": "projects/{project}/aggregated/targetHttpProxies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "maxResults": {
+ "type": "integer",
+ "format": "uint32",
+ "default": "500",
+ "location": "query",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Name of the project scoping this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ }
+ },
+ "parameterOrder": [
+ "project"
],
- "enum": [
- "PERSISTENT",
- "SCRATCH"
- ]
- },
- "source": {
- "description": "Specifies a URL of the disk attached to the source instance.",
- "type": "string"
- },
- "deviceName": {
- "type": "string",
- "description": "Specifies the name of the disk attached to the source instance."
+ "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.",
+ "path": "projects/{project}/aggregated/targetHttpProxies",
+ "response": {
+ "$ref": "TargetHttpProxyAggregatedList"
+ },
+ "httpMethod": "GET",
+ "id": "compute.targetHttpProxies.aggregatedList"
},
- "storageBytesStatus": {
- "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.",
- "enumDescriptions": [
- "",
- ""
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
+ "id": "compute.targetHttpProxies.delete",
+ "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
+ "parameterOrder": [
+ "project",
+ "targetHttpProxy"
],
- "type": "string",
- "enum": [
- "UPDATING",
- "UP_TO_DATE"
- ]
- },
- "index": {
- "format": "int32",
- "description": "Specifies zero-based index of the disk that is attached to the source instance.",
- "type": "integer"
- }
- }
- },
- "NotificationEndpointList": {
- "id": "NotificationEndpointList",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "type": "string",
- "default": "compute#notificationEndpointList",
- "description": "[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints."
- },
- "warning": {
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "targetHttpProxy": {
+ "description": "Name of the TargetHttpProxy resource to delete.",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
},
- "data": {
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "requestId": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "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"
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- },
- "items": {
- "items": {
- "$ref": "NotificationEndpoint"
- },
- "type": "array",
- "description": "A list of NotificationEndpoint resources."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "description": "Deletes the specified TargetHttpProxy resource."
}
- },
- "type": "object"
+ }
},
- "HttpRouteRuleMatch": {
- "id": "HttpRouteRuleMatch",
- "properties": {
- "metadataFilters": {
- "items": {
- "$ref": "MetadataFilter"
- },
- "description": "Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.",
- "type": "array"
- },
- "ignoreCase": {
- "description": "Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to a target gRPC proxy.",
- "type": "boolean"
- },
- "headerMatches": {
- "items": {
- "$ref": "HttpHeaderMatch"
+ "regionNotificationEndpoints": {
+ "methods": {
+ "list": {
+ "path": "projects/{project}/regions/{region}/notificationEndpoints",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/notificationEndpoints",
+ "response": {
+ "$ref": "NotificationEndpointList"
},
- "type": "array",
- "description": "Specifies a list of header match criteria, all of which must match corresponding headers in the request."
- },
- "prefixMatch": {
- "type": "string",
- "description": "For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified."
- },
- "queryParameterMatches": {
- "description": "Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.",
- "items": {
- "$ref": "HttpQueryParameterMatch"
+ "parameters": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "minimum": "0",
+ "location": "query",
+ "default": "500",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ }
},
- "type": "array"
- },
- "fullPathMatch": {
- "type": "string",
- "description": "For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified."
- },
- "regexMatch": {
- "type": "string",
- "description": "For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For more information about regular expression syntax, see Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED."
- }
- },
- "description": "HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.",
- "type": "object"
- },
- "ExchangedPeeringRoute": {
- "properties": {
- "nextHopRegion": {
- "description": "The region of peering route next hop, only applies to dynamic routes.",
- "type": "string"
- },
- "destRange": {
- "type": "string",
- "description": "The destination range of the route."
- },
- "type": {
- "description": "The type of the peering route.",
- "type": "string",
- "enumDescriptions": [
- "For routes exported from local network.",
- "The peering route.",
- "The peering route corresponding to subnetwork range."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "DYNAMIC_PEERING_ROUTE",
- "STATIC_PEERING_ROUTE",
- "SUBNET_PEERING_ROUTE"
- ]
- },
- "priority": {
- "format": "uint32",
- "type": "integer",
- "description": "The priority of the peering route."
- },
- "imported": {
- "description": "True if the peering route has been imported from a peer. The actual import happens if the field networkPeering.importCustomRoutes is true for this network, and networkPeering.exportCustomRoutes is true for the peer network, and the import does not result in a route conflict.",
- "type": "boolean"
- }
- },
- "id": "ExchangedPeeringRoute",
- "type": "object"
- },
- "TargetSslProxyList": {
- "description": "Contains a list of TargetSslProxy resources.",
- "properties": {
- "kind": {
- "default": "compute#targetSslProxyList",
- "description": "Type of resource.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "description": "Lists the NotificationEndpoints for a project in the given region.",
+ "id": "compute.regionNotificationEndpoints.list"
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- }
+ "insert": {
+ "id": "compute.regionNotificationEndpoints.insert",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/notificationEndpoints",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "message": {
+ "requestId": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "query",
+ "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)."
},
- "code": {
+ "region": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
}
},
- "type": "object"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "items": {
- "type": "array",
- "description": "A list of TargetSslProxy resources.",
- "items": {
- "$ref": "TargetSslProxy"
+ "request": {
+ "$ref": "NotificationEndpoint"
+ },
+ "path": "projects/{project}/regions/{region}/notificationEndpoints",
+ "description": "Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
}
- }
- },
- "type": "object",
- "id": "TargetSslProxyList"
- },
- "UrlMapsValidateResponse": {
- "type": "object",
- "id": "UrlMapsValidateResponse",
- "properties": {
- "result": {
- "$ref": "UrlMapValidationResult"
- }
- }
- },
- "InstanceWithNamedPorts": {
- "properties": {
- "instance": {
- "description": "[Output Only] The URL of the instance.",
- "type": "string"
},
- "status": {
- "description": "[Output Only] The status of the instance.",
- "enum": [
- "DEPROVISIONING",
- "PROVISIONING",
- "REPAIRING",
- "RUNNING",
- "STAGING",
- "STOPPED",
- "STOPPING",
- "SUSPENDED",
- "SUSPENDING",
- "TERMINATED"
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.regionNotificationEndpoints.delete",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "notificationEndpoint": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the NotificationEndpoint resource to delete.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path",
+ "description": "Name of the region scoping this request."
+ }
+ },
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "project",
+ "region",
+ "notificationEndpoint"
],
- "enumDescriptions": [
- "The Nanny is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.",
- "Resources are being allocated for the instance.",
- "The instance is in repair.",
- "The instance is running.",
- "All required resources have been allocated and the instance is being started.",
- "The instance has stopped successfully.",
- "The instance is currently stopping (either being deleted or killed).",
- "The instance has suspended.",
- "The instance is suspending.",
- "The instance has stopped (either by explicit action or underlying failure)."
+ "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
+ "description": "Deletes the specified NotificationEndpoint in the given region",
+ "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}"
},
- "namedPorts": {
- "type": "array",
- "description": "[Output Only] The named ports that belong to this instance group.",
- "items": {
- "$ref": "NamedPort"
- }
- }
- },
- "id": "InstanceWithNamedPorts",
- "type": "object"
- },
- "RouterInterface": {
- "id": "RouterInterface",
- "type": "object",
- "properties": {
- "managementType": {
- "enum": [
- "MANAGED_BY_ATTACHMENT",
- "MANAGED_BY_USER"
+ "get": {
+ "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "[Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. ",
- "type": "string",
- "enumDescriptions": [
- "The interface is automatically created for PARTNER type InterconnectAttachment, Google will automatically create/update/delete this interface when the PARTNER InterconnectAttachment is created/provisioned/deleted. This type of interface cannot be manually managed by user.",
- "Default value, the interface is manually created and managed by user."
- ]
- },
- "redundantInterface": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface 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."
- },
- "ipRange": {
- "type": "string",
- "description": "IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface."
- },
- "subnetwork": {
- "description": "The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.",
- "type": "string"
- },
- "privateIpAddress": {
- "description": "The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.",
- "type": "string"
- },
- "linkedVpnTunnel": {
- "type": "string",
- "description": "URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance."
- },
- "linkedInterconnectAttachment": {
- "type": "string",
- "description": "URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance."
- },
- "name": {
- "type": "string",
- "annotations": {
- "required": [
- "compute.routers.insert"
- ]
+ "parameters": {
+ "notificationEndpoint": {
+ "required": true,
+ "description": "Name of the NotificationEndpoint resource to return.",
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region scoping this request."
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
},
- "description": "Name of this interface entry. 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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ "httpMethod": "GET",
+ "description": "Returns the specified NotificationEndpoint resource in the given region.",
+ "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}",
+ "response": {
+ "$ref": "NotificationEndpoint"
+ },
+ "id": "compute.regionNotificationEndpoints.get",
+ "parameterOrder": [
+ "project",
+ "region",
+ "notificationEndpoint"
+ ]
}
}
},
- "ReservationAffinity": {
- "description": "Specifies the reservations that this instance can consume from.",
- "properties": {
- "key": {
- "type": "string",
- "description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value."
- },
- "consumeReservationType": {
- "description": "Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.",
- "enumDescriptions": [
- "Consume any allocation available.",
- "Do not consume from any allocated capacity.",
- "Must consume from a specific reservation. Must specify key value fields for specifying the reservations.",
- ""
+ "regionInstanceGroupManagers": {
+ "methods": {
+ "list": {
+ "description": "Retrieves the list of managed instance groups that are contained within the specified region.",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "type": "string",
- "enum": [
- "ANY_RESERVATION",
- "NO_RESERVATION",
- "SPECIFIC_RESERVATION",
- "UNSPECIFIED"
- ]
+ "parameters": {
+ "maxResults": {
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "minimum": "0",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request."
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ }
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers",
+ "response": {
+ "$ref": "RegionInstanceGroupManagerList"
+ },
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers",
+ "id": "compute.regionInstanceGroupManagers.list"
},
- "values": {
- "type": "array",
- "items": {
- "type": "string"
+ "patch": {
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
+ "request": {
+ "$ref": "InstanceGroupManager"
},
- "description": "Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or \"projects/different-project/reservations/some-reservation-name\" to target a shared reservation in the same zone but in a different project."
- }
- },
- "type": "object",
- "id": "ReservationAffinity"
- },
- "LocationPolicy": {
- "id": "LocationPolicy",
- "description": "Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).",
- "type": "object",
- "properties": {
- "targetShape": {
- "description": "Strategy for distributing VMs across zones in a region.",
- "enum": [
- "ANY",
- "ANY_SINGLE_ZONE",
- "BALANCED"
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.",
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "GCE picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.",
- "GCE always selects a single zone for all the VMs, optimizing for resource quotas, available reservations and general capacity. Recommended for batch workloads that cannot tollerate distribution over multiple zones. This the default shape in Bulk Insert and Capacity Advisor APIs.",
- "GCE prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across allowed zones to minimize the impact of zonal failure. Recommended for highly available serving workloads."
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
+ "id": "compute.regionInstanceGroupManagers.patch",
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
],
- "type": "string"
- },
- "locations": {
- "type": "object",
- "description": "Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a.",
- "additionalProperties": {
- "$ref": "LocationPolicyLocation"
+ "parameters": {
+ "instanceGroupManager": {
+ "required": true,
+ "description": "The name of the instance group manager.",
+ "type": "string",
+ "location": "path"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
}
- }
- }
- },
- "RoutersPreviewResponse": {
- "properties": {
- "resource": {
- "description": "Preview of given router.",
- "$ref": "Router"
- }
- },
- "id": "RoutersPreviewResponse",
- "type": "object"
- },
- "RegionInstanceGroupsListInstancesRequest": {
- "properties": {
- "portName": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances."
},
- "instanceState": {
- "enumDescriptions": [
- "Matches any status of the instances, running, non-running and others.",
- "Instance is in RUNNING state if it is running."
+ "insert": {
+ "request": {
+ "$ref": "InstanceGroupManager"
+ },
+ "httpMethod": "POST",
+ "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "description": "Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.",
- "enum": [
- "ALL",
- "RUNNING"
- ]
- }
- },
- "id": "RegionInstanceGroupsListInstancesRequest",
- "type": "object"
- },
- "SecurityPolicyRuleHttpHeaderAction": {
- "properties": {
- "requestHeadersToAdds": {
- "items": {
- "$ref": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption"
+ "response": {
+ "$ref": "Operation"
},
- "description": "The list of request headers to add or overwrite if they're already present.",
- "type": "array"
- }
- },
- "id": "SecurityPolicyRuleHttpHeaderAction",
- "type": "object"
- },
- "RegionInstanceGroupManagerDeleteInstanceConfigReq": {
- "properties": {
- "names": {
- "description": "The list of instance names for which we want to delete per-instance configs on this managed instance group.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "type": "object",
- "id": "RegionInstanceGroupManagerDeleteInstanceConfigReq",
- "description": "RegionInstanceGroupManagers.deletePerInstanceConfigs"
- },
- "InstanceGroupManagerUpdatePolicy": {
- "type": "object",
- "id": "InstanceGroupManagerUpdatePolicy",
- "properties": {
- "instanceRedistributionType": {
- "type": "string",
- "enumDescriptions": [
- "No action is being proactively performed in order to bring this IGM to its target instance distribution.",
- "This IGM will actively converge to its target instance distribution."
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region"
],
- "description": "The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. ",
- "enum": [
- "NONE",
- "PROACTIVE"
- ]
- },
- "maxSurge": {
- "$ref": "FixedOrPercent",
- "description": "The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge."
- },
- "maxUnavailable": {
- "description": "The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.",
- "$ref": "FixedOrPercent"
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers",
+ "id": "compute.regionInstanceGroupManagers.insert"
},
- "mostDisruptiveAllowedAction": {
- "enumDescriptions": [
- "Do not perform any action.",
- "Updates applied in runtime, instances will not be disrupted.",
- "Old instances will be deleted. New instances will be created from the target template.",
- "Every instance will be restarted."
+ "updatePerInstanceConfigs": {
+ "parameters": {
+ "instanceGroupManager": {
+ "type": "string",
+ "description": "The name of the managed instance group. It should conform to RFC1035.",
+ "location": "path",
+ "required": true
+ },
+ "region": {
+ "description": "Name of the region scoping this request, should conform to RFC1035.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
],
- "type": "string",
- "enum": [
- "NONE",
- "REFRESH",
- "REPLACE",
- "RESTART"
+ "description": "Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.",
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "RegionInstanceGroupManagerUpdateInstanceConfigReq"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all."
+ "id": "compute.regionInstanceGroupManagers.updatePerInstanceConfigs"
},
- "minimalAction": {
- "description": "Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary. - To limit disruption as much as possible, set the minimal action to REFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to RESTART or REPLACE. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to RESTART in order to pick up metadata changes. ",
- "type": "string",
- "enumDescriptions": [
- "Do not perform any action.",
- "Updates applied in runtime, instances will not be disrupted.",
- "Old instances will be deleted. New instances will be created from the target template.",
- "Every instance will be restarted."
+ "abandonInstances": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
],
- "enum": [
- "NONE",
- "REFRESH",
- "REPLACE",
- "RESTART"
- ]
+ "id": "compute.regionInstanceGroupManagers.abandonInstances",
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "RegionInstanceGroupManagersAbandonInstancesRequest"
+ },
+ "parameters": {
+ "region": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "instanceGroupManager": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the managed instance group."
+ }
+ }
},
- "replacementMethod": {
- "enum": [
- "RECREATE",
- "SUBSTITUTE"
+ "get": {
+ "response": {
+ "$ref": "InstanceGroupManager"
+ },
+ "description": "Returns all of the details about the specified managed instance group.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "What action should be used to replace instances. See minimal_action.REPLACE",
- "enumDescriptions": [
- "Instances will be recreated (with the same name)",
- "Default option: instances will be deleted and created (with a new name)"
+ "parameters": {
+ "instanceGroupManager": {
+ "required": true,
+ "description": "Name of the managed instance group to return.",
+ "type": "string",
+ "location": "path"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ }
+ },
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
+ "httpMethod": "GET",
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
],
- "type": "string"
+ "id": "compute.regionInstanceGroupManagers.get"
},
- "type": {
- "description": "The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).",
- "enumDescriptions": [
- "No action is being proactively performed in order to bring this IGM to its target version distribution (regardless of whether this distribution is expressed using instanceTemplate or versions field).",
- "This IGM will actively converge to its target version distribution (regardless of whether this distribution is expressed using instanceTemplate or versions field)."
- ],
- "type": "string",
- "enum": [
- "OPPORTUNISTIC",
- "PROACTIVE"
- ]
- }
- }
- },
- "SubnetworkLogConfig": {
- "description": "The available logging options for this subnetwork.",
- "type": "object",
- "properties": {
- "aggregationInterval": {
- "enum": [
- "INTERVAL_10_MIN",
- "INTERVAL_15_MIN",
- "INTERVAL_1_MIN",
- "INTERVAL_30_SEC",
- "INTERVAL_5_MIN",
- "INTERVAL_5_SEC"
+ "setTargetPools": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "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.",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "instanceGroupManager": {
+ "type": "string",
+ "required": true,
+ "description": "Name of the managed instance group.",
+ "location": "path"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "id": "compute.regionInstanceGroupManagers.setTargetPools",
+ "description": "Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.",
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
],
- "type": "string"
- },
- "enable": {
- "description": "Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled.",
- "type": "boolean"
- },
- "metadataFields": {
- "description": "Can only be specified if VPC flow logs for this subnetwork is enabled and \"metadata\" was set to CUSTOM_METADATA.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "flowSampling": {
- "format": "float",
- "type": "number",
- "description": "Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported."
- },
- "filterExpr": {
- "description": "Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging.",
- "type": "string"
+ "request": {
+ "$ref": "RegionInstanceGroupManagersSetTargetPoolsRequest"
+ },
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools"
},
- "metadata": {
- "enumDescriptions": [
- "",
- "",
- ""
+ "listErrors": {
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors",
+ "description": "Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.",
+ "id": "compute.regionInstanceGroupManagers.listErrors",
+ "response": {
+ "$ref": "RegionInstanceGroupManagersListErrorsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "description": "Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA.",
- "enum": [
- "CUSTOM_METADATA",
- "EXCLUDE_ALL_METADATA",
- "INCLUDE_ALL_METADATA"
- ]
- }
- },
- "id": "SubnetworkLogConfig"
- },
- "AcceleratorTypeList": {
- "description": "Contains a list of accelerator types.",
- "type": "object",
- "id": "AcceleratorTypeList",
- "properties": {
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types.",
- "default": "compute#acceleratorTypeList"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "AcceleratorType"
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
+ ],
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors",
+ "parameters": {
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "instanceGroupManager": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}."
+ },
+ "region": {
+ "required": true,
+ "location": "path",
+ "description": "Name of the region scoping this request. This should conform to RFC1035.",
+ "type": "string"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "maxResults": {
+ "location": "query",
+ "format": "uint32",
+ "type": "integer",
+ "default": "500",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ }
},
- "description": "A list of AcceleratorType resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "httpMethod": "GET"
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "message": {
+ "recreateInstances": {
+ "parameters": {
+ "region": {
+ "location": "path",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Name of the region scoping this request."
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- },
- "type": "array"
+ "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).",
+ "location": "query",
+ "type": "string"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "instanceGroupManager": {
+ "location": "path",
+ "description": "Name of the managed instance group.",
+ "required": true,
+ "type": "string"
}
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- }
- }
- },
- "RouterBgpPeerBfd": {
- "id": "RouterBgpPeerBfd",
- "properties": {
- "minReceiveInterval": {
- "type": "integer",
- "description": "The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.",
- "format": "uint32"
- },
- "sessionInitializationMode": {
- "enum": [
- "ACTIVE",
- "DISABLED",
- "PASSIVE"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
],
- "description": "The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.",
- "enumDescriptions": [
- "",
- "",
- ""
+ "id": "compute.regionInstanceGroupManagers.recreateInstances",
+ "request": {
+ "$ref": "RegionInstanceGroupManagersRecreateRequest"
+ },
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
- },
- "minTransmitInterval": {
- "format": "uint32",
- "type": "integer",
- "description": "The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000."
- },
- "multiplier": {
- "format": "uint32",
- "description": "The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "Screenshot": {
- "id": "Screenshot",
- "properties": {
- "kind": {
- "type": "string",
- "default": "compute#screenshot",
- "description": "[Output Only] Type of the resource. Always compute#screenshot for the screenshots."
- },
- "contents": {
- "description": "[Output Only] The Base64-encoded screenshot data.",
- "type": "string"
- }
- },
- "description": "An instance's screenshot.",
- "type": "object"
- },
- "NodeGroupNode": {
- "properties": {
- "totalResources": {
- "description": "Total amount of available resources on the node.",
- "$ref": "InstanceConsumptionInfo"
- },
- "consumedResources": {
- "$ref": "InstanceConsumptionInfo",
- "description": "Node resources that are reserved by all instances."
- },
- "name": {
- "type": "string",
- "description": "The name of the node."
+ "description": "Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST"
},
- "serverId": {
- "description": "Server ID associated with this node.",
- "type": "string"
+ "deletePerInstanceConfigs": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
+ ],
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs",
+ "httpMethod": "POST",
+ "description": "Deletes selected per-instance configurations for the managed instance group.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "RegionInstanceGroupManagerDeleteInstanceConfigReq"
+ },
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Name of the region scoping this request, should conform to RFC1035."
+ },
+ "instanceGroupManager": {
+ "required": true,
+ "description": "The name of the managed instance group. It should conform to RFC1035.",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.regionInstanceGroupManagers.deletePerInstanceConfigs",
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs"
},
- "status": {
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
+ "listManagedInstances": {
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
+ "description": "Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.",
+ "httpMethod": "POST",
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "instanceGroupManager": {
+ "required": true,
+ "description": "The name of the managed instance group.",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "enum": [
- "CREATING",
- "DELETING",
- "INVALID",
- "READY",
- "REPAIRING"
- ]
- },
- "accelerators": {
- "description": "Accelerators for this node.",
- "type": "array",
- "items": {
- "$ref": "AcceleratorConfig"
- }
- },
- "disks": {
- "description": "Local disk configurations.",
- "items": {
- "$ref": "LocalDisk"
+ "id": "compute.regionInstanceGroupManagers.listManagedInstances",
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
+ ],
+ "response": {
+ "$ref": "RegionInstanceGroupManagersListInstancesResponse"
},
- "type": "array"
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances"
},
- "cpuOvercommitType": {
- "type": "string",
- "enum": [
- "CPU_OVERCOMMIT_TYPE_UNSPECIFIED",
- "ENABLED",
- "NONE"
+ "patchPerInstanceConfigs": {
+ "description": "Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.",
+ "request": {
+ "$ref": "RegionInstanceGroupManagerPatchInstanceConfigReq"
+ },
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
],
- "enumDescriptions": [
- "",
- "",
- ""
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "instanceGroupManager": {
+ "location": "path",
+ "description": "The name of the managed instance group. It should conform to RFC1035.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Name of the region scoping this request, should conform to RFC1035.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "CPU overcommit."
- },
- "serverBinding": {
- "description": "Binding properties for the physical server.",
- "$ref": "ServerBinding"
- },
- "instanceConsumptionData": {
- "type": "array",
- "description": "Instance data that shows consumed resources on the node.",
- "items": {
- "$ref": "InstanceConsumptionData"
- }
- },
- "nodeType": {
- "type": "string",
- "description": "The type of this node."
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
+ "id": "compute.regionInstanceGroupManagers.patchPerInstanceConfigs"
},
- "instances": {
- "items": {
- "type": "string"
+ "deleteInstances": {
+ "description": "Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "Instances scheduled on this node."
- },
- "satisfiesPzs": {
- "description": "[Output Only] Reserved for future use.",
- "type": "boolean"
- }
- },
- "type": "object",
- "id": "NodeGroupNode"
- },
- "InstanceTemplateList": {
- "properties": {
- "items": {
- "description": "A list of InstanceTemplate resources.",
- "type": "array",
- "items": {
- "$ref": "InstanceTemplate"
- }
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "parameters": {
+ "region": {
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "type": "string"
},
- "message": {
+ "instanceGroupManager": {
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true,
+ "description": "Name of the managed instance group."
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "requestId": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
}
},
- "type": "object"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.",
- "default": "compute#instanceTemplateList"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- }
- },
- "description": "A list of instance templates.",
- "type": "object",
- "id": "InstanceTemplateList"
- },
- "AutoscalingPolicyScalingSchedule": {
- "id": "AutoscalingPolicyScalingSchedule",
- "type": "object",
- "description": "Scaling based on user-defined schedule. The message describes a single scaling schedule. A scaling schedule changes the minimum number of VM instances an autoscaler can recommend, which can trigger scaling out.",
- "properties": {
- "minRequiredReplicas": {
- "format": "int32",
- "description": "The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.",
- "type": "integer"
- },
- "disabled": {
- "description": "A boolean value that specifies whether a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect. This field is optional, and its value is false by default.",
- "type": "boolean"
- },
- "description": {
- "type": "string",
- "description": "A description of a scaling schedule."
- },
- "timeZone": {
- "description": "The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of “UTC” if left empty.",
- "type": "string"
- },
- "durationSec": {
- "type": "integer",
- "description": "The duration of time intervals, in seconds, for which this scaling schedule is to run. The minimum allowed value is 300. This field is required.",
- "format": "int32"
- },
- "schedule": {
- "description": "The start timestamps of time intervals when this scaling schedule is to provide a scaling signal. This field uses the extended cron format (with an optional year field). The expression can describe a single timestamp if the optional year is set, in which case the scaling schedule runs once. The schedule is interpreted with respect to time_zone. This field is required. Note: These timestamps only describe when autoscaler starts providing the scaling signal. The VMs need additional time to become serving.",
- "type": "string"
- }
- }
- },
- "FileContentBuffer": {
- "properties": {
- "content": {
- "type": "string",
- "format": "byte",
- "description": "The raw content in the secure keys file."
- },
- "fileType": {
- "enum": [
- "BIN",
- "UNDEFINED",
- "X509"
- ],
- "description": "The file type of source file.",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- }
- },
- "id": "FileContentBuffer",
- "type": "object"
- },
- "SslPolicyReference": {
- "id": "SslPolicyReference",
- "properties": {
- "sslPolicy": {
- "description": "URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "InstanceGroupManagersApplyUpdatesRequest": {
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
- "items": {
- "type": "string"
- }
- },
- "minimalAction": {
- "description": "The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.",
- "type": "string",
- "enumDescriptions": [
- "Do not perform any action.",
- "Updates applied in runtime, instances will not be disrupted.",
- "Old instances will be deleted. New instances will be created from the target template.",
- "Every instance will be restarted."
- ],
- "enum": [
- "NONE",
- "REFRESH",
- "REPLACE",
- "RESTART"
- ]
- },
- "mostDisruptiveAllowedAction": {
- "enumDescriptions": [
- "Do not perform any action.",
- "Updates applied in runtime, instances will not be disrupted.",
- "Old instances will be deleted. New instances will be created from the target template.",
- "Every instance will be restarted."
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.",
- "type": "string",
- "enum": [
- "NONE",
- "REFRESH",
- "REPLACE",
- "RESTART"
- ]
- },
- "allInstances": {
- "type": "boolean",
- "description": "Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request."
- }
- },
- "description": "InstanceGroupManagers.applyUpdatesToInstances",
- "id": "InstanceGroupManagersApplyUpdatesRequest"
- },
- "InstanceTemplate": {
- "properties": {
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] A unique identifier for this instance template. The server defines this identifier.",
- "type": "string",
- "format": "uint64"
- },
- "properties": {
- "$ref": "InstanceProperties",
- "description": "The instance properties for this instance template."
- },
- "name": {
- "annotations": {
- "required": [
- "compute.instanceTemplates.insert"
- ]
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
+ "request": {
+ "$ref": "RegionInstanceGroupManagersDeleteInstancesRequest"
},
- "type": "string",
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] The URL for this instance template. The server defines this URL."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] The creation timestamp for this instance template in RFC3339 text format."
- },
- "kind": {
- "type": "string",
- "default": "compute#instanceTemplate",
- "description": "[Output Only] The resource type, which is always compute#instanceTemplate for instance templates."
- },
- "sourceInstanceParams": {
- "$ref": "SourceInstanceParams",
- "description": "The source instance params to use to create this instance template."
- },
- "sourceInstance": {
- "description": "The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance ",
- "type": "string"
- }
- },
- "description": "Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates.",
- "id": "InstanceTemplate",
- "type": "object"
- },
- "UrlRewrite": {
- "description": "The spec for modifying the path before sending the request to the matched backend service.",
- "id": "UrlRewrite",
- "type": "object",
- "properties": {
- "pathPrefixRewrite": {
- "type": "string",
- "description": "Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters."
- },
- "hostRewrite": {
- "description": "Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.",
- "type": "string"
- }
- }
- },
- "NetworkAttachment": {
- "properties": {
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "fingerprint": {
- "type": "string",
- "description": "[Output Only] Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.",
- "format": "byte"
- },
- "id": {
- "format": "uint64",
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier."
- },
- "network": {
- "type": "string",
- "description": "[Output Only] The URL of the network which the Network Attachment belongs to."
+ "httpMethod": "POST",
+ "id": "compute.regionInstanceGroupManagers.deleteInstances",
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
+ ]
},
- "subnetworks": {
- "description": "An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.",
- "items": {
- "type": "string"
+ "listPerInstanceConfigs": {
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
+ "description": "Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.",
+ "httpMethod": "POST",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "description": "Name of the region scoping this request, should conform to RFC1035.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "instanceGroupManager": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the managed instance group. It should conform to RFC1035."
+ },
+ "maxResults": {
+ "minimum": "0",
+ "default": "500",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ }
},
- "type": "array"
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
+ ],
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "RegionInstanceGroupManagersListInstanceConfigsResp"
+ },
+ "id": "compute.regionInstanceGroupManagers.listPerInstanceConfigs"
},
- "producerAcceptLists": {
- "description": "Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.",
- "type": "array",
- "items": {
- "type": "string"
+ "delete": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
+ ],
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
+ "id": "compute.regionInstanceGroupManagers.delete",
+ "description": "Deletes the specified managed instance group and all of the instances in that group.",
+ "parameters": {
+ "region": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Name of the region scoping this request."
+ },
+ "instanceGroupManager": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the managed instance group to delete."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ }
+ },
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
}
},
- "selfLinkWithId": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource's resource id."
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "producerRejectLists": {
- "description": "Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.",
- "items": {
- "type": "string"
+ "applyUpdatesToInstances": {
+ "parameters": {
+ "region": {
+ "location": "path",
+ "description": "Name of the region scoping this request, should conform to RFC1035.",
+ "type": "string",
+ "required": true
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "instanceGroupManager": {
+ "type": "string",
+ "description": "The name of the managed instance group, should conform to RFC1035.",
+ "required": true,
+ "location": "path"
+ }
},
- "type": "array"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
+ "description": "Apply updates to selected instances the managed instance group.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
+ ],
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
+ "id": "compute.regionInstanceGroupManagers.applyUpdatesToInstances",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "RegionInstanceGroupManagersApplyUpdatesRequest"
+ }
},
- "kind": {
- "description": "[Output Only] Type of the resource.",
- "default": "compute#networkAttachment",
- "type": "string"
+ "createInstances": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "region": {
+ "type": "string",
+ "description": "The name of the region where the managed instance group is located. It should conform to RFC1035.",
+ "location": "path",
+ "required": true
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)."
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "instanceGroupManager": {
+ "type": "string",
+ "description": "The name of the managed instance group. It should conform to RFC1035.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "id": "compute.regionInstanceGroupManagers.createInstances",
+ "description": "Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "RegionInstanceGroupManagersCreateInstancesRequest"
+ },
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances",
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
+ ]
},
- "connectionEndpoints": {
- "description": "[Output Only] An array of connections for all the producers connected to this network attachment.",
- "type": "array",
- "items": {
- "$ref": "NetworkAttachmentConnectedEndpoint"
+ "setInstanceTemplate": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.",
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "instanceGroupManager": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the managed instance group."
+ }
+ },
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.regionInstanceGroupManagers.setInstanceTemplate",
+ "request": {
+ "$ref": "RegionInstanceGroupManagersSetTemplateRequest"
}
},
- "connectionPreference": {
- "enumDescriptions": [
- "",
- "",
- ""
+ "resize": {
+ "description": "Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. 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 removed or deleted.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "ACCEPT_AUTOMATIC",
- "ACCEPT_MANUAL",
- "INVALID"
+ "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize",
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroupManager",
+ "size"
],
- "type": "string"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
- },
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "annotations": {
- "required": [
- "compute.networkAttachments.insert"
- ]
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "instanceGroupManager": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the managed instance group.",
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "size": {
+ "minimum": "0",
+ "type": "integer",
+ "format": "int32",
+ "required": true,
+ "description": "Number of instances that should exist in this instance group manager.",
+ "location": "query"
+ }
},
- "description": "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."
- }
- },
- "description": "NetworkAttachments A network attachment resource ...",
- "id": "NetworkAttachment",
- "type": "object"
- },
- "HttpsHealthCheck": {
- "description": "Represents a legacy HTTPS Health Check resource. Legacy HTTPS health checks have been deprecated. If you are using a target pool-based network load balancer, you must use a legacy HTTP (not HTTPS) health check. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .",
- "type": "object",
- "id": "HttpsHealthCheck",
- "properties": {
- "id": {
- "type": "string",
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
- },
- "requestPath": {
- "type": "string",
- "description": "The request path of the HTTPS health check request. The default value is \"/\"."
- },
- "healthyThreshold": {
- "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
- "format": "int32",
- "type": "integer"
- },
- "kind": {
- "type": "string",
- "description": "Type of the resource.",
- "default": "compute#httpsHealthCheck"
- },
- "timeoutSec": {
- "format": "int32",
- "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.",
- "type": "integer"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "unhealthyThreshold": {
- "type": "integer",
- "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
- "format": "int32"
- },
- "port": {
- "description": "The TCP port number for the HTTPS health check request. The default value is 443.",
- "type": "integer",
- "format": "int32"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "host": {
- "type": "string",
- "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used."
- },
- "checkIntervalSec": {
- "type": "integer",
- "format": "int32",
- "description": "How often (in seconds) to send a health check. The default value is 5 seconds."
+ "id": "compute.regionInstanceGroupManagers.resize"
}
}
},
- "InstanceGroupManagersAbandonInstancesRequest": {
- "properties": {
- "instances": {
- "items": {
- "type": "string"
+ "licenses": {
+ "methods": {
+ "insert": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/devstorage.full_control",
+ "https://www.googleapis.com/auth/devstorage.read_only",
+ "https://www.googleapis.com/auth/devstorage.read_write"
+ ],
+ "description": "Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
+ "id": "compute.licenses.insert",
+ "flatPath": "projects/{project}/global/licenses",
+ "request": {
+ "$ref": "License"
},
- "type": "array",
- "description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]."
- }
- },
- "id": "InstanceGroupManagersAbandonInstancesRequest",
- "type": "object"
- },
- "License": {
- "description": "Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "chargesUseFee": {
- "description": "[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.",
- "type": "boolean"
- },
- "licenseCode": {
- "description": "[Output Only] The unique code used to attach this license to images, snapshots, and disks.",
- "format": "uint64",
- "type": "string"
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "resourceRequirements": {
- "$ref": "LicenseResourceRequirements"
- },
- "transferable": {
- "type": "boolean",
- "description": "If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk."
- },
- "name": {
- "description": "Name of the resource. The name must be 1-63 characters long and comply with RFC1035.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "annotations": {
- "required": [
- "compute.images.insert"
- ]
- }
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "kind": {
- "default": "compute#license",
- "description": "[Output Only] Type of resource. Always compute#license for licenses.",
- "type": "string"
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
+ },
+ "path": "projects/{project}/global/licenses",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project"
+ ]
},
- "description": {
- "description": "An optional textual description of the resource; provided by the client when the resource is created.",
- "type": "string"
- }
- },
- "type": "object",
- "id": "License"
- },
- "GlobalNetworkEndpointGroupsAttachEndpointsRequest": {
- "type": "object",
- "id": "GlobalNetworkEndpointGroupsAttachEndpointsRequest",
- "properties": {
- "networkEndpoints": {
- "description": "The list of network endpoints to be attached.",
- "type": "array",
- "items": {
- "$ref": "NetworkEndpoint"
- }
- }
- }
- },
- "StatefulPolicyPreservedStateDiskDevice": {
- "id": "StatefulPolicyPreservedStateDiskDevice",
- "properties": {
- "autoDelete": {
- "enum": [
- "NEVER",
- "ON_PERMANENT_INSTANCE_DELETION"
+ "delete": {
+ "parameterOrder": [
+ "project",
+ "license"
],
- "type": "string",
- "enumDescriptions": [
- "",
- ""
+ "flatPath": "projects/{project}/global/licenses/{license}",
+ "path": "projects/{project}/global/licenses/{license}",
+ "id": "compute.licenses.delete",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "license": {
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "description": "Name of the license resource to delete."
+ }
+ }
+ },
+ "testIamPermissions": {
+ "parameters": {
+ "resource": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string",
+ "description": "Name or id of the resource for this request."
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
],
- "description": "These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted."
- }
- },
- "type": "object"
- },
- "AttachedDisk": {
- "properties": {
- "forceAttach": {
- "description": "[Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.",
- "type": "boolean"
+ "description": "Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "id": "compute.licenses.testIamPermissions",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/global/licenses/{resource}/testIamPermissions",
+ "path": "projects/{project}/global/licenses/{resource}/testIamPermissions",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "architecture": {
- "description": "[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64.",
- "enumDescriptions": [
- "Default value indicating Architecture is not set.",
- "Machines with architecture ARM64",
- "Machines with architecture X86_64"
+ "setIamPolicy": {
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path",
+ "description": "Name or id of the resource for this request."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request."
+ }
+ },
+ "id": "compute.licenses.setIamPolicy",
+ "parameterOrder": [
+ "project",
+ "resource"
],
- "enum": [
- "ARCHITECTURE_UNSPECIFIED",
- "ARM64",
- "X86_64"
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
+ "flatPath": "projects/{project}/global/licenses/{resource}/setIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
- "type": "string",
- "default": "compute#attachedDisk"
- },
- "guestOsFeatures": {
- "items": {
- "$ref": "GuestOsFeature"
+ "response": {
+ "$ref": "Policy"
},
- "type": "array",
- "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options."
- },
- "index": {
- "type": "integer",
- "description": "[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.",
- "format": "int32"
+ "path": "projects/{project}/global/licenses/{resource}/setIamPolicy",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "GlobalSetPolicyRequest"
+ }
},
- "type": {
- "enum": [
- "PERSISTENT",
- "SCRATCH"
+ "list": {
+ "parameters": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "default": "500"
+ }
+ },
+ "parameterOrder": [
+ "project"
],
- "description": "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.",
- "enumDescriptions": [
- "",
- ""
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string"
- },
- "shieldedInstanceInitialState": {
- "$ref": "InitialStateConfig",
- "description": "[Output Only] shielded vm initial state stored on disk"
- },
- "initializeParams": {
- "description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.",
- "$ref": "AttachedDiskInitializeParams"
- },
- "boot": {
- "type": "boolean",
- "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem."
- },
- "diskSizeGb": {
- "type": "string",
- "description": "The size of the disk in GB.",
- "format": "int64"
- },
- "deviceName": {
- "description": "Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.",
- "type": "string"
+ "flatPath": "projects/{project}/global/licenses",
+ "response": {
+ "$ref": "LicensesListResponse"
+ },
+ "description": "Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
+ "id": "compute.licenses.list",
+ "path": "projects/{project}/global/licenses"
},
- "diskEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group."
+ "get": {
+ "parameters": {
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "license": {
+ "required": true,
+ "description": "Name of the License resource to return.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ }
+ },
+ "id": "compute.licenses.get",
+ "path": "projects/{project}/global/licenses/{license}",
+ "flatPath": "projects/{project}/global/licenses/{license}",
+ "response": {
+ "$ref": "License"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project",
+ "license"
+ ],
+ "description": "Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "interface": {
- "enumDescriptions": [
- "",
- ""
+ "getIamPolicy": {
+ "flatPath": "projects/{project}/global/licenses/{resource}/getIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see About persistent disks.",
- "type": "string",
- "enum": [
- "NVME",
- "SCSI"
+ "path": "projects/{project}/global/licenses/{resource}/getIamPolicy",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "optionsRequestedPolicyVersion": {
+ "format": "int32",
+ "description": "Requested IAM Policy version.",
+ "type": "integer",
+ "location": "query"
+ },
+ "resource": {
+ "type": "string",
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ }
+ },
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
+ "id": "compute.licenses.getIamPolicy",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ]
+ }
+ }
+ },
+ "sslPolicies": {
+ "methods": {
+ "insert": {
+ "httpMethod": "POST",
+ "description": "Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.",
+ "id": "compute.sslPolicies.insert",
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/global/sslPolicies",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "SslPolicy"
+ },
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ }
+ },
+ "flatPath": "projects/{project}/global/sslPolicies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
},
- "mode": {
- "type": "string",
- "enum": [
- "READ_ONLY",
- "READ_WRITE"
+ "list": {
+ "flatPath": "projects/{project}/global/sslPolicies",
+ "path": "projects/{project}/global/sslPolicies",
+ "id": "compute.sslPolicies.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.",
- "enumDescriptions": [
- "Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.",
- "*[Default]* Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode."
+ "httpMethod": "GET",
+ "description": "Lists all the SSL policies that have been configured for the specified project.",
+ "parameters": {
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "minimum": "0",
+ "location": "query",
+ "default": "500",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "SslPoliciesList"
+ },
+ "parameterOrder": [
+ "project"
]
},
- "autoDelete": {
- "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).",
- "type": "boolean"
+ "aggregatedList": {
+ "id": "compute.sslPolicies.aggregatedList",
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "default": "500",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "description": "Name of the project scoping this request.",
+ "location": "path"
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ }
+ },
+ "response": {
+ "$ref": "SslPoliciesAggregatedList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.",
+ "flatPath": "projects/{project}/aggregated/sslPolicies",
+ "httpMethod": "GET",
+ "path": "projects/{project}/aggregated/sslPolicies"
},
- "licenses": {
- "items": {
- "type": "string"
+ "delete": {
+ "parameters": {
+ "project": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "sslPolicy": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035."
+ }
},
- "description": "[Output Only] Any valid publicly visible licenses.",
- "type": "array"
+ "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}",
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/global/sslPolicies/{sslPolicy}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.",
+ "id": "compute.sslPolicies.delete",
+ "parameterOrder": [
+ "project",
+ "sslPolicy"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "source": {
- "description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk.",
- "type": "string"
- }
- },
- "type": "object",
- "description": "An instance-attached disk resource.",
- "id": "AttachedDisk"
- },
- "PacketMirroringFilter": {
- "type": "object",
- "properties": {
- "cidrRanges": {
- "items": {
- "type": "string"
+ "listAvailableFeatures": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/global/sslPolicies/listAvailableFeatures",
+ "description": "Lists all features that can be specified in the SSL policy when using custom profile.",
+ "parameters": {
+ "maxResults": {
+ "minimum": "0",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ }
},
- "description": "IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.",
- "type": "array"
+ "response": {
+ "$ref": "SslPoliciesListAvailableFeaturesResponse"
+ },
+ "path": "projects/{project}/global/sslPolicies/listAvailableFeatures",
+ "id": "compute.sslPolicies.listAvailableFeatures",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project"
+ ]
},
- "direction": {
- "enum": [
- "BOTH",
- "EGRESS",
- "INGRESS"
+ "patch": {
+ "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}",
+ "path": "projects/{project}/global/sslPolicies/{sslPolicy}",
+ "description": "Patches the specified SSL policy with the data included in the request.",
+ "parameters": {
+ "sslPolicy": {
+ "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true
+ }
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "project",
+ "sslPolicy"
],
- "description": "Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH. The default is BOTH.",
- "enumDescriptions": [
- "Default, both directions are mirrored.",
- "Only egress traffic is mirrored.",
- "Only ingress traffic is mirrored."
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
+ "request": {
+ "$ref": "SslPolicy"
+ },
+ "id": "compute.sslPolicies.patch"
},
- "IPProtocols": {
- "type": "array",
- "items": {
- "type": "string"
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "path": "projects/{project}/global/sslPolicies/{sslPolicy}",
+ "description": "Lists all of the ordered rules present in a single specified policy.",
+ "id": "compute.sslPolicies.get",
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "sslPolicy": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035."
+ }
},
- "description": "Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored."
+ "response": {
+ "$ref": "SslPolicy"
+ },
+ "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}",
+ "parameterOrder": [
+ "project",
+ "sslPolicy"
+ ]
}
- },
- "id": "PacketMirroringFilter"
+ }
},
- "ServiceAttachment": {
- "id": "ServiceAttachment",
- "description": "Represents a ServiceAttachment resource. A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service. next tag = 20",
- "properties": {
- "connectionPreference": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "ACCEPT_AUTOMATIC",
- "ACCEPT_MANUAL",
- "CONNECTION_PREFERENCE_UNSPECIFIED"
+ "machineImages": {
+ "methods": {
+ "setIamPolicy": {
+ "parameterOrder": [
+ "project",
+ "resource"
],
- "type": "string",
- "description": "The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules."
- },
- "pscServiceAttachmentId": {
- "$ref": "Uint128",
- "description": "[Output Only] An 128-bit global unique ID of the PSC service attachment."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.",
- "default": "compute#serviceAttachment"
- },
- "fingerprint": {
- "type": "string",
- "format": "byte",
- "description": "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."
- },
- "connectedEndpoints": {
- "type": "array",
- "items": {
- "$ref": "ServiceAttachmentConnectedEndpoint"
+ "parameters": {
+ "resource": {
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request.",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request."
+ }
},
- "description": "[Output Only] An array of connections for all the consumers connected to this service attachment."
- },
- "natSubnets": {
- "items": {
- "type": "string"
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/global/machineImages/{resource}/setIamPolicy",
+ "request": {
+ "$ref": "GlobalSetPolicyRequest"
},
- "description": "An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.",
- "type": "array"
- },
- "domainNames": {
- "items": {
- "type": "string"
+ "response": {
+ "$ref": "Policy"
},
- "type": "array",
- "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."
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
- },
- "targetService": {
- "description": "The URL of a service serving the endpoint identified by this service attachment.",
- "type": "string"
+ "id": "compute.machineImages.setIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/machineImages/{resource}/setIamPolicy"
},
- "consumerRejectLists": {
- "items": {
- "type": "string"
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/global/machineImages/{resource}/testIamPermissions",
+ "response": {
+ "$ref": "TestPermissionsResponse"
},
- "type": "array",
- "description": "Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "enableProxyProtocol": {
- "type": "boolean",
- "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."
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.",
- "type": "string"
- },
- "consumerAcceptLists": {
- "description": "Projects that are allowed to connect to this service attachment.",
- "type": "array",
- "items": {
- "$ref": "ServiceAttachmentConsumerProjectLimit"
- }
- },
- "name": {
- "description": "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.",
- "annotations": {
- "required": [
- "compute.serviceAttachments.insert"
- ]
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "path": "projects/{project}/global/machineImages/{resource}/testIamPermissions",
+ "request": {
+ "$ref": "TestPermissionsRequest"
},
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "producerForwardingRule": {
- "description": "The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "SslCertificateManagedSslCertificate": {
- "id": "SslCertificateManagedSslCertificate",
- "properties": {
- "domainStatus": {
- "type": "object",
- "description": "[Output only] Detailed statuses of the domains specified for managed certificate resource.",
- "additionalProperties": {
- "type": "string",
- "enumDescriptions": [
- "A managed certificate can be provisioned, no issues for this domain.",
- "",
- "Failed to check CAA records for the domain.",
- "Certificate issuance forbidden by an explicit CAA record for the domain.",
- "There seems to be problem with the user's DNS or load balancer configuration for this domain.",
- "Reached rate-limit for certificates per top-level private domain.",
- "Certificate provisioning for this domain is under way. GCP will attempt to provision the first certificate."
- ],
- "enum": [
- "ACTIVE",
- "DOMAIN_STATUS_UNSPECIFIED",
- "FAILED_CAA_CHECKING",
- "FAILED_CAA_FORBIDDEN",
- "FAILED_NOT_VISIBLE",
- "FAILED_RATE_LIMITED",
- "PROVISIONING"
- ]
+ "id": "compute.machineImages.testIamPermissions",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name or id of the resource for this request."
+ }
}
},
- "domains": {
- "items": {
- "type": "string"
+ "get": {
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string"
+ },
+ "machineImage": {
+ "description": "The name of the machine image.",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
},
- "type": "array",
- "description": "The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates)."
- },
- "status": {
- "type": "string",
- "enumDescriptions": [
- "The certificate management is working, and a certificate has been provisioned.",
- "",
- "The certificate management is working. GCP will attempt to provision the first certificate.",
- "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. For details of which domain failed, consult domain_status field.",
- "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. It won't be retried. To try again delete and create a new managed SslCertificate resource. For details of which domain failed, consult domain_status field.",
- "Renewal of the certificate has failed due to an issue with the DNS or load balancing configuration. The existing cert is still serving; however, it will expire shortly. To provision a renewed certificate, delete and create a new managed SslCertificate resource. For details on which domain failed, consult domain_status field."
+ "id": "compute.machineImages.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "[Output only] Status of the managed certificate resource.",
- "enum": [
- "ACTIVE",
- "MANAGED_CERTIFICATE_STATUS_UNSPECIFIED",
- "PROVISIONING",
- "PROVISIONING_FAILED",
- "PROVISIONING_FAILED_PERMANENTLY",
- "RENEWAL_FAILED"
+ "path": "projects/{project}/global/machineImages/{machineImage}",
+ "response": {
+ "$ref": "MachineImage"
+ },
+ "description": "Returns the specified machine image. Gets a list of available machine images by making a list() request.",
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/global/machineImages/{machineImage}",
+ "parameterOrder": [
+ "project",
+ "machineImage"
]
- }
- },
- "description": "Configuration and status of a managed SSL certificate.",
- "type": "object"
- },
- "Expr": {
- "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 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.",
- "properties": {
- "expression": {
- "type": "string",
- "description": "Textual representation of an expression in Common Expression Language syntax."
- },
- "title": {
- "type": "string",
- "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression."
- },
- "description": {
- "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
- "type": "string"
- },
- "location": {
- "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
- "type": "string"
- }
- },
- "id": "Expr",
- "type": "object"
- },
- "BackendBucketCdnPolicyNegativeCachingPolicy": {
- "properties": {
- "code": {
- "description": "The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.",
- "format": "int32",
- "type": "integer"
- },
- "ttl": {
- "format": "int32",
- "description": "The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.",
- "type": "integer"
- }
- },
- "description": "Specify CDN TTLs for response error codes.",
- "type": "object",
- "id": "BackendBucketCdnPolicyNegativeCachingPolicy"
- },
- "ConsistentHashLoadBalancerSettings": {
- "type": "object",
- "properties": {
- "httpHeaderName": {
- "description": "The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.",
- "type": "string"
- },
- "httpCookie": {
- "description": "Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
- "$ref": "ConsistentHashLoadBalancerSettingsHttpCookie"
},
- "minimumRingSize": {
- "format": "int64",
- "type": "string",
- "description": "The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node."
- }
- },
- "description": "This message defines settings for a consistent hash style load balancer.",
- "id": "ConsistentHashLoadBalancerSettings"
- },
- "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": {
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "[Output Only] The display name of the firewall policy."
+ "insert": {
+ "request": {
+ "$ref": "MachineImage"
+ },
+ "flatPath": "projects/{project}/global/machineImages",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "sourceInstance": {
+ "description": "Required. Source instance that is used to create the machine image from.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.machineImages.insert",
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "POST",
+ "description": "Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance.",
+ "path": "projects/{project}/global/machineImages"
},
- "name": {
- "description": "[Output Only] The name of the firewall policy.",
- "type": "string"
+ "getIamPolicy": {
+ "id": "compute.machineImages.getIamPolicy",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "path": "projects/{project}/global/machineImages/{resource}/getIamPolicy",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "optionsRequestedPolicyVersion": {
+ "type": "integer",
+ "format": "int32",
+ "location": "query",
+ "description": "Requested IAM Policy version."
+ },
+ "resource": {
+ "type": "string",
+ "location": "path",
+ "description": "Name or id of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
+ },
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "flatPath": "projects/{project}/global/machineImages/{resource}/getIamPolicy"
},
- "rules": {
- "type": "array",
- "description": "The rules that apply to the network.",
- "items": {
- "$ref": "FirewallPolicyRule"
+ "list": {
+ "path": "projects/{project}/global/machineImages",
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "id": "compute.machineImages.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves a list of machine images that are contained within the specified project.",
+ "flatPath": "projects/{project}/global/machineImages",
+ "parameters": {
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "type": "integer",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "MachineImageList"
}
},
- "type": {
- "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.",
- "enum": [
- "HIERARCHY",
- "NETWORK",
- "NETWORK_REGIONAL",
- "UNSPECIFIED"
+ "delete": {
+ "description": "Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.",
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "",
- "",
- "",
- ""
+ "path": "projects/{project}/global/machineImages/{machineImage}",
+ "id": "compute.machineImages.delete",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "machineImage": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "description": "The name of the machine image to delete."
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "machineImage"
],
- "type": "string"
+ "flatPath": "projects/{project}/global/machineImages/{machineImage}"
}
- },
- "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
+ }
},
- "SecurityPolicyDdosProtectionConfig": {
- "id": "SecurityPolicyDdosProtectionConfig",
- "type": "object",
- "properties": {
- "ddosProtection": {
- "enumDescriptions": [
- "",
- ""
+ "zoneOperations": {
+ "methods": {
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "ADVANCED",
- "STANDARD"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "operation"
],
- "type": "string"
- }
- }
- },
- "OperationList": {
- "id": "OperationList",
- "type": "object",
- "description": "Contains a list of Operation resources.",
- "properties": {
- "kind": {
- "description": "[Output Only] Type of resource. Always `compute#operations` for Operations resource.",
- "type": "string",
- "default": "compute#operationList"
- },
- "warning": {
- "properties": {
- "message": {
+ "id": "compute.zoneOperations.get",
+ "description": "Retrieves the specified zone-specific Operations resource.",
+ "parameters": {
+ "zone": {
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
- },
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- }
+ "description": "Name of the zone for this request."
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "operation": {
+ "description": "Name of the Operations resource to return.",
+ "required": true,
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "items": {
- "type": "array",
- "items": {
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/zones/{zone}/operations/{operation}",
+ "response": {
"$ref": "Operation"
},
- "description": "[Output Only] A list of Operation resources."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than `maxResults`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results.",
- "type": "string"
- }
- }
- },
- "BackendBucketCdnPolicy": {
- "properties": {
- "cacheKeyPolicy": {
- "description": "The CacheKeyPolicy for this CdnPolicy.",
- "$ref": "BackendBucketCdnPolicyCacheKeyPolicy"
- },
- "maxTtl": {
- "format": "int32",
- "type": "integer",
- "description": "Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of \"0\" means \"always revalidate\". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL."
- },
- "signedUrlCacheMaxAgeSec": {
- "type": "string",
- "description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.",
- "format": "int64"
- },
- "serveWhileStale": {
- "format": "int32",
- "type": "integer",
- "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale."
- },
- "clientTtl": {
- "description": "Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a \"public\" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a \"public\" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).",
- "type": "integer",
- "format": "int32"
+ "path": "projects/{project}/zones/{zone}/operations/{operation}"
},
- "signedUrlKeyNames": {
- "type": "array",
- "items": {
- "type": "string"
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves a list of Operation resources contained within the specified zone.",
+ "flatPath": "projects/{project}/zones/{zone}/operations",
+ "id": "compute.zoneOperations.list",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "maxResults": {
+ "default": "500",
+ "format": "uint32",
+ "minimum": "0",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer"
+ },
+ "zone": {
+ "description": "Name of the zone for request.",
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
},
- "description": "[Output Only] Names of the keys for signing request URLs."
- },
- "defaultTtl": {
- "type": "integer",
- "format": "int32",
- "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL."
- },
- "bypassCacheOnRequestHeaders": {
- "items": {
- "$ref": "BackendBucketCdnPolicyBypassCacheOnRequestHeader"
+ "response": {
+ "$ref": "OperationList"
},
- "description": "Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.",
- "type": "array"
- },
- "negativeCaching": {
- "type": "boolean",
- "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy."
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "path": "projects/{project}/zones/{zone}/operations",
+ "httpMethod": "GET"
},
- "negativeCachingPolicy": {
- "items": {
- "$ref": "BackendBucketCdnPolicyNegativeCachingPolicy"
+ "delete": {
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified zone-specific Operations resource.",
+ "path": "projects/{project}/zones/{zone}/operations/{operation}",
+ "id": "compute.zoneOperations.delete",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "zone": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "operation": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "description": "Name of the Operations resource to delete.",
+ "location": "path"
+ }
},
- "type": "array",
- "description": "Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists."
- },
- "requestCoalescing": {
- "type": "boolean",
- "description": "If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin."
- },
- "cacheMode": {
- "type": "string",
- "enumDescriptions": [
- "Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.",
- "Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.",
- "",
- "Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "CACHE_ALL_STATIC",
- "FORCE_CACHE_ALL",
- "INVALID_CACHE_MODE",
- "USE_ORIGIN_HEADERS"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "operation"
],
- "description": "Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached."
- }
- },
- "type": "object",
- "description": "Message containing Cloud CDN configuration for a backend bucket.",
- "id": "BackendBucketCdnPolicy"
- },
- "FirewallPolicyAssociation": {
- "id": "FirewallPolicyAssociation",
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association."
- },
- "name": {
- "type": "string",
- "description": "The name for an association."
- },
- "shortName": {
- "description": "[Output Only] The short name of the firewall policy of the association.",
- "type": "string"
- },
- "firewallPolicyId": {
- "description": "[Output Only] The firewall policy ID of the association.",
- "type": "string"
- },
- "attachmentTarget": {
- "description": "The target that the firewall policy is attached to.",
- "type": "string"
- }
- }
- },
- "LogConfigCounterOptionsCustomField": {
- "type": "object",
- "id": "LogConfigCounterOptionsCustomField",
- "properties": {
- "value": {
- "description": "This is deprecated and has no effect. Do not use.",
- "type": "string"
+ "flatPath": "projects/{project}/zones/{zone}/operations/{operation}"
},
- "name": {
- "type": "string",
- "description": "This is deprecated and has no effect. Do not use."
- }
- },
- "description": "This is deprecated and has no effect. Do not use."
- },
- "SslCertificatesScopedList": {
- "id": "SslCertificatesScopedList",
- "type": "object",
- "properties": {
- "warning": {
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "wait": {
+ "id": "compute.zoneOperations.wait",
+ "flatPath": "projects/{project}/zones/{zone}/operations/{operation}/wait",
+ "httpMethod": "POST",
+ "path": "projects/{project}/zones/{zone}/operations/{operation}/wait",
+ "parameters": {
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "operation": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the Operations resource to return.",
+ "location": "path",
+ "type": "string",
+ "required": true
},
- "data": {
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "zone": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
}
},
- "type": "object",
- "description": "Informational warning which replaces the list of backend services when the list is empty."
- },
- "sslCertificates": {
- "type": "array",
- "description": "List of SslCertificates contained in this scope.",
- "items": {
- "$ref": "SslCertificate"
+ "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "operation"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "Operation"
}
}
}
},
- "SecurityPolicyAdaptiveProtectionConfig": {
- "description": "Configuration options for Cloud Armor Adaptive Protection (CAAP).",
- "properties": {
- "layer7DdosDefenseConfig": {
- "$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig",
- "description": "If set to true, enables Cloud Armor Machine Learning."
- }
- },
- "id": "SecurityPolicyAdaptiveProtectionConfig",
- "type": "object"
- },
- "BfdStatus": {
- "id": "BfdStatus",
- "description": "Next free: 15",
- "type": "object",
- "properties": {
- "negotiatedLocalControlTxIntervalMs": {
- "format": "uint32",
- "type": "integer",
- "description": "Negotiated transmit interval for control packets."
- },
- "controlPacketIntervals": {
- "type": "array",
- "items": {
- "$ref": "PacketIntervals"
+ "nodeTypes": {
+ "methods": {
+ "aggregatedList": {
+ "id": "compute.nodeTypes.aggregatedList",
+ "path": "projects/{project}/aggregated/nodeTypes",
+ "description": "Retrieves an aggregated list of node types.",
+ "parameters": {
+ "includeAllScopes": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "format": "uint32",
+ "location": "query",
+ "default": "500"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
+ }
},
- "description": "Inter-packet time interval statistics for control packets."
- },
- "bfdSessionInitializationMode": {
- "enum": [
- "ACTIVE",
- "DISABLED",
- "PASSIVE"
- ],
- "enumDescriptions": [
- "",
- "",
- ""
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/aggregated/nodeTypes",
+ "response": {
+ "$ref": "NodeTypeAggregatedList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer.",
- "type": "string"
+ "parameterOrder": [
+ "project"
+ ]
},
- "localDiagnostic": {
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
+ "list": {
+ "parameterOrder": [
+ "project",
+ "zone"
],
- "description": "The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880",
- "enum": [
- "ADMINISTRATIVELY_DOWN",
- "CONCATENATED_PATH_DOWN",
- "CONTROL_DETECTION_TIME_EXPIRED",
- "DIAGNOSTIC_UNSPECIFIED",
- "ECHO_FUNCTION_FAILED",
- "FORWARDING_PLANE_RESET",
- "NEIGHBOR_SIGNALED_SESSION_DOWN",
- "NO_DIAGNOSTIC",
- "PATH_DOWN",
- "REVERSE_CONCATENATED_PATH_DOWN"
+ "path": "projects/{project}/zones/{zone}/nodeTypes",
+ "flatPath": "projects/{project}/zones/{zone}/nodeTypes",
+ "id": "compute.nodeTypes.list",
+ "description": "Retrieves a list of node types available to the specified project.",
+ "parameters": {
+ "zone": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone for this request."
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "default": "500",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string"
- },
- "txPacket": {
- "description": "The most recent Tx control packet for this BFD session.",
- "$ref": "BfdPacket"
- },
- "controlPacketCounts": {
- "$ref": "BfdStatusPacketCounts",
- "description": "Control packet counts for the current BFD session."
- },
- "configUpdateTimestampMicros": {
- "description": "Unix timestamp of the most recent config update.",
- "type": "string",
- "format": "int64"
- },
- "rxPacket": {
- "description": "The most recent Rx control packet for this BFD session.",
- "$ref": "BfdPacket"
+ "response": {
+ "$ref": "NodeTypeList"
+ }
},
- "localState": {
- "enum": [
- "ADMIN_DOWN",
- "DOWN",
- "INIT",
- "STATE_UNSPECIFIED",
- "UP"
+ "get": {
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/zones/{zone}/nodeTypes/{nodeType}",
+ "path": "projects/{project}/zones/{zone}/nodeTypes/{nodeType}",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "nodeType": {
+ "location": "path",
+ "description": "Name of the node type to return.",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the zone for this request.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ }
+ },
+ "description": "Returns the specified node type. Gets a list of available node types by making a list() request.",
+ "response": {
+ "$ref": "NodeType"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "uptimeMs": {
- "description": "Session uptime in milliseconds. Value will be 0 if session is not up.",
- "type": "string",
- "format": "int64"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "nodeType"
+ ],
+ "id": "compute.nodeTypes.get"
}
}
},
- "OperationAggregatedList": {
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "unreachables": {
- "type": "array",
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always `compute#operationAggregatedList` for aggregated lists of operations.",
- "default": "compute#operationAggregatedList",
- "type": "string"
+ "instanceGroupManagers": {
+ "methods": {
+ "listErrors": {
+ "response": {
+ "$ref": "InstanceGroupManagersListErrorsResponse"
+ },
+ "parameters": {
+ "maxResults": {
+ "type": "integer",
+ "default": "500",
+ "minimum": "0",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "instanceGroupManager": {
+ "description": "The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "httpMethod": "GET",
+ "description": "Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors",
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors",
+ "id": "compute.instanceGroupManagers.listErrors"
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
+ "createInstances": {
+ "id": "compute.instanceGroupManagers.createInstances",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances",
+ "parameters": {
+ "requestId": {
+ "location": "query",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)."
},
- "message": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "instanceGroupManager": {
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "path",
+ "description": "The name of the managed instance group. It should conform to RFC1035."
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- }
+ "zone": {
+ "type": "string",
+ "required": true,
+ "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.",
+ "location": "path"
}
},
- "type": "object"
- },
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "[Output Only] Name of the scope containing this set of operations.",
- "$ref": "OperationsScopedList"
- },
- "description": "[Output Only] A map of scoped operation lists."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than `maxResults`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results."
- }
- },
- "id": "OperationAggregatedList",
- "type": "object"
- },
- "Route": {
- "id": "Route",
- "properties": {
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of this resource. Always compute#routes for Route resources.",
- "default": "compute#route"
- },
- "priority": {
- "format": "uint32",
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
+ "request": {
+ "$ref": "InstanceGroupManagersCreateInstancesRequest"
},
- "description": "The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.",
- "type": "integer"
- },
- "nextHopVpnTunnel": {
- "description": "The URL to a VpnTunnel that should handle matching packets.",
- "type": "string"
+ "description": "Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.",
+ "httpMethod": "POST"
},
- "asPaths": {
- "type": "array",
- "items": {
- "$ref": "RouteAsPath"
+ "abandonInstances": {
+ "id": "compute.instanceGroupManagers.abandonInstances",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "description": "[Output Only] AS path."
- },
- "tags": {
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
+ "request": {
+ "$ref": "InstanceGroupManagersAbandonInstancesRequest"
},
- "description": "A list of instance tags to which this route applies.",
- "items": {
- "type": "string"
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "description": "Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
+ "parameters": {
+ "zone": {
+ "description": "The name of the zone where the managed instance group is located.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "instanceGroupManager": {
+ "required": true,
+ "type": "string",
+ "description": "The name of the managed instance group.",
+ "location": "path"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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": "array"
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances"
},
- "warnings": {
- "type": "array",
- "description": "[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.",
- "items": {
- "properties": {
- "data": {
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
- },
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
- },
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
- }
+ "aggregatedList": {
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "InstanceGroupManagerAggregatedList"
+ },
+ "path": "projects/{project}/aggregated/instanceGroupManagers",
+ "description": "Retrieves the list of managed instance groups and groups them by zone.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/aggregated/instanceGroupManagers",
+ "parameters": {
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
},
- "type": "object"
- }
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "network": {
- "description": "Fully-qualified URL of the network that this route applies to.",
- "type": "string",
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
- },
- "name": {
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "default": "500",
+ "location": "query",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean"
+ }
},
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit."
- },
- "nextHopInstance": {
- "type": "string",
- "description": "The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64"
- },
- "nextHopIlb": {
- "type": "string",
- "description": "The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule "
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined fully-qualified URL for this resource."
- },
- "nextHopGateway": {
- "type": "string",
- "description": "The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway"
- },
- "destRange": {
- "type": "string",
- "description": "The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.",
- "annotations": {
- "required": [
- "compute.routes.insert"
- ]
- }
+ "httpMethod": "GET",
+ "id": "compute.instanceGroupManagers.aggregatedList"
},
- "routeType": {
- "enumDescriptions": [
- "",
- "",
- "",
- ""
+ "applyUpdatesToInstances": {
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
],
- "enum": [
- "BGP",
- "STATIC",
- "SUBNET",
- "TRANSIT"
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route",
- "type": "string"
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
+ "description": "Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "zone": {
+ "description": "The name of the zone where the managed instance group is located. Should conform to RFC1035.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "instanceGroupManager": {
+ "required": true,
+ "description": "The name of the managed instance group, should conform to RFC1035.",
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "InstanceGroupManagersApplyUpdatesRequest"
+ },
+ "id": "compute.instanceGroupManagers.applyUpdatesToInstances"
},
- "routeStatus": {
- "description": "[Output only] The status of the route.",
- "enumDescriptions": [
- "This route is processed and active.",
- "The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example",
- "This route is processed but inactive due to failure from the backend. The backend may have rejected the route",
- "This route is being processed internally. The status will change once processed."
+ "setTargetPools": {
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
+ "id": "compute.instanceGroupManagers.setTargetPools",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
],
- "type": "string",
- "enum": [
- "ACTIVE",
- "DROPPED",
- "INACTIVE",
- "PENDING"
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
+ "request": {
+ "$ref": "InstanceGroupManagersSetTargetPoolsRequest"
+ },
+ "description": "Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.",
+ "parameters": {
+ "instanceGroupManager": {
+ "required": true,
+ "description": "The name of the managed instance group.",
+ "location": "path",
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "description": "The name of the zone where the managed instance group is located.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
},
- "nextHopIp": {
- "type": "string",
- "description": "The network IP address of an instance that should handle matching packets. Only IPv4 is supported."
- },
- "nextHopPeering": {
- "description": "[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this field when you create the resource."
- },
- "nextHopNetwork": {
- "description": "The URL of the local network if it should handle matching packets.",
- "type": "string"
- }
- },
- "type": "object",
- "description": "Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview."
- },
- "RegionList": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "warning": {
- "type": "object",
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "type": "string"
+ "patchPerInstanceConfigs": {
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "zone": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035."
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
+ "instanceGroupManager": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The name of the managed instance group. It should conform to RFC1035."
}
},
- "description": "[Output Only] Informational warning message."
- },
- "items": {
- "description": "A list of Region resources.",
- "type": "array",
- "items": {
- "$ref": "Region"
- }
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#regionList for lists of regions.",
- "default": "compute#regionList",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- }
- },
- "id": "RegionList",
- "description": "Contains a list of region resources."
- },
- "BackendBucketCdnPolicyCacheKeyPolicy": {
- "id": "BackendBucketCdnPolicyCacheKeyPolicy",
- "properties": {
- "queryStringWhitelist": {
- "description": "Names of query string parameters to include in cache keys. Default parameters are always included. '&' and '=' will be percent encoded and not treated as delimiters.",
- "items": {
- "type": "string"
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
+ "request": {
+ "$ref": "InstanceGroupManagersPatchPerInstanceConfigsReq"
},
- "type": "array"
- },
- "includeHttpHeaders": {
- "type": "array",
- "items": {
- "type": "string"
+ "id": "compute.instanceGroupManagers.patchPerInstanceConfigs",
+ "response": {
+ "$ref": "Operation"
},
- "description": "Allows HTTP request headers (by name) to be used in the cache key."
- }
- },
- "type": "object",
- "description": "Message containing what to include in the cache key for a request for Cloud CDN."
- },
- "Reference": {
- "id": "Reference",
- "description": "Represents a reference to a resource.",
- "type": "object",
- "properties": {
- "referrer": {
- "description": "URL of the resource which refers to the target.",
- "type": "string"
- },
- "target": {
- "description": "URL of the resource to which this reference points.",
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#reference for references.",
- "type": "string",
- "default": "compute#reference"
+ "description": "Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ],
+ "httpMethod": "POST"
},
- "referenceType": {
- "description": "A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF ",
- "type": "string"
- }
- }
- },
- "ReservationsScopedList": {
- "id": "ReservationsScopedList",
- "properties": {
- "warning": {
- "description": "Informational warning which replaces the list of reservations when the list is empty.",
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- },
- "type": "array"
+ "listManagedInstances": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "InstanceGroupManagersListManagedInstancesResponse"
+ },
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path"
},
- "message": {
+ "zone": {
+ "description": "The name of the zone where the managed instance group is located.",
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "location": "query"
+ },
+ "instanceGroupManager": {
+ "location": "path",
+ "type": "string",
+ "description": "The name of the managed instance group.",
+ "required": true
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "format": "uint32",
+ "type": "integer"
}
},
- "type": "object"
- },
- "reservations": {
- "type": "array",
- "description": "A list of reservations contained in this scope.",
- "items": {
- "$ref": "Reservation"
- }
- }
- },
- "type": "object"
- },
- "MachineTypeAggregatedList": {
- "properties": {
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "items": {
- "additionalProperties": {
- "$ref": "MachineTypesScopedList",
- "description": "[Output Only] Name of the scope containing this set of machine types."
- },
- "type": "object",
- "description": "A list of MachineTypesScopedList resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ],
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
+ "description": "Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.",
+ "id": "compute.instanceGroupManagers.listManagedInstances",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- }
+ "resize": {
+ "parameters": {
+ "size": {
+ "location": "query",
+ "format": "int32",
+ "description": "The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.",
+ "type": "integer",
+ "required": true
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "instanceGroupManager": {
+ "location": "path",
+ "description": "The name of the managed instance group.",
+ "required": true,
"type": "string"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "zone": {
+ "location": "path",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "required": true,
+ "description": "The name of the zone where the managed instance group is located."
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
}
},
- "type": "object"
- },
- "unreachables": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "[Output Only] Unreachable resources."
- },
- "kind": {
- "default": "compute#machineTypeAggregatedList",
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types."
- }
- },
- "type": "object",
- "id": "MachineTypeAggregatedList"
- },
- "RegionInstanceGroupManagersListInstanceConfigsResp": {
- "id": "RegionInstanceGroupManagersListInstanceConfigsResp",
- "properties": {
- "items": {
- "items": {
- "$ref": "PerInstanceConfig"
+ "id": "compute.instanceGroupManagers.resize",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
+ "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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 removed or deleted.",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager",
+ "size"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "[Output Only] The list of PerInstanceConfig."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize"
},
- "warning": {
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "listPerInstanceConfigs": {
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array"
+ "maxResults": {
+ "type": "integer",
+ "format": "uint32",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "minimum": "0"
},
- "message": {
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "zone": {
+ "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "instanceGroupManager": {
+ "description": "The name of the managed instance group. It should conform to RFC1035.",
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- }
- },
- "type": "object"
- },
- "DisksRemoveResourcePoliciesRequest": {
- "properties": {
- "resourcePolicies": {
- "type": "array",
- "description": "Resource policies to be removed from this disk.",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "DisksRemoveResourcePoliciesRequest",
- "type": "object"
- },
- "ResourcePolicySnapshotSchedulePolicySnapshotProperties": {
- "properties": {
- "guestFlush": {
- "description": "Indication to perform a 'guest aware' snapshot.",
- "type": "boolean"
- },
- "chainName": {
- "type": "string",
- "description": "Chain name that the snapshot is created in."
- },
- "storageLocations": {
- "description": "Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).",
- "type": "array",
- "items": {
- "type": "string"
+ "description": "Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.",
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
+ "id": "compute.instanceGroupManagers.listPerInstanceConfigs",
+ "response": {
+ "$ref": "InstanceGroupManagersListPerInstanceConfigsResp"
}
},
- "labels": {
- "description": "Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty.",
- "additionalProperties": {
- "type": "string"
+ "deleteInstances": {
+ "id": "compute.instanceGroupManagers.deleteInstances",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ],
+ "parameters": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "zone": {
+ "description": "The name of the zone where the managed instance group is located.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "instanceGroupManager": {
+ "description": "The name of the managed instance group.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ }
},
- "type": "object"
- }
- },
- "type": "object",
- "description": "Specified snapshot properties for scheduled snapshots created by this policy.",
- "id": "ResourcePolicySnapshotSchedulePolicySnapshotProperties"
- },
- "GuestAttributesEntry": {
- "type": "object",
- "id": "GuestAttributesEntry",
- "properties": {
- "namespace": {
- "type": "string",
- "description": "Namespace for the guest attribute entry."
- },
- "key": {
- "description": "Key for the guest attribute entry.",
- "type": "string"
- },
- "value": {
- "description": "Value for the guest attribute entry.",
- "type": "string"
- }
- },
- "description": "A guest attributes namespace/key/value entry."
- },
- "InterconnectOutageNotification": {
- "id": "InterconnectOutageNotification",
- "type": "object",
- "properties": {
- "state": {
- "description": "State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with \"NS_\" have been deprecated in favor of the unprefixed values.",
- "enumDescriptions": [
- "This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.",
- "The outage associated with this notification was cancelled before the outage was due to start.",
- "The outage associated with this notification is complete.",
- "[Deprecated] This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.",
- "[Deprecated] The outage associated with this notification was canceled before the outage was due to start."
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "enum": [
- "ACTIVE",
- "CANCELLED",
- "COMPLETED",
- "NS_ACTIVE",
- "NS_CANCELED"
- ]
- },
- "affectedCircuits": {
- "type": "array",
- "items": {
- "type": "string"
+ "request": {
+ "$ref": "InstanceGroupManagersDeleteInstancesRequest"
+ },
+ "response": {
+ "$ref": "Operation"
},
- "description": "If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected."
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
+ "description": "Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
+ "httpMethod": "POST"
},
- "issueType": {
- "enum": [
- "IT_OUTAGE",
- "IT_PARTIAL_OUTAGE",
- "OUTAGE",
- "PARTIAL_OUTAGE"
+ "setInstanceTemplate": {
+ "request": {
+ "$ref": "InstanceGroupManagersSetInstanceTemplateRequest"
+ },
+ "parameters": {
+ "instanceGroupManager": {
+ "required": true,
+ "description": "The name of the managed instance group.",
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "zone": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "The name of the zone where the managed instance group is located."
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
+ "httpMethod": "POST",
+ "id": "compute.instanceGroupManagers.setInstanceTemplate",
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with \"IT_\" have been deprecated in favor of the unprefixed values.",
- "enumDescriptions": [
- "[Deprecated] The Interconnect may be completely out of service for some or all of the specified window.",
- "[Deprecated] Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth.",
- "The Interconnect may be completely out of service for some or all of the specified window.",
- "Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth."
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
],
- "type": "string"
- },
- "startTime": {
- "description": "Scheduled start time for the outage (milliseconds since Unix epoch).",
- "type": "string",
- "format": "int64"
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate"
},
- "source": {
- "enum": [
- "GOOGLE",
- "NSRC_GOOGLE"
+ "delete": {
+ "parameters": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "zone": {
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone where the managed instance group is located.",
+ "type": "string"
+ },
+ "instanceGroupManager": {
+ "required": true,
+ "description": "The name of the managed instance group to delete.",
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.instanceGroupManagers.delete",
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.",
- "type": "string",
- "enumDescriptions": [
- "This notification was generated by Google.",
- "[Deprecated] This notification was generated by Google."
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
]
},
- "endTime": {
- "type": "string",
- "description": "Scheduled end time for the outage (milliseconds since Unix epoch).",
- "format": "int64"
- },
- "description": {
- "type": "string",
- "description": "A description about the purpose of the outage."
- },
- "name": {
- "description": "Unique identifier for this outage notification.",
- "type": "string"
- }
- },
- "description": "Description of a planned outage on this Interconnect."
- },
- "NetworkEdgeSecurityService": {
- "properties": {
- "securityPolicy": {
- "type": "string",
- "description": "The resource URL for the network edge security service associated with this network edge security service."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "region": {
- "description": "[Output Only] URL of the region where the resource 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"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "fingerprint": {
- "description": "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 NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.",
- "format": "byte",
- "type": "string"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "name": {
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices",
- "default": "compute#networkEdgeSecurityService"
- },
- "selfLinkWithId": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource with the resource id."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- }
- },
- "type": "object",
- "id": "NetworkEdgeSecurityService",
- "description": "Represents a Google Cloud Armor network edge security service resource."
- },
- "CommitmentList": {
- "properties": {
- "items": {
- "items": {
- "$ref": "Commitment"
+ "insert": {
+ "request": {
+ "$ref": "InstanceGroupManager"
},
- "description": "A list of Commitment resources.",
- "type": "array"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "kind": {
- "type": "string",
- "default": "compute#commitmentList",
- "description": "[Output Only] Type of resource. Always compute#commitmentList for lists of commitments."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "id": "compute.instanceGroupManagers.insert",
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "httpMethod": "POST",
+ "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the zone where you want to create the managed instance group.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ }
+ },
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers"
},
- "warning": {
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "list": {
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers",
+ "id": "compute.instanceGroupManagers.list",
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "parameters": {
+ "project": {
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "maxResults": {
+ "location": "query",
+ "format": "uint32",
+ "minimum": "0",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "location": "query"
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- }
+ "zone": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The name of the zone where the managed instance group is located."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ }
+ },
+ "httpMethod": "GET",
+ "description": "Retrieves a list of managed instance groups that are contained within the specified project and zone.",
+ "response": {
+ "$ref": "InstanceGroupManagerList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers"
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "InstanceGroupManager"
+ },
+ "id": "compute.instanceGroupManagers.get",
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
+ "parameters": {
+ "zone": {
+ "type": "string",
+ "location": "path",
+ "description": "The name of the zone where the managed instance group is located.",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "instanceGroupManager": {
+ "description": "The name of the managed instance group.",
+ "required": true,
+ "location": "path",
"type": "string"
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ],
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}"
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- }
- },
- "type": "object",
- "id": "CommitmentList",
- "description": "Contains a list of Commitment resources."
- },
- "TargetPoolsScopedList": {
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "updatePerInstanceConfigs": {
+ "id": "compute.instanceGroupManagers.updatePerInstanceConfigs",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "parameters": {
+ "instanceGroupManager": {
+ "description": "The name of the managed instance group. It should conform to RFC1035.",
+ "type": "string",
+ "location": "path",
+ "required": true
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
"type": "string"
},
- "code": {
- "type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "zone": {
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.",
+ "type": "string"
}
},
- "description": "Informational warning which replaces the list of addresses when the list is empty."
+ "description": "Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.",
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "InstanceGroupManagersUpdatePerInstanceConfigsReq"
+ },
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ]
},
- "targetPools": {
- "items": {
- "$ref": "TargetPool"
+ "recreateInstances": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. 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 removed or deleted. You can specify a maximum of 1000 instances with this method per request.",
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the zone where the managed instance group is located."
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "instanceGroupManager": {
+ "description": "The name of the managed instance group.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ }
},
- "description": "A list of target pools contained in this scope.",
- "type": "array"
- }
- },
- "id": "TargetPoolsScopedList",
- "type": "object"
- },
- "Int64RangeMatch": {
- "id": "Int64RangeMatch",
- "description": "HttpRouteRuleMatch criteria for field values that must stay within the specified integer range.",
- "properties": {
- "rangeEnd": {
- "description": "The end of the range (exclusive) in signed long integer format.",
- "format": "int64",
- "type": "string"
+ "request": {
+ "$ref": "InstanceGroupManagersRecreateInstancesRequest"
+ },
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
+ "id": "compute.instanceGroupManagers.recreateInstances",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ]
},
- "rangeStart": {
- "description": "The start of the range (inclusive) in signed long integer format.",
- "type": "string",
- "format": "int64"
- }
- },
- "type": "object"
- },
- "InstanceGroupManagerStatusStateful": {
- "properties": {
- "perInstanceConfigs": {
- "$ref": "InstanceGroupManagerStatusStatefulPerInstanceConfigs",
- "description": "[Output Only] Status of per-instance configurations on the instance."
+ "patch": {
+ "id": "compute.instanceGroupManagers.patch",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ],
+ "description": "Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.",
+ "httpMethod": "PATCH",
+ "request": {
+ "$ref": "InstanceGroupManager"
+ },
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the zone where you want to create the managed instance group."
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ },
+ "instanceGroupManager": {
+ "location": "path",
+ "description": "The name of the instance group manager.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}"
},
- "hasStatefulConfig": {
- "type": "boolean",
- "description": "[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions."
+ "deletePerInstanceConfigs": {
+ "description": "Deletes selected per-instance configurations for the managed instance group.",
+ "id": "compute.instanceGroupManagers.deletePerInstanceConfigs",
+ "parameters": {
+ "instanceGroupManager": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the managed instance group. It should conform to RFC1035."
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "zone": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035."
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instanceGroupManager"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs",
+ "request": {
+ "$ref": "InstanceGroupManagersDeletePerInstanceConfigsReq"
+ },
+ "httpMethod": "POST",
+ "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs"
}
- },
- "type": "object",
- "id": "InstanceGroupManagerStatusStateful"
+ }
},
- "BackendBucketList": {
- "description": "Contains a list of BackendBucket resources.",
- "type": "object",
- "id": "BackendBucketList",
- "properties": {
- "items": {
- "description": "A list of BackendBucket resources.",
- "type": "array",
- "items": {
- "$ref": "BackendBucket"
- }
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "networkAttachments": {
+ "methods": {
+ "aggregatedList": {
+ "id": "compute.networkAttachments.aggregatedList",
+ "parameterOrder": [
+ "project"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "type": "integer",
+ "minimum": "0",
+ "default": "500"
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ }
+ },
+ "flatPath": "projects/{project}/aggregated/networkAttachments",
+ "response": {
+ "$ref": "NetworkAttachmentAggregatedList"
+ },
+ "description": "Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.",
+ "path": "projects/{project}/aggregated/networkAttachments",
+ "httpMethod": "GET"
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "request": {
+ "$ref": "RegionSetPolicyRequest"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy",
+ "id": "compute.networkAttachments.setIamPolicy",
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name or id of the resource for this request."
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The name of the region for this request."
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true
+ }
+ },
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy"
},
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "getIamPolicy": {
+ "id": "compute.networkAttachments.getIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "optionsRequestedPolicyVersion": {
+ "location": "query",
+ "type": "integer",
+ "description": "Requested IAM Policy version.",
+ "format": "int32"
+ },
+ "resource": {
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string"
},
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "region": {
+ "required": true,
+ "location": "path",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "The name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
}
+ },
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy",
+ "path": "projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy",
+ "response": {
+ "$ref": "Policy"
}
},
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "default": "compute#backendBucketList",
- "type": "string",
- "description": "Type of resource."
- }
- }
- },
- "InstanceGroupManagersListErrorsResponse": {
- "type": "object",
- "properties": {
- "items": {
- "items": {
- "$ref": "InstanceManagedByIgmError"
+ "testIamPermissions": {
+ "id": "compute.networkAttachments.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "path": "projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions",
+ "request": {
+ "$ref": "TestPermissionsRequest"
},
- "type": "array",
- "description": "[Output Only] The list of errors of the managed instance group."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- }
- },
- "id": "InstanceGroupManagersListErrorsResponse"
- },
- "PacketMirroringsScopedList": {
- "type": "object",
- "properties": {
- "warning": {
- "properties": {
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- }
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name or id of the resource for this request."
},
- "message": {
+ "region": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "The name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "project": {
+ "description": "Project ID for this request.",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true
}
},
- "description": "Informational warning which replaces the list of packetMirrorings when the list is empty.",
- "type": "object"
- },
- "packetMirrorings": {
- "type": "array",
- "items": {
- "$ref": "PacketMirroring"
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestPermissionsResponse"
},
- "description": "A list of packetMirrorings contained in this scope."
- }
- },
- "id": "PacketMirroringsScopedList"
- },
- "Duration": {
- "description": "A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years.",
- "type": "object",
- "properties": {
- "nanos": {
- "type": "integer",
- "format": "int32",
- "description": "Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive."
+ "flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions"
},
- "seconds": {
- "format": "int64",
- "type": "string",
- "description": "Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years"
- }
- },
- "id": "Duration"
- },
- "NetworkEndpointGroupList": {
- "type": "object",
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "delete": {
+ "description": "Deletes the specified NetworkAttachment in the given scope",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
+ "parameters": {
+ "requestId": {
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "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",
+ "location": "query"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "region": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the region of this request.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "networkAttachment": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the NetworkAttachment resource to delete.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
}
},
- "description": "[Output Only] Informational warning message."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "kind": {
- "type": "string",
- "default": "compute#networkEndpointGroupList",
- "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists."
+ "parameterOrder": [
+ "project",
+ "region",
+ "networkAttachment"
+ ],
+ "id": "compute.networkAttachments.delete",
+ "flatPath": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}"
},
- "items": {
- "description": "A list of NetworkEndpointGroup resources.",
- "items": {
- "$ref": "NetworkEndpointGroup"
+ "insert": {
+ "flatPath": "projects/{project}/regions/{region}/networkAttachments",
+ "request": {
+ "$ref": "NetworkAttachment"
},
- "type": "array"
- }
- },
- "id": "NetworkEndpointGroupList"
- },
- "HttpFaultAbort": {
- "description": "Specification for how requests are aborted as part of fault injection.",
- "type": "object",
- "id": "HttpFaultAbort",
- "properties": {
- "percentage": {
- "format": "double",
- "type": "number",
- "description": "The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive."
- },
- "httpStatus": {
- "description": "The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.",
- "type": "integer",
- "format": "uint32"
- }
- }
- },
- "TargetHttpsProxiesSetSslCertificatesRequest": {
- "properties": {
- "sslCertificates": {
- "items": {
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates."
- }
- },
- "id": "TargetHttpsProxiesSetSslCertificatesRequest",
- "type": "object"
- },
- "InstanceGroupManagerStatusStatefulPerInstanceConfigs": {
- "id": "InstanceGroupManagerStatusStatefulPerInstanceConfigs",
- "type": "object",
- "properties": {
- "allEffective": {
- "type": "boolean",
- "description": "A bit indicating if all of the group's per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs."
- }
- }
- },
- "RouterNatRuleAction": {
- "properties": {
- "sourceNatDrainIps": {
- "items": {
- "type": "string"
+ "path": "projects/{project}/regions/{region}/networkAttachments",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "parameters": {
+ "region": {
+ "description": "Name of the region of this request.",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "requestId": {
+ "type": "string",
+ "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",
+ "location": "query"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true
+ }
},
- "description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only. This field is used for public NAT.",
- "type": "array"
+ "id": "compute.networkAttachments.insert"
},
- "sourceNatActiveIps": {
- "items": {
- "type": "string"
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project",
+ "region",
+ "networkAttachment"
+ ],
+ "response": {
+ "$ref": "NetworkAttachment"
},
- "type": "array",
- "description": "A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT."
- }
- },
- "type": "object",
- "id": "RouterNatRuleAction"
- },
- "TargetTcpProxyList": {
- "id": "TargetTcpProxyList",
- "type": "object",
- "properties": {
- "warning": {
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "description": "Returns the specified NetworkAttachment resource in the given scope.",
+ "flatPath": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- }
+ "networkAttachment": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the NetworkAttachment resource to return."
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "region": {
+ "description": "Name of the region of this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
"type": "string"
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "items": {
- "description": "A list of TargetTcpProxy resources.",
- "type": "array",
- "items": {
- "$ref": "TargetTcpProxy"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "type": "string",
- "default": "compute#targetTcpProxyList",
- "description": "Type of resource."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- },
- "description": "Contains a list of TargetTcpProxy resources."
- },
- "SSLHealthCheck": {
- "type": "object",
- "properties": {
- "port": {
- "format": "int32",
- "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.",
- "type": "integer"
- },
- "portSpecification": {
- "type": "string",
- "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.",
- "enumDescriptions": [
- "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
- "Not supported.",
- "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
+ "path": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "USE_FIXED_PORT",
- "USE_NAMED_PORT",
- "USE_SERVING_PORT"
- ]
+ "id": "compute.networkAttachments.get"
},
- "request": {
- "type": "string",
- "description": "Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection and SSL handshake."
- },
- "proxyHeader": {
- "enum": [
- "NONE",
- "PROXY_V1"
+ "list": {
+ "flatPath": "projects/{project}/regions/{region}/networkAttachments",
+ "parameters": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "minimum": "0",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "type": "integer"
+ },
+ "region": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region of this request."
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "description": "Lists the NetworkAttachments for a project in the given scope.",
+ "path": "projects/{project}/regions/{region}/networkAttachments",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
- "enumDescriptions": [
- "",
- ""
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string"
- },
- "response": {
- "description": "Creates a content-based SSL health check. In addition to establishing a TCP connection and the TLS handshake, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp",
- "type": "string"
- },
- "portName": {
- "type": "string",
- "description": "Not supported."
+ "response": {
+ "$ref": "NetworkAttachmentList"
+ },
+ "id": "compute.networkAttachments.list"
}
- },
- "id": "SSLHealthCheck"
+ }
},
- "Commitment": {
- "id": "Commitment",
- "description": "Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.",
- "type": "object",
- "properties": {
- "plan": {
- "enum": [
- "INVALID",
- "THIRTY_SIX_MONTH",
- "TWELVE_MONTH"
+ "regionOperations": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified region-specific Operations resource.",
+ "flatPath": "projects/{project}/regions/{region}/operations/{operation}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "operation"
],
- "enumDescriptions": [
- "",
- "",
- ""
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "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."
- },
- "licenseResource": {
- "$ref": "LicenseResourceCommitment",
- "description": "The license specification required as part of a license commitment."
- },
- "reservations": {
- "type": "array",
- "description": "List of reservations in this commitment.",
- "items": {
- "$ref": "Reservation"
- }
- },
- "autoRenew": {
- "description": "Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.",
- "type": "boolean"
- },
- "mergeSourceCommitments": {
- "type": "array",
- "items": {
- "type": "string"
+ "id": "compute.regionOperations.delete",
+ "parameters": {
+ "operation": {
+ "description": "Name of the Operations resource to delete.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "region": {
+ "description": "Name of the region for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
+ }
},
- "description": "List of source commitments to be merged into a new commitment."
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable explanation of the status."
- },
- "splitSourceCommitment": {
- "type": "string",
- "description": "Source commitment to be splitted into a new commitment."
+ "path": "projects/{project}/regions/{region}/operations/{operation}",
+ "httpMethod": "DELETE"
},
- "resources": {
- "items": {
- "$ref": "ResourceCommitment"
+ "list": {
+ "parameters": {
+ "region": {
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "Name of the region for this request."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "location": "query",
+ "minimum": "0",
+ "default": "500",
+ "format": "uint32"
+ }
},
- "type": "array",
- "description": "A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together."
- },
- "category": {
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
+ "parameterOrder": [
+ "project",
+ "region"
],
- "description": "The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.",
- "enum": [
- "CATEGORY_UNSPECIFIED",
- "LICENSE",
- "MACHINE"
- ]
- },
- "startTimestamp": {
- "type": "string",
- "description": "[Output Only] Commitment start time in RFC3339 text format."
- },
- "id": {
- "type": "string",
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
- },
- "region": {
- "description": "[Output Only] URL of the region where this commitment may be used.",
- "type": "string"
- },
- "endTimestamp": {
- "type": "string",
- "description": "[Output Only] Commitment end time in RFC3339 text format."
- },
- "status": {
- "type": "string",
- "enum": [
- "ACTIVE",
- "CANCELLED",
- "CREATING",
- "EXPIRED",
- "NOT_YET_ACTIVE"
+ "description": "Retrieves a list of Operation resources contained within the specified region.",
+ "response": {
+ "$ref": "OperationList"
+ },
+ "path": "projects/{project}/regions/{region}/operations",
+ "id": "compute.regionOperations.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "kind": {
- "type": "string",
- "default": "compute#commitment",
- "description": "[Output Only] Type of the resource. Always compute#commitment for commitments."
+ "flatPath": "projects/{project}/regions/{region}/operations",
+ "httpMethod": "GET"
},
- "type": {
- "enum": [
- "ACCELERATOR_OPTIMIZED",
- "COMPUTE_OPTIMIZED",
- "COMPUTE_OPTIMIZED_C2D",
- "GENERAL_PURPOSE",
- "GENERAL_PURPOSE_E2",
- "GENERAL_PURPOSE_N2",
- "GENERAL_PURPOSE_N2D",
- "GENERAL_PURPOSE_T2D",
- "MEMORY_OPTIMIZED",
- "MEMORY_OPTIMIZED_M3",
- "TYPE_UNSPECIFIED"
- ],
- "description": "The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
+ "wait": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "parameters": {
+ "operation": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "description": "Name of the Operations resource to return.",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "region": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true,
+ "description": "Name of the region for this request."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string"
+ "id": "compute.regionOperations.wait",
+ "path": "projects/{project}/regions/{region}/operations/{operation}/wait",
+ "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ",
+ "parameterOrder": [
+ "project",
+ "region",
+ "operation"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/operations/{operation}/wait"
},
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
+ "get": {
+ "parameters": {
+ "operation": {
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the Operations resource to return.",
+ "type": "string"
+ },
+ "region": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region for this request."
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "path": "projects/{project}/regions/{region}/operations/{operation}",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project",
+ "region",
+ "operation"
+ ],
+ "description": "Retrieves the specified region-specific Operations resource.",
+ "id": "compute.regionOperations.get",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/operations/{operation}"
}
}
},
- "AcceleratorTypeAggregatedList": {
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "kind": {
- "default": "compute#acceleratorTypeAggregatedList",
- "description": "[Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types.",
- "type": "string"
- },
- "unreachables": {
- "type": "array",
- "items": {
- "type": "string"
+ "regionBackendServices": {
+ "methods": {
+ "get": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "backendService"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}",
+ "path": "projects/{project}/regions/{region}/backendServices/{backendService}",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "backendService": {
+ "required": true,
+ "location": "path",
+ "description": "Name of the BackendService resource to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ }
},
- "description": "[Output Only] Unreachable resources."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "items": {
- "description": "A list of AcceleratorTypesScopedList resources.",
- "additionalProperties": {
- "description": "[Output Only] Name of the scope containing this set of accelerator types.",
- "$ref": "AcceleratorTypesScopedList"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.regionBackendServices.get",
+ "description": "Returns the specified regional BackendService resource.",
+ "response": {
+ "$ref": "BackendService"
},
- "type": "object"
+ "httpMethod": "GET"
},
- "warning": {
- "properties": {
- "data": {
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "path": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.regionBackendServices.setIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy",
+ "request": {
+ "$ref": "RegionSetPolicyRequest"
+ },
+ "parameters": {
+ "project": {
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "region": {
+ "required": true,
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "description": "The name of the region for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "resource": {
+ "location": "path",
+ "description": "Name or id of the resource for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string"
}
+ }
+ },
+ "update": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "backendService"
+ ],
+ "description": "Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .",
+ "response": {
+ "$ref": "Operation"
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- }
- },
- "id": "AcceleratorTypeAggregatedList",
- "type": "object"
- },
- "SubnetworksScopedList": {
- "properties": {
- "subnetworks": {
- "type": "array",
- "items": {
- "$ref": "Subnetwork"
+ "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}",
+ "id": "compute.regionBackendServices.update",
+ "path": "projects/{project}/regions/{region}/backendServices/{backendService}",
+ "request": {
+ "$ref": "BackendService"
},
- "description": "A list of subnetworks contained in this scope."
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "backendService": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name of the BackendService resource to update."
+ },
+ "region": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "httpMethod": "PUT"
},
- "warning": {
- "description": "An informational warning that appears when the list of addresses is empty.",
- "properties": {
- "code": {
+ "list": {
+ "parameters": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "location": "query"
},
- "data": {
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "project": {
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "maxResults": {
+ "location": "query",
+ "format": "uint32",
+ "type": "integer",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0"
+ },
+ "region": {
+ "location": "path",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"type": "string"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
}
},
- "type": "object"
- }
- },
- "id": "SubnetworksScopedList",
- "type": "object"
- },
- "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk": {
- "properties": {
- "diskSizeGb": {
- "format": "int64",
- "type": "string",
- "description": "Specifies the size of the disk in base-2 GB."
- },
- "interface": {
- "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.",
- "enum": [
- "NVME",
- "SCSI"
+ "response": {
+ "$ref": "BackendServiceList"
+ },
+ "description": "Retrieves the list of regional BackendService resources available to the specified project in the given region.",
+ "path": "projects/{project}/regions/{region}/backendServices",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "type": "string",
- "enumDescriptions": [
- "",
- ""
+ "id": "compute.regionBackendServices.list",
+ "flatPath": "projects/{project}/regions/{region}/backendServices",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
]
- }
- },
- "id": "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk",
- "type": "object"
- },
- "AttachedDiskInitializeParams": {
- "type": "object",
- "description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.",
- "properties": {
- "architecture": {
- "description": "The architecture of the attached disk. Valid values are arm64 or x86_64.",
- "enum": [
- "ARCHITECTURE_UNSPECIFIED",
- "ARM64",
- "X86_64"
+ },
+ "getIamPolicy": {
+ "parameters": {
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the region for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path"
+ },
+ "optionsRequestedPolicyVersion": {
+ "location": "query",
+ "description": "Requested IAM Policy version.",
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy",
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.regionBackendServices.getIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "path": "projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
],
- "type": "string",
- "enumDescriptions": [
- "Default value indicating Architecture is not set.",
- "Machines with architecture ARM64",
- "Machines with architecture X86_64"
- ]
- },
- "sourceImage": {
- "type": "string",
- "description": "The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set."
- },
- "description": {
- "type": "string",
- "description": "An optional description. Provide this property when creating the disk."
+ "httpMethod": "GET"
},
- "resourceManagerTags": {
- "description": "Resource manager tags to be bound to the disk. 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.",
- "additionalProperties": {
- "type": "string"
+ "getHealth": {
+ "request": {
+ "$ref": "ResourceGroupReference"
},
- "type": "object"
- },
- "resourcePolicies": {
- "type": "array",
- "description": "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.",
- "items": {
- "type": "string"
- }
- },
- "diskName": {
- "description": "Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.",
- "type": "string"
- },
- "sourceSnapshotEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "The customer-supplied encryption key of the source snapshot."
- },
- "onUpdateAction": {
- "enum": [
- "RECREATE_DISK",
- "RECREATE_DISK_IF_SOURCE_CHANGED",
- "USE_EXISTING_DISK"
+ "description": "Gets the most recent health check results for this regional BackendService.",
+ "path": "projects/{project}/regions/{region}/backendServices/{backendService}/getHealth",
+ "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}/getHealth",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "Specifies which action to take on instance update with this disk. Default is to use the existing disk.",
- "enumDescriptions": [
- "Always recreate the disk.",
- "Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.",
- "Use the existing disk, this is the default behaviour."
+ "parameterOrder": [
+ "project",
+ "region",
+ "backendService"
],
- "type": "string"
- },
- "licenses": {
- "type": "array",
- "description": "A list of publicly visible licenses. Reserved for Google's use.",
- "items": {
- "type": "string"
- }
- },
- "sourceImageEncryptionKey": {
- "$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. InstanceTemplate and InstancePropertiesPatch 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."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
+ "id": "compute.regionBackendServices.getHealth",
+ "parameters": {
+ "backendService": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "description": "Name of the BackendService resource for which to get health."
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the region scoping this request."
+ }
},
- "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"
- },
- "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"
- },
- "diskSizeGb": {
- "description": "Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.",
- "format": "int64",
- "type": "string"
- },
- "diskType": {
- "description": "Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.",
- "type": "string"
- },
- "provisionedIops": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- }
- },
- "id": "AttachedDiskInitializeParams"
- },
- "VpnGateway": {
- "properties": {
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.",
- "default": "compute#vpnGateway",
- "type": "string"
- },
- "vpnInterfaces": {
- "type": "array",
- "description": "The list of VPN interfaces associated with this VPN gateway.",
- "items": {
- "$ref": "VpnGatewayVpnGatewayInterface"
- }
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "labelFingerprint": {
- "type": "string",
- "description": "A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an VpnGateway.",
- "format": "byte"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.vpnGateways.insert"
- ]
+ "response": {
+ "$ref": "BackendServiceGroupHealth"
},
- "description": "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.",
- "type": "string"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
+ "httpMethod": "POST"
},
- "network": {
- "annotations": {
- "required": [
- "compute.vpnGateways.insert"
- ]
+ "insert": {
+ "request": {
+ "$ref": "BackendService"
},
- "description": "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.",
- "type": "string"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the VPN gateway resides."
- },
- "labels": {
- "type": "object",
- "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string",
- "format": "uint64"
- },
- "stackType": {
- "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.",
- "type": "string",
- "enumDescriptions": [
- "Enable VPN gateway with both IPv4 and IPv6 protocols.",
- "Enable VPN gateway with only IPv4 protocol."
+ "flatPath": "projects/{project}/regions/{region}/backendServices",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "IPV4_IPV6",
- "IPV4_ONLY"
- ]
- }
- },
- "type": "object",
- "id": "VpnGateway",
- "description": "Represents a HA VPN gateway. HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies ."
- },
- "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption": {
- "id": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption",
- "type": "object",
- "properties": {
- "headerName": {
- "type": "string",
- "description": "The name of the header to set."
- },
- "headerValue": {
- "type": "string",
- "description": "The value to set the named header to."
- }
- }
- },
- "InstanceConsumptionData": {
- "id": "InstanceConsumptionData",
- "properties": {
- "instance": {
- "description": "Server-defined URL for the instance.",
- "type": "string"
- },
- "consumptionInfo": {
- "description": "Resources consumed by the instance.",
- "$ref": "InstanceConsumptionInfo"
- }
- },
- "type": "object"
- },
- "TargetTcpProxiesSetProxyHeaderRequest": {
- "type": "object",
- "properties": {
- "proxyHeader": {
- "type": "string",
- "enum": [
- "NONE",
- "PROXY_V1"
+ "path": "projects/{project}/regions/{region}/backendServices",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "description": "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.",
- "enumDescriptions": [
- "",
- ""
- ]
- }
- },
- "id": "TargetTcpProxiesSetProxyHeaderRequest"
- },
- "ServiceAttachmentList": {
- "id": "ServiceAttachmentList",
- "properties": {
- "items": {
- "items": {
- "$ref": "ServiceAttachment"
- },
- "type": "array",
- "description": "A list of ServiceAttachment resources."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "default": "compute#serviceAttachmentList",
- "description": "[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "description": "Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.",
+ "httpMethod": "POST",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "project": {
+ "description": "Project ID for this request.",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
},
- "message": {
+ "region": {
+ "description": "Name of the region scoping this request.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
}
},
- "type": "object"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ShieldedInstanceIdentityEntry": {
- "properties": {
- "ekCert": {
- "description": "A PEM-encoded X.509 certificate. This field can be empty.",
- "type": "string"
+ "id": "compute.regionBackendServices.insert"
},
- "ekPub": {
- "type": "string",
- "description": "A PEM-encoded public key."
- }
- },
- "type": "object",
- "description": "A Shielded Instance Identity Entry.",
- "id": "ShieldedInstanceIdentityEntry"
- },
- "DiskTypeAggregatedList": {
- "id": "DiskTypeAggregatedList",
- "type": "object",
- "properties": {
- "unreachables": {
- "type": "array",
- "items": {
- "type": "string"
+ "patch": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "backendService"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "backendService": {
+ "description": "Name of the BackendService resource to patch.",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ }
},
- "description": "[Output Only] Unreachable resources."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "items": {
- "description": "A list of DiskTypesScopedList resources.",
- "type": "object",
- "additionalProperties": {
- "description": "[Output Only] Name of the scope containing this set of disk types.",
- "$ref": "DiskTypesScopedList"
+ "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}",
+ "id": "compute.regionBackendServices.patch",
+ "description": "Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "path": "projects/{project}/regions/{region}/backendServices/{backendService}",
+ "request": {
+ "$ref": "BackendService"
+ },
+ "response": {
+ "$ref": "Operation"
}
},
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#diskTypeAggregatedList.",
- "default": "compute#diskTypeAggregatedList",
- "type": "string"
- },
- "warning": {
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- }
+ "delete": {
+ "path": "projects/{project}/regions/{region}/backendServices/{backendService}",
+ "description": "Deletes the specified regional BackendService resource.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
},
- "message": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true,
+ "description": "Name of the region scoping this request."
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "backendService": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the BackendService resource to delete.",
+ "required": true,
"type": "string"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
+ "id": "compute.regionBackendServices.delete",
+ "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "project",
+ "region",
+ "backendService"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
}
}
},
- "AddressList": {
- "description": "Contains a list of addresses.",
- "id": "AddressList",
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "items": {
- "description": "A list of Address resources.",
- "items": {
- "$ref": "Address"
+ "networks": {
+ "methods": {
+ "listPeeringRoutes": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.networks.listPeeringRoutes",
+ "flatPath": "projects/{project}/global/networks/{network}/listPeeringRoutes",
+ "parameterOrder": [
+ "project",
+ "network"
+ ],
+ "path": "projects/{project}/global/networks/{network}/listPeeringRoutes",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ExchangedPeeringRoutesList"
},
- "type": "array"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "kind": {
- "default": "compute#addressList",
- "description": "[Output Only] Type of resource. Always compute#addressList for lists of addresses.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "warning": {
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "description": "Lists the peering routes exchanged over peering connection.",
+ "parameters": {
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "network": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the network for this request.",
+ "type": "string",
+ "required": true
+ },
+ "direction": {
+ "description": "The direction of the exchanged routes.",
"enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
+ "INCOMING",
+ "OUTGOING"
],
"type": "string",
"enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "For routes exported from peer network.",
+ "For routes exported from local network."
+ ],
+ "location": "query"
},
- "message": {
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "peeringName": {
+ "description": "The response will show routes exchanged over the given peering connection.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "query"
},
- "data": {
- "type": "array",
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "region": {
+ "type": "string",
+ "description": "The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region.",
+ "location": "query"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "maxResults": {
+ "type": "integer",
+ "format": "uint32",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
}
- },
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- }
- },
- "type": "object"
- },
- "RegionInstanceGroupManagerUpdateInstanceConfigReq": {
- "description": "RegionInstanceGroupManagers.updatePerInstanceConfigs",
- "type": "object",
- "properties": {
- "perInstanceConfigs": {
- "items": {
- "$ref": "PerInstanceConfig"
- },
- "type": "array",
- "description": "The list of per-instance configurations to insert or patch on this managed instance group."
- }
- },
- "id": "RegionInstanceGroupManagerUpdateInstanceConfigReq"
- },
- "PacketIntervals": {
- "id": "PacketIntervals",
- "description": "Next free: 7",
- "properties": {
- "type": {
- "enum": [
- "LOOPBACK",
- "RECEIVE",
- "TRANSMIT",
- "TYPE_UNSPECIFIED"
+ }
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enumDescriptions": [
- "Only applies to Echo packets. This shows the intervals between sending and receiving the same packet.",
- "Intervals between received packets.",
- "Intervals between transmitted packets.",
- ""
+ "path": "projects/{project}/global/networks/{network}",
+ "id": "compute.networks.get",
+ "flatPath": "projects/{project}/global/networks/{network}",
+ "description": "Returns the specified network. Gets a list of available networks by making a list() request.",
+ "parameterOrder": [
+ "project",
+ "network"
],
- "description": "The type of packets for which inter-packet intervals were computed.",
- "type": "string"
+ "httpMethod": "GET",
+ "parameters": {
+ "network": {
+ "description": "Name of the network to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "Network"
+ }
},
- "duration": {
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "From BfdSession object creation time.",
- ""
+ "list": {
+ "path": "projects/{project}/global/networks",
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/global/networks",
+ "id": "compute.networks.list",
+ "parameterOrder": [
+ "project"
],
- "description": "From how long ago in the past these intervals were observed.",
- "enum": [
- "DURATION_UNSPECIFIED",
- "HOUR",
- "MAX",
- "MINUTE"
- ]
- },
- "numIntervals": {
- "format": "int64",
- "type": "string",
- "description": "Number of inter-packet intervals from which these statistics were derived."
- },
- "avgMs": {
- "description": "Average observed inter-packet interval in milliseconds.",
- "type": "string",
- "format": "int64"
- },
- "maxMs": {
- "description": "Maximum observed inter-packet interval in milliseconds.",
- "type": "string",
- "format": "int64"
- },
- "minMs": {
- "format": "int64",
- "description": "Minimum observed inter-packet interval in milliseconds.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "FixedOrPercent": {
- "properties": {
- "calculated": {
- "type": "integer",
- "description": "[Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. ",
- "format": "int32"
- },
- "fixed": {
- "format": "int32",
- "type": "integer",
- "description": "Specifies a fixed number of VM instances. This must be a positive integer."
- },
- "percent": {
- "format": "int32",
- "type": "integer",
- "description": "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%."
- }
- },
- "type": "object",
- "id": "FixedOrPercent",
- "description": "Encapsulates numeric value that can be either absolute or relative."
- },
- "AdvancedMachineFeatures": {
- "properties": {
- "threadsPerCore": {
- "format": "int32",
- "type": "integer",
- "description": "The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed."
- },
- "enableNestedVirtualization": {
- "type": "boolean",
- "description": "Whether to enable nested virtualization or not (default is false)."
- },
- "enableUefiNetworking": {
- "description": "Whether to enable UEFI networking for instance creation.",
- "type": "boolean"
- },
- "visibleCoreCount": {
- "description": "The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.",
- "format": "int32",
- "type": "integer"
- }
- },
- "description": "Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled).",
- "type": "object",
- "id": "AdvancedMachineFeatures"
- },
- "HealthStatus": {
- "id": "HealthStatus",
- "properties": {
- "ipAddress": {
- "description": "For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.",
- "type": "string"
- },
- "forwardingRuleIp": {
- "description": "A forwarding rule IP address assigned to this instance.",
- "type": "string"
- },
- "instance": {
- "description": "URL of the instance resource.",
- "type": "string"
- },
- "port": {
- "type": "integer",
- "description": "The named port of the instance group, not necessarily the port that is health-checked.",
- "format": "int32"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves the list of networks available to the specified project.",
+ "parameters": {
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "location": "query",
+ "minimum": "0",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "format": "uint32"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "NetworkList"
+ }
},
- "weightError": {
- "type": "string",
- "enum": [
- "INVALID_WEIGHT",
- "MISSING_WEIGHT",
- "UNAVAILABLE_WEIGHT",
- "WEIGHT_NONE"
+ "patch": {
+ "description": "Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.",
+ "httpMethod": "PATCH",
+ "path": "projects/{project}/global/networks/{network}",
+ "parameters": {
+ "network": {
+ "required": true,
+ "description": "Name of the network to update.",
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ }
+ },
+ "request": {
+ "$ref": "Network"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation).",
- "The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight.",
- "This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN.",
- "This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight."
+ "id": "compute.networks.patch",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/networks/{network}",
+ "parameterOrder": [
+ "project",
+ "network"
]
},
- "forwardingRule": {
- "type": "string",
- "description": "URL of the forwarding rule associated with the health status of the instance."
- },
- "healthState": {
- "enum": [
- "HEALTHY",
- "UNHEALTHY"
+ "delete": {
+ "path": "projects/{project}/global/networks/{network}",
+ "parameterOrder": [
+ "project",
+ "network"
],
- "description": "Health state of the instance.",
- "enumDescriptions": [
- "",
- ""
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "network": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "description": "Name of the network to delete."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
- },
- "weight": {
- "type": "string"
- },
- "annotations": {
- "additionalProperties": {
- "type": "string"
+ "description": "Deletes the specified network.",
+ "response": {
+ "$ref": "Operation"
},
- "description": "Metadata defined as annotations for network endpoint.",
- "type": "object"
- }
- },
- "type": "object"
- },
- "InterconnectAttachmentPartnerMetadata": {
- "id": "InterconnectAttachmentPartnerMetadata",
- "properties": {
- "interconnectName": {
- "type": "string",
- "description": "Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance \"Chicago 1\". This value may be validated to match approved Partner values."
- },
- "portalUrl": {
- "description": "URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.",
- "type": "string"
- },
- "partnerName": {
- "description": "Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.",
- "type": "string"
- }
- },
- "type": "object",
- "description": "Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments."
- },
- "InstanceGroupManagerList": {
- "description": "[Output Only] A list of managed instance groups.",
- "id": "InstanceGroupManagerList",
- "properties": {
- "items": {
- "description": "A list of InstanceGroupManager resources.",
- "type": "array",
- "items": {
- "$ref": "InstanceGroupManager"
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "id": "compute.networks.delete",
+ "flatPath": "projects/{project}/global/networks/{network}",
+ "httpMethod": "DELETE"
},
- "warning": {
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
- },
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- }
+ "addPeering": {
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.networks.addPeering",
+ "description": "Adds a peering to the specified network.",
+ "flatPath": "projects/{project}/global/networks/{network}/addPeering",
+ "path": "projects/{project}/global/networks/{network}/addPeering",
+ "request": {
+ "$ref": "NetworksAddPeeringRequest"
+ },
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "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).",
+ "location": "query",
"type": "string"
+ },
+ "network": {
+ "description": "Name of the network resource to add peering to.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- },
- "kind": {
- "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.",
- "type": "string",
- "default": "compute#instanceGroupManagerList"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "SslCertificateAggregatedList": {
- "id": "SslCertificateAggregatedList",
- "type": "object",
- "properties": {
- "items": {
- "type": "object",
- "description": "A list of SslCertificatesScopedList resources.",
- "additionalProperties": {
- "$ref": "SslCertificatesScopedList",
- "description": "Name of the scope containing this set of SslCertificates."
+ "parameterOrder": [
+ "project",
+ "network"
+ ],
+ "response": {
+ "$ref": "Operation"
}
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
+ "getEffectiveFirewalls": {
+ "description": "Returns the effective firewalls on a given network.",
+ "flatPath": "projects/{project}/global/networks/{network}/getEffectiveFirewalls",
+ "parameterOrder": [
+ "project",
+ "network"
+ ],
+ "parameters": {
+ "network": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the network for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.networks.getEffectiveFirewalls",
+ "path": "projects/{project}/global/networks/{network}/getEffectiveFirewalls",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "NetworksGetEffectiveFirewallsResponse"
+ }
},
- "warning": {
- "properties": {
- "message": {
+ "updatePeering": {
+ "parameters": {
+ "network": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Name of the network resource which the updated peering is belonging to."
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "type": "string"
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "unreachables": {
- "type": "array",
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
- }
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.",
- "default": "compute#sslCertificateAggregatedList",
- "type": "string"
- }
- }
- },
- "RouterStatusNatStatusNatRuleStatus": {
- "id": "RouterStatusNatStatusNatRuleStatus",
- "description": "Status of a NAT Rule contained in this NAT.",
- "properties": {
- "drainNatIps": {
- "items": {
- "type": "string"
+ "description": "Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field.",
+ "id": "compute.networks.updatePeering",
+ "response": {
+ "$ref": "Operation"
},
- "description": "A list of IPs for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].",
- "type": "array"
- },
- "minExtraIpsNeeded": {
- "format": "int32",
- "type": "integer",
- "description": "The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT."
- },
- "ruleNumber": {
- "description": "Rule number of the rule.",
- "type": "integer",
- "format": "int32"
- },
- "numVmEndpointsWithNatMappings": {
- "type": "integer",
- "description": "Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.",
- "format": "int32"
+ "parameterOrder": [
+ "project",
+ "network"
+ ],
+ "path": "projects/{project}/global/networks/{network}/updatePeering",
+ "flatPath": "projects/{project}/global/networks/{network}/updatePeering",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "PATCH",
+ "request": {
+ "$ref": "NetworksUpdatePeeringRequest"
+ }
},
- "activeNatIps": {
- "description": "A list of active IPs for NAT. Example: [\"1.1.1.1\", \"179.12.26.133\"].",
- "items": {
- "type": "string"
+ "switchToCustomMode": {
+ "id": "compute.networks.switchToCustomMode",
+ "flatPath": "projects/{project}/global/networks/{network}/switchToCustomMode",
+ "parameterOrder": [
+ "project",
+ "network"
+ ],
+ "path": "projects/{project}/global/networks/{network}/switchToCustomMode",
+ "description": "Switches the network mode from auto subnet mode to custom subnet mode.",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- }
- },
- "type": "object"
- },
- "SslPoliciesAggregatedList": {
- "type": "object",
- "properties": {
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "requestId": {
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "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"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "network": {
+ "type": "string",
+ "location": "path",
+ "description": "Name of the network to be updated.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ }
+ }
+ },
+ "removePeering": {
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string"
},
- "data": {
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "network": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the network resource to remove peering from.",
+ "type": "string",
+ "location": "path"
}
+ },
+ "flatPath": "projects/{project}/global/networks/{network}/removePeering",
+ "id": "compute.networks.removePeering",
+ "request": {
+ "$ref": "NetworksRemovePeeringRequest"
+ },
+ "parameterOrder": [
+ "project",
+ "network"
+ ],
+ "path": "projects/{project}/global/networks/{network}/removePeering",
+ "description": "Removes a peering from the specified network.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
}
},
- "items": {
- "description": "A list of SslPoliciesScopedList resources.",
- "additionalProperties": {
- "$ref": "SslPoliciesScopedList",
- "description": "Name of the scope containing this set of SSL policies."
+ "insert": {
+ "flatPath": "projects/{project}/global/networks",
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ }
},
- "type": "object"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "unreachables": {
- "type": "array",
- "items": {
- "type": "string"
+ "httpMethod": "POST",
+ "path": "projects/{project}/global/networks",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Creates a network in the specified project using the data included in the request.",
+ "parameterOrder": [
+ "project"
+ ],
+ "id": "compute.networks.insert",
+ "response": {
+ "$ref": "Operation"
},
- "description": "[Output Only] Unreachable resources."
- },
- "etag": {
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "default": "compute#sslPoliciesAggregatedList",
- "description": "[Output Only] Type of resource. Always compute#sslPolicyAggregatedList for lists of SSL Policies."
+ "request": {
+ "$ref": "Network"
+ }
}
- },
- "id": "SslPoliciesAggregatedList"
+ }
},
- "SecurityPolicyAdvancedOptionsConfig": {
- "id": "SecurityPolicyAdvancedOptionsConfig",
- "type": "object",
- "properties": {
- "jsonParsing": {
- "enum": [
- "DISABLED",
- "STANDARD"
+ "regionDiskTypes": {
+ "methods": {
+ "get": {
+ "description": "Returns the specified regional disk type. Gets a list of available disk types by making a list() request.",
+ "httpMethod": "GET",
+ "path": "projects/{project}/regions/{region}/diskTypes/{diskType}",
+ "id": "compute.regionDiskTypes.get",
+ "parameterOrder": [
+ "project",
+ "region",
+ "diskType"
],
- "type": "string",
- "enumDescriptions": [
- "",
- ""
+ "parameters": {
+ "region": {
+ "description": "The name of the region for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "diskType": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the disk type to return.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
+ },
+ "flatPath": "projects/{project}/regions/{region}/diskTypes/{diskType}",
+ "response": {
+ "$ref": "DiskType"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
]
},
- "jsonCustomConfig": {
- "$ref": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig",
- "description": "Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD."
- },
- "logLevel": {
- "enumDescriptions": [
- "",
- ""
+ "list": {
+ "description": "Retrieves a list of regional disk types available to the specified project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "RegionDiskTypeList"
+ },
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "region": {
+ "description": "The name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "maxResults": {
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "default": "500",
+ "location": "query",
+ "minimum": "0"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region"
],
- "type": "string",
- "enum": [
- "NORMAL",
- "VERBOSE"
+ "path": "projects/{project}/regions/{region}/diskTypes",
+ "flatPath": "projects/{project}/regions/{region}/diskTypes",
+ "id": "compute.regionDiskTypes.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
- "PathRule": {
- "description": "A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.",
- "type": "object",
- "id": "PathRule",
- "properties": {
- "urlRedirect": {
- "$ref": "HttpRedirectAction",
- "description": "When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy."
- },
- "service": {
- "type": "string",
- "description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set."
- },
- "paths": {
- "type": "array",
- "items": {
- "type": "string"
+ "backendBuckets": {
+ "methods": {
+ "deleteSignedUrlKey": {
+ "path": "projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey",
+ "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
},
- "description": "The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here."
- },
- "routeAction": {
- "$ref": "HttpRouteAction",
- "description": "In response to a matching path, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a path rule's routeAction."
- }
- }
- },
- "PacketMirroringMirroredResourceInfoSubnetInfo": {
- "id": "PacketMirroringMirroredResourceInfoSubnetInfo",
- "type": "object",
- "properties": {
- "canonicalUrl": {
- "description": "[Output Only] Unique identifier for the subnetwork; defined by the server.",
- "type": "string"
- },
- "url": {
- "type": "string",
- "description": "Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored."
- }
- }
- },
- "RegionInstanceGroupManagerList": {
- "description": "Contains a list of managed instance groups.",
- "properties": {
- "kind": {
- "default": "compute#regionInstanceGroupManagerList",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "items": {
- "description": "A list of InstanceGroupManager resources.",
- "type": "array",
- "items": {
- "$ref": "InstanceGroupManager"
- }
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "backendBucket": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035."
+ },
+ "keyName": {
+ "required": true,
+ "location": "query",
+ "type": "string",
+ "description": "The name of the Signed URL Key to delete."
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "backendBucket",
+ "keyName"
+ ],
+ "description": "Deletes a key for validating requests with signed URLs for this backend bucket.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.backendBuckets.deleteSignedUrlKey"
},
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- }
+ "update": {
+ "id": "compute.backendBuckets.update",
+ "parameterOrder": [
+ "project",
+ "backendBucket"
+ ],
+ "httpMethod": "PUT",
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Updates the specified BackendBucket resource with the data included in the request.",
+ "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path"
+ },
+ "backendBucket": {
+ "type": "string",
+ "description": "Name of the BackendBucket resource to update.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ }
+ },
+ "path": "projects/{project}/global/backendBuckets/{backendBucket}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "BackendBucket"
+ }
+ },
+ "setEdgeSecurityPolicy": {
+ "httpMethod": "POST",
+ "description": "Sets the edge security policy for the specified backend bucket.",
+ "id": "compute.backendBuckets.setEdgeSecurityPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "SecurityPolicyReference"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy",
+ "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy",
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request."
},
- "message": {
+ "backendBucket": {
+ "description": "Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "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"
}
- }
- }
- },
- "id": "RegionInstanceGroupManagerList",
- "type": "object"
- },
- "ResourcePolicyGroupPlacementPolicy": {
- "description": "A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality",
- "properties": {
- "vmCount": {
- "format": "int32",
- "type": "integer",
- "description": "Number of VMs in this placement group. Google does not recommend that you use this field unless you use a compact policy and you want your policy to work only if it contains this exact number of VMs."
+ },
+ "parameterOrder": [
+ "project",
+ "backendBucket"
+ ]
},
- "collocation": {
- "enumDescriptions": [
- "",
- ""
+ "get": {
+ "path": "projects/{project}/global/backendBuckets/{backendBucket}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "Specifies network collocation",
- "enum": [
- "COLLOCATED",
- "UNSPECIFIED_COLLOCATION"
+ "parameters": {
+ "backendBucket": {
+ "type": "string",
+ "description": "Name of the BackendBucket resource to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "backendBucket"
],
- "type": "string"
- },
- "availabilityDomainCount": {
- "description": "The number of availability domains to spread instances across. If two instances are in different availability domain, they are not in the same low latency network.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ResourcePolicyGroupPlacementPolicy",
- "type": "object"
- },
- "PublicAdvertisedPrefixList": {
- "properties": {
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.",
- "default": "compute#publicAdvertisedPrefixList",
- "type": "string"
- },
- "items": {
- "items": {
- "$ref": "PublicAdvertisedPrefix"
+ "id": "compute.backendBuckets.get",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "BackendBucket"
},
- "description": "A list of PublicAdvertisedPrefix resources.",
- "type": "array"
+ "description": "Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.",
+ "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}"
},
- "warning": {
- "properties": {
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- }
- },
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "patch": {
+ "path": "projects/{project}/global/backendBuckets/{backendBucket}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "BackendBucket"
+ },
+ "parameters": {
+ "backendBucket": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the BackendBucket resource to patch.",
+ "location": "path",
"type": "string"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
"type": "string"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "backendBucket"
+ ],
+ "httpMethod": "PATCH",
+ "id": "compute.backendBuckets.patch",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}"
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "list": {
+ "parameters": {
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "default": "500",
+ "location": "query",
+ "type": "integer",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "httpMethod": "GET",
+ "description": "Retrieves the list of BackendBucket resources available to the specified project.",
+ "path": "projects/{project}/global/backendBuckets",
+ "response": {
+ "$ref": "BackendBucketList"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.backendBuckets.list",
+ "flatPath": "projects/{project}/global/backendBuckets"
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- },
- "id": "PublicAdvertisedPrefixList",
- "type": "object"
- },
- "NetworkEndpointGroupsScopedList": {
- "id": "NetworkEndpointGroupsScopedList",
- "properties": {
- "warning": {
- "type": "object",
- "description": "[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.",
- "properties": {
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "addSignedUrlKey": {
+ "request": {
+ "$ref": "SignedUrlKey"
+ },
+ "path": "projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey",
+ "description": "Adds a key for validating requests with signed URLs for this backend bucket.",
+ "id": "compute.backendBuckets.addSignedUrlKey",
+ "parameterOrder": [
+ "project",
+ "backendBucket"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "backendBucket": {
+ "location": "path",
+ "description": "Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.",
+ "type": "string",
+ "required": true
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "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).",
+ "location": "query",
"type": "string"
}
- }
- },
- "networkEndpointGroups": {
- "description": "[Output Only] The list of network endpoint groups that are contained in this scope.",
- "type": "array",
- "items": {
- "$ref": "NetworkEndpointGroup"
- }
- }
- },
- "type": "object"
- },
- "InstanceList": {
- "id": "InstanceList",
- "type": "object",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.",
- "default": "compute#instanceList",
- "type": "string"
- },
- "items": {
- "description": "A list of Instance resources.",
- "type": "array",
- "items": {
- "$ref": "Instance"
- }
- },
- "warning": {
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ },
+ "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.backendBuckets.delete",
+ "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}",
+ "parameterOrder": [
+ "project",
+ "backendBucket"
+ ],
+ "path": "projects/{project}/global/backendBuckets/{backendBucket}",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string"
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- }
+ "backendBucket": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "description": "Name of the BackendBucket resource to delete."
},
- "message": {
+ "requestId": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "query",
+ "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)."
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- }
- },
- "description": "Contains a list of instances."
- },
- "SecurityPolicyRuleRedirectOptions": {
- "id": "SecurityPolicyRuleRedirectOptions",
- "type": "object",
- "properties": {
- "target": {
- "type": "string",
- "description": "Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA."
+ "description": "Deletes the specified BackendBucket resource.",
+ "httpMethod": "DELETE"
},
- "type": {
- "enumDescriptions": [
- "",
- ""
+ "insert": {
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/global/backendBuckets",
+ "request": {
+ "$ref": "BackendBucket"
+ },
+ "parameters": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/backendBuckets",
+ "id": "compute.backendBuckets.insert",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Type of the redirect action.",
- "type": "string",
- "enum": [
- "EXTERNAL_302",
- "GOOGLE_RECAPTCHA"
+ "description": "Creates a BackendBucket resource in the specified project using the data included in the request.",
+ "parameterOrder": [
+ "project"
]
}
}
},
- "InstanceGroupManagerStatusVersionTarget": {
- "properties": {
- "isReached": {
- "type": "boolean",
- "description": "[Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager."
- }
- },
- "id": "InstanceGroupManagerStatusVersionTarget",
- "type": "object"
- },
- "SecurityPolicyList": {
- "properties": {
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "message": {
- "type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "regionNetworkEndpointGroups": {
+ "methods": {
+ "get": {
+ "id": "compute.regionNetworkEndpointGroups.get",
+ "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}",
+ "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}",
+ "description": "Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "NetworkEndpointGroup"
+ },
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
+ "networkEndpointGroup": {
+ "required": true,
+ "description": "The name of the network endpoint group. It should comply with RFC1035.",
+ "type": "string",
+ "location": "path"
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "region": {
+ "required": true,
+ "location": "path",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035."
}
- }
- },
- "items": {
- "items": {
- "$ref": "SecurityPolicy"
},
- "type": "array",
- "description": "A list of SecurityPolicy resources."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "default": "compute#securityPolicyList",
- "description": "[Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies"
- }
- },
- "type": "object",
- "id": "SecurityPolicyList"
- },
- "RouterStatusBgpPeerStatus": {
- "id": "RouterStatusBgpPeerStatus",
- "properties": {
- "statusReason": {
- "enumDescriptions": [
- "Indicates internal problems with configuration of MD5 authentication. This particular reason can only be returned when md5AuthEnabled is true and status is DOWN.",
- ""
- ],
- "description": "Indicates why particular status was returned.",
- "type": "string",
- "enum": [
- "MD5_AUTH_INTERNAL_PROBLEM",
- "STATUS_REASON_UNSPECIFIED"
+ "parameterOrder": [
+ "project",
+ "region",
+ "networkEndpointGroup"
]
},
- "advertisedRoutes": {
- "items": {
- "$ref": "Route"
- },
- "description": "Routes that were advertised to the remote BGP peer",
- "type": "array"
- },
- "uptimeSeconds": {
- "description": "Time this session has been up, in seconds. Format: 145",
- "type": "string"
- },
- "status": {
- "enum": [
- "DOWN",
- "UNKNOWN",
- "UP"
+ "delete": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "networkEndpointGroup"
],
- "enumDescriptions": [
- "",
- "",
- ""
+ "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "description": "Status of the BGP peer: {UP, DOWN}"
- },
- "peerIpv6NexthopAddress": {
- "type": "string",
- "description": "IPv6 address of the remote BGP interface."
- },
- "linkedVpnTunnel": {
- "description": "URL of the VPN tunnel that this BGP peer controls.",
- "type": "string"
- },
- "enableIpv6": {
- "description": "Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.",
- "type": "boolean"
- },
- "md5AuthEnabled": {
- "type": "boolean",
- "description": "Informs whether MD5 authentication is enabled on this BGP peer."
- },
- "uptime": {
- "description": "Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds",
- "type": "string"
- },
- "state": {
- "type": "string",
- "description": "The state of the BGP session. For a list of possible values for this field, see BGP session states."
- },
- "numLearnedRoutes": {
- "format": "uint32",
- "description": "Number of routes learned from the remote BGP Peer.",
- "type": "integer"
- },
- "peerIpAddress": {
- "description": "IP address of the remote BGP interface.",
- "type": "string"
- },
- "ipv6NexthopAddress": {
- "type": "string",
- "description": "IPv6 address of the local BGP interface."
- },
- "name": {
- "type": "string",
- "description": "Name of this BGP peer. Unique within the Routers resource."
- },
- "ipAddress": {
- "description": "IP address of the local BGP interface.",
- "type": "string"
- },
- "routerApplianceInstance": {
- "description": "[Output only] URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance is the peer side of the BGP session.",
- "type": "string"
- },
- "bfdStatus": {
- "$ref": "BfdStatus"
- }
- },
- "type": "object"
- },
- "VpnTunnelsScopedList": {
- "type": "object",
- "id": "VpnTunnelsScopedList",
- "properties": {
- "vpnTunnels": {
- "items": {
- "$ref": "VpnTunnel"
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "region": {
+ "required": true,
+ "location": "path",
+ "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035.",
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "networkEndpointGroup": {
+ "description": "The name of the network endpoint group to delete. It should comply with RFC1035.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ }
},
- "type": "array",
- "description": "A list of VPN tunnels contained in this scope."
+ "description": "Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.regionNetworkEndpointGroups.delete",
+ "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}"
},
- "warning": {
- "description": "Informational warning which replaces the list of addresses when the list is empty.",
- "type": "object",
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "list": {
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "path": "projects/{project}/regions/{region}/networkEndpointGroups",
+ "id": "compute.regionNetworkEndpointGroups.list",
+ "description": "Retrieves the list of regional network endpoint groups available to the specified project in the given region.",
+ "parameters": {
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "filter": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ },
+ "maxResults": {
+ "type": "integer",
+ "location": "query",
+ "default": "500",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
+ },
+ "region": {
+ "type": "string",
+ "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035.",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "NetworkEndpointGroupList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups"
+ },
+ "insert": {
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
"type": "string"
},
- "data": {
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "The name of the region where you want to create the network endpoint group. It should comply with RFC1035."
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/networkEndpointGroups",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups",
+ "request": {
+ "$ref": "NetworkEndpointGroup"
+ },
+ "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.",
+ "id": "compute.regionNetworkEndpointGroups.insert",
+ "parameterOrder": [
+ "project",
+ "region"
+ ]
}
}
},
- "PublicDelegatedPrefixList": {
- "id": "PublicDelegatedPrefixList",
- "properties": {
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "globalForwardingRules": {
+ "methods": {
+ "list": {
+ "description": "Retrieves a list of GlobalForwardingRule resources available to the specified project.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "orderBy": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
},
- "message": {
+ "maxResults": {
+ "type": "integer",
+ "minimum": "0",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "format": "uint32"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Project ID for this request."
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
}
},
- "type": "object"
- },
- "kind": {
- "default": "compute#publicDelegatedPrefixList",
- "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefixList for public delegated prefixes.",
- "type": "string"
- },
- "items": {
- "type": "array",
- "description": "A list of PublicDelegatedPrefix resources.",
- "items": {
- "$ref": "PublicDelegatedPrefix"
+ "httpMethod": "GET",
+ "id": "compute.globalForwardingRules.list",
+ "flatPath": "projects/{project}/global/forwardingRules",
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/global/forwardingRules",
+ "response": {
+ "$ref": "ForwardingRuleList"
}
},
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- }
- },
- "type": "object"
- },
- "SecurityPolicy": {
- "description": "Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.",
- "properties": {
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "name": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "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."
+ "patch": {
+ "httpMethod": "PATCH",
+ "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}",
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "forwardingRule": {
+ "type": "string",
+ "required": true,
+ "description": "Name of the ForwardingRule resource to patch.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.globalForwardingRules.patch",
+ "parameterOrder": [
+ "project",
+ "forwardingRule"
+ ],
+ "description": "Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.",
+ "path": "projects/{project}/global/forwardingRules/{forwardingRule}",
+ "request": {
+ "$ref": "ForwardingRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "type": {
- "description": "The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. This field can be set only at resource creation time.",
- "enumDescriptions": [
- "",
- "",
- ""
+ "get": {
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "CLOUD_ARMOR",
- "CLOUD_ARMOR_EDGE",
- "CLOUD_ARMOR_NETWORK"
+ "description": "Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.",
+ "response": {
+ "$ref": "ForwardingRule"
+ },
+ "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}",
+ "path": "projects/{project}/global/forwardingRules/{forwardingRule}",
+ "parameterOrder": [
+ "project",
+ "forwardingRule"
],
- "type": "string"
- },
- "fingerprint": {
- "type": "string",
- "format": "byte",
- "description": "Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy."
- },
- "region": {
- "description": "[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
+ "id": "compute.globalForwardingRules.get",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "forwardingRule": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the ForwardingRule resource to return.",
+ "required": true,
+ "location": "path"
+ }
+ }
},
- "rules": {
- "items": {
- "$ref": "SecurityPolicyRule"
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.globalForwardingRules.delete",
+ "parameters": {
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "forwardingRule": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "description": "Name of the ForwardingRule resource to delete."
+ }
},
- "type": "array",
- "description": "A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match \"*\" for srcIpRanges and for the networkMatch condition every field must be either match \"*\" or not set). If no rules are provided when creating a security policy, a default rule with action \"allow\" will be added."
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "advancedOptionsConfig": {
- "$ref": "SecurityPolicyAdvancedOptionsConfig"
- },
- "ddosProtectionConfig": {
- "$ref": "SecurityPolicyDdosProtectionConfig"
- },
- "adaptiveProtectionConfig": {
- "$ref": "SecurityPolicyAdaptiveProtectionConfig"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "kind": {
- "type": "string",
- "description": "[Output only] Type of the resource. Always compute#securityPolicyfor security policies",
- "default": "compute#securityPolicy"
- },
- "recaptchaOptionsConfig": {
- "$ref": "SecurityPolicyRecaptchaOptionsConfig"
- }
- },
- "id": "SecurityPolicy",
- "type": "object"
- },
- "VmEndpointNatMappings": {
- "id": "VmEndpointNatMappings",
- "type": "object",
- "description": "Contain information of Nat mapping for a VM endpoint (i.e., NIC).",
- "properties": {
- "instanceName": {
- "type": "string",
- "description": "Name of the VM instance which the endpoint belongs to"
- },
- "interfaceNatMappings": {
- "items": {
- "$ref": "VmEndpointNatMappingsInterfaceNatMappings"
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/global/forwardingRules/{forwardingRule}",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- }
- }
- },
- "BackendServiceIAP": {
- "id": "BackendServiceIAP",
- "type": "object",
- "properties": {
- "oauth2ClientSecret": {
- "description": "OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly",
- "type": "string"
- },
- "oauth2ClientSecretSha256": {
- "type": "string",
- "description": "[Output Only] SHA256 hash value for the field oauth2_client_secret above."
- },
- "enabled": {
- "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty.",
- "type": "boolean"
+ "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}",
+ "description": "Deletes the specified GlobalForwardingRule resource.",
+ "parameterOrder": [
+ "project",
+ "forwardingRule"
+ ]
},
- "oauth2ClientId": {
- "type": "string",
- "description": "OAuth2 client ID to use for the authentication flow."
- }
- },
- "description": "Identity-Aware Proxy"
- },
- "ServerBinding": {
- "id": "ServerBinding",
- "type": "object",
- "properties": {
- "type": {
- "enum": [
- "RESTART_NODE_ON_ANY_SERVER",
- "RESTART_NODE_ON_MINIMAL_SERVERS",
- "SERVER_BINDING_TYPE_UNSPECIFIED"
- ],
- "enumDescriptions": [
- "Node may associate with any physical server over its lifetime.",
- "Node may associate with minimal physical servers over its lifetime.",
- ""
+ "insert": {
+ "path": "projects/{project}/global/forwardingRules",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "ForwardingRule"
+ },
+ "flatPath": "projects/{project}/global/forwardingRules",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
- }
- }
- },
- "NetworkEndpointGroupsDetachEndpointsRequest": {
- "type": "object",
- "properties": {
- "networkEndpoints": {
- "type": "array",
- "description": "The list of network endpoints to be detached.",
- "items": {
- "$ref": "NetworkEndpoint"
- }
- }
- },
- "id": "NetworkEndpointGroupsDetachEndpointsRequest"
- },
- "TargetTcpProxiesScopedList": {
- "id": "TargetTcpProxiesScopedList",
- "type": "object",
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- }
- },
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "id": "compute.globalForwardingRules.insert",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
}
},
- "description": "Informational warning which replaces the list of backend services when the list is empty."
- },
- "targetTcpProxies": {
- "items": {
- "$ref": "TargetTcpProxy"
+ "description": "Creates a GlobalForwardingRule resource in the specified project using the data included in the request.",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "A list of TargetTcpProxies contained in this scope."
- }
- }
- },
- "InstanceGroupManagerAggregatedList": {
- "type": "object",
- "properties": {
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "parameterOrder": [
+ "project"
+ ]
},
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "type": "array",
- "items": {
- "type": "string"
+ "setLabels": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "GlobalSetLabelsRequest"
+ },
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/global/forwardingRules/{resource}/setLabels",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ },
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name or id of the resource for this request."
+ }
+ },
+ "id": "compute.globalForwardingRules.setLabels",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "path": "projects/{project}/global/forwardingRules/{resource}/setLabels",
+ "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.",
+ "response": {
+ "$ref": "Operation"
}
},
- "items": {
- "additionalProperties": {
- "description": "[Output Only] The name of the scope that contains this set of managed instance groups.",
- "$ref": "InstanceGroupManagersScopedList"
+ "setTarget": {
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget",
+ "response": {
+ "$ref": "Operation"
},
- "type": "object",
- "description": "A list of InstanceGroupManagersScopedList resources."
- },
- "kind": {
- "type": "string",
- "default": "compute#instanceGroupManagerAggregatedList",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups."
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "message": {
+ "request": {
+ "$ref": "TargetReference"
+ },
+ "parameterOrder": [
+ "project",
+ "forwardingRule"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget",
+ "description": "Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.",
+ "id": "compute.globalForwardingRules.setTarget",
+ "parameters": {
+ "forwardingRule": {
+ "required": true,
+ "location": "path",
+ "description": "Name of the ForwardingRule resource in which target is to be set.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "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).",
+ "location": "query",
+ "type": "string"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "project": {
+ "required": true,
+ "location": "path",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
}
}
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
}
- },
- "id": "InstanceGroupManagerAggregatedList"
+ }
},
- "BackendService": {
- "type": "object",
- "description": "Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) For more information, see Backend Services.",
- "properties": {
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- },
- "protocol": {
- "enumDescriptions": [
- "gRPC (available for Traffic Director).",
- "",
- "HTTP/2 with SSL.",
- "",
- "TCP proxying with SSL.",
- "TCP proxying or TCP pass-through.",
- "UDP.",
- "If a Backend Service has UNSPECIFIED as its protocol, it can be used with any L3/L4 Forwarding Rules."
- ],
- "type": "string",
- "description": "The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.",
- "enum": [
- "GRPC",
- "HTTP",
- "HTTP2",
- "HTTPS",
- "SSL",
- "TCP",
- "UDP",
- "UNSPECIFIED"
- ]
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#backendService for backend services.",
- "default": "compute#backendService"
- },
- "connectionDraining": {
- "$ref": "ConnectionDraining"
- },
- "logConfig": {
- "$ref": "BackendServiceLogConfig",
- "description": "This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver."
- },
- "port": {
- "format": "int32",
- "type": "integer",
- "description": "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port."
- },
- "customRequestHeaders": {
- "description": "Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).",
- "items": {
- "type": "string"
+ "httpHealthChecks": {
+ "methods": {
+ "delete": {
+ "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+ "id": "compute.httpHealthChecks.delete",
+ "parameters": {
+ "httpHealthCheck": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the HttpHealthCheck resource to delete.",
+ "type": "string",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ }
},
- "type": "array"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "loadBalancingScheme": {
- "type": "string",
- "enumDescriptions": [
- "Signifies that this will be used for external HTTP(S), SSL Proxy, TCP Proxy, or Network Load Balancing",
- "Signifies that this will be used for External Managed HTTP(S) Load Balancing.",
- "Signifies that this will be used for Internal TCP/UDP Load Balancing.",
- "Signifies that this will be used for Internal HTTP(S) Load Balancing.",
- "Signifies that this will be used by Traffic Director.",
- ""
+ "description": "Deletes the specified HttpHealthCheck resource.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "httpHealthCheck"
],
- "description": "Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.",
- "enum": [
- "EXTERNAL",
- "EXTERNAL_MANAGED",
- "INTERNAL",
- "INTERNAL_MANAGED",
- "INTERNAL_SELF_MANAGED",
- "INVALID_LOAD_BALANCING_SCHEME"
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
},
- "fingerprint": {
- "description": "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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.",
- "format": "byte",
- "type": "string"
- },
- "subsetting": {
- "$ref": "Subsetting"
- },
- "maxStreamDuration": {
- "$ref": "Duration",
- "description": "Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED."
- },
- "region": {
- "description": "[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. 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"
- },
- "iap": {
- "$ref": "BackendServiceIAP",
- "description": "The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing."
- },
- "localityLbPolicies": {
- "description": "A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true.",
- "type": "array",
- "items": {
- "$ref": "BackendServiceLocalityLoadBalancingPolicyConfig"
- }
- },
- "edgeSecurityPolicy": {
- "type": "string",
- "description": "[Output Only] The resource URL for the edge security policy associated with this backend service."
- },
- "connectionTrackingPolicy": {
- "description": "Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.",
- "$ref": "BackendServiceConnectionTrackingPolicy"
- },
- "network": {
- "type": "string",
- "description": "The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL."
- },
- "securityPolicy": {
- "type": "string",
- "description": "[Output Only] The resource URL for the security policy associated with this backend service."
- },
- "circuitBreakers": {
- "$ref": "CircuitBreakers"
- },
- "securitySettings": {
- "$ref": "SecuritySettings",
- "description": "This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED."
- },
- "serviceBindings": {
- "items": {
- "type": "string"
+ "list": {
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "HttpHealthCheckList"
},
- "description": "URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.",
- "type": "array"
- },
- "cdnPolicy": {
- "$ref": "BackendServiceCdnPolicy",
- "description": "Cloud CDN configuration for this BackendService. Only available for specified load balancer types."
- },
- "affinityCookieTtlSec": {
- "type": "integer",
- "description": "Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
- "format": "int32"
- },
- "name": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "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."
- },
- "healthChecks": {
- "type": "array",
- "items": {
- "type": "string"
+ "flatPath": "projects/{project}/global/httpHealthChecks",
+ "id": "compute.httpHealthChecks.list",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "location": "query",
+ "format": "uint32",
+ "default": "500",
+ "type": "integer"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ }
},
- "description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check."
+ "httpMethod": "GET",
+ "description": "Retrieves the list of HttpHealthCheck resources available to the specified project.",
+ "path": "projects/{project}/global/httpHealthChecks",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "localityLbPolicy": {
- "enum": [
- "INVALID_LB_POLICY",
- "LEAST_REQUEST",
- "MAGLEV",
- "ORIGINAL_DESTINATION",
- "RANDOM",
- "RING_HASH",
- "ROUND_ROBIN"
+ "insert": {
+ "request": {
+ "$ref": "HttpHealthCheck"
+ },
+ "path": "projects/{project}/global/httpHealthChecks",
+ "parameterOrder": [
+ "project"
],
- "type": "string",
- "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
- "enumDescriptions": [
- "",
- "An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.",
- "This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824",
- "Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.",
- "The load balancer selects a random healthy host.",
- "The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.",
- "This is a simple policy in which each healthy backend is selected in round robin order. This is the default."
+ "id": "compute.httpHealthChecks.insert",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/httpHealthChecks",
+ "httpMethod": "POST",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "description": "Creates a HttpHealthCheck resource in the specified project using the data included in the request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
},
- "timeoutSec": {
- "type": "integer",
- "format": "int32",
- "description": "The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration."
- },
- "failoverPolicy": {
- "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).",
- "$ref": "BackendServiceFailoverPolicy"
- },
- "consistentHash": {
- "description": "Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. ",
- "$ref": "ConsistentHashLoadBalancerSettings"
- },
- "sessionAffinity": {
- "enumDescriptions": [
- "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.",
- "1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.",
- "5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.",
- "3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.",
- "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.",
- "The hash is based on a user specified header field.",
- "The hash is based on a user provided cookie.",
- "No session affinity. Connections from the same client IP may go to any instance in the pool."
+ "patch": {
+ "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "request": {
+ "$ref": "HttpHealthCheck"
+ },
+ "httpMethod": "PATCH",
+ "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "CLIENT_IP",
- "CLIENT_IP_NO_DESTINATION",
- "CLIENT_IP_PORT_PROTO",
- "CLIENT_IP_PROTO",
- "GENERATED_COOKIE",
- "HEADER_FIELD",
- "HTTP_COOKIE",
- "NONE"
+ "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+ "id": "compute.httpHealthChecks.patch",
+ "parameterOrder": [
+ "project",
+ "httpHealthCheck"
],
- "description": "Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).",
- "type": "string"
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "httpHealthCheck": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the HttpHealthCheck resource to patch.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
+ }
},
- "customResponseHeaders": {
- "items": {
- "type": "string"
+ "update": {
+ "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.httpHealthChecks.update",
+ "parameters": {
+ "httpHealthCheck": {
+ "required": true,
+ "description": "Name of the HttpHealthCheck resource to update.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
},
- "description": "Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).",
- "type": "array"
- },
- "backends": {
- "items": {
- "$ref": "Backend"
+ "request": {
+ "$ref": "HttpHealthCheck"
},
- "description": "The list of backends that serve this BackendService.",
- "type": "array"
- },
- "outlierDetection": {
- "description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. ",
- "$ref": "OutlierDetection"
- },
- "enableCDN": {
- "type": "boolean",
- "description": "If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer."
- },
- "compressionMode": {
- "enum": [
- "AUTOMATIC",
- "DISABLED"
- ],
- "description": "Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.",
- "enumDescriptions": [
- "Automatically uses the best compression based on the Accept-Encoding header sent by the client.",
- "Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients."
+ "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+ "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "project",
+ "httpHealthCheck"
],
- "type": "string"
- },
- "portName": {
- "description": "A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- }
- },
- "id": "BackendService"
- },
- "LocalizedMessage": {
- "properties": {
- "message": {
- "description": "The localized error message in the above locale.",
- "type": "string"
+ "response": {
+ "$ref": "Operation"
+ }
},
- "locale": {
- "type": "string",
- "description": "The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: \"en-US\", \"fr-CH\", \"es-MX\""
- }
- },
- "type": "object",
- "id": "LocalizedMessage",
- "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error."
- },
- "RegionSetLabelsRequest": {
- "id": "RegionSetLabelsRequest",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
+ "get": {
+ "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+ "id": "compute.httpHealthChecks.get",
+ "httpMethod": "GET",
+ "description": "Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+ "response": {
+ "$ref": "HttpHealthCheck"
},
- "description": "The labels to set for this resource.",
- "type": "object"
- },
- "labelFingerprint": {
- "type": "string",
- "format": "byte",
- "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint."
- }
- },
- "type": "object"
- },
- "VpnGatewayVpnGatewayInterface": {
- "properties": {
- "id": {
- "type": "integer",
- "description": "[Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.",
- "format": "uint32"
- },
- "interconnectAttachment": {
- "type": "string",
- "description": "URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for HA VPN over Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource."
- },
- "ipAddress": {
- "type": "string",
- "description": "[Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For HA VPN over Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address."
- }
- },
- "type": "object",
- "description": "A VPN gateway interface.",
- "id": "VpnGatewayVpnGatewayInterface"
- },
- "RequestMirrorPolicy": {
- "properties": {
- "backendService": {
- "description": "The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. ",
- "type": "string"
+ "parameters": {
+ "httpHealthCheck": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "description": "Name of the HttpHealthCheck resource to return.",
+ "location": "path"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "httpHealthCheck"
+ ]
}
- },
- "type": "object",
- "id": "RequestMirrorPolicy",
- "description": "A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow."
+ }
},
- "HealthChecksScopedList": {
- "id": "HealthChecksScopedList",
- "properties": {
- "warning": {
- "description": "Informational warning which replaces the list of backend services when the list is empty.",
- "type": "object",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "networkEdgeSecurityServices": {
+ "methods": {
+ "aggregatedList": {
+ "flatPath": "projects/{project}/aggregated/networkEdgeSecurityServices",
+ "id": "compute.networkEdgeSecurityServices.aggregatedList",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "NetworkEdgeSecurityServiceAggregatedList"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/aggregated/networkEdgeSecurityServices",
+ "description": "Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project.",
+ "parameters": {
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "location": "query"
},
- "message": {
+ "includeAllScopes": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Name of the project scoping this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- }
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "minimum": "0",
+ "type": "integer",
+ "format": "uint32",
+ "location": "query"
}
}
},
- "healthChecks": {
- "type": "array",
- "description": "A list of HealthChecks contained in this scope.",
- "items": {
- "$ref": "HealthCheck"
- }
- }
- },
- "type": "object"
- },
- "FirewallPolicyRuleMatcherLayer4Config": {
- "id": "FirewallPolicyRuleMatcherLayer4Config",
- "properties": {
- "ports": {
- "type": "array",
- "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].",
- "items": {
- "type": "string"
- }
- },
- "ipProtocol": {
- "type": "string",
- "description": "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."
- }
- },
- "type": "object"
- },
- "DiskTypeList": {
- "id": "DiskTypeList",
- "description": "Contains a list of disk types.",
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "warning": {
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "patch": {
+ "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "updateMask": {
+ "type": "string",
+ "description": "Indicates fields to be updated as part of this request.",
+ "format": "google-fieldmask",
+ "location": "query"
},
- "data": {
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "paths": {
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "region": {
+ "location": "path",
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "networkEdgeSecurityService": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "description": "Name of the network edge security service to update.",
+ "location": "path"
+ }
+ },
+ "request": {
+ "$ref": "NetworkEdgeSecurityService"
+ },
+ "description": "Patches the specified policy with the data included in the request.",
+ "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "networkEdgeSecurityService"
+ ],
+ "id": "compute.networkEdgeSecurityServices.patch",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "PATCH"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "networkEdgeSecurityService": {
+ "description": "Name of the network edge security service to delete.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
"type": "string"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#diskTypeList for disk types.",
- "type": "string",
- "default": "compute#diskTypeList"
- },
- "items": {
- "items": {
- "$ref": "DiskType"
+ "parameterOrder": [
+ "project",
+ "region",
+ "networkEdgeSecurityService"
+ ],
+ "id": "compute.networkEdgeSecurityServices.delete",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "description": "A list of DiskType resources.",
- "type": "array"
- }
- },
- "type": "object"
- },
- "Help": {
- "description": "Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.",
- "properties": {
- "links": {
- "items": {
- "$ref": "HelpLink"
+ "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
+ "description": "Deletes the specified service.",
+ "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}"
+ },
+ "insert": {
+ "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices",
+ "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "URL(s) pointing to additional information on handling the current error."
- }
- },
- "type": "object",
- "id": "Help"
- },
- "Policy": {
- "id": "Policy",
- "type": "object",
- "properties": {
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "items": {
- "$ref": "AuditConfig"
+ "id": "compute.networkEdgeSecurityServices.insert",
+ "description": "Creates a new service in the specified project using the data included in the request.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "validateOnly": {
+ "type": "boolean",
+ "location": "query",
+ "description": "If true, the request will not be committed."
+ }
},
- "type": "array"
- },
- "bindings": {
- "type": "array",
- "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"
+ "request": {
+ "$ref": "NetworkEdgeSecurityService"
}
},
- "version": {
- "format": "int32",
- "type": "integer",
- "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)."
- },
- "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"
- },
- "rules": {
- "description": "This is deprecated and has no effect. Do not use.",
- "items": {
- "$ref": "Rule"
+ "get": {
+ "parameters": {
+ "region": {
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "networkEdgeSecurityService": {
+ "description": "Name of the network edge security service to get.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
},
- "type": "array"
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
+ "response": {
+ "$ref": "NetworkEdgeSecurityService"
+ },
+ "description": "Gets a specified NetworkEdgeSecurityService.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "networkEdgeSecurityService"
+ ],
+ "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
+ "id": "compute.networkEdgeSecurityServices.get"
}
- },
- "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 \u003c 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 \u003c 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/)."
+ }
},
- "ReservationAggregatedList": {
- "properties": {
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#reservationAggregatedList"
- },
- "items": {
- "type": "object",
- "description": "A list of Allocation resources.",
- "additionalProperties": {
- "description": "Name of the scope containing this set of reservations.",
- "$ref": "ReservationsScopedList"
- }
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "unreachables": {
- "items": {
- "type": "string"
+ "regionSslCertificates": {
+ "methods": {
+ "delete": {
+ "id": "compute.regionSslCertificates.delete",
+ "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
},
- "description": "[Output Only] Unreachable resources.",
- "type": "array"
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "parameterOrder": [
+ "project",
+ "region",
+ "sslCertificate"
+ ],
+ "parameters": {
+ "sslCertificate": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the SslCertificate resource to delete.",
+ "type": "string",
+ "required": true,
+ "location": "path"
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "required": true,
+ "description": "Name of the region scoping this request."
},
- "message": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "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).",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "query"
}
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- }
- },
- "id": "ReservationAggregatedList",
- "description": "Contains a list of reservations.",
- "type": "object"
- },
- "AuditLogConfig": {
- "properties": {
- "exemptedMembers": {
- "items": {
- "type": "string"
},
- "type": "array",
- "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members."
+ "description": "Deletes the specified SslCertificate resource in the region.",
+ "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "ignoreChildExemptions": {
- "type": "boolean",
- "description": "This is deprecated and has no effect. Do not use."
+ "list": {
+ "parameters": {
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "minimum": "0",
+ "type": "integer",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "id": "compute.regionSslCertificates.list",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/sslCertificates",
+ "response": {
+ "$ref": "SslCertificateList"
+ },
+ "path": "projects/{project}/regions/{region}/sslCertificates",
+ "description": "Retrieves the list of SslCertificate resources available to the specified project in the specified region."
},
- "logType": {
- "description": "The log type that this config enables.",
- "type": "string",
- "enum": [
- "ADMIN_READ",
- "DATA_READ",
- "DATA_WRITE",
- "LOG_TYPE_UNSPECIFIED"
+ "insert": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data reads. Example: CloudSQL Users list",
- "Data writes. Example: CloudSQL Users create",
- "Default case. Should never be this."
+ "parameters": {
+ "region": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string"
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.regionSslCertificates.insert",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/sslCertificates",
+ "path": "projects/{project}/regions/{region}/sslCertificates",
+ "description": "Creates a SslCertificate resource in the specified project and region using the data included in the request",
+ "request": {
+ "$ref": "SslCertificate"
+ },
+ "parameterOrder": [
+ "project",
+ "region"
]
- }
- },
- "type": "object",
- "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"
- },
- "LicenseCode": {
- "type": "object",
- "id": "LicenseCode",
- "description": "Represents a License Code resource. A License Code is a unique identifier used to represent a license resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
- "properties": {
- "licenseAlias": {
- "description": "[Output Only] URL and description aliases of Licenses with the same License Code.",
- "type": "array",
- "items": {
- "$ref": "LicenseCodeLicenseAlias"
- }
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#licenseCode for licenses.",
- "default": "compute#licenseCode",
- "type": "string"
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "transferable": {
- "type": "boolean",
- "description": "[Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred."
},
- "name": {
- "description": "[Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.",
- "type": "string",
- "annotations": {
- "required": [
- "compute.licenses.insert"
- ]
+ "get": {
+ "response": {
+ "$ref": "SslCertificate"
},
- "pattern": "[0-9]{0,20}?"
- },
- "state": {
- "enumDescriptions": [
- "Machines are not allowed to attach boot disks with this License Code. Requests to create new resources with this license will be rejected.",
- "Use is allowed for anyone with USE_READ_ONLY access to this License Code.",
- "Use of this license is limited to a project whitelist.",
- "",
- "Reserved state."
- ],
- "description": "[Output Only] Current state of this License Code.",
- "enum": [
- "DISABLED",
- "ENABLED",
- "RESTRICTED",
- "STATE_UNSPECIFIED",
- "TERMINATED"
+ "description": "Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.",
+ "id": "compute.regionSslCertificates.get",
+ "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}",
+ "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}",
+ "httpMethod": "GET",
+ "parameters": {
+ "region": {
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "Name of the region scoping this request."
+ },
+ "sslCertificate": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the SslCertificate resource to return."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "description": {
- "description": "[Output Only] Description of this License Code.",
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "region",
+ "sslCertificate"
+ ]
}
}
},
- "RegionAutoscalerList": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- }
+ "targetTcpProxies": {
+ "methods": {
+ "delete": {
+ "id": "compute.targetTcpProxies.delete",
+ "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "project",
+ "targetTcpProxy"
+ ],
+ "description": "Deletes the specified TargetTcpProxy resource.",
+ "parameters": {
+ "targetTcpProxy": {
+ "description": "Name of the TargetTcpProxy resource to delete.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "type": "string"
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
},
- "message": {
+ "project": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true
}
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}",
+ "response": {
+ "$ref": "Operation"
}
},
- "kind": {
- "default": "compute#regionAutoscalerList",
- "description": "Type of resource.",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "Autoscaler"
+ "insert": {
+ "id": "compute.targetTcpProxies.insert",
+ "httpMethod": "POST",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ }
},
- "description": "A list of Autoscaler resources."
- }
- },
- "id": "RegionAutoscalerList",
- "description": "Contains a list of autoscalers."
- },
- "HTTP2HealthCheck": {
- "properties": {
- "host": {
- "type": "string",
- "description": "The value of the host header in the HTTP/2 health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest"
- },
- "portName": {
- "description": "Not supported.",
- "type": "string"
- },
- "port": {
- "format": "int32",
- "type": "integer",
- "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535."
- },
- "requestPath": {
- "type": "string",
- "description": "The request path of the HTTP/2 health check request. The default value is /."
- },
- "response": {
- "description": "Creates a content-based HTTP/2 health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http",
- "type": "string"
- },
- "proxyHeader": {
- "type": "string",
- "enum": [
- "NONE",
- "PROXY_V1"
+ "path": "projects/{project}/global/targetTcpProxies",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project"
],
- "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
- "enumDescriptions": [
- "",
- ""
- ]
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/global/targetTcpProxies",
+ "description": "Creates a TargetTcpProxy resource in the specified project using the data included in the request.",
+ "request": {
+ "$ref": "TargetTcpProxy"
+ }
},
- "portSpecification": {
- "type": "string",
- "enum": [
- "USE_FIXED_PORT",
- "USE_NAMED_PORT",
- "USE_SERVING_PORT"
+ "setBackendService": {
+ "id": "compute.targetTcpProxies.setBackendService",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "targetTcpProxy"
],
- "enumDescriptions": [
- "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
- "Not supported.",
- "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
+ "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports."
- }
- },
- "id": "HTTP2HealthCheck",
- "type": "object"
- },
- "OperationsScopedList": {
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "code": {
+ "request": {
+ "$ref": "TargetTcpProxiesSetBackendServiceRequest"
+ },
+ "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "required": true,
+ "description": "Project ID for this request."
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "targetTcpProxy": {
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the TargetTcpProxy resource whose BackendService resource is to be set."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "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).",
+ "type": "string",
+ "location": "query"
}
},
- "description": "[Output Only] Informational warning which replaces the list of operations when the list is empty."
+ "description": "Changes the BackendService for TargetTcpProxy."
},
- "operations": {
- "type": "array",
- "items": {
- "$ref": "Operation"
+ "aggregatedList": {
+ "flatPath": "projects/{project}/aggregated/targetTcpProxies",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the project scoping this request."
+ },
+ "maxResults": {
+ "type": "integer",
+ "default": "500",
+ "location": "query",
+ "format": "uint32",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ }
},
- "description": "[Output Only] A list of operations contained in this scope."
- }
- },
- "type": "object",
- "id": "OperationsScopedList"
- },
- "LogConfigDataAccessOptions": {
- "id": "LogConfigDataAccessOptions",
- "type": "object",
- "description": "This is deprecated and has no effect. Do not use.",
- "properties": {
- "logMode": {
- "enum": [
- "LOG_FAIL_CLOSED",
- "LOG_MODE_UNSPECIFIED"
+ "path": "projects/{project}/aggregated/targetTcpProxies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "enumDescriptions": [
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use."
+ "description": "Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project.",
+ "id": "compute.targetTcpProxies.aggregatedList",
+ "parameterOrder": [
+ "project"
],
- "description": "This is deprecated and has no effect. Do not use."
- }
- }
- },
- "UrlMapValidationResult": {
- "id": "UrlMapValidationResult",
- "properties": {
- "loadErrors": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "testPassed": {
- "description": "If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.",
- "type": "boolean"
- },
- "testFailures": {
- "items": {
- "$ref": "TestFailure"
- },
- "type": "array"
- },
- "loadSucceeded": {
- "description": "Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.",
- "type": "boolean"
- }
- },
- "description": "Message representing the validation result for a UrlMap.",
- "type": "object"
- },
- "DisksAddResourcePoliciesRequest": {
- "properties": {
- "resourcePolicies": {
- "items": {
- "type": "string"
+ "response": {
+ "$ref": "TargetTcpProxyAggregatedList"
},
- "type": "array",
- "description": "Full or relative path to the resource policy to be added to this disk. You can only specify one resource policy."
- }
- },
- "id": "DisksAddResourcePoliciesRequest",
- "type": "object"
- },
- "NetworkEndpoint": {
- "properties": {
- "ipAddress": {
- "type": "string",
- "description": "Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used."
+ "httpMethod": "GET"
},
- "annotations": {
- "additionalProperties": {
- "type": "string"
+ "list": {
+ "response": {
+ "$ref": "TargetTcpProxyList"
},
- "type": "object",
- "description": "Metadata defined as annotations on the network endpoint."
- },
- "instance": {
- "type": "string",
- "description": "The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035."
- },
- "fqdn": {
- "type": "string",
- "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT."
- },
- "port": {
- "description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.",
- "type": "integer",
- "format": "int32"
- }
- },
- "type": "object",
- "description": "The network endpoint.",
- "id": "NetworkEndpoint"
- },
- "GlobalSetLabelsRequest": {
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
+ "description": "Retrieves the list of TargetTcpProxy resources available to the specified project.",
+ "parameters": {
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "default": "500",
+ "minimum": "0",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path"
+ }
},
- "type": "object",
- "description": "A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\")."
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/global/targetTcpProxies",
+ "id": "compute.targetTcpProxies.list",
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/global/targetTcpProxies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "labelFingerprint": {
- "type": "string",
- "format": "byte",
- "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint."
- }
- },
- "id": "GlobalSetLabelsRequest",
- "type": "object"
- },
- "TargetPoolsAddHealthCheckRequest": {
- "properties": {
- "healthChecks": {
- "description": "The HttpHealthCheck to add to the target pool.",
- "items": {
- "$ref": "HealthCheckReference"
+ "setProxyHeader": {
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "TargetTcpProxiesSetProxyHeaderRequest"
},
- "type": "array"
- }
- },
- "type": "object",
- "id": "TargetPoolsAddHealthCheckRequest"
- },
- "InstancesScopedList": {
- "id": "InstancesScopedList",
- "properties": {
- "instances": {
- "description": "[Output Only] A list of instances contained in this scope.",
- "items": {
- "$ref": "Instance"
+ "parameterOrder": [
+ "project",
+ "targetTcpProxy"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- },
- "warning": {
- "description": "[Output Only] Informational warning which replaces the list of instances when the list is empty.",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "targetTcpProxy": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "description": "Name of the TargetTcpProxy resource whose ProxyHeader is to be set."
},
- "message": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
}
- }
- }
- },
- "type": "object"
- },
- "GlobalNetworkEndpointGroupsDetachEndpointsRequest": {
- "properties": {
- "networkEndpoints": {
- "items": {
- "$ref": "NetworkEndpoint"
},
- "description": "The list of network endpoints to be detached.",
- "type": "array"
- }
- },
- "type": "object",
- "id": "GlobalNetworkEndpointGroupsDetachEndpointsRequest"
- },
- "RegionInstanceGroupManagersSetTargetPoolsRequest": {
- "type": "object",
- "id": "RegionInstanceGroupManagersSetTargetPoolsRequest",
- "properties": {
- "fingerprint": {
- "description": "Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.",
- "type": "string",
- "format": "byte"
+ "description": "Changes the ProxyHeaderType for TargetTcpProxy.",
+ "id": "compute.targetTcpProxies.setProxyHeader",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader"
},
- "targetPools": {
- "type": "array",
- "description": "The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "AllocationSpecificSKUAllocationReservedInstanceProperties": {
- "description": "Properties of the SKU instances being reserved. Next ID: 9",
- "id": "AllocationSpecificSKUAllocationReservedInstanceProperties",
- "type": "object",
- "properties": {
- "localSsds": {
- "type": "array",
- "items": {
- "$ref": "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk"
+ "get": {
+ "parameterOrder": [
+ "project",
+ "targetTcpProxy"
+ ],
+ "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}",
+ "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}",
+ "description": "Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.",
+ "response": {
+ "$ref": "TargetTcpProxy"
},
- "description": "Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd."
- },
- "guestAccelerators": {
- "items": {
- "$ref": "AcceleratorConfig"
+ "parameters": {
+ "targetTcpProxy": {
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "description": "Name of the TargetTcpProxy resource to return."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
},
- "description": "Specifies accelerator type and count.",
- "type": "array"
- },
- "minCpuPlatform": {
- "type": "string",
- "description": "Minimum cpu platform the reservation."
- },
- "machineType": {
- "description": "Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.",
- "type": "string"
- },
- "locationHint": {
- "type": "string",
- "description": "An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.targetTcpProxies.get",
+ "httpMethod": "GET"
}
}
},
- "Zone": {
- "description": "Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones.",
- "properties": {
- "region": {
- "description": "[Output Only] Full URL reference to the region which hosts the zone.",
- "type": "string"
- },
- "supportsPzs": {
- "type": "boolean",
- "description": "[Output Only] Reserved for future use."
- },
- "description": {
- "description": "[Output Only] Textual description of the resource.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#zone for zones.",
- "default": "compute#zone"
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this zone."
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "status": {
- "enum": [
- "DOWN",
- "UP"
+ "publicAdvertisedPrefixes": {
+ "methods": {
+ "get": {
+ "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
+ "parameters": {
+ "publicAdvertisedPrefix": {
+ "description": "Name of the PublicAdvertisedPrefix resource to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "id": "compute.publicAdvertisedPrefixes.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enumDescriptions": [
- "",
- ""
+ "parameterOrder": [
+ "project",
+ "publicAdvertisedPrefix"
],
- "description": "[Output Only] Status of the zone, either UP or DOWN.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
+ "description": "Returns the specified PublicAdvertisedPrefix resource.",
+ "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "PublicAdvertisedPrefix"
+ }
},
- "name": {
- "description": "[Output Only] Name of the resource.",
- "type": "string"
+ "insert": {
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ }
+ },
+ "path": "projects/{project}/global/publicAdvertisedPrefixes",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.publicAdvertisedPrefixes.insert",
+ "description": "Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.",
+ "request": {
+ "$ref": "PublicAdvertisedPrefix"
+ },
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/global/publicAdvertisedPrefixes",
+ "response": {
+ "$ref": "Operation"
+ }
},
- "availableCpuPlatforms": {
- "items": {
- "type": "string"
+ "patch": {
+ "parameterOrder": [
+ "project",
+ "publicAdvertisedPrefix"
+ ],
+ "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
+ "description": "Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "publicAdvertisedPrefix": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the PublicAdvertisedPrefix resource to patch.",
+ "location": "path"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true
+ }
},
- "type": "array",
- "description": "[Output Only] Available cpu/platform selections for the zone."
- }
- },
- "id": "Zone",
- "type": "object"
- },
- "AutoscalerAggregatedList": {
- "type": "object",
- "properties": {
- "items": {
- "additionalProperties": {
- "$ref": "AutoscalersScopedList",
- "description": "[Output Only] Name of the scope containing this set of autoscalers."
+ "id": "compute.publicAdvertisedPrefixes.patch",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Operation"
},
- "description": "A list of AutoscalersScopedList resources.",
- "type": "object"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "kind": {
- "default": "compute#autoscalerAggregatedList",
- "description": "[Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "request": {
+ "$ref": "PublicAdvertisedPrefix"
+ },
+ "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}"
},
- "unreachables": {
- "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder",
- "items": {
- "type": "string"
+ "list": {
+ "httpMethod": "GET",
+ "path": "projects/{project}/global/publicAdvertisedPrefixes",
+ "description": "Lists the PublicAdvertisedPrefixes for a project.",
+ "id": "compute.publicAdvertisedPrefixes.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "PublicAdvertisedPrefixList"
},
- "type": "array"
+ "parameterOrder": [
+ "project"
+ ],
+ "flatPath": "projects/{project}/global/publicAdvertisedPrefixes",
+ "parameters": {
+ "maxResults": {
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ }
+ }
},
- "warning": {
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "delete": {
+ "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
"type": "string"
},
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
},
- "code": {
+ "publicAdvertisedPrefix": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path",
+ "description": "Name of the PublicAdvertisedPrefix resource to delete."
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- }
- },
- "id": "AutoscalerAggregatedList"
- },
- "ResourcePolicyWeeklyCycle": {
- "id": "ResourcePolicyWeeklyCycle",
- "description": "Time window specified for weekly operations.",
- "properties": {
- "dayOfWeeks": {
- "items": {
- "$ref": "ResourcePolicyWeeklyCycleDayOfWeek"
+ "id": "compute.publicAdvertisedPrefixes.delete",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "Up to 7 intervals/windows, one for each day of the week."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
+ "description": "Deletes the specified PublicAdvertisedPrefix",
+ "parameterOrder": [
+ "project",
+ "publicAdvertisedPrefix"
+ ]
}
- },
- "type": "object"
+ }
},
- "BulkInsertInstanceResource": {
- "properties": {
- "namePattern": {
- "description": "The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters.",
- "type": "string"
- },
- "instanceProperties": {
- "description": "The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.",
- "$ref": "InstanceProperties"
- },
- "locationPolicy": {
- "$ref": "LocationPolicy",
- "description": "Policy for chosing target zone. For more information, see Create VMs in bulk ."
- },
- "count": {
- "format": "int64",
- "description": "The maximum number of instances to create.",
- "type": "string"
- },
- "perInstanceProperties": {
- "additionalProperties": {
- "$ref": "BulkInsertInstanceResourcePerInstanceProperties"
+ "nodeTemplates": {
+ "methods": {
+ "insert": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "path": "projects/{project}/regions/{region}/nodeTemplates",
+ "request": {
+ "$ref": "NodeTemplate"
},
- "type": "object",
- "description": "Per-instance properties to be set on individual instances. Keys of this map specify requested instance names. Can be empty if name_pattern is used."
- },
- "sourceInstanceTemplate": {
- "type": "string",
- "description": "Specifies the instance template from which to create instances. You may combine sourceInstanceTemplate with instanceProperties to override specific values from an existing instance template. Bulk API follows the semantics of JSON Merge Patch described by RFC 7396. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate This field is optional."
- },
- "minCount": {
- "format": "int64",
- "description": "The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted.",
- "type": "string"
- }
- },
- "id": "BulkInsertInstanceResource",
- "type": "object",
- "description": "A transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert . This resource is not persisted anywhere, it is used only for processing the requests."
- },
- "InstanceManagedByIgmError": {
- "type": "object",
- "id": "InstanceManagedByIgmError",
- "properties": {
- "timestamp": {
- "description": "[Output Only] The time that this error occurred. This value is in RFC3339 text format.",
- "type": "string"
- },
- "error": {
- "description": "[Output Only] Contents of the error.",
- "$ref": "InstanceManagedByIgmErrorManagedInstanceError"
+ "id": "compute.nodeTemplates.insert",
+ "flatPath": "projects/{project}/regions/{region}/nodeTemplates",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Creates a NodeTemplate resource in the specified project using the data included in the request.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ }
+ }
},
- "instanceActionDetails": {
- "description": "[Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional.",
- "$ref": "InstanceManagedByIgmErrorInstanceActionDetails"
- }
- }
- },
- "BackendServicesScopedList": {
- "type": "object",
- "id": "BackendServicesScopedList",
- "properties": {
- "warning": {
- "properties": {
- "message": {
+ "getIamPolicy": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy",
+ "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy",
+ "id": "compute.nodeTemplates.getIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "optionsRequestedPolicyVersion": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Requested IAM Policy version."
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the region for this request.",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "path"
},
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "project": {
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "resource": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request.",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "location": "path"
}
},
- "description": "Informational warning which replaces the list of backend services when the list is empty.",
- "type": "object"
+ "httpMethod": "GET"
},
- "backendServices": {
- "items": {
- "$ref": "BackendService"
+ "setIamPolicy": {
+ "request": {
+ "$ref": "RegionSetPolicyRequest"
},
- "description": "A list of BackendServices contained in this scope.",
- "type": "array"
- }
- }
- },
- "RegionDisksResizeRequest": {
- "properties": {
- "sizeGb": {
- "type": "string",
- "description": "The new size of the regional persistent disk, which is specified in GB.",
- "format": "int64"
- }
- },
- "type": "object",
- "id": "RegionDisksResizeRequest"
- },
- "SecurityPoliciesAggregatedList": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#securityPolicyAggregatedList for lists of Security Policies.",
- "default": "compute#securityPoliciesAggregatedList",
- "type": "string"
- },
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy",
+ "parameters": {
+ "resource": {
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request.",
+ "type": "string"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the region for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
+ }
},
- "type": "array"
+ "id": "compute.nodeTemplates.setIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy",
+ "httpMethod": "POST"
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "list": {
+ "description": "Retrieves a list of node templates available to the specified project.",
+ "id": "compute.nodeTemplates.list",
+ "response": {
+ "$ref": "NodeTemplateList"
+ },
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "default": "500",
+ "type": "integer",
+ "minimum": "0",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
+ },
+ "region": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the region for this request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/nodeTemplates",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "path": "projects/{project}/regions/{region}/nodeTemplates",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "Project ID for this request.",
+ "required": true
},
- "data": {
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "region": {
+ "required": true,
+ "type": "string",
+ "description": "The name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "nodeTemplate": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the NodeTemplate resource to delete."
+ },
+ "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).",
+ "location": "query",
"type": "string"
}
},
- "type": "object"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "etag": {
- "type": "string"
- },
- "items": {
- "description": "A list of SecurityPoliciesScopedList resources.",
- "type": "object",
- "additionalProperties": {
- "$ref": "SecurityPoliciesScopedList",
- "description": "Name of the scope containing this set of security policies."
- }
- }
- },
- "id": "SecurityPoliciesAggregatedList"
- },
- "BackendServiceList": {
- "id": "BackendServiceList",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "region",
+ "nodeTemplate"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Deletes the specified NodeTemplate resource.",
+ "path": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
+ "httpMethod": "DELETE",
+ "id": "compute.nodeTemplates.delete"
},
- "warning": {
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "aggregatedList": {
+ "flatPath": "projects/{project}/aggregated/nodeTemplates",
+ "response": {
+ "$ref": "NodeTemplateAggregatedList"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "description": "Retrieves an aggregated list of node templates.",
+ "httpMethod": "GET",
+ "id": "compute.nodeTemplates.aggregatedList",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- },
- "type": "array"
+ "maxResults": {
+ "minimum": "0",
+ "default": "500",
+ "type": "integer",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query"
},
- "code": {
+ "orderBy": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "includeAllScopes": {
+ "type": "boolean",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
+ "path": "projects/{project}/aggregated/nodeTemplates",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "items": {
- "items": {
- "$ref": "BackendService"
+ "testIamPermissions": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions",
+ "response": {
+ "$ref": "TestPermissionsResponse"
},
- "description": "A list of BackendService resources.",
- "type": "array"
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.",
- "type": "string",
- "default": "compute#backendServiceList"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- }
- },
- "description": "Contains a list of BackendService resources.",
- "type": "object"
- },
- "TargetGrpcProxyList": {
- "type": "object",
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.nodeTemplates.testIamPermissions",
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "region": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
+ "response": {
+ "$ref": "NodeTemplate"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "nodeTemplate"
+ ],
+ "parameters": {
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "The name of the region for this request.",
+ "location": "path",
"type": "string"
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
+ "nodeTemplate": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the node template to return.",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
}
},
- "description": "[Output Only] Informational warning message."
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "TargetGrpcProxy"
- },
- "description": "A list of TargetGrpcProxy resources."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.",
- "default": "compute#targetGrpcProxyList",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- },
- "id": "TargetGrpcProxyList"
- },
- "NetworksAddPeeringRequest": {
- "type": "object",
- "id": "NetworksAddPeeringRequest",
- "properties": {
- "name": {
- "annotations": {
- "required": [
- "compute.networks.addPeering"
- ]
- },
- "description": "Name of the peering, which should conform to RFC1035.",
- "type": "string"
- },
- "peerNetwork": {
- "description": "URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.",
- "type": "string"
- },
- "networkPeering": {
- "$ref": "NetworkPeering",
- "description": "Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon."
- },
- "autoCreateRoutes": {
- "description": "This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.",
- "type": "boolean"
+ "path": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
+ "id": "compute.nodeTemplates.get",
+ "description": "Returns the specified node template. Gets a list of available node templates by making a list() request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
- "TargetSslProxiesSetCertificateMapRequest": {
- "type": "object",
- "properties": {
- "certificateMap": {
- "type": "string",
- "description": "URL of the Certificate Map to associate with this TargetSslProxy."
- }
- },
- "id": "TargetSslProxiesSetCertificateMapRequest"
- },
- "InterconnectAttachment": {
- "id": "InterconnectAttachment",
- "description": "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.",
- "type": "object",
- "properties": {
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
- },
- "partnerMetadata": {
- "$ref": "InterconnectAttachmentPartnerMetadata",
- "description": "Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED."
- },
- "bandwidth": {
- "enumDescriptions": [
- "100 Mbit/s",
- "10 Gbit/s",
- "1 Gbit/s",
- "200 Mbit/s",
- "20 Gbit/s",
- "2 Gbit/s",
- "300 Mbit/s",
- "400 Mbit/s",
- "500 Mbit/s",
- "50 Gbit/s",
- "50 Mbit/s",
- "5 Gbit/s"
+ "regionTargetHttpsProxies": {
+ "methods": {
+ "get": {
+ "id": "compute.regionTargetHttpsProxies.get",
+ "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
+ "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetHttpsProxy"
],
- "enum": [
- "BPS_100M",
- "BPS_10G",
- "BPS_1G",
- "BPS_200M",
- "BPS_20G",
- "BPS_2G",
- "BPS_300M",
- "BPS_400M",
- "BPS_500M",
- "BPS_50G",
- "BPS_50M",
- "BPS_5G"
+ "httpMethod": "GET",
+ "description": "Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "description": "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 "
- },
- "partnerAsn": {
- "format": "int64",
- "description": "Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.",
- "type": "string"
- },
- "cloudRouterIpv6Address": {
- "type": "string",
- "description": "[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment."
- },
- "satisfiesPzs": {
- "type": "boolean",
- "description": "[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."
+ "parameters": {
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region scoping this request."
+ },
+ "targetHttpsProxy": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "description": "Name of the TargetHttpsProxy resource to return."
+ }
+ },
+ "response": {
+ "$ref": "TargetHttpsProxy"
+ }
},
- "state": {
- "type": "string",
- "enumDescriptions": [
- "Indicates that attachment has been turned up and is ready to use.",
- "The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was wiped out, or because the other side of a Partner attachment was deleted.",
- "A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.",
- "PARTNER or PARTNER_PROVIDER attachment that is waiting for the customer to activate.",
- "A newly created PARTNER attachment that has not yet been configured on the Partner side.",
- "",
- "Indicates that attachment is not ready to use yet, because turnup is not complete."
+ "patch": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "ACTIVE",
- "DEFUNCT",
- "PARTNER_REQUEST_RECEIVED",
- "PENDING_CUSTOMER",
- "PENDING_PARTNER",
- "STATE_UNSPECIFIED",
- "UNPROVISIONED"
+ "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
+ "description": "Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.regionTargetHttpsProxies.patch",
+ "request": {
+ "$ref": "TargetHttpsProxy"
+ },
+ "parameters": {
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region for this request."
+ },
+ "targetHttpsProxy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "description": "Name of the TargetHttpsProxy resource to patch.",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetHttpsProxy"
],
- "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. "
+ "httpMethod": "PATCH",
+ "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}"
},
- "stackType": {
- "type": "string",
- "enumDescriptions": [
- "The interconnect attachment can have both IPv4 and IPv6 addresses.",
- "The interconnect attachment will only be assigned IPv4 addresses."
+ "insert": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "TargetHttpsProxy"
+ },
+ "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies",
+ "path": "projects/{project}/regions/{region}/targetHttpsProxies",
+ "description": "Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "IPV4_IPV6",
- "IPV4_ONLY"
+ "parameterOrder": [
+ "project",
+ "region"
],
- "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."
- },
- "googleReferenceId": {
- "description": "[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.",
- "type": "string"
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "id": "compute.regionTargetHttpsProxies.insert",
+ "httpMethod": "POST"
},
- "type": {
- "enumDescriptions": [
- "Attachment to a dedicated interconnect.",
- "Attachment to a partner interconnect, created by the customer.",
- "Attachment to a partner interconnect, created by the partner."
+ "setSslCertificates": {
+ "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "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. ",
- "type": "string",
- "enum": [
- "DEDICATED",
- "PARTNER",
- "PARTNER_PROVIDER"
+ "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
+ "request": {
+ "$ref": "RegionTargetHttpsProxiesSetSslCertificatesRequest"
+ },
+ "httpMethod": "POST",
+ "description": "Replaces SslCertificates for TargetHttpsProxy.",
+ "parameters": {
+ "region": {
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "targetHttpsProxy": {
+ "type": "string",
+ "required": true,
+ "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
+ },
+ "id": "compute.regionTargetHttpsProxies.setSslCertificates",
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetHttpsProxy"
]
},
- "cloudRouterIpAddress": {
- "description": "[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.",
- "type": "string"
- },
- "cloudRouterIpv6InterfaceId": {
- "description": "This field is not available.",
- "type": "string"
- },
- "adminEnabled": {
- "description": "Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.",
- "type": "boolean"
- },
- "candidateIpv6Subnets": {
- "items": {
- "type": "string"
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/regions/{region}/targetHttpsProxies",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies",
+ "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.",
+ "parameters": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "type": "integer",
+ "location": "query",
+ "minimum": "0"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ }
},
- "description": "This field is not available.",
- "type": "array"
- },
- "interconnect": {
- "description": "URL of the underlying Interconnect object that this attachment's traffic will traverse through.",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "customerRouterIpAddress": {
- "type": "string",
- "description": "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment."
- },
- "name": {
- "type": "string",
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "vlanTag8021q": {
- "description": "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.",
- "type": "integer",
- "format": "int32"
+ "response": {
+ "$ref": "TargetHttpsProxyList"
+ },
+ "id": "compute.regionTargetHttpsProxies.list"
},
- "encryption": {
- "type": "string",
- "description": "Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option. ",
- "enum": [
- "IPSEC",
- "NONE"
+ "delete": {
+ "httpMethod": "DELETE",
+ "id": "compute.regionTargetHttpsProxies.delete",
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetHttpsProxy"
],
- "enumDescriptions": [
- "The interconnect attachment will carry only encrypted traffic that is encrypted by an IPsec device such as HA VPN gateway; VMs cannot directly send traffic to or receive traffic from such an interconnect attachment. To use HA VPN over Cloud Interconnect, the interconnect attachment must be created with this option.",
- "This is the default value, which means the Interconnect Attachment will carry unencrypted traffic. VMs will be able to send traffic to or receive traffic from such interconnect attachment."
- ]
- },
- "ipsecInternalAddresses": {
- "type": "array",
- "items": {
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Deletes the specified TargetHttpsProxy resource.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
+ "parameters": {
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "targetHttpsProxy": {
+ "required": true,
+ "description": "Name of the TargetHttpsProxy resource to delete.",
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
},
- "description": "A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool. Not currently available publicly. "
+ "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}"
},
- "edgeAvailabilityDomain": {
- "description": "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.",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
+ "setUrlMap": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetHttpsProxy"
],
- "enum": [
- "AVAILABILITY_DOMAIN_1",
- "AVAILABILITY_DOMAIN_2",
- "AVAILABILITY_DOMAIN_ANY"
- ]
- },
- "customerRouterIpv6Address": {
- "description": "[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.",
- "type": "string"
- },
- "customerRouterIpv6InterfaceId": {
- "description": "This field is not available.",
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.",
- "type": "string",
- "default": "compute#interconnectAttachment"
- },
- "candidateSubnets": {
- "items": {
- "type": "string"
+ "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "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."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- },
- "pairingKey": {
- "type": "string",
- "description": "[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form \"XXXXX/region/domain\""
- },
- "privateInterconnectInfo": {
- "description": "[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.",
- "$ref": "InterconnectAttachmentPrivateInfo"
- },
- "router": {
- "description": "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.",
- "type": "string"
- },
- "operationalStatus": {
- "type": "string",
- "enum": [
- "OS_ACTIVE",
- "OS_UNPROVISIONED"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. ",
- "enumDescriptions": [
- "Indicates that attachment has been turned up and is ready to use.",
- "Indicates that attachment is not ready to use yet, because turnup is not complete."
- ]
- },
- "mtu": {
- "format": "int32",
- "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.",
- "type": "integer"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "dataplaneVersion": {
- "format": "int32",
- "type": "integer",
- "description": "[Output Only] 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."
+ "httpMethod": "POST",
+ "id": "compute.regionTargetHttpsProxies.setUrlMap",
+ "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
+ "description": "Changes the URL map for TargetHttpsProxy.",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "targetHttpsProxy": {
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the TargetHttpsProxy to set a URL map for.",
+ "location": "path"
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "location": "path"
+ }
+ },
+ "request": {
+ "$ref": "UrlMapReference"
+ }
}
}
},
- "InstanceGroupsListInstances": {
- "id": "InstanceGroupsListInstances",
- "properties": {
- "kind": {
- "description": "[Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.",
- "default": "compute#instanceGroupsListInstances",
- "type": "string"
- },
- "warning": {
- "properties": {
- "message": {
+ "globalPublicDelegatedPrefixes": {
+ "methods": {
+ "list": {
+ "description": "Lists the global PublicDelegatedPrefixes for a project.",
+ "path": "projects/{project}/global/publicDelegatedPrefixes",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Project ID for this request."
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "filter": {
+ "location": "query",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- }
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "type": "integer"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "response": {
+ "$ref": "PublicDelegatedPrefixList"
+ },
+ "flatPath": "projects/{project}/global/publicDelegatedPrefixes",
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "id": "compute.globalPublicDelegatedPrefixes.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
+ "delete": {
+ "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "publicDelegatedPrefix": {
+ "required": true,
+ "description": "Name of the PublicDelegatedPrefix resource to delete.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "publicDelegatedPrefix"
+ ],
+ "id": "compute.globalPublicDelegatedPrefixes.delete",
+ "description": "Deletes the specified global PublicDelegatedPrefix.",
+ "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "items": {
- "description": "A list of InstanceWithNamedPorts resources.",
- "type": "array",
- "items": {
- "$ref": "InstanceWithNamedPorts"
+ "patch": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "publicDelegatedPrefix": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "description": "Name of the PublicDelegatedPrefix resource to patch.",
+ "type": "string"
+ }
+ },
+ "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
+ "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
+ "httpMethod": "PATCH",
+ "description": "Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
+ "parameterOrder": [
+ "project",
+ "publicDelegatedPrefix"
+ ],
+ "id": "compute.globalPublicDelegatedPrefixes.patch",
+ "request": {
+ "$ref": "PublicDelegatedPrefix"
+ },
+ "response": {
+ "$ref": "Operation"
}
},
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "InterconnectDiagnosticsARPEntry": {
- "description": "Describing the ARP neighbor entries seen on this link",
- "properties": {
- "macAddress": {
- "description": "The MAC address of this ARP neighbor.",
- "type": "string"
+ "insert": {
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ }
+ },
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "PublicDelegatedPrefix"
+ },
+ "path": "projects/{project}/global/publicDelegatedPrefixes",
+ "id": "compute.globalPublicDelegatedPrefixes.insert",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.",
+ "flatPath": "projects/{project}/global/publicDelegatedPrefixes"
},
- "ipAddress": {
- "type": "string",
- "description": "The IP address of this ARP neighbor."
- }
- },
- "type": "object",
- "id": "InterconnectDiagnosticsARPEntry"
- },
- "TargetInstancesScopedList": {
- "id": "TargetInstancesScopedList",
- "type": "object",
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "get": {
+ "httpMethod": "GET",
+ "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
+ "description": "Returns the specified global PublicDelegatedPrefix resource.",
+ "parameterOrder": [
+ "project",
+ "publicDelegatedPrefix"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
},
- "code": {
+ "publicDelegatedPrefix": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "required": true,
+ "location": "path",
+ "description": "Name of the PublicDelegatedPrefix resource to return."
+ }
+ },
+ "response": {
+ "$ref": "PublicDelegatedPrefix"
+ },
+ "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
+ "id": "compute.globalPublicDelegatedPrefixes.get"
+ }
+ }
+ },
+ "instances": {
+ "methods": {
+ "getSerialPortOutput": {
+ "description": "Returns the last 1 MB of serial port output from the specified instance.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/serialPort",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/serialPort",
+ "httpMethod": "GET",
+ "id": "compute.instances.getSerialPortOutput",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string"
},
- "message": {
+ "instance": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Name of the instance for this request.",
+ "required": true
+ },
+ "port": {
+ "description": "Specifies which COM or serial port to retrieve data from.",
+ "default": "1",
+ "type": "integer",
+ "location": "query",
+ "minimum": "1",
+ "format": "int32",
+ "maximum": "4"
+ },
+ "start": {
+ "format": "int64",
+ "description": "Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`. If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true
}
},
- "description": "Informational warning which replaces the list of addresses when the list is empty."
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "response": {
+ "$ref": "SerialPortOutput"
+ }
},
- "targetInstances": {
- "type": "array",
- "items": {
- "$ref": "TargetInstance"
+ "setTags": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setTags",
+ "id": "compute.instances.setTags",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "description": "A list of target instances contained in this scope."
- }
- }
- },
- "Autoscaler": {
- "description": "Represents an Autoscaler resource. Google Compute Engine has two Autoscaler resources: * [Zonal](/compute/docs/reference/rest/v1/autoscalers) * [Regional](/compute/docs/reference/rest/v1/regionAutoscalers) Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource.",
- "properties": {
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string",
- "format": "uint64"
- },
- "region": {
- "description": "[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).",
- "type": "string"
- },
- "target": {
- "description": "URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.",
- "type": "string"
- },
- "zone": {
- "description": "[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).",
- "type": "string"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "statusDetails": {
- "items": {
- "$ref": "AutoscalerStatusDetails"
+ "parameters": {
+ "zone": {
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "instance": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the instance scoping this request.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ }
},
- "description": "[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.",
- "type": "array"
- },
- "autoscalingPolicy": {
- "$ref": "AutoscalingPolicy",
- "description": "The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "recommendedSize": {
- "description": "[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction.",
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string",
- "description": "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.",
- "annotations": {
- "required": [
- "compute.autoscalers.insert"
- ]
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setTags",
+ "request": {
+ "$ref": "Tags"
},
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.",
- "type": "string",
- "default": "compute#autoscaler"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
+ "description": "Sets network tags for the specified instance to the data included in the request.",
+ "httpMethod": "POST"
},
- "scalingScheduleStatus": {
- "additionalProperties": {
- "$ref": "ScalingScheduleStatus"
+ "listReferrers": {
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/referrers",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "description": "Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.",
+ "id": "compute.instances.listReferrers",
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the zone for this request."
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "instance": {
+ "description": "Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "-|[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ }
},
- "type": "object",
- "description": "[Output Only] Status information of existing scaling schedules."
- },
- "status": {
- "description": "[Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.",
- "enum": [
- "ACTIVE",
- "DELETING",
- "ERROR",
- "PENDING"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "enumDescriptions": [
- "Configuration is acknowledged to be effective",
- "Configuration is being deleted",
- "Configuration has errors. Actionable for users.",
- "Autoscaler backend hasn't read new/updated configuration"
- ]
- }
- },
- "type": "object",
- "id": "Autoscaler"
- },
- "ResourcePolicyWeeklyCycleDayOfWeek": {
- "id": "ResourcePolicyWeeklyCycleDayOfWeek",
- "type": "object",
- "properties": {
- "duration": {
- "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.",
- "type": "string"
- },
- "startTime": {
- "type": "string",
- "description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT."
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/referrers",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "InstanceListReferrers"
+ }
},
- "day": {
- "type": "string",
- "enum": [
- "FRIDAY",
- "INVALID",
- "MONDAY",
- "SATURDAY",
- "SUNDAY",
- "THURSDAY",
- "TUESDAY",
- "WEDNESDAY"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
+ "updateShieldedInstanceConfig": {
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig",
+ "id": "compute.instances.updateShieldedInstanceConfig",
+ "description": "Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY."
- }
- }
- },
- "RegionInstanceGroupManagerPatchInstanceConfigReq": {
- "type": "object",
- "description": "RegionInstanceGroupManagers.patchPerInstanceConfigs",
- "properties": {
- "perInstanceConfigs": {
- "items": {
- "$ref": "PerInstanceConfig"
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig",
+ "httpMethod": "PATCH",
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "instance": {
+ "description": "Name or id of the instance scoping this request.",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path"
+ }
},
- "type": "array",
- "description": "The list of per-instance configurations to insert or patch on this managed instance group."
- }
- },
- "id": "RegionInstanceGroupManagerPatchInstanceConfigReq"
- },
- "ForwardingRuleServiceDirectoryRegistration": {
- "id": "ForwardingRuleServiceDirectoryRegistration",
- "properties": {
- "service": {
- "description": "Service Directory service to register the forwarding rule under.",
- "type": "string"
- },
- "namespace": {
- "type": "string",
- "description": "Service Directory namespace to register the forwarding rule under."
- },
- "serviceDirectoryRegion": {
- "description": "[Optional] Service Directory region to register this global forwarding rule under. Default to \"us-central1\". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.",
- "type": "string"
- }
- },
- "description": "Describes the auto-registration of the Forwarding Rule to Service Directory. The region and project of the Service Directory resource generated from this registration will be the same as this Forwarding Rule.",
- "type": "object"
- },
- "MachineTypeList": {
- "properties": {
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.",
- "type": "string",
- "default": "compute#machineTypeList"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "request": {
+ "$ref": "ShieldedInstanceConfig"
+ }
},
- "warning": {
- "type": "object",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "sendDiagnosticInterrupt": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
"type": "string"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "instance": {
+ "location": "path",
+ "type": "string",
+ "description": "Name of the instance scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true
+ }
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt",
+ "id": "compute.instances.sendDiagnosticInterrupt",
+ "description": "Sends diagnostic interrupt to the instance."
+ },
+ "setDiskAutoDelete": {
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
+ "description": "Sets the auto-delete flag for a disk attached to an instance.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "parameters": {
+ "autoDelete": {
+ "location": "query",
+ "type": "boolean",
+ "required": true,
+ "description": "Whether to auto-delete the disk when the instance is deleted."
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "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).",
+ "location": "query",
"type": "string"
+ },
+ "instance": {
+ "description": "The instance name for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "deviceName": {
+ "type": "string",
+ "location": "query",
+ "description": "The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.",
+ "pattern": "\\w[\\w.-]{0,254}",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "The name of the zone for this request."
}
},
- "description": "[Output Only] Informational warning message."
- },
- "items": {
- "description": "A list of MachineType resources.",
- "type": "array",
- "items": {
- "$ref": "MachineType"
- }
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance",
+ "autoDelete",
+ "deviceName"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.instances.setDiskAutoDelete"
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- }
- },
- "id": "MachineTypeList",
- "description": "Contains a list of machine types.",
- "type": "object"
- },
- "NetworkEndpointGroupAggregatedList": {
- "id": "NetworkEndpointGroupAggregatedList",
- "type": "object",
- "properties": {
- "items": {
- "description": "A list of NetworkEndpointGroupsScopedList resources.",
- "additionalProperties": {
- "$ref": "NetworkEndpointGroupsScopedList",
- "description": "The name of the scope that contains this set of network endpoint groups."
+ "setMachineResources": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources",
+ "response": {
+ "$ref": "Operation"
},
- "type": "object"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "kind": {
- "default": "compute#networkEndpointGroupAggregatedList",
- "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "warning": {
- "type": "object",
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "type": "array"
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources",
+ "description": "Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "parameters": {
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
"type": "string"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "instance": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the instance scoping this request.",
+ "required": true,
+ "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).",
+ "location": "query",
"type": "string"
}
},
- "description": "[Output Only] Informational warning message."
- },
- "unreachables": {
- "items": {
- "type": "string"
- },
- "description": "[Output Only] Unreachable resources.",
- "type": "array"
+ "httpMethod": "POST",
+ "id": "compute.instances.setMachineResources",
+ "request": {
+ "$ref": "InstancesSetMachineResourcesRequest"
+ }
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- }
- },
- "BackendBucketCdnPolicyBypassCacheOnRequestHeader": {
- "properties": {
- "headerName": {
- "type": "string",
- "description": "The header field name to match on when bypassing cache. Values are case-insensitive."
- }
- },
- "type": "object",
- "id": "BackendBucketCdnPolicyBypassCacheOnRequestHeader",
- "description": "Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting."
- },
- "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy": {
- "id": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy",
- "properties": {
- "type": {
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
+ "attachDisk": {
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
],
- "enum": [
- "HIERARCHY",
- "NETWORK",
- "UNSPECIFIED"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[Output Only] The type of the firewall policy."
- },
- "rules": {
- "description": "The rules that apply to the network.",
- "type": "array",
- "items": {
- "$ref": "FirewallPolicyRule"
- }
- },
- "displayName": {
- "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.",
- "type": "string"
- },
- "shortName": {
- "type": "string",
- "description": "[Output Only] The short name of the firewall policy."
- },
- "name": {
- "type": "string",
- "description": "[Output Only] The name of the firewall policy."
- }
- },
- "type": "object"
- },
- "FirewallPolicyRule": {
- "properties": {
- "kind": {
- "type": "string",
- "description": "[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules",
- "default": "compute#firewallPolicyRule"
- },
- "ruleTupleCount": {
- "format": "int32",
- "description": "[Output Only] Calculation of the complexity of a single firewall policy rule.",
- "type": "integer"
- },
- "match": {
- "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.",
- "$ref": "FirewallPolicyRuleMatcher"
- },
- "description": {
- "description": "An optional description for this resource.",
- "type": "string"
- },
- "targetSecureTags": {
- "description": "A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.",
- "items": {
- "$ref": "FirewallPolicyRuleSecureTag"
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk",
+ "id": "compute.instances.attachDisk",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk",
+ "request": {
+ "$ref": "AttachedDisk"
},
- "type": "array"
- },
- "enableLogging": {
- "type": "boolean",
- "description": "Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules."
- },
- "disabled": {
- "description": "Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.",
- "type": "boolean"
- },
- "targetResources": {
- "type": "array",
- "description": "A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.",
- "items": {
- "type": "string"
+ "description": "Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "zone": {
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "The name of the zone for this request."
+ },
+ "forceAttach": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error."
+ },
+ "instance": {
+ "description": "The instance name for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
+ },
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
}
},
- "targetServiceAccounts": {
- "description": "A list of service accounts indicating the sets of instances that are applied with this rule.",
- "items": {
- "type": "string"
+ "getEffectiveFirewalls": {
+ "parameters": {
+ "instance": {
+ "type": "string",
+ "required": true,
+ "description": "Name of the instance scoping this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "networkInterface": {
+ "description": "The name of the network interface to get the effective firewalls.",
+ "required": true,
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone for this request."
+ }
},
- "type": "array"
- },
- "action": {
- "type": "string",
- "description": "The Action to perform when the client connection triggers the rule. Can currently be either \"allow\" or \"deny()\" where valid values for status are 403, 404, and 502."
- },
- "direction": {
- "description": "The direction in which this rule applies.",
- "enumDescriptions": [
- "",
- ""
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls",
+ "response": {
+ "$ref": "InstancesGetEffectiveFirewallsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "EGRESS",
- "INGRESS"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance",
+ "networkInterface"
],
- "type": "string"
- },
- "ruleName": {
- "type": "string",
- "description": "An optional name for the rule. This field is not a unique identifier and can be updated."
- },
- "priority": {
- "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.",
- "type": "integer",
- "format": "int32"
- }
- },
- "type": "object",
- "id": "FirewallPolicyRule",
- "description": "Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny)."
- },
- "RouteAsPath": {
- "type": "object",
- "id": "RouteAsPath",
- "properties": {
- "asLists": {
- "items": {
- "format": "uint32",
- "type": "integer"
- },
- "type": "array",
- "description": "[Output Only] The AS numbers of the AS Path."
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls",
+ "httpMethod": "GET",
+ "id": "compute.instances.getEffectiveFirewalls",
+ "description": "Returns effective firewalls applied to an interface of the instance."
},
- "pathSegmentType": {
- "enum": [
- "AS_CONFED_SEQUENCE",
- "AS_CONFED_SET",
- "AS_SEQUENCE",
- "AS_SET"
+ "bulkInsert": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[Output Only] The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed ",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ]
- }
- }
- },
- "InterconnectLocationList": {
- "id": "InterconnectLocationList",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations.",
- "default": "compute#interconnectLocationList"
- },
- "warning": {
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "httpMethod": "POST",
+ "path": "projects/{project}/zones/{zone}/instances/bulkInsert",
+ "description": "Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.",
+ "parameters": {
+ "zone": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "requestId": {
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "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"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
"type": "string"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "items": {
- "items": {
- "$ref": "InterconnectLocation"
- },
- "description": "A list of InterconnectLocation resources.",
- "type": "array"
- }
- },
- "description": "Response to the list request, and contains a list of interconnect locations."
- },
- "XpnResourceId": {
- "description": "Service resource (a.k.a service project) ID.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678)."
- },
- "type": {
- "type": "string",
- "description": "The type of the service resource.",
- "enumDescriptions": [
- "",
- ""
+ "id": "compute.instances.bulkInsert",
+ "flatPath": "projects/{project}/zones/{zone}/instances/bulkInsert",
+ "parameterOrder": [
+ "project",
+ "zone"
],
- "enum": [
- "PROJECT",
- "XPN_RESOURCE_TYPE_UNSPECIFIED"
- ]
- }
- },
- "type": "object",
- "id": "XpnResourceId"
- },
- "InstanceGroupManagerVersion": {
- "properties": {
- "instanceTemplate": {
- "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.",
- "type": "string"
- },
- "targetSize": {
- "$ref": "FixedOrPercent",
- "description": "Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information."
- },
- "name": {
- "description": "Name of the version. Unique among all versions in the scope of this managed instance group.",
- "type": "string"
- }
- },
- "id": "InstanceGroupManagerVersion",
- "type": "object"
- },
- "Disk": {
- "description": "Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * [Zonal](/compute/docs/reference/rest/v1/disks) * [Regional](/compute/docs/reference/rest/v1/regionDisks) Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.",
- "type": "object",
- "id": "Disk",
- "properties": {
- "options": {
- "type": "string",
- "description": "Internal use only."
- },
- "sourceDiskId": {
- "type": "string",
- "description": "[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used."
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "users": {
- "description": "[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "kind": {
- "default": "compute#disk",
- "description": "[Output Only] Type of the resource. Always compute#disk for disks.",
- "type": "string"
- },
- "sourceSnapshotEncryptionKey": {
- "description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.",
- "$ref": "CustomerEncryptionKey"
- },
- "name": {
- "annotations": {
- "required": [
- "compute.disks.insert"
- ]
+ "request": {
+ "$ref": "BulkInsertInstanceResource"
},
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "sourceImageId": {
- "type": "string",
- "description": "[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used."
- },
- "zone": {
- "description": "[Output Only] URL of the zone where the disk 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"
- },
- "region": {
- "description": "[Output Only] URL of the region where the disk resides. Only applicable for regional resources. 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"
+ "response": {
+ "$ref": "Operation"
+ }
},
- "resourcePolicies": {
- "items": {
- "type": "string"
+ "setMinCpuPlatform": {
+ "request": {
+ "$ref": "InstancesSetMinCpuPlatformRequest"
},
- "description": "Resource policies applied to this disk for automatic snapshot creations.",
- "type": "array"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined fully-qualified URL for this resource.",
- "type": "string"
- },
- "params": {
- "$ref": "DiskParams",
- "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload."
- },
- "labels": {
- "description": "Labels to apply to this disk. These can be later modified by the setLabels method.",
- "additionalProperties": {
- "type": "string"
+ "description": "Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "instance": {
+ "description": "Name of the instance scoping this request.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "zone": {
+ "required": true,
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ }
},
- "type": "object"
- },
- "sourceDisk": {
- "type": "string",
- "description": "The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk "
- },
- "sourceSnapshot": {
- "type": "string",
- "description": "The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot "
- },
- "replicaZones": {
- "type": "array",
- "items": {
- "type": "string"
+ "response": {
+ "$ref": "Operation"
},
- "description": "URLs of the zones where the disk should be replicated to. Only applicable for regional resources."
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "sourceStorageObject": {
- "type": "string",
- "description": "The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead."
- },
- "provisionedIops": {
- "type": "string",
- "description": "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.",
- "format": "int64"
- },
- "sizeGb": {
- "description": "Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive.",
- "type": "string",
- "format": "int64"
- },
- "type": {
- "description": "URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.",
- "type": "string"
- },
- "diskEncryptionKey": {
- "description": "Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key *version* name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: \"diskEncryptionKey.kmsKeyName\": \"projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.",
- "$ref": "CustomerEncryptionKey"
- },
- "physicalBlockSizeBytes": {
- "type": "string",
- "description": "Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.",
- "format": "int64"
- },
- "architecture": {
- "enum": [
- "ARCHITECTURE_UNSPECIFIED",
- "ARM64",
- "X86_64"
+ "id": "compute.instances.setMinCpuPlatform",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "Default value indicating Architecture is not set.",
- "Machines with architecture ARM64",
- "Machines with architecture X86_64"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
],
- "description": "The architecture of the disk. Valid values are ARM64 or X86_64.",
- "type": "string"
- },
- "sourceSnapshotId": {
- "description": "[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.",
- "type": "string"
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform"
},
- "guestOsFeatures": {
- "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.",
- "items": {
- "$ref": "GuestOsFeature"
+ "aggregatedList": {
+ "path": "projects/{project}/aggregated/instances",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/aggregated/instances",
+ "parameters": {
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "location": "query",
+ "format": "uint32",
+ "minimum": "0",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string"
+ }
},
- "type": "array"
- },
- "licenses": {
- "description": "A list of publicly visible licenses. Reserved for Google's use.",
- "items": {
- "type": "string"
+ "id": "compute.instances.aggregatedList",
+ "response": {
+ "$ref": "InstanceAggregatedList"
},
- "type": "array"
- },
- "locationHint": {
- "description": "An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.",
- "type": "string"
- },
- "sourceImage": {
- "description": "The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family ",
- "type": "string"
- },
- "labelFingerprint": {
- "description": "A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.",
- "format": "byte",
- "type": "string"
- },
- "status": {
- "enumDescriptions": [
- "Disk is provisioning",
- "Disk is deleting.",
- "Disk creation failed.",
- "Disk is ready for use.",
- "Source data is being copied into the disk."
- ],
- "description": "[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. ",
- "enum": [
- "CREATING",
- "DELETING",
- "FAILED",
- "READY",
- "RESTORING"
+ "parameterOrder": [
+ "project"
],
- "type": "string"
- },
- "lastDetachTimestamp": {
- "type": "string",
- "description": "[Output Only] Last detach timestamp in RFC3339 text format."
- },
- "lastAttachTimestamp": {
- "description": "[Output Only] Last attach timestamp in RFC3339 text format.",
- "type": "string"
+ "description": "Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.",
+ "httpMethod": "GET"
},
- "licenseCodes": {
- "items": {
- "type": "string",
- "format": "int64"
+ "get": {
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.instances.get",
+ "httpMethod": "GET",
+ "description": "Returns the specified Instance resource. Gets a list of available instances by making a list() request.",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path",
+ "description": "The name of the zone for this request.",
+ "required": true
+ },
+ "instance": {
+ "description": "Name of the instance resource to return.",
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ }
},
- "type": "array",
- "description": "Integer license codes indicating which licenses are attached to this disk."
- },
- "sourceImageEncryptionKey": {
- "$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."
- },
- "satisfiesPzs": {
- "type": "boolean",
- "description": "[Output Only] Reserved for future use."
- },
- "id": {
- "type": "string",
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
- }
- }
- },
- "LicenseResourceRequirements": {
- "type": "object",
- "properties": {
- "minMemoryMb": {
- "description": "Minimum memory required to use the Instance. Enforced at Instance creation and Instance start.",
- "type": "integer",
- "format": "int32"
- },
- "minGuestCpuCount": {
- "type": "integer",
- "format": "int32",
- "description": "Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start."
- }
- },
- "id": "LicenseResourceRequirements"
- },
- "NodeGroupsSetNodeTemplateRequest": {
- "properties": {
- "nodeTemplate": {
- "description": "Full or partial URL of the node template resource to be updated for this node group.",
- "type": "string"
- }
- },
- "id": "NodeGroupsSetNodeTemplateRequest",
- "type": "object"
- },
- "InstanceGroupManagersPatchPerInstanceConfigsReq": {
- "description": "InstanceGroupManagers.patchPerInstanceConfigs",
- "id": "InstanceGroupManagersPatchPerInstanceConfigsReq",
- "properties": {
- "perInstanceConfigs": {
- "description": "The list of per-instance configurations to insert or patch on this managed instance group.",
- "items": {
- "$ref": "PerInstanceConfig"
+ "response": {
+ "$ref": "Instance"
},
- "type": "array"
- }
- },
- "type": "object"
- },
- "InstancesStartWithEncryptionKeyRequest": {
- "properties": {
- "disks": {
- "type": "array",
- "items": {
- "$ref": "CustomerEncryptionKeyProtectedDisk"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ]
+ },
+ "suspend": {
+ "description": "This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/suspend",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/suspend",
+ "id": "compute.instances.suspend",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "instance": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "description": "Name of the instance resource to suspend.",
+ "required": true
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "zone": {
+ "type": "string",
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "discardLocalSsd": {
+ "type": "boolean",
+ "description": "If true, discard the contents of any attached localSSD partitions. Default value is false.",
+ "location": "query"
+ }
},
- "description": "Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified."
- }
- },
- "id": "InstancesStartWithEncryptionKeyRequest",
- "type": "object"
- },
- "ReservationList": {
- "type": "object",
- "id": "ReservationList",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ]
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "simulateMaintenanceEvent": {
+ "parameters": {
+ "zone": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "location": "path"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "instance": {
+ "description": "Name of the instance scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "required": true
}
- }
- },
- "kind": {
- "default": "compute#reservationList",
- "type": "string",
- "description": "[Output Only] Type of resource.Always compute#reservationsList for listsof reservations"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "items": {
- "description": "[Output Only] A list of Allocation resources.",
- "type": "array",
- "items": {
- "$ref": "Reservation"
- }
- }
- }
- },
- "NodeTemplate": {
- "id": "NodeTemplate",
- "properties": {
- "nodeTypeFlexibility": {
- "description": "The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both.",
- "$ref": "NodeTemplateNodeTypeFlexibility"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.instances.simulateMaintenanceEvent",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent",
+ "description": "Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.",
+ "httpMethod": "POST"
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
+ "updateAccessConfig": {
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance",
+ "networkInterface"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig",
+ "httpMethod": "POST",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig",
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "request": {
+ "$ref": "AccessConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "instance": {
+ "required": true,
+ "description": "The instance name for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true
+ },
+ "zone": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "location": "path"
+ },
+ "networkInterface": {
+ "required": true,
+ "type": "string",
+ "location": "query",
+ "description": "The name of the network interface where the access config is attached."
+ }
+ },
+ "id": "compute.instances.updateAccessConfig"
},
- "status": {
- "enumDescriptions": [
- "Resources are being allocated.",
- "The node template is currently being deleted.",
- "Invalid status.",
- "The node template is ready."
+ "setMetadata": {
+ "request": {
+ "$ref": "Metadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "enum": [
- "CREATING",
- "DELETING",
- "INVALID",
- "READY"
+ "id": "compute.instances.setMetadata",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
],
- "description": "[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING."
+ "description": "Sets metadata for the specified instance to the data included in the request.",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
+ },
+ "instance": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "description": "Name of the instance scoping this request.",
+ "location": "path"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "httpMethod": "POST"
},
- "cpuOvercommitType": {
- "enum": [
- "CPU_OVERCOMMIT_TYPE_UNSPECIFIED",
- "ENABLED",
- "NONE"
+ "list": {
+ "description": "Retrieves the list of instances contained within the specified zone.",
+ "path": "projects/{project}/zones/{zone}/instances",
+ "response": {
+ "$ref": "InstanceList"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "description": "CPU overcommit.",
- "enumDescriptions": [
- "",
- "",
- ""
+ "flatPath": "projects/{project}/zones/{zone}/instances",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "maxResults": {
+ "minimum": "0",
+ "location": "query",
+ "format": "uint32",
+ "type": "integer",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "required": true
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "id": "compute.instances.list",
+ "parameterOrder": [
+ "project",
+ "zone"
]
},
- "nodeAffinityLabels": {
- "additionalProperties": {
- "type": "string"
+ "stop": {
+ "description": "Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.",
+ "id": "compute.instances.stop",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/stop",
+ "parameters": {
+ "instance": {
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the instance resource to stop."
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "zone": {
+ "type": "string",
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "discardLocalSsd": {
+ "type": "boolean",
+ "location": "query",
+ "description": "If true, discard the contents of any attached localSSD partitions. Default value is false."
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ }
},
- "description": "Labels to use for node affinity, which will be used in instance scheduling.",
- "type": "object"
- },
- "name": {
- "description": "The name of the resource, provided by the client when initially creating the resource. The resource 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.",
- "type": "string"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] The name of the region where the node template resides, such as us-central1."
- },
- "statusMessage": {
- "description": "[Output Only] An optional, human-readable explanation of the status.",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "serverBinding": {
- "description": "Sets the binding properties for the physical server. Valid values include: - *[Default]* RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information.",
- "$ref": "ServerBinding"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "default": "compute#nodeTemplate",
- "description": "[Output Only] The type of the resource. Always compute#nodeTemplate for node templates."
- },
- "nodeType": {
- "type": "string",
- "description": "The node type to use for nodes group that are created from this template."
- },
- "disks": {
- "type": "array",
- "items": {
- "$ref": "LocalDisk"
- }
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "accelerators": {
- "items": {
- "$ref": "AcceleratorConfig"
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- }
- },
- "description": "Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances.",
- "type": "object"
- },
- "ManagedInstance": {
- "type": "object",
- "id": "ManagedInstance",
- "properties": {
- "preservedStateFromConfig": {
- "$ref": "PreservedState",
- "description": "[Output Only] Preserved state applied from per-instance config for this instance."
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/stop",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "httpMethod": "POST"
},
- "instanceHealth": {
- "description": "[Output Only] Health state of the instance per health-check.",
- "items": {
- "$ref": "ManagedInstanceInstanceHealth"
+ "getIamPolicy": {
+ "httpMethod": "GET",
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "parameters": {
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "optionsRequestedPolicyVersion": {
+ "type": "integer",
+ "location": "query",
+ "description": "Requested IAM Policy version.",
+ "format": "int32"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "id": "compute.instances.getIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "Policy"
},
- "type": "array"
+ "path": "projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy"
},
- "currentAction": {
- "enum": [
- "ABANDONING",
- "CREATING",
- "CREATING_WITHOUT_RETRIES",
- "DELETING",
- "NONE",
- "RECREATING",
- "REFRESHING",
- "RESTARTING",
- "RESUMING",
- "STARTING",
- "STOPPING",
- "SUSPENDING",
- "VERIFYING"
+ "resume": {
+ "id": "compute.instances.resume",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.",
- "The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.",
- "The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.",
- "The managed instance group is permanently deleting this instance.",
- "The managed instance group has not scheduled any actions for this instance.",
- "The managed instance group is recreating this instance.",
- "The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.",
- "The managed instance group is restarting this instance.",
- "The managed instance group is resuming this instance.",
- "The managed instance group is starting this instance.",
- "The managed instance group is stopping this instance.",
- "The managed instance group is suspending this instance.",
- "The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions)."
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "zone": {
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "required": true
+ },
+ "instance": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the instance resource to resume.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
],
- "type": "string",
- "description": "[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. "
- },
- "id": {
- "description": "[Output only] The unique identifier for this resource. This field is empty when instance does not exist.",
- "format": "uint64",
- "type": "string"
- },
- "instance": {
- "type": "string",
- "description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created."
- },
- "lastAttempt": {
- "description": "[Output Only] Information about the last attempt to create or delete the instance.",
- "$ref": "ManagedInstanceLastAttempt"
- },
- "preservedStateFromPolicy": {
- "$ref": "PreservedState",
- "description": "[Output Only] Preserved state generated based on stateful policy for this instance."
+ "description": "Resumes an instance that was suspended using the instances().suspend method.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/resume",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/resume"
},
- "instanceStatus": {
- "type": "string",
- "enumDescriptions": [
- "The Nanny is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.",
- "Resources are being allocated for the instance.",
- "The instance is in repair.",
- "The instance is running.",
- "All required resources have been allocated and the instance is being started.",
- "The instance has stopped successfully.",
- "The instance is currently stopping (either being deleted or killed).",
- "The instance has suspended.",
- "The instance is suspending.",
- "The instance has stopped (either by explicit action or underlying failure)."
+ "addAccessConfig": {
+ "description": "Adds an access config to an instance's network interface.",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "AccessConfig"
+ },
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance",
+ "networkInterface"
],
- "description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.",
- "enum": [
- "DEPROVISIONING",
- "PROVISIONING",
- "REPAIRING",
- "RUNNING",
- "STAGING",
- "STOPPED",
- "STOPPING",
- "SUSPENDED",
- "SUSPENDING",
- "TERMINATED"
- ]
- },
- "version": {
- "description": "[Output Only] Intended version of this instance.",
- "$ref": "ManagedInstanceVersion"
- }
- },
- "description": "A Managed Instance resource."
- },
- "InstanceGroupsScopedList": {
- "id": "InstanceGroupsScopedList",
- "properties": {
- "warning": {
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.instances.addAccessConfig",
+ "parameters": {
+ "instance": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "The instance name for this request.",
+ "location": "path",
+ "required": true,
"type": "string"
},
- "code": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "The name of the zone for this request.",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "location": "path"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- }
+ "project": {
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "networkInterface": {
+ "required": true,
+ "location": "query",
+ "type": "string",
+ "description": "The name of the network interface to add to this instance."
+ }
+ }
+ },
+ "setMachineType": {
+ "id": "compute.instances.setMachineType",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "instance": {
+ "description": "Name of the instance scoping this request.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "zone": {
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
}
},
- "description": "[Output Only] An informational warning that replaces the list of instance groups when the list is empty.",
- "type": "object"
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "request": {
+ "$ref": "InstancesSetMachineTypeRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "description": "Changes the machine type for a stopped instance to the machine type specified in the request.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType"
},
- "instanceGroups": {
- "description": "[Output Only] The list of instance groups that are contained in this scope.",
- "items": {
- "$ref": "InstanceGroup"
+ "setDeletionProtection": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection",
+ "path": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection",
+ "description": "Sets deletion protection on the instance.",
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "deletionProtection": {
+ "default": "true",
+ "description": "Whether the resource should be protected against deletion.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "zone": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path",
+ "description": "The name of the zone for this request."
+ },
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name or id of the resource for this request."
+ }
},
- "type": "array"
- }
- },
- "type": "object"
- },
- "SourceDiskEncryptionKey": {
- "type": "object",
- "id": "SourceDiskEncryptionKey",
- "properties": {
- "diskEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key."
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "id": "compute.instances.setDeletionProtection"
},
- "sourceDisk": {
- "description": "URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk ",
- "type": "string"
- }
- }
- },
- "AutoscalerStatusDetails": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "ALL_INSTANCES_UNHEALTHY",
- "BACKEND_SERVICE_DOES_NOT_EXIST",
- "CAPPED_AT_MAX_NUM_REPLICAS",
- "CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE",
- "CUSTOM_METRIC_INVALID",
- "MIN_EQUALS_MAX",
- "MISSING_CUSTOM_METRIC_DATA_POINTS",
- "MISSING_LOAD_BALANCING_DATA_POINTS",
- "MODE_OFF",
- "MODE_ONLY_SCALE_OUT",
- "MODE_ONLY_UP",
- "MORE_THAN_ONE_BACKEND_SERVICE",
- "NOT_ENOUGH_QUOTA_AVAILABLE",
- "REGION_RESOURCE_STOCKOUT",
- "SCALING_TARGET_DOES_NOT_EXIST",
- "SCHEDULED_INSTANCES_GREATER_THAN_AUTOSCALER_MAX",
- "SCHEDULED_INSTANCES_LESS_THAN_AUTOSCALER_MIN",
- "UNKNOWN",
- "UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION",
- "ZONE_RESOURCE_STOCKOUT"
+ "testIamPermissions": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "The type of error, warning, or notice returned. Current set of possible values: - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. - MODE_ONLY_UP (WARNING): Autoscaling is in the \"Autoscale only out\" mode. The autoscaler can add instances but not remove any. - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.",
- "enumDescriptions": [
- "All instances in the instance group are unhealthy (not in RUNNING state).",
- "There is no backend service attached to the instance group.",
- "Autoscaler recommends a size greater than maxNumReplicas.",
- "The custom metric samples are not exported often enough to be a credible base for autoscaling.",
- "The custom metric that was specified does not exist or does not have the necessary labels.",
- "The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group.",
- "The autoscaler did not receive any data from the custom metric configured for autoscaling.",
- "The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer.",
- "Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved.",
- "Autoscaling is in the \"Autoscale only scale out\" mode. Instances in the group will be only added.",
- "Autoscaling is in the \"Autoscale only out\" mode. Instances in the group will be only added.",
- "The instance group cannot be autoscaled because it has more than one backend service attached to it.",
- "There is insufficient quota for the necessary resources, such as CPU or number of instances.",
- "Showed only for regional autoscalers: there is a resource stockout in the chosen region.",
- "The target to be scaled does not exist.",
- "For some scaling schedules minRequiredReplicas is greater than maxNumReplicas. Autoscaler always recommends at most maxNumReplicas instances.",
- "For some scaling schedules minRequiredReplicas is less than minNumReplicas. Autoscaler always recommends at least minNumReplicas instances.",
- "",
- "Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate.",
- "For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout."
- ]
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "path": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "id": "compute.instances.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions",
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string",
+ "description": "Name or id of the resource for this request.",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true
+ }
+ }
},
- "message": {
- "type": "string",
- "description": "The status message."
- }
- },
- "id": "AutoscalerStatusDetails"
- },
- "NetworkEndpointGroupsAttachEndpointsRequest": {
- "id": "NetworkEndpointGroupsAttachEndpointsRequest",
- "properties": {
- "networkEndpoints": {
- "type": "array",
- "items": {
- "$ref": "NetworkEndpoint"
+ "deleteAccessConfig": {
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
+ "parameters": {
+ "accessConfig": {
+ "required": true,
+ "description": "The name of the access config to delete.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "The name of the zone for this request."
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "instance": {
+ "description": "The instance name for this request.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path"
+ },
+ "networkInterface": {
+ "required": true,
+ "description": "The name of the network interface.",
+ "location": "query",
+ "type": "string"
+ }
},
- "description": "The list of network endpoints to be attached."
- }
- },
- "type": "object"
- },
- "TargetHttpsProxyList": {
- "properties": {
- "items": {
- "description": "A list of TargetHttpsProxy resources.",
- "items": {
- "$ref": "TargetHttpsProxy"
+ "httpMethod": "POST",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
+ "description": "Deletes an access config from an instance's network interface.",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance",
+ "accessConfig",
+ "networkInterface"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "kind": {
- "description": "Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.",
- "type": "string",
- "default": "compute#targetHttpsProxyList"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.instances.deleteAccessConfig"
},
- "warning": {
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "setLabels": {
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "The name of the zone for this request.",
+ "location": "path"
},
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "instance": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Name of the instance scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
},
- "message": {
+ "project": {
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- }
- },
- "id": "TargetHttpsProxyList",
- "type": "object",
- "description": "Contains a list of TargetHttpsProxy resources."
- },
- "NodeTemplateNodeTypeFlexibility": {
- "type": "object",
- "id": "NodeTemplateNodeTypeFlexibility",
- "properties": {
- "localSsd": {
- "type": "string"
- },
- "memory": {
- "type": "string"
- },
- "cpus": {
- "type": "string"
- }
- }
- },
- "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy": {
- "type": "object",
- "id": "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy",
- "properties": {
- "name": {
- "type": "string",
- "description": "Identifies the custom policy. The value should match the type the custom implementation is registered with on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (e.g. myorg.CustomLbPolicy). The maximum length is 256 characters. Note that specifying the same custom policy more than once for a backend is not a valid configuration and will be rejected."
- },
- "data": {
- "type": "string",
- "description": "An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation."
- }
- },
- "description": "The configuration for a custom policy implemented by the user and deployed with the client."
- },
- "ScalingScheduleStatus": {
- "type": "object",
- "id": "ScalingScheduleStatus",
- "properties": {
- "lastStartTime": {
- "type": "string",
- "description": "[Output Only] The last time the scaling schedule became active. Note: this is a timestamp when a schedule actually became active, not when it was planned to do so. The timestamp is in RFC3339 text format."
- },
- "state": {
- "enum": [
- "ACTIVE",
- "DISABLED",
- "OBSOLETE",
- "READY"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[Output Only] The current state of a scaling schedule.",
- "enumDescriptions": [
- "The current autoscaling recommendation is influenced by this scaling schedule.",
- "This scaling schedule has been disabled by the user.",
- "This scaling schedule will never become active again.",
- "The current autoscaling recommendation is not influenced by this scaling schedule."
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "InstancesSetLabelsRequest"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
],
- "type": "string"
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setLabels",
+ "id": "compute.instances.setLabels",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setLabels"
},
- "nextStartTime": {
- "description": "[Output Only] The next time the scaling schedule is to become active. Note: this is a timestamp when a schedule is planned to run, but the actual time might be slightly different. The timestamp is in RFC3339 text format.",
- "type": "string"
- }
- }
- },
- "ManagedInstanceLastAttempt": {
- "id": "ManagedInstanceLastAttempt",
- "properties": {
- "errors": {
- "type": "object",
- "properties": {
- "errors": {
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "type": "array",
- "items": {
- "properties": {
- "location": {
- "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.",
- "type": "string"
- },
- "errorDetails": {
- "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "errorInfo": {
- "$ref": "ErrorInfo"
- },
- "help": {
- "$ref": "Help"
- },
- "quotaInfo": {
- "$ref": "QuotaExceededInfo"
- },
- "localizedMessage": {
- "$ref": "LocalizedMessage"
- }
- }
- }
- },
- "code": {
- "description": "[Output Only] The error type identifier for this error.",
- "type": "string"
- },
- "message": {
- "type": "string",
- "description": "[Output Only] An optional, human-readable error message."
- }
- },
- "type": "object"
- }
- }
+ "getGuestAttributes": {
+ "response": {
+ "$ref": "GuestAttributes"
},
- "description": "[Output Only] Encountered errors during the last attempt to create or delete the instance."
- }
- },
- "type": "object"
- },
- "InterconnectAttachmentPrivateInfo": {
- "type": "object",
- "description": "Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.",
- "properties": {
- "tag8021q": {
- "description": "[Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.",
- "type": "integer",
- "format": "uint32"
- }
- },
- "id": "InterconnectAttachmentPrivateInfo"
- },
- "SecurityPolicyRuleRateLimitOptions": {
- "id": "SecurityPolicyRuleRateLimitOptions",
- "properties": {
- "rateLimitThreshold": {
- "$ref": "SecurityPolicyRuleRateLimitOptionsThreshold",
- "description": "Threshold at which to begin ratelimiting."
- },
- "conformAction": {
- "description": "Action to take for requests that are under the configured rate limit threshold. Valid option is \"allow\" only.",
- "type": "string"
- },
- "exceedAction": {
- "type": "string",
- "description": "Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are \"deny(status)\", where valid values for status are 403, 404, 429, and 502, and \"redirect\" where the redirect parameters come from exceedRedirectOptions below."
- },
- "banDurationSec": {
- "type": "integer",
- "description": "Can only be specified if the action for the rule is \"rate_based_ban\". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.",
- "format": "int32"
- },
- "enforceOnKeyName": {
- "type": "string",
- "description": "Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value."
- },
- "banThreshold": {
- "$ref": "SecurityPolicyRuleRateLimitOptionsThreshold",
- "description": "Can only be specified if the action for the rule is \"rate_based_ban\". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'."
- },
- "enforceOnKey": {
- "enum": [
- "ALL",
- "HTTP_COOKIE",
- "HTTP_HEADER",
- "HTTP_PATH",
- "IP",
- "REGION_CODE",
- "SNI",
- "XFF_IP"
+ "id": "compute.instances.getGuestAttributes",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "description": "Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if \"enforceOnKey\" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. ",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes",
+ "description": "Returns the specified guest attributes entry.",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "queryPath": {
+ "location": "query",
+ "description": "Specifies the guest attributes path to be queried.",
+ "type": "string"
+ },
+ "instance": {
+ "location": "path",
+ "description": "Name of the instance scoping this request.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ },
+ "variableKey": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies the key for the guest attributes entry."
+ },
+ "zone": {
+ "location": "path",
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
]
},
- "exceedRedirectOptions": {
- "description": "Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect.",
- "$ref": "SecurityPolicyRuleRedirectOptions"
- }
- },
- "type": "object"
- },
- "NodeGroup": {
- "properties": {
- "name": {
- "description": "The name of the resource, provided by the client when initially creating the resource. The resource 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.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "default": "compute#nodeGroup",
- "description": "[Output Only] The type of the resource. Always compute#nodeGroup for node group."
- },
- "locationHint": {
- "description": "An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.",
- "type": "string"
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "shareSettings": {
- "description": "Share-settings for the node group",
- "$ref": "ShareSettings"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "fingerprint": {
- "type": "string",
- "format": "byte"
- },
- "autoscalingPolicy": {
- "description": "Specifies how autoscaling should behave.",
- "$ref": "NodeGroupAutoscalingPolicy"
- },
- "status": {
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- ""
+ "updateNetworkInterface": {
+ "request": {
+ "$ref": "NetworkInterface"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance",
+ "networkInterface"
],
- "enum": [
- "CREATING",
- "DELETING",
- "INVALID",
- "READY"
- ]
- },
- "maintenanceWindow": {
- "$ref": "NodeGroupMaintenanceWindow"
- },
- "nodeTemplate": {
- "type": "string",
- "description": "URL of the node template to create the node group from."
- },
- "size": {
- "type": "integer",
- "description": "[Output Only] The total number of nodes in the node group.",
- "format": "int32"
- },
- "maintenancePolicy": {
- "type": "string",
- "description": "Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.",
- "enum": [
- "DEFAULT",
- "MAINTENANCE_POLICY_UNSPECIFIED",
- "MIGRATE_WITHIN_NODE_GROUP",
- "RESTART_IN_PLACE"
+ "id": "compute.instances.updateNetworkInterface",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "instance": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The instance name for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "networkInterface": {
+ "description": "The name of the network interface to update.",
+ "location": "query",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "Allow the node and corresponding instances to retain default maintenance behavior.",
- "",
- "When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.",
- "Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true."
- ]
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "zone": {
- "description": "[Output Only] The name of the zone where the node group resides, such as us-central1-a.",
- "type": "string"
- }
- },
- "type": "object",
- "id": "NodeGroup",
- "description": "Represents a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes."
- },
- "NetworkEndpointGroupAppEngine": {
- "description": "Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.",
- "id": "NetworkEndpointGroupAppEngine",
- "properties": {
- "urlMask": {
- "description": "A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs \"foo1-dot-appname.appspot.com/v1\" and \"foo1-dot-appname.appspot.com/v2\" can be backed by the same Serverless NEG with URL mask \"\u003cservice\u003e-dot-appname.appspot.com/\u003cversion\u003e\". The URL mask will parse them to { service = \"foo1\", version = \"v1\" } and { service = \"foo1\", version = \"v2\" } respectively.",
- "type": "string"
- },
- "version": {
- "description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: \"v1\", \"v2\".",
- "type": "string"
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface",
+ "httpMethod": "PATCH",
+ "description": "Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics."
},
- "service": {
- "type": "string",
- "description": "Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: \"default\", \"my-service\"."
- }
- },
- "type": "object"
- },
- "ForwardingRuleAggregatedList": {
- "properties": {
- "unreachables": {
- "items": {
- "type": "string"
+ "reset": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "instance": {
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the instance scoping this request.",
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request."
+ }
},
- "description": "[Output Only] Unreachable resources.",
- "type": "array"
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.",
- "default": "compute#forwardingRuleAggregatedList",
- "type": "string"
- },
- "items": {
- "additionalProperties": {
- "$ref": "ForwardingRulesScopedList",
- "description": "Name of the scope containing this set of addresses."
+ "description": "Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.",
+ "httpMethod": "POST",
+ "id": "compute.instances.reset",
+ "response": {
+ "$ref": "Operation"
},
- "type": "object",
- "description": "A list of ForwardingRulesScopedList resources."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/reset",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reset"
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "message": {
+ "update": {
+ "description": "Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}",
+ "request": {
+ "$ref": "Instance"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.instances.update",
+ "parameters": {
+ "mostDisruptiveAllowedAction": {
+ "enum": [
+ "INVALID",
+ "NO_EFFECT",
+ "REFRESH",
+ "RESTART"
+ ],
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "query",
+ "description": "Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.",
+ "enumDescriptions": [
+ "",
+ "No changes can be made to the instance.",
+ "The instance will not restart.",
+ "The instance will restart."
+ ]
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- }
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "instance": {
+ "type": "string",
+ "description": "Name of the instance resource to update.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
+ },
+ "minimalAction": {
+ "description": "Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require.",
+ "type": "string",
"enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
+ "INVALID",
+ "NO_EFFECT",
+ "REFRESH",
+ "RESTART"
+ ],
+ "enumDescriptions": [
+ "",
+ "No changes can be made to the instance.",
+ "The instance will not restart.",
+ "The instance will restart."
],
+ "location": "query"
+ },
+ "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).",
+ "location": "query",
"type": "string"
}
},
- "type": "object"
- }
- },
- "id": "ForwardingRuleAggregatedList",
- "type": "object"
- },
- "GlobalSetPolicyRequest": {
- "type": "object",
- "id": "GlobalSetPolicyRequest",
- "properties": {
- "bindings": {
- "type": "array",
- "items": {
- "$ref": "Binding"
- },
- "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings."
- },
- "etag": {
- "type": "string",
- "format": "byte",
- "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag."
- },
- "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 in general a valid policy but certain services (like Projects) might reject them.",
- "$ref": "Policy"
- }
- }
- },
- "ExternalVpnGatewayInterface": {
- "description": "The interface for the external VPN gateway.",
- "id": "ExternalVpnGatewayInterface",
- "type": "object",
- "properties": {
- "ipAddress": {
- "description": "IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.",
- "type": "string"
- },
- "id": {
- "description": "The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3 ",
- "format": "uint32",
- "type": "integer"
- }
- }
- },
- "BfdStatusPacketCounts": {
- "type": "object",
- "properties": {
- "numRx": {
- "format": "uint32",
- "description": "Number of packets received since the beginning of the current BFD session.",
- "type": "integer"
- },
- "numRxRejected": {
- "description": "Number of packets received that were rejected because of errors since the beginning of the current BFD session.",
- "type": "integer",
- "format": "uint32"
- },
- "numTx": {
- "description": "Number of packets transmitted since the beginning of the current BFD session.",
- "format": "uint32",
- "type": "integer"
- },
- "numRxSuccessful": {
- "format": "uint32",
- "description": "Number of packets received that were successfully processed since the beginning of the current BFD session.",
- "type": "integer"
- }
- },
- "id": "BfdStatusPacketCounts"
- },
- "InterconnectCircuitInfo": {
- "description": "Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only.",
- "id": "InterconnectCircuitInfo",
- "type": "object",
- "properties": {
- "customerDemarcId": {
- "description": "Customer-side demarc ID for this circuit.",
- "type": "string"
- },
- "googleCircuitId": {
- "type": "string",
- "description": "Google-assigned unique ID for this circuit. Assigned at circuit turn-up."
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ]
},
- "googleDemarcId": {
- "description": "Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.",
- "type": "string"
- }
- }
- },
- "TargetGrpcProxy": {
- "description": "Represents a Target gRPC Proxy resource. A target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Only global forwarding rules with load balancing scheme INTERNAL_SELF_MANAGED can reference a target gRPC proxy. The target gRPC Proxy references a URL map that specifies how traffic is routed to gRPC backend services.",
- "properties": {
- "urlMap": {
- "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.",
- "type": "string"
+ "setShieldedInstanceIntegrityPolicy": {
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy",
+ "id": "compute.instances.setShieldedInstanceIntegrityPolicy",
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "location": "path"
+ },
+ "instance": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name or id of the instance scoping this request."
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request."
+ }
+ },
+ "request": {
+ "$ref": "ShieldedInstanceIntegrityPolicy"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "description": "Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules."
},
- "name": {
- "description": "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.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.targetGrpcProxies.insert"
- ]
+ "getShieldedInstanceIdentity": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity",
+ "description": "Returns the Shielded Instance Identity of an instance",
+ "response": {
+ "$ref": "ShieldedInstanceIdentity"
+ },
+ "id": "compute.instances.getShieldedInstanceIdentity",
+ "httpMethod": "GET",
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "type": "string"
+ },
+ "instance": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "description": "Name or id of the instance scoping this request."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true
+ }
}
},
- "kind": {
- "type": "string",
- "default": "compute#targetGrpcProxy",
- "description": "[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.",
- "format": "uint64"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "selfLinkWithId": {
- "description": "[Output Only] Server-defined URL with id for the resource.",
- "type": "string"
- },
- "validateForProxyless": {
- "type": "boolean",
- "description": "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"
- },
- "fingerprint": {
- "type": "string",
- "format": "byte",
- "description": "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 TargetGrpcProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetGrpcProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetGrpcProxy."
- }
- },
- "id": "TargetGrpcProxy",
- "type": "object"
- },
- "InstanceGroupManagersSetInstanceTemplateRequest": {
- "id": "InstanceGroupManagersSetInstanceTemplateRequest",
- "type": "object",
- "properties": {
- "instanceTemplate": {
- "type": "string",
- "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE."
- }
- }
- },
- "VpnGatewayList": {
- "id": "VpnGatewayList",
- "properties": {
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "getScreenshot": {
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "parameters": {
+ "zone": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone for this request."
+ },
+ "instance": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the instance scoping this request."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
+ }
+ },
+ "id": "compute.instances.getScreenshot",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/screenshot",
+ "response": {
+ "$ref": "Screenshot"
+ },
+ "description": "Returns the screenshot from the specified instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/screenshot",
+ "httpMethod": "GET"
},
- "items": {
- "type": "array",
- "description": "A list of VpnGateway resources.",
- "items": {
- "$ref": "VpnGateway"
+ "updateDisplayDevice": {
+ "id": "compute.instances.updateDisplayDevice",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice",
+ "request": {
+ "$ref": "DisplayDevice"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "instance": {
+ "description": "Name of the instance scoping this request.",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ }
}
},
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ "delete": {
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}",
+ "description": "Deletes the specified Instance resource. For more information, see Deleting an instance.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/zones/{zone}/instances/{instance}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "instance": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the instance resource to delete.",
+ "type": "string",
+ "location": "path"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "zone": {
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "The name of the zone for this request."
+ }
+ },
+ "id": "compute.instances.delete"
},
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.",
- "default": "compute#vpnGatewayList",
- "type": "string"
+ "start": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/start",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/start",
+ "description": "Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "id": "compute.instances.start",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "project": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "zone": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "instance": {
+ "description": "Name of the instance resource to start.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ }
+ }
},
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "insert": {
+ "id": "compute.instances.insert",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "sourceInstanceTemplate": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate ",
+ "location": "query"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "sourceMachineImage": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage "
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
"type": "string"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
}
- }
- }
- },
- "type": "object",
- "description": "Contains a list of VpnGateway resources."
- },
- "ImageList": {
- "description": "Contains a list of images.",
- "type": "object",
- "id": "ImageList",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "flatPath": "projects/{project}/zones/{zone}/instances",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "Instance"
+ },
+ "description": "Creates an instance resource in the specified project using the data included in the request.",
+ "path": "projects/{project}/zones/{zone}/instances",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone"
+ ]
},
- "kind": {
- "description": "Type of resource.",
- "default": "compute#imageList",
- "type": "string"
+ "setIamPolicy": {
+ "path": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "request": {
+ "$ref": "ZoneSetPolicyRequest"
+ },
+ "parameters": {
+ "resource": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name or id of the resource for this request.",
+ "type": "string"
+ },
+ "zone": {
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "id": "compute.instances.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ]
},
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "setServiceAccount": {
+ "httpMethod": "POST",
+ "description": "Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "request": {
+ "$ref": "InstancesSetServiceAccountRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "instance": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the instance resource to start."
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "id": "compute.instances.setServiceAccount"
},
- "warning": {
- "properties": {
- "code": {
+ "addResourcePolicies": {
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "InstancesAddResourcePoliciesRequest"
+ },
+ "parameters": {
+ "project": {
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "instance": {
+ "description": "The instance name for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "required": true
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "requestId": {
+ "location": "query",
+ "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).",
"type": "string"
- },
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies",
+ "description": "Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.",
+ "id": "compute.instances.addResourcePolicies"
},
- "items": {
- "type": "array",
- "items": {
- "$ref": "Image"
+ "setScheduling": {
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "Scheduling"
},
- "description": "A list of Image resources."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- }
- }
- },
- "NodeTemplateAggregatedList": {
- "type": "object",
- "id": "NodeTemplateAggregatedList",
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "id": "compute.instances.setScheduling",
+ "description": "Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling",
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "type": "string",
+ "location": "path"
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "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).",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "location": "query"
},
- "message": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "instance": {
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Instance name for this request.",
+ "location": "path"
}
- },
- "description": "[Output Only] Informational warning message."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "kind": {
- "default": "compute#nodeTemplateAggregatedList",
- "description": "[Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "items": {
- "description": "A list of NodeTemplatesScopedList resources.",
- "type": "object",
- "additionalProperties": {
- "description": "[Output Only] Name of the scope containing this set of node templates.",
- "$ref": "NodeTemplatesScopedList"
}
},
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
+ "detachDisk": {
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.instances.detachDisk",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- }
- }
- },
- "ServiceAttachmentAggregatedList": {
- "properties": {
- "unreachables": {
- "items": {
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance",
+ "deviceName"
+ ],
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk",
+ "parameters": {
+ "deviceName": {
+ "type": "string",
+ "location": "query",
+ "description": "The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.",
+ "required": true
+ },
+ "instance": {
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Instance name for this request.",
+ "location": "path"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "type": "string"
+ }
},
- "description": "[Output Only] Unreachable resources.",
- "type": "array"
+ "description": "Detaches a disk from an instance."
},
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "kind": {
- "default": "compute#serviceAttachmentAggregatedList",
- "description": "Type of resource.",
- "type": "string"
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "removeResourcePolicies": {
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "description": "Removes resource policies from an instance.",
+ "id": "compute.instances.removeResourcePolicies",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "InstancesRemoveResourcePoliciesRequest"
+ },
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "zone": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "The name of the zone for this request.",
"type": "string"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- }
+ "instance": {
+ "required": true,
+ "location": "path",
+ "description": "The instance name for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
}
},
- "type": "object"
+ "httpMethod": "POST",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies"
},
- "items": {
- "description": "A list of ServiceAttachmentsScopedList resources.",
- "additionalProperties": {
- "$ref": "ServiceAttachmentsScopedList",
- "description": "Name of the scope containing this set of ServiceAttachments."
+ "startWithEncryptionKey": {
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey",
+ "response": {
+ "$ref": "Operation"
},
- "type": "object"
- }
- },
- "description": "Contains a list of ServiceAttachmentsScopedList.",
- "type": "object",
- "id": "ServiceAttachmentAggregatedList"
- },
- "NetworkEndpointGroupsListNetworkEndpoints": {
- "id": "NetworkEndpointGroupsListNetworkEndpoints",
- "properties": {
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "request": {
+ "$ref": "InstancesStartWithEncryptionKeyRequest"
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.instances.startWithEncryptionKey",
+ "description": "Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey",
+ "parameters": {
+ "instance": {
+ "required": true,
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
- },
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- }
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the instance resource to start."
},
- "message": {
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
- }
- },
- "type": "object"
- },
- "items": {
- "description": "A list of NetworkEndpointWithHealthStatus resources.",
- "items": {
- "$ref": "NetworkEndpointWithHealthStatus"
- },
- "type": "array"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.",
- "type": "string",
- "default": "compute#networkEndpointGroupsListNetworkEndpoints"
- }
- },
- "type": "object"
- },
- "ForwardingRuleList": {
- "description": "Contains a list of ForwardingRule resources.",
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of ForwardingRule resources.",
- "items": {
- "$ref": "ForwardingRule"
- }
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "message": {
+ "zone": {
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
- "code": {
+ "requestId": {
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "location": "query",
+ "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)."
}
}
- },
- "kind": {
- "description": "Type of resource.",
- "type": "string",
- "default": "compute#forwardingRuleList"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
}
- },
- "id": "ForwardingRuleList"
+ }
},
- "UsableSubnetworksAggregatedList": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. In special cases listUsable may return 0 subnetworks and nextPageToken which still should be used to get the next page of results.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks.",
- "type": "string",
- "default": "compute#usableSubnetworksAggregatedList"
- },
- "items": {
- "description": "[Output] A list of usable subnetwork URLs.",
- "items": {
- "$ref": "UsableSubnetwork"
+ "regionNetworkFirewallPolicies": {
+ "methods": {
+ "removeRule": {
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule",
+ "id": "compute.regionNetworkFirewallPolicies.removeRule",
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule",
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string"
+ },
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "location": "path"
+ },
+ "priority": {
+ "description": "The priority of the rule to remove from the firewall policy.",
+ "location": "query",
+ "format": "int32",
+ "type": "integer"
+ },
+ "firewallPolicy": {
+ "required": true,
+ "description": "Name of the firewall policy to update.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ }
},
- "type": "array"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "firewallPolicy"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "description": "Deletes a rule of the specified priority."
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "addRule": {
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
},
- "message": {
+ "project": {
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "code": {
+ "region": {
+ "required": true,
+ "description": "Name of the region scoping this request.",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "minPriority": {
+ "location": "query",
+ "type": "integer",
+ "format": "int32",
+ "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\u003e. This field is exclusive with rule.priority."
+ },
+ "maxPriority": {
+ "location": "query",
+ "format": "int32",
+ "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\u003e. This field is exclusive with rule.priority.",
+ "type": "integer"
+ },
+ "firewallPolicy": {
+ "description": "Name of the firewall policy to update.",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
}
},
- "type": "object"
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- }
- },
- "id": "UsableSubnetworksAggregatedList"
- },
- "InterconnectAttachmentsScopedList": {
- "properties": {
- "interconnectAttachments": {
- "description": "A list of interconnect attachments contained in this scope.",
- "items": {
- "$ref": "InterconnectAttachment"
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule",
+ "request": {
+ "$ref": "FirewallPolicyRule"
+ },
+ "description": "Inserts a rule into a network firewall policy.",
+ "id": "compute.regionNetworkFirewallPolicies.addRule",
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region",
+ "firewallPolicy"
+ ]
},
- "warning": {
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "list": {
+ "description": "Lists all the network firewall policies that have been configured for the specified project in the given region.",
+ "parameters": {
+ "region": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "format": "uint32",
+ "default": "500",
+ "location": "query",
+ "minimum": "0"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
"type": "string"
+ }
+ },
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "id": "compute.regionNetworkFirewallPolicies.list",
+ "path": "projects/{project}/regions/{region}/firewallPolicies",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "FirewallPolicyList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "getEffectiveFirewalls": {
+ "response": {
+ "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse"
+ },
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls",
+ "description": "Returns the effective firewalls on a given network.",
+ "parameters": {
+ "network": {
+ "location": "query",
+ "type": "string",
+ "required": true,
+ "description": "Network reference"
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "required": true
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
"type": "string"
- },
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
}
},
- "description": "Informational warning which replaces the list of addresses when the list is empty.",
- "type": "object"
- }
- },
- "id": "InterconnectAttachmentsScopedList",
- "type": "object"
- },
- "ZoneList": {
- "id": "ZoneList",
- "description": "Contains a list of zone resources.",
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of Zone resources.",
- "items": {
- "$ref": "Zone"
- }
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "network"
+ ],
+ "id": "compute.regionNetworkFirewallPolicies.getEffectiveFirewalls",
+ "path": "projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls",
+ "httpMethod": "GET"
},
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "getIamPolicy": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy",
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "region": {
+ "location": "path",
+ "type": "string",
+ "description": "The name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "optionsRequestedPolicyVersion": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Requested IAM Policy version.",
+ "location": "query"
+ },
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ }
+ },
+ "id": "compute.regionNetworkFirewallPolicies.getIamPolicy",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy"
},
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "cloneRules": {
+ "parameters": {
+ "sourceFirewallPolicy": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "description": "The firewall policy from which to copy rules.",
+ "location": "query"
},
- "data": {
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "firewallPolicy": {
+ "type": "string",
+ "description": "Name of the firewall policy to update.",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
"type": "string"
}
- }
- },
- "kind": {
- "default": "compute#zoneList",
- "description": "Type of resource.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ResourceCommitment": {
- "type": "object",
- "description": "Commitment for a particular resource (a Commitment is composed of one or more of these).",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "ACCELERATOR",
- "LOCAL_SSD",
- "MEMORY",
- "UNSPECIFIED",
- "VCPU"
+ },
+ "description": "Copies rules to the specified network firewall policy.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "firewallPolicy"
],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules",
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR."
- },
- "acceleratorType": {
- "type": "string",
- "description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR."
- },
- "amount": {
- "description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "ResourceCommitment"
- },
- "ShieldedInstanceIntegrityPolicy": {
- "type": "object",
- "description": "The policy describes the baseline against which Instance boot integrity is measured.",
- "properties": {
- "updateAutoLearnPolicy": {
- "type": "boolean",
- "description": "Updates the integrity policy baseline using the measurements from the VM instance's most recent boot."
- }
- },
- "id": "ShieldedInstanceIntegrityPolicy"
- },
- "TargetHttpProxyAggregatedList": {
- "id": "TargetHttpProxyAggregatedList",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "id": "compute.regionNetworkFirewallPolicies.cloneRules"
},
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
+ "removeAssociation": {
+ "parameters": {
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "firewallPolicy": {
+ "description": "Name of the firewall policy to update.",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name for the association that will be removed.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestId": {
+ "type": "string",
+ "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": "array"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "items": {
- "additionalProperties": {
- "description": "Name of the scope containing this set of TargetHttpProxies.",
- "$ref": "TargetHttpProxiesScopedList"
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation",
+ "description": "Removes an association for the specified network firewall policy.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "firewallPolicy"
+ ],
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation",
+ "id": "compute.regionNetworkFirewallPolicies.removeAssociation",
+ "response": {
+ "$ref": "Operation"
},
- "type": "object",
- "description": "A list of TargetHttpProxiesScopedList resources."
- },
- "kind": {
- "default": "compute#targetHttpProxyAggregatedList",
- "description": "[Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies.",
- "type": "string"
- }
- }
- },
- "RegionInstanceGroupManagersAbandonInstancesRequest": {
- "type": "object",
- "id": "RegionInstanceGroupManagersAbandonInstancesRequest",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "VpnGatewayStatusVpnConnection": {
- "properties": {
- "state": {
- "$ref": "VpnGatewayStatusHighAvailabilityRequirementState",
- "description": "HighAvailabilityRequirementState for the VPN connection."
- },
- "peerExternalGateway": {
- "type": "string",
- "description": "URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway."
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "tunnels": {
- "description": "List of VPN tunnels that are in this VPN connection.",
- "items": {
- "$ref": "VpnGatewayStatusTunnel"
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Deletes the specified network firewall policy.",
+ "id": "compute.regionNetworkFirewallPolicies.delete",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- },
- "peerGcpGateway": {
- "description": "URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.",
- "type": "string"
- }
- },
- "description": "A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway.",
- "id": "VpnGatewayStatusVpnConnection",
- "type": "object"
- },
- "NetworkInterface": {
- "id": "NetworkInterface",
- "properties": {
- "accessConfigs": {
- "type": "array",
- "items": {
- "$ref": "AccessConfig"
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "firewallPolicy": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the firewall policy to delete.",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
},
- "description": "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."
- },
- "ipv6Address": {
- "description": "An IPv6 internal network address for this network interface.",
- "type": "string"
- },
- "nicType": {
- "type": "string",
- "description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.",
- "enum": [
- "GVNIC",
- "UNSPECIFIED_NIC_TYPE",
- "VIRTIO_NET"
- ],
- "enumDescriptions": [
- "GVNIC",
- "No type specified.",
- "VIRTIO"
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "project",
+ "region",
+ "firewallPolicy"
]
},
- "queueCount": {
- "type": "integer",
- "format": "int32",
- "description": "The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users."
- },
- "internalIpv6PrefixLength": {
- "type": "integer",
- "description": "The prefix length of the primary internal IPv6 range.",
- "format": "int32"
- },
- "aliasIpRanges": {
- "items": {
- "$ref": "AliasIpRange"
+ "patchRule": {
+ "request": {
+ "$ref": "FirewallPolicyRule"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "firewallPolicy"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule",
+ "description": "Patches a rule of the specified priority.",
+ "id": "compute.regionNetworkFirewallPolicies.patchRule",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "firewallPolicy": {
+ "description": "Name of the firewall policy to update.",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "priority": {
+ "format": "int32",
+ "description": "The priority of the rule to patch.",
+ "location": "query",
+ "type": "integer"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "region": {
+ "type": "string",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
},
- "description": "An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.",
- "type": "array"
- },
- "subnetwork": {
- "type": "string",
- "description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork "
- },
- "name": {
- "description": "[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.",
- "type": "string"
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule"
},
- "ipv6AccessConfigs": {
- "items": {
- "$ref": "AccessConfig"
+ "getAssociation": {
+ "response": {
+ "$ref": "FirewallPolicyAssociation"
},
- "type": "array",
- "description": "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."
- },
- "ipv6AccessType": {
- "type": "string",
- "description": "[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.",
- "enum": [
- "EXTERNAL",
- "INTERNAL"
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation",
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation",
+ "id": "compute.regionNetworkFirewallPolicies.getAssociation",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enumDescriptions": [
- "This network interface can have external IPv6.",
- "This network interface can have internal IPv6."
- ]
- },
- "stackType": {
- "enum": [
- "IPV4_IPV6",
- "IPV4_ONLY"
+ "parameterOrder": [
+ "project",
+ "region",
+ "firewallPolicy"
],
- "type": "string",
- "description": "The stack type for this network interface 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 instance creation and update network interface operations.",
- "enumDescriptions": [
- "The network interface can have both IPv4 and IPv6 addresses.",
- "The network interface will be assigned IPv4 address."
- ]
- },
- "network": {
- "description": "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 ",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "default": "compute#networkInterface",
- "description": "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces."
- },
- "networkIP": {
- "type": "string",
- "description": "An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system."
+ "description": "Gets an association with the specified name.",
+ "parameters": {
+ "firewallPolicy": {
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the firewall policy to which the queried association belongs.",
+ "type": "string"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name of the association to get from the firewall policy.",
+ "type": "string"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ }
},
- "fingerprint": {
- "description": "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.",
- "format": "byte",
- "type": "string"
- }
- },
- "description": "A network interface resource attached to an instance.",
- "type": "object"
- },
- "NetworksGetEffectiveFirewallsResponse": {
- "id": "NetworksGetEffectiveFirewallsResponse",
- "properties": {
- "firewalls": {
- "description": "Effective firewalls on the network.",
- "items": {
- "$ref": "Firewall"
+ "addAssociation": {
+ "request": {
+ "$ref": "FirewallPolicyAssociation"
},
- "type": "array"
- },
- "firewallPolicys": {
- "items": {
- "$ref": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "Effective firewalls from firewall policy."
- }
- },
- "type": "object"
- },
- "RegionInstanceGroupManagersListInstancesResponse": {
- "id": "RegionInstanceGroupManagersListInstancesResponse",
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "managedInstances": {
- "type": "array",
- "description": "A list of managed instances.",
- "items": {
- "$ref": "ManagedInstance"
- }
- }
- },
- "type": "object"
- },
- "SecurityPolicyRuleMatcher": {
- "properties": {
- "expr": {
- "description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header.",
- "$ref": "Expr"
- },
- "versionedExpr": {
- "description": "Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.",
- "enumDescriptions": [
- "Matches the source IP address of a request to the IP ranges supplied in config."
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation",
+ "description": "Inserts an association for the specified network firewall policy.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "firewallPolicy"
],
- "enum": [
- "SRC_IPS_V1"
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation",
+ "id": "compute.regionNetworkFirewallPolicies.addAssociation",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
- },
- "config": {
- "$ref": "SecurityPolicyRuleMatcherConfig",
- "description": "The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified."
- }
- },
- "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.",
- "id": "SecurityPolicyRuleMatcher",
- "type": "object"
- },
- "TargetInstanceList": {
- "description": "Contains a list of TargetInstance resources.",
- "type": "object",
- "properties": {
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#targetInstanceList"
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array"
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
- "message": {
+ "replaceExistingAssociation": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists."
+ },
+ "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).",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "query"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "firewallPolicy": {
+ "location": "path",
+ "description": "Name of the firewall policy to update.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "location": "path",
+ "required": true
}
}
},
- "items": {
- "type": "array",
- "items": {
- "$ref": "TargetInstance"
+ "setIamPolicy": {
+ "request": {
+ "$ref": "RegionSetPolicyRequest"
},
- "description": "A list of TargetInstance resources."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- }
- },
- "id": "TargetInstanceList"
- },
- "SecurityPoliciesScopedList": {
- "id": "SecurityPoliciesScopedList",
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy",
+ "parameters": {
+ "region": {
+ "required": true,
+ "description": "The name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
"type": "string"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "type": "array"
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "type": "string"
+ "resource": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name or id of the resource for this request.",
+ "required": true
}
},
- "description": "Informational warning which replaces the list of security policies when the list is empty."
- },
- "securityPolicies": {
- "type": "array",
- "description": "A list of SecurityPolicies contained in this scope.",
- "items": {
- "$ref": "SecurityPolicy"
- }
- }
- },
- "type": "object"
- },
- "InstanceGroupsSetNamedPortsRequest": {
- "type": "object",
- "id": "InstanceGroupsSetNamedPortsRequest",
- "properties": {
- "namedPorts": {
- "type": "array",
- "description": "The list of named ports to set for this instance group.",
- "items": {
- "$ref": "NamedPort"
- }
- },
- "fingerprint": {
- "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet.",
- "format": "byte",
- "type": "string"
- }
- }
- },
- "GuestAttributes": {
- "properties": {
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.",
- "type": "string",
- "default": "compute#guestAttributes"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "queryValue": {
- "description": "[Output Only] The value of the requested queried path.",
- "$ref": "GuestAttributesValue"
- },
- "queryPath": {
- "description": "The path to be queried. This can be the default namespace ('') or a nested namespace ('\\/') or a specified key ('\\/\\').",
- "type": "string"
- },
- "variableValue": {
- "type": "string",
- "description": "[Output Only] The value found for the requested key."
- },
- "variableKey": {
- "description": "The key to search for.",
- "type": "string"
- }
- },
- "type": "object",
- "id": "GuestAttributes",
- "description": "A guest attributes entry."
- },
- "TargetVpnGatewaysScopedList": {
- "type": "object",
- "id": "TargetVpnGatewaysScopedList",
- "properties": {
- "warning": {
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- }
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "id": "compute.regionNetworkFirewallPolicies.setIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy."
+ },
+ "getRule": {
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule",
+ "parameters": {
+ "priority": {
+ "format": "int32",
+ "location": "query",
+ "description": "The priority of the rule to get from the firewall policy.",
+ "type": "integer"
},
- "message": {
+ "firewallPolicy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Name of the firewall policy to which the queried rule belongs."
},
- "code": {
+ "region": {
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request."
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
}
},
- "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
- "type": "object"
- },
- "targetVpnGateways": {
- "description": "[Output Only] A list of target VPN gateways contained in this scope.",
- "type": "array",
- "items": {
- "$ref": "TargetVpnGateway"
- }
- }
- }
- },
- "ManagedInstanceInstanceHealth": {
- "type": "object",
- "id": "ManagedInstanceInstanceHealth",
- "properties": {
- "detailedHealthState": {
- "type": "string",
- "enumDescriptions": [
- "The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.",
- "The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.",
- "The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout.",
- "The instance is reachable, but does not conform to the requirements defined by the health check.",
- "The health checking system is aware of the instance but its health is not known at the moment."
+ "parameterOrder": [
+ "project",
+ "region",
+ "firewallPolicy"
],
- "description": "[Output Only] The current detailed instance health state.",
- "enum": [
- "DRAINING",
- "HEALTHY",
- "TIMEOUT",
- "UNHEALTHY",
- "UNKNOWN"
- ]
- },
- "healthCheck": {
- "description": "[Output Only] The URL for the health check that verifies whether the instance is healthy.",
- "type": "string"
- }
- }
- },
- "InterconnectLocationRegionInfo": {
- "id": "InterconnectLocationRegionInfo",
- "description": "Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.",
- "type": "object",
- "properties": {
- "locationPresence": {
- "description": "Identifies the network presence of this location.",
- "enumDescriptions": [
- "This region is not in any common network presence with this InterconnectLocation.",
- "This region shares the same regional network presence as this InterconnectLocation.",
- "[Deprecated] This region is not in any common network presence with this InterconnectLocation.",
- "[Deprecated] This region shares the same regional network presence as this InterconnectLocation."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "enum": [
- "GLOBAL",
- "LOCAL_REGION",
- "LP_GLOBAL",
- "LP_LOCAL_REGION"
- ]
- },
- "region": {
- "description": "URL for the region of this location.",
- "type": "string"
- },
- "expectedRttMs": {
- "description": "Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.",
- "format": "int64",
- "type": "string"
- }
- }
- },
- "DistributionPolicyZoneConfiguration": {
- "id": "DistributionPolicyZoneConfiguration",
- "properties": {
- "zone": {
- "annotations": {
- "required": [
- "compute.regionInstanceGroupManagers.insert"
- ]
- },
- "description": "The URL of the zone. The zone must exist in the region where the managed instance group is located.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "TargetHttpProxyList": {
- "description": "A list of TargetHttpProxy resources.",
- "id": "TargetHttpProxyList",
- "properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "TargetHttpProxy"
+ "id": "compute.regionNetworkFirewallPolicies.getRule",
+ "response": {
+ "$ref": "FirewallPolicyRule"
},
- "description": "A list of TargetHttpProxy resources."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "kind": {
- "default": "compute#targetHttpProxyList",
- "type": "string",
- "description": "Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies."
+ "httpMethod": "GET",
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule",
+ "description": "Gets a rule of the specified priority."
},
- "warning": {
- "type": "object",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "get": {
+ "parameters": {
+ "firewallPolicy": {
+ "description": "Name of the firewall policy to get.",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
},
- "message": {
+ "region": {
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "location": "path"
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- }
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true
}
},
- "description": "[Output Only] Informational warning message."
- }
- },
- "type": "object"
- },
- "BackendServiceFailoverPolicy": {
- "id": "BackendServiceFailoverPolicy",
- "type": "object",
- "description": "For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).",
- "properties": {
- "failoverRatio": {
- "format": "float",
- "description": "The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).",
- "type": "number"
- },
- "dropTrafficIfUnhealthy": {
- "type": "boolean",
- "description": "If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false."
+ "parameterOrder": [
+ "project",
+ "region",
+ "firewallPolicy"
+ ],
+ "id": "compute.regionNetworkFirewallPolicies.get",
+ "description": "Returns the specified network firewall policy.",
+ "response": {
+ "$ref": "FirewallPolicy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
+ "httpMethod": "GET"
},
- "disableConnectionDrainOnFailover": {
- "type": "boolean",
- "description": "This can be set to true only if the protocol is TCP. The default is false."
- }
- }
- },
- "NodeTypesScopedList": {
- "type": "object",
- "id": "NodeTypesScopedList",
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "testIamPermissions": {
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "parameters": {
+ "region": {
+ "description": "The name of the region for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array"
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.regionNetworkFirewallPolicies.testIamPermissions",
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions",
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ }
+ },
+ "patch": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Patches the specified network firewall policy.",
+ "request": {
+ "$ref": "FirewallPolicy"
+ },
+ "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "firewallPolicy"
+ ],
+ "httpMethod": "PATCH",
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
+ "id": "compute.regionNetworkFirewallPolicies.patch",
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string"
+ },
+ "region": {
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "firewallPolicy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name of the firewall policy to update."
}
- },
- "description": "[Output Only] An informational warning that appears when the node types list is empty."
- },
- "nodeTypes": {
- "description": "[Output Only] A list of node types contained in this scope.",
- "type": "array",
- "items": {
- "$ref": "NodeType"
}
+ },
+ "insert": {
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/firewallPolicies",
+ "description": "Creates a new network firewall policy in the specified project and region.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/regions/{region}/firewallPolicies",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "region": {
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ }
+ },
+ "request": {
+ "$ref": "FirewallPolicy"
+ },
+ "id": "compute.regionNetworkFirewallPolicies.insert"
}
}
},
- "RegionInstanceGroupManagersSetTemplateRequest": {
- "id": "RegionInstanceGroupManagersSetTemplateRequest",
- "type": "object",
- "properties": {
- "instanceTemplate": {
- "type": "string",
- "description": "URL of the InstanceTemplate resource from which all new instances will be created."
- }
- }
- },
- "VpnTunnel": {
- "description": "Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.",
- "id": "VpnTunnel",
- "properties": {
- "ikeVersion": {
- "type": "integer",
- "description": "IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.",
- "format": "int32"
- },
- "sharedSecretHash": {
- "type": "string",
- "description": "Hash of the shared secret."
- },
- "remoteTrafficSelector": {
- "items": {
- "type": "string"
+ "targetInstances": {
+ "methods": {
+ "list": {
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/targetInstances",
+ "parameters": {
+ "maxResults": {
+ "type": "integer",
+ "location": "query",
+ "minimum": "0",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "zone": {
+ "location": "path",
+ "type": "string",
+ "description": "Name of the zone scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ }
},
- "type": "array",
- "description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported."
- },
- "targetVpnGateway": {
- "type": "string",
- "description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created."
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "kind": {
- "default": "compute#vpnTunnel",
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "peerIp": {
- "description": "IP address of the peer VPN gateway. Only IPv4 is supported.",
- "type": "string"
- },
- "peerExternalGatewayInterface": {
- "description": "The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type.",
- "type": "integer",
- "format": "int32"
- },
- "name": {
- "type": "string",
- "annotations": {
- "required": [
- "compute.vpnTunnels.insert"
- ]
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.targetInstances.list",
+ "path": "projects/{project}/zones/{zone}/targetInstances",
+ "response": {
+ "$ref": "TargetInstanceList"
},
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "id": {
- "type": "string",
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
- },
- "vpnGateway": {
- "type": "string",
- "description": "URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created."
- },
- "router": {
- "description": "URL of the router resource to be used for dynamic routing.",
- "type": "string"
- },
- "region": {
- "description": "[Output Only] URL of the region where the VPN tunnel 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"
+ "httpMethod": "GET",
+ "description": "Retrieves a list of TargetInstance resources available to the specified project and zone."
},
- "status": {
- "enumDescriptions": [
- "Cloud VPN is in the process of allocating all required resources (specifically, a borg task).",
- "Auth error (e.g. bad shared secret).",
- "Resources is being deallocated for the VPN tunnel.",
- "Secure session is successfully established with peer VPN.",
- "Tunnel creation has failed and the tunnel is not ready to be used.",
- "Successful first handshake with peer VPN.",
- "Handshake failed.",
- "Deprecated, replaced by NO_INCOMING_PACKETS",
- "No incoming packets from peer",
- "Resource is being allocated for the VPN tunnel.",
- "Tunnel configuration was rejected, can be result of being denylisted.",
- "Tunnel is stopped due to its Forwarding Rules being deleted.",
- "Waiting to receive all VPN-related configs from user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup VPN tunnel."
+ "get": {
+ "parameters": {
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "targetInstance": {
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the TargetInstance resource to return.",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "Name of the zone scoping this request."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "description": "[Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. ",
- "enum": [
- "ALLOCATING_RESOURCES",
- "AUTHORIZATION_ERROR",
- "DEPROVISIONING",
- "ESTABLISHED",
- "FAILED",
- "FIRST_HANDSHAKE",
- "NEGOTIATION_FAILURE",
- "NETWORK_ERROR",
- "NO_INCOMING_PACKETS",
- "PROVISIONING",
- "REJECTED",
- "STOPPED",
- "WAITING_FOR_FULL_CONFIG"
- ]
- },
- "peerGcpGateway": {
- "description": "URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway.",
- "type": "string"
- },
- "vpnGatewayInterface": {
- "format": "int32",
- "type": "integer",
- "description": "The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`."
- },
- "localTrafficSelector": {
- "type": "array",
- "description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.",
- "items": {
- "type": "string"
- }
- },
- "peerExternalGateway": {
- "type": "string",
- "description": "URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway."
- },
- "detailedStatus": {
- "description": "[Output Only] Detailed status message for the VPN tunnel.",
- "type": "string"
- },
- "sharedSecret": {
- "type": "string",
- "description": "Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway."
- }
- },
- "type": "object"
- },
- "SignedUrlKey": {
- "description": "Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs",
- "properties": {
- "keyValue": {
- "description": "128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.",
- "type": "string"
- },
- "keyName": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "Name of the key. 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."
- }
- },
- "type": "object",
- "id": "SignedUrlKey"
- },
- "MachineImage": {
- "type": "object",
- "properties": {
- "savedDisks": {
- "type": "array",
- "description": "An array of Machine Image specific properties for disks attached to the source instance",
- "items": {
- "$ref": "SavedDisk"
- }
- },
- "sourceDiskEncryptionKeys": {
- "items": {
- "$ref": "SourceDiskEncryptionKey"
+ "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}",
+ "description": "Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.",
+ "id": "compute.targetInstances.get",
+ "response": {
+ "$ref": "TargetInstance"
},
- "type": "array",
- "description": "[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key."
- },
- "machineImageEncryptionKey": {
- "$ref": "CustomerEncryptionKey",
- "description": "Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later."
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] The URL for this machine image. The server defines this URL.",
- "type": "string"
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "targetInstance"
+ ],
+ "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}"
},
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "annotations": {
- "required": [
- "compute.machineImages.insert"
- ]
+ "insert": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "description": "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."
- },
- "sourceInstance": {
- "type": "string",
- "description": "The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance "
- },
- "id": {
- "type": "string",
- "format": "uint64",
- "description": "[Output Only] A unique identifier for this machine image. The server defines this identifier."
- },
- "sourceInstanceProperties": {
- "$ref": "SourceInstanceProperties",
- "description": "[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field."
- },
- "guestFlush": {
- "type": "boolean",
- "description": "[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] The creation timestamp for this machine image in RFC3339 text format."
- },
- "totalStorageBytes": {
- "description": "[Output Only] Total size of the storage used by the machine image.",
- "format": "int64",
- "type": "string"
- },
- "status": {
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
+ "parameterOrder": [
+ "project",
+ "zone"
],
- "description": "[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.",
- "enum": [
- "CREATING",
- "DELETING",
- "INVALID",
- "READY",
- "UPLOADING"
- ]
- },
- "satisfiesPzs": {
- "description": "[Output Only] Reserved for future use.",
- "type": "boolean"
- },
- "instanceProperties": {
- "$ref": "InstanceProperties",
- "description": "[Output Only] Properties of source instance"
+ "path": "projects/{project}/zones/{zone}/targetInstances",
+ "id": "compute.targetInstances.insert",
+ "flatPath": "projects/{project}/zones/{zone}/targetInstances",
+ "request": {
+ "$ref": "TargetInstance"
+ },
+ "httpMethod": "POST",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "zone": {
+ "description": "Name of the zone scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ }
+ },
+ "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request."
},
- "kind": {
- "description": "[Output Only] The resource type, which is always compute#machineImage for machine image.",
- "default": "compute#machineImage",
- "type": "string"
+ "aggregatedList": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "default": "500",
+ "format": "uint32",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "TargetInstanceAggregatedList"
+ },
+ "description": "Retrieves an aggregated list of target instances.",
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/aggregated/targetInstances",
+ "id": "compute.targetInstances.aggregatedList",
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/aggregated/targetInstances"
},
- "storageLocations": {
- "items": {
- "type": "string"
+ "delete": {
+ "parameterOrder": [
+ "project",
+ "zone",
+ "targetInstance"
+ ],
+ "description": "Deletes the specified TargetInstance resource.",
+ "parameters": {
+ "targetInstance": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "description": "Name of the TargetInstance resource to delete."
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "zone": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "description": "Name of the zone scoping this request."
+ }
},
- "type": "array",
- "description": "The regional or multi-regional Cloud Storage bucket location where the machine image is stored."
- }
- },
- "description": "Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.",
- "id": "MachineImage"
- },
- "ProjectsDisableXpnResourceRequest": {
- "id": "ProjectsDisableXpnResourceRequest",
- "type": "object",
- "properties": {
- "xpnResource": {
- "$ref": "XpnResourceId",
- "description": "Service resource (a.k.a service project) ID."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}",
+ "id": "compute.targetInstances.delete",
+ "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}"
}
}
},
- "AutoscalingPolicyCustomMetricUtilization": {
- "id": "AutoscalingPolicyCustomMetricUtilization",
- "type": "object",
- "properties": {
- "utilizationTarget": {
- "format": "double",
- "description": "The target value of the metric that autoscaler maintains. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilization_target is https://www.googleapis.com/compute/v1/instance/network/received_bytes_count. The autoscaler works to keep this value constant for each of the instances.",
- "type": "number"
- },
- "singleInstanceAssignment": {
- "description": "If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler keeps the number of instances proportional to the value of this metric. The metric itself does not change value due to group resizing. A good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead.",
- "type": "number",
- "format": "double"
- },
- "utilizationTargetType": {
- "description": "Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.",
- "type": "string",
- "enum": [
- "DELTA_PER_MINUTE",
- "DELTA_PER_SECOND",
- "GAUGE"
+ "autoscalers": {
+ "methods": {
+ "aggregatedList": {
+ "response": {
+ "$ref": "AutoscalerAggregatedList"
+ },
+ "httpMethod": "GET",
+ "description": "Retrieves an aggregated list of autoscalers.",
+ "parameterOrder": [
+ "project"
],
- "enumDescriptions": [
- "Sets the utilization target value for a cumulative or delta metric, expressed as the rate of growth per minute.",
- "Sets the utilization target value for a cumulative or delta metric, expressed as the rate of growth per second.",
- "Sets the utilization target value for a gauge metric. The autoscaler will collect the average utilization of the virtual machines from the last couple of minutes, and compare the value to the utilization target value to perform autoscaling."
+ "id": "compute.autoscalers.aggregatedList",
+ "flatPath": "projects/{project}/aggregated/autoscalers",
+ "path": "projects/{project}/aggregated/autoscalers",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "type": "integer",
+ "location": "query",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
]
},
- "filter": {
- "description": "A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. For the filter to be valid for autoscaling purposes, the following rules apply: - You can only use the AND operator for joining selectors. - You can only use direct equality comparison operator (=) without any functions for each selector. - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a *per-group metric* for the purpose of autoscaling. If not specified, the type defaults to gce_instance. Try to provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.",
- "type": "string"
- },
- "metric": {
- "description": "The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE.",
- "type": "string"
- }
- },
- "description": "Custom utilization metric policy."
- },
- "NodeGroupList": {
- "type": "object",
- "properties": {
- "items": {
- "items": {
- "$ref": "NodeGroup"
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "autoscaler"
+ ],
+ "parameters": {
+ "autoscaler": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the autoscaler to return.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string"
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Name of the zone for this request."
+ }
},
- "description": "A list of NodeGroup resources.",
- "type": "array"
- },
- "kind": {
- "description": "[Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups.",
- "type": "string",
- "default": "compute#nodeGroupList"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "id": "compute.autoscalers.get",
+ "description": "Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.",
+ "flatPath": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
+ "response": {
+ "$ref": "Autoscaler"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}"
},
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "delete": {
+ "description": "Deletes the specified autoscaler.",
+ "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "autoscaler"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
+ "parameters": {
+ "autoscaler": {
+ "location": "path",
+ "description": "Name of the autoscaler to delete.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string",
+ "description": "Name of the zone for this request.",
+ "required": true
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "id": "compute.autoscalers.delete",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ }
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "update": {
+ "path": "projects/{project}/zones/{zone}/autoscalers",
+ "parameters": {
+ "requestId": {
+ "location": "query",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "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)."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "autoscaler": {
+ "description": "Name of the autoscaler to update.",
+ "type": "string",
+ "location": "query",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string"
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- }
+ "zone": {
+ "type": "string",
+ "location": "path",
+ "description": "Name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
}
},
- "type": "object"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "description": "Updates an autoscaler in the specified project using the data included in the request.",
+ "flatPath": "projects/{project}/zones/{zone}/autoscalers",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "Autoscaler"
+ },
+ "id": "compute.autoscalers.update",
+ "httpMethod": "PUT"
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- },
- "id": "NodeGroupList",
- "description": "Contains a list of nodeGroups."
- },
- "ServiceAttachmentConnectedEndpoint": {
- "id": "ServiceAttachmentConnectedEndpoint",
- "properties": {
- "pscConnectionId": {
- "type": "string",
- "format": "uint64",
- "description": "The PSC connection id of the connected endpoint."
+ "list": {
+ "path": "projects/{project}/zones/{zone}/autoscalers",
+ "flatPath": "projects/{project}/zones/{zone}/autoscalers",
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "id": "compute.autoscalers.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves a list of autoscalers contained within the specified zone.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "AutoscalerList"
+ },
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "Name of the zone for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "maxResults": {
+ "format": "uint32",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ }
+ }
},
- "endpoint": {
- "type": "string",
- "description": "The url of a connected endpoint."
+ "insert": {
+ "description": "Creates an autoscaler in the specified project using the data included in the request.",
+ "flatPath": "projects/{project}/zones/{zone}/autoscalers",
+ "path": "projects/{project}/zones/{zone}/autoscalers",
+ "request": {
+ "$ref": "Autoscaler"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.autoscalers.insert",
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name of the zone for this request."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "status": {
- "enum": [
- "ACCEPTED",
- "CLOSED",
- "NEEDS_ATTENTION",
- "PENDING",
- "REJECTED",
- "STATUS_UNSPECIFIED"
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/zones/{zone}/autoscalers",
+ "flatPath": "projects/{project}/zones/{zone}/autoscalers",
+ "parameters": {
+ "zone": {
+ "type": "string",
+ "description": "Name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "autoscaler": {
+ "description": "Name of the autoscaler to patch.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "query"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "request": {
+ "$ref": "Autoscaler"
+ },
+ "httpMethod": "PATCH",
+ "id": "compute.autoscalers.patch",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "description": "The status of a connected endpoint to this service attachment.",
- "enumDescriptions": [
- "The connection has been accepted by the producer.",
- "The connection has been closed by the producer.",
- "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.",
- "The connection is pending acceptance by the producer.",
- "The consumer is still connected but not using the connection.",
- ""
+ "description": "Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "parameterOrder": [
+ "project",
+ "zone"
]
}
- },
- "type": "object",
- "description": "[Output Only] A connection connected to this service attachment."
+ }
},
- "GuestOsFeature": {
- "type": "object",
- "properties": {
- "type": {
- "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features.",
- "enum": [
- "FEATURE_TYPE_UNSPECIFIED",
- "GVNIC",
- "MULTI_IP_SUBNET",
- "SECURE_BOOT",
- "SEV_CAPABLE",
- "UEFI_COMPATIBLE",
- "VIRTIO_SCSI_MULTIQUEUE",
- "WINDOWS"
+ "firewalls": {
+ "methods": {
+ "patch": {
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "firewall": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "description": "Name of the firewall rule to patch."
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ }
+ },
+ "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "Firewall"
+ },
+ "parameterOrder": [
+ "project",
+ "firewall"
],
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
+ "flatPath": "projects/{project}/global/firewalls/{firewall}",
+ "path": "projects/{project}/global/firewalls/{firewall}",
+ "id": "compute.firewalls.patch",
+ "description": "Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
- }
- },
- "id": "GuestOsFeature",
- "description": "Guest OS features."
- },
- "PacketMirroringMirroredResourceInfo": {
- "type": "object",
- "id": "PacketMirroringMirroredResourceInfo",
- "properties": {
- "instances": {
- "items": {
- "$ref": "PacketMirroringMirroredResourceInfoInstanceInfo"
- },
- "type": "array",
- "description": "A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring. Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring. You may specify a maximum of 50 Instances."
},
- "tags": {
- "items": {
- "type": "string"
+ "update": {
+ "request": {
+ "$ref": "Firewall"
},
- "type": "array",
- "description": "A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored."
- },
- "subnetworks": {
- "description": "A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring. You may specify a maximum of 5 subnetworks.",
- "items": {
- "$ref": "PacketMirroringMirroredResourceInfoSubnetInfo"
+ "httpMethod": "PUT",
+ "description": "Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.",
+ "flatPath": "projects/{project}/global/firewalls/{firewall}",
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "firewall": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the firewall rule to update.",
+ "location": "path"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
},
- "type": "array"
- }
- }
- },
- "ServiceAttachmentConsumerProjectLimit": {
- "id": "ServiceAttachmentConsumerProjectLimit",
- "type": "object",
- "properties": {
- "projectIdOrNum": {
- "type": "string",
- "description": "The project id or number for the project to set the limit for."
- },
- "connectionLimit": {
- "description": "The value of the limit to set.",
- "type": "integer",
- "format": "uint32"
- },
- "networkUrl": {
- "type": "string",
- "description": "The network URL for the network to set the limit for."
- }
- }
- },
- "SecurityPolicyRule": {
- "type": "object",
- "properties": {
- "kind": {
- "description": "[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules",
- "type": "string",
- "default": "compute#securityPolicyRule"
- },
- "preview": {
- "description": "If set to true, the specified action is not enforced.",
- "type": "boolean"
- },
- "action": {
- "description": "The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. ",
- "type": "string"
- },
- "rateLimitOptions": {
- "$ref": "SecurityPolicyRuleRateLimitOptions",
- "description": "Must be specified if the action is \"rate_based_ban\" or \"throttle\". Cannot be specified for any other actions."
- },
- "match": {
- "$ref": "SecurityPolicyRuleMatcher",
- "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced."
- },
- "headerAction": {
- "description": "Optional, additional actions that are performed on headers.",
- "$ref": "SecurityPolicyRuleHttpHeaderAction"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "redirectOptions": {
- "$ref": "SecurityPolicyRuleRedirectOptions",
- "description": "Parameters defining the redirect action. Cannot be specified for any other actions."
- },
- "priority": {
- "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.",
- "type": "integer",
- "format": "int32"
- }
- },
- "id": "SecurityPolicyRule",
- "description": "Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny)."
- },
- "HttpRouteRule": {
- "properties": {
- "headerAction": {
- "$ref": "HttpHeaderAction",
- "description": "Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true."
- },
- "description": {
- "description": "The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.",
- "type": "string"
- },
- "routeAction": {
- "description": "In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction.",
- "$ref": "HttpRouteAction"
- },
- "service": {
- "type": "string",
- "description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set."
- },
- "urlRedirect": {
- "description": "When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.",
- "$ref": "HttpRedirectAction"
- },
- "priority": {
- "type": "integer",
- "description": "For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.",
- "format": "int32"
- },
- "matchRules": {
- "description": "The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.",
- "type": "array",
- "items": {
- "$ref": "HttpRouteRuleMatch"
- }
- }
- },
- "description": "The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.",
- "type": "object",
- "id": "HttpRouteRule"
- },
- "DisplayDevice": {
- "description": "A set of Display Device options",
- "properties": {
- "enableDisplay": {
- "type": "boolean",
- "description": "Defines whether the instance has Display enabled."
- }
- },
- "type": "object",
- "id": "DisplayDevice"
- },
- "RegionInstanceGroupManagersRecreateRequest": {
- "id": "RegionInstanceGroupManagersRecreateRequest",
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
- "items": {
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "firewall"
+ ],
+ "id": "compute.firewalls.update",
+ "path": "projects/{project}/global/firewalls/{firewall}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
}
- }
- }
- },
- "HealthCheckReference": {
- "id": "HealthCheckReference",
- "properties": {
- "healthCheck": {
- "type": "string"
- }
- },
- "type": "object",
- "description": "A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check "
- },
- "ShieldedInstanceConfig": {
- "type": "object",
- "properties": {
- "enableIntegrityMonitoring": {
- "description": "Defines whether the instance has integrity monitoring enabled. Enabled by default.",
- "type": "boolean"
- },
- "enableSecureBoot": {
- "type": "boolean",
- "description": "Defines whether the instance has Secure Boot enabled. Disabled by default."
- },
- "enableVtpm": {
- "description": "Defines whether the instance has the vTPM enabled. Enabled by default.",
- "type": "boolean"
- }
- },
- "id": "ShieldedInstanceConfig",
- "description": "A set of Shielded Instance options."
- },
- "RegionDiskTypeList": {
- "id": "RegionDiskTypeList",
- "type": "object",
- "properties": {
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
},
- "items": {
- "items": {
- "$ref": "DiskType"
+ "delete": {
+ "flatPath": "projects/{project}/global/firewalls/{firewall}",
+ "description": "Deletes the specified firewall.",
+ "response": {
+ "$ref": "Operation"
},
- "description": "A list of DiskType resources.",
- "type": "array"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.",
- "default": "compute#regionDiskTypeList"
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "firewall"
+ ],
+ "httpMethod": "DELETE",
+ "id": "compute.firewalls.delete",
+ "path": "projects/{project}/global/firewalls/{firewall}",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "location": "path"
},
- "message": {
+ "requestId": {
+ "location": "query",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "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)."
},
- "data": {
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "firewall": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "description": "Name of the firewall rule to delete.",
+ "type": "string"
}
- },
- "type": "object"
- }
- }
- },
- "TargetPoolAggregatedList": {
- "type": "object",
- "properties": {
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
- },
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ }
+ },
+ "get": {
+ "parameterOrder": [
+ "project",
+ "firewall"
+ ],
+ "description": "Returns the specified firewall.",
+ "path": "projects/{project}/global/firewalls/{firewall}",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "firewall": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the firewall rule to return.",
"type": "string"
}
+ },
+ "id": "compute.firewalls.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/global/firewalls/{firewall}",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Firewall"
}
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "items": {
- "description": "A list of TargetPool resources.",
- "type": "object",
- "additionalProperties": {
- "$ref": "TargetPoolsScopedList",
- "description": "Name of the scope containing this set of target pools."
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "unreachables": {
- "items": {
- "type": "string"
+ "list": {
+ "response": {
+ "$ref": "FirewallList"
},
- "type": "array",
- "description": "[Output Only] Unreachable resources."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "kind": {
- "default": "compute#targetPoolAggregatedList",
- "description": "[Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.",
- "type": "string"
- }
- },
- "id": "TargetPoolAggregatedList"
- },
- "UrlMapTest": {
- "description": "Message for the expected URL mappings.",
- "properties": {
- "expectedOutputUrl": {
- "type": "string",
- "description": "The expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by the load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to HTTPS. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified."
- },
- "description": {
- "description": "Description of this test case.",
- "type": "string"
- },
- "host": {
- "description": "Host portion of the URL. If headers contains a host header, then host must also match the header value.",
- "type": "string"
- },
- "path": {
- "description": "Path portion of the URL.",
- "type": "string"
- },
- "expectedRedirectResponseCode": {
- "type": "integer",
- "description": "For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.",
- "format": "int32"
- },
- "headers": {
- "items": {
- "$ref": "UrlMapTestHeader"
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "type": "integer",
+ "minimum": "0",
+ "format": "uint32",
+ "default": "500"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
},
- "type": "array",
- "description": "HTTP headers for this request. If headers contains a host header, then host must also match the header value."
+ "path": "projects/{project}/global/firewalls",
+ "flatPath": "projects/{project}/global/firewalls",
+ "httpMethod": "GET",
+ "id": "compute.firewalls.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves the list of firewall rules available to the specified project.",
+ "parameterOrder": [
+ "project"
+ ]
},
- "service": {
- "description": "Expected BackendService or BackendBucket resource the given URL should be mapped to. The service field cannot be set if expectedRedirectResponseCode is set.",
- "type": "string"
- }
- },
- "type": "object",
- "id": "UrlMapTest"
- },
- "InstancesGetEffectiveFirewallsResponse": {
- "properties": {
- "firewalls": {
- "type": "array",
- "items": {
+ "insert": {
+ "id": "compute.firewalls.insert",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "description": "Creates a firewall rule in the specified project using the data included in the request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/firewalls",
+ "request": {
"$ref": "Firewall"
},
- "description": "Effective firewalls on the instance."
- },
- "firewallPolicys": {
- "description": "Effective firewalls from firewall policies.",
- "type": "array",
- "items": {
- "$ref": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
- }
+ "path": "projects/{project}/global/firewalls",
+ "httpMethod": "POST"
}
- },
- "id": "InstancesGetEffectiveFirewallsResponse",
- "type": "object"
+ }
},
- "AddressesScopedList": {
- "id": "AddressesScopedList",
- "properties": {
- "addresses": {
- "items": {
- "$ref": "Address"
+ "targetSslProxies": {
+ "methods": {
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "TargetSslProxy"
},
- "description": "[Output Only] A list of addresses contained in this scope.",
- "type": "array"
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "parameterOrder": [
+ "project",
+ "targetSslProxy"
+ ],
+ "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "targetSslProxy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the TargetSslProxy resource to return.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ }
+ },
+ "description": "Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request.",
+ "id": "compute.targetSslProxies.get",
+ "httpMethod": "GET",
+ "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}"
+ },
+ "setCertificateMap": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Changes the Certificate Map for TargetSslProxy.",
+ "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap",
+ "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap",
+ "parameters": {
+ "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).",
+ "location": "query",
"type": "string"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "type": "string"
+ "targetSslProxy": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035."
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
}
- }
- }
- },
- "type": "object"
- },
- "HealthCheckServicesList": {
- "id": "HealthCheckServicesList",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ },
+ "httpMethod": "POST",
+ "id": "compute.targetSslProxies.setCertificateMap",
+ "request": {
+ "$ref": "TargetSslProxiesSetCertificateMapRequest"
+ },
+ "parameterOrder": [
+ "project",
+ "targetSslProxy"
+ ]
},
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices.",
- "type": "string",
- "default": "compute#healthCheckServicesList"
+ "setSslPolicy": {
+ "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "SslPolicyReference"
+ },
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "targetSslProxy": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy",
+ "description": "Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "targetSslProxy"
+ ],
+ "id": "compute.targetSslProxies.setSslPolicy"
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "setBackendService": {
+ "request": {
+ "$ref": "TargetSslProxiesSetBackendServiceRequest"
+ },
+ "description": "Changes the BackendService for TargetSslProxy.",
+ "httpMethod": "POST",
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "targetSslProxy": {
+ "location": "path",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "Name of the TargetSslProxy resource whose BackendService resource is to be set.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request."
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.targetSslProxies.setBackendService",
+ "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService",
+ "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService",
+ "parameterOrder": [
+ "project",
+ "targetSslProxy"
+ ]
+ },
+ "setProxyHeader": {
+ "id": "compute.targetSslProxies.setProxyHeader",
+ "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader",
+ "request": {
+ "$ref": "TargetSslProxiesSetProxyHeaderRequest"
+ },
+ "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
},
- "data": {
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
},
- "message": {
+ "targetSslProxy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the TargetSslProxy resource whose ProxyHeader is to be set.",
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true
}
+ },
+ "parameterOrder": [
+ "project",
+ "targetSslProxy"
+ ],
+ "description": "Changes the ProxyHeaderType for TargetSslProxy.",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
}
},
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "items": {
- "items": {
- "$ref": "HealthCheckService"
+ "delete": {
+ "httpMethod": "DELETE",
+ "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}",
+ "id": "compute.targetSslProxies.delete",
+ "description": "Deletes the specified TargetSslProxy resource.",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "A list of HealthCheckService resources."
- }
- },
- "type": "object"
- },
- "ProjectsEnableXpnResourceRequest": {
- "id": "ProjectsEnableXpnResourceRequest",
- "type": "object",
- "properties": {
- "xpnResource": {
- "$ref": "XpnResourceId",
- "description": "Service resource (a.k.a service project) ID."
- }
- }
- },
- "HealthChecksAggregatedList": {
- "type": "object",
- "properties": {
- "warning": {
- "properties": {
- "message": {
+ "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "targetSslProxy": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the TargetSslProxy resource to delete.",
+ "location": "path"
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- }
+ "project": {
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "requestId": {
+ "location": "query",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "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)."
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- },
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "items": {
- "description": "A list of HealthChecksScopedList resources.",
- "additionalProperties": {
- "$ref": "HealthChecksScopedList",
- "description": "Name of the scope containing this set of HealthChecks."
- },
- "type": "object"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "kind": {
- "default": "compute#healthChecksAggregatedList",
- "description": "Type of resource.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- }
- },
- "id": "HealthChecksAggregatedList"
- },
- "TargetSslProxy": {
- "type": "object",
- "id": "TargetSslProxy",
- "properties": {
- "certificateMap": {
- "type": "string",
- "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored."
- },
- "sslPolicy": {
- "description": "URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.",
- "type": "string"
- },
- "sslCertificates": {
- "description": "URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "parameterOrder": [
+ "project",
+ "targetSslProxy"
+ ]
},
- "proxyHeader": {
- "type": "string",
- "enumDescriptions": [
- "",
- ""
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "NONE",
- "PROXY_V1"
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/global/targetSslProxies",
+ "description": "Retrieves the list of TargetSslProxy resources available to the specified project.",
+ "id": "compute.targetSslProxies.list",
+ "parameters": {
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "default": "500",
+ "format": "uint32",
+ "type": "integer",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "path": "projects/{project}/global/targetSslProxies",
+ "parameterOrder": [
+ "project"
],
- "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "name": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "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."
- },
- "id": {
- "format": "uint64",
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.",
- "type": "string",
- "default": "compute#targetSslProxy"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
+ "response": {
+ "$ref": "TargetSslProxyList"
+ }
},
- "service": {
- "type": "string",
- "description": "URL to the BackendService resource."
- }
- },
- "description": "Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies."
- },
- "VpnGatewayStatus": {
- "properties": {
- "vpnConnections": {
- "type": "array",
- "items": {
- "$ref": "VpnGatewayStatusVpnConnection"
+ "insert": {
+ "flatPath": "projects/{project}/global/targetSslProxies",
+ "path": "projects/{project}/global/targetSslProxies",
+ "description": "Creates a TargetSslProxy resource in the specified project using the data included in the request.",
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ }
},
- "description": "List of VPN connection for this VpnGateway."
- }
- },
- "id": "VpnGatewayStatus",
- "type": "object"
- },
- "RegionSetPolicyRequest": {
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "format": "byte",
- "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag."
- },
- "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 in general a valid policy but certain services (like Projects) might reject them.",
- "$ref": "Policy"
- },
- "bindings": {
- "type": "array",
- "items": {
- "$ref": "Binding"
+ "request": {
+ "$ref": "TargetSslProxy"
},
- "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings."
- }
- },
- "id": "RegionSetPolicyRequest"
- },
- "Subsetting": {
- "description": "Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.",
- "type": "object",
- "properties": {
- "policy": {
- "type": "string",
- "enum": [
- "CONSISTENT_HASH_SUBSETTING",
- "NONE"
+ "id": "compute.targetSslProxies.insert",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project"
],
- "enumDescriptions": [
- "Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the `subset_size` parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled.",
- "No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends."
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
- }
- },
- "id": "Subsetting"
- },
- "NotificationEndpoint": {
- "properties": {
- "grpcSettings": {
- "$ref": "NotificationEndpointGrpcSettings",
- "description": "Settings of the gRPC notification endpoint including the endpoint URL and the retry duration."
- },
- "name": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "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."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
- },
- "id": {
- "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
- "format": "uint64",
- "type": "string"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "kind": {
- "default": "compute#notificationEndpoint",
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints."
- }
- },
- "id": "NotificationEndpoint",
- "type": "object",
- "description": "Represents a notification endpoint. A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. For more information, see Health checks overview."
- },
- "NetworkEndpointGroupCloudRun": {
- "description": "Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.",
- "properties": {
- "urlMask": {
- "description": "A template to parse \u003cservice\u003e and \u003ctag\u003e fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs \"foo1.domain.com/bar1\" and \"foo1.domain.com/bar2\" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask \"\u003ctag\u003e.domain.com/\u003cservice\u003e\". The URL mask will parse them to { service=\"bar1\", tag=\"foo1\" } and { service=\"bar2\", tag=\"foo2\" } respectively.",
- "type": "string"
- },
- "tag": {
- "type": "string",
- "description": "Optional Cloud Run tag represents the \"named-revision\" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: \"revision-0010\"."
},
- "service": {
- "type": "string",
- "description": "Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: \"run-service\"."
- }
- },
- "id": "NetworkEndpointGroupCloudRun",
- "type": "object"
- },
- "ErrorInfo": {
- "id": "ErrorInfo",
- "properties": {
- "metadatas": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
+ "setSslCertificates": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.targetSslProxies.setSslCertificates",
+ "request": {
+ "$ref": "TargetSslProxiesSetSslCertificatesRequest"
},
- "description": "Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {\"instanceLimit\": \"100/request\"}, should be returned as, {\"instanceLimitPerRequest\": \"100\"}, if the client exceeds the number of instances that can be created in a single (batch) request."
- },
- "reason": {
- "description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.",
- "type": "string"
- },
- "domain": {
- "type": "string",
- "description": "The logical grouping to which the \"reason\" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: \"pubsub.googleapis.com\". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is \"googleapis.com\"."
- }
- },
- "type": "object",
- "description": "Describes the cause of the error with structured details. Example of an error when contacting the \"pubsub.googleapis.com\" API when it is not enabled: { \"reason\": \"API_DISABLED\" \"domain\": \"googleapis.com\" \"metadata\": { \"resource\": \"projects/123\", \"service\": \"pubsub.googleapis.com\" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { \"reason\": \"STOCKOUT\" \"domain\": \"spanner.googleapis.com\", \"metadata\": { \"availableRegions\": \"us-central1,us-east2\" } }"
- },
- "DiskTypesScopedList": {
- "properties": {
- "diskTypes": {
- "description": "[Output Only] A list of disk types contained in this scope.",
- "items": {
- "$ref": "DiskType"
+ "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- },
- "warning": {
- "description": "[Output Only] Informational warning which replaces the list of disk types when the list is empty.",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "description": "Changes SslCertificates for TargetSslProxy.",
+ "parameterOrder": [
+ "project",
+ "targetSslProxy"
+ ],
+ "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates",
+ "parameters": {
+ "targetSslProxy": {
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the TargetSslProxy resource whose SslCertificate resource is to be set.",
+ "location": "path"
},
- "code": {
+ "project": {
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "type": "array"
+ "requestId": {
+ "type": "string",
+ "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": "object"
- }
- },
- "id": "DiskTypesScopedList",
- "type": "object"
- },
- "InstancesRemoveResourcePoliciesRequest": {
- "properties": {
- "resourcePolicies": {
- "type": "array",
- "description": "Resource policies to be removed from this instance.",
- "items": {
- "type": "string"
}
}
- },
- "type": "object",
- "id": "InstancesRemoveResourcePoliciesRequest"
- },
- "SubnetworksExpandIpCidrRangeRequest": {
- "type": "object",
- "id": "SubnetworksExpandIpCidrRangeRequest",
- "properties": {
- "ipCidrRange": {
- "description": "The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update.",
- "type": "string"
- }
}
},
- "DiskInstantiationConfig": {
- "description": "A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.",
- "id": "DiskInstantiationConfig",
- "type": "object",
- "properties": {
- "autoDelete": {
- "type": "boolean",
- "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance)."
- },
- "instantiateFrom": {
- "enum": [
- "ATTACH_READ_ONLY",
- "BLANK",
- "CUSTOM_IMAGE",
- "DEFAULT",
- "DO_NOT_INCLUDE",
- "SOURCE_IMAGE",
- "SOURCE_IMAGE_FAMILY"
+ "projects": {
+ "methods": {
+ "setDefaultNetworkTier": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "enumDescriptions": [
- "Attach the existing disk in read-only mode. The request will fail if the disk was attached in read-write mode on the source instance. Applicable to: read-only disks.",
- "Create a blank disk. The disk will be created unformatted. Applicable to: additional read-write disks, local SSDs.",
- "Use the custom image specified in the custom_image field. Applicable to: boot disk, additional read-write disks.",
- "Use the default instantiation option for the corresponding type of disk. For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.",
- "Do not include the disk in the instance template. Applicable to: additional read-write disks, local SSDs, read-only disks.",
- "Use the same source image used for creation of the source instance's corresponding disk. The request will fail if the source VM's disk was created from a snapshot. Applicable to: boot disk, additional read-write disks.",
- "Use the same source image family used for creation of the source instance's corresponding disk. The request will fail if the source image of the source disk does not belong to any image family. Applicable to: boot disk, additional read-write disks."
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
+ },
+ "flatPath": "projects/{project}/setDefaultNetworkTier",
+ "path": "projects/{project}/setDefaultNetworkTier",
+ "httpMethod": "POST",
+ "id": "compute.projects.setDefaultNetworkTier",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project"
],
- "description": "Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. "
- },
- "customImage": {
- "type": "string",
- "description": "The custom source image to be used to restore this disk when instantiating this instance template."
+ "description": "Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.",
+ "request": {
+ "$ref": "ProjectsSetDefaultNetworkTierRequest"
+ }
},
- "deviceName": {
- "type": "string",
- "description": "Specifies the device name of the disk to which the configurations apply to."
- }
- }
- },
- "LocationPolicyLocationConstraints": {
- "properties": {
- "maxCount": {
- "description": "Maximum number of items that are allowed to be placed in this zone. The value must be non-negative.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "LocationPolicyLocationConstraints",
- "description": "Per-zone constraints on location policy for this zone.",
- "type": "object"
- },
- "InstanceGroupManager": {
- "description": "Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource.",
- "properties": {
- "listManagedInstancesResults": {
- "enum": [
- "PAGELESS",
- "PAGINATED"
+ "setCommonInstanceMetadata": {
+ "path": "projects/{project}/setCommonInstanceMetadata",
+ "flatPath": "projects/{project}/setCommonInstanceMetadata",
+ "parameterOrder": [
+ "project"
],
- "type": "string",
- "enumDescriptions": [
- "(Default) Pagination is disabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are ignored and all instances are returned in a single response.",
- "Pagination is enabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are respected."
+ "httpMethod": "POST",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "request": {
+ "$ref": "Metadata"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Pagination behavior of the listManagedInstances API method for this managed instance group."
- },
- "distributionPolicy": {
- "description": "Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.",
- "$ref": "DistributionPolicy"
- },
- "selfLink": {
- "description": "[Output Only] The URL for this managed instance group. The server defines this URL.",
- "type": "string"
+ "id": "compute.projects.setCommonInstanceMetadata",
+ "description": "Sets metadata common to all instances within the specified project using the data included in the request.",
+ "response": {
+ "$ref": "Operation"
+ }
},
- "targetSize": {
- "type": "integer",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert",
- "compute.regionInstanceGroupManagers.insert"
- ]
+ "getXpnHost": {
+ "id": "compute.projects.getXpnHost",
+ "flatPath": "projects/{project}/getXpnHost",
+ "description": "Gets the shared VPC host project that this project links to. May be empty if no link exists.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path"
+ }
},
- "description": "The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.",
- "format": "int32"
- },
- "id": {
- "format": "uint64",
- "type": "string",
- "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier."
- },
- "baseInstanceName": {
- "pattern": "[a-z][-a-z0-9]{0,57}",
- "type": "string",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert"
- ]
+ "response": {
+ "$ref": "Project"
},
- "description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035."
+ "path": "projects/{project}/getXpnHost"
},
- "statefulPolicy": {
- "description": "Stateful configuration for this Instanced Group Manager",
- "$ref": "StatefulPolicy"
- },
- "creationTimestamp": {
- "description": "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.",
- "type": "string"
- },
- "targetPools": {
- "items": {
- "type": "string"
+ "moveDisk": {
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true
+ }
},
- "type": "array",
- "description": "The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group."
- },
- "region": {
- "type": "string",
- "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources)."
- },
- "status": {
- "description": "[Output Only] The status of this managed instance group.",
- "$ref": "InstanceGroupManagerStatus"
- },
- "fingerprint": {
- "type": "string",
- "format": "byte",
- "description": "Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager."
- },
- "versions": {
- "items": {
- "$ref": "InstanceGroupManagerVersion"
+ "parameterOrder": [
+ "project"
+ ],
+ "request": {
+ "$ref": "DiskMoveRequest"
},
- "type": "array",
- "description": "Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates."
- },
- "updatePolicy": {
- "description": "The update policy for this managed instance group.",
- "$ref": "InstanceGroupManagerUpdatePolicy"
- },
- "name": {
- "type": "string",
- "description": "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.instanceGroupManagers.insert",
- "compute.regionInstanceGroupManagers.insert"
- ]
- }
- },
- "currentActions": {
- "$ref": "InstanceGroupManagerActionsSummary",
- "description": "[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions."
- },
- "zone": {
- "description": "[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).",
- "type": "string"
- },
- "instanceTemplate": {
- "type": "string",
- "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE."
- },
- "namedPorts": {
- "type": "array",
- "items": {
- "$ref": "NamedPort"
+ "response": {
+ "$ref": "Operation"
},
- "description": "Named ports configured for the Instance Groups complementary to this Instance Group Manager."
- },
- "description": {
- "description": "An optional description of this resource.",
- "type": "string"
- },
- "kind": {
- "default": "compute#instanceGroupManager",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.",
- "type": "string"
+ "description": "Moves a persistent disk from one zone to another.",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.projects.moveDisk",
+ "flatPath": "projects/{project}/moveDisk",
+ "path": "projects/{project}/moveDisk"
},
- "autoHealingPolicies": {
- "description": "The autohealing policy for this managed instance group. You can specify only one value.",
- "type": "array",
- "items": {
- "$ref": "InstanceGroupManagerAutoHealingPolicy"
+ "getXpnResources": {
+ "httpMethod": "GET",
+ "id": "compute.projects.getXpnResources",
+ "description": "Gets service resources (a.k.a service project) associated with this host project.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/getXpnResources",
+ "flatPath": "projects/{project}/getXpnResources",
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "ProjectsGetXpnResources"
+ },
+ "parameters": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "type": "integer",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "default": "500",
+ "format": "uint32"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ }
}
},
- "instanceGroup": {
- "type": "string",
- "description": "[Output Only] The URL of the Instance Group resource."
- }
- },
- "type": "object",
- "id": "InstanceGroupManager"
- },
- "RouterNatLogConfig": {
- "description": "Configuration of logging on a NAT.",
- "id": "RouterNatLogConfig",
- "type": "object",
- "properties": {
- "enable": {
- "description": "Indicates whether or not to export logs. This is false by default.",
- "type": "boolean"
+ "setUsageExportBucket": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/devstorage.full_control",
+ "https://www.googleapis.com/auth/devstorage.read_only",
+ "https://www.googleapis.com/auth/devstorage.read_write"
+ ],
+ "description": "Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.",
+ "request": {
+ "$ref": "UsageExportLocation"
+ },
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/setUsageExportBucket",
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ }
+ },
+ "id": "compute.projects.setUsageExportBucket",
+ "path": "projects/{project}/setUsageExportBucket"
},
- "filter": {
- "enum": [
- "ALL",
- "ERRORS_ONLY",
- "TRANSLATIONS_ONLY"
+ "listXpnHosts": {
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "minimum": "0",
+ "default": "500",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "XpnHostList"
+ },
+ "flatPath": "projects/{project}/listXpnHosts",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project"
],
- "enumDescriptions": [
- "Export logs for all (successful and unsuccessful) connections.",
- "Export logs for connection failures only.",
- "Export logs for successful connections only."
+ "path": "projects/{project}/listXpnHosts",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful. ",
- "type": "string"
- }
- }
- },
- "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": {
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy."
- },
- "shortName": {
- "description": "[Output Only] The short name of the firewall policy.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] The name of the firewall policy."
+ "description": "Lists all shared VPC host projects visible to the user in an organization.",
+ "request": {
+ "$ref": "ProjectsListXpnHostsRequest"
+ },
+ "id": "compute.projects.listXpnHosts"
},
- "type": {
- "enum": [
- "HIERARCHY",
- "NETWORK",
- "NETWORK_REGIONAL",
- "UNSPECIFIED"
- ],
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- ""
+ "enableXpnHost": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL."
- },
- "rules": {
- "items": {
- "$ref": "FirewallPolicyRule"
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
},
- "description": "The rules that apply to the network.",
- "type": "array"
- }
- },
- "id": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
- },
- "Subnetwork": {
- "properties": {
- "privateIpv6GoogleAccess": {
- "description": "This field is for internal use. This field can be both set at resource creation time and updated using patch.",
- "type": "string",
- "enum": [
- "DISABLE_GOOGLE_ACCESS",
- "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
- "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE"
+ "description": "Enable this project as a shared VPC host project.",
+ "parameterOrder": [
+ "project"
],
- "enumDescriptions": [
- "Disable private IPv6 access to/from Google services.",
- "Bidirectional private IPv6 access to/from Google services.",
- "Outbound private IPv6 access from VMs in this subnet to Google services."
- ]
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "fingerprint": {
- "format": "byte",
- "description": "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 Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork.",
- "type": "string"
+ "flatPath": "projects/{project}/enableXpnHost",
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "path": "projects/{project}/enableXpnHost",
+ "id": "compute.projects.enableXpnHost"
},
- "stackType": {
- "type": "string",
- "description": "The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.",
- "enum": [
- "IPV4_IPV6",
- "IPV4_ONLY"
+ "get": {
+ "flatPath": "projects/{project}",
+ "description": "Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.",
+ "path": "projects/{project}",
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enumDescriptions": [
- "New VMs in this subnet can have both IPv4 and IPv6 addresses.",
- "New VMs in this subnet will only be assigned IPv4 addresses."
+ "httpMethod": "GET",
+ "id": "compute.projects.get",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "parameterOrder": [
+ "project"
]
},
- "purpose": {
- "enumDescriptions": [
- "Subnet reserved for Internal HTTP(S) Load Balancing.",
- "Regular user created or automatically created subnet.",
- "Regular user created or automatically created subnet.",
- "Subnetworks created for Private Service Connect in the producer network.",
- "Subnetwork used for Regional Internal/External HTTP(S) Load Balancing."
+ "moveInstance": {
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "InstanceMoveRequest"
+ },
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "project"
],
- "enum": [
- "INTERNAL_HTTPS_LOAD_BALANCER",
- "PRIVATE",
- "PRIVATE_RFC_1918",
- "PRIVATE_SERVICE_CONNECT",
- "REGIONAL_MANAGED_PROXY"
+ "description": "Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.",
- "type": "string"
- },
- "gatewayAddress": {
- "type": "string",
- "description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork."
+ "id": "compute.projects.moveInstance",
+ "flatPath": "projects/{project}/moveInstance",
+ "path": "projects/{project}/moveInstance",
+ "response": {
+ "$ref": "Operation"
+ }
},
- "state": {
- "enumDescriptions": [
- "Subnetwork is being drained.",
- "Subnetwork is ready for use."
+ "enableXpnResource": {
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
+ },
+ "path": "projects/{project}/enableXpnResource",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "DRAINING",
- "READY"
+ "description": "Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.",
+ "id": "compute.projects.enableXpnResource",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/enableXpnResource",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project"
],
- "type": "string",
- "description": "[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY"
- },
- "logConfig": {
- "$ref": "SubnetworkLogConfig",
- "description": "This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging."
+ "request": {
+ "$ref": "ProjectsEnableXpnResourceRequest"
+ }
},
- "ipv6AccessType": {
- "enum": [
- "EXTERNAL",
- "INTERNAL"
+ "disableXpnHost": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/disableXpnHost",
+ "flatPath": "projects/{project}/disableXpnHost",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ }
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project"
],
- "enumDescriptions": [
- "VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.",
- "VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network."
+ "description": "Disable this project as a shared VPC host project.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "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.",
- "type": "string"
+ "id": "compute.projects.disableXpnHost"
},
- "network": {
- "type": "string",
- "description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time."
- },
- "secondaryIpRanges": {
- "items": {
- "$ref": "SubnetworkSecondaryRange"
+ "disableXpnResource": {
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request."
- },
- "role": {
- "enum": [
- "ACTIVE",
- "BACKUP"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "The ACTIVE subnet that is currently used.",
- "The BACKUP subnet that could be promoted to ACTIVE."
+ "request": {
+ "$ref": "ProjectsDisableXpnResourceRequest"
+ },
+ "description": "Disable a service resource (also known as service project) associated with this host project.",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "project"
],
- "type": "string",
- "description": "The role of subnetwork. Currently, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request."
- },
- "internalIpv6Prefix": {
- "description": "[Output Only] The internal IPv6 address range that is assigned to this subnetwork.",
- "type": "string"
- },
- "privateIpGoogleAccess": {
- "type": "boolean",
- "description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess."
- },
- "ipCidrRange": {
- "description": "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.",
- "type": "string"
- },
- "ipv6CidrRange": {
- "type": "string",
- "description": "[Output Only] This field is for internal use."
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time."
- },
- "region": {
- "type": "string",
- "description": "URL of the region where the Subnetwork resides. This field can be set only at resource creation time."
- },
- "id": {
- "type": "string",
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.",
- "default": "compute#subnetwork"
- },
- "externalIpv6Prefix": {
- "type": "string",
- "description": "The external IPv6 address range that is owned by this subnetwork."
- },
- "enableFlowLogs": {
- "description": "Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.",
- "type": "boolean"
- },
- "name": {
- "type": "string",
- "description": "The name of the resource, provided by the client when initially creating the resource. 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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- }
- },
- "id": "Subnetwork",
- "description": "Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network.",
- "type": "object"
- },
- "AllocationSpecificSKUReservation": {
- "description": "This reservation type allows to pre allocate specific instance configuration. Next ID: 6",
- "id": "AllocationSpecificSKUReservation",
- "type": "object",
- "properties": {
- "assuredCount": {
- "format": "int64",
- "type": "string",
- "description": "[Output Only] Indicates how many instances are actually usable currently."
- },
- "count": {
- "type": "string",
- "format": "int64",
- "description": "Specifies the number of resources that are allocated."
- },
- "inUseCount": {
- "description": "[Output Only] Indicates how many instances are in use.",
- "type": "string",
- "format": "int64"
- },
- "instanceProperties": {
- "description": "The instance properties for the reservation.",
- "$ref": "AllocationSpecificSKUAllocationReservedInstanceProperties"
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/disableXpnResource",
+ "id": "compute.projects.disableXpnResource",
+ "path": "projects/{project}/disableXpnResource"
}
}
},
- "ResourcePolicySnapshotSchedulePolicySchedule": {
- "id": "ResourcePolicySnapshotSchedulePolicySchedule",
- "type": "object",
- "properties": {
- "hourlySchedule": {
- "$ref": "ResourcePolicyHourlyCycle"
- },
- "weeklySchedule": {
- "$ref": "ResourcePolicyWeeklyCycle"
- },
- "dailySchedule": {
- "$ref": "ResourcePolicyDailyCycle"
- }
- },
- "description": "A schedule for disks where the schedueled operations are performed."
- },
- "HealthCheckServiceReference": {
- "description": "A full or valid partial URL to a health check service. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service - projects/project-id/regions/us-west1/healthCheckServices/health-check-service - regions/us-west1/healthCheckServices/health-check-service ",
- "id": "HealthCheckServiceReference",
- "properties": {
- "healthCheckService": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "InstanceGroupAggregatedList": {
- "id": "InstanceGroupAggregatedList",
- "properties": {
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "code": {
+ "globalOrganizationOperations": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified Operations resource.",
+ "path": "locations/global/operations/{operation}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "locations/global/operations/{operation}",
+ "parameterOrder": [
+ "operation"
+ ],
+ "id": "compute.globalOrganizationOperations.delete",
+ "parameters": {
+ "parentId": {
+ "location": "query",
+ "description": "Parent ID for this request.",
+ "type": "string"
+ },
+ "operation": {
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the Operations resource to delete."
+ }
+ },
+ "httpMethod": "DELETE"
+ },
+ "list": {
+ "id": "compute.globalOrganizationOperations.list",
+ "path": "locations/global/operations",
+ "parameters": {
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
},
- "message": {
+ "maxResults": {
+ "default": "500",
+ "type": "integer",
+ "format": "uint32",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query"
+ },
+ "parentId": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "query",
+ "description": "Parent ID for this request."
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "type": "array"
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
}
- }
- },
- "kind": {
- "default": "compute#instanceGroupAggregatedList",
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups."
- },
- "unreachables": {
- "items": {
- "type": "string"
},
- "description": "[Output Only] Unreachable resources.",
- "type": "array"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "locations/global/operations",
+ "response": {
+ "$ref": "OperationList"
+ },
+ "description": "Retrieves a list of Operation resources contained within the specified organization.",
+ "httpMethod": "GET"
},
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "The name of the scope that contains this set of instance groups.",
- "$ref": "InstanceGroupsScopedList"
+ "get": {
+ "flatPath": "locations/global/operations/{operation}",
+ "id": "compute.globalOrganizationOperations.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "locations/global/operations/{operation}",
+ "parameterOrder": [
+ "operation"
+ ],
+ "description": "Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.",
+ "parameters": {
+ "operation": {
+ "type": "string",
+ "location": "path",
+ "description": "Name of the Operations resource to return.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "parentId": {
+ "description": "Parent ID for this request.",
+ "type": "string",
+ "location": "query"
+ }
},
- "description": "A list of InstanceGroupsScopedList resources."
- }
- },
- "type": "object"
- },
- "SecurityPolicyReference": {
- "type": "object",
- "properties": {
- "securityPolicy": {
- "type": "string"
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ }
}
- },
- "id": "SecurityPolicyReference"
+ }
},
- "PublicDelegatedPrefix": {
- "properties": {
- "publicDelegatedSubPrefixs": {
- "type": "array",
- "description": "The list of sub public delegated prefixes that exist for this public delegated prefix.",
- "items": {
- "$ref": "PublicDelegatedPrefixPublicDelegatedSubPrefix"
+ "regionAutoscalers": {
+ "methods": {
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "parameters": {
+ "autoscaler": {
+ "type": "string",
+ "description": "Name of the autoscaler to patch.",
+ "location": "query",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ }
+ },
+ "id": "compute.regionAutoscalers.patch",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/regions/{region}/autoscalers",
+ "description": "Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/regions/{region}/autoscalers",
+ "request": {
+ "$ref": "Autoscaler"
}
},
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "fingerprint": {
- "type": "string",
- "format": "byte",
- "description": "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 new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix."
- },
- "name": {
- "type": "string",
- "description": "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.",
- "annotations": {
- "required": [
- "compute.publicDelegatedPrefixes.insert"
- ]
+ "list": {
+ "description": "Retrieves a list of autoscalers contained within the specified region.",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "path": "projects/{project}/regions/{region}/autoscalers",
+ "flatPath": "projects/{project}/regions/{region}/autoscalers",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.regionAutoscalers.list",
+ "httpMethod": "GET",
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer",
+ "default": "500"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ }
},
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
+ "response": {
+ "$ref": "RegionAutoscalerList"
+ }
},
- "status": {
- "type": "string",
- "enumDescriptions": [
- "The public delegated prefix is active.",
- "The public delegated prefix is being deprovsioned.",
- "The public delegated prefix is being initialized and addresses cannot be created yet.",
- "The public delegated prefix is currently withdrawn but ready to be announced."
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/regions/{region}/autoscalers/{autoscaler}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "autoscaler"
],
- "enum": [
- "ANNOUNCED",
- "DELETING",
- "INITIALIZING",
- "READY_TO_ANNOUNCE"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[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. "
- },
- "isLiveMigration": {
- "description": "If true, the prefix will be live migrated.",
- "type": "boolean"
- },
- "kind": {
- "default": "compute#publicDelegatedPrefix",
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes."
- },
- "ipCidrRange": {
- "description": "The IPv4 address range, in CIDR format, represented by this public delegated prefix.",
- "type": "string"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
- },
- "parentPrefix": {
- "description": "The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.",
- "type": "string",
- "format": "uint64"
- }
- },
- "id": "PublicDelegatedPrefix",
- "type": "object",
- "description": "A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block."
- },
- "HttpFaultDelay": {
- "description": "Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.",
- "properties": {
- "percentage": {
- "type": "number",
- "description": "The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive.",
- "format": "double"
- },
- "fixedDelay": {
- "description": "Specifies the value of the fixed delay interval.",
- "$ref": "Duration"
- }
- },
- "type": "object",
- "id": "HttpFaultDelay"
- },
- "LogConfigCloudAuditOptions": {
- "id": "LogConfigCloudAuditOptions",
- "properties": {
- "authorizationLoggingOptions": {
- "$ref": "AuthorizationLoggingOptions",
- "description": "This is deprecated and has no effect. Do not use."
+ "description": "Deletes the specified autoscaler.",
+ "id": "compute.regionAutoscalers.delete",
+ "httpMethod": "DELETE",
+ "flatPath": "projects/{project}/regions/{region}/autoscalers/{autoscaler}",
+ "parameters": {
+ "region": {
+ "location": "path",
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "autoscaler": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the autoscaler to delete.",
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
+ }
},
- "logName": {
- "enumDescriptions": [
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use."
+ "insert": {
+ "flatPath": "projects/{project}/regions/{region}/autoscalers",
+ "request": {
+ "$ref": "Autoscaler"
+ },
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/autoscalers",
+ "id": "compute.regionAutoscalers.insert",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "This is deprecated and has no effect. Do not use.",
- "type": "string",
- "enum": [
- "ADMIN_ACTIVITY",
- "DATA_ACCESS",
- "UNSPECIFIED_LOG_NAME"
- ]
- }
- },
- "type": "object",
- "description": "This is deprecated and has no effect. Do not use."
- },
- "UrlMapTestHeader": {
- "description": "HTTP headers used in UrlMapTests.",
- "properties": {
- "value": {
- "description": "Header value.",
- "type": "string"
- },
- "name": {
- "description": "Header name.",
- "type": "string"
- }
- },
- "type": "object",
- "id": "UrlMapTestHeader"
- },
- "TargetInstanceAggregatedList": {
- "id": "TargetInstanceAggregatedList",
- "type": "object",
- "properties": {
- "unreachables": {
- "items": {
- "type": "string"
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "region": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ }
},
- "type": "array",
- "description": "[Output Only] Unreachable resources."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "items": {
- "additionalProperties": {
- "$ref": "TargetInstancesScopedList",
- "description": "Name of the scope containing this set of target instances."
+ "response": {
+ "$ref": "Operation"
},
- "type": "object",
- "description": "A list of TargetInstance resources."
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "description": "Creates an autoscaler in the specified project using the data included in the request."
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "type": "array"
+ "update": {
+ "path": "projects/{project}/regions/{region}/autoscalers",
+ "request": {
+ "$ref": "Autoscaler"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
},
- "message": {
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "region": {
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "autoscaler": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "query",
+ "description": "Name of the autoscaler to update."
+ }
+ },
+ "description": "Updates an autoscaler in the specified project using the data included in the request.",
+ "flatPath": "projects/{project}/regions/{region}/autoscalers",
+ "httpMethod": "PUT",
+ "id": "compute.regionAutoscalers.update",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "region"
+ ]
+ },
+ "get": {
+ "path": "projects/{project}/regions/{region}/autoscalers/{autoscaler}",
+ "parameters": {
+ "autoscaler": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true,
+ "description": "Name of the autoscaler to return.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
},
- "code": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "description": "Project ID for this request."
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string"
}
},
- "type": "object"
- },
- "kind": {
- "type": "string",
- "default": "compute#targetInstanceAggregatedList",
- "description": "Type of resource."
- }
- }
- },
- "ProjectsListXpnHostsRequest": {
- "id": "ProjectsListXpnHostsRequest",
- "properties": {
- "organization": {
- "type": "string",
- "description": "Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project."
- }
- },
- "type": "object"
- },
- "DistributionPolicy": {
- "type": "object",
- "properties": {
- "zones": {
- "items": {
- "$ref": "DistributionPolicyZoneConfiguration"
+ "description": "Returns the specified autoscaler.",
+ "response": {
+ "$ref": "Autoscaler"
},
- "description": "Zones where the regional managed instance group will create and manage its instances.",
- "type": "array"
- },
- "targetShape": {
- "description": "The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).",
- "enum": [
- "ANY",
- "BALANCED",
- "EVEN"
+ "flatPath": "projects/{project}/regions/{region}/autoscalers/{autoscaler}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enumDescriptions": [
- "The group picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.",
- "The group prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across selected zones to minimize the impact of zonal failure. Recommended for highly available serving workloads.",
- "The group schedules VM instance creation and deletion to achieve and maintain an even number of managed instances across the selected zones. The distribution is even when the number of managed instances does not differ by more than 1 between any two zones. Recommended for highly available serving workloads."
+ "id": "compute.regionAutoscalers.get",
+ "parameterOrder": [
+ "project",
+ "region",
+ "autoscaler"
],
- "type": "string"
+ "httpMethod": "GET"
}
- },
- "id": "DistributionPolicy"
+ }
},
- "RouterAggregatedList": {
- "id": "RouterAggregatedList",
- "type": "object",
- "properties": {
- "unreachables": {
- "items": {
- "type": "string"
+ "regionHealthChecks": {
+ "methods": {
+ "insert": {
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "path": "projects/{project}/regions/{region}/healthChecks",
+ "flatPath": "projects/{project}/regions/{region}/healthChecks",
+ "request": {
+ "$ref": "HealthCheck"
},
- "type": "array",
- "description": "[Output Only] Unreachable resources."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "additionalProperties": {
- "description": "Name of the scope containing this set of routers.",
- "$ref": "RoutersScopedList"
+ "id": "compute.regionHealthChecks.insert",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Creates a HealthCheck resource in the specified project using the data included in the request.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "Name of the region scoping this request."
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
},
- "type": "object",
- "description": "A list of Router resources."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ }
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "delete": {
+ "description": "Deletes the specified HealthCheck resource.",
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
+ "parameters": {
+ "healthCheck": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "location": "path",
+ "required": true,
+ "description": "Name of the HealthCheck resource to delete."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string"
},
- "data": {
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "region": {
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
}
- }
- },
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#routerAggregatedList"
- }
- },
- "description": "Contains a list of routers."
- },
- "VpnTunnelList": {
- "properties": {
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "VpnTunnel"
},
- "description": "A list of VpnTunnel resources."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "healthCheck"
+ ],
+ "id": "compute.regionHealthChecks.delete",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}"
},
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ "patch": {
+ "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
+ "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
+ "parameters": {
+ "healthCheck": {
+ "description": "Name of the HealthCheck resource to patch.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "location": "path"
+ }
+ },
+ "id": "compute.regionHealthChecks.patch",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "HealthCheck"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "PATCH",
+ "description": "Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "healthCheck"
+ ]
},
- "warning": {
- "properties": {
- "message": {
+ "get": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "healthCheck"
+ ],
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "type": "array"
+ "healthCheck": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "description": "Name of the HealthCheck resource to return.",
+ "required": true
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "required": true,
+ "location": "path",
+ "description": "Name of the region scoping this request."
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
+ "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
+ "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
+ "description": "Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.",
+ "id": "compute.regionHealthChecks.get",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "HealthCheck"
+ }
},
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
- "type": "string",
- "default": "compute#vpnTunnelList"
+ "update": {
+ "description": "Updates a HealthCheck resource in the specified project using the data included in the request.",
+ "parameters": {
+ "healthCheck": {
+ "type": "string",
+ "location": "path",
+ "description": "Name of the HealthCheck resource to update.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ }
+ },
+ "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
+ "id": "compute.regionHealthChecks.update",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "healthCheck"
+ ],
+ "request": {
+ "$ref": "HealthCheck"
+ },
+ "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}"
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- },
- "id": "VpnTunnelList",
- "description": "Contains a list of VpnTunnel resources.",
- "type": "object"
- },
- "TargetHttpProxiesScopedList": {
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "list": {
+ "httpMethod": "GET",
+ "path": "projects/{project}/regions/{region}/healthChecks",
+ "flatPath": "projects/{project}/regions/{region}/healthChecks",
+ "id": "compute.regionHealthChecks.list",
+ "parameters": {
+ "maxResults": {
+ "minimum": "0",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "region": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
"type": "string"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
"type": "string"
}
},
- "description": "Informational warning which replaces the list of backend services when the list is empty."
- },
- "targetHttpProxies": {
- "description": "A list of TargetHttpProxies contained in this scope.",
- "items": {
- "$ref": "TargetHttpProxy"
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "HealthCheckList"
},
- "type": "array"
+ "description": "Retrieves the list of HealthCheck resources available to the specified project."
}
- },
- "type": "object",
- "id": "TargetHttpProxiesScopedList"
+ }
},
- "SslCertificate": {
- "type": "object",
- "properties": {
- "selfManaged": {
- "$ref": "SslCertificateSelfManagedSslCertificate",
- "description": "Configuration and status of a self-managed SSL certificate."
- },
- "kind": {
- "default": "compute#sslCertificate",
- "description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64"
- },
- "certificate": {
- "description": "A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.",
- "type": "string"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output only] Server-defined URL for the resource.",
- "type": "string"
- },
- "expireTime": {
- "type": "string",
- "description": "[Output Only] Expire time of the certificate. RFC3339"
- },
- "type": {
- "type": "string",
- "enumDescriptions": [
- "Google-managed SSLCertificate.",
- "Certificate uploaded by user.",
- ""
+ "regionHealthCheckServices": {
+ "methods": {
+ "insert": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/regions/{region}/healthCheckServices",
+ "id": "compute.regionHealthCheckServices.insert",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "enum": [
- "MANAGED",
- "SELF_MANAGED",
- "TYPE_UNSPECIFIED"
+ "httpMethod": "POST",
+ "description": "Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "(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."
- },
- "managed": {
- "description": "Configuration and status of a managed SSL certificate.",
- "$ref": "SslCertificateManagedSslCertificate"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate."
- },
- "privateKey": {
- "description": "A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.",
- "type": "string"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "name": {
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "subjectAlternativeNames": {
- "type": "array",
- "description": "[Output Only] Domains associated with the certificate via Subject Alternative Name.",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "SslCertificate",
- "description": "Represents an SSL Certificate resource. Google Compute Engine has two SSL Certificate resources: * [Global](/compute/docs/reference/rest/v1/sslCertificates) * [Regional](/compute/docs/reference/rest/v1/regionSslCertificates) The sslCertificates are used by: - external HTTPS load balancers - SSL proxy load balancers The regionSslCertificates are used by internal HTTPS load balancers. Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates."
- },
- "PublicDelegatedPrefixesScopedList": {
- "properties": {
- "publicDelegatedPrefixes": {
- "description": "[Output Only] A list of PublicDelegatedPrefixes contained in this scope.",
- "items": {
- "$ref": "PublicDelegatedPrefix"
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "region": {
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path"
+ }
},
- "type": "array"
+ "request": {
+ "$ref": "HealthCheckService"
+ },
+ "flatPath": "projects/{project}/regions/{region}/healthCheckServices"
},
- "warning": {
- "description": "[Output Only] Informational warning which replaces the list of public delegated prefixes when the list is empty.",
- "properties": {
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- }
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "HealthCheckService"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "healthCheckService"
+ ],
+ "parameters": {
+ "region": {
+ "location": "path",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "healthCheckService": {
+ "required": true,
+ "location": "path",
+ "description": "Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035.",
"type": "string"
}
},
- "type": "object"
- }
- },
- "type": "object",
- "id": "PublicDelegatedPrefixesScopedList"
- },
- "TargetVpnGateway": {
- "properties": {
- "status": {
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "enum": [
- "CREATING",
- "DELETING",
- "FAILED",
- "READY"
+ "httpMethod": "GET",
+ "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
+ "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
+ "description": "Returns the specified regional HealthCheckService resource.",
+ "id": "compute.regionHealthCheckServices.get"
+ },
+ "list": {
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "format": "uint32",
+ "default": "500",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ }
+ },
+ "flatPath": "projects/{project}/regions/{region}/healthCheckServices",
+ "response": {
+ "$ref": "HealthCheckServicesList"
+ },
+ "description": "Lists all the HealthCheckService resources that have been configured for the specified project in the given region.",
+ "path": "projects/{project}/regions/{region}/healthCheckServices",
+ "id": "compute.regionHealthCheckServices.list",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.",
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "region"
+ ]
},
- "forwardingRules": {
- "type": "array",
- "items": {
- "type": "string"
+ "patch": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "healthCheckService"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "healthCheckService": {
+ "description": "Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ }
},
- "description": "[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway."
- },
- "kind": {
- "type": "string",
- "default": "compute#targetVpnGateway",
- "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "network": {
- "annotations": {
- "required": [
- "compute.targetVpnGateways.insert"
- ]
+ "request": {
+ "$ref": "HealthCheckService"
},
- "description": "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.",
- "type": "string"
- },
- "region": {
- "description": "[Output Only] URL of the region where the target VPN gateway 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"
- },
- "tunnels": {
- "description": "[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.",
- "items": {
- "type": "string"
+ "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
+ "description": "Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "id": {
- "type": "string",
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
+ "id": "compute.regionHealthCheckServices.patch",
+ "httpMethod": "PATCH"
},
- "name": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.targetVpnGateways.insert"
- ]
+ "delete": {
+ "id": "compute.regionHealthCheckServices.delete",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ },
+ "healthCheckService": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035."
+ }
},
- "description": "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."
- }
- },
- "id": "TargetVpnGateway",
- "type": "object",
- "description": "Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview."
- },
- "ResourcePolicySnapshotSchedulePolicy": {
- "type": "object",
- "properties": {
- "schedule": {
- "description": "A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy.",
- "$ref": "ResourcePolicySnapshotSchedulePolicySchedule"
- },
- "retentionPolicy": {
- "description": "Retention policy applied to snapshots created by this resource policy.",
- "$ref": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy"
- },
- "snapshotProperties": {
- "description": "Properties with which snapshots are created such as labels, encryption keys.",
- "$ref": "ResourcePolicySnapshotSchedulePolicySnapshotProperties"
- }
- },
- "description": "A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained.",
- "id": "ResourcePolicySnapshotSchedulePolicy"
- },
- "NetworkAttachmentConnectedEndpoint": {
- "id": "NetworkAttachmentConnectedEndpoint",
- "description": "[Output Only] A connection connected to this network attachment.",
- "type": "object",
- "properties": {
- "projectIdOrNum": {
- "description": "The project id or number of the interface to which the IP was assigned.",
- "type": "string"
- },
- "status": {
- "enum": [
- "ACCEPTED",
- "CLOSED",
- "NEEDS_ATTENTION",
- "PENDING",
- "REJECTED",
- "STATUS_UNSPECIFIED"
+ "parameterOrder": [
+ "project",
+ "region",
+ "healthCheckService"
],
- "description": "The status of a connected endpoint to this network attachment.",
- "enumDescriptions": [
- "The consumer allows traffic from the producer to reach its VPC.",
- "The consumer network attachment no longer exists.",
- "The consumer needs to take further action before traffic can be served.",
- "The consumer neither allows nor prohibits traffic from the producer to reach its VPC.",
- "The consumer prohibits traffic from the producer to reach its VPC.",
- ""
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
- },
- "subnetwork": {
- "description": "The subnetwork used to assign the IP to the producer instance network interface.",
- "type": "string"
- },
- "ipAddress": {
- "type": "string",
- "description": "The IP address assigned to the producer instance network interface. This value will be a range in case of Serverless."
- },
- "secondaryIpCidrRanges": {
- "type": "array",
- "description": "Alias IP ranges from the same subnetwork",
- "items": {
- "type": "string"
- }
+ "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
+ "description": "Deletes the specified regional HealthCheckService.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}"
}
}
},
- "InterconnectDiagnosticsLinkLACPStatus": {
- "id": "InterconnectDiagnosticsLinkLACPStatus",
- "type": "object",
- "properties": {
- "neighborSystemId": {
- "description": "System ID of the port on the neighbor's side of the LACP exchange.",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "The link is configured and active within the bundle.",
- "The link is not configured within the bundle, this means the rest of the object should be empty."
- ],
- "type": "string",
- "enum": [
- "ACTIVE",
- "DETACHED"
+ "licenseCodes": {
+ "methods": {
+ "testIamPermissions": {
+ "id": "compute.licenseCodes.testIamPermissions",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
+ },
+ "resource": {
+ "required": true,
+ "location": "path",
+ "description": "Name or id of the resource for this request.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. "
- },
- "googleSystemId": {
- "description": "System ID of the port on Google's side of the LACP exchange.",
- "type": "string"
- }
- }
- },
- "Backend": {
- "id": "Backend",
- "properties": {
- "balancingMode": {
- "description": "Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.",
- "type": "string",
- "enum": [
- "CONNECTION",
- "RATE",
- "UTILIZATION"
+ "description": "Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
+ "path": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions",
+ "flatPath": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions",
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
],
- "enumDescriptions": [
- "Balance based on the number of simultaneous connections.",
- "Balance based on requests per second (RPS).",
- "Balance based on the backend utilization."
- ]
- },
- "maxRatePerEndpoint": {
- "type": "number",
- "format": "float",
- "description": "Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION."
- },
- "group": {
- "type": "string",
- "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported."
- },
- "maxConnectionsPerInstance": {
- "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.",
- "format": "int32",
- "type": "integer"
- },
- "capacityScaler": {
- "description": "A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.",
- "type": "number",
- "format": "float"
- },
- "failover": {
- "description": "This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.",
- "type": "boolean"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "maxRatePerInstance": {
- "type": "number",
- "description": "Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.",
- "format": "float"
- },
- "maxUtilization": {
- "description": "Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.",
- "format": "float",
- "type": "number"
- },
- "maxConnectionsPerEndpoint": {
- "format": "int32",
- "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.",
- "type": "integer"
- },
- "maxRate": {
- "format": "int32",
- "description": "Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.",
- "type": "integer"
- },
- "maxConnections": {
- "type": "integer",
- "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.",
- "format": "int32"
- }
- },
- "type": "object",
- "description": "Message containing information of one individual backend."
- },
- "HttpQueryParameterMatch": {
- "description": "HttpRouteRuleMatch criteria for a request's query parameter.",
- "type": "object",
- "id": "HttpQueryParameterMatch",
- "properties": {
- "exactMatch": {
- "type": "string",
- "description": "The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch, or regexMatch must be set. "
- },
- "presentMatch": {
- "description": "Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch, or regexMatch must be set. ",
- "type": "boolean"
- },
- "name": {
- "type": "string",
- "description": "The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails."
- },
- "regexMatch": {
- "description": "The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For more information about regular expression syntax, see Syntax. Only one of presentMatch, exactMatch, or regexMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. ",
- "type": "string"
- }
- }
- },
- "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings": {
- "id": "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings",
- "type": "object",
- "description": "Contains information of NAT Mappings provided by a NAT Rule.",
- "properties": {
- "natIpPortRanges": {
- "type": "array",
- "description": "A list of all IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].",
- "items": {
- "type": "string"
+ "request": {
+ "$ref": "TestPermissionsRequest"
}
},
- "ruleNumber": {
- "format": "int32",
- "type": "integer",
- "description": "Rule number of the NAT Rule."
- },
- "numTotalDrainNatPorts": {
- "description": "Total number of drain ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field drain_nat_ip_port_ranges.",
- "format": "int32",
- "type": "integer"
- },
- "numTotalNatPorts": {
- "description": "Total number of ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field nat_ip_port_ranges.",
- "format": "int32",
- "type": "integer"
- },
- "drainNatIpPortRanges": {
- "items": {
- "type": "string"
+ "get": {
+ "parameters": {
+ "licenseCode": {
+ "pattern": "[0-9]{0,61}?",
+ "required": true,
+ "description": "Number corresponding to the License code resource to return.",
+ "type": "string",
+ "location": "path"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ }
},
- "type": "array",
- "description": "List of all drain IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"]."
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "LicenseCode"
+ },
+ "parameterOrder": [
+ "project",
+ "licenseCode"
+ ],
+ "description": "Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ",
+ "path": "projects/{project}/global/licenseCodes/{licenseCode}",
+ "id": "compute.licenseCodes.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/global/licenseCodes/{licenseCode}"
}
}
},
- "Reservation": {
- "id": "Reservation",
- "description": "Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "commitment": {
- "type": "string",
- "description": "[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined fully-qualified URL for this resource.",
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.",
- "type": "string",
- "default": "compute#reservation"
- },
- "specificReservationRequired": {
- "type": "boolean",
- "description": "Indicates whether the reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation."
- },
- "satisfiesPzs": {
- "description": "[Output Only] Reserved for future use.",
- "type": "boolean"
- },
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.instances.insert"
- ]
+ "reservations": {
+ "methods": {
+ "aggregatedList": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project"
+ ],
+ "description": "Retrieves an aggregated list of reservations.",
+ "flatPath": "projects/{project}/aggregated/reservations",
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "maxResults": {
+ "default": "500",
+ "type": "integer",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query",
+ "type": "boolean"
+ }
},
- "description": "The name of the resource, provided by the client when initially creating the resource. The resource 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.",
- "type": "string"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "shareSettings": {
- "description": "Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.",
- "$ref": "ShareSettings"
+ "response": {
+ "$ref": "ReservationAggregatedList"
+ },
+ "path": "projects/{project}/aggregated/reservations",
+ "id": "compute.reservations.aggregatedList"
},
- "zone": {
- "type": "string",
- "description": "Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment."
+ "insert": {
+ "description": "Creates a new reservation. For more information, read Reserving zonal resources.",
+ "path": "projects/{project}/zones/{zone}/reservations",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "zone": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ }
+ },
+ "flatPath": "projects/{project}/zones/{zone}/reservations",
+ "request": {
+ "$ref": "Reservation"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.reservations.insert",
+ "httpMethod": "POST"
},
- "resourcePolicies": {
- "description": "Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
+ "list": {
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "zone": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "maxResults": {
+ "type": "integer",
+ "minimum": "0",
+ "default": "500",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/reservations",
+ "httpMethod": "GET",
+ "id": "compute.reservations.list",
+ "flatPath": "projects/{project}/zones/{zone}/reservations",
+ "description": "A list of all the reservations that have been configured for the specified project in specified zone.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "ReservationList"
}
},
- "status": {
- "enumDescriptions": [
- "Resources are being allocated for the reservation.",
- "Reservation is currently being deleted.",
- "",
- "Reservation has allocated all its resources.",
- "Reservation is currently being resized."
+ "get": {
+ "description": "Retrieves information about the specified reservation.",
+ "id": "compute.reservations.get",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "reservation"
],
- "type": "string",
- "enum": [
- "CREATING",
- "DELETING",
- "INVALID",
- "READY",
- "UPDATING"
+ "path": "projects/{project}/zones/{zone}/reservations/{reservation}",
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}",
+ "response": {
+ "$ref": "Reservation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "[Output Only] The status of the reservation."
- },
- "specificReservation": {
- "$ref": "AllocationSpecificSKUReservation",
- "description": "Reservation for instances with specific machine shapes."
- }
- }
- },
- "NetworkEndpointGroupCloudFunction": {
- "description": "Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.",
- "properties": {
- "function": {
- "description": "A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: \"func1\".",
- "type": "string"
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "zone": {
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "Name of the zone for this request."
+ },
+ "reservation": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "description": "Name of the reservation to retrieve."
+ }
+ }
},
- "urlMask": {
- "description": "A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs \" mydomain.com/function1\" and \"mydomain.com/function2\" can be backed by the same Serverless NEG with URL mask \"/\u003cfunction\u003e\". The URL mask will parse them to { function = \"function1\" } and { function = \"function2\" } respectively.",
- "type": "string"
- }
- },
- "type": "object",
- "id": "NetworkEndpointGroupCloudFunction"
- },
- "TargetHttpsProxiesSetQuicOverrideRequest": {
- "type": "object",
- "id": "TargetHttpsProxiesSetQuicOverrideRequest",
- "properties": {
- "quicOverride": {
- "enum": [
- "DISABLE",
- "ENABLE",
- "NONE"
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "zone": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the zone for this request."
+ },
+ "reservation": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the reservation to delete.",
+ "required": true
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/reservations/{reservation}",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "reservation"
],
- "description": "QUIC policy for the TargetHttpsProxy resource.",
- "type": "string",
- "enumDescriptions": [
- "The load balancer will not attempt to negotiate QUIC with clients.",
- "The load balancer will attempt to negotiate QUIC with clients.",
- "No overrides to the default QUIC policy. This option is implicit if no QUIC override has been specified in the request."
+ "description": "Deletes the specified reservation.",
+ "httpMethod": "DELETE",
+ "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}",
+ "id": "compute.reservations.delete",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
- }
- }
- },
- "ResourcePolicy": {
- "type": "object",
- "properties": {
- "snapshotSchedulePolicy": {
- "description": "Resource policy for persistent disks for creating snapshots.",
- "$ref": "ResourcePolicySnapshotSchedulePolicy"
},
- "status": {
- "type": "string",
- "enum": [
- "CREATING",
- "DELETING",
- "EXPIRED",
- "INVALID",
- "READY"
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enumDescriptions": [
- "Resource policy is being created.",
- "Resource policy is being deleted.",
- "Resource policy is expired and will not run again.",
- "",
- "Resource policy is ready to be used."
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "zone": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "location": "path"
+ },
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
],
- "description": "[Output Only] The status of resource policy creation."
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions",
+ "path": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions",
+ "id": "compute.reservations.testIamPermissions",
+ "httpMethod": "POST"
},
- "groupPlacementPolicy": {
- "$ref": "ResourcePolicyGroupPlacementPolicy",
- "description": "Resource policy for instances for placement configuration."
+ "setIamPolicy": {
+ "id": "compute.reservations.setIamPolicy",
+ "parameters": {
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "resource": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request."
+ }
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "ZoneSetPolicyRequest"
+ },
+ "path": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy"
},
- "description": {
- "type": "string"
+ "resize": {
+ "parameters": {
+ "reservation": {
+ "required": true,
+ "description": "Name of the reservation to update.",
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true
+ },
+ "zone": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the zone for this request."
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/reservations/{reservation}/resize",
+ "request": {
+ "$ref": "ReservationsResizeRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "description": "Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.",
+ "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/resize",
+ "id": "compute.reservations.resize",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "reservation"
+ ]
},
- "instanceSchedulePolicy": {
- "$ref": "ResourcePolicyInstanceSchedulePolicy",
- "description": "Resource policy for scheduling instance operations."
+ "getIamPolicy": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "path": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy",
+ "httpMethod": "GET",
+ "id": "compute.reservations.getIamPolicy",
+ "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy",
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "zone": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "type": "string"
+ },
+ "resource": {
+ "type": "string",
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "optionsRequestedPolicyVersion": {
+ "description": "Requested IAM Policy version.",
+ "type": "integer",
+ "location": "query",
+ "format": "int32"
+ }
+ }
},
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "annotations": {
- "required": [
- "compute.instances.insert"
- ]
+ "update": {
+ "description": "Update share settings of the reservation.",
+ "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}",
+ "path": "projects/{project}/zones/{zone}/reservations/{reservation}",
+ "httpMethod": "PATCH",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "updateMask": {
+ "type": "string",
+ "description": "Update_mask indicates fields to be updated as part of this request.",
+ "location": "query",
+ "format": "google-fieldmask"
+ },
+ "zone": {
+ "required": true,
+ "location": "path",
+ "description": "Name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "paths": {
+ "location": "query",
+ "type": "string",
+ "repeated": true
+ },
+ "reservation": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Name of the reservation to update."
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
},
- "type": "string",
- "description": "The name of the resource, provided by the client when initially creating the resource. The resource 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."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- },
- "resourceStatus": {
- "$ref": "ResourcePolicyResourceStatus",
- "description": "[Output Only] The system status of the resource policy."
- },
- "region": {
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#resource_policies for resource policies.",
- "default": "compute#resourcePolicy",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined fully-qualified URL for this resource."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ "id": "compute.reservations.update",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "Reservation"
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "reservation"
+ ]
}
- },
- "id": "ResourcePolicy",
- "description": "Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots."
+ }
},
- "Rule": {
- "id": "Rule",
- "type": "object",
- "description": "This is deprecated and has no effect. Do not use.",
- "properties": {
- "description": {
- "type": "string",
- "description": "This is deprecated and has no effect. Do not use."
- },
- "action": {
- "type": "string",
- "description": "This is deprecated and has no effect. Do not use.",
- "enum": [
- "ALLOW",
- "ALLOW_WITH_LOG",
- "DENY",
- "DENY_WITH_LOG",
- "LOG",
- "NO_ACTION"
+ "interconnects": {
+ "methods": {
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use.",
- "This is deprecated and has no effect. Do not use."
- ]
- },
- "conditions": {
- "items": {
- "$ref": "Condition"
+ "parameterOrder": [
+ "project",
+ "interconnect"
+ ],
+ "id": "compute.interconnects.delete",
+ "description": "Deletes the specified Interconnect.",
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "interconnect": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the interconnect to delete."
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
},
- "description": "This is deprecated and has no effect. Do not use.",
- "type": "array"
- },
- "ins": {
- "items": {
- "type": "string"
+ "httpMethod": "DELETE",
+ "flatPath": "projects/{project}/global/interconnects/{interconnect}",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "This is deprecated and has no effect. Do not use."
+ "path": "projects/{project}/global/interconnects/{interconnect}"
},
- "logConfigs": {
- "type": "array",
- "items": {
- "$ref": "LogConfig"
+ "get": {
+ "flatPath": "projects/{project}/global/interconnects/{interconnect}",
+ "description": "Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.",
+ "parameterOrder": [
+ "project",
+ "interconnect"
+ ],
+ "path": "projects/{project}/global/interconnects/{interconnect}",
+ "id": "compute.interconnects.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "interconnect": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the interconnect to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
},
- "description": "This is deprecated and has no effect. Do not use."
- },
- "notIns": {
- "type": "array",
- "description": "This is deprecated and has no effect. Do not use.",
- "items": {
- "type": "string"
+ "response": {
+ "$ref": "Interconnect"
}
},
- "permissions": {
- "description": "This is deprecated and has no effect. Do not use.",
- "type": "array",
- "items": {
- "type": "string"
+ "insert": {
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "request": {
+ "$ref": "Interconnect"
+ },
+ "httpMethod": "POST",
+ "path": "projects/{project}/global/interconnects",
+ "flatPath": "projects/{project}/global/interconnects",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Creates an Interconnect in the specified project using the data included in the request.",
+ "id": "compute.interconnects.insert",
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "Operation"
}
- }
- }
- },
- "InterconnectDiagnosticsLinkOpticalPower": {
- "type": "object",
- "properties": {
- "value": {
- "description": "Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.",
- "type": "number",
- "format": "float"
},
- "state": {
- "type": "string",
- "enum": [
- "HIGH_ALARM",
- "HIGH_WARNING",
- "LOW_ALARM",
- "LOW_WARNING",
- "OK"
+ "list": {
+ "response": {
+ "$ref": "InterconnectList"
+ },
+ "path": "projects/{project}/global/interconnects",
+ "parameterOrder": [
+ "project"
],
- "description": "The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. ",
- "enumDescriptions": [
- "The value has crossed above the high alarm threshold.",
- "The value of the current optical power has crossed above the high warning threshold.",
- "The value of the current optical power has crossed below the low alarm threshold.",
- "The value of the current optical power has crossed below the low warning threshold.",
- "The value of the current optical power has not crossed a warning threshold."
- ]
- }
- },
- "id": "InterconnectDiagnosticsLinkOpticalPower"
- },
- "RegionTargetHttpsProxiesSetSslCertificatesRequest": {
- "type": "object",
- "id": "RegionTargetHttpsProxiesSetSslCertificatesRequest",
- "properties": {
- "sslCertificates": {
- "items": {
- "type": "string"
+ "description": "Retrieves the list of Interconnects available to the specified project.",
+ "flatPath": "projects/{project}/global/interconnects",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "location": "query",
+ "format": "uint32",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ }
},
- "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource.",
- "type": "array"
- }
- }
- },
- "ResourcePolicyInstanceSchedulePolicy": {
- "properties": {
- "startTime": {
- "type": "string",
- "description": "The start time of the schedule. The timestamp is an RFC3339 string."
- },
- "vmStopSchedule": {
- "$ref": "ResourcePolicyInstanceSchedulePolicySchedule",
- "description": "Specifies the schedule for stopping instances."
- },
- "vmStartSchedule": {
- "description": "Specifies the schedule for starting instances.",
- "$ref": "ResourcePolicyInstanceSchedulePolicySchedule"
- },
- "timeZone": {
- "type": "string",
- "description": "Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database."
- },
- "expirationTime": {
- "type": "string",
- "description": "The expiration time of the schedule. The timestamp is an RFC3339 string."
- }
- },
- "description": "An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance.",
- "id": "ResourcePolicyInstanceSchedulePolicy",
- "type": "object"
- },
- "Region": {
- "description": "Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones.",
- "type": "object",
- "id": "Region",
- "properties": {
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the resource."
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#region for regions.",
- "default": "compute#region",
- "type": "string"
+ "id": "compute.interconnects.list"
},
- "status": {
- "enumDescriptions": [
- "",
- ""
+ "setLabels": {
+ "flatPath": "projects/{project}/global/interconnects/{resource}/setLabels",
+ "description": "Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[Output Only] Status of the region, either UP or DOWN.",
- "type": "string",
- "enum": [
- "DOWN",
- "UP"
- ]
- },
- "description": {
- "type": "string",
- "description": "[Output Only] Textual description of the resource."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "quotas": {
- "description": "[Output Only] Quotas assigned to this region.",
- "type": "array",
- "items": {
- "$ref": "Quota"
- }
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "deprecated": {
- "description": "[Output Only] The deprecation status associated with this region.",
- "$ref": "DeprecationStatus"
- },
- "zones": {
- "description": "[Output Only] A list of zones available in this region, in the form of resource URLs.",
- "items": {
- "type": "string"
+ "path": "projects/{project}/global/interconnects/{resource}/setLabels",
+ "httpMethod": "POST",
+ "id": "compute.interconnects.setLabels",
+ "request": {
+ "$ref": "GlobalSetLabelsRequest"
},
- "type": "array"
- },
- "supportsPzs": {
- "description": "[Output Only] Reserved for future use.",
- "type": "boolean"
- }
- }
- },
- "BackendServiceLocalityLoadBalancingPolicyConfig": {
- "type": "object",
- "properties": {
- "customPolicy": {
- "$ref": "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy"
- },
- "policy": {
- "$ref": "BackendServiceLocalityLoadBalancingPolicyConfigPolicy"
- }
- },
- "id": "BackendServiceLocalityLoadBalancingPolicyConfig",
- "description": "Container for either a built-in LB policy supported by gRPC or Envoy or a custom one implemented by the end user."
- },
- "InstanceReference": {
- "properties": {
- "instance": {
- "type": "string",
- "description": "The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances"
- }
- },
- "id": "InstanceReference",
- "type": "object"
- },
- "InstancesSetMachineResourcesRequest": {
- "properties": {
- "guestAccelerators": {
- "type": "array",
- "description": "A list of the type and count of accelerator cards attached to the instance.",
- "items": {
- "$ref": "AcceleratorConfig"
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true
+ },
+ "resource": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "response": {
+ "$ref": "Operation"
}
- }
- },
- "id": "InstancesSetMachineResourcesRequest",
- "type": "object"
- },
- "RouterNatRule": {
- "id": "RouterNatRule",
- "type": "object",
- "properties": {
- "description": {
- "description": "An optional description of this rule.",
- "type": "string"
- },
- "ruleNumber": {
- "description": "An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.",
- "type": "integer",
- "format": "uint32"
- },
- "match": {
- "type": "string",
- "description": "CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: \"inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')\" \"destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'\" The following example is a valid match expression for private NAT: \"nexthop.hub == 'https://networkconnectivity.googleapis.com/v1alpha1/projects/my-project/global/hub/hub-1'\""
},
- "action": {
- "description": "The action to be enforced for traffic that matches this rule.",
- "$ref": "RouterNatRuleAction"
- }
- }
- },
- "ResourceStatus": {
- "type": "object",
- "id": "ResourceStatus",
- "description": "Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls.",
- "properties": {
- "physicalHost": {
- "description": "[Output Only] An opaque ID of the host on which the VM is running.",
- "type": "string"
- }
- }
- },
- "UrlMapReference": {
- "type": "object",
- "properties": {
- "urlMap": {
- "type": "string"
- }
- },
- "id": "UrlMapReference"
- },
- "ZoneSetLabelsRequest": {
- "type": "object",
- "properties": {
- "labels": {
- "description": "The labels to set for this resource.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "interconnect": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the interconnect to update."
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
+ },
+ "request": {
+ "$ref": "Interconnect"
+ },
+ "path": "projects/{project}/global/interconnects/{interconnect}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "interconnect"
+ ],
+ "description": "Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "flatPath": "projects/{project}/global/interconnects/{interconnect}",
+ "httpMethod": "PATCH",
+ "id": "compute.interconnects.patch"
},
- "labelFingerprint": {
- "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.",
- "format": "byte",
- "type": "string"
+ "getDiagnostics": {
+ "parameterOrder": [
+ "project",
+ "interconnect"
+ ],
+ "parameters": {
+ "interconnect": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true,
+ "description": "Name of the interconnect resource to query."
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/interconnects/{interconnect}/getDiagnostics",
+ "id": "compute.interconnects.getDiagnostics",
+ "description": "Returns the interconnectDiagnostics for the specified Interconnect.",
+ "response": {
+ "$ref": "InterconnectsGetDiagnosticsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/global/interconnects/{interconnect}/getDiagnostics",
+ "httpMethod": "GET"
}
- },
- "id": "ZoneSetLabelsRequest"
+ }
},
- "HttpsHealthCheckList": {
- "id": "HttpsHealthCheckList",
- "type": "object",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "targetPools": {
+ "methods": {
+ "removeHealthCheck": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetPool"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck",
+ "description": "Removes health check URL from a target pool.",
+ "id": "compute.targetPools.removeHealthCheck",
+ "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck",
+ "request": {
+ "$ref": "TargetPoolsRemoveHealthCheckRequest"
+ },
+ "parameters": {
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "targetPool": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the target pool to remove health checks from.",
+ "type": "string",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "region": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region for this request.",
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST"
},
- "warning": {
- "properties": {
- "message": {
+ "delete": {
+ "path": "projects/{project}/regions/{region}/targetPools/{targetPool}",
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
},
- "code": {
+ "targetPool": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Name of the TargetPool resource to delete.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetPool"
+ ],
+ "id": "compute.targetPools.delete",
+ "description": "Deletes the specified target pool."
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "setBackup": {
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "targetPool": {
+ "location": "path",
+ "description": "Name of the TargetPool resource to set a backup pool for.",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "failoverRatio": {
+ "type": "number",
+ "format": "float",
+ "description": "New failoverRatio value for the target pool.",
+ "location": "query"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "TargetReference"
+ },
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup",
+ "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetPool"
+ ],
+ "description": "Changes a backup target pool's configurations.",
+ "id": "compute.targetPools.setBackup"
},
- "kind": {
- "type": "string",
- "description": "Type of resource.",
- "default": "compute#httpsHealthCheckList"
+ "addHealthCheck": {
+ "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Adds health check URLs to a target pool.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.targetPools.addHealthCheck",
+ "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck",
+ "parameters": {
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request."
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "targetPool": {
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the target pool to add a health check to.",
+ "required": true
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetPool"
+ ],
+ "request": {
+ "$ref": "TargetPoolsAddHealthCheckRequest"
+ },
+ "httpMethod": "POST"
},
- "items": {
- "type": "array",
- "description": "A list of HttpsHealthCheck resources.",
- "items": {
- "$ref": "HttpsHealthCheck"
+ "get": {
+ "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/regions/{region}/targetPools/{targetPool}",
+ "response": {
+ "$ref": "TargetPool"
+ },
+ "description": "Returns the specified target pool. Gets a list of available target pools by making a list() request.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetPool"
+ ],
+ "id": "compute.targetPools.get",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "region": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request."
+ },
+ "targetPool": {
+ "type": "string",
+ "location": "path",
+ "description": "Name of the TargetPool resource to return.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
}
- }
- },
- "description": "Contains a list of HttpsHealthCheck resources."
- },
- "InstanceGroupManagersDeleteInstancesRequest": {
- "type": "object",
- "id": "InstanceGroupManagersDeleteInstancesRequest",
- "properties": {
- "skipInstancesOnValidationError": {
- "description": "Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.",
- "type": "boolean"
},
- "instances": {
- "items": {
- "type": "string"
+ "removeInstance": {
+ "parameters": {
+ "targetPool": {
+ "location": "path",
+ "type": "string",
+ "description": "Name of the TargetPool resource to remove instances from.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "type": "string"
+ }
},
- "description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
- "type": "array"
- }
- }
- },
- "GlobalOrganizationSetPolicyRequest": {
- "properties": {
- "bindings": {
- "items": {
- "$ref": "Binding"
+ "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance",
+ "response": {
+ "$ref": "Operation"
},
- "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.",
- "type": "array"
- },
- "etag": {
- "format": "byte",
- "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
- "type": "string"
+ "request": {
+ "$ref": "TargetPoolsRemoveInstanceRequest"
+ },
+ "id": "compute.targetPools.removeInstance",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Removes instance URL from a target pool.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetPool"
+ ],
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance"
},
- "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 in general a valid policy but certain services (like Projects) might reject them.",
- "$ref": "Policy"
- }
- },
- "id": "GlobalOrganizationSetPolicyRequest",
- "type": "object"
- },
- "StatefulPolicyPreservedState": {
- "properties": {
- "disks": {
- "description": "Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.",
- "additionalProperties": {
- "$ref": "StatefulPolicyPreservedStateDiskDevice"
+ "addInstance": {
+ "description": "Adds an instance to a target pool.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetPool"
+ ],
+ "parameters": {
+ "project": {
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "targetPool": {
+ "required": true,
+ "type": "string",
+ "description": "Name of the TargetPool resource to add instances to.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
+ },
+ "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance",
+ "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance",
+ "id": "compute.targetPools.addInstance",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
},
- "type": "object"
- }
- },
- "description": "Configuration of preserved resources.",
- "id": "StatefulPolicyPreservedState",
- "type": "object"
- },
- "NodeGroupsListNodes": {
- "properties": {
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "request": {
+ "$ref": "TargetPoolsAddInstanceRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "items": {
- "description": "A list of Node resources.",
- "type": "array",
- "items": {
- "$ref": "NodeGroupNode"
+ "aggregatedList": {
+ "httpMethod": "GET",
+ "id": "compute.targetPools.aggregatedList",
+ "parameterOrder": [
+ "project"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/aggregated/targetPools",
+ "description": "Retrieves an aggregated list of target pools.",
+ "path": "projects/{project}/aggregated/targetPools",
+ "response": {
+ "$ref": "TargetPoolAggregatedList"
+ },
+ "parameters": {
+ "maxResults": {
+ "type": "integer",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "format": "uint32",
+ "minimum": "0"
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ }
}
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "warning": {
- "type": "object",
- "properties": {
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "insert": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "TargetPool"
+ },
+ "flatPath": "projects/{project}/regions/{region}/targetPools",
+ "parameters": {
+ "region": {
+ "required": true,
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "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).",
+ "location": "query",
"type": "string"
}
},
- "description": "[Output Only] Informational warning message."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group.",
- "default": "compute#nodeGroupsListNodes"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- }
- },
- "id": "NodeGroupsListNodes",
- "type": "object"
- },
- "RegionInstanceGroupsListInstances": {
- "id": "RegionInstanceGroupsListInstances",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "kind": {
- "description": "The resource type.",
- "type": "string",
- "default": "compute#regionInstanceGroupsListInstances"
+ "description": "Creates a target pool in the specified project and region using the data included in the request.",
+ "path": "projects/{project}/regions/{region}/targetPools",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "id": "compute.targetPools.insert"
},
- "warning": {
- "type": "object",
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- }
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "TargetPoolList"
+ },
+ "httpMethod": "GET",
+ "description": "Retrieves a list of target pools available to the specified project and region.",
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
"type": "string"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
"type": "string"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "location": "query",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "format": "uint32"
}
},
- "description": "[Output Only] Informational warning message."
+ "id": "compute.targetPools.list",
+ "path": "projects/{project}/regions/{region}/targetPools",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/targetPools"
},
- "items": {
- "description": "A list of InstanceWithNamedPorts resources.",
- "type": "array",
- "items": {
- "$ref": "InstanceWithNamedPorts"
+ "getHealth": {
+ "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth",
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth",
+ "id": "compute.targetPools.getHealth",
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetPool"
+ ],
+ "request": {
+ "$ref": "InstanceReference"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.",
+ "response": {
+ "$ref": "TargetPoolInstanceHealth"
+ },
+ "parameters": {
+ "region": {
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "required": true
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "targetPool": {
+ "location": "path",
+ "description": "Name of the TargetPool resource to which the queried instance belongs.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ }
}
}
- },
- "type": "object"
+ }
},
- "CacheKeyPolicy": {
- "id": "CacheKeyPolicy",
- "description": "Message containing what to include in the cache key for a request for Cloud CDN.",
- "properties": {
- "includeHttpHeaders": {
- "description": "Allows HTTP request headers (by name) to be used in the cache key.",
- "type": "array",
- "items": {
- "type": "string"
+ "regionUrlMaps": {
+ "methods": {
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Deletes the specified UrlMap resource.",
+ "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "urlMap"
+ ],
+ "id": "compute.regionUrlMaps.delete",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "urlMap": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the UrlMap resource to delete.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency."
+ },
+ "region": {
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "Name of the region scoping this request."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request."
+ }
+ }
+ },
+ "patch": {
+ "description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
+ "request": {
+ "$ref": "UrlMap"
+ },
+ "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
+ "id": "compute.regionUrlMaps.patch",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "project",
+ "region",
+ "urlMap"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "urlMap": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "description": "Name of the UrlMap resource to patch.",
+ "required": true
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region scoping this request."
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency."
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
}
},
- "includeQueryString": {
- "description": "If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.",
- "type": "boolean"
- },
- "queryStringWhitelist": {
- "type": "array",
- "items": {
- "type": "string"
+ "insert": {
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path"
+ },
+ "requestId": {
+ "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ }
},
- "description": "Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters."
- },
- "queryStringBlacklist": {
- "description": "Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "includeProtocol": {
- "description": "If true, http and https requests will be cached separately.",
- "type": "boolean"
- },
- "includeHost": {
- "type": "boolean",
- "description": "If true, requests to different hosts will be cached separately."
- },
- "includeNamedCookies": {
- "items": {
- "type": "string"
+ "request": {
+ "$ref": "UrlMap"
},
- "type": "array",
- "description": "Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates."
- }
- },
- "type": "object"
- },
- "PacketMirroringNetworkInfo": {
- "id": "PacketMirroringNetworkInfo",
- "properties": {
- "url": {
- "description": "URL of the network resource.",
- "type": "string"
- },
- "canonicalUrl": {
- "description": "[Output Only] Unique identifier for the network; defined by the server.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PublicDelegatedPrefixPublicDelegatedSubPrefix": {
- "description": "Represents a sub PublicDelegatedPrefix.",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the sub public delegated prefix."
- },
- "delegateeProject": {
- "description": "Name of the project scoping this PublicDelegatedSubPrefix.",
- "type": "string"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "region": {
- "description": "[Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.",
- "type": "string"
- },
- "isAddress": {
- "description": "Whether the sub prefix is delegated to create Address resources in the delegatee project.",
- "type": "boolean"
- },
- "status": {
- "enum": [
- "ACTIVE",
- "INACTIVE"
+ "id": "compute.regionUrlMaps.insert",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "enumDescriptions": [
- "",
- ""
+ "path": "projects/{project}/regions/{region}/urlMaps",
+ "description": "Creates a UrlMap resource in the specified project using the data included in the request.",
+ "flatPath": "projects/{project}/regions/{region}/urlMaps",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "description": "[Output Only] The status of the sub public delegated prefix."
- },
- "ipCidrRange": {
- "description": "The IPv4 address range, in CIDR format, represented by this sub public delegated prefix.",
- "type": "string"
- }
- },
- "id": "PublicDelegatedPrefixPublicDelegatedSubPrefix"
- },
- "InstancesAddResourcePoliciesRequest": {
- "properties": {
- "resourcePolicies": {
- "type": "array",
- "description": "Resource policies to be added to this instance.",
- "items": {
- "type": "string"
+ "response": {
+ "$ref": "Operation"
}
- }
- },
- "id": "InstancesAddResourcePoliciesRequest",
- "type": "object"
- },
- "UsableSubnetwork": {
- "properties": {
- "subnetwork": {
- "type": "string",
- "description": "Subnetwork URL."
},
- "stackType": {
- "enumDescriptions": [
- "New VMs in this subnet can have both IPv4 and IPv6 addresses.",
- "New VMs in this subnet will only be assigned IPv4 addresses."
+ "get": {
+ "response": {
+ "$ref": "UrlMap"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "urlMap"
],
- "type": "string",
- "description": "The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.",
- "enum": [
- "IPV4_IPV6",
- "IPV4_ONLY"
+ "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
+ "id": "compute.regionUrlMaps.get",
+ "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
+ "description": "Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.",
+ "httpMethod": "GET",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Name of the region scoping this request."
+ },
+ "urlMap": {
+ "description": "Name of the UrlMap resource to return.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
]
},
- "ipCidrRange": {
- "description": "The range of internal addresses that are owned by this subnetwork.",
- "type": "string"
- },
- "role": {
- "enum": [
- "ACTIVE",
- "BACKUP"
+ "validate": {
+ "response": {
+ "$ref": "UrlMapsValidateResponse"
+ },
+ "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "The ACTIVE subnet that is currently used.",
- "The BACKUP subnet that could be promoted to ACTIVE."
+ "parameters": {
+ "urlMap": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the UrlMap resource to be validated as.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "urlMap"
],
- "description": "The role of subnetwork. Currently, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.",
- "type": "string"
- },
- "internalIpv6Prefix": {
- "type": "string",
- "description": "[Output Only] The internal IPv6 address range that is assigned to this subnetwork."
- },
- "network": {
- "type": "string",
- "description": "Network URL."
+ "description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.",
+ "request": {
+ "$ref": "RegionUrlMapsValidateRequest"
+ },
+ "id": "compute.regionUrlMaps.validate",
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate"
},
- "ipv6AccessType": {
- "type": "string",
- "enum": [
- "EXTERNAL",
- "INTERNAL"
- ],
- "enumDescriptions": [
- "VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.",
- "VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network."
+ "update": {
+ "description": "Updates the specified UrlMap resource with the data included in the request.",
+ "id": "compute.regionUrlMaps.update",
+ "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "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."
+ "httpMethod": "PUT",
+ "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
+ "request": {
+ "$ref": "UrlMap"
+ },
+ "parameters": {
+ "urlMap": {
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the UrlMap resource to update."
+ },
+ "region": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "urlMap"
+ ]
},
- "purpose": {
- "enumDescriptions": [
- "Subnet reserved for Internal HTTP(S) Load Balancing.",
- "Regular user created or automatically created subnet.",
- "Regular user created or automatically created subnet.",
- "Subnetworks created for Private Service Connect in the producer network.",
- "Subnetwork used for Regional Internal/External HTTP(S) Load Balancing."
+ "list": {
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "INTERNAL_HTTPS_LOAD_BALANCER",
- "PRIVATE",
- "PRIVATE_RFC_1918",
- "PRIVATE_SERVICE_CONNECT",
- "REGIONAL_MANAGED_PROXY"
+ "path": "projects/{project}/regions/{region}/urlMaps",
+ "flatPath": "projects/{project}/regions/{region}/urlMaps",
+ "response": {
+ "$ref": "UrlMapList"
+ },
+ "id": "compute.regionUrlMaps.list",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "type": "string",
- "description": "The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER."
- },
- "externalIpv6Prefix": {
- "type": "string",
- "description": "[Output Only] The external IPv6 address range that is assigned to this subnetwork."
- },
- "secondaryIpRanges": {
- "description": "Secondary IP ranges.",
- "type": "array",
- "items": {
- "$ref": "UsableSubnetworkSecondaryRange"
- }
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "maxResults": {
+ "location": "query",
+ "format": "uint32",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "minimum": "0"
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
+ }
+ },
+ "description": "Retrieves the list of UrlMap resources available to the specified project in the specified region."
}
- },
- "type": "object",
- "description": "Subnetwork which the current user has compute.subnetworks.use permission on.",
- "id": "UsableSubnetwork"
+ }
},
- "RouterStatus": {
- "type": "object",
- "id": "RouterStatus",
- "properties": {
- "bgpPeerStatus": {
- "items": {
- "$ref": "RouterStatusBgpPeerStatus"
+ "targetGrpcProxies": {
+ "methods": {
+ "patch": {
+ "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
+ "httpMethod": "PATCH",
+ "id": "compute.targetGrpcProxies.patch",
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "targetGrpcProxy": {
+ "location": "path",
+ "description": "Name of the TargetGrpcProxy resource to patch.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ }
},
- "type": "array"
- },
- "bestRoutes": {
- "type": "array",
- "items": {
- "$ref": "Route"
+ "response": {
+ "$ref": "Operation"
},
- "description": "Best routes for this router's network."
- },
- "network": {
- "description": "URI of the network to which this router belongs.",
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "targetGrpcProxy"
+ ],
+ "request": {
+ "$ref": "TargetGrpcProxy"
+ },
+ "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
+ "description": "Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "bestRoutesForRouter": {
- "type": "array",
- "description": "Best routes learned by this router.",
- "items": {
- "$ref": "Route"
+ "get": {
+ "parameters": {
+ "targetGrpcProxy": {
+ "type": "string",
+ "location": "path",
+ "description": "Name of the TargetGrpcProxy resource to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ }
+ },
+ "id": "compute.targetGrpcProxies.get",
+ "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Returns the specified TargetGrpcProxy resource in the given scope.",
+ "parameterOrder": [
+ "project",
+ "targetGrpcProxy"
+ ],
+ "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
+ "response": {
+ "$ref": "TargetGrpcProxy"
}
},
- "natStatus": {
- "items": {
- "$ref": "RouterStatusNatStatus"
+ "delete": {
+ "parameterOrder": [
+ "project",
+ "targetGrpcProxy"
+ ],
+ "id": "compute.targetGrpcProxies.delete",
+ "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
+ "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
+ "description": "Deletes the specified TargetGrpcProxy in the given scope",
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- }
- }
- },
- "ShareSettings": {
- "description": "The share setting for reservations and sole tenancy node groups.",
- "properties": {
- "projectMap": {
- "description": "A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.",
- "type": "object",
- "additionalProperties": {
- "$ref": "ShareSettingsProjectConfig"
+ "parameters": {
+ "project": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "targetGrpcProxy": {
+ "required": true,
+ "location": "path",
+ "description": "Name of the TargetGrpcProxy resource to delete.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
}
},
- "shareType": {
- "enumDescriptions": [
- "Default value.",
- "Shared-reservation is open to entire Organization",
- "Default value. This value is unused.",
- "Shared-reservation is open to specific projects"
+ "insert": {
+ "description": "Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.",
+ "request": {
+ "$ref": "TargetGrpcProxy"
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Type of sharing for this shared-reservation",
- "enum": [
- "LOCAL",
- "ORGANIZATION",
- "SHARE_TYPE_UNSPECIFIED",
- "SPECIFIC_PROJECTS"
+ "id": "compute.targetGrpcProxies.insert",
+ "parameterOrder": [
+ "project"
],
- "type": "string"
- }
- },
- "id": "ShareSettings",
- "type": "object"
- },
- "FirewallPolicyRuleSecureTag": {
- "type": "object",
- "properties": {
- "name": {
- "pattern": "tagValues/[0-9]+",
- "type": "string",
- "description": "Name of the secure tag, created with TagManager's TagValue API."
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "path": "projects/{project}/global/targetGrpcProxies",
+ "flatPath": "projects/{project}/global/targetGrpcProxies",
+ "response": {
+ "$ref": "Operation"
+ }
},
- "state": {
- "enumDescriptions": [
- "",
- ""
- ],
- "description": "[Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.",
- "enum": [
- "EFFECTIVE",
- "INEFFECTIVE"
+ "list": {
+ "flatPath": "projects/{project}/global/targetGrpcProxies",
+ "path": "projects/{project}/global/targetGrpcProxies",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "TargetGrpcProxyList"
+ },
+ "id": "compute.targetGrpcProxies.list",
+ "description": "Lists the TargetGrpcProxies for a project in the given scope.",
+ "parameters": {
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "default": "500",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "minimum": "0"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "project"
],
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
- },
- "id": "FirewallPolicyRuleSecureTag"
+ }
},
- "TargetSslProxiesSetBackendServiceRequest": {
- "properties": {
- "service": {
- "description": "The URL of the new BackendService resource for the targetSslProxy.",
- "type": "string"
+ "regionInstances": {
+ "methods": {
+ "bulkInsert": {
+ "parameters": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "The name of the region for this request."
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Creates multiple instances in a given region. Count specifies the number of instances to create.",
+ "path": "projects/{project}/regions/{region}/instances/bulkInsert",
+ "id": "compute.regionInstances.bulkInsert",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "BulkInsertInstanceResource"
+ },
+ "flatPath": "projects/{project}/regions/{region}/instances/bulkInsert",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region"
+ ]
}
- },
- "type": "object",
- "id": "TargetSslProxiesSetBackendServiceRequest"
+ }
},
- "NetworkRoutingConfig": {
- "type": "object",
- "description": "A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide.",
- "properties": {
- "routingMode": {
- "enumDescriptions": [
- "",
- ""
+ "diskTypes": {
+ "methods": {
+ "get": {
+ "description": "Returns the specified disk type. Gets a list of available disk types by making a list() request.",
+ "path": "projects/{project}/zones/{zone}/diskTypes/{diskType}",
+ "response": {
+ "$ref": "DiskType"
+ },
+ "flatPath": "projects/{project}/zones/{zone}/diskTypes/{diskType}",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "zone": {
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "required": true
+ },
+ "diskType": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the disk type to return.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "diskType"
],
- "enum": [
- "GLOBAL",
- "REGIONAL"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "description": "The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions."
- }
- },
- "id": "NetworkRoutingConfig"
- },
- "SecurityPolicyRecaptchaOptionsConfig": {
- "properties": {
- "redirectSiteKey": {
- "description": "An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used.",
- "type": "string"
- }
- },
- "type": "object",
- "id": "SecurityPolicyRecaptchaOptionsConfig"
- },
- "DiskList": {
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "items": {
- "type": "array",
- "description": "A list of Disk resources.",
- "items": {
- "$ref": "Disk"
- }
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
+ "httpMethod": "GET",
+ "id": "compute.diskTypes.get"
},
- "warning": {
- "properties": {
- "message": {
+ "aggregatedList": {
+ "path": "projects/{project}/aggregated/diskTypes",
+ "id": "compute.diskTypes.aggregatedList",
+ "flatPath": "projects/{project}/aggregated/diskTypes",
+ "parameters": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "query"
},
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
},
- "code": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "minimum": "0",
+ "location": "query",
+ "default": "500"
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
+ "description": "Retrieves an aggregated list of disk types.",
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "DiskTypeAggregatedList"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "kind": {
- "type": "string",
- "default": "compute#diskList",
- "description": "[Output Only] Type of resource. Always compute#diskList for lists of disks."
- }
- },
- "type": "object",
- "description": "A list of Disk resources.",
- "id": "DiskList"
- },
- "ResourcePolicyList": {
- "properties": {
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
- },
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "list": {
+ "path": "projects/{project}/zones/{zone}/diskTypes",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "description": "Retrieves a list of disk types available to the specified project.",
+ "response": {
+ "$ref": "DiskTypeList"
+ },
+ "parameters": {
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "minimum": "0",
+ "default": "500",
+ "location": "query",
+ "format": "uint32"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
"type": "string"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "zone": {
+ "required": true,
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
"type": "string"
}
- }
- },
- "kind": {
- "description": "[Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies",
- "default": "compute#resourcePolicyList",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "items": {
- "description": "[Output Only] A list of ResourcePolicy resources.",
- "type": "array",
- "items": {
- "$ref": "ResourcePolicy"
- }
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "etag": {
- "type": "string"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- }
- },
- "id": "ResourcePolicyList",
- "type": "object"
- },
- "NodeGroupsDeleteNodesRequest": {
- "id": "NodeGroupsDeleteNodesRequest",
- "type": "object",
- "properties": {
- "nodes": {
- "description": "Names of the nodes to delete.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ },
+ "id": "compute.diskTypes.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/zones/{zone}/diskTypes"
}
}
},
- "CorsPolicy": {
- "type": "object",
- "properties": {
- "allowHeaders": {
- "type": "array",
- "description": "Specifies the content for the Access-Control-Allow-Headers header.",
- "items": {
- "type": "string"
- }
- },
- "allowOriginRegexes": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED."
- },
- "allowCredentials": {
- "description": "In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false.",
- "type": "boolean"
- },
- "exposeHeaders": {
- "description": "Specifies the content for the Access-Control-Expose-Headers header.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "allowOrigins": {
- "items": {
- "type": "string"
+ "instanceTemplates": {
+ "methods": {
+ "insert": {
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.",
+ "id": "compute.instanceTemplates.insert",
+ "path": "projects/{project}/global/instanceTemplates",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes."
- },
- "allowMethods": {
- "description": "Specifies the content for the Access-Control-Allow-Methods header.",
- "items": {
- "type": "string"
+ "request": {
+ "$ref": "InstanceTemplate"
},
- "type": "array"
- },
- "disabled": {
- "type": "boolean",
- "description": "If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect."
- },
- "maxAge": {
- "type": "integer",
- "format": "int32",
- "description": "Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header."
- }
- },
- "id": "CorsPolicy",
- "description": "The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard."
- },
- "XpnHostList": {
- "properties": {
- "warning": {
- "properties": {
- "message": {
+ "flatPath": "projects/{project}/global/instanceTemplates",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Project ID for this request."
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "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).",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
- },
- "data": {
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "location": "query"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
+ "parameterOrder": [
+ "project"
+ ]
},
- "items": {
- "type": "array",
- "items": {
- "$ref": "Project"
+ "delete": {
+ "response": {
+ "$ref": "Operation"
},
- "description": "[Output Only] A list of shared VPC host project URLs."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "kind": {
- "type": "string",
- "default": "compute#xpnHostList",
- "description": "[Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts."
- }
- },
- "type": "object",
- "id": "XpnHostList"
- },
- "RegionInstanceGroupManagersApplyUpdatesRequest": {
- "type": "object",
- "description": "RegionInstanceGroupManagers.applyUpdatesToInstances",
- "properties": {
- "instances": {
- "type": "array",
- "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
- "items": {
- "type": "string"
- }
- },
- "mostDisruptiveAllowedAction": {
- "enumDescriptions": [
- "Do not perform any action.",
- "Updates applied in runtime, instances will not be disrupted.",
- "Old instances will be deleted. New instances will be created from the target template.",
- "Every instance will be restarted."
- ],
- "description": "The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.",
- "enum": [
- "NONE",
- "REFRESH",
- "REPLACE",
- "RESTART"
- ],
- "type": "string"
- },
- "allInstances": {
- "type": "boolean",
- "description": "Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request."
- },
- "minimalAction": {
- "enum": [
- "NONE",
- "REFRESH",
- "REPLACE",
- "RESTART"
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "instanceTemplate": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "The name of the instance template to delete.",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.",
- "enumDescriptions": [
- "Do not perform any action.",
- "Updates applied in runtime, instances will not be disrupted.",
- "Old instances will be deleted. New instances will be created from the target template.",
- "Every instance will be restarted."
+ "parameterOrder": [
+ "project",
+ "instanceTemplate"
],
- "type": "string"
- }
- },
- "id": "RegionInstanceGroupManagersApplyUpdatesRequest"
- },
- "SecurityPolicyRuleMatcherConfig": {
- "properties": {
- "srcIpRanges": {
- "type": "array",
- "description": "CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.",
- "items": {
- "type": "string"
- }
- }
- },
- "type": "object",
- "id": "SecurityPolicyRuleMatcherConfig"
- },
- "InstanceGroupManagersDeletePerInstanceConfigsReq": {
- "type": "object",
- "properties": {
- "names": {
- "description": "The list of instance names for which we want to delete per-instance configs on this managed instance group.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "InstanceGroupManagersDeletePerInstanceConfigsReq",
- "description": "InstanceGroupManagers.deletePerInstanceConfigs"
- },
- "AcceleratorType": {
- "properties": {
- "kind": {
- "type": "string",
- "default": "compute#acceleratorType",
- "description": "[Output Only] The type of the resource. Always compute#acceleratorType for accelerator types."
- },
- "maximumCardsPerInstance": {
- "description": "[Output Only] Maximum number of accelerator cards allowed per instance.",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined, fully qualified URL for this resource.",
- "type": "string"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "deprecated": {
- "$ref": "DeprecationStatus",
- "description": "[Output Only] The deprecation status associated with this accelerator type."
- },
- "description": {
- "description": "[Output Only] An optional textual description of the resource.",
- "type": "string"
- },
- "name": {
- "description": "[Output Only] Name of the resource.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "zone": {
- "description": "[Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. 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"
- }
- },
- "type": "object",
- "description": "Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine.",
- "id": "AcceleratorType"
- },
- "SslPoliciesList": {
- "id": "SslPoliciesList",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "id": "compute.instanceTemplates.delete",
+ "flatPath": "projects/{project}/global/instanceTemplates/{instanceTemplate}",
+ "description": "Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.",
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}"
+ },
+ "list": {
+ "description": "Retrieves a list of instance templates that are contained within the specified project.",
+ "httpMethod": "GET",
+ "path": "projects/{project}/global/instanceTemplates",
+ "flatPath": "projects/{project}/global/instanceTemplates",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "maxResults": {
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "minimum": "0",
+ "default": "500",
+ "type": "integer"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"type": "string"
},
- "message": {
+ "filter": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
}
},
- "type": "object"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.",
- "type": "string",
- "default": "compute#sslPoliciesList"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
+ "id": "compute.instanceTemplates.list",
+ "response": {
+ "$ref": "InstanceTemplateList"
+ }
},
- "items": {
- "items": {
- "$ref": "SslPolicy"
+ "setIamPolicy": {
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
},
- "type": "array",
- "description": "A list of SslPolicy resources."
- }
- },
- "type": "object"
- },
- "SavedDisk": {
- "description": "An instance-attached disk resource.",
- "id": "SavedDisk",
- "type": "object",
- "properties": {
- "sourceDisk": {
- "description": "Specifies a URL of the disk attached to the source instance.",
- "type": "string"
+ "path": "projects/{project}/global/instanceTemplates/{resource}/setIamPolicy",
+ "request": {
+ "$ref": "GlobalSetPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "httpMethod": "POST",
+ "id": "compute.instanceTemplates.setIamPolicy",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "resource": {
+ "type": "string",
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ }
+ },
+ "flatPath": "projects/{project}/global/instanceTemplates/{resource}/setIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "architecture": {
- "enum": [
- "ARCHITECTURE_UNSPECIFIED",
- "ARM64",
- "X86_64"
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enumDescriptions": [
- "Default value indicating Architecture is not set.",
- "Machines with architecture ARM64",
- "Machines with architecture X86_64"
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "flatPath": "projects/{project}/global/instanceTemplates/{resource}/testIamPermissions",
+ "id": "compute.instanceTemplates.testIamPermissions",
+ "parameters": {
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
],
- "description": "[Output Only] The architecture of the attached disk.",
- "type": "string"
- },
- "kind": {
- "default": "compute#savedDisk",
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#savedDisk for attached disks."
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "path": "projects/{project}/global/instanceTemplates/{resource}/testIamPermissions"
},
- "storageBytes": {
- "description": "[Output Only] Size of the individual disk snapshot used by this machine image.",
- "type": "string",
- "format": "int64"
+ "get": {
+ "response": {
+ "$ref": "InstanceTemplate"
+ },
+ "parameterOrder": [
+ "project",
+ "instanceTemplate"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "id": "compute.instanceTemplates.get",
+ "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}",
+ "parameters": {
+ "instanceTemplate": {
+ "description": "The name of the instance template.",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ }
+ },
+ "description": "Returns the specified instance template. Gets a list of available instance templates by making a list() request.",
+ "flatPath": "projects/{project}/global/instanceTemplates/{instanceTemplate}"
},
- "storageBytesStatus": {
- "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.",
- "enum": [
- "UPDATING",
- "UP_TO_DATE"
+ "getIamPolicy": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "enumDescriptions": [
- "",
- ""
- ]
+ "flatPath": "projects/{project}/global/instanceTemplates/{resource}/getIamPolicy",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
+ },
+ "id": "compute.instanceTemplates.getIamPolicy",
+ "parameters": {
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "optionsRequestedPolicyVersion": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested IAM Policy version.",
+ "type": "integer"
+ }
+ },
+ "path": "projects/{project}/global/instanceTemplates/{resource}/getIamPolicy",
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists."
}
}
},
- "RouterList": {
- "id": "RouterList",
- "type": "object",
- "properties": {
- "warning": {
- "type": "object",
- "properties": {
- "code": {
+ "regionTargetTcpProxies": {
+ "methods": {
+ "insert": {
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/targetTcpProxies",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "path": "projects/{project}/regions/{region}/targetTcpProxies",
+ "id": "compute.regionTargetTcpProxies.insert",
+ "request": {
+ "$ref": "TargetTcpProxy"
+ },
+ "parameters": {
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "location": "path",
+ "required": true
},
- "data": {
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "requestId": {
+ "location": "query",
+ "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).",
"type": "string"
}
- },
- "description": "[Output Only] Informational warning message."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#router for routers.",
- "default": "compute#routerList",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "items": {
- "type": "array",
- "description": "A list of Router resources.",
- "items": {
- "$ref": "Router"
}
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- }
- },
- "description": "Contains a list of Router resources."
- },
- "PublicDelegatedPrefixAggregatedList": {
- "id": "PublicDelegatedPrefixAggregatedList",
- "properties": {
- "unreachables": {
- "type": "array",
- "items": {
- "type": "string"
+ "list": {
+ "response": {
+ "$ref": "TargetTcpProxyList"
},
- "description": "[Output Only] Unreachable resources."
- },
- "warning": {
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "maxResults": {
+ "format": "uint32",
+ "minimum": "0",
+ "type": "integer",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
},
- "message": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Name of the region scoping this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefixAggregatedList for aggregated lists of public delegated prefixes.",
- "default": "compute#publicDelegatedPrefixAggregatedList"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "items": {
- "additionalProperties": {
- "description": "[Output Only] Name of the scope containing this set of PublicDelegatedPrefixes.",
- "$ref": "PublicDelegatedPrefixesScopedList"
- },
- "description": "A list of PublicDelegatedPrefixesScopedList resources.",
- "type": "object"
- }
- },
- "type": "object"
- },
- "Network": {
- "description": "Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.",
- "annotations": {
- "required": [
- "compute.networks.insert"
- ]
- },
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ "httpMethod": "GET",
+ "path": "projects/{project}/regions/{region}/targetTcpProxies",
+ "flatPath": "projects/{project}/regions/{region}/targetTcpProxies",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "id": "compute.regionTargetTcpProxies.list",
+ "description": "Retrieves a list of TargetTcpProxy resources available to the specified project in a given region."
},
- "subnetworks": {
- "type": "array",
- "items": {
- "type": "string"
+ "get": {
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetTcpProxy"
+ ],
+ "response": {
+ "$ref": "TargetTcpProxy"
},
- "description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network."
- },
- "gatewayIPv4": {
- "description": "[Output Only] The gateway address for default routing out of the network, selected by GCP.",
- "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}",
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#network for networks.",
- "type": "string",
- "default": "compute#network"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this field when you create the resource."
- },
- "internalIpv6Range": {
- "description": "When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .",
- "type": "string"
- },
- "IPv4Range": {
- "type": "string",
- "description": "Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.",
- "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}"
- },
- "mtu": {
- "format": "int32",
- "description": "Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.",
- "type": "integer"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "routingConfig": {
- "description": "The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.",
- "$ref": "NetworkRoutingConfig"
- },
- "peerings": {
- "description": "[Output Only] A list of network peerings for the resource.",
- "items": {
- "$ref": "NetworkPeering"
+ "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}",
+ "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "id": "compute.regionTargetTcpProxies.get",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request.",
+ "type": "string"
+ },
+ "targetTcpProxy": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name of the TargetTcpProxy resource to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ }
},
- "type": "array"
- },
- "firewallPolicy": {
- "type": "string",
- "description": "[Output Only] URL of the firewall policy the network is associated with."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "enableUlaInternalIpv6": {
- "type": "boolean",
- "description": "Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. ."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string",
- "format": "uint64"
+ "description": "Returns the specified TargetTcpProxy resource."
},
- "networkFirewallPolicyEnforcementOrder": {
- "enumDescriptions": [
- "",
- ""
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "description": "The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.",
- "enum": [
- "AFTER_CLASSIC_FIREWALL",
- "BEFORE_CLASSIC_FIREWALL"
- ]
- },
- "selfLinkWithId": {
- "description": "[Output Only] Server-defined URL for this resource with the resource id.",
- "type": "string"
- },
- "autoCreateSubnetworks": {
- "description": "Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.",
- "type": "boolean"
- }
- },
- "id": "Network"
- },
- "PublicAdvertisedPrefixPublicDelegatedPrefix": {
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the public delegated prefix"
- },
- "region": {
- "description": "The region of the public delegated prefix if it is regional. If absent, the prefix is global.",
- "type": "string"
- },
- "project": {
- "type": "string",
- "description": "The project number of the public delegated prefix"
- },
- "status": {
- "description": "The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.",
- "type": "string"
- },
- "ipRange": {
- "description": "The IP address range of the public delegated prefix",
- "type": "string"
- }
- },
- "type": "object",
- "id": "PublicAdvertisedPrefixPublicDelegatedPrefix",
- "description": "Represents a CIDR range which can be used to assign addresses."
- },
- "TargetHttpsProxiesScopedList": {
- "id": "TargetHttpsProxiesScopedList",
- "type": "object",
- "properties": {
- "targetHttpsProxies": {
- "items": {
- "$ref": "TargetHttpsProxy"
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetTcpProxy"
+ ],
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified TargetTcpProxy resource.",
+ "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}",
+ "response": {
+ "$ref": "Operation"
},
- "description": "A list of TargetHttpsProxies contained in this scope.",
- "type": "array"
- },
- "warning": {
- "description": "Informational warning which replaces the list of backend services when the list is empty.",
- "type": "object",
- "properties": {
- "message": {
+ "parameters": {
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true,
+ "location": "path"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "project": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
},
- "data": {
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "targetTcpProxy": {
+ "required": true,
+ "location": "path",
+ "description": "Name of the TargetTcpProxy resource to delete.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
}
- }
+ },
+ "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}",
+ "id": "compute.regionTargetTcpProxies.delete"
}
}
},
- "InstanceMoveRequest": {
- "type": "object",
- "properties": {
- "targetInstance": {
- "type": "string",
- "description": "The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance "
+ "targetHttpsProxies": {
+ "methods": {
+ "setQuicOverride": {
+ "parameterOrder": [
+ "project",
+ "targetHttpsProxy"
+ ],
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "targetHttpsProxy": {
+ "required": true,
+ "description": "Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.",
+ "type": "string",
+ "location": "path"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride",
+ "id": "compute.targetHttpsProxies.setQuicOverride",
+ "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride",
+ "description": "Sets the QUIC override policy for TargetHttpsProxy.",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "TargetHttpsProxiesSetQuicOverrideRequest"
+ }
},
- "destinationZone": {
- "description": "The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone ",
- "type": "string"
- }
- },
- "id": "InstanceMoveRequest"
- },
- "AcceleratorTypesScopedList": {
- "type": "object",
- "properties": {
- "warning": {
- "description": "[Output Only] An informational warning that appears when the accelerator types list is empty.",
- "type": "object",
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "patch": {
+ "parameters": {
+ "targetHttpsProxy": {
+ "description": "Name of the TargetHttpsProxy resource to patch.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
+ "httpMethod": "PATCH",
+ "request": {
+ "$ref": "TargetHttpsProxy"
+ },
+ "description": "Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.targetHttpsProxies.patch",
+ "parameterOrder": [
+ "project",
+ "targetHttpsProxy"
+ ],
+ "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
+ "response": {
+ "$ref": "Operation"
+ }
+ },
+ "setCertificateMap": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "targetHttpsProxy"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap",
+ "description": "Changes the Certificate Map for TargetHttpsProxy.",
+ "parameters": {
+ "targetHttpsProxy": {
+ "type": "string",
+ "description": "Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.",
+ "location": "path",
+ "required": true
},
- "message": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "path"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array"
+ "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).",
+ "type": "string",
+ "location": "query"
}
+ },
+ "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap",
+ "id": "compute.targetHttpsProxies.setCertificateMap",
+ "request": {
+ "$ref": "TargetHttpsProxiesSetCertificateMapRequest"
}
},
- "acceleratorTypes": {
- "type": "array",
- "items": {
- "$ref": "AcceleratorType"
+ "insert": {
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
},
- "description": "[Output Only] A list of accelerator types contained in this scope."
- }
- },
- "id": "AcceleratorTypesScopedList"
- },
- "HealthStatusForNetworkEndpoint": {
- "properties": {
- "healthCheck": {
- "description": "URL of the health check associated with the health state of the network endpoint.",
- "$ref": "HealthCheckReference"
- },
- "healthState": {
- "description": "Health state of the network endpoint determined based on the health checks configured.",
- "enumDescriptions": [
- "",
- "",
- "",
- ""
+ "id": "compute.targetHttpsProxies.insert",
+ "request": {
+ "$ref": "TargetHttpsProxy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "DRAINING",
- "HEALTHY",
- "UNHEALTHY",
- "UNKNOWN"
+ "flatPath": "projects/{project}/global/targetHttpsProxies",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.",
+ "parameterOrder": [
+ "project"
],
- "type": "string"
- },
- "healthCheckService": {
- "$ref": "HealthCheckServiceReference",
- "description": "URL of the health check service associated with the health state of the network endpoint."
- },
- "forwardingRule": {
- "description": "URL of the forwarding rule associated with the health state of the network endpoint.",
- "$ref": "ForwardingRuleReference"
- },
- "backendService": {
- "$ref": "BackendServiceReference",
- "description": "URL of the backend service associated with the health state of the network endpoint."
- }
- },
- "type": "object",
- "id": "HealthStatusForNetworkEndpoint"
- },
- "TargetReference": {
- "type": "object",
- "id": "TargetReference",
- "properties": {
- "target": {
- "type": "string"
- }
- }
- },
- "FirewallPolicyRuleMatcher": {
- "id": "FirewallPolicyRuleMatcher",
- "type": "object",
- "properties": {
- "srcIpRanges": {
- "description": "CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "destIpRanges": {
- "description": "CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "path": "projects/{project}/global/targetHttpsProxies"
},
- "srcSecureTags": {
- "items": {
- "$ref": "FirewallPolicyRuleSecureTag"
+ "setSslCertificates": {
+ "id": "compute.targetHttpsProxies.setSslCertificates",
+ "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "TargetHttpsProxiesSetSslCertificatesRequest"
},
- "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.",
- "type": "array"
- },
- "layer4Configs": {
- "description": "Pairs of IP protocols and ports that the rule should match.",
- "items": {
- "$ref": "FirewallPolicyRuleMatcherLayer4Config"
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- }
- },
- "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified."
- },
- "SnapshotList": {
- "properties": {
- "items": {
- "type": "array",
- "description": "A list of Snapshot resources.",
- "items": {
- "$ref": "Snapshot"
- }
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "project": {
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "targetHttpsProxy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ }
+ },
+ "description": "Replaces SslCertificates for TargetHttpsProxy.",
+ "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
+ "parameterOrder": [
+ "project",
+ "targetHttpsProxy"
+ ]
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "message": {
+ "aggregatedList": {
+ "parameterOrder": [
+ "project"
+ ],
+ "flatPath": "projects/{project}/aggregated/targetHttpsProxies",
+ "path": "projects/{project}/aggregated/targetHttpsProxies",
+ "response": {
+ "$ref": "TargetHttpsProxyAggregatedList"
+ },
+ "id": "compute.targetHttpsProxies.aggregatedList",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
},
- "code": {
+ "project": {
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Name of the project scoping this request.",
+ "location": "path"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "maxResults": {
+ "format": "uint32",
+ "minimum": "0",
+ "type": "integer",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
}
},
- "type": "object"
- },
- "kind": {
- "default": "compute#snapshotList",
- "description": "Type of resource.",
- "type": "string"
+ "httpMethod": "GET",
+ "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project."
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- },
- "id": "SnapshotList",
- "description": "Contains a list of Snapshot resources.",
- "type": "object"
- },
- "BfdPacket": {
- "type": "object",
- "properties": {
- "minEchoRxIntervalMs": {
- "description": "The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880",
- "format": "uint32",
- "type": "integer"
+ "setUrlMap": {
+ "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
+ "description": "Changes the URL map for TargetHttpsProxy.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "targetHttpsProxy": {
+ "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
+ "httpMethod": "POST",
+ "id": "compute.targetHttpsProxies.setUrlMap",
+ "request": {
+ "$ref": "UrlMapReference"
+ },
+ "parameterOrder": [
+ "project",
+ "targetHttpsProxy"
+ ]
},
- "myDiscriminator": {
- "description": "The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880",
- "type": "integer",
- "format": "uint32"
+ "list": {
+ "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.",
+ "id": "compute.targetHttpsProxies.list",
+ "response": {
+ "$ref": "TargetHttpsProxyList"
+ },
+ "flatPath": "projects/{project}/global/targetHttpsProxies",
+ "httpMethod": "GET",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "type": "integer",
+ "format": "uint32",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/global/targetHttpsProxies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "diagnostic": {
- "description": "The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
+ "setSslPolicy": {
+ "request": {
+ "$ref": "SslPolicyReference"
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "ADMINISTRATIVELY_DOWN",
- "CONCATENATED_PATH_DOWN",
- "CONTROL_DETECTION_TIME_EXPIRED",
- "DIAGNOSTIC_UNSPECIFIED",
- "ECHO_FUNCTION_FAILED",
- "FORWARDING_PLANE_RESET",
- "NEIGHBOR_SIGNALED_SESSION_DOWN",
- "NO_DIAGNOSTIC",
- "PATH_DOWN",
- "REVERSE_CONCATENATED_PATH_DOWN"
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "targetHttpsProxy": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035."
+ }
+ },
+ "description": "Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.",
+ "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy",
+ "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy",
+ "id": "compute.targetHttpsProxies.setSslPolicy",
+ "parameterOrder": [
+ "project",
+ "targetHttpsProxy"
]
},
- "state": {
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- ""
+ "get": {
+ "parameterOrder": [
+ "project",
+ "targetHttpsProxy"
],
- "description": "The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880",
- "type": "string",
- "enum": [
- "ADMIN_DOWN",
- "DOWN",
- "INIT",
- "STATE_UNSPECIFIED",
- "UP"
- ]
- },
- "minTxIntervalMs": {
- "type": "integer",
- "description": "The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880",
- "format": "uint32"
- },
- "yourDiscriminator": {
- "description": "The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880",
- "format": "uint32",
- "type": "integer"
- },
- "length": {
- "description": "The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880",
- "format": "uint32",
- "type": "integer"
- },
- "version": {
- "format": "uint32",
- "description": "The version number of the BFD protocol, as specified in section 4.1 of RFC5880.",
- "type": "integer"
- },
- "controlPlaneIndependent": {
- "type": "boolean",
- "description": "The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880"
- },
- "authenticationPresent": {
- "description": "The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880",
- "type": "boolean"
- },
- "minRxIntervalMs": {
- "description": "The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880",
- "type": "integer",
- "format": "uint32"
- },
- "multiplier": {
- "format": "uint32",
- "type": "integer",
- "description": "The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880"
- },
- "poll": {
- "type": "boolean",
- "description": "The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880"
- },
- "multipoint": {
- "type": "boolean",
- "description": "The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880"
- },
- "demand": {
- "type": "boolean",
- "description": "The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880"
- },
- "final": {
- "description": "The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880",
- "type": "boolean"
- }
- },
- "id": "BfdPacket"
- },
- "InstancesSetServiceAccountRequest": {
- "id": "InstancesSetServiceAccountRequest",
- "type": "object",
- "properties": {
- "scopes": {
- "type": "array",
- "description": "The list of scopes to be made available for this service account.",
- "items": {
- "type": "string"
+ "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
+ "description": "Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.",
+ "id": "compute.targetHttpsProxies.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "TargetHttpsProxy"
+ },
+ "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
+ "httpMethod": "GET",
+ "parameters": {
+ "targetHttpsProxy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Name of the TargetHttpsProxy resource to return."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true
+ }
}
},
- "email": {
- "type": "string",
- "description": "Email address of the service account."
+ "delete": {
+ "httpMethod": "DELETE",
+ "id": "compute.targetHttpsProxies.delete",
+ "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
+ "description": "Deletes the specified TargetHttpsProxy resource.",
+ "parameterOrder": [
+ "project",
+ "targetHttpsProxy"
+ ],
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request."
+ },
+ "targetHttpsProxy": {
+ "location": "path",
+ "type": "string",
+ "description": "Name of the TargetHttpsProxy resource to delete.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
}
}
},
- "StatefulPolicy": {
- "properties": {
- "preservedState": {
- "$ref": "StatefulPolicyPreservedState"
- }
- },
- "type": "object",
- "id": "StatefulPolicy"
- },
- "InitialStateConfig": {
- "description": "Initial State for shielded instance, these are public keys which are safe to store in public",
- "properties": {
- "dbs": {
- "type": "array",
- "description": "The Key Database (db).",
- "items": {
- "$ref": "FileContentBuffer"
- }
+ "sslCertificates": {
+ "methods": {
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "sslCertificate": {
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the SslCertificate resource to return."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ }
+ },
+ "flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}",
+ "response": {
+ "$ref": "SslCertificate"
+ },
+ "parameterOrder": [
+ "project",
+ "sslCertificate"
+ ],
+ "httpMethod": "GET",
+ "id": "compute.sslCertificates.get",
+ "description": "Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.",
+ "path": "projects/{project}/global/sslCertificates/{sslCertificate}"
},
- "keks": {
- "description": "The Key Exchange Key (KEK).",
- "type": "array",
- "items": {
- "$ref": "FileContentBuffer"
+ "insert": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/sslCertificates",
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/global/sslCertificates",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.sslCertificates.insert",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ }
+ },
+ "description": "Creates a SslCertificate resource in the specified project using the data included in the request.",
+ "request": {
+ "$ref": "SslCertificate"
}
},
- "pk": {
- "$ref": "FileContentBuffer",
- "description": "The Platform Key (PK)."
- },
- "dbxs": {
- "description": "The forbidden key database (dbx).",
- "items": {
- "$ref": "FileContentBuffer"
+ "delete": {
+ "httpMethod": "DELETE",
+ "id": "compute.sslCertificates.delete",
+ "description": "Deletes the specified SslCertificate resource.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/sslCertificates/{sslCertificate}",
+ "parameters": {
+ "sslCertificate": {
+ "type": "string",
+ "location": "path",
+ "description": "Name of the SslCertificate resource to delete.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ }
},
- "type": "array"
- }
- },
- "id": "InitialStateConfig",
- "type": "object"
- },
- "InterconnectAttachmentList": {
- "id": "InterconnectAttachmentList",
- "description": "Response to the list request, and contains a list of interconnect attachments.",
- "type": "object",
- "properties": {
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}",
+ "parameterOrder": [
+ "project",
+ "sslCertificate"
+ ]
},
- "items": {
- "items": {
- "$ref": "InterconnectAttachment"
+ "aggregatedList": {
+ "httpMethod": "GET",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Name of the project scoping this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "maxResults": {
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "minimum": "0",
+ "location": "query",
+ "format": "uint32"
+ }
},
- "description": "A list of InterconnectAttachment resources.",
- "type": "array"
+ "path": "projects/{project}/aggregated/sslCertificates",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.sslCertificates.aggregatedList",
+ "description": "Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.",
+ "response": {
+ "$ref": "SslCertificateAggregatedList"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "flatPath": "projects/{project}/aggregated/sslCertificates"
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "list": {
+ "flatPath": "projects/{project}/global/sslCertificates",
+ "description": "Retrieves the list of SslCertificate resources available to the specified project.",
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/global/sslCertificates",
+ "response": {
+ "$ref": "SslCertificateList"
+ },
+ "id": "compute.sslCertificates.list",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
},
- "code": {
+ "maxResults": {
+ "type": "integer",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "pageToken": {
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ }
+ }
+ }
+ }
+ },
+ "imageFamilyViews": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "ImageFamilyView"
+ },
+ "path": "projects/{project}/zones/{zone}/imageFamilyViews/{family}",
+ "httpMethod": "GET",
+ "description": "Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.imageFamilyViews.get",
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "description": "The name of the zone for this request.",
+ "type": "string"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "family": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the image family to search for.",
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
"type": "string"
}
},
- "type": "object"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "kind": {
- "type": "string",
- "default": "compute#interconnectAttachmentList",
- "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments."
+ "flatPath": "projects/{project}/zones/{zone}/imageFamilyViews/{family}",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "family"
+ ]
}
}
},
- "TargetTcpProxiesSetBackendServiceRequest": {
- "id": "TargetTcpProxiesSetBackendServiceRequest",
- "properties": {
- "service": {
- "description": "The URL of the new BackendService resource for the targetTcpProxy.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ResourcePolicySnapshotSchedulePolicyRetentionPolicy": {
- "type": "object",
- "id": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy",
- "properties": {
- "maxRetentionDays": {
- "type": "integer",
- "format": "int32",
- "description": "Maximum age of the snapshot that is allowed to be kept."
- },
- "onSourceDiskDelete": {
- "enumDescriptions": [
- "",
- "",
- ""
+ "targetVpnGateways": {
+ "methods": {
+ "insert": {
+ "httpMethod": "POST",
+ "id": "compute.targetVpnGateways.insert",
+ "description": "Creates a target VPN gateway in the specified project and region using the data included in the request.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "location": "path",
+ "description": "Name of the region for this request.",
+ "required": true
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "projects/{project}/regions/{region}/targetVpnGateways",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "type": "string",
- "description": "Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.",
- "enum": [
- "APPLY_RETENTION_POLICY",
- "KEEP_AUTO_SNAPSHOTS",
- "UNSPECIFIED_ON_SOURCE_DISK_DELETE"
- ]
- }
- },
- "description": "Policy for retention of scheduled snapshots."
- },
- "HttpRouteAction": {
- "properties": {
- "corsPolicy": {
- "$ref": "CorsPolicy",
- "description": "The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy."
- },
- "weightedBackendServices": {
- "type": "array",
- "description": "A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number. After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.",
- "items": {
- "$ref": "WeightedBackendService"
+ "request": {
+ "$ref": "TargetVpnGateway"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/regions/{region}/targetVpnGateways",
+ "response": {
+ "$ref": "Operation"
}
},
- "retryPolicy": {
- "description": "Specifies the retry policy associated with this route.",
- "$ref": "HttpRetryPolicy"
- },
- "faultInjectionPolicy": {
- "$ref": "HttpFaultInjection",
- "description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout and retry_policy is ignored by clients that are configured with a fault_injection_policy if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection. Fault injection is not supported with the global external HTTP(S) load balancer (classic). To see which load balancers support fault injection, see Load balancing: Routing and traffic management features."
- },
- "maxStreamDuration": {
- "$ref": "Duration",
- "description": "Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (known as *end-of-stream*), the duration in this field is computed from the beginning of the stream until the response has been processed, including all retries. A stream that does not complete in this duration is closed. If not specified, this field uses the maximum maxStreamDuration value among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED."
- },
- "urlRewrite": {
- "description": "The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.",
- "$ref": "UrlRewrite"
- },
- "requestMirrorPolicy": {
- "description": "Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.",
- "$ref": "RequestMirrorPolicy"
- },
- "timeout": {
- "description": "Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as *end-of-stream*) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.",
- "$ref": "Duration"
- }
- },
- "type": "object",
- "id": "HttpRouteAction"
- },
- "UsageExportLocation": {
- "id": "UsageExportLocation",
- "type": "object",
- "description": "The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.",
- "properties": {
- "reportNamePrefix": {
- "description": "An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage_gce. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.",
- "type": "string"
- },
- "bucketName": {
- "description": "The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.",
- "type": "string"
- }
- }
- },
- "NamedPort": {
- "type": "object",
- "description": "The named port. For example: \u003c\"http\", 80\u003e.",
- "properties": {
- "name": {
- "description": "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.",
- "type": "string"
- },
- "port": {
- "format": "int32",
- "description": "The port number, which can be a value between 1 and 65535.",
- "type": "integer"
- }
- },
- "id": "NamedPort"
- },
- "ProjectsGetXpnResources": {
- "properties": {
- "kind": {
- "type": "string",
- "default": "compute#projectsGetXpnResources",
- "description": "[Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects)"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "XpnResourceId"
+ "aggregatedList": {
+ "id": "compute.targetVpnGateways.aggregatedList",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves an aggregated list of target VPN gateways.",
+ "flatPath": "projects/{project}/aggregated/targetVpnGateways",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "maxResults": {
+ "default": "500",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ }
},
- "description": "Service resources (a.k.a service projects) attached to this project as their shared VPC host."
- }
- },
- "type": "object",
- "id": "ProjectsGetXpnResources"
- },
- "TargetPool": {
- "properties": {
- "failoverRatio": {
- "description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.",
- "format": "float",
- "type": "number"
- },
- "instances": {
- "type": "array",
- "description": "A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.",
- "items": {
- "type": "string"
- }
+ "response": {
+ "$ref": "TargetVpnGatewayAggregatedList"
+ },
+ "path": "projects/{project}/aggregated/targetVpnGateways"
},
- "sessionAffinity": {
- "type": "string",
- "enum": [
- "CLIENT_IP",
- "CLIENT_IP_NO_DESTINATION",
- "CLIENT_IP_PORT_PROTO",
- "CLIENT_IP_PROTO",
- "GENERATED_COOKIE",
- "HEADER_FIELD",
- "HTTP_COOKIE",
- "NONE"
+ "setLabels": {
+ "path": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "RegionSetLabelsRequest"
+ },
+ "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.",
- "enumDescriptions": [
- "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.",
- "1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.",
- "5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.",
- "3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.",
- "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.",
- "The hash is based on a user specified header field.",
- "The hash is based on a user provided cookie.",
- "No session affinity. Connections from the same client IP may go to any instance in the pool."
+ "httpMethod": "POST",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true,
+ "description": "The region for this request.",
+ "location": "path"
+ },
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name or id of the resource for this request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "description": "Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation.",
+ "id": "compute.targetVpnGateways.setLabels",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
]
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "name": {
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "backupPool": {
- "description": "The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.",
- "type": "string"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the target pool resides."
- },
- "healthChecks": {
- "items": {
- "type": "string"
+ "delete": {
+ "description": "Deletes the specified target VPN gateway.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
},
- "description": "The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.",
- "type": "array"
- },
- "kind": {
- "type": "string",
- "default": "compute#targetPool",
- "description": "[Output Only] Type of the resource. Always compute#targetPool for target pools."
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- }
- },
- "description": "Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools.",
- "id": "TargetPool",
- "type": "object"
- },
- "ExternalVpnGatewayList": {
- "id": "ExternalVpnGatewayList",
- "description": "Response to the list request, and contains a list of externalVpnGateways.",
- "properties": {
- "etag": {
- "type": "string"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true
+ },
+ "targetVpnGateway": {
+ "type": "string",
+ "description": "Name of the target VPN gateway to delete.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
+ },
+ "region": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "description": "Name of the region for this request.",
+ "location": "path"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetVpnGateway"
+ ],
+ "id": "compute.targetVpnGateways.delete",
+ "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
+ "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}"
},
- "warning": {
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "list": {
+ "parameters": {
+ "project": {
+ "required": true,
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "default": "500",
+ "type": "integer",
+ "location": "query"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "type": "array"
+ "region": {
+ "type": "string",
+ "description": "Name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path"
},
- "message": {
+ "filter": {
+ "location": "query",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "ExternalVpnGateway"
+ "path": "projects/{project}/regions/{region}/targetVpnGateways",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.targetVpnGateways.list",
+ "flatPath": "projects/{project}/regions/{region}/targetVpnGateways",
+ "response": {
+ "$ref": "TargetVpnGatewayList"
},
- "description": "A list of ExternalVpnGateway resources."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways.",
- "type": "string",
- "default": "compute#externalVpnGatewayList"
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "httpMethod": "GET",
+ "description": "Retrieves a list of target VPN gateways available to the specified project and region."
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DeprecationStatus": {
- "properties": {
- "state": {
- "enum": [
- "ACTIVE",
- "DELETED",
- "DEPRECATED",
- "OBSOLETE"
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- ""
+ "id": "compute.targetVpnGateways.get",
+ "parameterOrder": [
+ "project",
+ "region",
+ "targetVpnGateway"
],
- "description": "The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error."
- },
- "deprecated": {
- "type": "string",
- "description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it."
- },
- "replacement": {
- "type": "string",
- "description": "The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource."
- },
- "deleted": {
- "description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.",
- "type": "string"
- },
- "obsolete": {
- "type": "string",
- "description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it."
+ "httpMethod": "GET",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "targetVpnGateway": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the target VPN gateway to return.",
+ "type": "string"
+ },
+ "region": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string",
+ "description": "Name of the region for this request."
+ }
+ },
+ "response": {
+ "$ref": "TargetVpnGateway"
+ },
+ "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
+ "description": "Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.",
+ "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}"
}
- },
- "id": "DeprecationStatus",
- "type": "object",
- "description": "Deprecation status for a public resource."
+ }
},
- "InstanceGroupList": {
- "description": "A list of InstanceGroup resources.",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "warning": {
- "type": "object",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "securityPolicies": {
+ "methods": {
+ "removeRule": {
+ "httpMethod": "POST",
+ "path": "projects/{project}/global/securityPolicies/{securityPolicy}/removeRule",
+ "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/removeRule",
+ "parameterOrder": [
+ "project",
+ "securityPolicy"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "securityPolicy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "required": true,
+ "location": "path",
+ "description": "Name of the security policy to update."
},
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- }
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "priority": {
+ "location": "query",
+ "description": "The priority of the rule to remove from the security policy.",
+ "format": "int32",
+ "type": "integer"
}
},
- "description": "[Output Only] Informational warning message."
- },
- "items": {
- "items": {
- "$ref": "InstanceGroup"
+ "description": "Deletes a rule at the specified priority.",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "A list of InstanceGroup resources."
- },
- "kind": {
- "type": "string",
- "default": "compute#instanceGroupList",
- "description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists."
- }
- },
- "id": "InstanceGroupList"
- },
- "NetworkAttachmentList": {
- "id": "NetworkAttachmentList",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "default": "compute#networkAttachmentList"
+ "id": "compute.securityPolicies.removeRule"
},
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ "get": {
+ "httpMethod": "GET",
+ "path": "projects/{project}/global/securityPolicies/{securityPolicy}",
+ "description": "List all of the ordered rules present in a single specified policy.",
+ "id": "compute.securityPolicies.get",
+ "parameters": {
+ "securityPolicy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the security policy to get.",
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "response": {
+ "$ref": "SecurityPolicy"
+ },
+ "parameterOrder": [
+ "project",
+ "securityPolicy"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}"
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
+ "listPreconfiguredExpressionSets": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ }
+ },
+ "id": "compute.securityPolicies.listPreconfiguredExpressionSets",
+ "flatPath": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets",
+ "path": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets",
+ "httpMethod": "GET",
+ "description": "Gets the current list of preconfigured Web Application Firewall (WAF) expressions."
},
- "warning": {
- "type": "object",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "aggregatedList": {
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/aggregated/securityPolicies",
+ "description": "Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.securityPolicies.aggregatedList",
+ "response": {
+ "$ref": "SecurityPoliciesAggregatedList"
+ },
+ "parameters": {
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "location": "query"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name of the project scoping this request."
+ },
+ "maxResults": {
+ "location": "query",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "format": "uint32",
+ "minimum": "0"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"type": "string"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "includeAllScopes": {
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean"
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
}
},
- "description": "[Output Only] Informational warning message."
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "items": {
- "items": {
- "$ref": "NetworkAttachment"
- },
- "type": "array",
- "description": "A list of NetworkAttachment resources."
- }
- }
- },
- "Scheduling": {
- "id": "Scheduling",
- "type": "object",
- "properties": {
- "nodeAffinities": {
- "description": "A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.",
- "items": {
- "$ref": "SchedulingNodeAffinity"
- },
- "type": "array"
- },
- "automaticRestart": {
- "type": "boolean",
- "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine."
- },
- "instanceTerminationAction": {
- "type": "string",
- "description": "Specifies the termination action for the instance.",
- "enum": [
- "DELETE",
- "INSTANCE_TERMINATION_ACTION_UNSPECIFIED",
- "STOP"
- ],
- "enumDescriptions": [
- "Delete the VM.",
- "Default value. This value is unused.",
- "Stop the VM without storing in-memory content. default action."
- ]
- },
- "onHostMaintenance": {
- "type": "string",
- "description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy.",
- "enum": [
- "MIGRATE",
- "TERMINATE"
- ],
- "enumDescriptions": [
- "*[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.",
- "Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events."
+ "path": "projects/{project}/aggregated/securityPolicies",
+ "parameterOrder": [
+ "project"
]
},
- "provisioningModel": {
- "enumDescriptions": [
- "Heavily discounted, no guaranteed runtime.",
- "Standard provisioning with user controlled runtime, no discounts."
+ "addRule": {
+ "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule",
+ "path": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule",
+ "request": {
+ "$ref": "SecurityPolicyRule"
+ },
+ "description": "Inserts a rule into a security policy.",
+ "parameterOrder": [
+ "project",
+ "securityPolicy"
],
- "type": "string",
- "enum": [
- "SPOT",
- "STANDARD"
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "Specifies the provisioning model of the instance."
- },
- "locationHint": {
- "type": "string",
- "description": "An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API."
- },
- "minNodeCpus": {
- "type": "integer",
- "format": "int32",
- "description": "The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node."
- },
- "preemptible": {
- "description": "Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.",
- "type": "boolean"
- }
- },
- "description": "Sets the scheduling options for an Instance."
- },
- "VpnGatewaysGetStatusResponse": {
- "properties": {
- "result": {
- "$ref": "VpnGatewayStatus"
- }
- },
- "type": "object",
- "id": "VpnGatewaysGetStatusResponse"
- },
- "TestPermissionsResponse": {
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
- "items": {
- "type": "string"
+ "id": "compute.securityPolicies.addRule",
+ "parameters": {
+ "validateOnly": {
+ "location": "query",
+ "description": "If true, the request will not be committed.",
+ "type": "boolean"
+ },
+ "securityPolicy": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Name of the security policy to update.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request."
+ }
},
- "type": "array"
- }
- },
- "id": "TestPermissionsResponse"
- },
- "Project": {
- "type": "object",
- "description": "Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy.",
- "properties": {
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#project for projects.",
- "type": "string",
- "default": "compute#project"
- },
- "defaultServiceAccount": {
- "type": "string",
- "description": "[Output Only] Default service account used by VMs running in this project."
- },
- "commonInstanceMetadata": {
- "$ref": "Metadata",
- "description": "Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information."
- },
- "description": {
- "description": "An optional textual description of the resource.",
- "type": "string"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "usageExportLocation": {
- "$ref": "UsageExportLocation",
- "description": "The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored."
+ "httpMethod": "POST"
},
- "xpnProjectStatus": {
- "enum": [
- "HOST",
- "UNSPECIFIED_XPN_PROJECT_STATUS"
+ "patchRule": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "SecurityPolicyRule"
+ },
+ "httpMethod": "POST",
+ "parameters": {
+ "validateOnly": {
+ "location": "query",
+ "description": "If true, the request will not be committed.",
+ "type": "boolean"
+ },
+ "securityPolicy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the security policy to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "priority": {
+ "description": "The priority of the rule to patch.",
+ "type": "integer",
+ "location": "query",
+ "format": "int32"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request."
+ }
+ },
+ "description": "Patches a rule at the specified priority.",
+ "path": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule",
+ "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule",
+ "id": "compute.securityPolicies.patchRule",
+ "parameterOrder": [
+ "project",
+ "securityPolicy"
],
- "type": "string",
- "description": "[Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated.",
- "enumDescriptions": [
- "",
- ""
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
},
- "quotas": {
- "type": "array",
- "items": {
- "$ref": "Quota"
+ "insert": {
+ "id": "compute.securityPolicies.insert",
+ "response": {
+ "$ref": "Operation"
},
- "description": "[Output Only] Quotas assigned to this project."
- },
- "defaultNetworkTier": {
- "description": "This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM.",
- "enum": [
- "FIXED_STANDARD",
- "PREMIUM",
- "STANDARD",
- "STANDARD_OVERRIDES_FIXED_STANDARD"
- ],
- "enumDescriptions": [
- "Public internet quality with fixed bandwidth.",
- "High quality, Google-grade network tier, support for all networking products.",
- "Public internet quality, only limited support for other networking products.",
- "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured."
+ "description": "Creates a new policy in the specified project using the data included in the request.",
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/global/securityPolicies",
+ "path": "projects/{project}/global/securityPolicies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine."
- },
- "enabledFeatures": {
- "items": {
- "type": "string"
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "validateOnly": {
+ "location": "query",
+ "type": "boolean",
+ "description": "If true, the request will not be committed."
+ }
},
- "type": "array",
- "description": "Restricted features enabled for use on this project."
- },
- "vmDnsSetting": {
- "enumDescriptions": [
- "",
- "",
- "",
- ""
- ],
- "type": "string",
- "enum": [
- "GLOBAL_DEFAULT",
- "UNSPECIFIED_VM_DNS_SETTING",
- "ZONAL_DEFAULT",
- "ZONAL_ONLY"
+ "parameterOrder": [
+ "project"
],
- "description": "[Output Only] Default internal DNS setting used by VMs running in this project."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server. This is *not* the project ID, and is just a unique ID used by Compute Engine to identify resources.",
- "format": "uint64",
- "type": "string"
- }
- },
- "id": "Project"
- },
- "AutoscalingPolicy": {
- "properties": {
- "scaleInControl": {
- "$ref": "AutoscalingPolicyScaleInControl"
- },
- "scalingSchedules": {
- "description": "Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.",
- "type": "object",
- "additionalProperties": {
- "$ref": "AutoscalingPolicyScalingSchedule"
+ "request": {
+ "$ref": "SecurityPolicy"
}
},
- "cpuUtilization": {
- "description": "Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.",
- "$ref": "AutoscalingPolicyCpuUtilization"
- },
- "mode": {
- "description": "Defines operating mode for this policy.",
- "enum": [
- "OFF",
- "ON",
- "ONLY_SCALE_OUT",
- "ONLY_UP"
- ],
- "type": "string",
- "enumDescriptions": [
- "Do not automatically scale the MIG in or out. The recommended_size field contains the size of MIG that would be set if the actuation mode was enabled.",
- "Automatically scale the MIG in and out according to the policy.",
- "Automatically create VMs according to the policy, but do not scale the MIG in.",
- "Automatically create VMs according to the policy, but do not scale the MIG in."
- ]
- },
- "coolDownPeriodSec": {
- "type": "integer",
- "description": "The number of seconds that the autoscaler waits before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.",
- "format": "int32"
- },
- "customMetricUtilizations": {
- "type": "array",
- "items": {
- "$ref": "AutoscalingPolicyCustomMetricUtilization"
+ "patch": {
+ "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}",
+ "httpMethod": "PATCH",
+ "parameters": {
+ "securityPolicy": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the security policy to update."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
},
- "description": "Configuration parameters of autoscaling based on a custom metric."
- },
- "minNumReplicas": {
- "format": "int32",
- "type": "integer",
- "description": "The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed."
- },
- "loadBalancingUtilization": {
- "description": "Configuration parameters of autoscaling based on load balancer.",
- "$ref": "AutoscalingPolicyLoadBalancingUtilization"
- },
- "maxNumReplicas": {
- "description": "The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object",
- "description": "Cloud Autoscaler policy.",
- "id": "AutoscalingPolicy"
- },
- "ConsistentHashLoadBalancerSettingsHttpCookie": {
- "type": "object",
- "description": "The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash.",
- "properties": {
- "path": {
- "description": "Path to set for the cookie.",
- "type": "string"
- },
- "ttl": {
- "description": "Lifetime of the cookie.",
- "$ref": "Duration"
- },
- "name": {
- "type": "string",
- "description": "Name of the cookie."
- }
- },
- "id": "ConsistentHashLoadBalancerSettingsHttpCookie"
- },
- "ConnectionDraining": {
- "description": "Message containing connection draining configuration.",
- "properties": {
- "drainingTimeoutSec": {
- "description": "Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.",
- "type": "integer",
- "format": "int32"
- }
- },
- "type": "object",
- "id": "ConnectionDraining"
- },
- "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig": {
- "properties": {
- "contentTypes": {
- "description": "A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type \"/\" subtype *[\";\" parameter] When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig",
- "type": "object"
- },
- "ShieldedInstanceIdentity": {
- "id": "ShieldedInstanceIdentity",
- "type": "object",
- "description": "A Shielded Instance Identity.",
- "properties": {
- "encryptionKey": {
- "$ref": "ShieldedInstanceIdentityEntry",
- "description": "An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM."
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.",
- "default": "compute#shieldedInstanceIdentity",
- "type": "string"
- },
- "signingKey": {
- "description": "An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.",
- "$ref": "ShieldedInstanceIdentityEntry"
- }
- }
- },
- "CustomerEncryptionKeyProtectedDisk": {
- "type": "object",
- "properties": {
- "source": {
- "type": "string",
- "description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. For example: \"source\": \"/compute/v1/projects/project_id/zones/zone/disks/ disk_name "
- },
- "diskEncryptionKey": {
- "description": "Decrypts data associated with the disk with a customer-supplied encryption key.",
- "$ref": "CustomerEncryptionKey"
- }
- },
- "id": "CustomerEncryptionKeyProtectedDisk"
- },
- "FirewallLogConfig": {
- "type": "object",
- "description": "The available logging options for a firewall rule.",
- "id": "FirewallLogConfig",
- "properties": {
- "metadata": {
- "enum": [
- "EXCLUDE_ALL_METADATA",
- "INCLUDE_ALL_METADATA"
+ "request": {
+ "$ref": "SecurityPolicy"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.",
+ "parameterOrder": [
+ "project",
+ "securityPolicy"
],
- "description": "This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.",
- "type": "string",
- "enumDescriptions": [
- "",
- ""
- ]
- },
- "enable": {
- "description": "This field denotes whether to enable logging for a particular firewall rule.",
- "type": "boolean"
- }
- }
- },
- "CacheInvalidationRule": {
- "id": "CacheInvalidationRule",
- "type": "object",
- "properties": {
- "host": {
- "type": "string",
- "description": "If set, this invalidation rule will only apply to requests with a Host header matching host."
- },
- "path": {
- "type": "string"
- }
- }
- },
- "SubnetworkList": {
- "description": "Contains a list of Subnetwork resources.",
- "type": "object",
- "id": "SubnetworkList",
- "properties": {
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "id": "compute.securityPolicies.patch",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/securityPolicies/{securityPolicy}"
},
- "items": {
- "type": "array",
- "items": {
- "$ref": "Subnetwork"
+ "setLabels": {
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path"
+ },
+ "resource": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "description": "Name or id of the resource for this request."
+ }
},
- "description": "A list of Subnetwork resources."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.",
- "default": "compute#subnetworkList",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "request": {
+ "$ref": "GlobalSetLabelsRequest"
+ },
+ "path": "projects/{project}/global/securityPolicies/{resource}/setLabels",
+ "description": "Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/securityPolicies/{resource}/setLabels",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "id": "compute.securityPolicies.setLabels"
},
- "warning": {
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "type": "array"
+ "list": {
+ "description": "List all the policies that have been configured for the specified project.",
+ "response": {
+ "$ref": "SecurityPolicyList"
+ },
+ "parameters": {
+ "maxResults": {
+ "location": "query",
+ "type": "integer",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "default": "500"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
"type": "string"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "orderBy": {
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
}
},
- "type": "object",
- "description": "[Output Only] Informational warning message."
- }
- }
- },
- "PerInstanceConfig": {
- "id": "PerInstanceConfig",
- "type": "object",
- "properties": {
- "fingerprint": {
- "format": "byte",
- "description": "Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset.",
- "type": "string"
- },
- "name": {
- "description": "The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configconfiguration for a VM instance that either doesn't exist or is not part of the group will result in an error.",
- "type": "string"
+ "id": "compute.securityPolicies.list",
+ "path": "projects/{project}/global/securityPolicies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project"
+ ],
+ "flatPath": "projects/{project}/global/securityPolicies",
+ "httpMethod": "GET"
},
- "preservedState": {
- "description": "The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.",
- "$ref": "PreservedState"
+ "getRule": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "securityPolicy"
+ ],
+ "path": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "SecurityPolicyRule"
+ },
+ "description": "Gets a rule at the specified priority.",
+ "parameters": {
+ "priority": {
+ "location": "query",
+ "type": "integer",
+ "format": "int32",
+ "description": "The priority of the rule to get from the security policy."
+ },
+ "securityPolicy": {
+ "description": "Name of the security policy to which the queried rule belongs.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "id": "compute.securityPolicies.getRule",
+ "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule"
},
- "status": {
- "description": "The status of applying this per-instance configuration on the corresponding managed instance.",
- "enumDescriptions": [
- "The per-instance configuration is being applied to the instance, but is not yet effective, possibly waiting for the instance to, for example, REFRESH.",
- "The per-instance configuration deletion is being applied on the instance, possibly waiting for the instance to, for example, REFRESH.",
- "The per-instance configuration is effective on the instance, meaning that all disks, ips and metadata specified in this configuration are attached or set on the instance.",
- "*[Default]* The default status, when no per-instance configuration exists.",
- "The per-instance configuration is set on an instance but not been applied yet.",
- "The per-instance configuration has been deleted, but the deletion is not yet applied."
+ "delete": {
+ "path": "projects/{project}/global/securityPolicies/{securityPolicy}",
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified policy.",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "securityPolicy": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the security policy to delete.",
+ "location": "path",
+ "required": true
+ }
+ },
+ "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "enum": [
- "APPLYING",
- "DELETING",
- "EFFECTIVE",
- "NONE",
- "UNAPPLIED",
- "UNAPPLIED_DELETION"
- ]
+ "parameterOrder": [
+ "project",
+ "securityPolicy"
+ ],
+ "id": "compute.securityPolicies.delete",
+ "response": {
+ "$ref": "Operation"
+ }
}
}
},
- "InstanceGroupsAddInstancesRequest": {
- "type": "object",
- "properties": {
- "instances": {
- "type": "array",
- "items": {
- "$ref": "InstanceReference"
+ "publicDelegatedPrefixes": {
+ "methods": {
+ "patch": {
+ "parameters": {
+ "publicDelegatedPrefix": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Name of the PublicDelegatedPrefix resource to patch.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "description": "Name of the region for this request.",
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true
+ }
},
- "description": "The list of instances to add to the instance group."
- }
- },
- "id": "InstanceGroupsAddInstancesRequest"
- },
- "InstanceGroupsListInstancesRequest": {
- "type": "object",
- "properties": {
- "instanceState": {
- "description": "A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.",
- "enum": [
- "ALL",
- "RUNNING"
- ],
- "enumDescriptions": [
- "Includes all instances in the generated list regardless of their state.",
- "Includes instances in the generated list only if they have a RUNNING state."
+ "request": {
+ "$ref": "PublicDelegatedPrefix"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "publicDelegatedPrefix"
],
- "type": "string"
- }
- },
- "id": "InstanceGroupsListInstancesRequest"
- },
- "HTTPHealthCheck": {
- "properties": {
- "portSpecification": {
- "enumDescriptions": [
- "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.",
- "Not supported.",
- "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports."
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.publicDelegatedPrefixes.patch",
+ "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
+ "description": "Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Also supported in legacy HTTP health checks for target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.",
- "enum": [
- "USE_FIXED_PORT",
- "USE_NAMED_PORT",
- "USE_SERVING_PORT"
- ]
- },
- "requestPath": {
- "description": "The request path of the HTTP health check request. The default value is /.",
- "type": "string"
+ "httpMethod": "PATCH",
+ "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}"
},
- "portName": {
- "description": "Not supported.",
- "type": "string"
+ "delete": {
+ "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "publicDelegatedPrefix"
+ ],
+ "parameters": {
+ "region": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "Name of the region of this request.",
+ "required": true
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "publicDelegatedPrefix": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the PublicDelegatedPrefix resource to delete."
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path"
+ }
+ },
+ "description": "Deletes the specified PublicDelegatedPrefix in the given region.",
+ "id": "compute.publicDelegatedPrefixes.delete"
},
- "port": {
- "description": "The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.",
- "format": "int32",
- "type": "integer"
+ "aggregatedList": {
+ "path": "projects/{project}/aggregated/publicDelegatedPrefixes",
+ "parameters": {
+ "includeAllScopes": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
+ },
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "default": "500",
+ "minimum": "0",
+ "location": "query",
+ "format": "uint32"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "description": "Name of the project scoping this request.",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "id": "compute.publicDelegatedPrefixes.aggregatedList",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "PublicDelegatedPrefixAggregatedList"
+ },
+ "httpMethod": "GET",
+ "description": "Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.",
+ "flatPath": "projects/{project}/aggregated/publicDelegatedPrefixes"
},
- "host": {
- "description": "The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest",
- "type": "string"
+ "insert": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes",
+ "description": "Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.",
+ "httpMethod": "POST",
+ "id": "compute.publicDelegatedPrefixes.insert",
+ "parameters": {
+ "region": {
+ "required": true,
+ "description": "Name of the region of this request.",
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "request": {
+ "$ref": "PublicDelegatedPrefix"
+ },
+ "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes"
},
- "proxyHeader": {
- "enumDescriptions": [
- "",
- ""
+ "get": {
+ "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
+ "response": {
+ "$ref": "PublicDelegatedPrefix"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "publicDelegatedPrefix"
],
- "type": "string",
- "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
- "enum": [
- "NONE",
- "PROXY_V1"
- ]
- },
- "response": {
- "description": "Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http",
- "type": "string"
- }
- },
- "id": "HTTPHealthCheck",
- "type": "object"
- },
- "ForwardingRuleReference": {
- "type": "object",
- "id": "ForwardingRuleReference",
- "properties": {
- "forwardingRule": {
- "type": "string"
- }
- }
- },
- "AddressAggregatedList": {
- "id": "AddressAggregatedList",
- "properties": {
- "kind": {
- "default": "compute#addressAggregatedList",
- "description": "[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.",
- "type": "string"
- },
- "items": {
- "additionalProperties": {
- "description": "[Output Only] Name of the scope containing this set of addresses.",
- "$ref": "AddressesScopedList"
+ "id": "compute.publicDelegatedPrefixes.get",
+ "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region of this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "publicDelegatedPrefix": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string",
+ "description": "Name of the PublicDelegatedPrefix resource to return."
+ }
},
- "type": "object",
- "description": "A list of AddressesScopedList resources."
+ "description": "Returns the specified PublicDelegatedPrefix resource in the given region.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET"
},
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "list": {
+ "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes",
+ "parameters": {
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region of this request.",
"type": "string"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array"
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "location": "query",
+ "default": "500",
+ "minimum": "0"
},
- "message": {
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
}
- }
- },
- "unreachables": {
- "type": "array",
- "items": {
- "type": "string"
},
- "description": "[Output Only] Unreachable resources."
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- },
- "type": "object"
- },
- "InstanceGroupManagersCreateInstancesRequest": {
- "description": "InstanceGroupManagers.createInstances",
- "type": "object",
- "id": "InstanceGroupManagersCreateInstancesRequest",
- "properties": {
- "instances": {
- "type": "array",
- "items": {
- "$ref": "PerInstanceConfig"
+ "response": {
+ "$ref": "PublicDelegatedPrefixList"
},
- "description": "[Required] List of specifications of per-instance configs."
+ "id": "compute.publicDelegatedPrefixes.list",
+ "description": "Lists the PublicDelegatedPrefixes for a project in the given region.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "httpMethod": "GET"
}
}
},
- "UrlMap": {
- "type": "object",
- "id": "UrlMap",
- "properties": {
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "tests": {
- "type": "array",
- "items": {
- "$ref": "UrlMapTest"
+ "regionCommitments": {
+ "methods": {
+ "insert": {
+ "id": "compute.regionCommitments.insert",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "region": {
+ "description": "Name of the region for this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
},
- "description": "The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true."
- },
- "hostRules": {
- "items": {
- "$ref": "HostRule"
+ "flatPath": "projects/{project}/regions/{region}/commitments",
+ "description": "Creates a commitment in the specified project using the data included in the request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "The list of host rules to use against the URL."
- },
- "pathMatchers": {
- "items": {
- "$ref": "PathMatcher"
+ "request": {
+ "$ref": "Commitment"
},
- "type": "array",
- "description": "The list of named PathMatchers to use against the URL."
- },
- "kind": {
- "default": "compute#urlMap",
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#urlMaps for url maps."
- },
- "headerAction": {
- "$ref": "HttpHeaderAction",
- "description": "Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "defaultService": {
- "description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.",
- "type": "string"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
- },
- "defaultRouteAction": {
- "$ref": "HttpRouteAction",
- "description": "defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string",
- "format": "uint64"
- },
- "name": {
- "type": "string",
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ "path": "projects/{project}/regions/{region}/commitments"
},
- "defaultUrlRedirect": {
- "description": "When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.",
- "$ref": "HttpRedirectAction"
+ "get": {
+ "description": "Returns the specified commitment resource. Gets a list of available commitments by making a list() request.",
+ "httpMethod": "GET",
+ "id": "compute.regionCommitments.get",
+ "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "commitment"
+ ],
+ "response": {
+ "$ref": "Commitment"
+ },
+ "path": "projects/{project}/regions/{region}/commitments/{commitment}",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "commitment": {
+ "description": "Name of the commitment to return.",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region for this request.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ }
},
- "fingerprint": {
- "type": "string",
- "format": "byte",
- "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap."
- }
- },
- "description": "Represents a URL Map resource. Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts."
- },
- "CommitmentsScopedList": {
- "type": "object",
- "properties": {
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning which replaces the list of commitments when the list is empty.",
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "update": {
+ "path": "projects/{project}/regions/{region}/commitments/{commitment}",
+ "httpMethod": "PATCH",
+ "description": "Updates the specified commitment 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: auto_renew.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "region": {
+ "required": true,
+ "description": "Name of the region for this request.",
+ "location": "path",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
- "data": {
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "project": {
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "paths": {
+ "location": "query",
+ "type": "string",
+ "repeated": true
+ },
+ "commitment": {
+ "required": true,
+ "description": "Name of the commitment for which auto renew is being updated.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "update_mask indicates fields to be updated as part of this request.",
+ "location": "query",
"type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
}
- }
- },
- "commitments": {
- "type": "array",
- "description": "[Output Only] A list of commitments contained in this scope.",
- "items": {
+ },
+ "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}",
+ "id": "compute.regionCommitments.update",
+ "request": {
"$ref": "Commitment"
- }
- }
- },
- "id": "CommitmentsScopedList"
- },
- "InstanceListReferrers": {
- "description": "Contains a list of instance referrers.",
- "id": "InstanceListReferrers",
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "default": "compute#instanceListReferrers",
- "description": "[Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers."
- },
- "items": {
- "items": {
- "$ref": "Reference"
},
- "description": "A list of Reference resources.",
- "type": "array"
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "project",
+ "region",
+ "commitment"
+ ]
},
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "aggregatedList": {
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/aggregated/commitments",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query",
+ "type": "boolean"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "maxResults": {
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "minimum": "0",
+ "default": "500",
+ "format": "uint32"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
"type": "string"
}
- }
- }
- },
- "type": "object"
- },
- "PreservedState": {
- "type": "object",
- "description": "Preserved state for a given instance.",
- "id": "PreservedState",
- "properties": {
- "metadata": {
- "additionalProperties": {
- "type": "string"
},
- "type": "object",
- "description": "Preserved metadata defined for this instance."
- },
- "disks": {
- "additionalProperties": {
- "$ref": "PreservedStatePreservedDisk"
+ "path": "projects/{project}/aggregated/commitments",
+ "id": "compute.regionCommitments.aggregatedList",
+ "response": {
+ "$ref": "CommitmentAggregatedList"
},
- "description": "Preserved disks defined for this instance. This map is keyed with the device names of the disks.",
- "type": "object"
- }
- }
- },
- "CircuitBreakers": {
- "id": "CircuitBreakers",
- "description": "Settings controlling the volume of requests, connections and retries to this backend service.",
- "type": "object",
- "properties": {
- "maxRetries": {
- "type": "integer",
- "description": "The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
- "format": "int32"
- },
- "maxPendingRequests": {
- "format": "int32",
- "description": "The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
- "type": "integer"
- },
- "maxRequestsPerConnection": {
- "format": "int32",
- "description": "Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
- "type": "integer"
- },
- "maxConnections": {
- "description": "The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
- "type": "integer",
- "format": "int32"
- },
- "maxRequests": {
- "format": "int32",
- "description": "The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.",
- "type": "integer"
- }
- }
- },
- "TargetPoolInstanceHealth": {
- "properties": {
- "kind": {
- "type": "string",
- "default": "compute#targetPoolInstanceHealth",
- "description": "[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves an aggregated list of commitments by region."
},
- "healthStatus": {
- "items": {
- "$ref": "HealthStatus"
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "CommitmentList"
},
- "type": "array"
- }
- },
- "id": "TargetPoolInstanceHealth",
- "type": "object"
- },
- "LicenseCodeLicenseAlias": {
- "type": "object",
- "properties": {
- "selfLink": {
- "description": "[Output Only] URL of license corresponding to this License Code.",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "[Output Only] Description of this License Code."
- }
- },
- "id": "LicenseCodeLicenseAlias"
- },
- "SerialPortOutput": {
- "type": "object",
- "id": "SerialPortOutput",
- "properties": {
- "start": {
- "description": "The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "default": "compute#serialPortOutput",
- "description": "[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output."
- },
- "contents": {
- "type": "string",
- "description": "[Output Only] The contents of the console output."
- },
- "next": {
- "type": "string",
- "description": "[Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter.",
- "format": "int64"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- },
- "description": "An instance serial console output."
- },
- "InstancesSetMinCpuPlatformRequest": {
- "id": "InstancesSetMinCpuPlatformRequest",
- "properties": {
- "minCpuPlatform": {
- "type": "string",
- "description": "Minimum cpu/platform this instance should be started at."
+ "parameters": {
+ "maxResults": {
+ "minimum": "0",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "format": "uint32",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "region": {
+ "type": "string",
+ "description": "Name of the region for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ }
+ },
+ "httpMethod": "GET",
+ "id": "compute.regionCommitments.list",
+ "description": "Retrieves a list of commitments contained within the specified region.",
+ "path": "projects/{project}/regions/{region}/commitments",
+ "flatPath": "projects/{project}/regions/{region}/commitments",
+ "parameterOrder": [
+ "project",
+ "region"
+ ]
}
- },
- "type": "object"
+ }
},
- "TargetTcpProxy": {
- "properties": {
- "proxyBind": {
- "description": "This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.",
- "type": "boolean"
- },
- "name": {
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "proxyHeader": {
- "enum": [
- "NONE",
- "PROXY_V1"
+ "firewallPolicies": {
+ "methods": {
+ "removeAssociation": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "",
- ""
+ "httpMethod": "POST",
+ "id": "compute.firewallPolicies.removeAssociation",
+ "path": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation",
+ "description": "Removes an association for the specified firewall policy.",
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation",
+ "parameters": {
+ "name": {
+ "location": "query",
+ "description": "Name for the attachment that will be removed.",
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "firewallPolicy": {
+ "description": "Name of the firewall policy to update.",
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "firewallPolicy"
],
- "type": "string",
- "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE."
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "region": {
- "description": "[Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.",
- "type": "string"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "kind": {
- "default": "compute#targetTcpProxy",
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies."
- },
- "service": {
- "type": "string",
- "description": "URL to the BackendService resource."
+ "response": {
+ "$ref": "Operation"
+ }
},
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- }
- },
- "id": "TargetTcpProxy",
- "type": "object",
- "description": "Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview."
- },
- "NodeGroupAutoscalingPolicy": {
- "id": "NodeGroupAutoscalingPolicy",
- "properties": {
- "mode": {
- "type": "string",
- "enum": [
- "MODE_UNSPECIFIED",
- "OFF",
- "ON",
- "ONLY_SCALE_OUT"
- ],
- "enumDescriptions": [
- "",
- "Autoscaling is disabled.",
- "Autocaling is fully enabled.",
- "Autoscaling will only scale out and will not remove nodes."
+ "setIamPolicy": {
+ "parameterOrder": [
+ "resource"
],
- "description": "The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes."
- },
- "minNodes": {
- "type": "integer",
- "description": "The minimum number of nodes that the group should have.",
- "format": "int32"
+ "path": "locations/global/firewallPolicies/{resource}/setIamPolicy",
+ "id": "compute.firewallPolicies.setIamPolicy",
+ "request": {
+ "$ref": "GlobalOrganizationSetPolicyRequest"
+ },
+ "parameters": {
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "flatPath": "locations/global/firewallPolicies/{resource}/setIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "httpMethod": "POST"
},
- "maxNodes": {
- "description": "The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "SecurityPolicyRuleRateLimitOptionsThreshold": {
- "id": "SecurityPolicyRuleRateLimitOptionsThreshold",
- "type": "object",
- "properties": {
- "count": {
- "description": "Number of HTTP(S) requests for calculating the threshold.",
- "format": "int32",
- "type": "integer"
+ "insert": {
+ "flatPath": "locations/global/firewallPolicies",
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "locations/global/firewallPolicies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "FirewallPolicy"
+ },
+ "id": "compute.firewallPolicies.insert",
+ "description": "Creates a new policy in the specified project using the data included in the request.",
+ "parameters": {
+ "parentId": {
+ "type": "string",
+ "description": "Parent ID for this request. The ID can be either be \"folders/[FOLDER_ID]\" if the parent is a folder or \"organizations/[ORGANIZATION_ID]\" if the parent is an organization.",
+ "location": "query"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ }
+ },
+ "httpMethod": "POST"
},
- "intervalSec": {
- "description": "Interval over which the threshold is computed.",
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "ExternalVpnGateway": {
- "description": "Represents an external VPN gateway. External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway. For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN.",
- "type": "object",
- "id": "ExternalVpnGateway",
- "properties": {
- "redundancyType": {
- "type": "string",
- "description": "Indicates the user-supplied redundancy type of this external VPN gateway.",
- "enum": [
- "FOUR_IPS_REDUNDANCY",
- "SINGLE_IP_INTERNALLY_REDUNDANT",
- "TWO_IPS_REDUNDANCY"
+ "getRule": {
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getRule",
+ "id": "compute.firewallPolicies.getRule",
+ "description": "Gets a rule of the specified priority.",
+ "path": "locations/global/firewallPolicies/{firewallPolicy}/getRule",
+ "response": {
+ "$ref": "FirewallPolicyRule"
+ },
+ "parameterOrder": [
+ "firewallPolicy"
],
- "enumDescriptions": [
- "The external VPN gateway has four public IP addresses; at the time of writing this API, the AWS virtual private gateway is an example which has four public IP addresses for high availability connections; there should be two VPN connections in the AWS virtual private gateway , each AWS VPN connection has two public IP addresses; please make sure to put two public IP addresses from one AWS VPN connection into interfaces 0 and 1 of this external VPN gateway, and put the other two public IP addresses from another AWS VPN connection into interfaces 2 and 3 of this external VPN gateway. When displaying highly available configuration status for the VPN tunnels connected to FOUR_IPS_REDUNDANCY external VPN gateway, Google will always detect whether interfaces 0 and 1 are connected on one interface of HA Cloud VPN gateway, and detect whether interfaces 2 and 3 are connected to another interface of the HA Cloud VPN gateway.",
- "The external VPN gateway has only one public IP address which internally provide redundancy or failover.",
- "The external VPN gateway has two public IP addresses which are redundant with each other, the following two types of setup on your on-premises side would have this type of redundancy: (1) Two separate on-premises gateways, each with one public IP address, the two on-premises gateways are redundant with each other. (2) A single on-premise gateway with two public IP addresses that are redundant with eatch other."
+ "parameters": {
+ "priority": {
+ "location": "query",
+ "description": "The priority of the rule to get from the firewall policy.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "firewallPolicy": {
+ "required": true,
+ "type": "string",
+ "description": "Name of the firewall policy to which the queried rule belongs.",
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "location": "path"
+ }
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
]
},
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "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.",
- "annotations": {
- "required": [
- "compute.externalVpnGateways.insert"
- ]
- }
- },
- "labelFingerprint": {
- "type": "string",
- "format": "byte",
- "description": "A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway."
+ "addRule": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "FirewallPolicyRule"
+ },
+ "httpMethod": "POST",
+ "description": "Inserts a rule into a firewall policy.",
+ "parameterOrder": [
+ "firewallPolicy"
+ ],
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addRule",
+ "path": "locations/global/firewallPolicies/{firewallPolicy}/addRule",
+ "id": "compute.firewallPolicies.addRule",
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "firewallPolicy": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name of the firewall policy to update.",
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
},
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
+ "listAssociations": {
+ "id": "compute.firewallPolicies.listAssociations",
+ "path": "locations/global/firewallPolicies/listAssociations",
+ "description": "Lists associations of a specified target, i.e., organization or folder.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "locations/global/firewallPolicies/listAssociations",
+ "parameters": {
+ "targetResource": {
+ "location": "query",
+ "description": "The target resource to list associations. It is an organization, or a folder.",
+ "type": "string"
+ }
+ },
+ "response": {
+ "$ref": "FirewallPoliciesListAssociationsResponse"
+ },
+ "httpMethod": "GET"
},
- "interfaces": {
- "description": "A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.",
- "type": "array",
- "items": {
- "$ref": "ExternalVpnGatewayInterface"
+ "move": {
+ "description": "Moves the specified firewall policy.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.firewallPolicies.move",
+ "parameterOrder": [
+ "firewallPolicy"
+ ],
+ "httpMethod": "POST",
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/move",
+ "path": "locations/global/firewallPolicies/{firewallPolicy}/move",
+ "parameters": {
+ "parentId": {
+ "location": "query",
+ "description": "The new parent of the firewall policy.",
+ "type": "string"
+ },
+ "firewallPolicy": {
+ "location": "path",
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "description": "Name of the firewall policy to update.",
+ "type": "string",
+ "required": true
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "Operation"
}
},
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.",
- "default": "compute#externalVpnGateway",
- "type": "string"
- },
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
+ "patch": {
+ "response": {
+ "$ref": "Operation"
},
- "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty."
+ "httpMethod": "PATCH",
+ "request": {
+ "$ref": "FirewallPolicy"
+ },
+ "parameters": {
+ "firewallPolicy": {
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "required": true,
+ "description": "Name of the firewall policy to update.",
+ "location": "path",
+ "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).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "path": "locations/global/firewallPolicies/{firewallPolicy}",
+ "parameterOrder": [
+ "firewallPolicy"
+ ],
+ "description": "Patches the specified policy with the data included in the request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.firewallPolicies.patch",
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}"
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "flatPath": "locations/global/firewallPolicies/{resource}/testIamPermissions",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "path": "locations/global/firewallPolicies/{resource}/testIamPermissions",
+ "id": "compute.firewallPolicies.testIamPermissions",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "location": "path",
+ "type": "string",
+ "required": true
+ }
+ }
},
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- }
- }
- },
- "RegionInstanceGroupManagersDeleteInstancesRequest": {
- "id": "RegionInstanceGroupManagersDeleteInstancesRequest",
- "properties": {
- "instances": {
- "type": "array",
- "items": {
- "type": "string"
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
},
- "description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]."
+ "flatPath": "locations/global/firewallPolicies/{resource}/getIamPolicy",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "resource"
+ ],
+ "id": "compute.firewallPolicies.getIamPolicy",
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "location": "path",
+ "description": "Name or id of the resource for this request.",
+ "required": true,
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}"
+ },
+ "optionsRequestedPolicyVersion": {
+ "type": "integer",
+ "location": "query",
+ "description": "Requested IAM Policy version.",
+ "format": "int32"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "path": "locations/global/firewallPolicies/{resource}/getIamPolicy"
},
- "skipInstancesOnValidationError": {
- "description": "Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "ResourcePolicyAggregatedList": {
- "description": "Contains a list of resourcePolicies.",
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "default": "compute#resourcePolicyAggregatedList",
- "description": "Type of resource."
+ "getAssociation": {
+ "response": {
+ "$ref": "FirewallPolicyAssociation"
+ },
+ "parameterOrder": [
+ "firewallPolicy"
+ ],
+ "path": "locations/global/firewallPolicies/{firewallPolicy}/getAssociation",
+ "id": "compute.firewallPolicies.getAssociation",
+ "description": "Gets an association with the specified name.",
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "query",
+ "description": "The name of the association to get from the firewall policy.",
+ "type": "string"
+ },
+ "firewallPolicy": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the firewall policy to which the queried rule belongs.",
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}"
+ }
+ },
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getAssociation",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- }
+ "addAssociation": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "firewallPolicy": {
+ "description": "Name of the firewall policy to update.",
+ "required": true,
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "type": "string",
+ "location": "path"
},
- "code": {
+ "replaceExistingAssociation": {
+ "type": "boolean",
+ "description": "Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.",
+ "location": "query"
+ },
+ "requestId": {
+ "location": "query",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "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)."
+ }
+ },
+ "parameterOrder": [
+ "firewallPolicy"
+ ],
+ "httpMethod": "POST",
+ "description": "Inserts an association for the specified firewall policy.",
+ "id": "compute.firewallPolicies.addAssociation",
+ "path": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation",
+ "request": {
+ "$ref": "FirewallPolicyAssociation"
+ }
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Lists all the policies that have been configured for the specified folder or organization.",
+ "response": {
+ "$ref": "FirewallPolicyList"
+ },
+ "path": "locations/global/firewallPolicies",
+ "parameters": {
+ "maxResults": {
+ "type": "integer",
+ "format": "uint32",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "parentId": {
+ "description": "Parent ID for this request.",
+ "location": "query",
"type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
}
- }
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ },
+ "httpMethod": "GET",
+ "flatPath": "locations/global/firewallPolicies",
+ "id": "compute.firewallPolicies.list"
},
- "etag": {
- "type": "string"
+ "patchRule": {
+ "path": "locations/global/firewallPolicies/{firewallPolicy}/patchRule",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "FirewallPolicyRule"
+ },
+ "description": "Patches a rule of the specified priority.",
+ "parameters": {
+ "firewallPolicy": {
+ "location": "path",
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "required": true,
+ "type": "string",
+ "description": "Name of the firewall policy to update."
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "priority": {
+ "format": "int32",
+ "description": "The priority of the rule to patch.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "id": "compute.firewallPolicies.patchRule",
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchRule",
+ "parameterOrder": [
+ "firewallPolicy"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ }
},
- "unreachables": {
- "items": {
- "type": "string"
+ "removeRule": {
+ "parameters": {
+ "firewallPolicy": {
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "type": "string",
+ "description": "Name of the firewall policy to update.",
+ "location": "path",
+ "required": true
+ },
+ "priority": {
+ "format": "int32",
+ "description": "The priority of the rule to remove from the firewall policy.",
+ "location": "query",
+ "type": "integer"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ }
},
- "type": "array",
- "description": "[Output Only] Unreachable resources."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "locations/global/firewallPolicies/{firewallPolicy}/removeRule",
+ "description": "Deletes a rule of the specified priority.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "firewallPolicy"
+ ],
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeRule",
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.firewallPolicies.removeRule"
},
- "items": {
- "type": "object",
- "additionalProperties": {
- "$ref": "ResourcePoliciesScopedList",
- "description": "Name of the scope containing this set of resourcePolicies."
+ "get": {
+ "parameterOrder": [
+ "firewallPolicy"
+ ],
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}",
+ "path": "locations/global/firewallPolicies/{firewallPolicy}",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "FirewallPolicy"
},
- "description": "A list of ResourcePolicy resources."
- }
- },
- "id": "ResourcePolicyAggregatedList"
- },
- "LogConfigCounterOptions": {
- "id": "LogConfigCounterOptions",
- "description": "This is deprecated and has no effect. Do not use.",
- "properties": {
- "customFields": {
- "items": {
- "$ref": "LogConfigCounterOptionsCustomField"
+ "description": "Returns the specified firewall policy.",
+ "parameters": {
+ "firewallPolicy": {
+ "type": "string",
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "required": true,
+ "location": "path",
+ "description": "Name of the firewall policy to get."
+ }
},
- "description": "This is deprecated and has no effect. Do not use.",
- "type": "array"
+ "id": "compute.firewallPolicies.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "metric": {
- "description": "This is deprecated and has no effect. Do not use.",
- "type": "string"
+ "cloneRules": {
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "firewallPolicy"
+ ],
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "sourceFirewallPolicy": {
+ "location": "query",
+ "description": "The firewall policy from which to copy rules.",
+ "type": "string"
+ },
+ "firewallPolicy": {
+ "type": "string",
+ "location": "path",
+ "description": "Name of the firewall policy to update.",
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "required": true
+ }
+ },
+ "description": "Copies rules to the specified firewall policy.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules",
+ "httpMethod": "POST",
+ "id": "compute.firewallPolicies.cloneRules"
},
- "field": {
- "type": "string",
- "description": "This is deprecated and has no effect. Do not use."
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "firewallPolicy": {
+ "location": "path",
+ "pattern": "(firewallPolicies/)?[0-9]{0,20}",
+ "type": "string",
+ "required": true,
+ "description": "Name of the firewall policy to delete."
+ }
+ },
+ "flatPath": "locations/global/firewallPolicies/{firewallPolicy}",
+ "description": "Deletes the specified policy.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "id": "compute.firewallPolicies.delete",
+ "path": "locations/global/firewallPolicies/{firewallPolicy}",
+ "parameterOrder": [
+ "firewallPolicy"
+ ]
}
- },
- "type": "object"
+ }
},
- "DiskAggregatedList": {
- "type": "object",
- "id": "DiskAggregatedList",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
+ "routes": {
+ "methods": {
+ "delete": {
+ "parameters": {
+ "route": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "description": "Name of the Route resource to delete.",
+ "location": "path"
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ }
+ },
+ "flatPath": "projects/{project}/global/routes/{route}",
+ "parameterOrder": [
+ "project",
+ "route"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/global/routes/{route}",
+ "id": "compute.routes.delete",
+ "description": "Deletes the specified Route resource.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "DELETE"
},
- "kind": {
- "default": "compute#diskAggregatedList",
- "description": "[Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.",
- "type": "string"
+ "insert": {
+ "flatPath": "projects/{project}/global/routes",
+ "description": "Creates a Route resource in the specified project using the data included in the request.",
+ "path": "projects/{project}/global/routes",
+ "id": "compute.routes.insert",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path"
+ }
+ },
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "Route"
+ },
+ "parameterOrder": [
+ "project"
+ ]
},
- "unreachables": {
- "items": {
- "type": "string"
+ "get": {
+ "parameters": {
+ "route": {
+ "description": "Name of the Route resource to return.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
+ }
},
- "description": "[Output Only] Unreachable resources.",
- "type": "array"
+ "parameterOrder": [
+ "project",
+ "route"
+ ],
+ "response": {
+ "$ref": "Route"
+ },
+ "flatPath": "projects/{project}/global/routes/{route}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.routes.get",
+ "path": "projects/{project}/global/routes/{route}",
+ "description": "Returns the specified Route resource. Gets a list of available routes by making a list() request.",
+ "httpMethod": "GET"
},
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "list": {
+ "parameterOrder": [
+ "project"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
},
- "code": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ]
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "maxResults": {
+ "format": "uint32",
+ "type": "integer",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "minimum": "0"
+ }
+ },
+ "path": "projects/{project}/global/routes",
+ "flatPath": "projects/{project}/global/routes",
+ "id": "compute.routes.list",
+ "response": {
+ "$ref": "RouteList"
+ },
+ "description": "Retrieves the list of Route resources available to the specified project."
+ }
+ }
+ },
+ "machineTypes": {
+ "methods": {
+ "get": {
+ "parameterOrder": [
+ "project",
+ "zone",
+ "machineType"
+ ],
+ "id": "compute.machineTypes.get",
+ "flatPath": "projects/{project}/zones/{zone}/machineTypes/{machineType}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/zones/{zone}/machineTypes/{machineType}",
+ "httpMethod": "GET",
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "zone": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string",
+ "description": "The name of the zone for this request."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "machineType": {
+ "description": "Name of the machine type to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string",
+ "required": true
}
+ },
+ "description": "Returns the specified machine type. Gets a list of available machine types by making a list() request.",
+ "response": {
+ "$ref": "MachineType"
}
},
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "items": {
- "description": "A list of DisksScopedList resources.",
- "additionalProperties": {
- "description": "[Output Only] Name of the scope containing this set of disks.",
- "$ref": "DisksScopedList"
+ "aggregatedList": {
+ "id": "compute.machineTypes.aggregatedList",
+ "response": {
+ "$ref": "MachineTypeAggregatedList"
},
- "type": "object"
- }
- }
- },
- "UsableSubnetworkSecondaryRange": {
- "description": "Secondary IP range of a usable subnetwork.",
- "id": "UsableSubnetworkSecondaryRange",
- "type": "object",
- "properties": {
- "rangeName": {
- "description": "The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.",
- "type": "string"
- },
- "ipCidrRange": {
- "description": "The range of IP addresses belonging to this subnetwork secondary range.",
- "type": "string"
- }
- }
- },
- "PacketMirroringAggregatedList": {
- "description": "Contains a list of packetMirrorings.",
- "id": "PacketMirroringAggregatedList",
- "properties": {
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "parameterOrder": [
+ "project"
+ ],
+ "description": "Retrieves an aggregated list of machine types.",
+ "flatPath": "projects/{project}/aggregated/machineTypes",
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
"type": "string"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "orderBy": {
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array"
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "minimum": "0",
+ "type": "integer",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean"
}
- }
- },
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
},
- "type": "array"
- },
- "kind": {
- "description": "Type of resource.",
- "default": "compute#packetMirroringAggregatedList",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "path": "projects/{project}/aggregated/machineTypes",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "items": {
- "additionalProperties": {
- "description": "Name of the scope containing this set of packetMirrorings.",
- "$ref": "PacketMirroringsScopedList"
+ "list": {
+ "response": {
+ "$ref": "MachineTypeList"
},
- "description": "A list of PacketMirroring resources.",
- "type": "object"
- }
- },
- "type": "object"
- },
- "Uint128": {
- "id": "Uint128",
- "type": "object",
- "properties": {
- "low": {
- "type": "string",
- "format": "uint64"
- },
- "high": {
- "type": "string",
- "format": "uint64"
- }
- }
- },
- "TargetPoolsRemoveHealthCheckRequest": {
- "type": "object",
- "id": "TargetPoolsRemoveHealthCheckRequest",
- "properties": {
- "healthChecks": {
- "type": "array",
- "description": "Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project /global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check ",
- "items": {
- "$ref": "HealthCheckReference"
- }
- }
- }
- },
- "HttpHeaderOption": {
- "id": "HttpHeaderOption",
- "description": "Specification determining how headers are added to requests or responses.",
- "type": "object",
- "properties": {
- "headerValue": {
- "description": "The value of the header to add.",
- "type": "string"
- },
- "headerName": {
- "type": "string",
- "description": "The name of the header."
- },
- "replace": {
- "description": "If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false. ",
- "type": "boolean"
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone for this request.",
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "type": "integer",
+ "location": "query",
+ "default": "500",
+ "format": "uint32",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "id": "compute.machineTypes.list",
+ "flatPath": "projects/{project}/zones/{zone}/machineTypes",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves a list of machine types available to the specified project.",
+ "path": "projects/{project}/zones/{zone}/machineTypes",
+ "parameterOrder": [
+ "project",
+ "zone"
+ ]
}
}
},
- "HttpHeaderAction": {
- "id": "HttpHeaderAction",
- "description": "The request and response header transformations that take effect before the request is passed along to the selected backendService.",
- "type": "object",
- "properties": {
- "responseHeadersToRemove": {
- "items": {
- "type": "string"
+ "globalAddresses": {
+ "methods": {
+ "get": {
+ "id": "compute.globalAddresses.get",
+ "description": "Returns the specified address resource. Gets a list of available addresses by making a list() request.",
+ "response": {
+ "$ref": "Address"
},
- "type": "array",
- "description": "A list of header names for headers that need to be removed from the response before sending the response back to the client."
- },
- "requestHeadersToRemove": {
- "type": "array",
- "description": "A list of header names for headers that need to be removed from the request before forwarding the request to the backendService.",
- "items": {
- "type": "string"
- }
- },
- "responseHeadersToAdd": {
- "items": {
- "$ref": "HttpHeaderOption"
+ "path": "projects/{project}/global/addresses/{address}",
+ "parameterOrder": [
+ "project",
+ "address"
+ ],
+ "flatPath": "projects/{project}/global/addresses/{address}",
+ "httpMethod": "GET",
+ "parameters": {
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "address": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the address resource to return.",
+ "type": "string",
+ "location": "path"
+ }
},
- "type": "array",
- "description": "Headers to add the response before sending the response back to the client."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "requestHeadersToAdd": {
- "items": {
- "$ref": "HttpHeaderOption"
+ "setLabels": {
+ "flatPath": "projects/{project}/global/addresses/{resource}/setLabels",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "location": "path",
+ "description": "Name or id of the resource for this request."
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
},
- "description": "Headers to add to a matching request before forwarding the request to the backendService.",
- "type": "array"
- }
- }
- },
- "ResourcePolicyHourlyCycle": {
- "description": "Time window specified for hourly operations.",
- "properties": {
- "startTime": {
- "description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.",
- "type": "string"
- },
- "hoursInCycle": {
- "description": "Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.",
- "type": "integer",
- "format": "int32"
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.globalAddresses.setLabels",
+ "path": "projects/{project}/global/addresses/{resource}/setLabels",
+ "request": {
+ "$ref": "GlobalSetLabelsRequest"
+ },
+ "description": "Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation."
},
- "duration": {
- "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.",
- "type": "string"
- }
- },
- "id": "ResourcePolicyHourlyCycle",
- "type": "object"
- },
- "HttpRetryPolicy": {
- "type": "object",
- "id": "HttpRetryPolicy",
- "description": "The retry policy associates with HttpRouteRule",
- "properties": {
- "numRetries": {
- "description": "Specifies the allowed number retries. This number must be \u003e 0. If not specified, defaults to 1.",
- "type": "integer",
- "format": "uint32"
+ "list": {
+ "flatPath": "projects/{project}/global/addresses",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.globalAddresses.list",
+ "path": "projects/{project}/global/addresses",
+ "response": {
+ "$ref": "AddressList"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "500",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
+ }
+ },
+ "description": "Retrieves a list of global addresses.",
+ "parameterOrder": [
+ "project"
+ ]
},
- "perTryTimeout": {
- "$ref": "Duration",
- "description": "Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in the HttpRouteAction field. If timeout in the HttpRouteAction field is not set, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true."
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/global/addresses/{address}",
+ "flatPath": "projects/{project}/global/addresses/{address}",
+ "description": "Deletes the specified address resource.",
+ "id": "compute.globalAddresses.delete",
+ "parameters": {
+ "address": {
+ "required": true,
+ "description": "Name of the address resource to delete.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "address"
+ ]
},
- "retryConditions": {
- "description": "Specifies one or more conditions when this retry policy applies. Valid values are: - 5xx: retry is attempted if the instance or endpoint responds with any 5xx response code, or if the instance or endpoint does not respond at all. For example, disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - connect-failure: a retry is attempted on failures connecting to the instance or endpoint. For example, connection timeouts. - retriable-4xx: a retry is attempted if the instance or endpoint responds with a 4xx response code. The only error that you can retry is error code 409. - refused-stream: a retry is attempted if the instance or endpoint resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: a retry is attempted if the gRPC status code in the response header is set to cancelled. - deadline-exceeded: a retry is attempted if the gRPC status code in the response header is set to deadline-exceeded. - internal: a retry is attempted if the gRPC status code in the response header is set to internal. - resource-exhausted: a retry is attempted if the gRPC status code in the response header is set to resource-exhausted. - unavailable: a retry is attempted if the gRPC status code in the response header is set to unavailable. Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true. - cancelled - deadline-exceeded - internal - resource-exhausted - unavailable ",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "insert": {
+ "request": {
+ "$ref": "Address"
+ },
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Creates an address resource in the specified project by using the data included in the request.",
+ "path": "projects/{project}/global/addresses",
+ "parameterOrder": [
+ "project"
+ ],
+ "flatPath": "projects/{project}/global/addresses",
+ "id": "compute.globalAddresses.insert",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
}
}
},
- "HostRule": {
- "type": "object",
- "id": "HostRule",
- "properties": {
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "hosts": {
- "items": {
- "type": "string"
+ "snapshots": {
+ "methods": {
+ "insert": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
},
- "description": "The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character, and if followed by anything, the immediate following character must be either - or .. * based matching is not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.",
- "type": "array"
- },
- "pathMatcher": {
- "description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.",
- "type": "string"
- }
- },
- "description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService."
- },
- "LicensesListResponse": {
- "properties": {
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "parameterOrder": [
+ "project"
+ ],
+ "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.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "Snapshot"
+ },
+ "path": "projects/{project}/global/snapshots",
+ "flatPath": "projects/{project}/global/snapshots",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "id": "compute.snapshots.insert"
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
+ "list": {
+ "response": {
+ "$ref": "SnapshotList"
+ },
+ "description": "Retrieves the list of Snapshot resources contained within the specified project.",
+ "parameters": {
+ "maxResults": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "minimum": "0",
+ "default": "500"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "flatPath": "projects/{project}/global/snapshots",
+ "httpMethod": "GET",
+ "path": "projects/{project}/global/snapshots",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.snapshots.list"
},
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
+ "setLabels": {
+ "description": "Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.",
+ "id": "compute.snapshots.setLabels",
+ "path": "projects/{project}/global/snapshots/{resource}/setLabels",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "resource": {
+ "location": "path",
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ }
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/snapshots/{resource}/setLabels",
+ "request": {
+ "$ref": "GlobalSetLabelsRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "httpMethod": "POST"
},
- "items": {
- "description": "A list of License resources.",
- "type": "array",
- "items": {
- "$ref": "License"
- }
+ "get": {
+ "description": "Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.",
+ "parameterOrder": [
+ "project",
+ "snapshot"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "snapshot": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the Snapshot resource to return."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "projects/{project}/global/snapshots/{snapshot}",
+ "path": "projects/{project}/global/snapshots/{snapshot}",
+ "response": {
+ "$ref": "Snapshot"
+ },
+ "id": "compute.snapshots.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "delete": {
+ "id": "compute.snapshots.delete",
+ "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "project",
+ "snapshot"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/global/snapshots/{snapshot}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "snapshot": {
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "description": "Name of the Snapshot resource to delete."
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
+ "project": {
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path"
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "type": "string"
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
}
- }
- }
- },
- "id": "LicensesListResponse",
- "type": "object"
- },
- "TargetVpnGatewayList": {
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
+ },
+ "path": "projects/{project}/global/snapshots/{snapshot}"
},
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
- "type": "string",
- "default": "compute#targetVpnGatewayList"
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "flatPath": "projects/{project}/global/snapshots/{resource}/testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "path": "projects/{project}/global/snapshots/{resource}/testIamPermissions",
+ "id": "compute.snapshots.testIamPermissions",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request."
+ }
+ },
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "parameterOrder": [
+ "project",
+ "resource"
+ ]
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "getIamPolicy": {
+ "id": "compute.snapshots.getIamPolicy",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "flatPath": "projects/{project}/global/snapshots/{resource}/getIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "httpMethod": "GET",
+ "path": "projects/{project}/global/snapshots/{resource}/getIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "Name or id of the resource for this request.",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "type": "string"
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "optionsRequestedPolicyVersion": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Requested IAM Policy version."
+ }
+ }
+ },
+ "setIamPolicy": {
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name or id of the resource for this request."
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- }
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "location": "path"
}
},
- "type": "object"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "items": {
- "items": {
- "$ref": "TargetVpnGateway"
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "request": {
+ "$ref": "GlobalSetPolicyRequest"
},
- "type": "array",
- "description": "A list of TargetVpnGateway resources."
+ "response": {
+ "$ref": "Policy"
+ },
+ "id": "compute.snapshots.setIamPolicy",
+ "httpMethod": "POST",
+ "path": "projects/{project}/global/snapshots/{resource}/setIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/global/snapshots/{resource}/setIamPolicy",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ]
}
- },
- "description": "Contains a list of TargetVpnGateway resources.",
- "id": "TargetVpnGatewayList",
- "type": "object"
+ }
},
- "RoutersScopedList": {
- "id": "RoutersScopedList",
- "properties": {
- "warning": {
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "forwardingRules": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "ForwardingRule"
+ },
+ "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
+ "parameters": {
+ "project": {
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request."
},
- "code": {
+ "forwardingRule": {
+ "description": "Name of the ForwardingRule resource to return.",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
+ "region": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true,
+ "description": "Name of the region scoping this request."
}
},
- "type": "object",
- "description": "Informational warning which replaces the list of routers when the list is empty."
- },
- "routers": {
- "type": "array",
- "description": "A list of routers contained in this scope.",
- "items": {
- "$ref": "Router"
- }
- }
- },
- "type": "object"
- },
- "BackendServiceGroupHealth": {
- "properties": {
- "healthStatus": {
- "description": "Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks.",
- "type": "array",
- "items": {
- "$ref": "HealthStatus"
- }
- },
- "kind": {
- "default": "compute#backendServiceGroupHealth",
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services."
- },
- "annotations": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object",
- "description": "Metadata defined as annotations on the network endpoint group."
- }
- },
- "id": "BackendServiceGroupHealth",
- "type": "object"
- },
- "Operation": {
- "type": "object",
- "description": "Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.",
- "id": "Operation",
- "properties": {
- "user": {
- "description": "[Output Only] User who requested the operation, for example: `user@example.com`.",
- "type": "string"
- },
- "progress": {
- "format": "int32",
- "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.",
- "type": "integer"
- },
- "status": {
- "type": "string",
- "enum": [
- "DONE",
- "PENDING",
- "RUNNING"
+ "parameterOrder": [
+ "project",
+ "region",
+ "forwardingRule"
],
- "enumDescriptions": [
- "",
- "",
- ""
+ "description": "Returns the specified ForwardingRule resource.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "[Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`."
- },
- "id": {
- "type": "string",
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the operation. This identifier is defined by the server."
- },
- "httpErrorStatusCode": {
- "format": "int32",
- "description": "[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.",
- "type": "integer"
- },
- "clientOperationId": {
- "description": "[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.",
- "type": "string"
- },
- "description": {
- "description": "[Output Only] A textual description of the operation, which is set when the operation is created.",
- "type": "string"
- },
- "httpErrorMessage": {
- "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.",
- "type": "string"
- },
- "error": {
- "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
- "type": "object",
- "properties": {
- "errors": {
- "items": {
- "properties": {
- "message": {
- "description": "[Output Only] An optional, human-readable error message.",
- "type": "string"
- },
- "code": {
- "description": "[Output Only] The error type identifier for this error.",
- "type": "string"
- },
- "errorDetails": {
- "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.",
- "items": {
- "properties": {
- "help": {
- "$ref": "Help"
- },
- "quotaInfo": {
- "$ref": "QuotaExceededInfo"
- },
- "errorInfo": {
- "$ref": "ErrorInfo"
- },
- "localizedMessage": {
- "$ref": "LocalizedMessage"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "location": {
- "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "[Output Only] The array of errors encountered while processing this operation.",
- "type": "array"
- }
- }
- },
- "targetLink": {
- "description": "[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.",
- "type": "string"
+ "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
+ "id": "compute.forwardingRules.get",
+ "httpMethod": "GET"
},
- "warnings": {
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
- },
- "data": {
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- }
- }
- },
- "message": {
- "type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
- }
+ "insert": {
+ "flatPath": "projects/{project}/regions/{region}/forwardingRules",
+ "httpMethod": "POST",
+ "parameters": {
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "required": true
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
}
},
- "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
- "type": "array"
- },
- "endTime": {
- "type": "string",
- "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format."
- },
- "region": {
- "description": "[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "[Output Only] Name of the operation."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Deprecated] This field is deprecated."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "kind": {
- "description": "[Output Only] Type of the resource. Always `compute#operation` for Operation resources.",
- "type": "string",
- "default": "compute#operation"
- },
- "operationType": {
- "description": "[Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.",
- "type": "string"
+ "path": "projects/{project}/regions/{region}/forwardingRules",
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.forwardingRules.insert",
+ "request": {
+ "$ref": "ForwardingRule"
+ },
+ "parameterOrder": [
+ "project",
+ "region"
+ ]
},
- "insertTime": {
- "description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format.",
- "type": "string"
+ "aggregatedList": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/aggregated/forwardingRules",
+ "description": "Retrieves an aggregated list of forwarding rules.",
+ "path": "projects/{project}/aggregated/forwardingRules",
+ "id": "compute.forwardingRules.aggregatedList",
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "ForwardingRuleAggregatedList"
+ },
+ "parameters": {
+ "maxResults": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "minimum": "0",
+ "location": "query"
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ }
+ },
+ "httpMethod": "GET"
},
- "operationGroupId": {
- "description": "[Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.",
- "type": "string"
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "forwardingRule"
+ ],
+ "id": "compute.forwardingRules.delete",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified ForwardingRule resource.",
+ "parameters": {
+ "region": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "description": "Name of the region scoping this request."
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "forwardingRule": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "description": "Name of the ForwardingRule resource to delete.",
+ "required": true,
+ "location": "path"
+ }
+ }
},
- "statusMessage": {
- "description": "[Output Only] An optional textual description of the current status of the operation.",
- "type": "string"
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
+ "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.forwardingRules.patch",
+ "httpMethod": "PATCH",
+ "request": {
+ "$ref": "ForwardingRule"
+ },
+ "description": "Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "forwardingRule"
+ ],
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "forwardingRule": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the ForwardingRule resource to patch.",
+ "type": "string",
+ "required": true
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ }
+ }
},
- "zone": {
- "type": "string",
- "description": "[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations."
+ "setLabels": {
+ "request": {
+ "$ref": "RegionSetLabelsRequest"
+ },
+ "parameters": {
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "The region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ }
+ },
+ "path": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels",
+ "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels",
+ "httpMethod": "POST",
+ "id": "compute.forwardingRules.setLabels",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ]
},
- "startTime": {
- "description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.",
- "type": "string"
+ "list": {
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "path": "projects/{project}/regions/{region}/forwardingRules",
+ "flatPath": "projects/{project}/regions/{region}/forwardingRules",
+ "parameters": {
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "type": "integer",
+ "default": "500",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query",
+ "minimum": "0"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request.",
+ "type": "string"
+ }
+ },
+ "description": "Retrieves a list of ForwardingRule resources available to the specified project and region.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.forwardingRules.list",
+ "response": {
+ "$ref": "ForwardingRuleList"
+ },
+ "httpMethod": "GET"
},
- "targetId": {
- "description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.",
- "type": "string",
- "format": "uint64"
+ "setTarget": {
+ "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget",
+ "description": "Changes target URL for forwarding rule. The new target should be of the same type as the old target.",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "forwardingRule": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the ForwardingRule resource in which target is to be set.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region scoping this request."
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string"
+ }
+ },
+ "request": {
+ "$ref": "TargetReference"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region",
+ "forwardingRule"
+ ],
+ "id": "compute.forwardingRules.setTarget",
+ "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
}
}
},
- "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig": {
- "description": "Configuration options for L7 DDoS detection.",
- "properties": {
- "enable": {
- "type": "boolean",
- "description": "If set to true, enables CAAP for L7 DDoS detection."
- },
- "ruleVisibility": {
- "type": "string",
- "enum": [
- "PREMIUM",
- "STANDARD"
+ "addresses": {
+ "methods": {
+ "insert": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "",
- ""
+ "description": "Creates an address resource in the specified project by using the data included in the request.",
+ "flatPath": "projects/{project}/regions/{region}/addresses",
+ "parameterOrder": [
+ "project",
+ "region"
],
- "description": "Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules."
- }
- },
- "id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig",
- "type": "object"
- },
- "InstanceManagedByIgmErrorInstanceActionDetails": {
- "type": "object",
- "properties": {
- "instance": {
- "type": "string",
- "description": "[Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created."
+ "path": "projects/{project}/regions/{region}/addresses",
+ "httpMethod": "POST",
+ "id": "compute.addresses.insert",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "Address"
+ },
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "description": "Name of the region for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ }
+ }
},
- "action": {
- "description": "[Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:",
- "enumDescriptions": [
- "The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.",
- "The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.",
- "The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.",
- "The managed instance group is permanently deleting this instance.",
- "The managed instance group has not scheduled any actions for this instance.",
- "The managed instance group is recreating this instance.",
- "The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.",
- "The managed instance group is restarting this instance.",
- "The managed instance group is resuming this instance.",
- "The managed instance group is starting this instance.",
- "The managed instance group is stopping this instance.",
- "The managed instance group is suspending this instance.",
- "The managed instance group is verifying this already created instance. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions)."
+ "delete": {
+ "flatPath": "projects/{project}/regions/{region}/addresses/{address}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "ABANDONING",
- "CREATING",
- "CREATING_WITHOUT_RETRIES",
- "DELETING",
- "NONE",
- "RECREATING",
- "REFRESHING",
- "RESTARTING",
- "RESUMING",
- "STARTING",
- "STOPPING",
- "SUSPENDING",
- "VERIFYING"
+ "parameterOrder": [
+ "project",
+ "region",
+ "address"
],
- "type": "string"
- },
- "version": {
- "description": "[Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created.",
- "$ref": "ManagedInstanceVersion"
- }
- },
- "id": "InstanceManagedByIgmErrorInstanceActionDetails"
- },
- "HealthCheckLogConfig": {
- "properties": {
- "enable": {
- "type": "boolean",
- "description": "Indicates whether or not to export logs. This is false by default, which means no health check logging will be done."
- }
- },
- "id": "HealthCheckLogConfig",
- "type": "object",
- "description": "Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver."
- },
- "InstanceGroupManagersListPerInstanceConfigsResp": {
- "type": "object",
- "properties": {
- "items": {
- "items": {
- "$ref": "PerInstanceConfig"
- },
- "description": "[Output Only] The list of PerInstanceConfig.",
- "type": "array"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "warning": {
- "properties": {
- "data": {
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
},
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "region": {
+ "required": true,
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "Name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
},
- "message": {
+ "address": {
+ "location": "path",
+ "description": "Name of the address resource to delete.",
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- }
- },
- "id": "InstanceGroupManagersListPerInstanceConfigsResp"
- },
- "Address": {
- "type": "object",
- "id": "Address",
- "properties": {
- "status": {
- "type": "string",
- "enumDescriptions": [
- "Address is being used by another resource and is not available.",
- "Address is reserved and available to use.",
- "Address is being reserved."
- ],
- "description": "[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.",
- "enum": [
- "IN_USE",
- "RESERVED",
- "RESERVING"
- ]
- },
- "description": {
- "description": "An optional description of this resource. Provide this field when you create the resource.",
- "type": "string"
- },
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.",
- "type": "string",
- "annotations": {
- "required": [
- "compute.addresses.insert"
- ]
- }
- },
- "id": {
- "type": "string",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "subnetwork": {
- "type": "string",
- "description": "The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose."
- },
- "prefixLength": {
- "type": "integer",
- "format": "int32",
- "description": "The prefix length if the resource represents an IP range."
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Deletes the specified address resource.",
+ "httpMethod": "DELETE",
+ "path": "projects/{project}/regions/{region}/addresses/{address}",
+ "id": "compute.addresses.delete"
},
- "ipv6EndpointType": {
- "enum": [
- "NETLB",
- "VM"
+ "aggregatedList": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "enumDescriptions": [
- "Reserved IPv6 address can be used on network load balancer.",
- "Reserved IPv6 address can be used on VM."
+ "parameterOrder": [
+ "project"
],
- "description": "The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation."
- },
- "users": {
- "type": "array",
- "items": {
- "type": "string"
+ "description": "Retrieves an aggregated list of addresses.",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "maxResults": {
+ "type": "integer",
+ "location": "query",
+ "minimum": "0",
+ "format": "uint32",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ }
},
- "description": "[Output Only] The URLs of the resources that are using this address."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.*"
+ "response": {
+ "$ref": "AddressAggregatedList"
+ },
+ "httpMethod": "GET",
+ "path": "projects/{project}/aggregated/addresses",
+ "id": "compute.addresses.aggregatedList",
+ "flatPath": "projects/{project}/aggregated/addresses"
},
- "networkTier": {
- "enumDescriptions": [
- "Public internet quality with fixed bandwidth.",
- "High quality, Google-grade network tier, support for all networking products.",
- "Public internet quality, only limited support for other networking products.",
- "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured."
+ "list": {
+ "parameterOrder": [
+ "project",
+ "region"
],
- "type": "string",
- "enum": [
- "FIXED_STANDARD",
- "PREMIUM",
- "STANDARD",
- "STANDARD_OVERRIDES_FIXED_STANDARD"
+ "response": {
+ "$ref": "AddressList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM."
- },
- "kind": {
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#address for addresses.",
- "default": "compute#address"
+ "id": "compute.addresses.list",
+ "description": "Retrieves a list of addresses contained within the specified region.",
+ "parameters": {
+ "maxResults": {
+ "type": "integer",
+ "default": "500",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "minimum": "0"
+ },
+ "region": {
+ "description": "Name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "httpMethod": "GET",
+ "path": "projects/{project}/regions/{region}/addresses",
+ "flatPath": "projects/{project}/regions/{region}/addresses"
},
- "purpose": {
- "type": "string",
- "enumDescriptions": [
- "DNS resolver address in the subnetwork.",
- "VM internal/alias IP, Internal LB service IP, etc.",
- "A regional internal IP address range reserved for the VLAN attachment that is used in HA VPN over Cloud Interconnect. This regional internal IP address range must not overlap with any IP address range of subnet/route in the VPC network and its peering networks. After the VLAN attachment is created with the reserved IP address range, when creating a new VPN gateway, its interface IP address is allocated from the associated VLAN attachment’s IP address range.",
- "External IP automatically reserved for Cloud NAT.",
- "A private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL",
- "A regional internal IP address range reserved for Serverless.",
- "A private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.",
- "IP range for peer networks."
+ "get": {
+ "path": "projects/{project}/regions/{region}/addresses/{address}",
+ "parameterOrder": [
+ "project",
+ "region",
+ "address"
],
- "enum": [
- "DNS_RESOLVER",
- "GCE_ENDPOINT",
- "IPSEC_INTERCONNECT",
- "NAT_AUTO",
- "PRIVATE_SERVICE_CONNECT",
- "SERVERLESS",
- "SHARED_LOADBALANCER_VIP",
- "VPC_PEERING"
+ "flatPath": "projects/{project}/regions/{region}/addresses/{address}",
+ "response": {
+ "$ref": "Address"
+ },
+ "id": "compute.addresses.get",
+ "parameters": {
+ "address": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the address resource to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "Name of the region for this request."
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. "
+ "httpMethod": "GET",
+ "description": "Returns the specified address resource."
},
- "ipVersion": {
- "enumDescriptions": [
- "",
- "",
- ""
+ "setLabels": {
+ "id": "compute.addresses.setLabels",
+ "path": "projects/{project}/regions/{region}/addresses/{resource}/setLabels",
+ "parameters": {
+ "project": {
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true
+ },
+ "resource": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request."
+ },
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "description": "The region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ }
+ },
+ "description": "Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
],
- "description": "The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.",
- "type": "string",
- "enum": [
- "IPV4",
- "IPV6",
- "UNSPECIFIED_VERSION"
- ]
- },
- "addressType": {
- "enum": [
- "EXTERNAL",
- "INTERNAL",
- "UNSPECIFIED_TYPE"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "type": "string",
- "description": "The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.",
- "enumDescriptions": [
- "A publicly visible external IP address.",
- "A private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.",
- ""
- ]
- },
- "address": {
- "type": "string",
- "description": "The static IP address represented by this resource."
- },
- "network": {
- "type": "string",
- "description": "The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose."
- }
- },
- "description": "Represents an IP Address resource. Google Compute Engine has two IP Address resources: * [Global (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/globalAddresses) * [Regional (external and internal)](https://cloud.google.com/compute/docs/reference/rest/v1/addresses) For more information, see Reserving a static external IP address."
- },
- "CustomerEncryptionKey": {
- "properties": {
- "rsaEncryptedKey": {
- "type": "string",
- "description": "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": {
- "description": "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
- "type": "string"
- },
- "rawKey": {
- "description": "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: \"rawKey\": \"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\" ",
- "type": "string"
- },
- "kmsKeyServiceAccount": {
- "type": "string",
- "description": "The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: \"kmsKeyServiceAccount\": \"name@project_id.iam.gserviceaccount.com/ "
- },
- "kmsKeyName": {
- "type": "string",
- "description": "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 "
+ "request": {
+ "$ref": "RegionSetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "flatPath": "projects/{project}/regions/{region}/addresses/{resource}/setLabels"
}
- },
- "type": "object",
- "id": "CustomerEncryptionKey"
+ }
},
- "NetworkList": {
- "type": "object",
- "id": "NetworkList",
- "description": "Contains a list of networks.",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "code": {
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "regionInstanceGroups": {
+ "methods": {
+ "listInstances": {
+ "parameters": {
+ "maxResults": {
+ "minimum": "0",
+ "format": "uint32",
+ "location": "query",
+ "default": "500",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "type": "string",
+ "description": "Name of the region scoping this request.",
+ "location": "path",
+ "required": true
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "instanceGroup": {
+ "description": "Name of the regional instance group for which we want to list the instances.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "id": "compute.regionInstanceGroups.listInstances",
+ "response": {
+ "$ref": "RegionInstanceGroupsListInstances"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "RegionInstanceGroupsListInstancesRequest"
+ },
+ "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances",
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroup"
+ ],
+ "description": "Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported."
+ },
+ "setNamedPorts": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.regionInstanceGroups.setNamedPorts",
+ "description": "Sets the named ports for the specified regional instance group.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts",
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroup"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "RegionInstanceGroupsSetNamedPortsRequest"
+ },
+ "parameters": {
+ "region": {
"type": "string",
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "required": true,
+ "location": "path",
+ "description": "Name of the region scoping this request."
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "instanceGroup": {
+ "required": true,
+ "description": "The name of the regional instance group where the named ports are updated.",
+ "location": "path",
"type": "string"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- }
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "requestId": {
+ "type": "string",
+ "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"
}
}
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.",
- "type": "string",
- "default": "compute#networkList"
- },
- "items": {
- "description": "A list of Network resources.",
- "items": {
- "$ref": "Network"
+ "list": {
+ "parameters": {
+ "project": {
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "region": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Name of the region scoping this request."
+ },
+ "maxResults": {
+ "minimum": "0",
+ "type": "integer",
+ "format": "uint32",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500"
+ }
},
- "type": "array"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- }
- }
- },
- "RegionInstanceGroupList": {
- "properties": {
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "type": "string",
- "default": "compute#regionInstanceGroupList",
- "description": "The resource type."
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "items": {
- "description": "A list of InstanceGroup resources.",
- "items": {
- "$ref": "InstanceGroup"
+ "flatPath": "projects/{project}/regions/{region}/instanceGroups",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.regionInstanceGroups.list",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "description": "Retrieves the list of instance group resources contained within the specified region.",
+ "path": "projects/{project}/regions/{region}/instanceGroups",
+ "response": {
+ "$ref": "RegionInstanceGroupList"
},
- "type": "array"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
+ "httpMethod": "GET"
},
- "warning": {
- "properties": {
- "data": {
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
- },
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "get": {
+ "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}",
+ "description": "Returns the specified instance group resource.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "instanceGroup"
+ ],
+ "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}",
+ "parameters": {
+ "region": {
+ "description": "Name of the region scoping this request.",
+ "required": true,
+ "location": "path",
"type": "string"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "type": "string"
+ "instanceGroup": {
+ "description": "Name of the instance group resource to return.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "InstanceGroup"
+ },
+ "id": "compute.regionInstanceGroups.get"
}
- },
- "description": "Contains a list of InstanceGroup resources.",
- "type": "object",
- "id": "RegionInstanceGroupList"
+ }
},
- "TargetTcpProxyAggregatedList": {
- "properties": {
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#targetTcpProxyAggregatedList for lists of Target TCP Proxies.",
- "type": "string",
- "default": "compute#targetTcpProxyAggregatedList"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "warning": {
- "properties": {
- "message": {
+ "acceleratorTypes": {
+ "methods": {
+ "aggregatedList": {
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "project": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "includeAllScopes": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
"type": "string"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- }
- },
- "type": "array"
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "maxResults": {
+ "location": "query",
+ "minimum": "0",
+ "type": "integer",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500"
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
+ "path": "projects/{project}/aggregated/acceleratorTypes",
+ "flatPath": "projects/{project}/aggregated/acceleratorTypes",
+ "parameterOrder": [
+ "project"
+ ],
+ "description": "Retrieves an aggregated list of accelerator types.",
+ "response": {
+ "$ref": "AcceleratorTypeAggregatedList"
},
- "type": "array"
+ "id": "compute.acceleratorTypes.aggregatedList"
},
- "items": {
- "additionalProperties": {
- "$ref": "TargetTcpProxiesScopedList",
- "description": "Name of the scope containing this set of TargetTcpProxies."
+ "list": {
+ "id": "compute.acceleratorTypes.list",
+ "flatPath": "projects/{project}/zones/{zone}/acceleratorTypes",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "AcceleratorTypeList"
},
- "type": "object",
- "description": "A list of TargetTcpProxiesScopedList resources."
- }
- },
- "id": "TargetTcpProxyAggregatedList",
- "type": "object"
- },
- "ForwardingRule": {
- "id": "ForwardingRule",
- "description": "Represents a Forwarding Rule resource. Forwarding rule resources in Google Cloud can be either regional or global in scope: * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules) A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding.",
- "properties": {
- "labelFingerprint": {
- "format": "byte",
- "type": "string",
- "description": "A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule."
- },
- "IPProtocol": {
- "type": "string",
- "enum": [
- "AH",
- "ESP",
- "ICMP",
- "L3_DEFAULT",
- "SCTP",
- "TCP",
- "UDP"
+ "parameters": {
+ "maxResults": {
+ "minimum": "0",
+ "type": "integer",
+ "format": "uint32",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query"
+ },
+ "zone": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "required": true
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "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).",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
+ "path": "projects/{project}/zones/{zone}/acceleratorTypes",
+ "description": "Retrieves a list of accelerator types that are available to the specified project.",
+ "parameterOrder": [
+ "project",
+ "zone"
]
},
- "allowGlobalAccess": {
- "type": "boolean",
- "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."
- },
- "IPAddress": {
- "type": "string",
- "description": "IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number."
- },
- "name": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "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. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter."
- },
- "backendService": {
- "type": "string",
- "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."
- },
- "serviceDirectoryRegistrations": {
- "description": "Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.",
- "items": {
- "$ref": "ForwardingRuleServiceDirectoryRegistration"
+ "get": {
+ "flatPath": "projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}",
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the zone for this request."
+ },
+ "acceleratorType": {
+ "location": "path",
+ "required": true,
+ "description": "Name of the accelerator type to return.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path"
+ }
},
- "type": "array"
- },
- "subnetwork": {
- "type": "string",
- "description": "This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6."
- },
- "pscConnectionStatus": {
- "enum": [
- "ACCEPTED",
- "CLOSED",
- "NEEDS_ATTENTION",
- "PENDING",
- "REJECTED",
- "STATUS_UNSPECIFIED"
- ],
- "enumDescriptions": [
- "The connection has been accepted by the producer.",
- "The connection has been closed by the producer and will not serve traffic going forward.",
- "The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.",
- "The connection is pending acceptance by the producer.",
- "The connection has been rejected by the producer.",
- ""
+ "description": "Returns the specified accelerator type.",
+ "id": "compute.acceleratorTypes.get",
+ "path": "projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}",
+ "response": {
+ "$ref": "AcceleratorType"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string"
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "noAutomateDnsZone": {
- "type": "boolean",
- "description": "This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field."
- },
- "fingerprint": {
- "description": "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 ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.",
- "type": "string",
- "format": "byte"
- },
- "ports": {
- "description": "This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\\\d+(?:-\\\\d+)?",
- "items": {
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "acceleratorType"
+ ]
+ }
+ }
+ },
+ "healthChecks": {
+ "methods": {
+ "insert": {
+ "flatPath": "projects/{project}/global/healthChecks",
+ "id": "compute.healthChecks.insert",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "HealthCheck"
},
- "type": "array"
- },
- "network": {
- "description": "This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.",
- "type": "string"
- },
- "allPorts": {
- "description": "This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive.",
- "type": "boolean"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
- },
- "metadataFilters": {
- "description": "Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.",
- "items": {
- "$ref": "MetadataFilter"
+ "description": "Creates a HealthCheck resource in the specified project using the data included in the request.",
+ "path": "projects/{project}/global/healthChecks",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- },
- "portRange": {
- "type": "string",
- "description": "This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\\\d+(?:-\\\\d+)?"
- },
- "labels": {
- "type": "object",
- "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "target": {
- "type": "string",
- "description": "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the \"Target\" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. "
- },
- "networkTier": {
- "type": "string",
- "description": "This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.",
- "enumDescriptions": [
- "Public internet quality with fixed bandwidth.",
- "High quality, Google-grade network tier, support for all networking products.",
- "Public internet quality, only limited support for other networking products.",
- "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured."
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "FIXED_STANDARD",
- "PREMIUM",
- "STANDARD",
- "STANDARD_OVERRIDES_FIXED_STANDARD"
+ "parameterOrder": [
+ "project"
]
},
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "loadBalancingScheme": {
- "type": "string",
- "description": "Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.",
- "enum": [
- "EXTERNAL",
- "EXTERNAL_MANAGED",
- "INTERNAL",
- "INTERNAL_MANAGED",
- "INTERNAL_SELF_MANAGED",
- "INVALID"
+ "update": {
+ "flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
+ "path": "projects/{project}/global/healthChecks/{healthCheck}",
+ "parameterOrder": [
+ "project",
+ "healthCheck"
],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Updates a HealthCheck resource in the specified project using the data included in the request.",
+ "id": "compute.healthChecks.update",
+ "httpMethod": "PUT",
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ },
+ "healthCheck": {
+ "description": "Name of the HealthCheck resource to update.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ }
+ },
+ "request": {
+ "$ref": "HealthCheck"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
]
},
- "pscConnectionId": {
- "description": "[Output Only] The PSC connection id of the PSC Forwarding Rule.",
- "format": "uint64",
- "type": "string"
- },
- "serviceLabel": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label 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. This field is only used for internal load balancing.",
- "type": "string"
- },
- "ipVersion": {
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "IPV4",
- "IPV6",
- "UNSPECIFIED_VERSION"
+ "aggregatedList": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6."
- },
- "kind": {
- "default": "compute#forwardingRule",
- "type": "string",
- "description": "[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources."
- },
- "serviceName": {
- "description": "[Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.",
- "type": "string"
- },
- "isMirroringCollector": {
- "description": "Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL.",
- "type": "boolean"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- }
- },
- "type": "object"
- },
- "RouterAdvertisedIpRange": {
- "description": "Description-tagged IP ranges for the router to advertise.",
- "id": "RouterAdvertisedIpRange",
- "properties": {
- "description": {
- "type": "string",
- "description": "User-specified description for the IP range."
- },
- "range": {
- "description": "The IP range to advertise. The value must be a CIDR-formatted string.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ResourceGroupReference": {
- "id": "ResourceGroupReference",
- "type": "object",
- "properties": {
- "group": {
- "type": "string",
- "description": "A URI referencing one of the instance groups or network endpoint groups listed in the backend service."
- }
- }
- },
- "TargetPoolList": {
- "description": "Contains a list of TargetPool resources.",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "type": "array"
+ "httpMethod": "GET",
+ "parameters": {
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
"type": "string"
},
- "code": {
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "location": "query",
+ "format": "uint32",
+ "minimum": "0"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Name of the project scoping this request."
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean"
}
- }
- },
- "items": {
- "description": "A list of TargetPool resources.",
- "items": {
- "$ref": "TargetPool"
},
- "type": "array"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.",
- "type": "string",
- "default": "compute#targetPoolList"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- }
- },
- "id": "TargetPoolList",
- "type": "object"
- },
- "SecurityPoliciesWafConfig": {
- "type": "object",
- "properties": {
- "wafRules": {
- "$ref": "PreconfiguredWafSet"
- }
- },
- "id": "SecurityPoliciesWafConfig"
- },
- "TargetHttpsProxy": {
- "id": "TargetHttpsProxy",
- "type": "object",
- "description": "Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.",
- "properties": {
- "fingerprint": {
- "format": "byte",
- "type": "string",
- "description": "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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy."
+ "response": {
+ "$ref": "HealthChecksAggregatedList"
+ },
+ "description": "Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.",
+ "id": "compute.healthChecks.aggregatedList",
+ "parameterOrder": [
+ "project"
+ ],
+ "flatPath": "projects/{project}/aggregated/healthChecks",
+ "path": "projects/{project}/aggregated/healthChecks"
},
- "sslCertificates": {
- "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.",
- "items": {
- "type": "string"
+ "delete": {
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified HealthCheck resource.",
+ "parameterOrder": [
+ "project",
+ "healthCheck"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/healthChecks/{healthCheck}",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "requestId": {
+ "location": "query",
+ "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).",
+ "type": "string"
+ },
+ "healthCheck": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "description": "Name of the HealthCheck resource to delete."
+ }
+ },
+ "flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
+ "id": "compute.healthChecks.delete"
},
- "quicOverride": {
- "description": "Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. ",
- "type": "string",
- "enumDescriptions": [
- "The load balancer will not attempt to negotiate QUIC with clients.",
- "The load balancer will attempt to negotiate QUIC with clients.",
- "No overrides to the default QUIC policy. This option is implicit if no QUIC override has been specified in the request."
+ "list": {
+ "flatPath": "projects/{project}/global/healthChecks",
+ "response": {
+ "$ref": "HealthCheckList"
+ },
+ "description": "Retrieves the list of HealthCheck resources available to the specified project.",
+ "httpMethod": "GET",
+ "id": "compute.healthChecks.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "DISABLE",
- "ENABLE",
- "NONE"
+ "path": "projects/{project}/global/healthChecks",
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "type": "integer",
+ "location": "query",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "minimum": "0"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string"
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ }
+ },
+ "parameterOrder": [
+ "project"
]
},
- "urlMap": {
- "type": "string",
- "description": "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 "
- },
- "region": {
- "description": "[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.",
- "type": "string"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.",
- "default": "compute#targetHttpsProxy",
- "type": "string"
- },
- "certificateMap": {
- "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.",
- "type": "string"
- },
- "serverTlsPolicy": {
- "type": "string",
- "description": "Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact."
- },
- "sslPolicy": {
- "description": "URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "name": {
- "description": "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.",
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
- },
- "authorizationPolicy": {
- "description": "Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact.",
- "type": "string"
+ "get": {
+ "parameterOrder": [
+ "project",
+ "healthCheck"
+ ],
+ "id": "compute.healthChecks.get",
+ "description": "Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "path": "projects/{project}/global/healthChecks/{healthCheck}",
+ "httpMethod": "GET",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "healthCheck": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the HealthCheck resource to return.",
+ "type": "string"
+ }
+ },
+ "response": {
+ "$ref": "HealthCheck"
+ },
+ "flatPath": "projects/{project}/global/healthChecks/{healthCheck}"
},
- "proxyBind": {
- "description": "This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.",
- "type": "boolean"
+ "patch": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "healthCheck"
+ ],
+ "flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "healthCheck": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path",
+ "description": "Name of the HealthCheck resource to patch.",
+ "required": true
+ },
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "path": "projects/{project}/global/healthChecks/{healthCheck}",
+ "request": {
+ "$ref": "HealthCheck"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "PATCH",
+ "id": "compute.healthChecks.patch",
+ "description": "Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules."
}
}
},
- "ResourcePolicyDailyCycle": {
- "properties": {
- "startTime": {
- "description": "Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.",
- "type": "string"
- },
- "duration": {
- "type": "string",
- "description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario."
- },
- "daysInCycle": {
- "description": "Defines a schedule with units measured in days. The value determines how many days pass between the start of each cycle.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ResourcePolicyDailyCycle",
- "type": "object",
- "description": "Time window specified for daily operations."
- },
- "Tags": {
- "properties": {
- "fingerprint": {
- "format": "byte",
- "type": "string",
- "description": "Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance."
- },
- "items": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "items": {
- "type": "string"
+ "resourcePolicies": {
+ "methods": {
+ "insert": {
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "description": "Creates a new resource policy.",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "request": {
+ "$ref": "ResourcePolicy"
},
- "description": "An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.",
- "type": "array"
- }
- },
- "id": "Tags",
- "type": "object",
- "description": "A set of instance tags."
- },
- "VmEndpointNatMappingsList": {
- "properties": {
- "result": {
- "items": {
- "$ref": "VmEndpointNatMappings"
+ "path": "projects/{project}/regions/{region}/resourcePolicies",
+ "id": "compute.resourcePolicies.insert",
+ "flatPath": "projects/{project}/regions/{region}/resourcePolicies",
+ "response": {
+ "$ref": "Operation"
},
- "type": "array",
- "description": "[Output Only] A list of Nat mapping information of VM endpoints."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints.",
- "default": "compute#vmEndpointNatMappingsList",
- "type": "string"
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "parameters": {
+ "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).",
+ "location": "query",
+ "type": "string"
},
- "message": {
+ "region": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Name of the region for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
},
- "code": {
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "location": "path"
}
}
},
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ },
+ "region": {
+ "type": "string",
+ "required": true,
+ "description": "Name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "resourcePolicy": {
+ "location": "path",
+ "description": "Name of the resource policy to delete.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ }
+ },
+ "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.resourcePolicies.delete",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resourcePolicy"
+ ],
+ "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
+ "description": "Deletes the specified resource policy."
},
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
- }
- },
- "description": "Contains a list of VmEndpointNatMappings.",
- "id": "VmEndpointNatMappingsList",
- "type": "object"
- },
- "InstanceGroupsRemoveInstancesRequest": {
- "properties": {
- "instances": {
- "description": "The list of instances to remove from the instance group.",
- "items": {
- "$ref": "InstanceReference"
+ "aggregatedList": {
+ "path": "projects/{project}/aggregated/resourcePolicies",
+ "id": "compute.resourcePolicies.aggregatedList",
+ "description": "Retrieves an aggregated list of resource policies.",
+ "response": {
+ "$ref": "ResourcePolicyAggregatedList"
},
- "type": "array"
- }
- },
- "id": "InstanceGroupsRemoveInstancesRequest",
- "type": "object"
- },
- "Snapshot": {
- "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.",
- "properties": {
- "satisfiesPzs": {
- "description": "[Output Only] Reserved for future use.",
- "type": "boolean"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/aggregated/resourcePolicies",
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "includeAllScopes": {
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "location": "query",
+ "type": "integer",
+ "default": "500",
+ "minimum": "0",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
+ }
+ }
},
- "name": {
- "annotations": {
- "required": [
- "compute.snapshots.insert"
- ]
+ "get": {
+ "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "ResourcePolicy"
},
- "description": "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.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "storageLocations": {
- "description": "Cloud Storage bucket storage location of the snapshot (regional or multi-regional).",
- "items": {
- "type": "string"
+ "parameters": {
+ "region": {
+ "type": "string",
+ "description": "Name of the region for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path"
+ },
+ "resourcePolicy": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the resource policy to retrieve.",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ }
},
- "type": "array"
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string",
- "format": "uint64"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- },
- "chainName": {
- "type": "string",
- "description": "Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value."
- },
- "labelFingerprint": {
- "type": "string",
- "format": "byte",
- "description": "A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot."
- },
- "licenses": {
- "type": "array",
- "description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).",
- "items": {
- "type": "string"
- }
- },
- "autoCreated": {
- "type": "boolean",
- "description": "[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk."
- },
- "sourceSnapshotSchedulePolicyId": {
- "description": "[Output Only] ID of the resource policy which created this scheduled snapshot.",
- "type": "string"
+ "id": "compute.resourcePolicies.get",
+ "description": "Retrieves all information of the specified resource policy.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resourcePolicy"
+ ],
+ "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}"
},
- "status": {
- "enum": [
- "CREATING",
- "DELETING",
- "FAILED",
- "READY",
- "UPLOADING"
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "httpMethod": "POST",
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
],
- "type": "string",
- "enumDescriptions": [
- "Snapshot creation is in progress.",
- "Snapshot is currently being deleted.",
- "Snapshot creation failed.",
- "Snapshot has been created successfully.",
- "Snapshot is being uploaded."
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions",
+ "id": "compute.resourcePolicies.testIamPermissions",
+ "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING."
- },
- "sourceDiskEncryptionKey": {
- "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.",
- "$ref": "CustomerEncryptionKey"
+ "parameters": {
+ "region": {
+ "description": "The name of the region for this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "resource": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ }
+ }
},
- "snapshotType": {
- "type": "string",
- "enumDescriptions": [
- "",
- ""
+ "list": {
+ "description": "A list all the resource policies that have been configured for the specified project in specified region.",
+ "parameters": {
+ "maxResults": {
+ "default": "500",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ },
+ "project": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "Name of the region for this request.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
+ "type": "string",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ }
+ },
+ "path": "projects/{project}/regions/{region}/resourcePolicies",
+ "id": "compute.resourcePolicies.list",
+ "flatPath": "projects/{project}/regions/{region}/resourcePolicies",
+ "response": {
+ "$ref": "ResourcePolicyList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "Indicates the type of the snapshot.",
- "enum": [
- "ARCHIVE",
- "STANDARD"
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project",
+ "region"
]
},
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "sourceSnapshotSchedulePolicy": {
- "description": "[Output Only] URL of the resource policy which created this scheduled snapshot.",
- "type": "string"
- },
- "snapshotEncryptionKey": {
- "$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."
- },
- "creationSizeBytes": {
- "type": "string",
- "description": "[Output Only] Size in bytes of the snapshot at creation time.",
- "format": "int64"
- },
- "storageBytesStatus": {
- "type": "string",
- "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.",
- "enumDescriptions": [
- "",
- ""
+ "getIamPolicy": {
+ "httpMethod": "GET",
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path"
+ },
+ "optionsRequestedPolicyVersion": {
+ "location": "query",
+ "format": "int32",
+ "type": "integer",
+ "description": "Requested IAM Policy version."
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the region for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true
+ }
+ },
+ "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy",
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
],
- "enum": [
- "UPDATING",
- "UP_TO_DATE"
- ]
- },
- "locationHint": {
- "description": "An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.",
- "type": "string"
- },
- "downloadBytes": {
- "format": "int64",
- "type": "string",
- "description": "[Output Only] Number of bytes downloaded to restore a snapshot to a disk."
- },
- "sourceDiskId": {
- "description": "[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.",
- "type": "string"
- },
- "architecture": {
- "enumDescriptions": [
- "Default value indicating Architecture is not set.",
- "Machines with architecture ARM64",
- "Machines with architecture X86_64"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "description": "[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.",
- "type": "string",
- "enum": [
- "ARCHITECTURE_UNSPECIFIED",
- "ARM64",
- "X86_64"
- ]
- },
- "sourceDisk": {
- "type": "string",
- "description": "The source disk used to create this snapshot."
- },
- "labels": {
- "description": "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "kind": {
- "type": "string",
- "default": "compute#snapshot",
- "description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources."
- },
- "diskSizeGb": {
- "description": "[Output Only] Size of the source disk, specified in GB.",
- "type": "string",
- "format": "int64"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "licenseCodes": {
- "type": "array",
- "description": "[Output Only] Integer license codes indicating which licenses are attached to this snapshot.",
- "items": {
- "format": "int64",
- "type": "string"
- }
+ "id": "compute.resourcePolicies.getIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy"
},
- "storageBytes": {
- "description": "[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "Snapshot",
- "type": "object"
- },
- "AutoscalingPolicyCpuUtilization": {
- "id": "AutoscalingPolicyCpuUtilization",
- "type": "object",
- "description": "CPU utilization policy.",
- "properties": {
- "predictiveMethod": {
- "enum": [
- "NONE",
- "OPTIMIZE_AVAILABILITY"
+ "setIamPolicy": {
+ "parameters": {
+ "region": {
+ "required": true,
+ "location": "path",
+ "description": "The name of the region for this request.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "location": "path"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics",
- "Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand."
+ "request": {
+ "$ref": "RegionSetPolicyRequest"
+ },
+ "id": "compute.resourcePolicies.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
],
- "description": "Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are: * NONE (default). No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics. * OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand.",
- "type": "string"
- },
- "utilizationTarget": {
- "format": "double",
- "description": "The target CPU utilization that the autoscaler maintains. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales in the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales out until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.",
- "type": "number"
+ "response": {
+ "$ref": "Policy"
+ }
}
}
},
- "InstanceManagedByIgmErrorManagedInstanceError": {
- "id": "InstanceManagedByIgmErrorManagedInstanceError",
- "properties": {
- "message": {
- "description": "[Output Only] Error message.",
- "type": "string"
- },
- "code": {
- "description": "[Output Only] Error code.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AutoscalingPolicyLoadBalancingUtilization": {
- "properties": {
- "utilizationTarget": {
- "description": "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that the autoscaler maintains. Must be a positive float value. If not defined, the default is 0.8.",
- "type": "number",
- "format": "double"
- }
- },
- "description": "Configuration parameters of autoscaling based on load balancing.",
- "id": "AutoscalingPolicyLoadBalancingUtilization",
- "type": "object"
- },
- "RouterNat": {
- "id": "RouterNat",
- "type": "object",
- "description": "Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.",
- "properties": {
- "endpointTypes": {
- "type": "array",
- "description": "List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM",
- "items": {
- "enum": [
- "ENDPOINT_TYPE_SWG",
- "ENDPOINT_TYPE_VM"
- ],
- "enumDescriptions": [
- "This is used for Secure Web Gateway endpoints.",
- "This is the default."
- ],
- "type": "string"
- }
- },
- "natIpAllocateOption": {
- "type": "string",
- "description": "Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. ",
- "enum": [
- "AUTO_ONLY",
- "MANUAL_ONLY"
+ "disks": {
+ "methods": {
+ "resize": {
+ "request": {
+ "$ref": "DisksResizeRequest"
+ },
+ "description": "Resizes the specified persistent disk. You can only increase the size of the disk.",
+ "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/resize",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "Nat IPs are allocated by GCP; customers can not specify any Nat IPs.",
- "Only use Nat IPs provided by customers. When specified Nat IPs are not enough then the Nat service fails for new VMs."
- ]
- },
- "name": {
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035."
- },
- "enableDynamicPortAllocation": {
- "description": "Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config. ",
- "type": "boolean"
- },
- "natIps": {
- "description": "A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.",
- "type": "array",
- "items": {
- "type": "string"
+ "response": {
+ "$ref": "Operation"
+ },
+ "path": "projects/{project}/zones/{zone}/disks/{disk}/resize",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "disk"
+ ],
+ "id": "compute.disks.resize",
+ "httpMethod": "POST",
+ "parameters": {
+ "project": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request."
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "disk": {
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "The name of the persistent disk.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string",
+ "required": true
+ }
}
},
- "minPortsPerVm": {
- "description": "Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.",
- "format": "int32",
- "type": "integer"
- },
- "icmpIdleTimeoutSec": {
- "type": "integer",
- "format": "int32",
- "description": "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set."
- },
- "sourceSubnetworkIpRangesToNat": {
- "description": "Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.",
- "type": "string",
- "enumDescriptions": [
- "All the IP ranges in every Subnetwork are allowed to Nat.",
- "All the primary IP ranges in every Subnetwork are allowed to Nat.",
- "A list of Subnetworks are allowed to Nat (specified in the field subnetwork below)"
+ "getIamPolicy": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "enum": [
- "ALL_SUBNETWORKS_ALL_IP_RANGES",
- "ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES",
- "LIST_OF_SUBNETWORKS"
- ]
- },
- "logConfig": {
- "$ref": "RouterNatLogConfig",
- "description": "Configure logging on this NAT."
- },
- "tcpTimeWaitTimeoutSec": {
- "type": "integer",
- "format": "int32",
- "description": "Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set."
- },
- "tcpEstablishedIdleTimeoutSec": {
- "type": "integer",
- "description": "Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.",
- "format": "int32"
- },
- "udpIdleTimeoutSec": {
- "description": "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.",
- "format": "int32",
- "type": "integer"
- },
- "enableEndpointIndependentMapping": {
- "type": "boolean"
- },
- "subnetworks": {
- "type": "array",
- "items": {
- "$ref": "RouterNatSubnetworkToNat"
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
},
- "description": "A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above."
- },
- "tcpTransitoryIdleTimeoutSec": {
- "description": "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.",
- "format": "int32",
- "type": "integer"
- },
- "maxPortsPerVm": {
- "format": "int32",
- "type": "integer",
- "description": "Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config."
+ "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
+ "parameters": {
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "optionsRequestedPolicyVersion": {
+ "format": "int32",
+ "description": "Requested IAM Policy version.",
+ "type": "integer",
+ "location": "query"
+ },
+ "resource": {
+ "type": "string",
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "required": true
+ }
+ },
+ "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy",
+ "path": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "id": "compute.disks.getIamPolicy"
},
- "rules": {
- "type": "array",
- "description": "A list of rules associated with this NAT.",
- "items": {
- "$ref": "RouterNatRule"
- }
+ "aggregatedList": {
+ "id": "compute.disks.aggregatedList",
+ "response": {
+ "$ref": "DiskAggregatedList"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "includeAllScopes": {
+ "location": "query",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "type": "boolean"
+ },
+ "maxResults": {
+ "location": "query",
+ "type": "integer",
+ "minimum": "0",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500"
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ }
+ },
+ "flatPath": "projects/{project}/aggregated/disks",
+ "path": "projects/{project}/aggregated/disks",
+ "parameterOrder": [
+ "project"
+ ],
+ "description": "Retrieves an aggregated list of persistent disks."
},
- "drainNatIps": {
- "type": "array",
- "items": {
- "type": "string"
+ "list": {
+ "id": "compute.disks.list",
+ "path": "projects/{project}/zones/{zone}/disks",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "type": "string",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "maxResults": {
+ "default": "500",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "type": "integer",
+ "minimum": "0",
+ "location": "query"
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ }
},
- "description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only."
- }
- }
- },
- "BulkInsertInstanceResourcePerInstanceProperties": {
- "properties": {
- "name": {
- "description": "This field is only temporary. It will be removed. Do not use it.",
- "type": "string"
- }
- },
- "type": "object",
- "id": "BulkInsertInstanceResourcePerInstanceProperties",
- "description": "Per-instance properties to be set on individual instances. To be extended in the future."
- },
- "HttpRedirectAction": {
- "type": "object",
- "id": "HttpRedirectAction",
- "properties": {
- "prefixRedirect": {
- "description": "The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.",
- "type": "string"
+ "response": {
+ "$ref": "DiskList"
+ },
+ "description": "Retrieves a list of persistent disks contained within the specified zone.",
+ "flatPath": "projects/{project}/zones/{zone}/disks",
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "httpMethod": "GET"
},
- "redirectResponseCode": {
- "type": "string",
- "description": "The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained. ",
- "enumDescriptions": [
- "Http Status Code 302 - Found.",
- "Http Status Code 301 - Moved Permanently.",
- "Http Status Code 308 - Permanent Redirect maintaining HTTP method.",
- "Http Status Code 303 - See Other.",
- "Http Status Code 307 - Temporary Redirect maintaining HTTP method."
+ "addResourcePolicies": {
+ "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies",
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.disks.addResourcePolicies",
+ "path": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enum": [
- "FOUND",
- "MOVED_PERMANENTLY_DEFAULT",
- "PERMANENT_REDIRECT",
- "SEE_OTHER",
- "TEMPORARY_REDIRECT"
+ "description": "Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.",
+ "request": {
+ "$ref": "DisksAddResourcePoliciesRequest"
+ },
+ "parameters": {
+ "disk": {
+ "location": "path",
+ "description": "The disk name for this request.",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "zone": {
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "type": "string"
+ },
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "disk"
]
},
- "stripQuery": {
- "type": "boolean",
- "description": "If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. "
- },
- "pathRedirect": {
- "type": "string",
- "description": "The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters."
- },
- "hostRedirect": {
- "type": "string",
- "description": "The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters."
- },
- "httpsRedirect": {
- "type": "boolean",
- "description": "If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false."
- }
- },
- "description": "Specifies settings for an HTTP redirect."
- },
- "DisksResizeRequest": {
- "type": "object",
- "properties": {
- "sizeGb": {
- "type": "string",
- "format": "int64",
- "description": "The new size of the persistent disk, which is specified in GB."
- }
- },
- "id": "DisksResizeRequest"
- },
- "NotificationEndpointGrpcSettings": {
- "description": "Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint.",
- "id": "NotificationEndpointGrpcSettings",
- "type": "object",
- "properties": {
- "endpoint": {
- "description": "Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name.",
- "type": "string"
- },
- "resendInterval": {
- "description": "Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. Can only be set for regional notification endpoints.",
- "$ref": "Duration"
- },
- "authority": {
- "type": "string",
- "description": "Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3"
+ "get": {
+ "parameters": {
+ "project": {
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ },
+ "disk": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "type": "string",
+ "description": "Name of the persistent disk to return.",
+ "required": true
+ },
+ "zone": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "description": "The name of the zone for this request."
+ }
+ },
+ "description": "Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request.",
+ "flatPath": "projects/{project}/zones/{zone}/disks/{disk}",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "disk"
+ ],
+ "response": {
+ "$ref": "Disk"
+ },
+ "httpMethod": "GET",
+ "path": "projects/{project}/zones/{zone}/disks/{disk}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "id": "compute.disks.get"
},
- "retryDurationSec": {
- "type": "integer",
- "format": "uint32",
- "description": "How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number."
+ "setLabels": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "path": "projects/{project}/zones/{zone}/disks/{resource}/setLabels",
+ "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/setLabels",
+ "id": "compute.disks.setLabels",
+ "response": {
+ "$ref": "Operation"
+ },
+ "request": {
+ "$ref": "ZoneSetLabelsRequest"
+ },
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "resource": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "description": "Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation."
},
- "payloadName": {
- "description": "Optional. If specified, this field is used to populate the \"name\" field in gRPC requests.",
- "type": "string"
- }
- }
- },
- "NodeGroupsScopedList": {
- "type": "object",
- "properties": {
- "warning": {
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "createSnapshot": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.disks.createSnapshot",
+ "httpMethod": "POST",
+ "path": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "zone",
+ "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.",
+ "request": {
+ "$ref": "Snapshot"
+ },
+ "parameters": {
+ "guestFlush": {
+ "location": "query",
+ "type": "boolean",
+ "description": "[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process."
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ]
+ "description": "Project ID for this request.",
+ "location": "path"
},
- "message": {
+ "zone": {
+ "location": "path",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "type": "string"
+ },
+ "disk": {
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the persistent disk to snapshot."
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- }
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
}
},
- "type": "object",
- "description": "[Output Only] An informational warning that appears when the nodeGroup list is empty."
+ "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot"
},
- "nodeGroups": {
- "items": {
- "$ref": "NodeGroup"
+ "removeResourcePolicies": {
+ "path": "projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies",
+ "description": "Removes resource policies from a disk.",
+ "request": {
+ "$ref": "DisksRemoveResourcePoliciesRequest"
},
- "type": "array",
- "description": "[Output Only] A list of node groups contained in this scope."
- }
- },
- "id": "NodeGroupsScopedList"
- },
- "DiskType": {
- "properties": {
- "description": {
- "description": "[Output Only] An optional description of this resource.",
- "type": "string"
- },
- "validDiskSize": {
- "description": "[Output Only] An optional textual description of the valid disk size, such as \"10GB-10TB\".",
- "type": "string"
- },
- "name": {
- "description": "[Output Only] Name of the resource.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "kind": {
- "default": "compute#diskType",
- "description": "[Output Only] Type of the resource. Always compute#diskType for disk types.",
- "type": "string"
- },
- "deprecated": {
- "description": "[Output Only] The deprecation status associated with this disk type.",
- "$ref": "DeprecationStatus"
- },
- "defaultDiskSizeGb": {
- "format": "int64",
- "description": "[Output Only] Server-defined default disk size in GB.",
- "type": "string"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "region": {
- "type": "string",
- "description": "[Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
- },
- "zone": {
- "type": "string",
- "description": "[Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body."
- },
- "id": {
- "format": "uint64",
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "type": "string"
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
- }
- },
- "id": "DiskType",
- "description": "Represents a Disk Type resource. Google Compute Engine has two Disk Type resources: * [Regional](/compute/docs/reference/rest/v1/regionDiskTypes) * [Zonal](/compute/docs/reference/rest/v1/diskTypes) You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks.",
- "type": "object"
- },
- "ShareSettingsProjectConfig": {
- "type": "object",
- "id": "ShareSettingsProjectConfig",
- "description": "Config for each project in the share settings.",
- "properties": {
- "projectId": {
- "type": "string",
- "description": "The project ID, should be same as the key of this project config in the parent map."
- }
- }
- },
- "InstancesSetLabelsRequest": {
- "properties": {
- "labelFingerprint": {
- "description": "Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.",
- "format": "byte",
- "type": "string"
- },
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "id": "InstancesSetLabelsRequest",
- "type": "object"
- },
- "FirewallPolicyList": {
- "id": "FirewallPolicyList",
- "type": "object",
- "properties": {
- "items": {
- "description": "A list of FirewallPolicy resources.",
- "items": {
- "$ref": "FirewallPolicy"
+ "parameterOrder": [
+ "project",
+ "zone",
+ "disk"
+ ],
+ "parameters": {
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "disk": {
+ "description": "The disk name for this request.",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "The name of the zone for this request."
+ }
},
- "type": "array"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "kind": {
- "type": "string",
- "default": "compute#firewallPolicyList",
- "description": "[Output Only] Type of resource. Always compute#firewallPolicyList for listsof FirewallPolicies"
+ "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "id": "compute.disks.removeResourcePolicies",
+ "response": {
+ "$ref": "Operation"
+ }
},
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "type": "object",
- "properties": {
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
"type": "string"
},
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "disk": {
+ "type": "string",
+ "description": "Name of the persistent disk to delete.",
+ "required": true,
+ "location": "path"
+ },
+ "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).",
+ "location": "query",
"type": "string"
},
- "data": {
- "items": {
- "properties": {
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- },
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- }
- },
- "type": "object"
- },
- "type": "array",
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "zone": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "required": true,
+ "description": "The name of the zone for this request."
}
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- }
- }
- },
- "PacketMirroring": {
- "description": "Represents a Packet Mirroring resource. Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring.",
- "id": "PacketMirroring",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "priority": {
- "type": "integer",
- "description": "The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.",
- "format": "uint32"
- },
- "mirroredResources": {
- "description": "PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.",
- "$ref": "PacketMirroringMirroredResourceInfo"
- },
- "filter": {
- "description": "Filter for mirrored traffic. If unspecified, all traffic is mirrored.",
- "$ref": "PacketMirroringFilter"
- },
- "name": {
- "annotations": {
- "required": [
- "compute.packetMirrorings.insert"
- ]
},
- "type": "string",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "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."
- },
- "kind": {
- "type": "string",
- "default": "compute#packetMirroring",
- "description": "[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- },
- "collectorIlb": {
- "$ref": "PacketMirroringForwardingRuleInfo",
- "description": "The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true."
- },
- "creationTimestamp": {
- "type": "string",
- "description": "[Output Only] Creation timestamp in RFC3339 text format."
+ "description": "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.",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "disk"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.disks.delete",
+ "flatPath": "projects/{project}/zones/{zone}/disks/{disk}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/zones/{zone}/disks/{disk}"
},
- "region": {
- "description": "[Output Only] URI of the region where the packetMirroring resides.",
- "type": "string"
+ "setIamPolicy": {
+ "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "path": "projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "request": {
+ "$ref": "ZoneSetPolicyRequest"
+ },
+ "parameters": {
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "resource": {
+ "required": true,
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ }
+ },
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Policy"
+ },
+ "id": "compute.disks.setIamPolicy"
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
+ "insert": {
+ "parameters": {
+ "project": {
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
+ },
+ "sourceImage": {
+ "location": "query",
+ "type": "string",
+ "description": "Source image to restore onto a disk. This field is optional."
+ },
+ "zone": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "type": "string",
+ "location": "path",
+ "required": true
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "zone"
+ ],
+ "description": "Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "Disk"
+ },
+ "flatPath": "projects/{project}/zones/{zone}/disks",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.disks.insert",
+ "path": "projects/{project}/zones/{zone}/disks"
},
- "network": {
- "annotations": {
- "required": [
- "compute.packetMirrorings.insert"
- ]
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "parameters": {
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "description": "The name of the zone for this request.",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Project ID for this request."
+ }
},
- "description": "Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.",
- "$ref": "PacketMirroringNetworkInfo"
- },
- "enable": {
- "enum": [
- "FALSE",
- "TRUE"
- ],
- "enumDescriptions": [
- "",
- ""
+ "path": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions",
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "httpMethod": "POST",
+ "id": "compute.disks.testIamPermissions",
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
],
- "type": "string",
- "description": "Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
}
},
- "NetworksUpdatePeeringRequest": {
- "properties": {
- "networkPeering": {
- "$ref": "NetworkPeering"
- }
- },
- "type": "object",
- "id": "NetworksUpdatePeeringRequest"
- },
- "Quota": {
- "id": "Quota",
- "description": "A quotas entry.",
- "type": "object",
- "properties": {
- "owner": {
- "type": "string",
- "description": "[Output Only] Owning resource. This is the resource on which this quota is applied."
- },
- "usage": {
- "description": "[Output Only] Current usage of this metric.",
- "format": "double",
- "type": "number"
- },
- "metric": {
- "enum": [
- "A2_CPUS",
- "AFFINITY_GROUPS",
- "AUTOSCALERS",
- "BACKEND_BUCKETS",
- "BACKEND_SERVICES",
- "C2D_CPUS",
- "C2_CPUS",
- "C3_CPUS",
- "COMMITMENTS",
- "COMMITTED_A2_CPUS",
- "COMMITTED_C2D_CPUS",
- "COMMITTED_C2_CPUS",
- "COMMITTED_C3_CPUS",
- "COMMITTED_CPUS",
- "COMMITTED_E2_CPUS",
- "COMMITTED_LICENSES",
- "COMMITTED_LOCAL_SSD_TOTAL_GB",
- "COMMITTED_M3_CPUS",
- "COMMITTED_MEMORY_OPTIMIZED_CPUS",
- "COMMITTED_N2A_CPUS",
- "COMMITTED_N2D_CPUS",
- "COMMITTED_N2_CPUS",
- "COMMITTED_NVIDIA_A100_80GB_GPUS",
- "COMMITTED_NVIDIA_A100_GPUS",
- "COMMITTED_NVIDIA_K80_GPUS",
- "COMMITTED_NVIDIA_P100_GPUS",
- "COMMITTED_NVIDIA_P4_GPUS",
- "COMMITTED_NVIDIA_T4_GPUS",
- "COMMITTED_NVIDIA_V100_GPUS",
- "COMMITTED_T2A_CPUS",
- "COMMITTED_T2D_CPUS",
- "CPUS",
- "CPUS_ALL_REGIONS",
- "DISKS_TOTAL_GB",
- "E2_CPUS",
- "EXTERNAL_MANAGED_FORWARDING_RULES",
- "EXTERNAL_NETWORK_LB_FORWARDING_RULES",
- "EXTERNAL_PROTOCOL_FORWARDING_RULES",
- "EXTERNAL_VPN_GATEWAYS",
- "FIREWALLS",
- "FORWARDING_RULES",
- "GLOBAL_EXTERNAL_MANAGED_BACKEND_SERVICES",
- "GLOBAL_EXTERNAL_MANAGED_FORWARDING_RULES",
- "GLOBAL_EXTERNAL_PROXY_LB_BACKEND_SERVICES",
- "GLOBAL_INTERNAL_ADDRESSES",
- "GLOBAL_INTERNAL_MANAGED_BACKEND_SERVICES",
- "GLOBAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES",
- "GPUS_ALL_REGIONS",
- "HEALTH_CHECKS",
- "IMAGES",
- "INSTANCES",
- "INSTANCE_GROUPS",
- "INSTANCE_GROUP_MANAGERS",
- "INSTANCE_TEMPLATES",
- "INTERCONNECTS",
- "INTERCONNECT_ATTACHMENTS_PER_REGION",
- "INTERCONNECT_ATTACHMENTS_TOTAL_MBPS",
- "INTERCONNECT_TOTAL_GBPS",
- "INTERNAL_ADDRESSES",
- "INTERNAL_TRAFFIC_DIRECTOR_FORWARDING_RULES",
- "IN_PLACE_SNAPSHOTS",
- "IN_USE_ADDRESSES",
- "IN_USE_BACKUP_SCHEDULES",
- "IN_USE_SNAPSHOT_SCHEDULES",
- "LOCAL_SSD_TOTAL_GB",
- "M1_CPUS",
- "M2_CPUS",
- "M3_CPUS",
- "MACHINE_IMAGES",
- "N2A_CPUS",
- "N2D_CPUS",
- "N2_CPUS",
- "NETWORKS",
- "NETWORK_ENDPOINT_GROUPS",
- "NETWORK_FIREWALL_POLICIES",
- "NODE_GROUPS",
- "NODE_TEMPLATES",
- "NVIDIA_A100_80GB_GPUS",
- "NVIDIA_A100_GPUS",
- "NVIDIA_K80_GPUS",
- "NVIDIA_P100_GPUS",
- "NVIDIA_P100_VWS_GPUS",
- "NVIDIA_P4_GPUS",
- "NVIDIA_P4_VWS_GPUS",
- "NVIDIA_T4_GPUS",
- "NVIDIA_T4_VWS_GPUS",
- "NVIDIA_V100_GPUS",
- "PACKET_MIRRORINGS",
- "PD_EXTREME_TOTAL_PROVISIONED_IOPS",
- "PREEMPTIBLE_CPUS",
- "PREEMPTIBLE_LOCAL_SSD_GB",
- "PREEMPTIBLE_NVIDIA_A100_80GB_GPUS",
- "PREEMPTIBLE_NVIDIA_A100_GPUS",
- "PREEMPTIBLE_NVIDIA_K80_GPUS",
- "PREEMPTIBLE_NVIDIA_P100_GPUS",
- "PREEMPTIBLE_NVIDIA_P100_VWS_GPUS",
- "PREEMPTIBLE_NVIDIA_P4_GPUS",
- "PREEMPTIBLE_NVIDIA_P4_VWS_GPUS",
- "PREEMPTIBLE_NVIDIA_T4_GPUS",
- "PREEMPTIBLE_NVIDIA_T4_VWS_GPUS",
- "PREEMPTIBLE_NVIDIA_V100_GPUS",
- "PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK",
- "PSC_INTERNAL_LB_FORWARDING_RULES",
- "PUBLIC_ADVERTISED_PREFIXES",
- "PUBLIC_DELEGATED_PREFIXES",
- "REGIONAL_AUTOSCALERS",
- "REGIONAL_EXTERNAL_MANAGED_BACKEND_SERVICES",
- "REGIONAL_EXTERNAL_NETWORK_LB_BACKEND_SERVICES",
- "REGIONAL_INSTANCE_GROUP_MANAGERS",
- "REGIONAL_INTERNAL_LB_BACKEND_SERVICES",
- "REGIONAL_INTERNAL_MANAGED_BACKEND_SERVICES",
- "RESERVATIONS",
- "RESOURCE_POLICIES",
- "ROUTERS",
- "ROUTES",
- "SECURITY_POLICIES",
- "SECURITY_POLICIES_PER_REGION",
- "SECURITY_POLICY_CEVAL_RULES",
- "SECURITY_POLICY_RULES",
- "SECURITY_POLICY_RULES_PER_REGION",
- "SERVICE_ATTACHMENTS",
- "SNAPSHOTS",
- "SSD_TOTAL_GB",
- "SSL_CERTIFICATES",
- "STATIC_ADDRESSES",
- "STATIC_BYOIP_ADDRESSES",
- "STATIC_EXTERNAL_IPV6_ADDRESS_RANGES",
- "SUBNETWORKS",
- "T2A_CPUS",
- "T2D_CPUS",
- "TARGET_HTTPS_PROXIES",
- "TARGET_HTTP_PROXIES",
- "TARGET_INSTANCES",
- "TARGET_POOLS",
- "TARGET_SSL_PROXIES",
- "TARGET_TCP_PROXIES",
- "TARGET_VPN_GATEWAYS",
- "URL_MAPS",
- "VPN_GATEWAYS",
- "VPN_TUNNELS",
- "XPN_SERVICE_PROJECTS"
+ "urlMaps": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "description": "Deletes the specified UrlMap resource.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "flatPath": "projects/{project}/global/urlMaps/{urlMap}",
+ "path": "projects/{project}/global/urlMaps/{urlMap}",
+ "id": "compute.urlMaps.delete",
+ "parameterOrder": [
+ "project",
+ "urlMap"
],
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "Guest CPUs",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "The total number of snapshots allowed for a single project.",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- ""
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "description": "[Output Only] Name of the quota metric."
+ "parameters": {
+ "urlMap": {
+ "type": "string",
+ "description": "Name of the UrlMap resource to delete.",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string"
+ }
+ }
},
- "limit": {
- "type": "number",
- "format": "double",
- "description": "[Output Only] Quota limit for this metric."
- }
- }
- },
- "HealthCheckList": {
- "properties": {
- "warning": {
- "type": "object",
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "message": {
+ "aggregatedList": {
+ "flatPath": "projects/{project}/aggregated/urlMaps",
+ "path": "projects/{project}/aggregated/urlMaps",
+ "parameterOrder": [
+ "project"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "description": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project.",
+ "id": "compute.urlMaps.aggregatedList",
+ "httpMethod": "GET",
+ "parameters": {
+ "project": {
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "required": true,
+ "description": "Name of the project scoping this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
},
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "includeAllScopes": {
+ "type": "boolean",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query"
+ },
+ "filter": {
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "maxResults": {
+ "type": "integer",
+ "location": "query",
+ "minimum": "0",
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32"
}
+ },
+ "response": {
+ "$ref": "UrlMapsAggregatedList"
}
},
- "items": {
- "items": {
- "$ref": "HealthCheck"
+ "patch": {
+ "parameters": {
+ "project": {
+ "required": true,
+ "description": "Project ID for this request.",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ },
+ "urlMap": {
+ "required": true,
+ "description": "Name of the UrlMap resource to patch.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "location": "path"
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ }
},
- "description": "A list of HealthCheck resources.",
- "type": "array"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- },
- "kind": {
- "description": "Type of resource.",
- "type": "string",
- "default": "compute#healthCheckList"
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- },
- "description": "Contains a list of HealthCheck resources.",
- "id": "HealthCheckList",
- "type": "object"
- },
- "TargetHttpProxy": {
- "type": "object",
- "description": "Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.",
- "properties": {
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for the resource."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- },
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "description": {
- "description": "An optional description of this resource. Provide this property when you create the resource.",
- "type": "string"
- },
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string",
- "description": "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."
- },
- "proxyBind": {
- "type": "boolean",
- "description": "This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false."
- },
- "region": {
- "description": "[Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.",
- "type": "string"
- },
- "urlMap": {
- "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService.",
- "type": "string"
- },
- "fingerprint": {
- "description": "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 TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.",
- "type": "string",
- "format": "byte"
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.",
- "type": "string",
- "default": "compute#targetHttpProxy"
- }
- },
- "id": "TargetHttpProxy"
- },
- "SourceInstanceProperties": {
- "properties": {
- "machineType": {
- "type": "string",
- "description": "The machine type to use for instances that are created from this machine image."
- },
- "keyRevocationActionType": {
- "enum": [
- "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED",
- "NONE",
- "STOP"
+ "description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
+ "path": "projects/{project}/global/urlMaps/{urlMap}",
+ "request": {
+ "$ref": "UrlMap"
+ },
+ "flatPath": "projects/{project}/global/urlMaps/{urlMap}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "Indicates user chose no operation.",
- "Indicates user chose to opt for VM shutdown on key revocation."
+ "id": "compute.urlMaps.patch",
+ "parameterOrder": [
+ "project",
+ "urlMap"
],
- "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.",
- "type": "string"
- },
- "deletionProtection": {
- "type": "boolean",
- "description": "Whether the instance created from this machine image should be protected against deletion."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
+ "response": {
+ "$ref": "Operation"
},
- "description": "Labels to apply to instances that are created from this machine image.",
- "type": "object"
- },
- "minCpuPlatform": {
- "description": "Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.",
- "type": "string"
- },
- "canIpForward": {
- "description": "Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.",
- "type": "boolean"
+ "httpMethod": "PATCH"
},
- "guestAccelerators": {
- "items": {
- "$ref": "AcceleratorConfig"
+ "update": {
+ "flatPath": "projects/{project}/global/urlMaps/{urlMap}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "urlMap"
+ ],
+ "parameters": {
+ "project": {
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true
+ },
+ "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).",
+ "type": "string",
+ "location": "query"
+ },
+ "urlMap": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "description": "Name of the UrlMap resource to update."
+ }
},
- "description": "A list of guest accelerator cards' type and count to use for instances created from this machine image.",
- "type": "array"
- },
- "tags": {
- "$ref": "Tags",
- "description": "A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035."
- },
- "scheduling": {
- "description": "Specifies the scheduling options for the instances that are created from this machine image.",
- "$ref": "Scheduling"
+ "request": {
+ "$ref": "UrlMap"
+ },
+ "description": "Updates the specified UrlMap resource with the data included in the request.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "id": "compute.urlMaps.update",
+ "path": "projects/{project}/global/urlMaps/{urlMap}",
+ "httpMethod": "PUT"
},
- "description": {
- "description": "An optional text description for the instances that are created from this machine image.",
- "type": "string"
+ "list": {
+ "description": "Retrieves the list of UrlMap resources available to the specified project.",
+ "path": "projects/{project}/global/urlMaps",
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "maxResults": {
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "default": "500",
+ "format": "uint32",
+ "location": "query",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "project": {
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "UrlMapList"
+ },
+ "flatPath": "projects/{project}/global/urlMaps",
+ "httpMethod": "GET",
+ "id": "compute.urlMaps.list"
},
- "serviceAccounts": {
- "items": {
- "$ref": "ServiceAccount"
+ "get": {
+ "response": {
+ "$ref": "UrlMap"
},
- "type": "array",
- "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances."
+ "id": "compute.urlMaps.get",
+ "path": "projects/{project}/global/urlMaps/{urlMap}",
+ "parameters": {
+ "urlMap": {
+ "description": "Name of the UrlMap resource to return.",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "urlMap"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "flatPath": "projects/{project}/global/urlMaps/{urlMap}",
+ "description": "Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request."
},
- "networkInterfaces": {
- "description": "An array of network access configurations for this interface.",
- "type": "array",
- "items": {
- "$ref": "NetworkInterface"
- }
+ "insert": {
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "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"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "id": "compute.urlMaps.insert",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project"
+ ],
+ "request": {
+ "$ref": "UrlMap"
+ },
+ "path": "projects/{project}/global/urlMaps",
+ "httpMethod": "POST",
+ "description": "Creates a UrlMap resource in the specified project using the data included in the request.",
+ "flatPath": "projects/{project}/global/urlMaps"
},
- "metadata": {
- "$ref": "Metadata",
- "description": "The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information."
+ "validate": {
+ "parameterOrder": [
+ "project",
+ "urlMap"
+ ],
+ "description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.",
+ "request": {
+ "$ref": "UrlMapsValidateRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "httpMethod": "POST",
+ "path": "projects/{project}/global/urlMaps/{urlMap}/validate",
+ "flatPath": "projects/{project}/global/urlMaps/{urlMap}/validate",
+ "parameters": {
+ "urlMap": {
+ "required": true,
+ "location": "path",
+ "description": "Name of the UrlMap resource to be validated as.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "description": "Project ID for this request."
+ }
+ },
+ "response": {
+ "$ref": "UrlMapsValidateResponse"
+ },
+ "id": "compute.urlMaps.validate"
},
- "disks": {
- "type": "array",
- "items": {
- "$ref": "SavedAttachedDisk"
+ "invalidateCache": {
+ "response": {
+ "$ref": "Operation"
},
- "description": "An array of disks that are associated with the instances that are created from this machine image."
+ "parameters": {
+ "requestId": {
+ "type": "string",
+ "location": "query",
+ "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)."
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "urlMap": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "description": "Name of the UrlMap scoping this request.",
+ "location": "path"
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "urlMap"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "path": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache",
+ "id": "compute.urlMaps.invalidateCache",
+ "flatPath": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache",
+ "description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).",
+ "request": {
+ "$ref": "CacheInvalidationRule"
+ },
+ "httpMethod": "POST"
}
- },
- "id": "SourceInstanceProperties",
- "type": "object",
- "description": "DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field."
+ }
},
- "NodeTemplatesScopedList": {
- "type": "object",
- "properties": {
- "nodeTemplates": {
- "description": "[Output Only] A list of node templates contained in this scope.",
- "type": "array",
- "items": {
- "$ref": "NodeTemplate"
- }
- },
- "warning": {
- "type": "object",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
+ "interconnectLocations": {
+ "methods": {
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "location": "query",
"type": "string"
},
- "data": {
- "type": "array",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "maxResults": {
+ "default": "500",
+ "minimum": "0",
+ "type": "integer",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "location": "query"
+ },
+ "project": {
+ "type": "string",
+ "required": true,
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
"type": "string"
}
},
- "description": "[Output Only] An informational warning that appears when the node templates list is empty."
- }
- },
- "id": "NodeTemplatesScopedList"
- },
- "ServiceAccount": {
- "id": "ServiceAccount",
- "type": "object",
- "properties": {
- "scopes": {
- "description": "The list of scopes to be made available for this service account.",
- "items": {
- "type": "string"
+ "path": "projects/{project}/global/interconnectLocations",
+ "response": {
+ "$ref": "InterconnectLocationList"
},
- "type": "array"
+ "description": "Retrieves the list of interconnect locations available to the specified project.",
+ "parameterOrder": [
+ "project"
+ ],
+ "flatPath": "projects/{project}/global/interconnectLocations",
+ "id": "compute.interconnectLocations.list"
},
- "email": {
- "description": "Email address of the service account.",
- "type": "string"
- }
- },
- "description": "A service account."
- },
- "SchedulingNodeAffinity": {
- "properties": {
- "operator": {
- "enum": [
- "IN",
- "NOT_IN",
- "OPERATOR_UNSPECIFIED"
+ "get": {
+ "id": "compute.interconnectLocations.get",
+ "path": "projects/{project}/global/interconnectLocations/{interconnectLocation}",
+ "response": {
+ "$ref": "InterconnectLocation"
+ },
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "description": "Project ID for this request."
+ },
+ "interconnectLocation": {
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name of the interconnect location to return.",
+ "required": true
+ }
+ },
+ "parameterOrder": [
+ "project",
+ "interconnectLocation"
],
- "enumDescriptions": [
- "Requires Compute Engine to seek for matched nodes.",
- "Requires Compute Engine to avoid certain nodes.",
- ""
+ "description": "Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
],
- "type": "string",
- "description": "Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity."
- },
- "values": {
- "description": "Corresponds to the label values of Node resource.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "key": {
- "type": "string",
- "description": "Corresponds to the label key of Node resource."
- }
- },
- "id": "SchedulingNodeAffinity",
- "description": "Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.",
- "type": "object"
- },
- "OutlierDetection": {
- "type": "object",
- "properties": {
- "enforcingConsecutiveErrors": {
- "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
- "type": "integer",
- "format": "int32"
- },
- "interval": {
- "description": "Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.",
- "$ref": "Duration"
- },
- "successRateRequestVolume": {
- "description": "The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.",
- "format": "int32",
- "type": "integer"
- },
- "enforcingSuccessRate": {
- "format": "int32",
- "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.",
- "type": "integer"
- },
- "successRateStdevFactor": {
- "description": "This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.",
- "format": "int32",
- "type": "integer"
- },
- "successRateMinimumHosts": {
- "description": "The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.",
- "format": "int32",
- "type": "integer"
- },
- "consecutiveErrors": {
- "type": "integer",
- "format": "int32",
- "description": "Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true."
- },
- "enforcingConsecutiveGatewayFailure": {
- "format": "int32",
- "description": "The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.",
- "type": "integer"
- },
- "consecutiveGatewayFailure": {
- "type": "integer",
- "format": "int32",
- "description": "The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true."
- },
- "maxEjectionPercent": {
- "type": "integer",
- "format": "int32",
- "description": "Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%."
- },
- "baseEjectionTime": {
- "description": "The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.",
- "$ref": "Duration"
+ "flatPath": "projects/{project}/global/interconnectLocations/{interconnectLocation}",
+ "httpMethod": "GET"
}
- },
- "description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.",
- "id": "OutlierDetection"
+ }
},
- "VpnGatewaysScopedList": {
- "id": "VpnGatewaysScopedList",
- "properties": {
- "warning": {
- "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
- "properties": {
- "code": {
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
+ "vpnGateways": {
+ "methods": {
+ "aggregatedList": {
+ "parameterOrder": [
+ "project"
+ ],
+ "path": "projects/{project}/aggregated/vpnGateways",
+ "parameters": {
+ "project": {
"type": "string",
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "required": true,
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
},
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
+ "filter": {
+ "type": "string",
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query"
},
- "data": {
- "items": {
- "type": "object",
- "properties": {
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "type": "array"
+ "includeAllScopes": {
+ "type": "boolean",
+ "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.",
+ "location": "query"
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported."
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnPartialSuccess": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "maxResults": {
+ "location": "query",
+ "default": "500",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "minimum": "0",
+ "type": "integer"
}
},
- "type": "object"
- },
- "vpnGateways": {
- "type": "array",
- "description": "[Output Only] A list of VPN gateways contained in this scope.",
- "items": {
- "$ref": "VpnGateway"
- }
- }
- },
- "type": "object"
- },
- "CommitmentAggregatedList": {
- "id": "CommitmentAggregatedList",
- "properties": {
- "unreachables": {
- "description": "[Output Only] Unreachable resources.",
- "items": {
- "type": "string"
+ "id": "compute.vpnGateways.aggregatedList",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "response": {
+ "$ref": "VpnGatewayAggregatedList"
},
- "type": "array"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for this resource.",
- "type": "string"
+ "flatPath": "projects/{project}/aggregated/vpnGateways",
+ "description": "Retrieves an aggregated list of VPN gateways.",
+ "httpMethod": "GET"
},
- "warning": {
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
+ "delete": {
+ "parameters": {
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "location": "path",
+ "description": "Project ID for this request.",
"type": "string"
},
- "data": {
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ",
- "items": {
- "properties": {
- "value": {
- "type": "string",
- "description": "[Output Only] A warning data value corresponding to the key."
- },
- "key": {
- "type": "string",
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
- }
- },
- "type": "object"
- },
- "type": "array"
+ "requestId": {
+ "location": "query",
+ "type": "string",
+ "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)."
},
- "message": {
+ "region": {
+ "description": "Name of the region for this request.",
+ "location": "path",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
+ },
+ "vpnGateway": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Name of the VPN gateway to delete.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- },
- "items": {
- "type": "object",
- "description": "A list of CommitmentsScopedList resources.",
- "additionalProperties": {
- "$ref": "CommitmentsScopedList",
- "description": "[Output Only] Name of the scope containing this set of commitments."
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results."
- },
- "kind": {
- "description": "[Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments.",
- "type": "string",
- "default": "compute#commitmentAggregatedList"
- },
- "id": {
- "type": "string",
- "description": "[Output Only] Unique identifier for the resource; defined by the server."
- }
- },
- "type": "object"
- },
- "AliasIpRange": {
- "properties": {
- "subnetworkRangeName": {
- "description": "The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.",
- "type": "string"
- },
- "ipCidrRange": {
- "type": "string",
- "description": "The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24)."
- }
- },
- "id": "AliasIpRange",
- "description": "An alias IP range attached to an instance's network interface.",
- "type": "object"
- },
- "VpnTunnelAggregatedList": {
- "properties": {
- "items": {
- "description": "A list of VpnTunnelsScopedList resources.",
- "additionalProperties": {
- "description": "Name of the scope containing this set of VPN tunnels.",
- "$ref": "VpnTunnelsScopedList"
- },
- "type": "object"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
- "type": "string"
- },
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
+ "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}",
+ "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}",
+ "id": "compute.vpnGateways.delete",
+ "description": "Deletes the specified VPN gateway.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameterOrder": [
+ "project",
+ "region",
+ "vpnGateway"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE"
},
- "warning": {
- "properties": {
- "message": {
+ "get": {
+ "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}",
+ "parameters": {
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
"type": "string",
- "description": "[Output Only] A human-readable description of the warning code."
+ "description": "Name of the region for this request.",
+ "location": "path"
},
- "code": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"type": "string",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed operation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as deprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as experimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden. Deprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the network.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite the mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "The user attempted to use a resource that requires a TOS they have not accepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted because they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
+ "description": "Project ID for this request."
},
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- }
- },
- "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } "
+ "vpnGateway": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "required": true,
+ "description": "Name of the VPN gateway to return.",
+ "location": "path"
}
},
- "description": "[Output Only] Informational warning message.",
- "type": "object"
- },
- "kind": {
- "default": "compute#vpnTunnelAggregatedList",
- "type": "string",
- "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels."
- },
- "unreachables": {
- "type": "array",
- "items": {
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "region",
+ "vpnGateway"
+ ],
+ "response": {
+ "$ref": "VpnGateway"
},
- "description": "[Output Only] Unreachable resources."
+ "description": "Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.",
+ "id": "compute.vpnGateways.get",
+ "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
},
- "selfLink": {
- "type": "string",
- "description": "[Output Only] Server-defined URL for this resource."
- }
- },
- "id": "VpnTunnelAggregatedList",
- "type": "object"
- },
- "RegionUrlMapsValidateRequest": {
- "type": "object",
- "properties": {
- "resource": {
- "description": "Content of the UrlMap to be validated.",
- "$ref": "UrlMap"
- }
- },
- "id": "RegionUrlMapsValidateRequest"
- },
- "WafExpressionSetExpression": {
- "type": "object",
- "id": "WafExpressionSetExpression",
- "properties": {
- "id": {
- "description": "Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. required",
- "type": "string"
- }
- }
- },
- "VmEndpointNatMappingsInterfaceNatMappings": {
- "description": "Contain information of Nat mapping for an interface of this endpoint.",
- "id": "VmEndpointNatMappingsInterfaceNatMappings",
- "properties": {
- "drainNatIpPortRanges": {
- "items": {
- "type": "string"
+ "setLabels": {
+ "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels",
+ "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.vpnGateways.setLabels",
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "required": true,
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "location": "path",
+ "description": "Name or id of the resource for this request."
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "description": "The region for this request.",
+ "type": "string",
+ "required": true
+ },
+ "project": {
+ "location": "path",
+ "type": "string",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true
+ }
},
- "description": "List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].",
- "type": "array"
- },
- "numTotalNatPorts": {
- "description": "Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges.",
- "type": "integer",
- "format": "int32"
- },
- "natIpPortRanges": {
- "description": "A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "sourceAliasIpRange": {
- "description": "Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: \"10.33.4.55/32\", or \"192.168.5.0/24\".",
- "type": "string"
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "request": {
+ "$ref": "RegionSetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "description": "Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation."
},
- "ruleMappings": {
- "type": "array",
- "description": "Information about mappings provided by rules in this NAT.",
- "items": {
- "$ref": "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings"
+ "insert": {
+ "flatPath": "projects/{project}/regions/{region}/vpnGateways",
+ "description": "Creates a VPN gateway in the specified project and region using the data included in the request.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "path": "projects/{project}/regions/{region}/vpnGateways",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "id": "compute.vpnGateways.insert",
+ "request": {
+ "$ref": "VpnGateway"
+ },
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "parameters": {
+ "region": {
+ "description": "Name of the region for this request.",
+ "type": "string",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true
+ },
+ "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).",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path"
+ }
}
},
- "sourceVirtualIp": {
- "description": "Primary IP of the VM for this NIC.",
- "type": "string"
- },
- "numTotalDrainNatPorts": {
- "format": "int32",
- "type": "integer",
- "description": "Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges."
- }
- },
- "type": "object"
- },
- "HealthCheckService": {
- "properties": {
- "creationTimestamp": {
- "description": "[Output Only] Creation timestamp in RFC3339 text format.",
- "type": "string"
- },
- "healthStatusAggregationPolicy": {
- "description": "Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService.",
- "enumDescriptions": [
- "If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY.",
- "An EndpointHealth message is returned for each backend in the health check service."
+ "getStatus": {
+ "id": "compute.vpnGateways.getStatus",
+ "parameters": {
+ "vpnGateway": {
+ "required": true,
+ "location": "path",
+ "description": "Name of the VPN gateway to return.",
+ "type": "string",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}"
+ },
+ "project": {
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "description": "Project ID for this request.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ },
+ "region": {
+ "required": true,
+ "description": "Name of the region for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ }
+ },
+ "response": {
+ "$ref": "VpnGatewaysGetStatusResponse"
+ },
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus",
+ "description": "Returns the status for the specified VPN gateway.",
+ "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus",
+ "parameterOrder": [
+ "project",
+ "region",
+ "vpnGateway"
],
- "type": "string",
- "enum": [
- "AND",
- "NO_AGGREGATION"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
]
},
- "region": {
- "description": "[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. 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"
- },
- "selfLink": {
- "description": "[Output Only] Server-defined URL for the resource.",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this resource. Provide this property when you create the resource."
- },
- "healthChecks": {
- "type": "array",
- "items": {
- "type": "string"
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestPermissionsRequest"
},
- "description": "A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups."
- },
- "name": {
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "description": "Name of the resource. 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.",
- "type": "string"
- },
- "networkEndpointGroups": {
- "type": "array",
- "items": {
- "type": "string"
+ "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions",
+ "response": {
+ "$ref": "TestPermissionsResponse"
},
- "description": "A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT."
- },
- "id": {
- "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
- "format": "uint64",
- "type": "string"
- },
- "fingerprint": {
- "format": "byte",
- "type": "string",
- "description": "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 HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService."
- },
- "kind": {
- "default": "compute#healthCheckService",
- "description": "[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.",
- "type": "string"
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "id": "compute.vpnGateways.testIamPermissions",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "region": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "location": "path",
+ "type": "string",
+ "description": "The name of the region for this request.",
+ "required": true
+ },
+ "resource": {
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "type": "string",
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "required": true
+ },
+ "project": {
+ "type": "string",
+ "description": "Project ID for this request.",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "required": true
+ }
+ }
},
- "notificationEndpoints": {
- "type": "array",
- "items": {
- "type": "string"
+ "list": {
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "response": {
+ "$ref": "VpnGatewayList"
+ },
+ "path": "projects/{project}/regions/{region}/vpnGateways",
+ "id": "compute.vpnGateways.list",
+ "parameters": {
+ "maxResults": {
+ "location": "query",
+ "format": "uint32",
+ "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
+ "default": "500",
+ "type": "integer",
+ "minimum": "0"
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results."
+ },
+ "project": {
+ "required": true,
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "location": "path",
+ "type": "string",
+ "description": "Project ID for this request."
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.",
+ "type": "string"
+ },
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\u003e`, `\u003c`, `\u003c=`, `\u003e=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.",
+ "location": "query",
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false."
+ },
+ "region": {
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string",
+ "description": "Name of the region for this request.",
+ "required": true
+ }
},
- "description": "A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global."
+ "description": "Retrieves a list of VPN gateways available to the specified project and region.",
+ "httpMethod": "GET",
+ "flatPath": "projects/{project}/regions/{region}/vpnGateways",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
}
- },
- "description": "Represents a Health-Check as a Service resource.",
- "type": "object",
- "id": "HealthCheckService"
+ }
}
},
- "title": "Compute Engine API",
- "protocol": "rest",
+ "description": "Creates and runs virtual machines on Google Cloud Platform. ",
+ "version": "v1",
"id": "compute:v1",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/devstorage.full_control": {
- "description": "Manage your data and permissions in Cloud Storage and see the email address for your Google Account"
+ "https://www.googleapis.com/auth/devstorage.read_write": {
+ "description": "Manage your data in Cloud Storage and see the email address of your Google Account"
+ },
+ "https://www.googleapis.com/auth/devstorage.read_only": {
+ "description": "View your data in Google Cloud Storage"
},
"https://www.googleapis.com/auth/compute": {
"description": "View and manage your Google Compute Engine resources"
},
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
+ "https://www.googleapis.com/auth/devstorage.full_control": {
+ "description": "Manage your data and permissions in Cloud Storage and see the email address for your Google Account"
},
"https://www.googleapis.com/auth/compute.readonly": {
"description": "View your Google Compute Engine resources"
},
- "https://www.googleapis.com/auth/devstorage.read_only": {
- "description": "View your data in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/devstorage.read_write": {
- "description": "Manage your data in Cloud Storage and see the email address of your Google Account"
+ "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."
}
}
}
},
+ "kind": "discovery#restDescription",
+ "documentationLink": "https://cloud.google.com/compute/",
+ "discoveryVersion": "v1",
"ownerName": "Google",
- "revision": "20221126",
- "basePath": "/compute/v1/",
- "description": "Creates and runs virtual machines on Google Cloud Platform. ",
- "rootUrl": "https://compute.googleapis.com/"
+ "name": "compute",
+ "ownerDomain": "google.com"
}
diff --git a/third_party/googleapis/google/cloud/compute/v1/compute_gapic.yaml b/third_party/googleapis/google/cloud/compute/v1/compute_gapic.yaml
index 101e4488f..1fd634126 100755
--- a/third_party/googleapis/google/cloud/compute/v1/compute_gapic.yaml
+++ b/third_party/googleapis/google/cloud/compute/v1/compute_gapic.yaml
@@ -1,4 +1,4 @@
-# Copyright 2022 Google LLC
+# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
# Generated by the disco-to-proto3-converter. DO NOT EDIT!
# Source Discovery file: compute.v1.json
-# Source file revision: 20221126
+# Source file revision: 20230103
# API name: compute
# API version: v1
diff --git a/third_party/googleapis/google/cloud/connectors/v1/BUILD.bazel b/third_party/googleapis/google/cloud/connectors/v1/BUILD.bazel
index 551c7df34..32a97891a 100644
--- a/third_party/googleapis/google/cloud/connectors/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/connectors/v1/BUILD.bazel
@@ -37,6 +37,7 @@ proto_library(
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:struct_proto",
"@com_google_protobuf//:timestamp_proto",
@@ -133,7 +134,7 @@ load(
go_proto_library(
name = "connectors_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/connectors/v1",
+ importpath = "cloud.google.com/go/connectors/apiv1/connectorspb",
protos = [":connectors_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -147,6 +148,7 @@ go_gapic_library(
grpc_service_config = "connectors_grpc_service_config.json",
importpath = "cloud.google.com/go/connectors/apiv1;connectors",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "connectors_v1.yaml",
transport = "grpc+rest",
@@ -195,7 +197,7 @@ py_gapic_library(
grpc_service_config = "connectors_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "connectors_v1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -370,6 +372,7 @@ csharp_gapic_library(
grpc_service_config = "connectors_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "connectors_v1.yaml",
+ transport = "grpc+rest",
deps = [
":connectors_csharp_grpc",
":connectors_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/connectors/v1/authconfig.proto b/third_party/googleapis/google/cloud/connectors/v1/authconfig.proto
index dd2b6baaf..ab845a847 100644
--- a/third_party/googleapis/google/cloud/connectors/v1/authconfig.proto
+++ b/third_party/googleapis/google/cloud/connectors/v1/authconfig.proto
@@ -18,7 +18,7 @@ package google.cloud.connectors.v1;
import "google/cloud/connectors/v1/common.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/connectors/v1;connectors";
+option go_package = "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb";
option java_multiple_files = true;
option java_outer_classname = "AuthConfigProto";
option java_package = "com.google.cloud.connectors.v1";
diff --git a/third_party/googleapis/google/cloud/connectors/v1/common.proto b/third_party/googleapis/google/cloud/connectors/v1/common.proto
index a70ca493e..df91cf913 100644
--- a/third_party/googleapis/google/cloud/connectors/v1/common.proto
+++ b/third_party/googleapis/google/cloud/connectors/v1/common.proto
@@ -19,7 +19,7 @@ package google.cloud.connectors.v1;
import "google/api/field_behavior.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/connectors/v1;connectors";
+option go_package = "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb";
option java_multiple_files = true;
option java_outer_classname = "CommonProto";
option java_package = "com.google.cloud.connectors.v1";
diff --git a/third_party/googleapis/google/cloud/connectors/v1/connection.proto b/third_party/googleapis/google/cloud/connectors/v1/connection.proto
index c0ce7ceaa..3ea13461d 100644
--- a/third_party/googleapis/google/cloud/connectors/v1/connection.proto
+++ b/third_party/googleapis/google/cloud/connectors/v1/connection.proto
@@ -25,7 +25,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/connectors/v1;connectors";
+option go_package = "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb";
option java_multiple_files = true;
option java_outer_classname = "ConnectionProto";
option java_package = "com.google.cloud.connectors.v1";
diff --git a/third_party/googleapis/google/cloud/connectors/v1/connector.proto b/third_party/googleapis/google/cloud/connectors/v1/connector.proto
index 67380ed42..63c8a6e56 100644
--- a/third_party/googleapis/google/cloud/connectors/v1/connector.proto
+++ b/third_party/googleapis/google/cloud/connectors/v1/connector.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/cloud/connectors/v1/common.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/connectors/v1;connectors";
+option go_package = "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb";
option java_multiple_files = true;
option java_outer_classname = "ConnectorProto";
option java_package = "com.google.cloud.connectors.v1";
diff --git a/third_party/googleapis/google/cloud/connectors/v1/connector_version.proto b/third_party/googleapis/google/cloud/connectors/v1/connector_version.proto
index 0db4ce1b2..8ed7bf2a6 100644
--- a/third_party/googleapis/google/cloud/connectors/v1/connector_version.proto
+++ b/third_party/googleapis/google/cloud/connectors/v1/connector_version.proto
@@ -22,7 +22,7 @@ import "google/cloud/connectors/v1/authconfig.proto";
import "google/cloud/connectors/v1/common.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/connectors/v1;connectors";
+option go_package = "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb";
option java_multiple_files = true;
option java_outer_classname = "ConnectorVersionProto";
option java_package = "com.google.cloud.connectors.v1";
diff --git a/third_party/googleapis/google/cloud/connectors/v1/connectors_service.proto b/third_party/googleapis/google/cloud/connectors/v1/connectors_service.proto
index 9e3deb3ce..e56427a61 100644
--- a/third_party/googleapis/google/cloud/connectors/v1/connectors_service.proto
+++ b/third_party/googleapis/google/cloud/connectors/v1/connectors_service.proto
@@ -25,7 +25,7 @@ import "google/cloud/connectors/v1/provider.proto";
import "google/cloud/connectors/v1/runtime.proto";
import "google/longrunning/operations.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/connectors/v1;connectors";
+option go_package = "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb";
option java_multiple_files = true;
option java_outer_classname = "ConnectorsServiceProto";
option java_package = "com.google.cloud.connectors.v1";
diff --git a/third_party/googleapis/google/cloud/connectors/v1/destination_config.proto b/third_party/googleapis/google/cloud/connectors/v1/destination_config.proto
index 79c0d92f0..56fd61da0 100644
--- a/third_party/googleapis/google/cloud/connectors/v1/destination_config.proto
+++ b/third_party/googleapis/google/cloud/connectors/v1/destination_config.proto
@@ -16,7 +16,7 @@ syntax = "proto3";
package google.cloud.connectors.v1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/connectors/v1;connectors";
+option go_package = "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb";
option java_multiple_files = true;
// Define the Connectors target endpoint.
diff --git a/third_party/googleapis/google/cloud/connectors/v1/provider.proto b/third_party/googleapis/google/cloud/connectors/v1/provider.proto
index 08ea21cfa..2e5fb7e30 100644
--- a/third_party/googleapis/google/cloud/connectors/v1/provider.proto
+++ b/third_party/googleapis/google/cloud/connectors/v1/provider.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/cloud/connectors/v1/common.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/connectors/v1;connectors";
+option go_package = "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb";
option java_multiple_files = true;
option java_outer_classname = "ProviderProto";
option java_package = "com.google.cloud.connectors.v1";
diff --git a/third_party/googleapis/google/cloud/connectors/v1/runtime.proto b/third_party/googleapis/google/cloud/connectors/v1/runtime.proto
index 1a7a615d4..68ca7648f 100644
--- a/third_party/googleapis/google/cloud/connectors/v1/runtime.proto
+++ b/third_party/googleapis/google/cloud/connectors/v1/runtime.proto
@@ -19,7 +19,7 @@ package google.cloud.connectors.v1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/connectors/v1;connectors";
+option go_package = "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb";
option java_multiple_files = true;
option java_outer_classname = "RuntimeProto";
option java_package = "com.google.cloud.connectors.v1";
diff --git a/third_party/googleapis/google/cloud/contactcenterinsights/v1/BUILD.bazel b/third_party/googleapis/google/cloud/contactcenterinsights/v1/BUILD.bazel
index 61f30800f..839235312 100644
--- a/third_party/googleapis/google/cloud/contactcenterinsights/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/contactcenterinsights/v1/BUILD.bazel
@@ -119,7 +119,7 @@ load(
go_proto_library(
name = "contactcenterinsights_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/contactcenterinsights/v1",
+ importpath = "cloud.google.com/go/contactcenterinsights/apiv1/contactcenterinsightspb",
protos = [":contactcenterinsights_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -134,6 +134,7 @@ go_gapic_library(
grpc_service_config = "contactcenterinsights_grpc_service_config.json",
importpath = "cloud.google.com/go/contactcenterinsights/apiv1;contactcenterinsights",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "contactcenterinsights_v1.yaml",
transport = "grpc+rest",
@@ -184,7 +185,8 @@ py_gapic_library(
"python-gapic-name=contact_center_insights",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "contactcenterinsights_v1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -315,6 +317,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Contact Center AI Insights helps users detect and visualize patterns in their contact center data. Understanding conversational data drives business value, improves operational efficiency, and provides a voice for customer feedback.",
ruby_cloud_title = "Contact Center AI Insights V1",
+ service_yaml = "contactcenterinsights_v1.yaml",
deps = [
":contactcenterinsights_ruby_grpc",
":contactcenterinsights_ruby_proto",
@@ -360,6 +363,7 @@ csharp_gapic_library(
grpc_service_config = "contactcenterinsights_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "contactcenterinsights_v1.yaml",
+ transport = "grpc+rest",
deps = [
":contactcenterinsights_csharp_grpc",
":contactcenterinsights_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/contactcenterinsights/v1/contact_center_insights.proto b/third_party/googleapis/google/cloud/contactcenterinsights/v1/contact_center_insights.proto
index 1ecf43216..b9f611b78 100644
--- a/third_party/googleapis/google/cloud/contactcenterinsights/v1/contact_center_insights.proto
+++ b/third_party/googleapis/google/cloud/contactcenterinsights/v1/contact_center_insights.proto
@@ -29,7 +29,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.ContactCenterInsights.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contactcenterinsights/v1;contactcenterinsights";
+option go_package = "cloud.google.com/go/contactcenterinsights/apiv1/contactcenterinsightspb;contactcenterinsightspb";
option java_multiple_files = true;
option java_outer_classname = "ContactCenterInsightsProto";
option java_package = "com.google.cloud.contactcenterinsights.v1";
@@ -39,7 +39,8 @@ option ruby_package = "Google::Cloud::ContactCenterInsights::V1";
// An API that lets users analyze and explore their business conversation data.
service ContactCenterInsights {
option (google.api.default_host) = "contactcenterinsights.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a conversation.
rpc CreateConversation(CreateConversationRequest) returns (Conversation) {
@@ -47,7 +48,8 @@ service ContactCenterInsights {
post: "/v1/{parent=projects/*/locations/*}/conversations"
body: "conversation"
};
- option (google.api.method_signature) = "parent,conversation,conversation_id";
+ option (google.api.method_signature) =
+ "parent,conversation,conversation_id";
}
// Updates a conversation.
@@ -68,7 +70,8 @@ service ContactCenterInsights {
}
// Lists conversations.
- rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) {
+ rpc ListConversations(ListConversationsRequest)
+ returns (ListConversationsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/conversations"
};
@@ -76,7 +79,8 @@ service ContactCenterInsights {
}
// Deletes a conversation.
- rpc DeleteConversation(DeleteConversationRequest) returns (google.protobuf.Empty) {
+ rpc DeleteConversation(DeleteConversationRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/conversations/*}"
};
@@ -85,7 +89,8 @@ service ContactCenterInsights {
// Creates an analysis. The long running operation is done when the analysis
// has completed.
- rpc CreateAnalysis(CreateAnalysisRequest) returns (google.longrunning.Operation) {
+ rpc CreateAnalysis(CreateAnalysisRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/conversations/*}/analyses"
body: "analysis"
@@ -122,7 +127,8 @@ service ContactCenterInsights {
}
// Analyzes multiple conversations in a single request.
- rpc BulkAnalyzeConversations(BulkAnalyzeConversationsRequest) returns (google.longrunning.Operation) {
+ rpc BulkAnalyzeConversations(BulkAnalyzeConversationsRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/conversations:bulkAnalyze"
body: "*"
@@ -136,7 +142,8 @@ service ContactCenterInsights {
// Imports conversations and processes them according to the user's
// configuration.
- rpc IngestConversations(IngestConversationsRequest) returns (google.longrunning.Operation) {
+ rpc IngestConversations(IngestConversationsRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/conversations:ingest"
body: "*"
@@ -149,7 +156,8 @@ service ContactCenterInsights {
}
// Export insights data to a destination defined in the request body.
- rpc ExportInsightsData(ExportInsightsDataRequest) returns (google.longrunning.Operation) {
+ rpc ExportInsightsData(ExportInsightsDataRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/insightsdata:export"
body: "*"
@@ -162,7 +170,8 @@ service ContactCenterInsights {
}
// Creates an issue model.
- rpc CreateIssueModel(CreateIssueModelRequest) returns (google.longrunning.Operation) {
+ rpc CreateIssueModel(CreateIssueModelRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/issueModels"
body: "issue_model"
@@ -192,7 +201,8 @@ service ContactCenterInsights {
}
// Lists issue models.
- rpc ListIssueModels(ListIssueModelsRequest) returns (ListIssueModelsResponse) {
+ rpc ListIssueModels(ListIssueModelsRequest)
+ returns (ListIssueModelsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/issueModels"
};
@@ -200,7 +210,8 @@ service ContactCenterInsights {
}
// Deletes an issue model.
- rpc DeleteIssueModel(DeleteIssueModelRequest) returns (google.longrunning.Operation) {
+ rpc DeleteIssueModel(DeleteIssueModelRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/issueModels/*}"
};
@@ -213,7 +224,8 @@ service ContactCenterInsights {
// Deploys an issue model. Returns an error if a model is already deployed.
// An issue model can only be used in analysis after it has been deployed.
- rpc DeployIssueModel(DeployIssueModelRequest) returns (google.longrunning.Operation) {
+ rpc DeployIssueModel(DeployIssueModelRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/issueModels/*}:deploy"
body: "*"
@@ -227,7 +239,8 @@ service ContactCenterInsights {
// Undeploys an issue model.
// An issue model can not be used in analysis after it has been undeployed.
- rpc UndeployIssueModel(UndeployIssueModelRequest) returns (google.longrunning.Operation) {
+ rpc UndeployIssueModel(UndeployIssueModelRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/issueModels/*}:undeploy"
body: "*"
@@ -273,7 +286,8 @@ service ContactCenterInsights {
}
// Gets an issue model's statistics.
- rpc CalculateIssueModelStats(CalculateIssueModelStatsRequest) returns (CalculateIssueModelStatsResponse) {
+ rpc CalculateIssueModelStats(CalculateIssueModelStatsRequest)
+ returns (CalculateIssueModelStatsResponse) {
option (google.api.http) = {
get: "/v1/{issue_model=projects/*/locations/*/issueModels/*}:calculateIssueModelStats"
};
@@ -298,7 +312,8 @@ service ContactCenterInsights {
}
// Lists phrase matchers.
- rpc ListPhraseMatchers(ListPhraseMatchersRequest) returns (ListPhraseMatchersResponse) {
+ rpc ListPhraseMatchers(ListPhraseMatchersRequest)
+ returns (ListPhraseMatchersResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/phraseMatchers"
};
@@ -306,7 +321,8 @@ service ContactCenterInsights {
}
// Deletes a phrase matcher.
- rpc DeletePhraseMatcher(DeletePhraseMatcherRequest) returns (google.protobuf.Empty) {
+ rpc DeletePhraseMatcher(DeletePhraseMatcherRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/phraseMatchers/*}"
};
@@ -479,10 +495,12 @@ message CalculateStatsResponse {
// Metadata for a create analysis operation.
message CreateAnalysisOperationMetadata {
// Output only. The time the operation was created.
- google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the operation finished running.
- google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The Conversation that this Analysis Operation belongs to.
string conversation = 3 [
@@ -493,7 +511,8 @@ message CreateAnalysisOperationMetadata {
];
// Output only. The annotator selector used for the analysis (if any).
- AnnotatorSelector annotator_selector = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ AnnotatorSelector annotator_selector = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Request to create a conversation.
@@ -645,24 +664,51 @@ message IngestConversationsRequest {
// The metadata for an IngestConversations operation.
message IngestConversationsMetadata {
+ // Statistics for IngestConversations operation.
+ message IngestConversationsStats {
+ // Output only. The number of objects processed during the ingest operation.
+ int32 processed_object_count = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The number of objects skipped because another conversation
+ // with the same transcript uri had already been ingested.
+ int32 duplicates_skipped_count = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The number of new conversations added during this ingest
+ // operation.
+ int32 successful_ingest_count = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The number of objects which were unable to be ingested due
+ // to errors. The errors are populated in the partial_errors field.
+ int32 failed_ingest_count = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
// Output only. The time the operation was created.
- google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the operation finished running.
- google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The original request for ingest.
- IngestConversationsRequest request = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ IngestConversationsRequest request = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Partial errors during ingest operation that might cause the operation
- // output to be incomplete.
- repeated google.rpc.Status partial_errors = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Partial errors during ingest operation that might cause the
+ // operation output to be incomplete.
+ repeated google.rpc.Status partial_errors = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Statistics for IngestConversations operation.
+ IngestConversationsStats ingest_conversations_stats = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The response to an IngestConversations operation.
-message IngestConversationsResponse {
-
-}
+message IngestConversationsResponse {}
// The request to create an analysis.
message CreateAnalysisRequest {
@@ -798,9 +844,9 @@ message ExportInsightsDataRequest {
// the resource project will be used.
string project_id = 3;
- // Required. The name of the BigQuery dataset that the snapshot result should be
- // exported to. If this dataset does not exist, the export call returns an
- // INVALID_ARGUMENT error.
+ // Required. The name of the BigQuery dataset that the snapshot result
+ // should be exported to. If this dataset does not exist, the export call
+ // returns an INVALID_ARGUMENT error.
string dataset = 1 [(google.api.field_behavior) = REQUIRED];
// The BigQuery table name to which the insights data should be written.
@@ -852,10 +898,12 @@ message ExportInsightsDataRequest {
// Metadata for an export insights operation.
message ExportInsightsDataMetadata {
// Output only. The time the operation was created.
- google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the operation finished running.
- google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The original request for export.
ExportInsightsDataRequest request = 3;
@@ -866,9 +914,7 @@ message ExportInsightsDataMetadata {
}
// Response for an export insights operation.
-message ExportInsightsDataResponse {
-
-}
+message ExportInsightsDataResponse {}
// The request to create an issue model.
message CreateIssueModelRequest {
@@ -887,10 +933,12 @@ message CreateIssueModelRequest {
// Metadata for creating an issue model.
message CreateIssueModelMetadata {
// Output only. The time the operation was created.
- google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the operation finished running.
- google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The original request for creation.
CreateIssueModelRequest request = 3;
@@ -947,10 +995,12 @@ message DeleteIssueModelRequest {
// Metadata for deleting an issue model.
message DeleteIssueModelMetadata {
// Output only. The time the operation was created.
- google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the operation finished running.
- google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The original request for deletion.
DeleteIssueModelRequest request = 3;
@@ -968,17 +1018,17 @@ message DeployIssueModelRequest {
}
// The response to deploy an issue model.
-message DeployIssueModelResponse {
-
-}
+message DeployIssueModelResponse {}
// Metadata for deploying an issue model.
message DeployIssueModelMetadata {
// Output only. The time the operation was created.
- google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the operation finished running.
- google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The original request for deployment.
DeployIssueModelRequest request = 3;
@@ -996,17 +1046,17 @@ message UndeployIssueModelRequest {
}
// The response to undeploy an issue model.
-message UndeployIssueModelResponse {
-
-}
+message UndeployIssueModelResponse {}
// Metadata for undeploying an issue model.
message UndeployIssueModelMetadata {
// Output only. The time the operation was created.
- google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the operation finished running.
- google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The original request for undeployment.
UndeployIssueModelRequest request = 3;
@@ -1080,10 +1130,10 @@ message CalculateIssueModelStatsResponse {
// Request to create a phrase matcher.
message CreatePhraseMatcherRequest {
- // Required. The parent resource of the phrase matcher. Required. The location to create
- // a phrase matcher for.
- // Format: `projects//locations/` or
- // `projects//locations/`
+ // Required. The parent resource of the phrase matcher. Required. The location
+ // to create a phrase matcher for. Format: `projects//locations/` or `projects//locations/`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -1179,7 +1229,8 @@ message UpdateSettingsRequest {
Settings settings = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The list of fields to be updated.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// The request to create a view.
diff --git a/third_party/googleapis/google/cloud/contactcenterinsights/v1/contactcenterinsights_v1.yaml b/third_party/googleapis/google/cloud/contactcenterinsights/v1/contactcenterinsights_v1.yaml
index c610755bd..1cb93088a 100644
--- a/third_party/googleapis/google/cloud/contactcenterinsights/v1/contactcenterinsights_v1.yaml
+++ b/third_party/googleapis/google/cloud/contactcenterinsights/v1/contactcenterinsights_v1.yaml
@@ -44,3 +44,10 @@ authentication:
publishing:
organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED
+ new_issue_uri: ''
+ documentation_uri: ''
+ api_short_name: ''
+ github_label: ''
+ doc_tag_prefix: ''
+ codeowner_github_teams:
+ library_settings:
diff --git a/third_party/googleapis/google/cloud/contactcenterinsights/v1/resources.proto b/third_party/googleapis/google/cloud/contactcenterinsights/v1/resources.proto
index 715eff611..966680be1 100644
--- a/third_party/googleapis/google/cloud/contactcenterinsights/v1/resources.proto
+++ b/third_party/googleapis/google/cloud/contactcenterinsights/v1/resources.proto
@@ -22,7 +22,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.ContactCenterInsights.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contactcenterinsights/v1;contactcenterinsights";
+option go_package = "cloud.google.com/go/contactcenterinsights/apiv1/contactcenterinsightspb;contactcenterinsightspb";
option java_multiple_files = true;
option java_outer_classname = "ResourcesProto";
option java_package = "com.google.cloud.contactcenterinsights.v1";
@@ -146,7 +146,8 @@ message Conversation {
// Input only. The TTL for this resource. If specified, then this TTL will
// be used to calculate the expire time.
- google.protobuf.Duration ttl = 16 [(google.api.field_behavior) = INPUT_ONLY];
+ google.protobuf.Duration ttl = 16
+ [(google.api.field_behavior) = INPUT_ONLY];
}
// Immutable. The resource name of the conversation.
@@ -158,10 +159,12 @@ message Conversation {
ConversationDataSource data_source = 2;
// Output only. The time at which the conversation was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The most recent time at which the conversation was updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The time at which the conversation started.
google.protobuf.Timestamp start_time = 17;
@@ -180,11 +183,13 @@ message Conversation {
// Output only. The conversation transcript.
Transcript transcript = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
+ // Immutable. The conversation medium, if unspecified will default to
+ // PHONE_CALL.
Medium medium = 9 [(google.api.field_behavior) = IMMUTABLE];
// Output only. The duration of the conversation.
- google.protobuf.Duration duration = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Duration duration = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The number of turns in the conversation.
int32 turn_count = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -192,14 +197,16 @@ message Conversation {
// Output only. The conversation's latest analysis, if one exists.
Analysis latest_analysis = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The annotations that were generated during the customer and agent
- // interaction.
- repeated RuntimeAnnotation runtime_annotations = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The annotations that were generated during the customer and
+ // agent interaction.
+ repeated RuntimeAnnotation runtime_annotations = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. All the matched Dialogflow intents in the call. The key corresponds to a
- // Dialogflow intent, format:
+ // Output only. All the matched Dialogflow intents in the call. The key
+ // corresponds to a Dialogflow intent, format:
// projects/{project}/agent/{agent}/intents/{intent}
- map dialogflow_intents = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
+ map dialogflow_intents = 18
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Obfuscated user ID which the customer sent to us.
string obfuscated_user_id = 21;
@@ -218,15 +225,18 @@ message Analysis {
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
// Output only. The time at which the analysis was requested.
- google.protobuf.Timestamp request_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp request_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The time at which the analysis was created, which occurs when the
- // long-running operation completes.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The time at which the analysis was created, which occurs when
+ // the long-running operation completes.
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The result of the analysis, which is populated when the analysis
- // finishes.
- AnalysisResult analysis_result = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The result of the analysis, which is populated when the
+ // analysis finishes.
+ AnalysisResult analysis_result = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// To select the annotators to run and the phrase matchers to use
// (if any). If not specified, all annotators will be run.
@@ -251,8 +261,8 @@ message GcsSource {
// audio.
string audio_uri = 1;
- // Immutable. Cloud Storage URI that points to a file that contains the conversation
- // transcript.
+ // Immutable. Cloud Storage URI that points to a file that contains the
+ // conversation transcript.
string transcript_uri = 2 [(google.api.field_behavior) = IMMUTABLE];
}
@@ -261,7 +271,8 @@ message DialogflowSource {
// Output only. The name of the Dialogflow conversation that this conversation
// resource is derived from. Format:
// projects/{project}/locations/{location}/conversations/{conversation}
- string dialogflow_conversation = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ string dialogflow_conversation = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Cloud Storage URI that points to a file that contains the conversation
// audio.
@@ -306,8 +317,8 @@ message IssueModelResult {
// Issue model that generates the result.
// Format: projects/{project}/locations/{location}/issueModels/{issue_model}
string issue_model = 1 [(google.api.resource_reference) = {
- type: "contactcenterinsights.googleapis.com/IssueModel"
- }];
+ type: "contactcenterinsights.googleapis.com/IssueModel"
+ }];
// All the matched issues.
repeated IssueAssignment issues = 2;
@@ -331,8 +342,8 @@ message IssueAssignment {
// currently bounded on [0,1].
double score = 2;
- // Immutable. Display name of the assigned issue. This field is set at time of analyis
- // and immutable since then.
+ // Immutable. Display name of the assigned issue. This field is set at time of
+ // analyis and immutable since then.
string display_name = 3 [(google.api.field_behavior) = IMMUTABLE];
}
@@ -526,19 +537,13 @@ message DialogflowIntent {
}
// The data for an interruption annotation.
-message InterruptionData {
-
-}
+message InterruptionData {}
// The data for a silence annotation.
-message SilenceData {
-
-}
+message SilenceData {}
// The data for a hold annotation.
-message HoldData {
-
-}
+message HoldData {}
// The data for an entity mention annotation.
// This represents a mention of an `Entity` in the conversation.
@@ -607,7 +612,8 @@ message IssueModel {
Conversation.Medium medium = 1 [deprecated = true];
// Output only. Number of conversations used in training. Output only.
- int64 training_conversations_count = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ int64 training_conversations_count = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// A filter to reduce the conversations used for training the model to a
// specific subset.
@@ -645,10 +651,15 @@ message IssueModel {
string display_name = 2;
// Output only. The time at which this issue model was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The most recent time at which the issue model was updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Number of issues in this issue model.
+ int64 issue_count = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. State of the model.
State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -656,7 +667,8 @@ message IssueModel {
// Configs for the input data that used to create the issue model.
InputDataConfig input_data_config = 6;
- // Output only. Immutable. The issue model's label statistics on its training data.
+ // Output only. Immutable. The issue model's label statistics on its training
+ // data.
IssueModelLabelStats training_stats = 7 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.field_behavior) = IMMUTABLE
@@ -679,14 +691,17 @@ message Issue {
string display_name = 2;
// Output only. The time at which this issue was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The most recent time that this issue was updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Resource names of the sample representative utterances that match to this
- // issue.
- repeated string sample_utterances = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. Resource names of the sample representative utterances that
+ // match to this issue.
+ repeated string sample_utterances = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Aggregated statistics about an issue model.
@@ -754,9 +769,10 @@ message PhraseMatcher {
// it will default to `revision_id`.
string version_tag = 3;
- // Output only. The timestamp of when the revision was created. It is also the create time
- // when a new matcher is added.
- google.protobuf.Timestamp revision_create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The timestamp of when the revision was created. It is also the
+ // create time when a new matcher is added.
+ google.protobuf.Timestamp revision_create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The human-readable name of the phrase matcher.
string display_name = 5;
@@ -770,8 +786,10 @@ message PhraseMatcher {
// A list of phase match rule groups that are included in this matcher.
repeated PhraseMatchRuleGroup phrase_match_rule_groups = 8;
- // Output only. The most recent time at which the activation status was updated.
- google.protobuf.Timestamp activation_update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Output only. The most recent time at which the activation status was
+ // updated.
+ google.protobuf.Timestamp activation_update_time = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The role whose utterances the phrase matcher should be matched
// against. If the role is ROLE_UNSPECIFIED it will be matched against any
@@ -779,7 +797,8 @@ message PhraseMatcher {
ConversationParticipant.Role role_match = 10;
// Output only. The most recent time at which the phrase matcher was updated.
- google.protobuf.Timestamp update_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A message representing a rule in the phrase matcher.
@@ -846,6 +865,10 @@ message Settings {
// to analyze automatically, between [0, 100].
double runtime_integration_analysis_percentage = 1;
+ // Percentage of conversations created using the UploadConversation endpoint
+ // to analyze automatically, between [0, 100].
+ double upload_conversation_analysis_percentage = 6;
+
// To select the annotators to run and the phrase matchers to use
// (if any). If not specified, all annotators will be run.
AnnotatorSelector annotator_selector = 5;
@@ -857,10 +880,12 @@ message Settings {
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
// Output only. The time at which the settings was created.
- google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time at which the settings were last updated.
- google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// A language code to be applied to each transcript segment unless the segment
// already specifies a language code. Language code defaults to "en-US" if it
@@ -1092,8 +1117,8 @@ message ConversationParticipant {
// The name of the participant provided by Dialogflow. Format:
// projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}
string dialogflow_participant_name = 5 [(google.api.resource_reference) = {
- type: "dialogflow.googleapis.com/Participant"
- }];
+ type: "dialogflow.googleapis.com/Participant"
+ }];
// A user-specified ID representing the participant.
string user_id = 6;
@@ -1127,12 +1152,14 @@ message View {
string display_name = 2;
// Output only. The time at which this view was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The most recent time at which the view was updated.
- google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
- // String with specific view properties.
+ // String with specific view properties, must be non-empty.
string value = 5;
}
@@ -1153,8 +1180,8 @@ message AnnotatorSelector {
// run_phrase_matcher_annotator is set to true. Format:
// projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
repeated string phrase_matchers = 4 [(google.api.resource_reference) = {
- type: "contactcenterinsights.googleapis.com/PhraseMatcher"
- }];
+ type: "contactcenterinsights.googleapis.com/PhraseMatcher"
+ }];
// Whether to run the sentiment annotator.
bool run_sentiment_annotator = 5;
@@ -1175,6 +1202,6 @@ message AnnotatorSelector {
// is set to true. If more than one issue model is provided, only the first
// provided issue model will be used for inference.
repeated string issue_models = 10 [(google.api.resource_reference) = {
- type: "contactcenterinsights.googleapis.com/IssueModel"
- }];
+ type: "contactcenterinsights.googleapis.com/IssueModel"
+ }];
}
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/BUILD.bazel b/third_party/googleapis/google/cloud/contentwarehouse/v1/BUILD.bazel
index 0b1ab9c0a..902cbf9f3 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/BUILD.bazel
@@ -149,7 +149,7 @@ load(
go_proto_library(
name = "contentwarehouse_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1",
+ importpath = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb",
protos = [":contentwarehouse_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -166,6 +166,7 @@ go_gapic_library(
grpc_service_config = "contentwarehouse_grpc_service_config.json",
importpath = "cloud.google.com/go/contentwarehouse/apiv1;contentwarehouse",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "contentwarehouse_v1.yaml",
transport = "grpc+rest",
@@ -210,6 +211,7 @@ py_gapic_library(
grpc_service_config = "contentwarehouse_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "contentwarehouse_v1.yaml",
+ transport = "grpc+rest",
deps = [
"//google/cloud/documentai/v1:documentai_py_proto",
"//google/iam/v1:iam_policy_py_proto",
@@ -389,6 +391,7 @@ csharp_gapic_library(
grpc_service_config = "contentwarehouse_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "contentwarehouse_v1.yaml",
+ transport = "grpc+rest",
deps = [
":contentwarehouse_csharp_grpc",
":contentwarehouse_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/async_document_service_request.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/async_document_service_request.proto
index 368ddf3f8..eba3bf3bb 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/async_document_service_request.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/async_document_service_request.proto
@@ -19,7 +19,7 @@ package google.cloud.contentwarehouse.v1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "AsyncDocumentServiceRequestProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/common.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/common.proto
index 9be7e86a3..3592ee6d2 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/common.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/common.proto
@@ -19,7 +19,7 @@ package google.cloud.contentwarehouse.v1;
import "google/api/resource.proto";
import "google/protobuf/field_mask.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "CommonProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/document.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/document.proto
index 5ec6c2ec6..c74c6fc75 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/document.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/document.proto
@@ -22,7 +22,7 @@ import "google/cloud/documentai/v1/document.proto";
import "google/protobuf/timestamp.proto";
import "google/type/datetime.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "DocumentProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/document_link_service.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/document_link_service.proto
index a5a14d8dc..36fb164fa 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/document_link_service.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/document_link_service.proto
@@ -25,7 +25,7 @@ import "google/cloud/contentwarehouse/v1/document.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "DocumentLinkServiceProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/document_schema.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/document_schema.proto
index fae52e4c5..6c5526129 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/document_schema.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/document_schema.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "DocumentSchemaProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/document_schema_service.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/document_schema_service.proto
index 9c5706950..0027048ca 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/document_schema_service.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/document_schema_service.proto
@@ -23,7 +23,7 @@ import "google/api/resource.proto";
import "google/cloud/contentwarehouse/v1/document_schema.proto";
import "google/protobuf/empty.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "DocumentSchemaServiceProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/document_service.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/document_service.proto
index e0c1c8750..d2b250be9 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/document_service.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/document_service.proto
@@ -27,7 +27,7 @@ import "google/cloud/contentwarehouse/v1/rule_engine.proto";
import "google/iam/v1/policy.proto";
import "google/protobuf/empty.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "DocumentServiceProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/document_service_request.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/document_service_request.proto
index 635bfdb65..521ef12ac 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/document_service_request.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/document_service_request.proto
@@ -25,7 +25,7 @@ import "google/cloud/contentwarehouse/v1/histogram.proto";
import "google/iam/v1/policy.proto";
import "google/protobuf/field_mask.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "DocumentServiceRequestProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/filters.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/filters.proto
index 52e39ca90..2c43dfffb 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/filters.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/filters.proto
@@ -19,7 +19,7 @@ package google.cloud.contentwarehouse.v1;
import "google/api/resource.proto";
import "google/type/interval.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "FiltersProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/histogram.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/histogram.proto
index ce25e7a8c..5c73cea74 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/histogram.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/histogram.proto
@@ -19,7 +19,7 @@ package google.cloud.contentwarehouse.v1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "HistogramProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/rule_engine.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/rule_engine.proto
index 7badc7b78..2f69d5e83 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/rule_engine.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/rule_engine.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/iam/v1/policy.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "RuleEngineProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/ruleset_service.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/ruleset_service.proto
index 091367eab..9a1fe571b 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/ruleset_service.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/ruleset_service.proto
@@ -22,7 +22,7 @@ import "google/cloud/contentwarehouse/v1/rule_engine.proto";
import "google/cloud/contentwarehouse/v1/ruleset_service_request.proto";
import "google/protobuf/empty.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "RuleSetServiceProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/ruleset_service_request.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/ruleset_service_request.proto
index 61d125106..2bca2efef 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/ruleset_service_request.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/ruleset_service_request.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/contentwarehouse/v1/rule_engine.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "RuleSetServiceRequestProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset.proto
index d4f23e057..ed989951d 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset.proto
@@ -18,7 +18,7 @@ package google.cloud.contentwarehouse.v1;
import "google/api/resource.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "SynonymSetProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset_service.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset_service.proto
index 39acfd112..5f3e1625e 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset_service.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset_service.proto
@@ -22,7 +22,7 @@ import "google/cloud/contentwarehouse/v1/synonymset.proto";
import "google/cloud/contentwarehouse/v1/synonymset_service_request.proto";
import "google/protobuf/empty.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "SynonymSetServiceProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset_service_request.proto b/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset_service_request.proto
index 8d1955456..89584cd2e 100644
--- a/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset_service_request.proto
+++ b/third_party/googleapis/google/cloud/contentwarehouse/v1/synonymset_service_request.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/contentwarehouse/v1/synonymset.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/contentwarehouse/v1;contentwarehouse";
+option go_package = "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb";
option java_multiple_files = true;
option java_outer_classname = "SynonymSetServiceRequestProto";
option java_package = "com.google.cloud.contentwarehouse.v1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/lineage/BUILD.bazel b/third_party/googleapis/google/cloud/datacatalog/lineage/BUILD.bazel
new file mode 100644
index 000000000..abb64c4c9
--- /dev/null
+++ b/third_party/googleapis/google/cloud/datacatalog/lineage/BUILD.bazel
@@ -0,0 +1,39 @@
+# This build file includes a target for the Ruby wrapper library for
+# google-cloud-data_catalog-lineage.
+
+# This is an API workspace, having public visibility by default makes perfect sense.
+package(default_visibility = ["//visibility:public"])
+
+# Export yaml configs.
+exports_files(glob(["*.yaml"]))
+
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "ruby_cloud_gapic_library",
+ "ruby_gapic_assembly_pkg",
+)
+
+# Generates a Ruby wrapper client for datalineage.
+# Ruby wrapper clients are versionless, but are generated from source protos
+# for a particular service version, v1 in this case.
+ruby_cloud_gapic_library(
+ name = "datalineage_ruby_wrapper",
+ srcs = ["//google/cloud/datacatalog/lineage/v1:lineage_proto_with_info"],
+ extra_protoc_parameters = [
+ "ruby-cloud-gem-name=google-cloud-data_catalog-lineage",
+ "ruby-cloud-wrapper-of=v1:0.0",
+ "ruby-cloud-product-url=https://cloud.google.com/data-catalog/docs/reference/data-lineage/rpc",
+ "ruby-cloud-api-id=datalineage.googleapis.com",
+ "ruby-cloud-api-shortname=datalineage",
+ ],
+ ruby_cloud_description = "DataCatalog is a centralized and unified data catalog service for all your Cloud resources, where users and systems can discover data, explore and curate its semantics, understand how to act on it, and help govern its usage. Lineage is used to track data flows between assets over time. You can create Lineage Events to record lineage between multiple sources and a single target, for example, when table data is based on data from multiple tables.",
+ ruby_cloud_title = "Data Lineage",
+)
+
+# Open Source package.
+ruby_gapic_assembly_pkg(
+ name = "google-cloud-datacatalog-lineage-ruby",
+ deps = [
+ ":datalineage_ruby_wrapper",
+ ],
+)
diff --git a/third_party/googleapis/google/cloud/datacatalog/lineage/v1/BUILD.bazel b/third_party/googleapis/google/cloud/datacatalog/lineage/v1/BUILD.bazel
new file mode 100644
index 000000000..4dfb37124
--- /dev/null
+++ b/third_party/googleapis/google/cloud/datacatalog/lineage/v1/BUILD.bazel
@@ -0,0 +1,399 @@
+# This file was automatically generated by BuildFileGenerator
+# https://github.com/googleapis/rules_gapic/tree/master/bazel
+
+# Most of the manual changes to this file will be overwritten.
+# It's **only** allowed to change the following rule attribute values:
+# - names of *_gapic_assembly_* rules
+# - certain parameters of *_gapic_library rules, including but not limited to:
+# * extra_protoc_parameters
+# * extra_protoc_file_parameters
+# The complete list of preserved parameters can be found in the source code.
+
+# This is an API workspace, having public visibility by default makes perfect sense.
+package(default_visibility = ["//visibility:public"])
+
+##############################################################################
+# Common
+##############################################################################
+load("@rules_proto//proto:defs.bzl", "proto_library")
+load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
+
+proto_library(
+ name = "lineage_proto",
+ srcs = [
+ "lineage.proto",
+ ],
+ deps = [
+ "//google/api:annotations_proto",
+ "//google/api:client_proto",
+ "//google/api:field_behavior_proto",
+ "//google/api:resource_proto",
+ "//google/longrunning:operations_proto",
+ "@com_google_protobuf//:empty_proto",
+ "@com_google_protobuf//:field_mask_proto",
+ "@com_google_protobuf//:struct_proto",
+ "@com_google_protobuf//:timestamp_proto",
+ ],
+)
+
+proto_library_with_info(
+ name = "lineage_proto_with_info",
+ deps = [
+ ":lineage_proto",
+ "//google/cloud:common_resources_proto",
+ ],
+)
+
+##############################################################################
+# Java
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "java_gapic_assembly_gradle_pkg",
+ "java_gapic_library",
+ "java_gapic_test",
+ "java_grpc_library",
+ "java_proto_library",
+)
+
+java_proto_library(
+ name = "lineage_java_proto",
+ deps = [":lineage_proto"],
+)
+
+java_grpc_library(
+ name = "lineage_java_grpc",
+ srcs = [":lineage_proto"],
+ deps = [":lineage_java_proto"],
+)
+
+java_gapic_library(
+ name = "lineage_java_gapic",
+ srcs = [":lineage_proto_with_info"],
+ gapic_yaml = None,
+ grpc_service_config = "lineage_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "datalineage_v1.yaml",
+ test_deps = [
+ ":lineage_java_grpc",
+ ],
+ transport = "grpc+rest",
+ deps = [
+ ":lineage_java_proto",
+ "//google/api:api_java_proto",
+ ],
+)
+
+java_gapic_test(
+ name = "lineage_java_gapic_test_suite",
+ test_classes = [
+ "com.google.cloud.datacatalog.lineage.v1.LineageClientHttpJsonTest",
+ "com.google.cloud.datacatalog.lineage.v1.LineageClientTest",
+ ],
+ runtime_deps = [":lineage_java_gapic_test"],
+)
+
+# Open Source Packages
+java_gapic_assembly_gradle_pkg(
+ name = "google-cloud-datacatalog-lineage-v1-java",
+ include_samples = True,
+ transport = "grpc+rest",
+ deps = [
+ ":lineage_java_gapic",
+ ":lineage_java_grpc",
+ ":lineage_java_proto",
+ ":lineage_proto",
+ ],
+)
+
+##############################################################################
+# Go
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "go_gapic_assembly_pkg",
+ "go_gapic_library",
+ "go_proto_library",
+ "go_test",
+)
+
+go_proto_library(
+ name = "lineage_go_proto",
+ compilers = ["@io_bazel_rules_go//proto:go_grpc"],
+ importpath = "cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb",
+ protos = [":lineage_proto"],
+ deps = [
+ "//google/api:annotations_go_proto",
+ "//google/longrunning:longrunning_go_proto",
+ ],
+)
+
+go_gapic_library(
+ name = "lineage_go_gapic",
+ srcs = [":lineage_proto_with_info"],
+ grpc_service_config = "lineage_grpc_service_config.json",
+ importpath = "cloud.google.com/go/datacatalog/lineage/apiv1;lineage",
+ metadata = True,
+ release_level = "beta",
+ rest_numeric_enums = True,
+ service_yaml = "datalineage_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":lineage_go_proto",
+ "//google/longrunning:longrunning_go_proto",
+ "@com_google_cloud_go_longrunning//:go_default_library",
+ "@com_google_cloud_go_longrunning//autogen:go_default_library",
+ "@io_bazel_rules_go//proto/wkt:struct_go_proto",
+ ],
+)
+
+go_test(
+ name = "lineage_go_gapic_test",
+ srcs = [":lineage_go_gapic_srcjar_test"],
+ embed = [":lineage_go_gapic"],
+ importpath = "cloud.google.com/go/datacatalog/lineage/apiv1",
+)
+
+# Open Source Packages
+go_gapic_assembly_pkg(
+ name = "gapi-cloud-datacatalog-lineage-v1-go",
+ deps = [
+ ":lineage_go_gapic",
+ ":lineage_go_gapic_srcjar-metadata.srcjar",
+ ":lineage_go_gapic_srcjar-test.srcjar",
+ ":lineage_go_proto",
+ ],
+)
+
+##############################################################################
+# Python
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "py_gapic_assembly_pkg",
+ "py_gapic_library",
+ "py_test",
+)
+
+py_gapic_library(
+ name = "lineage_py_gapic",
+ srcs = [":lineage_proto"],
+ grpc_service_config = "lineage_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "datalineage_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ],
+)
+
+py_test(
+ name = "lineage_py_gapic_test",
+ srcs = [
+ "lineage_py_gapic_pytest.py",
+ "lineage_py_gapic_test.py",
+ ],
+ legacy_create_init = False,
+ deps = [":lineage_py_gapic"],
+)
+
+# Open Source Packages
+py_gapic_assembly_pkg(
+ name = "datacatalog-lineage-v1-py",
+ deps = [
+ ":lineage_py_gapic",
+ ],
+)
+
+##############################################################################
+# PHP
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "php_gapic_assembly_pkg",
+ "php_gapic_library",
+ "php_grpc_library",
+ "php_proto_library",
+)
+
+php_proto_library(
+ name = "lineage_php_proto",
+ deps = [":lineage_proto"],
+)
+
+php_grpc_library(
+ name = "lineage_php_grpc",
+ srcs = [":lineage_proto"],
+ deps = [":lineage_php_proto"],
+)
+
+php_gapic_library(
+ name = "lineage_php_gapic",
+ srcs = [":lineage_proto_with_info"],
+ grpc_service_config = "lineage_grpc_service_config.json",
+ rest_numeric_enums = False,
+ service_yaml = "datalineage_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":lineage_php_grpc",
+ ":lineage_php_proto",
+ ],
+)
+
+# Open Source Packages
+php_gapic_assembly_pkg(
+ name = "google-cloud-datacatalog-lineage-v1-php",
+ deps = [
+ ":lineage_php_gapic",
+ ":lineage_php_grpc",
+ ":lineage_php_proto",
+ ],
+)
+
+##############################################################################
+# Node.js
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "nodejs_gapic_assembly_pkg",
+ "nodejs_gapic_library",
+)
+
+nodejs_gapic_library(
+ name = "lineage_nodejs_gapic",
+ package_name = "@google-cloud/lineage",
+ src = ":lineage_proto_with_info",
+ extra_protoc_parameters = ["metadata"],
+ grpc_service_config = "lineage_grpc_service_config.json",
+ package = "google.cloud.datacatalog.lineage.v1",
+ rest_numeric_enums = True,
+ service_yaml = "datalineage_v1.yaml",
+ transport = "grpc+rest",
+ deps = [],
+)
+
+nodejs_gapic_assembly_pkg(
+ name = "datacatalog-lineage-v1-nodejs",
+ deps = [
+ ":lineage_nodejs_gapic",
+ ":lineage_proto",
+ ],
+)
+
+##############################################################################
+# Ruby
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "ruby_cloud_gapic_library",
+ "ruby_gapic_assembly_pkg",
+ "ruby_grpc_library",
+ "ruby_proto_library",
+)
+
+ruby_proto_library(
+ name = "lineage_ruby_proto",
+ deps = [":lineage_proto"],
+)
+
+ruby_grpc_library(
+ name = "lineage_ruby_grpc",
+ srcs = [":lineage_proto"],
+ deps = [":lineage_ruby_proto"],
+)
+
+ruby_cloud_gapic_library(
+ name = "lineage_ruby_gapic",
+ srcs = [":lineage_proto_with_info"],
+ extra_protoc_parameters = [
+ "ruby-cloud-api-id=datalineage.googleapis.com",
+ "ruby-cloud-api-shortname=datalineage",
+ "ruby-cloud-gem-name=google-cloud-data_catalog-lineage-v1",
+ "ruby-cloud-product-url=https://cloud.google.com/data-catalog/docs/reference/data-lineage/rpc",
+ ],
+ grpc_service_config = "lineage_grpc_service_config.json",
+ rest_numeric_enums = True,
+ ruby_cloud_description = "DataCatalog is a centralized and unified data catalog service for all your Cloud resources, where users and systems can discover data, explore and curate its semantics, understand how to act on it, and help govern its usage. Lineage is used to track data flows between assets over time. You can create Lineage Events to record lineage between multiple sources and a single target, for example, when table data is based on data from multiple tables.",
+ ruby_cloud_title = "Data Lineage V1",
+ service_yaml = "datalineage_v1.yaml",
+ deps = [
+ ":lineage_ruby_grpc",
+ ":lineage_ruby_proto",
+ ],
+)
+
+# Open Source Packages
+ruby_gapic_assembly_pkg(
+ name = "google-cloud-datacatalog-lineage-v1-ruby",
+ deps = [
+ ":lineage_ruby_gapic",
+ ":lineage_ruby_grpc",
+ ":lineage_ruby_proto",
+ ],
+)
+
+##############################################################################
+# C#
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "csharp_gapic_assembly_pkg",
+ "csharp_gapic_library",
+ "csharp_grpc_library",
+ "csharp_proto_library",
+)
+
+csharp_proto_library(
+ name = "lineage_csharp_proto",
+ deps = [":lineage_proto"],
+)
+
+csharp_grpc_library(
+ name = "lineage_csharp_grpc",
+ srcs = [":lineage_proto"],
+ deps = [":lineage_csharp_proto"],
+)
+
+csharp_gapic_library(
+ name = "lineage_csharp_gapic",
+ srcs = [":lineage_proto_with_info"],
+ common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
+ grpc_service_config = "lineage_grpc_service_config.json",
+ rest_numeric_enums = True,
+ service_yaml = "datalineage_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ ":lineage_csharp_grpc",
+ ":lineage_csharp_proto",
+ ],
+)
+
+# Open Source Packages
+csharp_gapic_assembly_pkg(
+ name = "google-cloud-datacatalog-lineage-v1-csharp",
+ deps = [
+ ":lineage_csharp_gapic",
+ ":lineage_csharp_grpc",
+ ":lineage_csharp_proto",
+ ],
+)
+
+##############################################################################
+# C++
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "cc_grpc_library",
+ "cc_proto_library",
+)
+
+cc_proto_library(
+ name = "lineage_cc_proto",
+ deps = [":lineage_proto"],
+)
+
+cc_grpc_library(
+ name = "lineage_cc_grpc",
+ srcs = [":lineage_proto"],
+ grpc_only = True,
+ deps = [":lineage_cc_proto"],
+)
diff --git a/third_party/googleapis/google/cloud/datacatalog/lineage/v1/datalineage_v1.yaml b/third_party/googleapis/google/cloud/datacatalog/lineage/v1/datalineage_v1.yaml
new file mode 100644
index 000000000..b18b677c5
--- /dev/null
+++ b/third_party/googleapis/google/cloud/datacatalog/lineage/v1/datalineage_v1.yaml
@@ -0,0 +1,44 @@
+type: google.api.Service
+config_version: 3
+name: datalineage.googleapis.com
+title: Data Lineage API
+
+apis:
+- name: google.cloud.datacatalog.lineage.v1.Lineage
+- name: google.longrunning.Operations
+
+types:
+- name: google.cloud.datacatalog.lineage.v1.OperationMetadata
+
+http:
+ rules:
+ - selector: google.longrunning.Operations.CancelOperation
+ post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
+ body: '*'
+ - selector: google.longrunning.Operations.DeleteOperation
+ delete: '/v1/{name=projects/*/locations/*/operations/*}'
+ - selector: google.longrunning.Operations.GetOperation
+ get: '/v1/{name=projects/*/locations/*/operations/*}'
+ - selector: google.longrunning.Operations.ListOperations
+ get: '/v1/{name=projects/*/locations/*}/operations'
+
+authentication:
+ rules:
+ - selector: 'google.cloud.datacatalog.lineage.v1.Lineage.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: 'google.longrunning.Operations.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+
+publishing:
+ organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED
+ new_issue_uri: ''
+ documentation_uri: ''
+ api_short_name: ''
+ github_label: ''
+ doc_tag_prefix: ''
+ codeowner_github_teams:
+ library_settings:
diff --git a/third_party/googleapis/google/cloud/datacatalog/lineage/v1/lineage.proto b/third_party/googleapis/google/cloud/datacatalog/lineage/v1/lineage.proto
new file mode 100644
index 000000000..ed9602a81
--- /dev/null
+++ b/third_party/googleapis/google/cloud/datacatalog/lineage/v1/lineage.proto
@@ -0,0 +1,879 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.datacatalog.lineage.v1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DataCatalog.Lineage.V1";
+option go_package = "cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb;lineagepb";
+option java_multiple_files = true;
+option java_outer_classname = "LineageProto";
+option java_package = "com.google.cloud.datacatalog.lineage.v1";
+option php_namespace = "Google\\Cloud\\DataCatalog\\Lineage\\V1";
+option ruby_package = "Google::Cloud::DataCatalog::Lineage::V1";
+
+// Lineage is used to track data flows between assets over time. You can
+// create [LineageEvents][google.cloud.datacatalog.lineage.v1.LineageEvent]
+// to record lineage between multiple sources and a single target, for
+// example, when table data is based on data from multiple tables.
+service Lineage {
+ option (google.api.default_host) = "datalineage.googleapis.com";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
+
+ // Creates a new process.
+ rpc CreateProcess(CreateProcessRequest) returns (Process) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*}/processes"
+ body: "process"
+ };
+ option (google.api.method_signature) = "parent,process";
+ }
+
+ // Updates a process.
+ rpc UpdateProcess(UpdateProcessRequest) returns (Process) {
+ option (google.api.http) = {
+ patch: "/v1/{process.name=projects/*/locations/*/processes/*}"
+ body: "process"
+ };
+ option (google.api.method_signature) = "process,update_mask";
+ }
+
+ // Gets the details of the specified process.
+ rpc GetProcess(GetProcessRequest) returns (Process) {
+ option (google.api.http) = {
+ get: "/v1/{name=projects/*/locations/*/processes/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // List processes in the given project and location. List order is descending
+ // by insertion time.
+ rpc ListProcesses(ListProcessesRequest) returns (ListProcessesResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=projects/*/locations/*}/processes"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Deletes the process with the specified name.
+ rpc DeleteProcess(DeleteProcessRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1/{name=projects/*/locations/*/processes/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "google.cloud.datacatalog.lineage.v1.OperationMetadata"
+ };
+ }
+
+ // Creates a new run.
+ rpc CreateRun(CreateRunRequest) returns (Run) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*/processes/*}/runs"
+ body: "run"
+ };
+ option (google.api.method_signature) = "parent,run";
+ }
+
+ // Updates a run.
+ rpc UpdateRun(UpdateRunRequest) returns (Run) {
+ option (google.api.http) = {
+ patch: "/v1/{run.name=projects/*/locations/*/processes/*/runs/*}"
+ body: "run"
+ };
+ option (google.api.method_signature) = "run,update_mask";
+ }
+
+ // Gets the details of the specified run.
+ rpc GetRun(GetRunRequest) returns (Run) {
+ option (google.api.http) = {
+ get: "/v1/{name=projects/*/locations/*/processes/*/runs/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Lists runs in the given project and location. List order is descending by
+ // `start_time`.
+ rpc ListRuns(ListRunsRequest) returns (ListRunsResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=projects/*/locations/*/processes/*}/runs"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Deletes the run with the specified name.
+ rpc DeleteRun(DeleteRunRequest) returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1/{name=projects/*/locations/*/processes/*/runs/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "google.cloud.datacatalog.lineage.v1.OperationMetadata"
+ };
+ }
+
+ // Creates a new lineage event.
+ rpc CreateLineageEvent(CreateLineageEventRequest) returns (LineageEvent) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*/processes/*/runs/*}/lineageEvents"
+ body: "lineage_event"
+ };
+ option (google.api.method_signature) = "parent,lineage_event";
+ }
+
+ // Gets details of a specified lineage event.
+ rpc GetLineageEvent(GetLineageEventRequest) returns (LineageEvent) {
+ option (google.api.http) = {
+ get: "/v1/{name=projects/*/locations/*/processes/*/runs/*/lineageEvents/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Lists lineage events in the given project and location. The list order is
+ // not defined.
+ rpc ListLineageEvents(ListLineageEventsRequest)
+ returns (ListLineageEventsResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=projects/*/locations/*/processes/*/runs/*}/lineageEvents"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Deletes the lineage event with the specified name.
+ rpc DeleteLineageEvent(DeleteLineageEventRequest)
+ returns (google.protobuf.Empty) {
+ option (google.api.http) = {
+ delete: "/v1/{name=projects/*/locations/*/processes/*/runs/*/lineageEvents/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Retrieve a list of links connected to a specific asset.
+ // Links represent the data flow between **source** (upstream)
+ // and **target** (downstream) assets in transformation pipelines.
+ // Links are stored in the same project as the Lineage Events that create
+ // them.
+ //
+ // You can retrieve links in every project where you have the
+ // `datalineage.events.get` permission. The project provided in the URL
+ // is used for Billing and Quota.
+ rpc SearchLinks(SearchLinksRequest) returns (SearchLinksResponse) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*}:searchLinks"
+ body: "*"
+ };
+ }
+
+ // Retrieve information about LineageProcesses associated with specific
+ // links. LineageProcesses are transformation pipelines that result in data
+ // flowing from **source** to **target** assets. Links between assets
+ // represent this operation.
+ //
+ // If you have specific link names, you can use this method to
+ // verify which LineageProcesses contribute to creating those links.
+ // See the
+ // [SearchLinks][google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks]
+ // method for more information on how to retrieve link name.
+ //
+ // You can retrieve the LineageProcess information in every project where you
+ // have the `datalineage.events.get` permission. The project provided in the
+ // URL is used for Billing and Quota.
+ rpc BatchSearchLinkProcesses(BatchSearchLinkProcessesRequest)
+ returns (BatchSearchLinkProcessesResponse) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*}:batchSearchLinkProcesses"
+ body: "*"
+ };
+ }
+}
+
+// A process is the definition of a data transformation operation.
+message Process {
+ option (google.api.resource) = {
+ type: "datalineage.googleapis.com/Process"
+ pattern: "projects/{project}/locations/{location}/processes/{process}"
+ };
+
+ // Immutable. The resource name of the lineage process. Format:
+ // `projects/{project}/locations/{location}/processes/{process}`.
+ // Can be specified or auto-assigned.
+ // {process} must be not longer than 200 characters and only
+ // contain characters in a set: `a-zA-Z0-9_-:.`
+ string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Optional. A human-readable name you can set to display in a user interface.
+ // Must be not longer than 200 characters and only contain UTF-8 letters
+ // or numbers, spaces or characters like `_-:&.`
+ string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The attributes of the process. Can be anything, for example,
+ // "author". Up to 100 attributes are allowed.
+ map attributes = 3
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The origin of this process and its runs and lineage events.
+ Origin origin = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// A lineage run represents an execution of a process that creates
+// lineage events.
+message Run {
+ option (google.api.resource) = {
+ type: "datalineage.googleapis.com/Run"
+ pattern: "projects/{project}/locations/{location}/processes/{process}/runs/{run}"
+ };
+
+ // The current state of the run.
+ enum State {
+ // The state is unknown. The true state may be any of the below or a
+ // different state that is not supported here explicitly.
+ UNKNOWN = 0;
+
+ // The run is still executing.
+ STARTED = 1;
+
+ // The run completed.
+ COMPLETED = 2;
+
+ // The run failed.
+ FAILED = 3;
+
+ // The run aborted.
+ ABORTED = 4;
+ }
+
+ // Immutable. The resource name of the run. Format:
+ // `projects/{project}/locations/{location}/processes/{process}/runs/{run}`.
+ // Can be specified or auto-assigned.
+ // {run} must be not longer than 200 characters and only
+ // contain characters in a set: `a-zA-Z0-9_-:.`
+ string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Optional. A human-readable name you can set to display in a user interface.
+ // Must be not longer than 1024 characters and only contain UTF-8 letters
+ // or numbers, spaces or characters like `_-:&.`
+ string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The attributes of the run. Can be anything, for example, a string
+ // with an SQL request. Up to 100 attributes are allowed.
+ map attributes = 3
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The timestamp of the start of the run.
+ google.protobuf.Timestamp start_time = 4
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. The timestamp of the end of the run.
+ google.protobuf.Timestamp end_time = 5
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The state of the run.
+ State state = 6 [(google.api.field_behavior) = REQUIRED];
+}
+
+// A lineage event represents an operation on assets. Within the operation, the
+// data flows from the source to the target defined in the links field.
+message LineageEvent {
+ option (google.api.resource) = {
+ type: "datalineage.googleapis.com/LineageEvent"
+ pattern: "projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}"
+ };
+
+ // Immutable. The resource name of the lineage event.
+ // Format:
+ // `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`.
+ // Can be specified or auto-assigned.
+ // {lineage_event} must be not longer than 200 characters and only
+ // contain characters in a set: `a-zA-Z0-9_-:.`
+ string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+
+ // Optional. List of source-target pairs. Can't contain more than 100 tuples.
+ repeated EventLink links = 8 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The beginning of the transformation which resulted in this
+ // lineage event. For streaming scenarios, it should be the beginning of the
+ // period from which the lineage is being reported.
+ google.protobuf.Timestamp start_time = 6
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The end of the transformation which resulted in this lineage
+ // event. For streaming scenarios, it should be the end of the period from
+ // which the lineage is being reported.
+ google.protobuf.Timestamp end_time = 7
+ [(google.api.field_behavior) = OPTIONAL];
+}
+
+// A lineage between source and target entities.
+message EventLink {
+ // Required. Reference to the source entity
+ EntityReference source = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Reference to the target entity
+ EntityReference target = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// The soft reference to everything you can attach a lineage event to.
+message EntityReference {
+ // Required. Fully Qualified Name of the entity. Useful for referencing
+ // entities that aren't represented as GCP resources, for example, tables in
+ // Dataproc Metastore API.
+ //
+ // Examples:
+ //
+ // * `bigquery:dataset.project_id.dataset_id`
+ // * `bigquery:table.project_id.dataset_id.table_id`
+ // * `pubsub:project_id.topic_id`
+ // * `dataproc_metastore:projectId.locationId.instanceId.databaseId.tableId`
+ string fully_qualified_name = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Metadata describing the operation.
+message OperationMetadata {
+ // An enum with the state of the operation.
+ enum State {
+ // Unused.
+ STATE_UNSPECIFIED = 0;
+
+ // The operation has been created but is not yet started.
+ PENDING = 1;
+
+ // The operation is underway.
+ RUNNING = 2;
+
+ // The operation completed successfully.
+ SUCCEEDED = 3;
+
+ // The operation is no longer running and did not succeed.
+ FAILED = 4;
+ }
+
+ // Type of the long running operation.
+ enum Type {
+ // Unused.
+ TYPE_UNSPECIFIED = 0;
+
+ // The resource deletion operation.
+ DELETE = 1;
+ }
+
+ // Output only. The current operation state.
+ State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The type of the operation being performed.
+ Type operation_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The [relative name]
+ // (https://cloud.google.com//apis/design/resource_names#relative_resource_name)
+ // of the resource being operated on.
+ string resource = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The UUID of the resource being operated on.
+ string resource_uuid = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The timestamp of the operation submission to the server.
+ google.protobuf.Timestamp create_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The timestamp of the operation termination, regardless of its
+ // success. This field is unset if the operation is still ongoing.
+ google.protobuf.Timestamp end_time = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Request message for
+// [CreateProcess][google.cloud.datacatalog.lineage.v1.CreateProcess].
+message CreateProcessRequest {
+ // Required. The name of the project and its location that should own the
+ // process.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "datalineage.googleapis.com/Process"
+ }
+ ];
+
+ // Required. The process to create.
+ Process process = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // A unique identifier for this request. Restricted to 36 ASCII characters.
+ // A random UUID is recommended. This request is idempotent only if a
+ // `request_id` is provided.
+ string request_id = 3;
+}
+
+// Request message for
+// [UpdateProcess][google.cloud.datacatalog.lineage.v1.UpdateProcess].
+message UpdateProcessRequest {
+ // Required. The lineage process to update.
+ //
+ // The process's `name` field is used to identify the process to update.
+ Process process = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // The list of fields to update. Currently not used. The whole message is
+ // updated.
+ google.protobuf.FieldMask update_mask = 2;
+
+ // If set to true and the process is not found, the request inserts it.
+ bool allow_missing = 3;
+}
+
+// Request message for
+// [GetProcess][google.cloud.datacatalog.lineage.v1.GetProcess].
+message GetProcessRequest {
+ // Required. The name of the process to get.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "datalineage.googleapis.com/Process"
+ }
+ ];
+}
+
+// Request message for
+// [ListProcesses][google.cloud.datacatalog.lineage.v1.ListProcesses].
+message ListProcessesRequest {
+ // Required. The name of the project and its location that owns this
+ // collection of processes.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "datalineage.googleapis.com/Process"
+ }
+ ];
+
+ // The maximum number of processes to return. The service may return
+ // fewer than this value. If unspecified, at most 50 processes are
+ // returned. The maximum value is 100; values greater than 100 are cut to
+ // 100.
+ int32 page_size = 2;
+
+ // The page token received from a previous `ListProcesses` call. Specify
+ // it to get the next page.
+ //
+ // When paginating, all other parameters specified in this call must
+ // match the parameters of the call that provided the page token.
+ string page_token = 3;
+}
+
+// Response message for
+// [ListProcesses][google.cloud.datacatalog.lineage.v1.ListProcesses].
+message ListProcessesResponse {
+ // The processes from the specified project and location.
+ repeated Process processes = 1;
+
+ // The token to specify as `page_token` in the next call to get the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
+}
+
+// Request message for
+// [DeleteProcess][google.cloud.datacatalog.lineage.v1.DeleteProcess].
+message DeleteProcessRequest {
+ // Required. The name of the process to delete.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "datalineage.googleapis.com/Process"
+ }
+ ];
+
+ // If set to true and the process is not found, the request
+ // succeeds but the server doesn't perform any actions.
+ bool allow_missing = 2;
+}
+
+// Request message for
+// [CreateRun][google.cloud.datacatalog.lineage.v1.CreateRun].
+message CreateRunRequest {
+ // Required. The name of the process that should own the run.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "datalineage.googleapis.com/Run"
+ }
+ ];
+
+ // Required. The run to create.
+ Run run = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // A unique identifier for this request. Restricted to 36 ASCII characters.
+ // A random UUID is recommended. This request is idempotent only if a
+ // `request_id` is provided.
+ string request_id = 3;
+}
+
+// Request message for
+// [UpdateRun][google.cloud.datacatalog.lineage.v1.UpdateRun].
+message UpdateRunRequest {
+ // Required. The lineage run to update.
+ //
+ // The run's `name` field is used to identify the run to update.
+ //
+ // Format:
+ // `projects/{project}/locations/{location}/processes/{process}/runs/{run}`.
+ Run run = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // The list of fields to update. Currently not used. The whole message is
+ // updated.
+ google.protobuf.FieldMask update_mask = 2;
+}
+
+// Request message for
+// [GetRun][google.cloud.datacatalog.lineage.v1.GetRun].
+message GetRunRequest {
+ // Required. The name of the run to get.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "datalineage.googleapis.com/Run" }
+ ];
+}
+
+// Request message for
+// [ListRuns][google.cloud.datacatalog.lineage.v1.ListRuns].
+message ListRunsRequest {
+ // Required. The name of process that owns this collection of runs.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "datalineage.googleapis.com/Run"
+ }
+ ];
+
+ // The maximum number of runs to return. The service may return
+ // fewer than this value. If unspecified, at most 50 runs are
+ // returned. The maximum value is 100; values greater than 100 are cut to
+ // 100.
+ int32 page_size = 2;
+
+ // The page token received from a previous `ListRuns` call. Specify
+ // it to get the next page.
+ //
+ // When paginating, all other parameters specified in this call must
+ // match the parameters of the call that provided the page token.
+ string page_token = 3;
+}
+
+// Response message for
+// [ListRuns][google.cloud.datacatalog.lineage.v1.ListRuns].
+message ListRunsResponse {
+ // The runs from the specified project and location.
+ repeated Run runs = 1;
+
+ // The token to specify as `page_token` in the next call to get the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
+}
+
+// Request message for
+// [DeleteRun][google.cloud.datacatalog.lineage.v1.DeleteRun].
+message DeleteRunRequest {
+ // Required. The name of the run to delete.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = { type: "datalineage.googleapis.com/Run" }
+ ];
+
+ // If set to true and the run is not found, the request
+ // succeeds but the server doesn't perform any actions.
+ bool allow_missing = 2;
+}
+
+// Request message for
+// [CreateLineageEvent][google.cloud.datacatalog.lineage.v1.CreateLineageEvent].
+message CreateLineageEventRequest {
+ // Required. The name of the run that should own the lineage event.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "datalineage.googleapis.com/LineageEvent"
+ }
+ ];
+
+ // Required. The lineage event to create.
+ LineageEvent lineage_event = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // A unique identifier for this request. Restricted to 36 ASCII characters.
+ // A random UUID is recommended. This request is idempotent only if a
+ // `request_id` is provided.
+ string request_id = 3;
+}
+
+// Request message for
+// [GetLineageEvent][google.cloud.datacatalog.lineage.v1.GetLineageEvent].
+message GetLineageEventRequest {
+ // Required. The name of the lineage event to get.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "datalineage.googleapis.com/LineageEvent"
+ }
+ ];
+}
+
+// Request message for
+// [ListLineageEvents][google.cloud.datacatalog.lineage.v1.ListLineageEvents].
+message ListLineageEventsRequest {
+ // Required. The name of the run that owns the collection of lineage events to
+ // get.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "datalineage.googleapis.com/LineageEvent"
+ }
+ ];
+
+ // The maximum number of lineage events to return.
+ //
+ // The service may return fewer events than this value.
+ // If unspecified, at most 50 events are returned. The maximum value is 100;
+ // values greater than 100 are cut to 100.
+ int32 page_size = 2;
+
+ // The page token received from a previous `ListLineageEvents` call. Specify
+ // it to get the next page.
+ //
+ // When paginating, all other parameters specified in this call must
+ // match the parameters of the call that provided the page token.
+ string page_token = 3;
+}
+
+// Response message for
+// [ListLineageEvents][google.cloud.datacatalog.lineage.v1.ListLineageEvents].
+message ListLineageEventsResponse {
+ // Lineage events from the specified project and location.
+ repeated LineageEvent lineage_events = 1;
+
+ // The token to specify as `page_token` in the next call to get the next page.
+ // If this field is omitted, there are no subsequent pages.
+ string next_page_token = 2;
+}
+
+// Request message for
+// [DeleteLineageEvent][google.cloud.datacatalog.lineage.v1.DeleteLineageEvent].
+message DeleteLineageEventRequest {
+ // Required. The name of the lineage event to delete.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "datalineage.googleapis.com/LineageEvent"
+ }
+ ];
+
+ // If set to true and the lineage event is not found, the request
+ // succeeds but the server doesn't perform any actions.
+ bool allow_missing = 2;
+}
+
+// Request message for
+// [SearchLinks][google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks].
+message SearchLinksRequest {
+ // Required. The project and location you want search in.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "datalineage.googleapis.com/Process"
+ }
+ ];
+
+ // The asset for which you want to retrieve links.
+ oneof criteria {
+ // Optional. Send asset information in the **source** field to retrieve all
+ // links that lead from the specified asset to downstream assets.
+ EntityReference source = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Send asset information in the **target** field to retrieve all
+ // links that lead from upstream assets to the specified asset.
+ EntityReference target = 5 [(google.api.field_behavior) = OPTIONAL];
+ }
+
+ // Optional. The maximum number of links to return in a single page of the
+ // response. A page may contain fewer links than this value. If unspecified,
+ // at most 10 links are returned.
+ //
+ // Maximum value is 100; values greater than 100 are reduced to 100.
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The page token received from a previous `SearchLinksRequest`
+ // call. Use it to get the next page.
+ //
+ // When requesting subsequent pages of a response, remember that
+ // all parameters must match the values you provided
+ // in the original request.
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response message for
+// [SearchLinks][google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks].
+message SearchLinksResponse {
+ // The list of links for a given asset. Can be empty if the asset has no
+ // relations of requested type (source or target).
+ repeated Link links = 1;
+
+ // The token to specify as `page_token` in the subsequent call to get the next
+ // page. Omitted if there are no more pages in the response.
+ string next_page_token = 2;
+}
+
+// Links represent the data flow between **source** (upstream)
+// and **target** (downstream) assets in transformation pipelines.
+//
+// Links are created when LineageEvents record data transformation between
+// related assets.
+message Link {
+ // Output only. Immutable. The name of the link. Format:
+ // `projects/{project}/locations/{location}/links/{link}`.
+ string name = 1 [
+ (google.api.field_behavior) = OUTPUT_ONLY,
+ (google.api.field_behavior) = IMMUTABLE
+ ];
+
+ // The pointer to the entity that is the **source** of this link.
+ EntityReference source = 2;
+
+ // The pointer to the entity that is the **target** of this link.
+ EntityReference target = 3;
+
+ // The start of the first event establishing this link.
+ google.protobuf.Timestamp start_time = 4;
+
+ // The end of the last event establishing this link.
+ google.protobuf.Timestamp end_time = 5;
+}
+
+// Request message for
+// [BatchSearchLinkProcesses][google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses].
+message BatchSearchLinkProcessesRequest {
+ // Required. The project and location where you want to search.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ child_type: "datalineage.googleapis.com/Process"
+ }
+ ];
+
+ // Required. An array of links to check for their associated LineageProcesses.
+ //
+ // The maximum number of items in this array is 100.
+ // If the request contains more than 100 links, it returns the
+ // `INVALID_ARGUMENT` error.
+ //
+ // Format: `projects/{project}/locations/{location}/links/{link}`.
+ repeated string links = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // The maximum number of processes to return in a single page of the response.
+ // A page may contain fewer results than this value.
+ int32 page_size = 3;
+
+ // The page token received from a previous `BatchSearchLinkProcesses` call.
+ // Use it to get the next page.
+ //
+ // When requesting subsequent pages of a response, remember that
+ // all parameters must match the values you provided
+ // in the original request.
+ string page_token = 4;
+}
+
+// Response message for
+// [BatchSearchLinkProcesses][google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses].
+message BatchSearchLinkProcessesResponse {
+ // An array of processes associated with the specified links.
+ repeated ProcessLinks process_links = 1;
+
+ // The token to specify as `page_token` in the subsequent call to get the next
+ // page. Omitted if there are no more pages in the response.
+ string next_page_token = 2;
+}
+
+// Links associated with a specific process.
+message ProcessLinks {
+ // The process name in the format of
+ // `projects/{project}/locations/{location}/processes/{process}`.
+ string process = 1 [(google.api.resource_reference) = {
+ type: "datalineage.googleapis.com/Process"
+ }];
+
+ // An array containing link details objects of the links provided in
+ // the original request.
+ //
+ // A single process can result in creating multiple links.
+ // If any of the links you provide in the request are created by
+ // the same process, they all are included in this array.
+ repeated ProcessLinkInfo links = 2;
+}
+
+// Link details.
+message ProcessLinkInfo {
+ // The name of the link in the format of
+ // `projects/{project}/locations/{location}/links/{link}`.
+ string link = 1;
+
+ // The start of the first event establishing this link-process tuple.
+ google.protobuf.Timestamp start_time = 2;
+
+ // The end of the last event establishing this link-process tuple.
+ google.protobuf.Timestamp end_time = 3;
+}
+
+// Origin of a process.
+message Origin {
+ // Type of the source of a process.
+ enum SourceType {
+ // Source is Unspecified
+ SOURCE_TYPE_UNSPECIFIED = 0;
+
+ // A custom source
+ CUSTOM = 1;
+
+ // BigQuery
+ BIGQUERY = 2;
+
+ // Data Fusion
+ DATA_FUSION = 3;
+
+ // Composer
+ COMPOSER = 4;
+
+ // Looker Studio
+ LOOKER_STUDIO = 5;
+ }
+
+ // Type of the source.
+ SourceType source_type = 1;
+
+ // If the source_type isn't CUSTOM, the value of this field should be a GCP
+ // resource name of the system, which reports lineage. The project and
+ // location parts of the resource name must match the project and location of
+ // the lineage resource being created. Examples:
+ //
+ // - `{source_type: COMPOSER, name:
+ // "projects/foo/locations/us/environments/bar"}`
+ // - `{source_type: BIGQUERY, name: "projects/foo/locations/eu"}`
+ // - `{source_type: CUSTOM, name: "myCustomIntegration"}`
+ string name = 2;
+}
diff --git a/third_party/googleapis/google/cloud/datacatalog/lineage/v1/lineage_grpc_service_config.json b/third_party/googleapis/google/cloud/datacatalog/lineage/v1/lineage_grpc_service_config.json
new file mode 100644
index 000000000..d333c6bab
--- /dev/null
+++ b/third_party/googleapis/google/cloud/datacatalog/lineage/v1/lineage_grpc_service_config.json
@@ -0,0 +1,20 @@
+{
+ "methodConfig": [
+ {
+ "name": [
+ {
+ "service": "google.cloud.datacatalog.lineage.v1.Lineage"
+ }
+ ],
+ "timeout": "60s",
+ "retryPolicy": {
+ "initialBackoff": "0.100s",
+ "maxBackoff": "60s",
+ "backoffMultiplier": 1.3,
+ "retryableStatusCodes": [
+ "UNAVAILABLE"
+ ]
+ }
+ }
+ ]
+}
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/BUILD.bazel b/third_party/googleapis/google/cloud/datacatalog/v1/BUILD.bazel
index 2186698c1..3caf0315d 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/BUILD.bazel
@@ -136,7 +136,7 @@ load(
go_proto_library(
name = "datacatalog_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1",
+ importpath = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb",
protos = [":datacatalog_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -150,9 +150,10 @@ go_gapic_library(
grpc_service_config = "datacatalog_grpc_service_config.json",
importpath = "cloud.google.com/go/datacatalog/apiv1;datacatalog",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = False,
service_yaml = "datacatalog_v1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
":datacatalog_go_proto",
"//google/iam/v1:iam_go_proto",
@@ -192,6 +193,7 @@ py_gapic_library(
srcs = [":datacatalog_proto"],
grpc_service_config = "datacatalog_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "datacatalog_v1.yaml",
transport = "grpc",
deps = [
"//google/iam/v1:iam_policy_py_proto",
@@ -243,6 +245,7 @@ php_gapic_library(
srcs = [":datacatalog_proto_with_info"],
grpc_service_config = "datacatalog_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "datacatalog_v1.yaml",
transport = "grpc+rest",
deps = [
":datacatalog_php_grpc",
@@ -280,7 +283,7 @@ nodejs_gapic_library(
package = "google.cloud.datacatalog.v1",
rest_numeric_enums = False,
service_yaml = "datacatalog_v1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
@@ -328,6 +331,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = False,
ruby_cloud_description = "DataCatalog is a centralized and unified data catalog service for all your Cloud resources, where users and systems can discover data, explore and curate its semantics, understand how to act on it, and help govern its usage.",
ruby_cloud_title = "Data Catalog V1",
+ service_yaml = "datacatalog_v1.yaml",
deps = [
":datacatalog_ruby_grpc",
":datacatalog_ruby_proto",
@@ -373,6 +377,7 @@ csharp_gapic_library(
grpc_service_config = "datacatalog_grpc_service_config.json",
rest_numeric_enums = False,
service_yaml = "datacatalog_v1.yaml",
+ transport = "grpc+rest",
deps = [
":datacatalog_csharp_grpc",
":datacatalog_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/bigquery.proto b/third_party/googleapis/google/cloud/datacatalog/v1/bigquery.proto
index 4be42ebba..33994ac3f 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/bigquery.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/bigquery.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_outer_classname = "BigQueryProto";
option java_package = "com.google.cloud.datacatalog.v1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/common.proto b/third_party/googleapis/google/cloud/datacatalog/v1/common.proto
index 7a6bef5f2..11483e32f 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/common.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/common.proto
@@ -20,7 +20,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/data_source.proto b/third_party/googleapis/google/cloud/datacatalog/v1/data_source.proto
index a73ff09c7..faf266662 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/data_source.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/data_source.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_outer_classname = "DataSourceProto";
option java_package = "com.google.cloud.datacatalog.v1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/datacatalog.proto b/third_party/googleapis/google/cloud/datacatalog/v1/datacatalog.proto
index 4508e0766..7c03a04d8 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/datacatalog.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/datacatalog.proto
@@ -38,7 +38,7 @@ import "google/protobuf/field_mask.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/dataplex_spec.proto b/third_party/googleapis/google/cloud/datacatalog/v1/dataplex_spec.proto
index 0cdba3e1f..bf47a373b 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/dataplex_spec.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/dataplex_spec.proto
@@ -21,7 +21,7 @@ import "google/cloud/datacatalog/v1/physical_schema.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_outer_classname = "DataplexSpecProto";
option java_package = "com.google.cloud.datacatalog.v1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/gcs_fileset_spec.proto b/third_party/googleapis/google/cloud/datacatalog/v1/gcs_fileset_spec.proto
index 82a165309..56d9f4d6e 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/gcs_fileset_spec.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/gcs_fileset_spec.proto
@@ -21,7 +21,7 @@ import "google/cloud/datacatalog/v1/timestamps.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/physical_schema.proto b/third_party/googleapis/google/cloud/datacatalog/v1/physical_schema.proto
index 414e95ca7..693cd6071 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/physical_schema.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/physical_schema.proto
@@ -18,7 +18,7 @@ package google.cloud.datacatalog.v1;
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_outer_classname = "PhysicalSchemaProto";
option java_package = "com.google.cloud.datacatalog.v1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/policytagmanager.proto b/third_party/googleapis/google/cloud/datacatalog/v1/policytagmanager.proto
index be4159884..45a8489e5 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/policytagmanager.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/policytagmanager.proto
@@ -28,7 +28,7 @@ import "google/protobuf/field_mask.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_outer_classname = "PolicyTagManagerProto";
option java_package = "com.google.cloud.datacatalog.v1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/policytagmanagerserialization.proto b/third_party/googleapis/google/cloud/datacatalog/v1/policytagmanagerserialization.proto
index a4fe4d8b9..9d320b21f 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/policytagmanagerserialization.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/policytagmanagerserialization.proto
@@ -24,7 +24,7 @@ import "google/cloud/datacatalog/v1/policytagmanager.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_outer_classname = "PolicyTagManagerSerializationProto";
option java_package = "com.google.cloud.datacatalog.v1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/schema.proto b/third_party/googleapis/google/cloud/datacatalog/v1/schema.proto
index b33caac48..f5a1f81eb 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/schema.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/schema.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/search.proto b/third_party/googleapis/google/cloud/datacatalog/v1/search.proto
index 88c06a46c..72dbe9f3f 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/search.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/search.proto
@@ -22,7 +22,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/table_spec.proto b/third_party/googleapis/google/cloud/datacatalog/v1/table_spec.proto
index cbf7ad3e9..a92e5990e 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/table_spec.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/table_spec.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/tags.proto b/third_party/googleapis/google/cloud/datacatalog/v1/tags.proto
index dedfd2f61..c5835af12 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/tags.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/tags.proto
@@ -22,7 +22,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/timestamps.proto b/third_party/googleapis/google/cloud/datacatalog/v1/timestamps.proto
index fe96d7d3f..cab8776cc 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/timestamps.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/timestamps.proto
@@ -21,7 +21,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1/usage.proto b/third_party/googleapis/google/cloud/datacatalog/v1/usage.proto
index d778e5121..07c3b140d 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1/usage.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1/usage.proto
@@ -21,7 +21,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/datacatalog/v1beta1/BUILD.bazel
index 75d9526e1..5e0fc99b5 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/datacatalog/v1beta1/BUILD.bazel
@@ -122,7 +122,7 @@ load(
go_proto_library(
name = "datacatalog_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1",
+ importpath = "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb",
protos = [":datacatalog_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -135,6 +135,8 @@ go_gapic_library(
srcs = [":datacatalog_proto_with_info"],
grpc_service_config = "datacatalog_grpc_service_config.json",
importpath = "cloud.google.com/go/datacatalog/apiv1beta1;datacatalog",
+ metadata = True,
+ release_level = "beta",
rest_numeric_enums = False,
service_yaml = "datacatalog_v1beta1.yaml",
transport = "grpc+rest",
@@ -176,6 +178,7 @@ py_gapic_library(
srcs = [":datacatalog_proto"],
grpc_service_config = "datacatalog_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "datacatalog_v1beta1.yaml",
transport = "grpc",
deps = [
"//google/iam/v1:iam_policy_py_proto",
@@ -227,6 +230,7 @@ php_gapic_library(
srcs = [":datacatalog_proto_with_info"],
grpc_service_config = "datacatalog_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "datacatalog_v1beta1.yaml",
transport = "grpc+rest",
deps = [
":datacatalog_php_grpc",
@@ -264,7 +268,7 @@ nodejs_gapic_library(
package = "google.cloud.datacatalog.v1beta1",
rest_numeric_enums = False,
service_yaml = "datacatalog_v1beta1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
@@ -303,6 +307,7 @@ ruby_cloud_gapic_library(
srcs = [":datacatalog_proto_with_info"],
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-datacatalog-v1beta1"],
rest_numeric_enums = False,
+ service_yaml = "datacatalog_v1beta1.yaml",
deps = [
":datacatalog_ruby_grpc",
":datacatalog_ruby_proto",
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1beta1/common.proto b/third_party/googleapis/google/cloud/datacatalog/v1beta1/common.proto
index a759b371e..f61608a66 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1beta1/common.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1beta1/common.proto
@@ -18,7 +18,7 @@ package google.cloud.datacatalog.v1beta1;
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1beta1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1beta1/datacatalog.proto b/third_party/googleapis/google/cloud/datacatalog/v1beta1/datacatalog.proto
index 5f265d5bf..0c6c0809b 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1beta1/datacatalog.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1beta1/datacatalog.proto
@@ -34,7 +34,7 @@ import "google/protobuf/field_mask.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1beta1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1beta1/gcs_fileset_spec.proto b/third_party/googleapis/google/cloud/datacatalog/v1beta1/gcs_fileset_spec.proto
index c8ca9779f..b7c6bcafa 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1beta1/gcs_fileset_spec.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1beta1/gcs_fileset_spec.proto
@@ -21,7 +21,7 @@ import "google/cloud/datacatalog/v1beta1/timestamps.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1beta1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1beta1/policytagmanager.proto b/third_party/googleapis/google/cloud/datacatalog/v1beta1/policytagmanager.proto
index 5602bcf16..7cc209055 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1beta1/policytagmanager.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1beta1/policytagmanager.proto
@@ -28,7 +28,7 @@ import "google/protobuf/field_mask.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_outer_classname = "PolicyTagManagerProto";
option java_package = "com.google.cloud.datacatalog.v1beta1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1beta1/policytagmanagerserialization.proto b/third_party/googleapis/google/cloud/datacatalog/v1beta1/policytagmanagerserialization.proto
index b6e4fb320..a1b2314d3 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1beta1/policytagmanagerserialization.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1beta1/policytagmanagerserialization.proto
@@ -25,7 +25,7 @@ import "google/api/client.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_outer_classname = "PolicyTagManagerSerializationProto";
option java_package = "com.google.cloud.datacatalog.v1beta1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1beta1/schema.proto b/third_party/googleapis/google/cloud/datacatalog/v1beta1/schema.proto
index d8e69fd46..c51234aa4 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1beta1/schema.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1beta1/schema.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1beta1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1beta1/search.proto b/third_party/googleapis/google/cloud/datacatalog/v1beta1/search.proto
index afaa643d7..0455662cb 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1beta1/search.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1beta1/search.proto
@@ -20,7 +20,7 @@ import "google/cloud/datacatalog/v1beta1/common.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1beta1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1beta1/table_spec.proto b/third_party/googleapis/google/cloud/datacatalog/v1beta1/table_spec.proto
index c08f43efd..abfc3fe46 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1beta1/table_spec.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1beta1/table_spec.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1beta1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1beta1/tags.proto b/third_party/googleapis/google/cloud/datacatalog/v1beta1/tags.proto
index c15fb218a..57a683bbe 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1beta1/tags.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1beta1/tags.proto
@@ -22,7 +22,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1beta1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datacatalog/v1beta1/timestamps.proto b/third_party/googleapis/google/cloud/datacatalog/v1beta1/timestamps.proto
index dc49c75cb..e524d671c 100644
--- a/third_party/googleapis/google/cloud/datacatalog/v1beta1/timestamps.proto
+++ b/third_party/googleapis/google/cloud/datacatalog/v1beta1/timestamps.proto
@@ -21,7 +21,7 @@ import "google/protobuf/timestamp.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.DataCatalog.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datacatalog/v1beta1;datacatalog";
+option go_package = "cloud.google.com/go/datacatalog/apiv1beta1/datacatalogpb;datacatalogpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datacatalog.v1beta1";
option php_namespace = "Google\\Cloud\\DataCatalog\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/dataform/v1alpha2/BUILD.bazel b/third_party/googleapis/google/cloud/dataform/v1alpha2/BUILD.bazel
index 642c72d0c..bd516cb27 100644
--- a/third_party/googleapis/google/cloud/dataform/v1alpha2/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/dataform/v1alpha2/BUILD.bazel
@@ -124,7 +124,7 @@ load(
go_proto_library(
name = "dataform_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/dataform/v1alpha2",
+ importpath = "cloud.google.com/go/dataform/apiv1alpha2/dataformpb",
protos = [":dataform_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -138,6 +138,7 @@ go_gapic_library(
grpc_service_config = "dataform_grpc_service_config.json",
importpath = "cloud.google.com/go/dataform/apiv1alpha2;dataform",
metadata = True,
+ release_level = "alpha",
rest_numeric_enums = True,
service_yaml = "dataform_v1alpha2.yaml",
transport = "grpc+rest",
@@ -181,7 +182,7 @@ py_gapic_library(
grpc_service_config = "dataform_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "dataform_v1alpha2.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -354,6 +355,7 @@ csharp_gapic_library(
grpc_service_config = "dataform_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "dataform_v1alpha2.yaml",
+ transport = "grpc+rest",
deps = [
":dataform_csharp_grpc",
":dataform_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/dataform/v1alpha2/dataform.proto b/third_party/googleapis/google/cloud/dataform/v1alpha2/dataform.proto
index 771acdb48..6547cba48 100644
--- a/third_party/googleapis/google/cloud/dataform/v1alpha2/dataform.proto
+++ b/third_party/googleapis/google/cloud/dataform/v1alpha2/dataform.proto
@@ -25,7 +25,7 @@ import "google/protobuf/field_mask.proto";
import "google/type/interval.proto";
option csharp_namespace = "Google.Cloud.Dataform.V1Alpha2";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataform/v1alpha2;dataform";
+option go_package = "cloud.google.com/go/dataform/apiv1alpha2/dataformpb;dataformpb";
option java_multiple_files = true;
option java_outer_classname = "DataformProto";
option java_package = "com.google.cloud.dataform.v1alpha2";
diff --git a/third_party/googleapis/google/cloud/dataform/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/dataform/v1beta1/BUILD.bazel
index bfe126a21..d779d1de6 100644
--- a/third_party/googleapis/google/cloud/dataform/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/dataform/v1beta1/BUILD.bazel
@@ -124,7 +124,7 @@ load(
go_proto_library(
name = "dataform_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/dataform/v1beta1",
+ importpath = "cloud.google.com/go/dataform/apiv1beta1/dataformpb",
protos = [":dataform_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -138,6 +138,7 @@ go_gapic_library(
grpc_service_config = "dataform_grpc_service_config.json",
importpath = "cloud.google.com/go/dataform/apiv1beta1;dataform",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "dataform_v1beta1.yaml",
transport = "grpc+rest",
@@ -181,7 +182,7 @@ py_gapic_library(
grpc_service_config = "dataform_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "dataform_v1beta1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
)
# Open Source Packages
@@ -348,6 +349,7 @@ csharp_gapic_library(
grpc_service_config = "dataform_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "dataform_v1beta1.yaml",
+ transport = "grpc+rest",
deps = [
":dataform_csharp_grpc",
":dataform_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/dataform/v1beta1/dataform.proto b/third_party/googleapis/google/cloud/dataform/v1beta1/dataform.proto
index 57d43c3e0..466459c30 100644
--- a/third_party/googleapis/google/cloud/dataform/v1beta1/dataform.proto
+++ b/third_party/googleapis/google/cloud/dataform/v1beta1/dataform.proto
@@ -25,7 +25,7 @@ import "google/protobuf/field_mask.proto";
import "google/type/interval.proto";
option csharp_namespace = "Google.Cloud.Dataform.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataform/v1beta1;dataform";
+option go_package = "cloud.google.com/go/dataform/apiv1beta1/dataformpb;dataformpb";
option java_multiple_files = true;
option java_outer_classname = "DataformProto";
option java_package = "com.google.cloud.dataform.v1beta1";
diff --git a/third_party/googleapis/google/cloud/datafusion/v1/BUILD.bazel b/third_party/googleapis/google/cloud/datafusion/v1/BUILD.bazel
index da2689d90..879868629 100644
--- a/third_party/googleapis/google/cloud/datafusion/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/datafusion/v1/BUILD.bazel
@@ -29,6 +29,7 @@ proto_library(
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
@@ -115,7 +116,7 @@ load(
go_proto_library(
name = "datafusion_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/datafusion/v1",
+ importpath = "cloud.google.com/go/datafusion/apiv1/datafusionpb",
protos = [":datafusion_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -129,6 +130,7 @@ go_gapic_library(
grpc_service_config = "datafusion_grpc_service_config.json",
importpath = "cloud.google.com/go/datafusion/apiv1;datafusion",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "datafusion_v1.yaml",
transport = "grpc+rest",
@@ -178,7 +180,8 @@ py_gapic_library(
"python-gapic-name=data_fusion",
],
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "datafusion_v1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -309,6 +312,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Cloud Data Fusion is a fully managed, cloud-native, enterprise data integration service for quickly building and managing data pipelines.",
ruby_cloud_title = "Cloud Data Fusion V1",
+ service_yaml = "datafusion_v1.yaml",
deps = [
":datafusion_ruby_grpc",
":datafusion_ruby_proto",
@@ -354,6 +358,7 @@ csharp_gapic_library(
grpc_service_config = "datafusion_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "datafusion_v1.yaml",
+ transport = "grpc+rest",
deps = [
":datafusion_csharp_grpc",
":datafusion_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/datafusion/v1/datafusion.proto b/third_party/googleapis/google/cloud/datafusion/v1/datafusion.proto
index 615105093..9cbaaf97e 100644
--- a/third_party/googleapis/google/cloud/datafusion/v1/datafusion.proto
+++ b/third_party/googleapis/google/cloud/datafusion/v1/datafusion.proto
@@ -25,7 +25,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.DataFusion.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datafusion/v1;datafusion";
+option go_package = "cloud.google.com/go/datafusion/apiv1/datafusionpb;datafusionpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datafusion.v1";
option php_namespace = "Google\\Cloud\\DataFusion\\V1";
diff --git a/third_party/googleapis/google/cloud/datafusion/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/datafusion/v1beta1/BUILD.bazel
index 30733daff..1c192fe51 100644
--- a/third_party/googleapis/google/cloud/datafusion/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/datafusion/v1beta1/BUILD.bazel
@@ -31,6 +31,7 @@ proto_library(
"//google/iam/v1:policy_proto",
"//google/longrunning:operations_proto",
"//google/rpc:status_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
@@ -119,7 +120,7 @@ load(
go_proto_library(
name = "datafusion_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/datafusion/v1beta1",
+ importpath = "cloud.google.com/go/datafusion/apiv1beta1/datafusionpb",
protos = [":datafusion_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -135,6 +136,7 @@ go_gapic_library(
grpc_service_config = "datafusion_grpc_service_config.json",
importpath = "cloud.google.com/go/datafusion/apiv1beta1;datafusion",
metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "datafusion_v1beta1.yaml",
transport = "grpc+rest",
@@ -180,7 +182,8 @@ py_gapic_library(
srcs = [":datafusion_proto"],
grpc_service_config = "datafusion_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "datafusion_v1beta1.yaml",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -314,6 +317,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Cloud Data Fusion is a fully managed, cloud-native, enterprise data integration service for quickly building and managing data pipelines.",
ruby_cloud_title = "Cloud Data Fusion V1beta1",
+ service_yaml = "datafusion_v1beta1.yaml",
deps = [
":datafusion_ruby_grpc",
":datafusion_ruby_proto",
@@ -359,6 +363,7 @@ csharp_gapic_library(
grpc_service_config = "datafusion_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "datafusion_v1beta1.yaml",
+ transport = "grpc+rest",
deps = [
":datafusion_csharp_grpc",
":datafusion_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/datafusion/v1beta1/v1beta1.proto b/third_party/googleapis/google/cloud/datafusion/v1beta1/v1beta1.proto
index ac3f309c1..ef2c68579 100644
--- a/third_party/googleapis/google/cloud/datafusion/v1beta1/v1beta1.proto
+++ b/third_party/googleapis/google/cloud/datafusion/v1beta1/v1beta1.proto
@@ -27,7 +27,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.DataFusion.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datafusion/v1beta1;datafusion";
+option go_package = "cloud.google.com/go/datafusion/apiv1beta1/datafusionpb;datafusionpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datafusion.v1beta1";
option php_namespace = "Google\\Cloud\\DataFusion\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datalabeling/v1beta1/BUILD.bazel b/third_party/googleapis/google/cloud/datalabeling/v1beta1/BUILD.bazel
index e26610631..b260ab719 100644
--- a/third_party/googleapis/google/cloud/datalabeling/v1beta1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/datalabeling/v1beta1/BUILD.bazel
@@ -117,7 +117,7 @@ load(
go_proto_library(
name = "datalabeling_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1",
+ importpath = "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb",
protos = [":datalabeling_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -131,6 +131,8 @@ go_gapic_library(
srcs = [":datalabeling_proto_with_info"],
grpc_service_config = "datalabeling_grpc_service_config.json",
importpath = "cloud.google.com/go/datalabeling/apiv1beta1;datalabeling",
+ metadata = True,
+ release_level = "beta",
rest_numeric_enums = True,
service_yaml = "datalabeling_v1beta1.yaml",
transport = "grpc+rest",
@@ -175,6 +177,7 @@ py_gapic_library(
srcs = [":datalabeling_proto"],
grpc_service_config = "datalabeling_grpc_service_config.json",
rest_numeric_enums = True,
+ service_yaml = "datalabeling_v1beta1.yaml",
transport = "grpc",
)
@@ -259,7 +262,7 @@ nodejs_gapic_library(
package = "google.cloud.datalabeling.v1beta1",
rest_numeric_enums = True,
service_yaml = "datalabeling_v1beta1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
@@ -307,6 +310,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "AI Platform Data Labeling Service lets you work with human labelers to generate highly accurate labels for a collection of data that you can use in machine learning models.",
ruby_cloud_title = "AI Platform Data Labeling Service V1beta1",
+ service_yaml = "datalabeling_v1beta1.yaml",
deps = [
":datalabeling_ruby_grpc",
":datalabeling_ruby_proto",
@@ -352,6 +356,7 @@ csharp_gapic_library(
grpc_service_config = "datalabeling_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "datalabeling_v1beta1.yaml",
+ transport = "grpc",
deps = [
":datalabeling_csharp_grpc",
":datalabeling_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/datalabeling/v1beta1/annotation.proto b/third_party/googleapis/google/cloud/datalabeling/v1beta1/annotation.proto
index d62cbfd13..fa8580551 100644
--- a/third_party/googleapis/google/cloud/datalabeling/v1beta1/annotation.proto
+++ b/third_party/googleapis/google/cloud/datalabeling/v1beta1/annotation.proto
@@ -21,7 +21,7 @@ import "google/cloud/datalabeling/v1beta1/annotation_spec_set.proto";
import "google/protobuf/duration.proto";
option csharp_namespace = "Google.Cloud.DataLabeling.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1;datalabeling";
+option go_package = "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb;datalabelingpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datalabeling.v1beta1";
option php_namespace = "Google\\Cloud\\DataLabeling\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datalabeling/v1beta1/annotation_spec_set.proto b/third_party/googleapis/google/cloud/datalabeling/v1beta1/annotation_spec_set.proto
index 7670ae6a9..b4d67e476 100644
--- a/third_party/googleapis/google/cloud/datalabeling/v1beta1/annotation_spec_set.proto
+++ b/third_party/googleapis/google/cloud/datalabeling/v1beta1/annotation_spec_set.proto
@@ -20,7 +20,7 @@ package google.cloud.datalabeling.v1beta1;
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.DataLabeling.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1;datalabeling";
+option go_package = "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb;datalabelingpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datalabeling.v1beta1";
option php_namespace = "Google\\Cloud\\DataLabeling\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datalabeling/v1beta1/data_labeling_service.proto b/third_party/googleapis/google/cloud/datalabeling/v1beta1/data_labeling_service.proto
index 5d0746c8a..fc3b50c7e 100644
--- a/third_party/googleapis/google/cloud/datalabeling/v1beta1/data_labeling_service.proto
+++ b/third_party/googleapis/google/cloud/datalabeling/v1beta1/data_labeling_service.proto
@@ -32,7 +32,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.DataLabeling.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1;datalabeling";
+option go_package = "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb;datalabelingpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datalabeling.v1beta1";
option php_namespace = "Google\\Cloud\\DataLabeling\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datalabeling/v1beta1/data_payloads.proto b/third_party/googleapis/google/cloud/datalabeling/v1beta1/data_payloads.proto
index a9ca0fc93..6d663486d 100644
--- a/third_party/googleapis/google/cloud/datalabeling/v1beta1/data_payloads.proto
+++ b/third_party/googleapis/google/cloud/datalabeling/v1beta1/data_payloads.proto
@@ -20,7 +20,7 @@ package google.cloud.datalabeling.v1beta1;
import "google/protobuf/duration.proto";
option csharp_namespace = "Google.Cloud.DataLabeling.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1;datalabeling";
+option go_package = "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb;datalabelingpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datalabeling.v1beta1";
option php_namespace = "Google\\Cloud\\DataLabeling\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datalabeling/v1beta1/dataset.proto b/third_party/googleapis/google/cloud/datalabeling/v1beta1/dataset.proto
index 557279fa7..038bee18f 100644
--- a/third_party/googleapis/google/cloud/datalabeling/v1beta1/dataset.proto
+++ b/third_party/googleapis/google/cloud/datalabeling/v1beta1/dataset.proto
@@ -25,7 +25,7 @@ import "google/cloud/datalabeling/v1beta1/human_annotation_config.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.DataLabeling.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1;datalabeling";
+option go_package = "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb;datalabelingpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datalabeling.v1beta1";
option php_namespace = "Google\\Cloud\\DataLabeling\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datalabeling/v1beta1/evaluation.proto b/third_party/googleapis/google/cloud/datalabeling/v1beta1/evaluation.proto
index 950fa82cf..557d7f727 100644
--- a/third_party/googleapis/google/cloud/datalabeling/v1beta1/evaluation.proto
+++ b/third_party/googleapis/google/cloud/datalabeling/v1beta1/evaluation.proto
@@ -23,7 +23,7 @@ import "google/cloud/datalabeling/v1beta1/annotation_spec_set.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.DataLabeling.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1;datalabeling";
+option go_package = "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb;datalabelingpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datalabeling.v1beta1";
option php_namespace = "Google\\Cloud\\DataLabeling\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datalabeling/v1beta1/evaluation_job.proto b/third_party/googleapis/google/cloud/datalabeling/v1beta1/evaluation_job.proto
index d40f8f201..fc98544d5 100644
--- a/third_party/googleapis/google/cloud/datalabeling/v1beta1/evaluation_job.proto
+++ b/third_party/googleapis/google/cloud/datalabeling/v1beta1/evaluation_job.proto
@@ -25,7 +25,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.DataLabeling.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1;datalabeling";
+option go_package = "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb;datalabelingpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datalabeling.v1beta1";
option php_namespace = "Google\\Cloud\\DataLabeling\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datalabeling/v1beta1/human_annotation_config.proto b/third_party/googleapis/google/cloud/datalabeling/v1beta1/human_annotation_config.proto
index 9cc2424be..0b2b016c0 100644
--- a/third_party/googleapis/google/cloud/datalabeling/v1beta1/human_annotation_config.proto
+++ b/third_party/googleapis/google/cloud/datalabeling/v1beta1/human_annotation_config.proto
@@ -21,7 +21,7 @@ import "google/api/field_behavior.proto";
import "google/protobuf/duration.proto";
option csharp_namespace = "Google.Cloud.DataLabeling.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1;datalabeling";
+option go_package = "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb;datalabelingpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datalabeling.v1beta1";
option php_namespace = "Google\\Cloud\\DataLabeling\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datalabeling/v1beta1/instruction.proto b/third_party/googleapis/google/cloud/datalabeling/v1beta1/instruction.proto
index 9b19d32fd..6227c7cfd 100644
--- a/third_party/googleapis/google/cloud/datalabeling/v1beta1/instruction.proto
+++ b/third_party/googleapis/google/cloud/datalabeling/v1beta1/instruction.proto
@@ -22,7 +22,7 @@ import "google/cloud/datalabeling/v1beta1/dataset.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.DataLabeling.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1;datalabeling";
+option go_package = "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb;datalabelingpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datalabeling.v1beta1";
option php_namespace = "Google\\Cloud\\DataLabeling\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datalabeling/v1beta1/operations.proto b/third_party/googleapis/google/cloud/datalabeling/v1beta1/operations.proto
index 02d596fc9..a467dc3a6 100644
--- a/third_party/googleapis/google/cloud/datalabeling/v1beta1/operations.proto
+++ b/third_party/googleapis/google/cloud/datalabeling/v1beta1/operations.proto
@@ -23,7 +23,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.DataLabeling.V1Beta1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1;datalabeling";
+option go_package = "cloud.google.com/go/datalabeling/apiv1beta1/datalabelingpb;datalabelingpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.datalabeling.v1beta1";
option php_namespace = "Google\\Cloud\\DataLabeling\\V1beta1";
diff --git a/third_party/googleapis/google/cloud/datapipelines/logging/v1/BUILD.bazel b/third_party/googleapis/google/cloud/datapipelines/logging/v1/BUILD.bazel
new file mode 100644
index 000000000..6b81c9037
--- /dev/null
+++ b/third_party/googleapis/google/cloud/datapipelines/logging/v1/BUILD.bazel
@@ -0,0 +1,177 @@
+# This file was automatically generated by BuildFileGenerator
+
+# This is an API workspace, having public visibility by default makes perfect sense.
+package(default_visibility = ["//visibility:public"])
+
+##############################################################################
+# Common
+##############################################################################
+load("@rules_proto//proto:defs.bzl", "proto_library")
+
+proto_library(
+ name = "logging_proto",
+ srcs = [
+ "logging.proto",
+ ],
+ deps = [
+ "//google/rpc:status_proto",
+ ],
+)
+
+##############################################################################
+# Java
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "java_grpc_library",
+ "java_proto_library",
+)
+
+java_proto_library(
+ name = "logging_java_proto",
+ deps = [":logging_proto"],
+)
+
+java_grpc_library(
+ name = "logging_java_grpc",
+ srcs = [":logging_proto"],
+ deps = [":logging_java_proto"],
+)
+
+##############################################################################
+# Go
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "go_proto_library",
+)
+
+go_proto_library(
+ name = "logging_go_proto",
+ compilers = ["@io_bazel_rules_go//proto:go_grpc"],
+ importpath = "cloud.google.com/go/datapipelines/logging/apiv1/loggingpb",
+ protos = [":logging_proto"],
+ deps = [
+ "//google/rpc:status_go_proto",
+ ],
+)
+
+##############################################################################
+# Python
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "moved_proto_library",
+ "py_grpc_library",
+ "py_proto_library",
+)
+
+moved_proto_library(
+ name = "logging_moved_proto",
+ srcs = [":logging_proto"],
+ deps = [
+ "//google/rpc:status_proto",
+ ],
+)
+
+py_proto_library(
+ name = "logging_py_proto",
+ deps = [":logging_moved_proto"],
+)
+
+py_grpc_library(
+ name = "logging_py_grpc",
+ srcs = [":logging_moved_proto"],
+ deps = [":logging_py_proto"],
+)
+
+##############################################################################
+# PHP
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "php_grpc_library",
+ "php_proto_library",
+)
+
+php_proto_library(
+ name = "logging_php_proto",
+ deps = [":logging_proto"],
+)
+
+php_grpc_library(
+ name = "logging_php_grpc",
+ srcs = [":logging_proto"],
+ deps = [":logging_php_proto"],
+)
+
+##############################################################################
+# Node.js
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "nodejs_gapic_assembly_pkg",
+ "nodejs_gapic_library",
+)
+
+
+##############################################################################
+# Ruby
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "ruby_grpc_library",
+ "ruby_proto_library",
+)
+
+ruby_proto_library(
+ name = "logging_ruby_proto",
+ deps = [":logging_proto"],
+)
+
+ruby_grpc_library(
+ name = "logging_ruby_grpc",
+ srcs = [":logging_proto"],
+ deps = [":logging_ruby_proto"],
+)
+
+##############################################################################
+# C#
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "csharp_grpc_library",
+ "csharp_proto_library",
+)
+
+csharp_proto_library(
+ name = "logging_csharp_proto",
+ deps = [":logging_proto"],
+)
+
+csharp_grpc_library(
+ name = "logging_csharp_grpc",
+ srcs = [":logging_proto"],
+ deps = [":logging_csharp_proto"],
+)
+
+##############################################################################
+# C++
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "cc_grpc_library",
+ "cc_proto_library",
+)
+
+cc_proto_library(
+ name = "logging_cc_proto",
+ deps = [":logging_proto"],
+)
+
+cc_grpc_library(
+ name = "logging_cc_grpc",
+ srcs = [":logging_proto"],
+ grpc_only = True,
+ deps = [":logging_cc_proto"],
+)
diff --git a/third_party/googleapis/google/cloud/datapipelines/logging/v1/logging.proto b/third_party/googleapis/google/cloud/datapipelines/logging/v1/logging.proto
new file mode 100644
index 000000000..ea176786d
--- /dev/null
+++ b/third_party/googleapis/google/cloud/datapipelines/logging/v1/logging.proto
@@ -0,0 +1,140 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.datapipelines.logging.v1;
+
+import "google/rpc/status.proto";
+
+option go_package = "cloud.google.com/go/datapipelines/logging/apiv1/loggingpb;loggingpb";
+option java_multiple_files = true;
+option java_outer_classname = "LoggingProto";
+option java_package = "com.google.cloud.datapipelines.logging.v1";
+
+// Cloud Logging structured payload for events generated from Data Pipelines API
+// requests.
+message RequestLogEntry {
+ // Type of a Data Pipelines API request.
+ enum RequestType {
+ // Default value. This value is not used.
+ REQUEST_TYPE_UNSPECIFIED = 0;
+
+ // A Data Pipelines Create Pipeline request.
+ CREATE_PIPELINE = 1;
+
+ // A Data Pipelines Update Pipeline request.
+ UPDATE_PIPELINE = 2;
+
+ // A Data Pipelines Delete Pipeline request.
+ DELETE_PIPELINE = 3;
+
+ // A Data Pipelines List Pipelines request.
+ LIST_PIPELINES = 4;
+
+ // A Data Pipelines Get Pipeline request.
+ GET_PIPELINE = 5;
+
+ // A Data Pipelines Stop Pipeline request.
+ STOP_PIPELINE = 6;
+
+ // A Data Pipelines Run Pipeline request.
+ RUN_PIPELINE = 7;
+
+ // A Data Pipelines List Jobs request.
+ LIST_JOBS = 8;
+ }
+
+ // Cause code for a Data Pipelines API request error.
+ enum ErrorCause {
+ // Default value. This value is not used.
+ ERROR_CAUSE_UNSPECIFIED = 0;
+
+ // The request is invalid.
+ INVALID_REQUEST = 1;
+
+ // Failed to fetch project number for the provided project id.
+ PROJECT_NUMBER_NOT_FOUND = 2;
+
+ // The given pipeline already exists.
+ PIPELINE_ID_ALREADY_EXISTS = 3;
+
+ // Failed to allocate a token for the per project pipeline count quota.
+ PIPELINE_QUOTA_ALLOCATION_FAILED = 4;
+
+ // The given pipeline is not found.
+ PIPELINE_NOT_FOUND = 5;
+
+ // The pipeline's workload is invalid.
+ INVALID_PIPELINE_WORKLOAD = 6;
+
+ // The user cannot act as the Dataflow worker service account.
+ DATAFLOW_WORKER_SERVICE_ACCOUNT_PERMISSION_DENIED = 7;
+
+ // The user cannot act as the Cloud Scheduler service account.
+ CLOUD_SCHEDULER_SERVICE_ACCOUNT_PERMISSION_DENIED = 8;
+
+ // Issues related to the per service per project service account.
+ INTERNAL_DATA_PIPELINES_SERVICE_ACCOUNT_ISSUE = 9;
+
+ // Invalid argument in Cloud Scheduler service call.
+ CLOUD_SCHEDULER_INVALID_ARGUMENT = 10;
+
+ // Exceeds Cloud Scheduler service quota limit.
+ CLOUD_SCHEDULER_RESOURCE_EXHAUSTED = 11;
+
+ // Cloud Scheduler job not found.
+ CLOUD_SCHEDULER_JOB_NOT_FOUND = 12;
+
+ // Other Cloud Scheduler related issues.
+ OTHER_CLOUD_SCHEDULER_ISSUE = 13;
+
+ // Dataflow job with the same name already exists.
+ DATAFLOW_JOB_ALREADY_EXISTS = 14;
+
+ // Invalid argument in Dataflow service call.
+ DATAFLOW_INVALID_ARGUMENT = 15;
+
+ // Exceeds Dataflow service quota limit.
+ DATAFLOW_RESOURCE_EXHAUSTED = 16;
+
+ // Dataflow job not found.
+ DATAFLOW_JOB_NOT_FOUND = 17;
+
+ // Other Dataflow related issues.
+ OTHER_DATAFLOW_ISSUE = 18;
+
+ // Database related issues.
+ DATABASE_ERROR = 19;
+
+ // Request with the wrong pipeline type. For example, RunPipeline cannot be
+ // used with a streaming pipeline.
+ WRONG_PIPELINE_TYPE = 20;
+
+ // Issues related to other Google internal services/systems.
+ INTERNAL_ERROR = 21;
+
+ // Cannot find the given pipeline or project.
+ PIPELINE_OR_PROJECT_NOT_FOUND = 22;
+ }
+
+ // Type of the Data Pipelines API request.
+ RequestType request_type = 1;
+
+ // The resulting status of the Data Pipelines API request.
+ google.rpc.Status status = 2;
+
+ // Cause of the error status.
+ ErrorCause error_cause = 3;
+}
diff --git a/third_party/googleapis/google/cloud/dataplex/BUILD.bazel b/third_party/googleapis/google/cloud/dataplex/BUILD.bazel
index a0a049f6c..2412eec39 100644
--- a/third_party/googleapis/google/cloud/dataplex/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/dataplex/BUILD.bazel
@@ -21,7 +21,7 @@ ruby_cloud_gapic_library(
srcs = ["//google/cloud/dataplex/v1:dataplex_proto_with_info"],
extra_protoc_parameters = [
"ruby-cloud-gem-name=google-cloud-dataplex",
- "ruby-cloud-wrapper-of=v1:0.2",
+ "ruby-cloud-wrapper-of=v1:0.6",
"ruby-cloud-product-url=https://cloud.google.com/dataplex/",
"ruby-cloud-api-id=dataplex.googleapis.com",
"ruby-cloud-api-shortname=dataplex",
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/BUILD.bazel b/third_party/googleapis/google/cloud/dataplex/v1/BUILD.bazel
index 93111dd01..ffdc097f9 100644
--- a/third_party/googleapis/google/cloud/dataplex/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/dataplex/v1/BUILD.bazel
@@ -23,8 +23,12 @@ proto_library(
srcs = [
"analyze.proto",
"content.proto",
+ "data_profile.proto",
+ "data_quality.proto",
+ "datascans.proto",
"logs.proto",
"metadata.proto",
+ "processing.proto",
"resources.proto",
"service.proto",
"tasks.proto",
@@ -103,6 +107,8 @@ java_gapic_test(
test_classes = [
"com.google.cloud.dataplex.v1.ContentServiceClientHttpJsonTest",
"com.google.cloud.dataplex.v1.ContentServiceClientTest",
+ "com.google.cloud.dataplex.v1.DataScanServiceClientHttpJsonTest",
+ "com.google.cloud.dataplex.v1.DataScanServiceClientTest",
"com.google.cloud.dataplex.v1.DataplexServiceClientHttpJsonTest",
"com.google.cloud.dataplex.v1.DataplexServiceClientTest",
"com.google.cloud.dataplex.v1.MetadataServiceClientHttpJsonTest",
@@ -138,7 +144,7 @@ load(
go_proto_library(
name = "dataplex_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/dataplex/v1",
+ importpath = "cloud.google.com/go/dataplex/apiv1/dataplexpb",
protos = [":dataplex_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -153,6 +159,7 @@ go_gapic_library(
grpc_service_config = "dataplex_grpc_service_config.json",
importpath = "cloud.google.com/go/dataplex/apiv1;dataplex",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "dataplex_v1.yaml",
transport = "grpc",
@@ -383,6 +390,7 @@ csharp_gapic_library(
grpc_service_config = "dataplex_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "dataplex_v1.yaml",
+ transport = "grpc+rest",
deps = [
":dataplex_csharp_grpc",
":dataplex_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/analyze.proto b/third_party/googleapis/google/cloud/dataplex/v1/analyze.proto
index ece76eb5a..9befe7ba5 100644
--- a/third_party/googleapis/google/cloud/dataplex/v1/analyze.proto
+++ b/third_party/googleapis/google/cloud/dataplex/v1/analyze.proto
@@ -22,7 +22,7 @@ import "google/cloud/dataplex/v1/resources.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataplex/v1;dataplex";
+option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
option java_multiple_files = true;
option java_outer_classname = "AnalyzeProto";
option java_package = "com.google.cloud.dataplex.v1";
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/content.proto b/third_party/googleapis/google/cloud/dataplex/v1/content.proto
index 9064de5c3..b63d8ae97 100644
--- a/third_party/googleapis/google/cloud/dataplex/v1/content.proto
+++ b/third_party/googleapis/google/cloud/dataplex/v1/content.proto
@@ -26,7 +26,7 @@ import "google/iam/v1/policy.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataplex/v1;dataplex";
+option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
option java_multiple_files = true;
option java_outer_classname = "ContentProto";
option java_package = "com.google.cloud.dataplex.v1";
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/data_profile.proto b/third_party/googleapis/google/cloud/dataplex/v1/data_profile.proto
new file mode 100644
index 000000000..05a005f2e
--- /dev/null
+++ b/third_party/googleapis/google/cloud/dataplex/v1/data_profile.proto
@@ -0,0 +1,207 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.dataplex.v1;
+
+import "google/cloud/dataplex/v1/processing.proto";
+
+option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
+option java_multiple_files = true;
+option java_outer_classname = "DataProfileProto";
+option java_package = "com.google.cloud.dataplex.v1";
+
+// DataProfileScan related setting.
+message DataProfileSpec {}
+
+// DataProfileResult defines the output of DataProfileScan.
+// Each field of the table will have field type specific profile result.
+message DataProfileResult {
+ // Profile information describing the structure and layout of the data
+ // and contains the profile info.
+ message Profile {
+ // Represents a column field within a table schema.
+ message Field {
+ // ProfileInfo defines the profile information for each schema field type.
+ message ProfileInfo {
+ // StringFieldInfo defines output info for any string type field.
+ message StringFieldInfo {
+ // The minimum length of the string field in the sampled data.
+ // Optional if zero non-null rows.
+ int64 min_length = 1;
+
+ // The maximum length of a string field in the sampled data.
+ // Optional if zero non-null rows.
+ int64 max_length = 2;
+
+ // The average length of a string field in the sampled data.
+ // Optional if zero non-null rows.
+ double average_length = 3;
+ }
+
+ // IntegerFieldInfo defines output for any integer type field.
+ message IntegerFieldInfo {
+ // The average of non-null values of integer field in the sampled
+ // data. Return NaN, if the field has a NaN. Optional if zero non-null
+ // rows.
+ double average = 1;
+
+ // The standard deviation of non-null of integer field in the sampled
+ // data. Return NaN, if the field has a NaN. Optional if zero non-null
+ // rows.
+ double standard_deviation = 3;
+
+ // The minimum value of an integer field in the sampled data.
+ // Return NaN, if the field has a NaN. Optional if zero non-null
+ // rows.
+ int64 min = 4;
+
+ // A quartile divide the number of data points into four parts, or
+ // quarters, of more-or-less equal size. Three main quartiles used
+ // are: The first quartile (Q1) splits off the lowest 25% of data from
+ // the highest 75%. It is also known as the lower or 25th empirical
+ // quartile, as 25% of the data is below this point. The second
+ // quartile (Q2) is the median of a data set. So, 50% of the data lies
+ // below this point. The third quartile (Q3) splits off the highest
+ // 25% of data from the lowest 75%. It is known as the upper or 75th
+ // empirical quartile, as 75% of the data lies below this point. So,
+ // here the quartiles is provided as an ordered list of quartile
+ // values, occurring in order Q1, median, Q3.
+ repeated int64 quartiles = 6;
+
+ // The maximum value of an integer field in the sampled data.
+ // Return NaN, if the field has a NaN. Optional if zero non-null
+ // rows.
+ int64 max = 5;
+ }
+
+ // DoubleFieldInfo defines output for any double type field.
+ message DoubleFieldInfo {
+ // The average of non-null values of double field in the sampled data.
+ // Return NaN, if the field has a NaN. Optional if zero non-null rows.
+ double average = 1;
+
+ // The standard deviation of non-null of double field in the sampled
+ // data. Return NaN, if the field has a NaN. Optional if zero non-null
+ // rows.
+ double standard_deviation = 3;
+
+ // The minimum value of a double field in the sampled data.
+ // Return NaN, if the field has a NaN. Optional if zero non-null
+ // rows.
+ double min = 4;
+
+ // A quartile divide the numebr of data points into four parts, or
+ // quarters, of more-or-less equal size. Three main quartiles used
+ // are: The first quartile (Q1) splits off the lowest 25% of data from
+ // the highest 75%. It is also known as the lower or 25th empirical
+ // quartile, as 25% of the data is below this point. The second
+ // quartile (Q2) is the median of a data set. So, 50% of the data lies
+ // below this point. The third quartile (Q3) splits off the highest
+ // 25% of data from the lowest 75%. It is known as the upper or 75th
+ // empirical quartile, as 75% of the data lies below this point. So,
+ // here the quartiles is provided as an ordered list of quartile
+ // values, occurring in order Q1, median, Q3.
+ repeated double quartiles = 6;
+
+ // The maximum value of a double field in the sampled data.
+ // Return NaN, if the field has a NaN. Optional if zero non-null
+ // rows.
+ double max = 5;
+ }
+
+ // The TopNValue defines the structure of output of top N values of a
+ // field.
+ message TopNValue {
+ // The value is the string value of the actual value from the field.
+ string value = 1;
+
+ // The frequency count of the corresponding value in the field.
+ int64 count = 2;
+ }
+
+ // The ratio of null rows against the rows in the sampled data.
+ double null_ratio = 2;
+
+ // The ratio of rows that are distinct against the rows in the sampled
+ // data.
+ double distinct_ratio = 3;
+
+ // The array of top N values of the field in the sampled data.
+ // Currently N is set as 10 or equal to distinct values in the field,
+ // whichever is smaller. This will be optional for complex non-groupable
+ // data-types such as JSON, ARRAY, JSON, STRUCT.
+ repeated TopNValue top_n_values = 4;
+
+ // The corresponding profile for specific field type.
+ // Each field will have only one field type specific profile output.
+ oneof field_info {
+ // The corresponding string field profile.
+ StringFieldInfo string_profile = 101;
+
+ // The corresponding integer field profile.
+ IntegerFieldInfo integer_profile = 102;
+
+ // The corresponding double field profile.
+ DoubleFieldInfo double_profile = 103;
+ }
+ }
+
+ // The name of the field.
+ string name = 1;
+
+ // The field data type. Possible values include:
+ //
+ // * STRING
+ // * BYTE
+ // * INT64
+ // * INT32
+ // * INT16
+ // * DOUBLE
+ // * FLOAT
+ // * DECIMAL
+ // * BOOLEAN
+ // * BINARY
+ // * TIMESTAMP
+ // * DATE
+ // * TIME
+ // * NULL
+ // * RECORD
+ string type = 2;
+
+ // The mode of the field. Its value will be:
+ // REQUIRED, if it is a required field.
+ // NULLABLE, if it is an optional field.
+ // REPEATED, if it is a repeated field.
+ string mode = 3;
+
+ // The profile information for the corresponding field.
+ ProfileInfo profile = 4;
+ }
+
+ // The sequence of fields describing data in table entities.
+ repeated Field fields = 2;
+ }
+
+ // The count of all rows in the sampled data.
+ // Return 0, if zero rows.
+ int64 row_count = 3;
+
+ // This represents the profile information per field.
+ Profile profile = 4;
+
+ // The data scanned for this profile.
+ ScannedData scanned_data = 5;
+}
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/data_quality.proto b/third_party/googleapis/google/cloud/dataplex/v1/data_quality.proto
new file mode 100644
index 000000000..fc9acd06c
--- /dev/null
+++ b/third_party/googleapis/google/cloud/dataplex/v1/data_quality.proto
@@ -0,0 +1,236 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.dataplex.v1;
+
+import "google/api/field_behavior.proto";
+import "google/cloud/dataplex/v1/processing.proto";
+
+option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
+option java_multiple_files = true;
+option java_outer_classname = "DataQualityProto";
+option java_package = "com.google.cloud.dataplex.v1";
+
+// DataQualityScan related setting.
+message DataQualitySpec {
+ // The list of rules to evaluate against a data source. At least one rule is
+ // required.
+ repeated DataQualityRule rules = 1;
+}
+
+// The output of a DataQualityScan.
+message DataQualityResult {
+ // Overall data quality result -- `true` if all rules passed.
+ bool passed = 5;
+
+ // A list of results at the dimension-level.
+ repeated DataQualityDimensionResult dimensions = 2;
+
+ // A list of all the rules in a job, and their results.
+ repeated DataQualityRuleResult rules = 3;
+
+ // The count of rows processed.
+ int64 row_count = 4;
+
+ // The data scanned for this result.
+ ScannedData scanned_data = 7;
+}
+
+// DataQualityRuleResult provides a more detailed, per-rule level view of the
+// results.
+message DataQualityRuleResult {
+ // The rule specified in the DataQualitySpec, as is.
+ DataQualityRule rule = 1;
+
+ // Whether the rule passed or failed.
+ bool passed = 7;
+
+ // The number of rows a rule was evaluated against.
+ // This field is only valid for ColumnMap type rules.
+ // Evaluated count can be configured to either
+ // (1) include all rows (default) - with null rows automatically failing rule
+ // evaluation OR (2) exclude null rows from the evaluated_count, by setting
+ // ignore_nulls = true
+ int64 evaluated_count = 9;
+
+ // The number of rows which passed a rule evaluation.
+ // This field is only valid for ColumnMap type rules.
+ int64 passed_count = 8;
+
+ // The number of rows with null values in the specified column.
+ int64 null_count = 5;
+
+ // The ratio of passed_count / evaluated_count.
+ // This field is only valid for ColumnMap type rules.
+ double pass_ratio = 6;
+
+ // The query to find rows that did not pass this rule.
+ // Only applies to ColumnMap and RowCondition rules.
+ string failing_rows_query = 10;
+}
+
+// DataQualityDimensionResult provides a more detailed, per-dimension level view
+// of the results.
+message DataQualityDimensionResult {
+ // Whether the dimension passed or failed.
+ bool passed = 3;
+}
+
+// A rule captures data quality intent about a data source.
+message DataQualityRule {
+ // Evaluates whether each column value lies between a specified range.
+ message RangeExpectation {
+ // Optional. The minimum column value allowed for a row to pass this
+ // validation. At least one of min_value and max_value need to be provided.
+ string min_value = 1 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The maximum column value allowed for a row to pass this
+ // validation. At least one of min_value and max_value need to be provided.
+ string max_value = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Whether each value needs to be strictly greater than ('>') the
+ // minimum, or if equality is allowed. Only relevant if a min_value has been
+ // defined. Default = false.
+ bool strict_min_enabled = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Whether each value needs to be strictly lesser than ('<') the
+ // maximum, or if equality is allowed. Only relevant if a max_value has been
+ // defined. Default = false.
+ bool strict_max_enabled = 4 [(google.api.field_behavior) = OPTIONAL];
+ }
+
+ // Evaluates whether each column value is null.
+ message NonNullExpectation {}
+
+ // Evaluates whether each column value is contained by a specified set.
+ message SetExpectation {
+ repeated string values = 1;
+ }
+
+ // Evaluates whether each column value matches a specified regex.
+ message RegexExpectation {
+ string regex = 1;
+ }
+
+ // Evaluates whether the column has duplicates.
+ message UniquenessExpectation {}
+
+ // Evaluates whether the column aggregate statistic lies between a specified
+ // range.
+ message StatisticRangeExpectation {
+ enum ColumnStatistic {
+ // Unspecified statistic type
+ STATISTIC_UNDEFINED = 0;
+
+ // Evaluate the column mean
+ MEAN = 1;
+
+ // Evaluate the column min
+ MIN = 2;
+
+ // Evaluate the column max
+ MAX = 3;
+ }
+
+ ColumnStatistic statistic = 1;
+
+ // The minimum column statistic value allowed for a row to pass this
+ // validation.
+ // At least one of min_value and max_value need to be provided.
+ string min_value = 2;
+
+ // The maximum column statistic value allowed for a row to pass this
+ // validation.
+ // At least one of min_value and max_value need to be provided.
+ string max_value = 3;
+
+ // Whether column statistic needs to be strictly greater than ('>')
+ // the minimum, or if equality is allowed. Only relevant if a min_value has
+ // been defined. Default = false.
+ bool strict_min_enabled = 4;
+
+ // Whether column statistic needs to be strictly lesser than ('<') the
+ // maximum, or if equality is allowed. Only relevant if a max_value has been
+ // defined. Default = false.
+ bool strict_max_enabled = 5;
+ }
+
+ // Evaluates whether each row passes the specified condition.
+ // The SQL expression needs to use BigQuery standard SQL syntax and should
+ // produce a boolean per row as the result.
+ // Example: col1 >= 0 AND col2 < 10
+ message RowConditionExpectation {
+ string sql_expression = 1;
+ }
+
+ // Evaluates whether the provided expression is true.
+ // The SQL expression needs to use BigQuery standard SQL syntax and should
+ // produce a scalar boolean result.
+ // Example: MIN(col1) >= 0
+ message TableConditionExpectation {
+ string sql_expression = 1;
+ }
+
+ oneof rule_type {
+ // ColumnMap rule which evaluates whether each column value lies between a
+ // specified range.
+ RangeExpectation range_expectation = 1;
+
+ // ColumnMap rule which evaluates whether each column value is null.
+ NonNullExpectation non_null_expectation = 2;
+
+ // ColumnMap rule which evaluates whether each column value is contained by
+ // a specified set.
+ SetExpectation set_expectation = 3;
+
+ // ColumnMap rule which evaluates whether each column value matches a
+ // specified regex.
+ RegexExpectation regex_expectation = 4;
+
+ // ColumnAggregate rule which evaluates whether the column has duplicates.
+ UniquenessExpectation uniqueness_expectation = 100;
+
+ // ColumnAggregate rule which evaluates whether the column aggregate
+ // statistic lies between a specified range.
+ StatisticRangeExpectation statistic_range_expectation = 101;
+
+ // Table rule which evaluates whether each row passes the specified
+ // condition.
+ RowConditionExpectation row_condition_expectation = 200;
+
+ // Table rule which evaluates whether the provided expression is true.
+ TableConditionExpectation table_condition_expectation = 201;
+ }
+
+ // Optional. The unnested column which this rule is evaluated against.
+ string column = 500 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Rows with null values will automatically fail a rule, unless
+ // ignore_null is true. In that case, such null rows are trivially considered
+ // passing. Only applicable to ColumnMap rules.
+ bool ignore_null = 501 [(google.api.field_behavior) = OPTIONAL];
+
+ // Required. The dimension a rule belongs to. Results are also aggregated at
+ // the dimension-level. Supported dimensions are ["COMPLETENESS", "ACCURACY",
+ // "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]
+ string dimension = 502 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. The minimum ratio of passing_rows / total_rows required to pass
+ // this rule, with a range of [0.0, 1.0]
+ //
+ // 0 indicates default value (i.e. 1.0)
+ double threshold = 503 [(google.api.field_behavior) = OPTIONAL];
+}
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/dataplex_v1.yaml b/third_party/googleapis/google/cloud/dataplex/v1/dataplex_v1.yaml
index 8e5c6cbf9..78a0b6e5b 100644
--- a/third_party/googleapis/google/cloud/dataplex/v1/dataplex_v1.yaml
+++ b/third_party/googleapis/google/cloud/dataplex/v1/dataplex_v1.yaml
@@ -5,6 +5,7 @@ title: Cloud Dataplex API
apis:
- name: google.cloud.dataplex.v1.ContentService
+- name: google.cloud.dataplex.v1.DataScanService
- name: google.cloud.dataplex.v1.DataplexService
- name: google.cloud.dataplex.v1.MetadataService
- name: google.cloud.location.Locations
@@ -12,6 +13,7 @@ apis:
- name: google.longrunning.Operations
types:
+- name: google.cloud.dataplex.v1.DataScanEvent
- name: google.cloud.dataplex.v1.DiscoveryEvent
- name: google.cloud.dataplex.v1.JobEvent
- name: google.cloud.dataplex.v1.OperationMetadata
@@ -53,6 +55,8 @@ backend:
rules:
- selector: 'google.cloud.dataplex.v1.ContentService.*'
deadline: 60.0
+ - selector: 'google.cloud.dataplex.v1.DataScanService.*'
+ deadline: 60.0
- selector: 'google.cloud.dataplex.v1.DataplexService.*'
deadline: 60.0
- selector: 'google.cloud.dataplex.v1.MetadataService.*'
@@ -79,6 +83,10 @@ http:
- get: '/v1/{resource=projects/*/locations/*/lakes/*/zones/*/assets/*}:getIamPolicy'
- get: '/v1/{resource=projects/*/locations/*/lakes/*/tasks/*}:getIamPolicy'
- get: '/v1/{resource=projects/*/locations/*/lakes/*/environments/*}:getIamPolicy'
+ - get: '/v1/{resource=projects/*/locations/*/dataScans/*}:getIamPolicy'
+ - get: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*}:getIamPolicy'
+ - get: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*/attributes/*}:getIamPolicy'
+ - get: '/v1/{resource=projects/*/locations/*/dataAttributeBindings/*}:getIamPolicy'
- selector: google.iam.v1.IAMPolicy.SetIamPolicy
post: '/v1/{resource=projects/*/locations/*/lakes/*}:setIamPolicy'
body: '*'
@@ -91,6 +99,14 @@ http:
body: '*'
- post: '/v1/{resource=projects/*/locations/*/lakes/*/environments/*}:setIamPolicy'
body: '*'
+ - post: '/v1/{resource=projects/*/locations/*/dataScans/*}:setIamPolicy'
+ body: '*'
+ - post: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*}:setIamPolicy'
+ body: '*'
+ - post: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*/attributes/*}:setIamPolicy'
+ body: '*'
+ - post: '/v1/{resource=projects/*/locations/*/dataAttributeBindings/*}:setIamPolicy'
+ body: '*'
- selector: google.iam.v1.IAMPolicy.TestIamPermissions
post: '/v1/{resource=projects/*/locations/*/lakes/*}:testIamPermissions'
body: '*'
@@ -103,6 +119,14 @@ http:
body: '*'
- post: '/v1/{resource=projects/*/locations/*/lakes/*/environments/*}:testIamPermissions'
body: '*'
+ - post: '/v1/{resource=projects/*/locations/*/dataScans/*}:testIamPermissions'
+ body: '*'
+ - post: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*}:testIamPermissions'
+ body: '*'
+ - post: '/v1/{resource=projects/*/locations/*/dataTaxonomies/*/attributes/*}:testIamPermissions'
+ body: '*'
+ - post: '/v1/{resource=projects/*/locations/*/dataAttributeBindings/*}:testIamPermissions'
+ body: '*'
- selector: google.longrunning.Operations.CancelOperation
post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
body: '*'
@@ -119,6 +143,10 @@ authentication:
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
+ - selector: 'google.cloud.dataplex.v1.DataScanService.*'
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
- selector: 'google.cloud.dataplex.v1.DataplexService.*'
oauth:
canonical_scopes: |-
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/datascans.proto b/third_party/googleapis/google/cloud/dataplex/v1/datascans.proto
new file mode 100644
index 000000000..d2320c566
--- /dev/null
+++ b/third_party/googleapis/google/cloud/dataplex/v1/datascans.proto
@@ -0,0 +1,550 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.dataplex.v1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/dataplex/v1/data_profile.proto";
+import "google/cloud/dataplex/v1/data_quality.proto";
+import "google/cloud/dataplex/v1/processing.proto";
+import "google/cloud/dataplex/v1/resources.proto";
+import "google/longrunning/operations.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
+
+option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
+option java_multiple_files = true;
+option java_outer_classname = "DataScansProto";
+option java_package = "com.google.cloud.dataplex.v1";
+
+// DataScanService manages DataScan resources which can be configured to run
+// various types of data scanning workload and generate enriched metadata (e.g.
+// Data Profile, Data Quality) for the data source.
+service DataScanService {
+ option (google.api.default_host) = "dataplex.googleapis.com";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
+
+ // Creates a DataScan resource.
+ rpc CreateDataScan(CreateDataScanRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*/locations/*}/dataScans"
+ body: "data_scan"
+ };
+ option (google.api.method_signature) = "parent,data_scan,data_scan_id";
+ option (google.longrunning.operation_info) = {
+ response_type: "DataScan"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Updates a DataScan resource.
+ rpc UpdateDataScan(UpdateDataScanRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ patch: "/v1/{data_scan.name=projects/*/locations/*/dataScans/*}"
+ body: "data_scan"
+ };
+ option (google.api.method_signature) = "data_scan,update_mask";
+ option (google.longrunning.operation_info) = {
+ response_type: "DataScan"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Deletes a DataScan resource.
+ rpc DeleteDataScan(DeleteDataScanRequest)
+ returns (google.longrunning.Operation) {
+ option (google.api.http) = {
+ delete: "/v1/{name=projects/*/locations/*/dataScans/*}"
+ };
+ option (google.api.method_signature) = "name";
+ option (google.longrunning.operation_info) = {
+ response_type: "google.protobuf.Empty"
+ metadata_type: "OperationMetadata"
+ };
+ }
+
+ // Gets a DataScan resource.
+ rpc GetDataScan(GetDataScanRequest) returns (DataScan) {
+ option (google.api.http) = {
+ get: "/v1/{name=projects/*/locations/*/dataScans/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Lists DataScans.
+ rpc ListDataScans(ListDataScansRequest) returns (ListDataScansResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=projects/*/locations/*}/dataScans"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+
+ // Runs an on-demand execution of a DataScan
+ rpc RunDataScan(RunDataScanRequest) returns (RunDataScanResponse) {
+ option (google.api.http) = {
+ post: "/v1/{name=projects/*/locations/*/dataScans/*}:run"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Gets a DataScanJob resource.
+ rpc GetDataScanJob(GetDataScanJobRequest) returns (DataScanJob) {
+ option (google.api.http) = {
+ get: "/v1/{name=projects/*/locations/*/dataScans/*/jobs/*}"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
+ // Lists DataScanJobs under the given DataScan.
+ rpc ListDataScanJobs(ListDataScanJobsRequest)
+ returns (ListDataScanJobsResponse) {
+ option (google.api.http) = {
+ get: "/v1/{parent=projects/*/locations/*/dataScans/*}/jobs"
+ };
+ option (google.api.method_signature) = "parent";
+ }
+}
+
+// Create dataScan request.
+message CreateDataScanRequest {
+ // Required. The resource name of the parent location:
+ // `projects/{project}/locations/{location_id}`
+ // where `project` refers to a *project_id* or *project_number* and
+ // `location_id` refers to a GCP region.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "locations.googleapis.com/Location"
+ }
+ ];
+
+ // Required. DataScan resource.
+ DataScan data_scan = 2 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. DataScan identifier.
+ //
+ // * Must contain only lowercase letters, numbers and hyphens.
+ // * Must start with a letter.
+ // * Must end with a number or a letter.
+ // * Must be between 1-63 characters.
+ // * Must be unique within the customer project / location.
+ string data_scan_id = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Update dataScan request.
+message UpdateDataScanRequest {
+ // Required. DataScan resource to be updated.
+ //
+ // Only fields specified in `update_mask` are updated.
+ DataScan data_scan = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Mask of fields to update.
+ google.protobuf.FieldMask update_mask = 2
+ [(google.api.field_behavior) = REQUIRED];
+}
+
+// Delete dataScan request.
+message DeleteDataScanRequest {
+ // Required. The resource name of the dataScan:
+ // `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
+ // where `project` refers to a *project_id* or *project_number* and
+ // `location_id` refers to a GCP region.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "dataplex.googleapis.com/DataScan"
+ }
+ ];
+}
+
+// Get dataScan request.
+message GetDataScanRequest {
+ // DataScan view options.
+ enum DataScanView {
+ // The API will default to the `BASIC` view.
+ DATA_SCAN_VIEW_UNSPECIFIED = 0;
+
+ // Basic view that does not include *spec* and *result*.
+ BASIC = 1;
+
+ // Include everything.
+ FULL = 10;
+ }
+
+ // Required. The resource name of the dataScan:
+ // `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
+ // where `project` refers to a *project_id* or *project_number* and
+ // `location_id` refers to a GCP region.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "dataplex.googleapis.com/DataScan"
+ }
+ ];
+
+ // Optional. Select the DataScan view to return. Defaults to `BASIC`.
+ DataScanView view = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// List dataScans request.
+message ListDataScansRequest {
+ // Required. The resource name of the parent location:
+ // `projects/{project}/locations/{location_id}`
+ // where `project` refers to a *project_id* or *project_number* and
+ // `location_id` refers to a GCP region.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "locations.googleapis.com/Location"
+ }
+ ];
+
+ // Optional. Maximum number of dataScans to return. The service may return
+ // fewer than this value. If unspecified, at most 10 scans will be returned.
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Page token received from a previous `ListDataScans` call. Provide
+ // this to retrieve the subsequent page. When paginating, all other parameters
+ // provided to `ListDataScans` must match the call that provided the
+ // page token.
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Filter request.
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Order by fields (`name` or `create_time`) for the result.
+ // If not specified, the ordering is undefined.
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// List dataScans response.
+message ListDataScansResponse {
+ // DataScans (`BASIC` view only) under the given parent location.
+ repeated DataScan data_scans = 1;
+
+ // Token to retrieve the next page of results, or empty if there are no more
+ // results in the list.
+ string next_page_token = 2;
+
+ // Locations that could not be reached.
+ repeated string unreachable = 3;
+}
+
+// Run DataScan Request
+message RunDataScanRequest {
+ // Required. The resource name of the DataScan:
+ // `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`.
+ // where `project` refers to a *project_id* or *project_number* and
+ // `location_id` refers to a GCP region.
+ //
+ // Only **OnDemand** data scans are allowed.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "dataplex.googleapis.com/DataScan"
+ }
+ ];
+}
+
+// Run DataScan Response.
+message RunDataScanResponse {
+ // DataScanJob created by RunDataScan request.
+ DataScanJob job = 1;
+}
+
+// Get DataScanJob request.
+message GetDataScanJobRequest {
+ // DataScanJob view options.
+ enum DataScanJobView {
+ // The API will default to the `BASIC` view.
+ DATA_SCAN_JOB_VIEW_UNSPECIFIED = 0;
+
+ // Basic view that does not include *spec* and *result*.
+ BASIC = 1;
+
+ // Include everything.
+ FULL = 10;
+ }
+
+ // Required. The resource name of the DataScanJob:
+ // `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id}`
+ // where `project` refers to a *project_id* or *project_number* and
+ // `location_id` refers to a GCP region.
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "dataplex.googleapis.com/DataScanJob"
+ }
+ ];
+
+ // Optional. Select the DataScanJob view to return. Defaults to `BASIC`.
+ DataScanJobView view = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// List DataScanJobs request.
+message ListDataScanJobsRequest {
+ // Required. The resource name of the parent environment:
+ // `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
+ // where `project` refers to a *project_id* or *project_number* and
+ // `location_id` refers to a GCP region.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "dataplex.googleapis.com/DataScan"
+ }
+ ];
+
+ // Optional. Maximum number of DataScanJobs to return. The service may return
+ // fewer than this value. If unspecified, at most 10 DataScanJobs will be
+ // returned. The maximum value is 1000; values above 1000 will be coerced to
+ // 1000.
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Page token received from a previous `ListDataScanJobs` call.
+ // Provide this to retrieve the subsequent page. When paginating, all other
+ // parameters provided to `ListDataScanJobs` must match the call that provided
+ // the page token.
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// List DataScanJobs response.
+message ListDataScanJobsResponse {
+ // DataScanJobs (`BASIC` view only) under a given dataScan.
+ repeated DataScanJob data_scan_jobs = 1;
+
+ // Token to retrieve the next page of results, or empty if there are no more
+ // results in the list.
+ string next_page_token = 2;
+}
+
+// Represents a user-visible job which provides the insights for the related
+// data source.
+//
+// For example:
+//
+// * Data Quality: generates queries based on the rules and runs against the
+// data to get data quality check results.
+// * Data Profile: analyzes the data in table(s) and generates insights about
+// the structure, content and relationships (such as null percent,
+// cardinality, min/max/mean, etc).
+message DataScan {
+ option (google.api.resource) = {
+ type: "dataplex.googleapis.com/DataScan"
+ pattern: "projects/{project}/locations/{location}/dataScans/{dataScan}"
+ };
+
+ // DataScan execution settings.
+ message ExecutionSpec {
+ // Optional. Spec related to how often and when a scan should be triggered.
+ //
+ // If not specified, the default is `OnDemand`, which means the scan will
+ // not run until the user calls `RunDataScan` API.
+ Trigger trigger = 1 [(google.api.field_behavior) = OPTIONAL];
+
+ // Spec related to incremental scan of the data
+ //
+ // When an option is selected for incremental scan, it cannot be unset or
+ // changed. If not specified, a data scan will run for all data in the
+ // table.
+ oneof incremental {
+ // Immutable. The unnested field (of type *Date* or *Timestamp*) that
+ // contains values which monotonically increase over time.
+ //
+ // If not specified, a data scan will run for all data in the table.
+ string field = 100 [(google.api.field_behavior) = IMMUTABLE];
+ }
+ }
+
+ // Status of the data scan execution.
+ message ExecutionStatus {
+ // The time when the latest DataScanJob started.
+ google.protobuf.Timestamp latest_job_start_time = 4;
+
+ // The time when the latest DataScanJob ended.
+ google.protobuf.Timestamp latest_job_end_time = 5;
+ }
+
+ // Output only. The relative resource name of the scan, of the form:
+ // `projects/{project}/locations/{location_id}/dataScans/{datascan_id}`,
+ // where `project` refers to a *project_id* or *project_number* and
+ // `location_id` refers to a GCP region.
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. System generated globally unique ID for the scan. This ID will
+ // be different if the scan is deleted and re-created with the same name.
+ string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Optional. Description of the scan.
+ //
+ // * Must be between 1-1024 characters.
+ string description = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. User friendly display name.
+ //
+ // * Must be between 1-256 characters.
+ string display_name = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. User-defined labels for the scan.
+ map labels = 5 [(google.api.field_behavior) = OPTIONAL];
+
+ // Output only. Current state of the DataScan.
+ State state = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time when the scan was created.
+ google.protobuf.Timestamp create_time = 7
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time when the scan was last updated.
+ google.protobuf.Timestamp update_time = 8
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Required. The data source for DataScan.
+ DataSource data = 9 [(google.api.field_behavior) = REQUIRED];
+
+ // Optional. DataScan execution settings.
+ //
+ // If not specified, the fields in it will use their default values.
+ ExecutionSpec execution_spec = 10 [(google.api.field_behavior) = OPTIONAL];
+
+ // Output only. Status of the data scan execution.
+ ExecutionStatus execution_status = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The type of DataScan.
+ DataScanType type = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Data Scan related setting.
+ // It is required and immutable which means once data_quality_spec is set, it
+ // cannot be changed to data_profile_spec.
+ oneof spec {
+ // DataQualityScan related setting.
+ DataQualitySpec data_quality_spec = 100;
+
+ // DataProfileScan related setting.
+ DataProfileSpec data_profile_spec = 101;
+ }
+
+ // The result of the data scan.
+ oneof result {
+ // Output only. The result of the data quality scan.
+ DataQualityResult data_quality_result = 200
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The result of the data profile scan.
+ DataProfileResult data_profile_result = 201
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+}
+
+// A DataScanJob represents an instance of DataScan execution.
+message DataScanJob {
+ option (google.api.resource) = {
+ type: "dataplex.googleapis.com/DataScanJob"
+ pattern: "projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{job}"
+ };
+
+ // Execution state for the DataScanJob.
+ enum State {
+ // The DataScanJob state is unspecified.
+ STATE_UNSPECIFIED = 0;
+
+ // The DataScanJob is running.
+ RUNNING = 1;
+
+ // The DataScanJob is canceling.
+ CANCELING = 2;
+
+ // The DataScanJob cancellation was successful.
+ CANCELLED = 3;
+
+ // The DataScanJob completed successfully.
+ SUCCEEDED = 4;
+
+ // The DataScanJob is no longer running due to an error.
+ FAILED = 5;
+
+ // The DataScanJob has been created but not started to run yet.
+ PENDING = 7;
+ }
+
+ // Output only. The relative resource name of the DataScanJob, of the form:
+ // `projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}`,
+ // where `project` refers to a *project_id* or *project_number* and
+ // `location_id` refers to a GCP region.
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. System generated globally unique ID for the DataScanJob.
+ string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time when the DataScanJob was started.
+ google.protobuf.Timestamp start_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time when the DataScanJob ended.
+ google.protobuf.Timestamp end_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Execution state for the DataScanJob.
+ State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Additional information about the current state.
+ string message = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The type of the parent DataScan.
+ DataScanType type = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Data Scan related setting.
+ oneof spec {
+ // Output only. DataQualityScan related setting.
+ DataQualitySpec data_quality_spec = 100
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. DataProfileScan related setting.
+ DataProfileSpec data_profile_spec = 101
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
+ // The result of the data scan.
+ oneof result {
+ // Output only. The result of the data quality scan.
+ DataQualityResult data_quality_result = 200
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The result of the data profile scan.
+ DataProfileResult data_profile_result = 201
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+}
+
+// The type of DataScan.
+enum DataScanType {
+ // The DataScan type is unspecified.
+ DATA_SCAN_TYPE_UNSPECIFIED = 0;
+
+ // Data Quality scan.
+ DATA_QUALITY = 1;
+
+ // Data Profile scan.
+ DATA_PROFILE = 2;
+}
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/logs.proto b/third_party/googleapis/google/cloud/dataplex/v1/logs.proto
index 0cec18480..f6bc38640 100644
--- a/third_party/googleapis/google/cloud/dataplex/v1/logs.proto
+++ b/third_party/googleapis/google/cloud/dataplex/v1/logs.proto
@@ -20,7 +20,7 @@ import "google/api/resource.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataplex/v1;dataplex";
+option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
option java_multiple_files = true;
option java_outer_classname = "LogsProto";
option java_package = "com.google.cloud.dataplex.v1";
@@ -291,10 +291,128 @@ message SessionEvent {
// The status of the event.
bool event_succeeded = 6;
- // If the session is associated with an Environment with fast startup enabled,
- // and was pre-created before being assigned to a user.
+ // If the session is associated with an environment with fast startup enabled,
+ // and was created before being assigned to a user.
bool fast_startup_enabled = 7;
// The idle duration of a warm pooled session before it is assigned to user.
google.protobuf.Duration unassigned_duration = 8;
}
+
+// These messages contain information about the execution of a datascan.
+// The monitored resource is 'DataScan'
+message DataScanEvent {
+ // The type of the data scan.
+ enum ScanType {
+ // An unspecified data scan type.
+ SCAN_TYPE_UNSPECIFIED = 0;
+
+ // Data scan for data profile.
+ DATA_PROFILE = 1;
+
+ // Data scan for data quality.
+ DATA_QUALITY = 2;
+ }
+
+ // The job state of the data scan.
+ enum State {
+ // Unspecified job state.
+ STATE_UNSPECIFIED = 0;
+
+ // Data scan started.
+ STARTED = 1;
+
+ // Data scan successfully completed.
+ SUCCEEDED = 2;
+
+ // Data scan was unsuccessful.
+ FAILED = 3;
+
+ // Data scan was cancelled.
+ CANCELLED = 4;
+ }
+
+ // The trigger type for the data scan.
+ enum Trigger {
+ // An unspecified trigger type.
+ TRIGGER_UNSPECIFIED = 0;
+
+ // Data scan triggers on demand.
+ ON_DEMAND = 1;
+
+ // Data scan triggers as per schedule.
+ SCHEDULE = 2;
+ }
+
+ // The scope of job for the data scan.
+ enum Scope {
+ // An unspecified scope type.
+ SCOPE_UNSPECIFIED = 0;
+
+ // Data scan runs on all of the data.
+ FULL = 1;
+
+ // Data scan runs on incremental data.
+ INCREMENTAL = 2;
+ }
+
+ // Data profile result for data scan job.
+ message DataProfileResult {
+ // The count of rows processed in the data scan job.
+ int64 row_count = 1;
+ }
+
+ // Data quality result for data scan job.
+ message DataQualityResult {
+ // The count of rows processed in the data scan job.
+ int64 row_count = 1;
+
+ // Whether the data quality result was `pass` or not.
+ bool passed = 2;
+
+ // The result of each dimension for data quality result.
+ // The key of the map is the name of the dimension.
+ // The value is the bool value depicting whether the dimension result was
+ // `pass` or not.
+ map dimension_passed = 3;
+ }
+
+ // The data source of the data scan
+ string data_source = 1;
+
+ // The identifier of the specific data scan job this log entry is for.
+ string job_id = 2;
+
+ // The time when the data scan job started to run.
+ google.protobuf.Timestamp start_time = 3;
+
+ // The time when the data scan job finished.
+ google.protobuf.Timestamp end_time = 4;
+
+ // The type of the data scan.
+ ScanType type = 5;
+
+ // The status of the data scan job.
+ State state = 6;
+
+ // The message describing the data scan job event.
+ string message = 7;
+
+ // A version identifier of the spec which was used to execute this job.
+ string spec_version = 8;
+
+ // The trigger type of the data scan job.
+ Trigger trigger = 9;
+
+ // The scope of the data scan (e.g. full, incremental).
+ Scope scope = 10;
+
+ // The result of the data scan job.
+ oneof result {
+ // Data profile result for data profile type data scan.
+ DataProfileResult data_profile = 101;
+
+ // Data quality result for data quality type data scan.
+ DataQualityResult data_quality = 102;
+ }
+}
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/metadata.proto b/third_party/googleapis/google/cloud/dataplex/v1/metadata.proto
index 5aac7eb14..c6432906f 100644
--- a/third_party/googleapis/google/cloud/dataplex/v1/metadata.proto
+++ b/third_party/googleapis/google/cloud/dataplex/v1/metadata.proto
@@ -23,7 +23,7 @@ import "google/api/resource.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataplex/v1;dataplex";
+option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
option java_multiple_files = true;
option java_outer_classname = "MetadataProto";
option java_package = "com.google.cloud.dataplex.v1";
@@ -682,6 +682,13 @@ message StorageFormat {
string encoding = 1 [(google.api.field_behavior) = OPTIONAL];
}
+ // Describes Iceberg data format.
+ message IcebergOptions {
+ // Optional. The location of where the iceberg metadata is present, must be
+ // within the table path
+ string metadata_location = 1 [(google.api.field_behavior) = OPTIONAL];
+ }
+
// The specific file format of the data.
enum Format {
// Format unspecified.
@@ -752,6 +759,9 @@ message StorageFormat {
// - application/x-avro
// - application/x-orc
// - application/x-tfrecord
+ // - application/x-parquet+iceberg
+ // - application/x-avro+iceberg
+ // - application/x-orc+iceberg
// - application/json
// - application/{subtypes}
// - text/csv
@@ -768,6 +778,9 @@ message StorageFormat {
// Optional. Additional information about CSV formatted data.
JsonOptions json = 11 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Additional information about iceberg tables.
+ IcebergOptions iceberg = 12 [(google.api.field_behavior) = OPTIONAL];
}
}
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/processing.proto b/third_party/googleapis/google/cloud/dataplex/v1/processing.proto
new file mode 100644
index 000000000..ba32f7a0d
--- /dev/null
+++ b/third_party/googleapis/google/cloud/dataplex/v1/processing.proto
@@ -0,0 +1,94 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.dataplex.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
+option java_multiple_files = true;
+option java_outer_classname = "ProcessingProto";
+option java_package = "com.google.cloud.dataplex.v1";
+
+// DataScan scheduling and trigger settings.
+message Trigger {
+ // The scan runs one-time via RunDataScan API.
+ message OnDemand {}
+
+ // The scan is scheduled to run periodically.
+ message Schedule {
+ // Required. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running
+ // scans periodically.
+ // To explicitly set a timezone to the cron tab, apply a prefix in the
+ // cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}".
+ // The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone
+ // database. For example, "CRON_TZ=America/New_York 1 * * * *", or
+ // "TZ=America/New_York 1 * * * *".
+ // This field is required for Schedule scans.
+ string cron = 1 [(google.api.field_behavior) = REQUIRED];
+ }
+
+ // DataScan scheduling and trigger settings.
+ // If not specified, the default is OnDemand, which means the scan will not
+ // run until the user calls RunDataScan API.
+ oneof mode {
+ // The scan runs one-time shortly after DataScan Creation.
+ OnDemand on_demand = 100;
+
+ // The scan is scheduled to run periodically.
+ Schedule schedule = 101;
+ }
+}
+
+// The data source for DataScan.
+message DataSource {
+ // The source is required and immutable which means once entity is set, it
+ // cannot be change to others, and vice versa.
+ oneof source {
+ // Immutable. The dataplex entity that contains the data for DataScan, of
+ // the form:
+ // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
+ string entity = 100 [
+ (google.api.field_behavior) = IMMUTABLE,
+ (google.api.resource_reference) = {
+ type: "dataplex.googleapis.com/Entity"
+ }
+ ];
+ }
+}
+
+// The data scanned during processing (e.g. in incremental DataScan)
+message ScannedData {
+ // A data range denoted by a pair of start/end values of a field.
+ message IncrementalField {
+ // The field that contains values which monotonically increases over time
+ // (e.g. timestamp).
+ string field = 1;
+
+ // Value that marks the start of the range
+ string start = 2;
+
+ // Value that marks the end of the range
+ string end = 3;
+ }
+
+ // The range of scanned data
+ oneof data_range {
+ // The range denoted by values of an incremental field
+ IncrementalField incremental_field = 1;
+ }
+}
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/resources.proto b/third_party/googleapis/google/cloud/dataplex/v1/resources.proto
index 86af8432b..7ba96cfee 100644
--- a/third_party/googleapis/google/cloud/dataplex/v1/resources.proto
+++ b/third_party/googleapis/google/cloud/dataplex/v1/resources.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataplex/v1;dataplex";
+option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
option java_multiple_files = true;
option java_outer_classname = "ResourcesProto";
option java_package = "com.google.cloud.dataplex.v1";
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/service.proto b/third_party/googleapis/google/cloud/dataplex/v1/service.proto
index d23ca8e2f..ba0ed0502 100644
--- a/third_party/googleapis/google/cloud/dataplex/v1/service.proto
+++ b/third_party/googleapis/google/cloud/dataplex/v1/service.proto
@@ -28,7 +28,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataplex/v1;dataplex";
+option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
option java_multiple_files = true;
option java_outer_classname = "ServiceProto";
option java_package = "com.google.cloud.dataplex.v1";
diff --git a/third_party/googleapis/google/cloud/dataplex/v1/tasks.proto b/third_party/googleapis/google/cloud/dataplex/v1/tasks.proto
index 6aa028636..3e7137ba2 100644
--- a/third_party/googleapis/google/cloud/dataplex/v1/tasks.proto
+++ b/third_party/googleapis/google/cloud/dataplex/v1/tasks.proto
@@ -22,7 +22,7 @@ import "google/cloud/dataplex/v1/resources.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataplex/v1;dataplex";
+option go_package = "cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpb";
option java_multiple_files = true;
option java_outer_classname = "TasksProto";
option java_package = "com.google.cloud.dataplex.v1";
diff --git a/third_party/googleapis/google/cloud/dataproc/logging/BUILD.bazel b/third_party/googleapis/google/cloud/dataproc/logging/BUILD.bazel
index 88780e4de..e5e61a389 100644
--- a/third_party/googleapis/google/cloud/dataproc/logging/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/dataproc/logging/BUILD.bazel
@@ -49,7 +49,7 @@ load(
go_proto_library(
name = "logging_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/dataproc/logging",
+ importpath = "cloud.google.com/go/dataproc/logging/loggingpb",
protos = [":logging_proto"],
deps = [
],
diff --git a/third_party/googleapis/google/cloud/dataproc/logging/autoscaler_log.proto b/third_party/googleapis/google/cloud/dataproc/logging/autoscaler_log.proto
index eb3dc0e6c..5500b37c5 100644
--- a/third_party/googleapis/google/cloud/dataproc/logging/autoscaler_log.proto
+++ b/third_party/googleapis/google/cloud/dataproc/logging/autoscaler_log.proto
@@ -18,7 +18,7 @@ package google.cloud.dataproc.logging;
import "google/protobuf/duration.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataproc/logging;logging";
+option go_package = "cloud.google.com/go/dataproc/logging/loggingpb;loggingpb";
option java_multiple_files = true;
option java_package = "com.google.cloud.dataproc.logging";
diff --git a/third_party/googleapis/google/cloud/dataproc/v1/BUILD.bazel b/third_party/googleapis/google/cloud/dataproc/v1/BUILD.bazel
index cbb0569e9..b5931419c 100644
--- a/third_party/googleapis/google/cloud/dataproc/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/dataproc/v1/BUILD.bazel
@@ -16,10 +16,10 @@ proto_library(
"batches.proto",
"clusters.proto",
"jobs.proto",
+ "node_groups.proto",
"operations.proto",
"shared.proto",
"workflow_templates.proto",
- "node_groups.proto",
],
deps = [
"//google/api:annotations_proto",
@@ -125,7 +125,7 @@ load(
go_proto_library(
name = "dataproc_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/dataproc/v1",
+ importpath = "cloud.google.com/go/dataproc/apiv1/dataprocpb",
protos = [":dataproc_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -138,11 +138,15 @@ go_gapic_library(
srcs = [":dataproc_proto_with_info"],
grpc_service_config = "dataproc_grpc_service_config.json",
importpath = "cloud.google.com/go/dataproc/apiv1;dataproc",
+ metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "dataproc_v1.yaml",
transport = "grpc+rest",
deps = [
":dataproc_go_proto",
+ "//google/cloud/location:location_go_proto",
+ "//google/iam/v1:iam_go_proto",
"//google/longrunning:longrunning_go_proto",
"@com_google_cloud_go_longrunning//:go_default_library",
"@com_google_cloud_go_longrunning//autogen:go_default_library",
@@ -182,7 +186,12 @@ py_gapic_library(
srcs = [":dataproc_proto"],
grpc_service_config = "dataproc_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "dataproc_v1.yaml",
+ transport = "grpc+rest",
+ deps = [
+ "//google/iam/v1:iam_policy_py_proto",
+ "//google/iam/v1:policy_py_proto",
+ ],
)
py_test(
@@ -315,6 +324,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
ruby_cloud_title = "Cloud Dataproc V1",
+ service_yaml = "dataproc_v1.yaml",
deps = [
":dataproc_ruby_grpc",
":dataproc_ruby_proto",
@@ -360,6 +370,7 @@ csharp_gapic_library(
grpc_service_config = "dataproc_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "dataproc_v1.yaml",
+ transport = "grpc+rest",
deps = [
":dataproc_csharp_grpc",
":dataproc_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/dataproc/v1/autoscaling_policies.proto b/third_party/googleapis/google/cloud/dataproc/v1/autoscaling_policies.proto
index 18b2f7df3..337ec6a64 100644
--- a/third_party/googleapis/google/cloud/dataproc/v1/autoscaling_policies.proto
+++ b/third_party/googleapis/google/cloud/dataproc/v1/autoscaling_policies.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ import "google/api/resource.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataproc/v1;dataproc";
+option go_package = "cloud.google.com/go/dataproc/apiv1/dataprocpb;dataprocpb";
option java_multiple_files = true;
option java_outer_classname = "AutoscalingPoliciesProto";
option java_package = "com.google.cloud.dataproc.v1";
@@ -36,10 +36,12 @@ option (google.api.resource_definition) = {
// Dataproc API.
service AutoscalingPolicyService {
option (google.api.default_host) = "dataproc.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates new autoscaling policy.
- rpc CreateAutoscalingPolicy(CreateAutoscalingPolicyRequest) returns (AutoscalingPolicy) {
+ rpc CreateAutoscalingPolicy(CreateAutoscalingPolicyRequest)
+ returns (AutoscalingPolicy) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/autoscalingPolicies"
body: "policy"
@@ -55,7 +57,8 @@ service AutoscalingPolicyService {
//
// Disabled check for update_mask, because all updates will be full
// replacements.
- rpc UpdateAutoscalingPolicy(UpdateAutoscalingPolicyRequest) returns (AutoscalingPolicy) {
+ rpc UpdateAutoscalingPolicy(UpdateAutoscalingPolicyRequest)
+ returns (AutoscalingPolicy) {
option (google.api.http) = {
put: "/v1/{policy.name=projects/*/locations/*/autoscalingPolicies/*}"
body: "policy"
@@ -68,7 +71,8 @@ service AutoscalingPolicyService {
}
// Retrieves autoscaling policy.
- rpc GetAutoscalingPolicy(GetAutoscalingPolicyRequest) returns (AutoscalingPolicy) {
+ rpc GetAutoscalingPolicy(GetAutoscalingPolicyRequest)
+ returns (AutoscalingPolicy) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/autoscalingPolicies/*}"
additional_bindings {
@@ -79,7 +83,8 @@ service AutoscalingPolicyService {
}
// Lists autoscaling policies in the project.
- rpc ListAutoscalingPolicies(ListAutoscalingPoliciesRequest) returns (ListAutoscalingPoliciesResponse) {
+ rpc ListAutoscalingPolicies(ListAutoscalingPoliciesRequest)
+ returns (ListAutoscalingPoliciesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/autoscalingPolicies"
additional_bindings {
@@ -91,7 +96,8 @@ service AutoscalingPolicyService {
// Deletes an autoscaling policy. It is an error to delete an autoscaling
// policy that is in use by one or more clusters.
- rpc DeleteAutoscalingPolicy(DeleteAutoscalingPolicyRequest) returns (google.protobuf.Empty) {
+ rpc DeleteAutoscalingPolicy(DeleteAutoscalingPolicyRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/autoscalingPolicies/*}"
additional_bindings {
@@ -132,14 +138,17 @@ message AutoscalingPolicy {
// Autoscaling algorithm for policy.
oneof algorithm {
- BasicAutoscalingAlgorithm basic_algorithm = 3 [(google.api.field_behavior) = REQUIRED];
+ BasicAutoscalingAlgorithm basic_algorithm = 3
+ [(google.api.field_behavior) = REQUIRED];
}
// Required. Describes how the autoscaler will operate for primary workers.
- InstanceGroupAutoscalingPolicyConfig worker_config = 4 [(google.api.field_behavior) = REQUIRED];
+ InstanceGroupAutoscalingPolicyConfig worker_config = 4
+ [(google.api.field_behavior) = REQUIRED];
// Optional. Describes how the autoscaler will operate for secondary workers.
- InstanceGroupAutoscalingPolicyConfig secondary_worker_config = 5 [(google.api.field_behavior) = OPTIONAL];
+ InstanceGroupAutoscalingPolicyConfig secondary_worker_config = 5
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. The labels to associate with this autoscaling policy.
// Label **keys** must contain 1 to 63 characters, and must conform to
@@ -155,14 +164,16 @@ message AutoscalingPolicy {
message BasicAutoscalingAlgorithm {
oneof config {
// Required. YARN autoscaling configuration.
- BasicYarnAutoscalingConfig yarn_config = 1 [(google.api.field_behavior) = REQUIRED];
+ BasicYarnAutoscalingConfig yarn_config = 1
+ [(google.api.field_behavior) = REQUIRED];
}
// Optional. Duration between scaling events. A scaling period starts after
// the update operation from the previous event has completed.
//
// Bounds: [2m, 1d]. Default: 2m.
- google.protobuf.Duration cooldown_period = 2 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.Duration cooldown_period = 2
+ [(google.api.field_behavior) = OPTIONAL];
}
// Basic autoscaling configurations for YARN.
@@ -173,22 +184,23 @@ message BasicYarnAutoscalingConfig {
// downscaling operations.
//
// Bounds: [0s, 1d].
- google.protobuf.Duration graceful_decommission_timeout = 5 [(google.api.field_behavior) = REQUIRED];
-
- // Required. Fraction of average YARN pending memory in the last cooldown period
- // for which to add workers. A scale-up factor of 1.0 will result in scaling
- // up so that there is no pending memory remaining after the update (more
- // aggressive scaling). A scale-up factor closer to 0 will result in a smaller
- // magnitude of scaling up (less aggressive scaling).
- // See [How autoscaling
+ google.protobuf.Duration graceful_decommission_timeout = 5
+ [(google.api.field_behavior) = REQUIRED];
+
+ // Required. Fraction of average YARN pending memory in the last cooldown
+ // period for which to add workers. A scale-up factor of 1.0 will result in
+ // scaling up so that there is no pending memory remaining after the update
+ // (more aggressive scaling). A scale-up factor closer to 0 will result in a
+ // smaller magnitude of scaling up (less aggressive scaling). See [How
+ // autoscaling
// works](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
// for more information.
//
// Bounds: [0.0, 1.0].
double scale_up_factor = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. Fraction of average YARN pending memory in the last cooldown period
- // for which to remove workers. A scale-down factor of 1 will result in
+ // Required. Fraction of average YARN pending memory in the last cooldown
+ // period for which to remove workers. A scale-down factor of 1 will result in
// scaling down so that there is no available memory remaining after the
// update (more aggressive scaling). A scale-down factor of 0 disables
// removing workers, which can be beneficial for autoscaling a single job.
@@ -206,7 +218,8 @@ message BasicYarnAutoscalingConfig {
// on any recommended change.
//
// Bounds: [0.0, 1.0]. Default: 0.0.
- double scale_up_min_worker_fraction = 3 [(google.api.field_behavior) = OPTIONAL];
+ double scale_up_min_worker_fraction = 3
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. Minimum scale-down threshold as a fraction of total cluster size
// before scaling occurs. For example, in a 20-worker cluster, a threshold of
@@ -215,7 +228,8 @@ message BasicYarnAutoscalingConfig {
// on any recommended change.
//
// Bounds: [0.0, 1.0]. Default: 0.0.
- double scale_down_min_worker_fraction = 4 [(google.api.field_behavior) = OPTIONAL];
+ double scale_down_min_worker_fraction = 4
+ [(google.api.field_behavior) = OPTIONAL];
}
// Configuration for the size bounds of an instance group, including its
@@ -358,7 +372,8 @@ message ListAutoscalingPoliciesRequest {
// A response to a request to list autoscaling policies in a project.
message ListAutoscalingPoliciesResponse {
// Output only. Autoscaling policies list.
- repeated AutoscalingPolicy policies = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated AutoscalingPolicy policies = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. This token is included in the response if there are more
// results to fetch.
diff --git a/third_party/googleapis/google/cloud/dataproc/v1/batches.proto b/third_party/googleapis/google/cloud/dataproc/v1/batches.proto
index eafb4e354..cde1351c8 100644
--- a/third_party/googleapis/google/cloud/dataproc/v1/batches.proto
+++ b/third_party/googleapis/google/cloud/dataproc/v1/batches.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@ import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataproc/v1;dataproc";
+option go_package = "cloud.google.com/go/dataproc/apiv1/dataprocpb;dataprocpb";
option java_multiple_files = true;
option java_outer_classname = "BatchesProto";
option java_package = "com.google.cloud.dataproc.v1";
@@ -33,7 +33,8 @@ option java_package = "com.google.cloud.dataproc.v1";
// The BatchController provides methods to manage batch workloads.
service BatchController {
option (google.api.default_host) = "dataproc.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates a batch workload that executes asynchronously.
rpc CreateBatch(CreateBatchRequest) returns (google.longrunning.Operation) {
@@ -87,8 +88,8 @@ message CreateBatchRequest {
// Required. The batch to create.
Batch batch = 2 [(google.api.field_behavior) = REQUIRED];
- // Optional. The ID to use for the batch, which will become the final component of
- // the batch's resource name.
+ // Optional. The ID to use for the batch, which will become the final
+ // component of the batch's resource name.
//
// This value must be 4-63 characters. Valid characters are `/[a-z][0-9]-/`.
string batch_id = 3 [(google.api.field_behavior) = OPTIONAL];
@@ -110,12 +111,12 @@ message CreateBatchRequest {
// A request to get the resource representation for a batch workload.
message GetBatchRequest {
- // Required. The name of the batch to retrieve.
+ // Required. The fully qualified name of the batch to retrieve
+ // in the format
+ // "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"
string name = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "dataproc.googleapis.com/Batch"
- }
+ (google.api.resource_reference) = { type: "dataproc.googleapis.com/Batch" }
];
}
@@ -137,6 +138,28 @@ message ListBatchesRequest {
// Optional. A page token received from a previous `ListBatches` call.
// Provide this token to retrieve the subsequent page.
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. A filter for the batches to return in the response.
+ //
+ // A filter is a logical expression constraining the values of various fields
+ // in each batch resource. Filters are case sensitive, and may contain
+ // multiple clauses combined with logical operators (AND/OR).
+ // Supported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`.
+ //
+ // e.g. `state = RUNNING and create_time < "2023-01-01T00:00:00Z"`
+ // filters for batches in state RUNNING that were created before 2023-01-01
+ //
+ // See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed
+ // description of the filter syntax and a list of supported comparisons.
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Field(s) on which to sort the list of batches.
+ //
+ // Currently the only supported sort orders are unspecified (empty) and
+ // `create_time desc` to sort by most recently created batches first.
+ //
+ // See https://google.aip.dev/132#ordering for more details.
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
}
// A list of batch workloads.
@@ -151,12 +174,12 @@ message ListBatchesResponse {
// A request to delete a batch workload.
message DeleteBatchRequest {
- // Required. The name of the batch resource to delete.
+ // Required. The fully qualified name of the batch to retrieve
+ // in the format
+ // "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"
string name = 1 [
(google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "dataproc.googleapis.com/Batch"
- }
+ (google.api.resource_reference) = { type: "dataproc.googleapis.com/Batch" }
];
}
@@ -167,18 +190,6 @@ message Batch {
pattern: "projects/{project}/locations/{location}/batches/{batch}"
};
- // Historical state information.
- message StateHistory {
- // Output only. The state of the batch at this point in history.
- State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. Details about the state at this point in history.
- string state_message = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The time when the batch entered the historical state.
- google.protobuf.Timestamp state_start_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
-
// The batch state.
enum State {
// The batch state is unknown.
@@ -203,6 +214,19 @@ message Batch {
FAILED = 6;
}
+ // Historical state information.
+ message StateHistory {
+ // Output only. The state of the batch at this point in history.
+ State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Details about the state at this point in history.
+ string state_message = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The time when the batch entered the historical state.
+ google.protobuf.Timestamp state_start_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+ }
+
// Output only. The resource name of the batch.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -211,7 +235,8 @@ message Batch {
string uuid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time when the batch was created.
- google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// The application/framework-specific portion of the batch configuration.
oneof batch_config {
@@ -239,7 +264,8 @@ message Batch {
string state_message = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time when the batch entered a current state.
- google.protobuf.Timestamp state_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp state_time = 11
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The email address of the user who created the batch.
string creator = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -257,13 +283,15 @@ message Batch {
RuntimeConfig runtime_config = 14 [(google.api.field_behavior) = OPTIONAL];
// Optional. Environment configuration for the batch execution.
- EnvironmentConfig environment_config = 15 [(google.api.field_behavior) = OPTIONAL];
+ EnvironmentConfig environment_config = 15
+ [(google.api.field_behavior) = OPTIONAL];
// Output only. The resource name of the operation associated with this batch.
string operation = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Historical state information for the batch.
- repeated StateHistory state_history = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated StateHistory state_history = 17
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A configuration for running an
@@ -271,8 +299,8 @@ message Batch {
// PySpark](https://spark.apache.org/docs/latest/api/python/getting_started/quickstart.html)
// batch workload.
message PySparkBatch {
- // Required. The HCFS URI of the main Python file to use as the Spark driver. Must
- // be a .py file.
+ // Required. The HCFS URI of the main Python file to use as the Spark driver.
+ // Must be a .py file.
string main_python_file_uri = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. The arguments to pass to the driver. Do not include arguments
@@ -298,7 +326,7 @@ message PySparkBatch {
repeated string archive_uris = 6 [(google.api.field_behavior) = OPTIONAL];
}
-// A configuration for running an [Apache Spark](http://spark.apache.org/)
+// A configuration for running an [Apache Spark](https://spark.apache.org/)
// batch workload.
message SparkBatch {
// The specification of the main method to call to drive the Spark
@@ -310,8 +338,8 @@ message SparkBatch {
// Optional. The HCFS URI of the jar file that contains the main class.
string main_jar_file_uri = 1 [(google.api.field_behavior) = OPTIONAL];
- // Optional. The name of the driver main class. The jar file that contains the class
- // must be in the classpath or specified in `jar_file_uris`.
+ // Optional. The name of the driver main class. The jar file that contains
+ // the class must be in the classpath or specified in `jar_file_uris`.
string main_class = 2 [(google.api.field_behavior) = OPTIONAL];
}
@@ -342,9 +370,9 @@ message SparkRBatch {
// Must be a `.R` or `.r` file.
string main_r_file_uri = 1 [(google.api.field_behavior) = REQUIRED];
- // Optional. The arguments to pass to the Spark driver. Do not include arguments
- // that can be set as batch properties, such as `--conf`, since a collision
- // can occur that causes an incorrect batch submission.
+ // Optional. The arguments to pass to the Spark driver. Do not include
+ // arguments that can be set as batch properties, such as `--conf`, since a
+ // collision can occur that causes an incorrect batch submission.
repeated string args = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. HCFS URIs of files to be placed in the working directory of
@@ -358,14 +386,17 @@ message SparkRBatch {
}
// A configuration for running
-// [Apache Spark SQL](http://spark.apache.org/sql/) queries as a batch workload.
+// [Apache Spark SQL](https://spark.apache.org/sql/) queries as a batch
+// workload.
message SparkSqlBatch {
- // Required. The HCFS URI of the script that contains Spark SQL queries to execute.
+ // Required. The HCFS URI of the script that contains Spark SQL queries to
+ // execute.
string query_file_uri = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. Mapping of query variable names to values (equivalent to the
// Spark SQL command: `SET name="value";`).
- map query_variables = 2 [(google.api.field_behavior) = OPTIONAL];
+ map query_variables = 2
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
repeated string jar_file_uris = 3 [(google.api.field_behavior) = OPTIONAL];
diff --git a/third_party/googleapis/google/cloud/dataproc/v1/clusters.proto b/third_party/googleapis/google/cloud/dataproc/v1/clusters.proto
index 11611fbf6..d1e46bd3d 100644
--- a/third_party/googleapis/google/cloud/dataproc/v1/clusters.proto
+++ b/third_party/googleapis/google/cloud/dataproc/v1/clusters.proto
@@ -26,18 +26,10 @@ import "google/protobuf/duration.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataproc/v1;dataproc";
+option go_package = "cloud.google.com/go/dataproc/apiv1/dataprocpb;dataprocpb";
option java_multiple_files = true;
option java_outer_classname = "ClustersProto";
option java_package = "com.google.cloud.dataproc.v1";
-option (google.api.resource_definition) = {
- type: "container.googleapis.com/Cluster"
- pattern: "projects/{project}/locations/{location}/clusters/{cluster}"
-};
-option (google.api.resource_definition) = {
- type: "metastore.googleapis.com/Service"
- pattern: "projects/{project}/locations/{location}/services/{service}"
-};
// The ClusterControllerService provides methods to manage clusters
// of Compute Engine instances.
@@ -174,12 +166,14 @@ message Cluster {
// Optional. The cluster config for a cluster of Compute Engine Instances.
// Note that Dataproc may set default values, and values may change
// when clusters are updated.
+ //
+ // Exactly one of ClusterConfig or VirtualClusterConfig must be specified.
ClusterConfig config = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. The virtual cluster config is used when creating a Dataproc
// cluster that does not directly control the underlying compute resources,
// for example, when creating a [Dataproc-on-GKE
- // cluster](https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke).
+ // cluster](https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview).
// Dataproc may set default values, and values may change when
// clusters are updated. Exactly one of
// [config][google.cloud.dataproc.v1.Cluster.config] or
@@ -316,7 +310,7 @@ message ClusterConfig {
// The Dataproc cluster config for a cluster that does not directly control the
// underlying compute resources, such as a [Dataproc-on-GKE
-// cluster](https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke).
+// cluster](https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview).
message VirtualClusterConfig {
// Optional. A Cloud Storage bucket used to stage job
// dependencies, config files, and job driver console output.
@@ -414,17 +408,15 @@ message GceClusterConfig {
BIDIRECTIONAL = 3;
}
- // Optional. The zone where the Compute Engine cluster will be located.
- // On a create request, it is required in the "global" region. If omitted
- // in a non-global Dataproc region, the service will pick a zone in the
- // corresponding Compute Engine region. On a get request, zone will
- // always be present.
+ // Optional. The Compute Engine zone where the Dataproc cluster will be
+ // located. If omitted, the service will pick a zone in the cluster's Compute
+ // Engine region. On a get request, zone will always be present.
//
// A full URL, partial URI, or short name are valid. Examples:
//
// * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`
// * `projects/[project_id]/zones/[zone]`
- // * `us-central1-f`
+ // * `[zone]`
string zone_uri = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The Compute Engine network to be used for machine
@@ -436,8 +428,8 @@ message GceClusterConfig {
//
// A full URL, partial URI, or short name are valid. Examples:
//
- // * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`
- // * `projects/[project_id]/regions/global/default`
+ // * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default`
+ // * `projects/[project_id]/global/networks/default`
// * `default`
string network_uri = 2 [(google.api.field_behavior) = OPTIONAL];
@@ -446,8 +438,8 @@ message GceClusterConfig {
//
// A full URL, partial URI, or short name are valid. Examples:
//
- // * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0`
- // * `projects/[project_id]/regions/us-east1/subnetworks/sub0`
+ // * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/[region]/subnetworks/sub0`
+ // * `projects/[project_id]/regions/[region]/subnetworks/sub0`
// * `sub0`
string subnetwork_uri = 6 [(google.api.field_behavior) = OPTIONAL];
@@ -457,7 +449,7 @@ message GceClusterConfig {
// instance. This `internal_ip_only` restriction can only be enabled for
// subnetwork enabled networks, and all off-cluster dependencies must be
// configured to be accessible without external IP addresses.
- bool internal_ip_only = 7 [(google.api.field_behavior) = OPTIONAL];
+ optional bool internal_ip_only = 7 [(google.api.field_behavior) = OPTIONAL];
// Optional. The type of IPv6 access for a cluster.
PrivateIpv6GoogleAccess private_ipv6_google_access = 12
@@ -533,8 +525,8 @@ message NodeGroupAffinity {
//
// A full URL, partial URI, or node group name are valid. Examples:
//
- // * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-central1-a/nodeGroups/node-group-1`
- // * `projects/[project_id]/zones/us-central1-a/nodeGroups/node-group-1`
+ // * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1`
+ // * `projects/[project_id]/zones/[zone]/nodeGroups/node-group-1`
// * `node-group-1`
string node_group_uri = 1 [(google.api.field_behavior) = REQUIRED];
}
@@ -543,13 +535,14 @@ message NodeGroupAffinity {
// VMs](https://cloud.google.com/security/shielded-cloud/shielded-vm).
message ShieldedInstanceConfig {
// Optional. Defines whether instances have Secure Boot enabled.
- bool enable_secure_boot = 1 [(google.api.field_behavior) = OPTIONAL];
+ optional bool enable_secure_boot = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. Defines whether instances have the vTPM enabled.
- bool enable_vtpm = 2 [(google.api.field_behavior) = OPTIONAL];
+ optional bool enable_vtpm = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. Defines whether instances have integrity monitoring enabled.
- bool enable_integrity_monitoring = 3 [(google.api.field_behavior) = OPTIONAL];
+ optional bool enable_integrity_monitoring = 3
+ [(google.api.field_behavior) = OPTIONAL];
}
// Confidential Instance Config for clusters using [Confidential
@@ -582,6 +575,16 @@ message InstanceGroupConfig {
// (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms)
// groups.
PREEMPTIBLE = 2;
+
+ // Instances are [Spot VMs]
+ // (https://cloud.google.com/compute/docs/instances/spot).
+ //
+ // This option is allowed only for [secondary worker]
+ // (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms)
+ // groups. Spot VMs are the latest version of [preemptible VMs]
+ // (https://cloud.google.com/compute/docs/instances/preemptible), and
+ // provide additional features.
+ SPOT = 3;
}
// Optional. The number of VM instances in the instance group.
@@ -603,14 +606,14 @@ message InstanceGroupConfig {
//
// Image examples:
//
- // * `https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]`
+ // * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id]`
// * `projects/[project_id]/global/images/[image-id]`
// * `image-id`
//
// Image family examples. Dataproc will use the most recent
// image from the family:
//
- // * `https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]`
+ // * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name]`
// * `projects/[project_id]/global/images/family/[custom-image-family-name]`
//
// If the URI is unspecified, it will be inferred from
@@ -621,8 +624,8 @@ message InstanceGroupConfig {
//
// A full URL, partial URI, or short name are valid. Examples:
//
- // * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`
- // * `projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`
+ // * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2`
+ // * `projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2`
// * `n1-standard-2`
//
// **Auto Zone Exception**: If you are using the Dataproc
@@ -683,12 +686,12 @@ message AcceleratorConfig {
// Full URL, partial URI, or short name of the accelerator type resource to
// expose to this instance. See
// [Compute Engine
- // AcceleratorTypes](https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).
+ // AcceleratorTypes](https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).
//
// Examples:
//
- // * `https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
- // * `projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80`
+ // * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80`
+ // * `projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80`
// * `nvidia-tesla-k80`
//
// **Auto Zone Exception**: If you are using the Dataproc
@@ -720,6 +723,9 @@ message DiskConfig {
// If one or more SSDs are attached, this runtime bulk
// data is spread across them, and the boot disk contains only basic
// config and installed binaries.
+ //
+ // Note: Local SSD options may vary by machine type and number of vCPUs
+ // selected.
int32 num_local_ssds = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. Interface type of local SSDs (default is "scsi").
@@ -1055,6 +1061,18 @@ message MetastoreConfig {
];
}
+// Contains cluster daemon metrics, such as HDFS and YARN stats.
+//
+// **Beta Feature**: This report is available for testing purposes only. It may
+// be changed before final release.
+message ClusterMetrics {
+ // The HDFS metrics.
+ map hdfs_metrics = 1;
+
+ // YARN metrics.
+ map yarn_metrics = 2;
+}
+
// Dataproc metric config.
message DataprocMetricConfig {
// A source for the collection of Dataproc OSS metrics (see [available OSS
@@ -1084,6 +1102,9 @@ message DataprocMetricConfig {
// Hiveserver2 metric source.
HIVESERVER2 = 6;
+
+ // hivemetastore metric source
+ HIVEMETASTORE = 7;
}
// A Dataproc OSS metric.
@@ -1131,18 +1152,6 @@ message DataprocMetricConfig {
repeated Metric metrics = 1 [(google.api.field_behavior) = REQUIRED];
}
-// Contains cluster daemon metrics, such as HDFS and YARN stats.
-//
-// **Beta Feature**: This report is available for testing purposes only. It may
-// be changed before final release.
-message ClusterMetrics {
- // The HDFS metrics.
- map hdfs_metrics = 1;
-
- // The YARN metrics.
- map yarn_metrics = 2;
-}
-
// A request to create a cluster.
message CreateClusterRequest {
// Required. The ID of the Google Cloud Platform project that the cluster
@@ -1189,7 +1198,7 @@ message UpdateClusterRequest {
// Required. The changes to the cluster.
Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
- // Optional. Timeout for graceful YARN decomissioning. Graceful
+ // Optional. Timeout for graceful YARN decommissioning. Graceful
// decommissioning allows removing nodes from the cluster without
// interrupting jobs in progress. Timeout specifies how long to wait for jobs
// in progress to finish before forcefully removing nodes (and potentially
diff --git a/third_party/googleapis/google/cloud/dataproc/v1/dataproc_v1.yaml b/third_party/googleapis/google/cloud/dataproc/v1/dataproc_v1.yaml
index 7f1d640fa..e1da3ab29 100644
--- a/third_party/googleapis/google/cloud/dataproc/v1/dataproc_v1.yaml
+++ b/third_party/googleapis/google/cloud/dataproc/v1/dataproc_v1.yaml
@@ -10,6 +10,8 @@ apis:
- name: google.cloud.dataproc.v1.JobController
- name: google.cloud.dataproc.v1.NodeGroupController
- name: google.cloud.dataproc.v1.WorkflowTemplateService
+- name: google.iam.v1.IAMPolicy
+- name: google.longrunning.Operations
types:
- name: google.cloud.dataproc.v1.BatchOperationMetadata
@@ -97,12 +99,20 @@ http:
body: '*'
- selector: google.longrunning.Operations.CancelOperation
post: '/v1/{name=projects/*/regions/*/operations/*}:cancel'
+ additional_bindings:
+ - post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
- selector: google.longrunning.Operations.DeleteOperation
delete: '/v1/{name=projects/*/regions/*/operations/*}'
+ additional_bindings:
+ - delete: '/v1/{name=projects/*/locations/*/operations/*}'
- selector: google.longrunning.Operations.GetOperation
get: '/v1/{name=projects/*/regions/*/operations/*}'
+ additional_bindings:
+ - get: '/v1/{name=projects/*/locations/*/operations/*}'
- selector: google.longrunning.Operations.ListOperations
get: '/v1/{name=projects/*/regions/*/operations}'
+ additional_bindings:
+ - get: '/v1/{name=projects/*/locations/*/operations}'
authentication:
rules:
diff --git a/third_party/googleapis/google/cloud/dataproc/v1/jobs.proto b/third_party/googleapis/google/cloud/dataproc/v1/jobs.proto
index e9dcf9cc6..1c19ce66b 100644
--- a/third_party/googleapis/google/cloud/dataproc/v1/jobs.proto
+++ b/third_party/googleapis/google/cloud/dataproc/v1/jobs.proto
@@ -24,7 +24,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataproc/v1;dataproc";
+option go_package = "cloud.google.com/go/dataproc/apiv1/dataprocpb;dataprocpb";
option java_multiple_files = true;
option java_outer_classname = "JobsProto";
option java_package = "com.google.cloud.dataproc.v1";
@@ -476,6 +476,43 @@ message PrestoJob {
LoggingConfig logging_config = 7 [(google.api.field_behavior) = OPTIONAL];
}
+// A Dataproc job for running [Trino](https://trino.io/) queries.
+// **IMPORTANT**: The [Dataproc Trino Optional
+// Component](https://cloud.google.com/dataproc/docs/concepts/components/trino)
+// must be enabled when the cluster is created to submit a Trino job to the
+// cluster.
+message TrinoJob {
+ // Required. The sequence of Trino queries to execute, specified as
+ // either an HCFS file URI or as a list of queries.
+ oneof queries {
+ // The HCFS URI of the script that contains SQL queries.
+ string query_file_uri = 1;
+
+ // A list of queries.
+ QueryList query_list = 2;
+ }
+
+ // Optional. Whether to continue executing queries if a query fails.
+ // The default value is `false`. Setting to `true` can be useful when
+ // executing independent parallel queries.
+ bool continue_on_failure = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The format in which query output will be displayed. See the
+ // Trino documentation for supported output formats
+ string output_format = 4 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Trino client tags to attach to this query
+ repeated string client_tags = 5 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. A mapping of property names to values. Used to set Trino
+ // [session properties](https://trino.io/docs/current/sql/set-session.html)
+ // Equivalent to using the --session flag in the Trino CLI
+ map properties = 6 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The runtime log config for job execution.
+ LoggingConfig logging_config = 7 [(google.api.field_behavior) = OPTIONAL];
+}
+
// Dataproc job config.
message JobPlacement {
// Required. The name of the cluster where the job will be submitted.
@@ -680,6 +717,9 @@ message Job {
// Optional. Job is a Presto job.
PrestoJob presto_job = 23 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Job is a Trino job.
+ TrinoJob trino_job = 28 [(google.api.field_behavior) = OPTIONAL];
}
// Output only. The job status. Additional application-specific
diff --git a/third_party/googleapis/google/cloud/dataproc/v1/node_groups.proto b/third_party/googleapis/google/cloud/dataproc/v1/node_groups.proto
index 0abc22382..0bd3ef30f 100644
--- a/third_party/googleapis/google/cloud/dataproc/v1/node_groups.proto
+++ b/third_party/googleapis/google/cloud/dataproc/v1/node_groups.proto
@@ -24,7 +24,7 @@ import "google/cloud/dataproc/v1/clusters.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/duration.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataproc/v1;dataproc";
+option go_package = "cloud.google.com/go/dataproc/apiv1/dataprocpb;dataprocpb";
option java_multiple_files = true;
option java_outer_classname = "NodeGroupsProto";
option java_package = "com.google.cloud.dataproc.v1";
@@ -144,7 +144,7 @@ message ResizeNodeGroupRequest {
// underscores (_), and hyphens (-). The maximum length is 40 characters.
string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Timeout for graceful YARN decommissioning. [Graceful
+ // Optional. Timeout for graceful YARN decomissioning. [Graceful
// decommissioning]
// (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/scaling-clusters#graceful_decommissioning)
// allows the removal of nodes from the Compute Engine node group
diff --git a/third_party/googleapis/google/cloud/dataproc/v1/operations.proto b/third_party/googleapis/google/cloud/dataproc/v1/operations.proto
index 854d9eda6..57c913f7a 100644
--- a/third_party/googleapis/google/cloud/dataproc/v1/operations.proto
+++ b/third_party/googleapis/google/cloud/dataproc/v1/operations.proto
@@ -19,7 +19,7 @@ package google.cloud.dataproc.v1;
import "google/api/field_behavior.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataproc/v1;dataproc";
+option go_package = "cloud.google.com/go/dataproc/apiv1/dataprocpb;dataprocpb";
option java_multiple_files = true;
option java_outer_classname = "OperationsProto";
option java_package = "com.google.cloud.dataproc.v1";
@@ -117,6 +117,10 @@ message ClusterOperationMetadata {
// Output only. Errors encountered during operation execution.
repeated string warnings = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Child operation ids
+ repeated string child_operation_ids = 15
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Metadata describing the node group operation.
diff --git a/third_party/googleapis/google/cloud/dataproc/v1/shared.proto b/third_party/googleapis/google/cloud/dataproc/v1/shared.proto
index 187969157..72192bd40 100644
--- a/third_party/googleapis/google/cloud/dataproc/v1/shared.proto
+++ b/third_party/googleapis/google/cloud/dataproc/v1/shared.proto
@@ -17,23 +17,34 @@ syntax = "proto3";
package google.cloud.dataproc.v1;
import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataproc/v1;dataproc";
+option go_package = "cloud.google.com/go/dataproc/apiv1/dataprocpb;dataprocpb";
option java_multiple_files = true;
option java_outer_classname = "SharedProto";
option java_package = "com.google.cloud.dataproc.v1";
+option (google.api.resource_definition) = {
+ type: "container.googleapis.com/Cluster"
+ pattern: "projects/{project}/locations/{location}/clusters/{cluster}"
+};
+option (google.api.resource_definition) = {
+ type: "metastore.googleapis.com/Service"
+ pattern: "projects/{project}/locations/{location}/services/{service}"
+};
// Runtime configuration for a workload.
message RuntimeConfig {
// Optional. Version of the batch runtime.
string version = 1 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Optional custom container image for the job runtime environment. If
- // not specified, a default container image will be used.
+ // Optional. Optional custom container image for the job runtime environment.
+ // If not specified, a default container image will be used.
string container_image = 2 [(google.api.field_behavior) = OPTIONAL];
- // Optional. A mapping of property names to values, which are used to configure workload
- // execution.
+ // Optional. A mapping of property names to values, which are used to
+ // configure workload execution.
map properties = 3 [(google.api.field_behavior) = OPTIONAL];
}
@@ -43,7 +54,8 @@ message EnvironmentConfig {
ExecutionConfig execution_config = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. Peripherals configuration that workload has access to.
- PeripheralsConfig peripherals_config = 2 [(google.api.field_behavior) = OPTIONAL];
+ PeripheralsConfig peripherals_config = 2
+ [(google.api.field_behavior) = OPTIONAL];
}
// Execution configuration for a workload.
@@ -65,19 +77,39 @@ message ExecutionConfig {
// Optional. The Cloud KMS key to use for encryption.
string kms_key = 7 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The duration after which the workload will be terminated.
+ // When the workload passes this ttl, it will be unconditionally killed
+ // without waiting for ongoing work to finish.
+ // Minimum value is 10 minutes; maximum value is 14 days (see JSON
+ // representation of
+ // [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
+ // If both ttl and idle_ttl are specified, the conditions are treated as
+ // and OR: the workload will be terminated when it has been idle for idle_ttl
+ // or when the ttl has passed, whichever comes first.
+ // If ttl is not specified for a session, it defaults to 24h.
+ google.protobuf.Duration ttl = 9 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. A Cloud Storage bucket used to stage workload dependencies,
+ // config files, and store workload output and other ephemeral data, such as
+ // Spark history files. If you do not specify a staging bucket, Cloud Dataproc
+ // will determine a Cloud Storage location according to the region where your
+ // workload is running, and then create and manage project-level, per-location
+ // staging and temporary buckets.
+ // **This field requires a Cloud Storage bucket name, not a `gs://...` URI to
+ // a Cloud Storage bucket.**
+ string staging_bucket = 10 [(google.api.field_behavior) = OPTIONAL];
}
// Spark History Server configuration for the workload.
message SparkHistoryServerConfig {
- // Optional. Resource name of an existing Dataproc Cluster to act as a Spark History
- // Server for the workload.
+ // Optional. Resource name of an existing Dataproc Cluster to act as a Spark
+ // History Server for the workload.
//
// Example:
//
// * `projects/[project_id]/regions/[region]/clusters/[cluster_name]`
- string dataproc_cluster = 1 [
- (google.api.field_behavior) = OPTIONAL
- ];
+ string dataproc_cluster = 1 [(google.api.field_behavior) = OPTIONAL];
}
// Auxiliary services configuration for a workload.
@@ -88,58 +120,111 @@ message PeripheralsConfig {
//
// * `projects/[project_id]/locations/[region]/services/[service_id]`
string metastore_service = 1 [
- (google.api.field_behavior) = OPTIONAL
+ (google.api.field_behavior) = OPTIONAL,
+ (google.api.resource_reference) = {
+ type: "metastore.googleapis.com/Service"
+ }
];
// Optional. The Spark History Server configuration for the workload.
- SparkHistoryServerConfig spark_history_server_config = 2 [(google.api.field_behavior) = OPTIONAL];
+ SparkHistoryServerConfig spark_history_server_config = 2
+ [(google.api.field_behavior) = OPTIONAL];
}
// Runtime information about workload execution.
message RuntimeInfo {
- // Output only. Map of remote access endpoints (such as web interfaces and APIs) to their
- // URIs.
+ // Output only. Map of remote access endpoints (such as web interfaces and
+ // APIs) to their URIs.
map endpoints = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. A URI pointing to the location of the stdout and stderr of the workload.
+ // Output only. A URI pointing to the location of the stdout and stderr of the
+ // workload.
string output_uri = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. A URI pointing to the location of the diagnostics tarball.
string diagnostic_output_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Approximate workload resource usage calculated after workload
+ // finishes (see [Dataproc Serverless pricing]
+ // (https://cloud.google.com/dataproc-serverless/pricing)).
+ UsageMetrics approximate_usage = 6
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Snapshot of current workload resource usage.
+ UsageSnapshot current_usage = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Usage metrics represent approximate total resources consumed by a workload.
+message UsageMetrics {
+ // Optional. DCU (Dataproc Compute Units) usage in (`milliDCU` x `seconds`)
+ // (see [Dataproc Serverless pricing]
+ // (https://cloud.google.com/dataproc-serverless/pricing)).
+ int64 milli_dcu_seconds = 1 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Shuffle storage usage in (`GB` x `seconds`) (see
+ // [Dataproc Serverless pricing]
+ // (https://cloud.google.com/dataproc-serverless/pricing)).
+ int64 shuffle_storage_gb_seconds = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// The usage snaphot represents the resources consumed by a workload at a
+// specified time.
+message UsageSnapshot {
+ // Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see
+ // [Dataproc Serverless pricing]
+ // (https://cloud.google.com/dataproc-serverless/pricing)).
+ int64 milli_dcu = 1 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Shuffle Storage in gigabytes (GB). (see [Dataproc Serverless
+ // pricing] (https://cloud.google.com/dataproc-serverless/pricing))
+ int64 shuffle_storage_gb = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The timestamp of the usage snapshot.
+ google.protobuf.Timestamp snapshot_time = 3
+ [(google.api.field_behavior) = OPTIONAL];
}
// The cluster's GKE config.
message GkeClusterConfig {
- // Optional. A target GKE cluster to deploy to. It must be in the same project and
- // region as the Dataproc cluster (the GKE cluster can be zonal or regional).
- // Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'
+ // Optional. A target GKE cluster to deploy to. It must be in the same project
+ // and region as the Dataproc cluster (the GKE cluster can be zonal or
+ // regional). Format:
+ // 'projects/{project}/locations/{location}/clusters/{cluster_id}'
string gke_cluster_target = 2 [
- (google.api.field_behavior) = OPTIONAL
+ (google.api.field_behavior) = OPTIONAL,
+ (google.api.resource_reference) = {
+ type: "container.googleapis.com/Cluster"
+ }
];
- // Optional. GKE NodePools where workloads will be scheduled. At least one node pool
- // must be assigned the 'default' role. Each role can be given to only a
- // single NodePoolTarget. All NodePools must have the same location settings.
- // If a nodePoolTarget is not specified, Dataproc constructs a default
- // nodePoolTarget.
- repeated GkeNodePoolTarget node_pool_target = 3 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. GKE node pools where workloads will be scheduled. At least one
+ // node pool must be assigned the `DEFAULT`
+ // [GkeNodePoolTarget.Role][google.cloud.dataproc.v1.GkeNodePoolTarget.Role].
+ // If a `GkeNodePoolTarget` is not specified, Dataproc constructs a `DEFAULT`
+ // `GkeNodePoolTarget`. Each role can be given to only one
+ // `GkeNodePoolTarget`. All node pools must have the same location settings.
+ repeated GkeNodePoolTarget node_pool_target = 3
+ [(google.api.field_behavior) = OPTIONAL];
}
// The configuration for running the Dataproc cluster on Kubernetes.
message KubernetesClusterConfig {
- // Optional. A namespace within the Kubernetes cluster to deploy into. If this namespace
- // does not exist, it is created. If it exists, Dataproc
- // verifies that another Dataproc VirtualCluster is not installed
- // into it. If not specified, the name of the Dataproc Cluster is used.
+ // Optional. A namespace within the Kubernetes cluster to deploy into. If this
+ // namespace does not exist, it is created. If it exists, Dataproc verifies
+ // that another Dataproc VirtualCluster is not installed into it. If not
+ // specified, the name of the Dataproc Cluster is used.
string kubernetes_namespace = 1 [(google.api.field_behavior) = OPTIONAL];
oneof config {
// Required. The configuration for running the Dataproc cluster on GKE.
- GkeClusterConfig gke_cluster_config = 2 [(google.api.field_behavior) = REQUIRED];
+ GkeClusterConfig gke_cluster_config = 2
+ [(google.api.field_behavior) = REQUIRED];
}
- // Optional. The software configuration for this Dataproc cluster running on Kubernetes.
- KubernetesSoftwareConfig kubernetes_software_config = 3 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. The software configuration for this Dataproc cluster running on
+ // Kubernetes.
+ KubernetesSoftwareConfig kubernetes_software_config = 3
+ [(google.api.field_behavior) = OPTIONAL];
}
// The software configuration for this Dataproc cluster running on Kubernetes.
@@ -163,54 +248,60 @@ message KubernetesSoftwareConfig {
map properties = 2;
}
-// GKE NodePools that Dataproc workloads run on.
+// GKE node pools that Dataproc workloads run on.
message GkeNodePoolTarget {
- // `Role` specifies whose tasks will run on the NodePool. The roles can be
- // specific to workloads. Exactly one GkeNodePoolTarget within the
- // VirtualCluster must have 'default' role, which is used to run all workloads
- // that are not associated with a NodePool.
+ // `Role` specifies the tasks that will run on the node pool. Roles can be
+ // specific to workloads. Exactly one
+ // [GkeNodePoolTarget][google.cloud.dataproc.v1.GkeNodePoolTarget] within the
+ // virtual cluster must have the `DEFAULT` role, which is used to run all
+ // workloads that are not associated with a node pool.
enum Role {
// Role is unspecified.
ROLE_UNSPECIFIED = 0;
- // Any roles that are not directly assigned to a NodePool run on the
- // `default` role's NodePool.
+ // At least one node pool must have the `DEFAULT` role.
+ // Work assigned to a role that is not associated with a node pool
+ // is assigned to the node pool with the `DEFAULT` role. For example,
+ // work assigned to the `CONTROLLER` role will be assigned to the node pool
+ // with the `DEFAULT` role if no node pool has the `CONTROLLER` role.
DEFAULT = 1;
- // Run controllers and webhooks.
+ // Run work associated with the Dataproc control plane (for example,
+ // controllers and webhooks). Very low resource requirements.
CONTROLLER = 2;
- // Run spark driver.
+ // Run work associated with a Spark driver of a job.
SPARK_DRIVER = 3;
- // Run spark executors.
+ // Run work associated with a Spark executor of a job.
SPARK_EXECUTOR = 4;
}
- // Required. The target GKE NodePool.
+ // Required. The target GKE node pool.
// Format:
// 'projects/{project}/locations/{location}/clusters/{cluster}/nodePools/{node_pool}'
- string node_pool = 1 [
- (google.api.field_behavior) = REQUIRED
- ];
+ string node_pool = 1 [(google.api.field_behavior) = REQUIRED];
- // Required. The types of role for a GKE NodePool
+ // Required. The roles associated with the GKE node pool.
repeated Role roles = 2 [(google.api.field_behavior) = REQUIRED];
- // Optional. The configuration for the GKE NodePool.
+ // Input only. The configuration for the GKE node pool.
//
- // If specified, Dataproc attempts to create a NodePool with the
+ // If specified, Dataproc attempts to create a node pool with the
// specified shape. If one with the same name already exists, it is
// verified against all specified fields. If a field differs, the
// virtual cluster creation will fail.
//
- // If omitted, any NodePool with the specified name is used. If a
- // NodePool with the specified name does not exist, Dataproc create a NodePool
- // with default values.
- GkeNodePoolConfig node_pool_config = 3 [(google.api.field_behavior) = OPTIONAL];
+ // If omitted, any node pool with the specified name is used. If a
+ // node pool with the specified name does not exist, Dataproc create a
+ // node pool with default values.
+ //
+ // This is an input only field. It will not be returned by the API.
+ GkeNodePoolConfig node_pool_config = 3
+ [(google.api.field_behavior) = INPUT_ONLY];
}
-// The configuration of a GKE NodePool used by a [Dataproc-on-GKE
+// The configuration of a GKE node pool used by a [Dataproc-on-GKE
// cluster](https://cloud.google.com/dataproc/docs/concepts/jobs/dataproc-gke#create-a-dataproc-on-gke-cluster).
message GkeNodePoolConfig {
// Parameters that describe cluster nodes.
@@ -219,19 +310,28 @@ message GkeNodePoolConfig {
// type](https://cloud.google.com/compute/docs/machine-types).
string machine_type = 1 [(google.api.field_behavior) = OPTIONAL];
- // Optional. Whether the nodes are created as [preemptible VM
- // instances](https://cloud.google.com/compute/docs/instances/preemptible).
- bool preemptible = 10 [(google.api.field_behavior) = OPTIONAL];
-
- // Optional. The number of local SSD disks to attach to the node, which is limited by
- // the maximum number of disks allowable per zone (see [Adding Local
- // SSDs](https://cloud.google.com/compute/docs/disks/local-ssd)).
+ // Optional. The number of local SSD disks to attach to the node, which is
+ // limited by the maximum number of disks allowable per zone (see [Adding
+ // Local SSDs](https://cloud.google.com/compute/docs/disks/local-ssd)).
int32 local_ssd_count = 7 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. Whether the nodes are created as legacy [preemptible VM
+ // instances] (https://cloud.google.com/compute/docs/instances/preemptible).
+ // Also see
+ // [Spot][google.cloud.dataproc.v1.GkeNodePoolConfig.GkeNodeConfig.spot]
+ // VMs, preemptible VM instances without a maximum lifetime. Legacy and Spot
+ // preemptible nodes cannot be used in a node pool with the `CONTROLLER`
+ // [role]
+ // (/dataproc/docs/reference/rest/v1/projects.regions.clusters#role)
+ // or in the DEFAULT node pool if the CONTROLLER role is not assigned (the
+ // DEFAULT node pool will assume the CONTROLLER role).
+ bool preemptible = 10 [(google.api.field_behavior) = OPTIONAL];
+
// Optional. A list of [hardware
// accelerators](https://cloud.google.com/compute/docs/gpus) to attach to
// each node.
- repeated GkeNodePoolAcceleratorConfig accelerators = 11 [(google.api.field_behavior) = OPTIONAL];
+ repeated GkeNodePoolAcceleratorConfig accelerators = 11
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. [Minimum CPU
// platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
@@ -239,26 +339,51 @@ message GkeNodePoolConfig {
// specified or a newer CPU platform. Specify the friendly names of CPU
// platforms, such as "Intel Haswell"` or Intel Sandy Bridge".
string min_cpu_platform = 13 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The [Customer Managed Encryption Key (CMEK)]
+ // (https://cloud.google.com/kubernetes-engine/docs/how-to/using-cmek)
+ // used to encrypt the boot disk attached to each node in the node pool.
+ // Specify the key using the following format:
+ // projects/KEY_PROJECT_ID/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME.
+ string boot_disk_kms_key = 23 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Whether the nodes are created as [Spot VM instances]
+ // (https://cloud.google.com/compute/docs/instances/spot).
+ // Spot VMs are the latest update to legacy
+ // [preemptible
+ // VMs][google.cloud.dataproc.v1.GkeNodePoolConfig.GkeNodeConfig.preemptible].
+ // Spot VMs do not have a maximum lifetime. Legacy and Spot preemptible
+ // nodes cannot be used in a node pool with the `CONTROLLER`
+ // [role](/dataproc/docs/reference/rest/v1/projects.regions.clusters#role)
+ // or in the DEFAULT node pool if the CONTROLLER role is not assigned (the
+ // DEFAULT node pool will assume the CONTROLLER role).
+ bool spot = 32 [(google.api.field_behavior) = OPTIONAL];
}
// A GkeNodeConfigAcceleratorConfig represents a Hardware Accelerator request
- // for a NodePool.
+ // for a node pool.
message GkeNodePoolAcceleratorConfig {
// The number of accelerator cards exposed to an instance.
int64 accelerator_count = 1;
// The accelerator type resource namename (see GPUs on Compute Engine).
string accelerator_type = 2;
+
+ // Size of partitions to create on the GPU. Valid values are described in
+ // the NVIDIA [mig user
+ // guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
+ string gpu_partition_size = 3;
}
// GkeNodePoolAutoscaling contains information the cluster autoscaler needs to
// adjust the size of the node pool to the current cluster usage.
message GkeNodePoolAutoscalingConfig {
- // The minimum number of nodes in the NodePool. Must be >= 0 and <=
+ // The minimum number of nodes in the node pool. Must be >= 0 and <=
// max_node_count.
int32 min_node_count = 2;
- // The maximum number of nodes in the NodePool. Must be >= min_node_count.
+ // The maximum number of nodes in the node pool. Must be >= min_node_count,
+ // and must be > 0.
// **Note:** Quota must be sufficient to scale up the cluster.
int32 max_node_count = 3;
}
@@ -268,17 +393,21 @@ message GkeNodePoolConfig {
// Optional. The list of Compute Engine
// [zones](https://cloud.google.com/compute/docs/zones#available) where
- // NodePool's nodes will be located.
+ // node pool nodes associated with a Dataproc on GKE virtual cluster
+ // will be located.
//
- // **Note:** Currently, only one zone may be specified.
+ // **Note:** All node pools associated with a virtual cluster
+ // must be located in the same region as the virtual cluster, and they must
+ // be located in the same zone within that region.
//
- // If a location is not specified during NodePool creation, Dataproc will
- // choose a location.
+ // If a location is not specified during node pool creation, Dataproc on GKE
+ // will choose the zone.
repeated string locations = 13 [(google.api.field_behavior) = OPTIONAL];
- // Optional. The autoscaler configuration for this NodePool. The autoscaler is enabled
- // only when a valid configuration is present.
- GkeNodePoolAutoscalingConfig autoscaling = 4 [(google.api.field_behavior) = OPTIONAL];
+ // Optional. The autoscaler configuration for this node pool. The autoscaler
+ // is enabled only when a valid configuration is present.
+ GkeNodePoolAutoscalingConfig autoscaling = 4
+ [(google.api.field_behavior) = OPTIONAL];
}
// Cluster components that can be activated.
@@ -308,12 +437,18 @@ enum Component {
// The Hive Web HCatalog (the REST service for accessing HCatalog).
HIVE_WEBHCAT = 3;
+ // Hudi.
+ HUDI = 18;
+
// The Jupyter Notebook.
JUPYTER = 1;
// The Presto query engine.
PRESTO = 6;
+ // The Trino query engine.
+ TRINO = 17;
+
// The Ranger service.
RANGER = 12;
diff --git a/third_party/googleapis/google/cloud/dataproc/v1/workflow_templates.proto b/third_party/googleapis/google/cloud/dataproc/v1/workflow_templates.proto
index 416ba26d0..0b81da02e 100644
--- a/third_party/googleapis/google/cloud/dataproc/v1/workflow_templates.proto
+++ b/third_party/googleapis/google/cloud/dataproc/v1/workflow_templates.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataproc/v1;dataproc";
+option go_package = "cloud.google.com/go/dataproc/apiv1/dataprocpb;dataprocpb";
option java_multiple_files = true;
option java_outer_classname = "WorkflowTemplatesProto";
option java_package = "com.google.cloud.dataproc.v1";
@@ -36,10 +36,12 @@ option java_package = "com.google.cloud.dataproc.v1";
// Dataproc API.
service WorkflowTemplateService {
option (google.api.default_host) = "dataproc.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+ option (google.api.oauth_scopes) =
+ "https://www.googleapis.com/auth/cloud-platform";
// Creates new workflow template.
- rpc CreateWorkflowTemplate(CreateWorkflowTemplateRequest) returns (WorkflowTemplate) {
+ rpc CreateWorkflowTemplate(CreateWorkflowTemplateRequest)
+ returns (WorkflowTemplate) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/workflowTemplates"
body: "template"
@@ -55,7 +57,8 @@ service WorkflowTemplateService {
//
// Can retrieve previously instantiated template by specifying optional
// version parameter.
- rpc GetWorkflowTemplate(GetWorkflowTemplateRequest) returns (WorkflowTemplate) {
+ rpc GetWorkflowTemplate(GetWorkflowTemplateRequest)
+ returns (WorkflowTemplate) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/workflowTemplates/*}"
additional_bindings {
@@ -85,7 +88,8 @@ service WorkflowTemplateService {
// On successful completion,
// [Operation.response][google.longrunning.Operation.response] will be
// [Empty][google.protobuf.Empty].
- rpc InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest) returns (google.longrunning.Operation) {
+ rpc InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/workflowTemplates/*}:instantiate"
body: "*"
@@ -105,7 +109,8 @@ service WorkflowTemplateService {
// Instantiates a template and begins execution.
//
// This method is equivalent to executing the sequence
- // [CreateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate],
+ // [CreateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate],
+ // [InstantiateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate],
// [DeleteWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.DeleteWorkflowTemplate].
//
// The returned Operation can be used to track execution of
@@ -126,7 +131,9 @@ service WorkflowTemplateService {
// On successful completion,
// [Operation.response][google.longrunning.Operation.response] will be
// [Empty][google.protobuf.Empty].
- rpc InstantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest) returns (google.longrunning.Operation) {
+ rpc InstantiateInlineWorkflowTemplate(
+ InstantiateInlineWorkflowTemplateRequest)
+ returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/workflowTemplates:instantiateInline"
body: "template"
@@ -144,7 +151,8 @@ service WorkflowTemplateService {
// Updates (replaces) workflow template. The updated template
// must contain version that matches the current server version.
- rpc UpdateWorkflowTemplate(UpdateWorkflowTemplateRequest) returns (WorkflowTemplate) {
+ rpc UpdateWorkflowTemplate(UpdateWorkflowTemplateRequest)
+ returns (WorkflowTemplate) {
option (google.api.http) = {
put: "/v1/{template.name=projects/*/locations/*/workflowTemplates/*}"
body: "template"
@@ -157,7 +165,8 @@ service WorkflowTemplateService {
}
// Lists workflows that match the specified filter in the request.
- rpc ListWorkflowTemplates(ListWorkflowTemplatesRequest) returns (ListWorkflowTemplatesResponse) {
+ rpc ListWorkflowTemplates(ListWorkflowTemplatesRequest)
+ returns (ListWorkflowTemplatesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/workflowTemplates"
additional_bindings {
@@ -168,7 +177,8 @@ service WorkflowTemplateService {
}
// Deletes a workflow template. It does not cancel in-progress workflows.
- rpc DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest) returns (google.protobuf.Empty) {
+ rpc DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest)
+ returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/workflowTemplates/*}"
additional_bindings {
@@ -214,10 +224,12 @@ message WorkflowTemplate {
int32 version = 3 [(google.api.field_behavior) = OPTIONAL];
// Output only. The time template was created.
- google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp create_time = 4
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time template was last updated.
- google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp update_time = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. The labels to associate with this template. These labels
// will be propagated to all jobs and clusters created by the workflow
@@ -234,7 +246,8 @@ message WorkflowTemplate {
map labels = 6 [(google.api.field_behavior) = OPTIONAL];
// Required. WorkflowTemplate scheduling information.
- WorkflowTemplatePlacement placement = 7 [(google.api.field_behavior) = REQUIRED];
+ WorkflowTemplatePlacement placement = 7
+ [(google.api.field_behavior) = REQUIRED];
// Required. The Directed Acyclic Graph of Jobs to submit.
repeated OrderedJob jobs = 8 [(google.api.field_behavior) = REQUIRED];
@@ -242,7 +255,8 @@ message WorkflowTemplate {
// Optional. Template parameters whose values are substituted into the
// template. Values for parameters must be provided when the template is
// instantiated.
- repeated TemplateParameter parameters = 9 [(google.api.field_behavior) = OPTIONAL];
+ repeated TemplateParameter parameters = 9
+ [(google.api.field_behavior) = OPTIONAL];
// Optional. Timeout duration for the DAG of jobs, expressed in seconds (see
// [JSON representation of
@@ -254,7 +268,8 @@ message WorkflowTemplate {
// [managed
// cluster](/dataproc/docs/concepts/workflows/using-workflows#configuring_or_selecting_a_cluster),
// the cluster is deleted.
- google.protobuf.Duration dag_timeout = 10 [(google.api.field_behavior) = OPTIONAL];
+ google.protobuf.Duration dag_timeout = 10
+ [(google.api.field_behavior) = OPTIONAL];
}
// Specifies workflow execution target.
@@ -312,7 +327,8 @@ message ClusterSelector {
// Required. The cluster labels. Cluster must have all labels
// to match.
- map cluster_labels = 2 [(google.api.field_behavior) = REQUIRED];
+ map cluster_labels = 2
+ [(google.api.field_behavior) = REQUIRED];
}
// A job executed by the workflow.
@@ -322,8 +338,8 @@ message OrderedJob {
//
// The step id is used as prefix for job id, as job
// `goog-dataproc-workflow-step-id` label, and in
- // [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids] field from other
- // steps.
+ // [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids]
+ // field from other steps.
//
// The id must contain only letters (a-z, A-Z), numbers (0-9),
// underscores (_), and hyphens (-). Cannot begin or end with underscore
@@ -374,7 +390,8 @@ message OrderedJob {
// Optional. The optional list of prerequisite job step_ids.
// If not specified, the job will start at the beginning of workflow.
- repeated string prerequisite_step_ids = 10 [(google.api.field_behavior) = OPTIONAL];
+ repeated string prerequisite_step_ids = 10
+ [(google.api.field_behavior) = OPTIONAL];
}
// A configurable parameter that replaces one or more fields in the template.
@@ -400,10 +417,10 @@ message TemplateParameter {
// A field is allowed to appear in at most one parameter's list of field
// paths.
//
- // A field path is similar in syntax to a [google.protobuf.FieldMask][google.protobuf.FieldMask].
- // For example, a field path that references the zone field of a workflow
- // template's cluster selector would be specified as
- // `placement.clusterSelector.zone`.
+ // A field path is similar in syntax to a
+ // [google.protobuf.FieldMask][google.protobuf.FieldMask]. For example, a
+ // field path that references the zone field of a workflow template's cluster
+ // selector would be specified as `placement.clusterSelector.zone`.
//
// Also, field paths can reference fields using the following syntax:
//
@@ -510,13 +527,15 @@ message WorkflowMetadata {
int32 version = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The create cluster operation metadata.
- ClusterOperation create_cluster = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+ ClusterOperation create_cluster = 3
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The workflow graph.
WorkflowGraph graph = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The delete cluster operation metadata.
- ClusterOperation delete_cluster = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+ ClusterOperation delete_cluster = 5
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The workflow state.
State state = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -528,25 +547,33 @@ message WorkflowMetadata {
map parameters = 8;
// Output only. Workflow start time.
- google.protobuf.Timestamp start_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp start_time = 9
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Workflow end time.
- google.protobuf.Timestamp end_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Timestamp end_time = 10
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The UUID of target cluster.
string cluster_uuid = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. The timeout duration for the DAG of jobs, expressed in seconds (see
- // [JSON representation of
+ // Output only. The timeout duration for the DAG of jobs, expressed in seconds
+ // (see [JSON representation of
// duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
- google.protobuf.Duration dag_timeout = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. DAG start time, only set for workflows with [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when DAG
- // begins.
- google.protobuf.Timestamp dag_start_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. DAG end time, only set for workflows with [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when DAG ends.
- google.protobuf.Timestamp dag_end_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+ google.protobuf.Duration dag_timeout = 12
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. DAG start time, only set for workflows with
+ // [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
+ // DAG begins.
+ google.protobuf.Timestamp dag_start_time = 13
+ [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. DAG end time, only set for workflows with
+ // [dag_timeout][google.cloud.dataproc.v1.WorkflowMetadata.dag_timeout] when
+ // DAG ends.
+ google.protobuf.Timestamp dag_end_time = 14
+ [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The cluster operation triggered by a workflow.
@@ -595,7 +622,8 @@ message WorkflowNode {
string step_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Node's prerequisite nodes.
- repeated string prerequisite_step_ids = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated string prerequisite_step_ids = 2
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The job id; populated after the node enters RUNNING state.
string job_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -771,7 +799,8 @@ message ListWorkflowTemplatesRequest {
// A response to a request to list workflow templates in a project.
message ListWorkflowTemplatesResponse {
// Output only. WorkflowTemplates list.
- repeated WorkflowTemplate templates = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ repeated WorkflowTemplate templates = 1
+ [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. This token is included in the response if there are more
// results to fetch. To fetch additional results, provide this value as the
diff --git a/third_party/googleapis/google/cloud/dataqna/v1alpha/BUILD.bazel b/third_party/googleapis/google/cloud/dataqna/v1alpha/BUILD.bazel
index 3988a296e..f9927f2ff 100644
--- a/third_party/googleapis/google/cloud/dataqna/v1alpha/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/dataqna/v1alpha/BUILD.bazel
@@ -122,7 +122,7 @@ load(
go_proto_library(
name = "dataqna_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/dataqna/v1alpha",
+ importpath = "cloud.google.com/go/dataqna/apiv1alpha/dataqnapb",
protos = [":dataqna_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -135,6 +135,8 @@ go_gapic_library(
srcs = [":dataqna_proto_with_info"],
grpc_service_config = "dataqna_grpc_service_config.json",
importpath = "cloud.google.com/go/dataqna/apiv1alpha;dataqna",
+ metadata = True,
+ release_level = "alpha",
rest_numeric_enums = False,
service_yaml = "dataqna_v1alpha.yaml",
transport = "grpc+rest",
@@ -178,7 +180,8 @@ py_gapic_library(
"warehouse-package-name=google-cloud-data-qna",
],
rest_numeric_enums = False,
- transport = "grpc",
+ service_yaml = "dataqna_v1alpha.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -225,6 +228,7 @@ php_gapic_library(
srcs = [":dataqna_proto_with_info"],
grpc_service_config = "dataqna_grpc_service_config.json",
rest_numeric_enums = False,
+ service_yaml = "dataqna_v1alpha.yaml",
transport = "grpc+rest",
deps = [
":dataqna_php_grpc",
@@ -260,7 +264,7 @@ nodejs_gapic_library(
package = "google.cloud.dataqna.v1alpha",
rest_numeric_enums = False,
service_yaml = "dataqna_v1alpha.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [],
)
@@ -309,6 +313,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = False,
ruby_cloud_description = "Data QnA is a natural language question and answer service for BigQuery data.",
ruby_cloud_title = "BigQuery Data QnA V1alpha",
+ service_yaml = "dataqna_v1alpha.yaml",
deps = [
":dataqna_ruby_grpc",
":dataqna_ruby_proto",
diff --git a/third_party/googleapis/google/cloud/dataqna/v1alpha/annotated_string.proto b/third_party/googleapis/google/cloud/dataqna/v1alpha/annotated_string.proto
index d1eb596d1..2b7592008 100644
--- a/third_party/googleapis/google/cloud/dataqna/v1alpha/annotated_string.proto
+++ b/third_party/googleapis/google/cloud/dataqna/v1alpha/annotated_string.proto
@@ -17,7 +17,7 @@ syntax = "proto3";
package google.cloud.dataqna.v1alpha;
option csharp_namespace = "Google.Cloud.DataQnA.V1Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataqna/v1alpha;dataqna";
+option go_package = "cloud.google.com/go/dataqna/apiv1alpha/dataqnapb;dataqnapb";
option java_multiple_files = true;
option java_outer_classname = "AnnotatedStringProto";
option java_package = "com.google.cloud.dataqna.v1alpha";
diff --git a/third_party/googleapis/google/cloud/dataqna/v1alpha/auto_suggestion_service.proto b/third_party/googleapis/google/cloud/dataqna/v1alpha/auto_suggestion_service.proto
index dc547819a..f8af41bb0 100644
--- a/third_party/googleapis/google/cloud/dataqna/v1alpha/auto_suggestion_service.proto
+++ b/third_party/googleapis/google/cloud/dataqna/v1alpha/auto_suggestion_service.proto
@@ -23,7 +23,7 @@ import "google/cloud/dataqna/v1alpha/annotated_string.proto";
import "google/api/client.proto";
option csharp_namespace = "Google.Cloud.DataQnA.V1Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataqna/v1alpha;dataqna";
+option go_package = "cloud.google.com/go/dataqna/apiv1alpha/dataqnapb;dataqnapb";
option java_multiple_files = true;
option java_outer_classname = "AutoSuggestionServiceProto";
option java_package = "com.google.cloud.dataqna.v1alpha";
diff --git a/third_party/googleapis/google/cloud/dataqna/v1alpha/question.proto b/third_party/googleapis/google/cloud/dataqna/v1alpha/question.proto
index 7478adfd7..950d94bd9 100644
--- a/third_party/googleapis/google/cloud/dataqna/v1alpha/question.proto
+++ b/third_party/googleapis/google/cloud/dataqna/v1alpha/question.proto
@@ -24,7 +24,7 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.DataQnA.V1Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataqna/v1alpha;dataqna";
+option go_package = "cloud.google.com/go/dataqna/apiv1alpha/dataqnapb;dataqnapb";
option java_multiple_files = true;
option java_outer_classname = "QuestionProto";
option java_package = "com.google.cloud.dataqna.v1alpha";
diff --git a/third_party/googleapis/google/cloud/dataqna/v1alpha/question_service.proto b/third_party/googleapis/google/cloud/dataqna/v1alpha/question_service.proto
index d92ac1275..9c2b24d81 100644
--- a/third_party/googleapis/google/cloud/dataqna/v1alpha/question_service.proto
+++ b/third_party/googleapis/google/cloud/dataqna/v1alpha/question_service.proto
@@ -25,7 +25,7 @@ import "google/cloud/dataqna/v1alpha/user_feedback.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.DataQnA.V1Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataqna/v1alpha;dataqna";
+option go_package = "cloud.google.com/go/dataqna/apiv1alpha/dataqnapb;dataqnapb";
option java_multiple_files = true;
option java_outer_classname = "QuestionServiceProto";
option java_package = "com.google.cloud.dataqna.v1alpha";
diff --git a/third_party/googleapis/google/cloud/dataqna/v1alpha/user_feedback.proto b/third_party/googleapis/google/cloud/dataqna/v1alpha/user_feedback.proto
index 9749d49e7..6f0430881 100644
--- a/third_party/googleapis/google/cloud/dataqna/v1alpha/user_feedback.proto
+++ b/third_party/googleapis/google/cloud/dataqna/v1alpha/user_feedback.proto
@@ -20,7 +20,7 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Cloud.DataQnA.V1Alpha";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dataqna/v1alpha;dataqna";
+option go_package = "cloud.google.com/go/dataqna/apiv1alpha/dataqnapb;dataqnapb";
option java_multiple_files = true;
option java_outer_classname = "UserFeedbackProto";
option java_package = "com.google.cloud.dataqna.v1alpha";
diff --git a/third_party/googleapis/google/cloud/datastream/logging/v1/BUILD.bazel b/third_party/googleapis/google/cloud/datastream/logging/v1/BUILD.bazel
new file mode 100644
index 000000000..ea03972d7
--- /dev/null
+++ b/third_party/googleapis/google/cloud/datastream/logging/v1/BUILD.bazel
@@ -0,0 +1,175 @@
+# This file was automatically generated by BuildFileGenerator
+
+# This is an API workspace, having public visibility by default makes perfect sense.
+package(default_visibility = ["//visibility:public"])
+
+##############################################################################
+# Common
+##############################################################################
+load("@rules_proto//proto:defs.bzl", "proto_library")
+
+proto_library(
+ name = "logging_proto",
+ srcs = [
+ "datastream_logs.proto",
+ ],
+ deps = [
+ ],
+)
+
+##############################################################################
+# Java
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "java_grpc_library",
+ "java_proto_library",
+)
+
+java_proto_library(
+ name = "logging_java_proto",
+ deps = [":logging_proto"],
+)
+
+java_grpc_library(
+ name = "logging_java_grpc",
+ srcs = [":logging_proto"],
+ deps = [":logging_java_proto"],
+)
+
+##############################################################################
+# Go
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "go_proto_library",
+)
+
+go_proto_library(
+ name = "logging_go_proto",
+ compilers = ["@io_bazel_rules_go//proto:go_grpc"],
+ importpath = "cloud.google.com/go/datastream/logging/apiv1/loggingpb",
+ protos = [":logging_proto"],
+ deps = [
+ "//google/api:annotations_go_proto",
+ "//google/rpc:status_go_proto",
+ ],
+)
+
+##############################################################################
+# Python
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "moved_proto_library",
+ "py_grpc_library",
+ "py_proto_library",
+)
+
+moved_proto_library(
+ name = "logging_moved_proto",
+ srcs = [":logging_proto"],
+ deps = [
+ ],
+)
+
+py_proto_library(
+ name = "logging_py_proto",
+ deps = [":logging_moved_proto"],
+)
+
+py_grpc_library(
+ name = "logging_py_grpc",
+ srcs = [":logging_moved_proto"],
+ deps = [":logging_py_proto"],
+)
+
+##############################################################################
+# PHP
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "php_grpc_library",
+ "php_proto_library",
+)
+
+php_proto_library(
+ name = "logging_php_proto",
+ deps = [":logging_proto"],
+)
+
+php_grpc_library(
+ name = "logging_php_grpc",
+ srcs = [":logging_proto"],
+ deps = [":logging_php_proto"],
+)
+
+##############################################################################
+# Node.js
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "nodejs_gapic_assembly_pkg",
+ "nodejs_gapic_library",
+)
+
+##############################################################################
+# Ruby
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "ruby_grpc_library",
+ "ruby_proto_library",
+)
+
+ruby_proto_library(
+ name = "logging_ruby_proto",
+ deps = [":logging_proto"],
+)
+
+ruby_grpc_library(
+ name = "logging_ruby_grpc",
+ srcs = [":logging_proto"],
+ deps = [":logging_ruby_proto"],
+)
+
+##############################################################################
+# C#
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "csharp_grpc_library",
+ "csharp_proto_library",
+)
+
+csharp_proto_library(
+ name = "logging_csharp_proto",
+ deps = [":logging_proto"],
+)
+
+csharp_grpc_library(
+ name = "logging_csharp_grpc",
+ srcs = [":logging_proto"],
+ deps = [":logging_csharp_proto"],
+)
+
+##############################################################################
+# C++
+##############################################################################
+load(
+ "@com_google_googleapis_imports//:imports.bzl",
+ "cc_grpc_library",
+ "cc_proto_library",
+)
+
+cc_proto_library(
+ name = "logging_cc_proto",
+ deps = [":logging_proto"],
+)
+
+cc_grpc_library(
+ name = "logging_cc_grpc",
+ srcs = [":logging_proto"],
+ grpc_only = True,
+ deps = [":logging_cc_proto"],
+)
diff --git a/third_party/googleapis/google/cloud/datastream/logging/v1/datastream_logs.proto b/third_party/googleapis/google/cloud/datastream/logging/v1/datastream_logs.proto
new file mode 100644
index 000000000..5240091f1
--- /dev/null
+++ b/third_party/googleapis/google/cloud/datastream/logging/v1/datastream_logs.proto
@@ -0,0 +1,34 @@
+// Copyright 2022 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.
+
+syntax = "proto3";
+
+package google.cloud.datastream.logging.v1;
+
+option csharp_namespace = "Google.Cloud.Datastream.Logging.V1";
+option go_package = "cloud.google.com/go/datastream/logging/apiv1/loggingpb;loggingpb";
+option java_multiple_files = true;
+option java_outer_classname = "DatastreamLogsProto";
+option java_package = "com.google.cloud.datastream.logging.v1";
+option php_namespace = "Google\\Cloud\\Datastream\\Logging\\V1";
+option ruby_package = "Google::Cloud::Datastream::Logging::V1";
+
+// Stackdriver structured-payload for events related to a stream.
+message StreamActivityLogEntry {
+ // A code representing the event.
+ string event_code = 1;
+
+ // A free-text message describing the event.
+ string event_message = 2;
+}
diff --git a/third_party/googleapis/google/cloud/datastream/v1/BUILD.bazel b/third_party/googleapis/google/cloud/datastream/v1/BUILD.bazel
index d0221b0ff..40d2fb284 100644
--- a/third_party/googleapis/google/cloud/datastream/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/datastream/v1/BUILD.bazel
@@ -31,6 +31,7 @@ proto_library(
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"@com_google_protobuf//:duration_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
@@ -126,7 +127,7 @@ load(
go_proto_library(
name = "datastream_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/datastream/v1",
+ importpath = "cloud.google.com/go/datastream/apiv1/datastreampb",
protos = [":datastream_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -140,6 +141,7 @@ go_gapic_library(
grpc_service_config = "datastream_grpc_service_config.json",
importpath = "cloud.google.com/go/datastream/apiv1;datastream",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "datastream_v1.yaml",
transport = "grpc+rest",
@@ -188,7 +190,7 @@ py_gapic_library(
grpc_service_config = "datastream_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "datastream_v1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -368,6 +370,7 @@ csharp_gapic_library(
grpc_service_config = "datastream_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "datastream_v1.yaml",
+ transport = "grpc+rest",
deps = [
":datastream_csharp_grpc",
":datastream_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/datastream/v1/datastream.proto b/third_party/googleapis/google/cloud/datastream/v1/datastream.proto
index a29633912..cd9770794 100644
--- a/third_party/googleapis/google/cloud/datastream/v1/datastream.proto
+++ b/third_party/googleapis/google/cloud/datastream/v1/datastream.proto
@@ -26,7 +26,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Datastream.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datastream/v1;datastream";
+option go_package = "cloud.google.com/go/datastream/apiv1/datastreampb;datastreampb";
option java_multiple_files = true;
option java_outer_classname = "DatastreamProto";
option java_package = "com.google.cloud.datastream.v1";
diff --git a/third_party/googleapis/google/cloud/datastream/v1/datastream_resources.proto b/third_party/googleapis/google/cloud/datastream/v1/datastream_resources.proto
index 58a2c7bdf..80a8deeae 100644
--- a/third_party/googleapis/google/cloud/datastream/v1/datastream_resources.proto
+++ b/third_party/googleapis/google/cloud/datastream/v1/datastream_resources.proto
@@ -22,7 +22,7 @@ import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Datastream.V1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datastream/v1;datastream";
+option go_package = "cloud.google.com/go/datastream/apiv1/datastreampb;datastreampb";
option java_multiple_files = true;
option java_outer_classname = "DatastreamResourcesProto";
option java_package = "com.google.cloud.datastream.v1";
diff --git a/third_party/googleapis/google/cloud/datastream/v1alpha1/BUILD.bazel b/third_party/googleapis/google/cloud/datastream/v1alpha1/BUILD.bazel
index 5a2324f7c..63e398b09 100644
--- a/third_party/googleapis/google/cloud/datastream/v1alpha1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/datastream/v1alpha1/BUILD.bazel
@@ -31,6 +31,7 @@ proto_library(
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"@com_google_protobuf//:duration_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
@@ -117,7 +118,7 @@ load(
go_proto_library(
name = "datastream_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1",
+ importpath = "cloud.google.com/go/datastream/apiv1alpha1/datastreampb",
protos = [":datastream_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -131,6 +132,7 @@ go_gapic_library(
grpc_service_config = "datastream_grpc_service_config.json",
importpath = "cloud.google.com/go/datastream/apiv1alpha1;datastream",
metadata = True,
+ release_level = "alpha",
rest_numeric_enums = True,
service_yaml = "datastream_v1alpha1.yaml",
transport = "grpc+rest",
@@ -176,7 +178,8 @@ py_gapic_library(
srcs = [":datastream_proto"],
grpc_service_config = "datastream_grpc_service_config.json",
rest_numeric_enums = True,
- transport = "grpc",
+ service_yaml = "datastream_v1alpha1.yaml",
+ transport = "grpc+rest",
)
py_test(
@@ -307,6 +310,7 @@ ruby_cloud_gapic_library(
rest_numeric_enums = True,
ruby_cloud_description = "Datastream is a serverless and easy-to-use change data capture (CDC) and replication service. It allows you to synchronize data across heterogeneous databases and applications reliably, and with minimal latency and downtime.",
ruby_cloud_title = "Datastream V1alpha1",
+ service_yaml = "datastream_v1alpha1.yaml",
deps = [
":datastream_ruby_grpc",
":datastream_ruby_proto",
@@ -352,6 +356,7 @@ csharp_gapic_library(
grpc_service_config = "datastream_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "datastream_v1alpha1.yaml",
+ transport = "grpc+rest",
deps = [
":datastream_csharp_grpc",
":datastream_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/datastream/v1alpha1/datastream.proto b/third_party/googleapis/google/cloud/datastream/v1alpha1/datastream.proto
index c924cbbf5..14dac8fe5 100644
--- a/third_party/googleapis/google/cloud/datastream/v1alpha1/datastream.proto
+++ b/third_party/googleapis/google/cloud/datastream/v1alpha1/datastream.proto
@@ -26,7 +26,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Datastream.V1Alpha1";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1;datastream";
+option go_package = "cloud.google.com/go/datastream/apiv1alpha1/datastreampb;datastreampb";
option java_multiple_files = true;
option java_outer_classname = "CloudDatastreamServiceProto";
option java_package = "com.google.cloud.datastream.v1alpha1";
diff --git a/third_party/googleapis/google/cloud/datastream/v1alpha1/datastream_resources.proto b/third_party/googleapis/google/cloud/datastream/v1alpha1/datastream_resources.proto
index b2a9ba3fc..59111d92a 100644
--- a/third_party/googleapis/google/cloud/datastream/v1alpha1/datastream_resources.proto
+++ b/third_party/googleapis/google/cloud/datastream/v1alpha1/datastream_resources.proto
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/datastream/v1alpha1;datastream";
+option go_package = "cloud.google.com/go/datastream/apiv1alpha1/datastreampb;datastreampb";
option java_multiple_files = true;
option java_outer_classname = "CloudDatastreamResourcesProto";
option java_package = "com.google.cloud.datastream.v1alpha1";
diff --git a/third_party/googleapis/google/cloud/deploy/v1/BUILD.bazel b/third_party/googleapis/google/cloud/deploy/v1/BUILD.bazel
index aa46b67b8..6944c3edd 100644
--- a/third_party/googleapis/google/cloud/deploy/v1/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/deploy/v1/BUILD.bazel
@@ -38,6 +38,7 @@ proto_library(
"//google/longrunning:operations_proto",
"//google/type:date_proto",
"@com_google_protobuf//:duration_proto",
+ "@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
@@ -133,7 +134,7 @@ load(
go_proto_library(
name = "deploy_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/deploy/v1",
+ importpath = "cloud.google.com/go/deploy/apiv1/deploypb",
protos = [":deploy_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -148,6 +149,7 @@ go_gapic_library(
grpc_service_config = "clouddeploy_grpc_service_config.json",
importpath = "cloud.google.com/go/deploy/apiv1;deploy",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "clouddeploy_v1.yaml",
transport = "grpc+rest",
@@ -196,7 +198,7 @@ py_gapic_library(
grpc_service_config = "clouddeploy_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "clouddeploy_v1.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
"//google/iam/v1:iam_policy_py_proto",
],
@@ -377,6 +379,7 @@ csharp_gapic_library(
grpc_service_config = "clouddeploy_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "clouddeploy_v1.yaml",
+ transport = "grpc+rest",
deps = [
":deploy_csharp_grpc",
":deploy_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/deploy/v1/cloud_deploy.proto b/third_party/googleapis/google/cloud/deploy/v1/cloud_deploy.proto
index 69f8d5222..cf8810dcd 100644
--- a/third_party/googleapis/google/cloud/deploy/v1/cloud_deploy.proto
+++ b/third_party/googleapis/google/cloud/deploy/v1/cloud_deploy.proto
@@ -26,7 +26,7 @@ import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "google/type/date.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/deploy/v1;deploy";
+option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
option java_multiple_files = true;
option java_outer_classname = "CloudDeployProto";
option java_package = "com.google.cloud.deploy.v1";
diff --git a/third_party/googleapis/google/cloud/deploy/v1/deliverypipeline_notification_payload.proto b/third_party/googleapis/google/cloud/deploy/v1/deliverypipeline_notification_payload.proto
index 5fff2d087..6ba9b13a1 100644
--- a/third_party/googleapis/google/cloud/deploy/v1/deliverypipeline_notification_payload.proto
+++ b/third_party/googleapis/google/cloud/deploy/v1/deliverypipeline_notification_payload.proto
@@ -18,7 +18,7 @@ package google.cloud.deploy.v1;
import "google/cloud/deploy/v1/log_enums.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/deploy/v1;deploy";
+option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
option java_multiple_files = true;
option java_outer_classname = "DeliveryPipelineNotificationPayloadProto";
option java_package = "com.google.cloud.deploy.v1";
diff --git a/third_party/googleapis/google/cloud/deploy/v1/jobrun_notification_payload.proto b/third_party/googleapis/google/cloud/deploy/v1/jobrun_notification_payload.proto
index f1e80d6b3..a3049eb0e 100644
--- a/third_party/googleapis/google/cloud/deploy/v1/jobrun_notification_payload.proto
+++ b/third_party/googleapis/google/cloud/deploy/v1/jobrun_notification_payload.proto
@@ -18,7 +18,7 @@ package google.cloud.deploy.v1;
import "google/cloud/deploy/v1/log_enums.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/deploy/v1;deploy";
+option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
option java_multiple_files = true;
option java_outer_classname = "JobRunNotificationPayloadProto";
option java_package = "com.google.cloud.deploy.v1";
diff --git a/third_party/googleapis/google/cloud/deploy/v1/log_enums.proto b/third_party/googleapis/google/cloud/deploy/v1/log_enums.proto
index cd6a32ea4..649ad98c6 100644
--- a/third_party/googleapis/google/cloud/deploy/v1/log_enums.proto
+++ b/third_party/googleapis/google/cloud/deploy/v1/log_enums.proto
@@ -16,7 +16,7 @@ syntax = "proto3";
package google.cloud.deploy.v1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/deploy/v1;deploy";
+option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
option java_multiple_files = true;
option java_outer_classname = "LogEnumsProto";
option java_package = "com.google.cloud.deploy.v1";
diff --git a/third_party/googleapis/google/cloud/deploy/v1/release_notification_payload.proto b/third_party/googleapis/google/cloud/deploy/v1/release_notification_payload.proto
index 0383b8e56..f0e117fa4 100644
--- a/third_party/googleapis/google/cloud/deploy/v1/release_notification_payload.proto
+++ b/third_party/googleapis/google/cloud/deploy/v1/release_notification_payload.proto
@@ -18,7 +18,7 @@ package google.cloud.deploy.v1;
import "google/cloud/deploy/v1/log_enums.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/deploy/v1;deploy";
+option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
option java_multiple_files = true;
option java_outer_classname = "ReleaseNotificationPayloadProto";
option java_package = "com.google.cloud.deploy.v1";
diff --git a/third_party/googleapis/google/cloud/deploy/v1/release_render_payload.proto b/third_party/googleapis/google/cloud/deploy/v1/release_render_payload.proto
index 414e72ded..a8d18dcf5 100644
--- a/third_party/googleapis/google/cloud/deploy/v1/release_render_payload.proto
+++ b/third_party/googleapis/google/cloud/deploy/v1/release_render_payload.proto
@@ -16,7 +16,7 @@ syntax = "proto3";
package google.cloud.deploy.v1;
-option go_package = "google.golang.org/genproto/googleapis/cloud/deploy/v1;deploy";
+option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
option java_multiple_files = true;
option java_outer_classname = "ReleaseRenderPayloadProto";
option java_package = "com.google.cloud.deploy.v1";
diff --git a/third_party/googleapis/google/cloud/deploy/v1/rollout_notification_payload.proto b/third_party/googleapis/google/cloud/deploy/v1/rollout_notification_payload.proto
index 10f6864f9..31cc0f40d 100644
--- a/third_party/googleapis/google/cloud/deploy/v1/rollout_notification_payload.proto
+++ b/third_party/googleapis/google/cloud/deploy/v1/rollout_notification_payload.proto
@@ -18,7 +18,7 @@ package google.cloud.deploy.v1;
import "google/cloud/deploy/v1/log_enums.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/deploy/v1;deploy";
+option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
option java_multiple_files = true;
option java_outer_classname = "RolloutNotificationPayloadProto";
option java_package = "com.google.cloud.deploy.v1";
diff --git a/third_party/googleapis/google/cloud/deploy/v1/target_notification_payload.proto b/third_party/googleapis/google/cloud/deploy/v1/target_notification_payload.proto
index d121cdb8d..734f5a44f 100644
--- a/third_party/googleapis/google/cloud/deploy/v1/target_notification_payload.proto
+++ b/third_party/googleapis/google/cloud/deploy/v1/target_notification_payload.proto
@@ -18,7 +18,7 @@ package google.cloud.deploy.v1;
import "google/cloud/deploy/v1/log_enums.proto";
-option go_package = "google.golang.org/genproto/googleapis/cloud/deploy/v1;deploy";
+option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
option java_multiple_files = true;
option java_outer_classname = "TargetNotificationPayloadProto";
option java_package = "com.google.cloud.deploy.v1";
diff --git a/third_party/googleapis/google/cloud/dialogflow/cx/v3/BUILD.bazel b/third_party/googleapis/google/cloud/dialogflow/cx/v3/BUILD.bazel
index 7e947d8a9..2909ddb66 100644
--- a/third_party/googleapis/google/cloud/dialogflow/cx/v3/BUILD.bazel
+++ b/third_party/googleapis/google/cloud/dialogflow/cx/v3/BUILD.bazel
@@ -31,6 +31,7 @@ proto_library(
"experiment.proto",
"flow.proto",
"fulfillment.proto",
+ "gcs.proto",
"intent.proto",
"page.proto",
"response_message.proto",
@@ -176,7 +177,7 @@ load(
go_proto_library(
name = "cx_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
- importpath = "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3",
+ importpath = "cloud.google.com/go/dialogflow/cx/apiv3/cxpb",
protos = [":cx_proto"],
deps = [
"//google/api:annotations_go_proto",
@@ -192,6 +193,7 @@ go_gapic_library(
grpc_service_config = "dialogflow_grpc_service_config.json",
importpath = "cloud.google.com/go/dialogflow/cx/apiv3;cx",
metadata = True,
+ release_level = "ga",
rest_numeric_enums = True,
service_yaml = "dialogflow_v3.yaml",
transport = "grpc+rest",
@@ -245,7 +247,7 @@ py_gapic_library(
],
rest_numeric_enums = True,
service_yaml = "dialogflow_v3.yaml",
- transport = "grpc",
+ transport = "grpc+rest",
deps = [
],
)
@@ -428,6 +430,7 @@ csharp_gapic_library(
grpc_service_config = "dialogflow_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "dialogflow_v3.yaml",
+ transport = "grpc+rest",
deps = [
":cx_csharp_grpc",
":cx_csharp_proto",
diff --git a/third_party/googleapis/google/cloud/dialogflow/cx/v3/advanced_settings.proto b/third_party/googleapis/google/cloud/dialogflow/cx/v3/advanced_settings.proto
index d2de5b1fc..05460932a 100644
--- a/third_party/googleapis/google/cloud/dialogflow/cx/v3/advanced_settings.proto
+++ b/third_party/googleapis/google/cloud/dialogflow/cx/v3/advanced_settings.proto
@@ -17,10 +17,11 @@ syntax = "proto3";
package google.cloud.dialogflow.cx.v3;
import "google/api/field_behavior.proto";
+import "google/cloud/dialogflow/cx/v3/gcs.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3;cx";
+option go_package = "cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb";
option java_multiple_files = true;
option java_outer_classname = "AdvancedSettingsProto";
option java_package = "com.google.cloud.dialogflow.cx.v3";
@@ -48,6 +49,13 @@ message AdvancedSettings {
bool enable_interaction_logging = 3;
}
+ // If present, incoming audio is exported by Dialogflow to the configured
+ // Google Cloud Storage destination.
+ // Exposed at the following levels:
+ // - Agent level
+ // - Flow level
+ GcsDestination audio_export_gcs_destination = 2;
+
// Settings for logging.
// Settings for Dialogflow History, Contact Center messages, StackDriver logs,
// and speech logging.
diff --git a/third_party/googleapis/google/cloud/dialogflow/cx/v3/agent.proto b/third_party/googleapis/google/cloud/dialogflow/cx/v3/agent.proto
index 0c4fb140b..2c7ed1adb 100644
--- a/third_party/googleapis/google/cloud/dialogflow/cx/v3/agent.proto
+++ b/third_party/googleapis/google/cloud/dialogflow/cx/v3/agent.proto
@@ -21,14 +21,16 @@ import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/dialogflow/cx/v3/advanced_settings.proto";
+import "google/cloud/dialogflow/cx/v3/audio_config.proto";
import "google/cloud/dialogflow/cx/v3/flow.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
+import "google/protobuf/struct.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3";
-option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3;cx";
+option go_package = "cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb";
option java_multiple_files = true;
option java_outer_classname = "AgentProto";
option java_package = "com.google.cloud.dialogflow.cx.v3";
@@ -100,7 +102,8 @@ service Agents {
//
// - `metadata`: An empty [Struct
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
- // - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
+ // - `response`:
+ // [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v3/{name=projects/*/locations/*/agents/*}:export"
@@ -152,7 +155,8 @@ service Agents {
// Gets the latest agent validation result. Agent validation is performed
// when ValidateAgent is called.
- rpc GetAgentValidationResult(GetAgentValidationResultRequest) returns (AgentValidationResult) {
+ rpc GetAgentValidationResult(GetAgentValidationResultRequest)
+ returns (AgentValidationResult) {
option (google.api.http) = {
get: "/v3/{name=projects/*/locations/*/agents/*/validationResult}"
};
@@ -171,9 +175,13 @@ message SpeechToTextSettings {
// in your app, product, or service to determine user intent and respond to the
// user in a natural way.
//
-// After you create an agent, you can add [Intents][google.cloud.dialogflow.cx.v3.Intent],
-// [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment],
-// [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..
+// After you create an agent, you can add
+// [Intents][google.cloud.dialogflow.cx.v3.Intent], [Entity
+// Types][google.cloud.dialogflow.cx.v3.EntityType],
+// [Flows][google.cloud.dialogflow.cx.v3.Flow],
+// [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment],
+// [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the
+// conversation flows..
message Agent {
option (google.api.resource) = {
type: "dialogflow.googleapis.com/Agent"
@@ -181,7 +189,10 @@ message Agent {
};
// The unique identifier of the agent.
- // Required for the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method. [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent]
+ // Required for the
+ // [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
+ // method.
+ // [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent]
// populates the name automatically.
// Format: `projects//locations//agents/`.
string name = 1;
@@ -193,7 +204,9 @@ message Agent {
// See [Language
// Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
// for a list of the currently supported language codes.
- // This field cannot be set by the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method.
+ // This field cannot be set by the
+ // [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
+ // method.
string default_language_code = 3 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
@@ -221,27 +234,26 @@ message Agent {
// Speech recognition related settings.
SpeechToTextSettings speech_to_text_settings = 13;
- // Immutable. Name of the start flow in this agent. A start flow will be automatically
- // created when the agent is created, and can only be deleted by deleting the
- // agent.
- // Format: `projects//locations//agents//flows/`.
+ // Immutable. Name of the start flow in this agent. A start flow will be
+ // automatically created when the agent is created, and can only be deleted by
+ // deleting the agent. Format: `projects//locations//agents//flows/`.
string start_flow = 16 [
(google.api.field_behavior) = IMMUTABLE,
- (google.api.resource_reference) = {
- type: "dialogflow.googleapis.com/Flow"
- }
+ (google.api.resource_reference) = { type: "dialogflow.googleapis.com/Flow" }
];
- // Name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] reference for the agent.
- // Format: `projects//locations//locations//securitySettings/`.
string security_settings = 17 [(google.api.resource_reference) = {
- type: "dialogflow.googleapis.com/SecuritySettings"
- }];
+ type: "dialogflow.googleapis.com/SecuritySettings"
+ }];
// Indicates if stackdriver logging is enabled for the agent.
- // Please use [agent.advanced_settings][google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettings]
+ // Please use
+ // [agent.advanced_settings][google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettings]
// instead.
bool enable_stackdriver_logging = 18 [deprecated = true];
@@ -256,9 +268,14 @@ message Agent {
// Hierarchical advanced settings for this agent. The settings exposed at the
// lower level overrides the settings exposed at the higher level.
AdvancedSettings advanced_settings = 22;
+
+ // Settings on instructing the speech synthesizer on how to generate the
+ // output audio content.
+ TextToSpeechSettings text_to_speech_settings = 31;
}
-// The request message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
+// The request message for
+// [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
message ListAgentsRequest {
// Required. The location to list all agents for.
// Format: `projects//locations/`.
@@ -277,7 +294,8 @@ message ListAgentsRequest {
string page_token = 3;
}
-// The response message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
+// The response message for
+// [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].
message ListAgentsResponse {
// The list of agents. There will be a maximum number of items returned based
// on the page_size field in the request.
@@ -288,7 +306,8 @@ message ListAgentsResponse {
string next_page_token = 2;
}
-// The request message for [Agents.GetAgent][google.cloud.dialogflow.cx.v3.Agents.GetAgent].
+// The request message for
+// [Agents.GetAgent][google.cloud.dialogflow.cx.v3.Agents.GetAgent].
message GetAgentRequest {
// Required. The name of the agent.
// Format: `projects//locations//agents/`.
@@ -300,7 +319,8 @@ message GetAgentRequest {
];
}
-// The request message for [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent].
+// The request message for
+// [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent].
message CreateAgentRequest {
// Required. The location to create a agent for.
// Format: `projects//locations/`.
@@ -315,7 +335,8 @@ message CreateAgentRequest {
Agent agent = 2 [(google.api.field_behavior) = REQUIRED];
}
-// The request message for [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent].
+// The request message for
+// [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent].
message UpdateAgentRequest {
// Required. The agent to update.
Agent agent = 1 [(google.api.field_behavior) = REQUIRED];
@@ -325,7 +346,8 @@ message UpdateAgentRequest {
google.protobuf.FieldMask update_mask = 2;
}
-// The request message for [Agents.DeleteAgent][google.cloud.dialogflow.cx.v3.Agents.DeleteAgent].
+// The request message for
+// [Agents.DeleteAgent][google.cloud.dialogflow.cx.v3.Agents.DeleteAgent].
message DeleteAgentRequest {
// Required. The name of the agent to delete.
// Format: `projects//locations//agents/`.
@@ -337,7 +359,8 @@ message DeleteAgentRequest {
];
}
-// The request message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].
+// The request message for
+// [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].
message ExportAgentRequest {
// Data format of the exported agent.
enum DataFormat {
@@ -346,6 +369,9 @@ message ExportAgentRequest {
// Agent content will be exported as raw bytes.
BLOB = 1;
+
+ // Agent content will be exported in JSON Package format.
+ JSON_PACKAGE = 4;
}
// Required. The name of the agent to export.
@@ -357,10 +383,10 @@ message ExportAgentRequest {
}
];
- // Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to
- // export the agent to. The format of this URI must be
- // `gs:///